chore: move private classes into internal module (#103)

Author: stainless-app[bot]

lib/finch_api.rb

@@ -36,27 +36,27 @@
 
 # Package files.
 require_relative "finch_api/version"
-require_relative "finch_api/util"
-require_relative "finch_api/type/converter"
-require_relative "finch_api/type/unknown"
-require_relative "finch_api/type/boolean_model"
-require_relative "finch_api/type/enum"
-require_relative "finch_api/type/union"
-require_relative "finch_api/type/array_of"
-require_relative "finch_api/type/hash_of"
-require_relative "finch_api/type/base_model"
-require_relative "finch_api/type/base_page"
-require_relative "finch_api/type/request_parameters"
-require_relative "finch_api/type"
+require_relative "finch_api/internal/util"
+require_relative "finch_api/internal/type/converter"
+require_relative "finch_api/internal/type/unknown"
+require_relative "finch_api/internal/type/boolean_model"
+require_relative "finch_api/internal/type/enum"
+require_relative "finch_api/internal/type/union"
+require_relative "finch_api/internal/type/array_of"
+require_relative "finch_api/internal/type/hash_of"
+require_relative "finch_api/internal/type/base_model"
+require_relative "finch_api/internal/type/base_page"
+require_relative "finch_api/internal/type/request_parameters"
+require_relative "finch_api/aliases"
 require_relative "finch_api/request_options"
 require_relative "finch_api/errors"
-require_relative "finch_api/transport/base_client"
-require_relative "finch_api/transport/pooled_net_requester"
+require_relative "finch_api/internal/transport/base_client"
+require_relative "finch_api/internal/transport/pooled_net_requester"
 require_relative "finch_api/client"
-require_relative "finch_api/individuals_page"
-require_relative "finch_api/page"
-require_relative "finch_api/responses_page"
-require_relative "finch_api/single_page"
+require_relative "finch_api/internal/individuals_page"
+require_relative "finch_api/internal/page"
+require_relative "finch_api/internal/responses_page"
+require_relative "finch_api/internal/single_page"
 require_relative "finch_api/models/base_webhook_event"
 require_relative "finch_api/models/hris/benefit_contribution"
 require_relative "finch_api/models/sandbox/jobs/sandbox_job_configuration"

lib/finch_api/aliases.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  Unknown = FinchAPI::Internal::Type::Unknown
+
+  BooleanModel = FinchAPI::Internal::Type::BooleanModel
+
+  Enum = FinchAPI::Internal::Type::Enum
+
+  Union = FinchAPI::Internal::Type::Union
+
+  ArrayOf = FinchAPI::Internal::Type::ArrayOf
+
+  HashOf = FinchAPI::Internal::Type::HashOf
+
+  BaseModel = FinchAPI::Internal::Type::BaseModel
+
+  RequestParameters = FinchAPI::Internal::Type::RequestParameters
+end

lib/finch_api/client.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  class Client < FinchAPI::Transport::BaseClient
+  class Client < FinchAPI::Internal::Transport::BaseClient
     # Default max number of retries to attempt after a failed retryable request.
     DEFAULT_MAX_RETRIES = 2
 

lib/finch_api/individuals_page.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Internal
+    # @example
+    #   if individuals_page.has_next?
+    #     individuals_page = individuals_page.next_page
+    #   end
+    #
+    # @example
+    #   individuals_page.auto_paging_each do |directory|
+    #     puts(directory)
+    #   end
+    #
+    # @example
+    #   directories =
+    #     individuals_page
+    #     .to_enum
+    #     .lazy
+    #     .select { _1.object_id.even? }
+    #     .map(&:itself)
+    #     .take(2)
+    #     .to_a
+    #
+    #   directories => Array
+    class IndividualsPage
+      include FinchAPI::Internal::Type::BasePage
+
+      # @return [Array<Object>, nil]
+      attr_accessor :individuals
+
+      # @return [FinchAPI::Models::Paging]
+      attr_accessor :paging
+
+      # @api private
+      #
+      # @param client [FinchAPI::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+        model = req.fetch(:model)
+
+        case page_data
+        in {individuals: Array | nil => individuals}
+          @individuals = individuals&.map { FinchAPI::Internal::Type::Converter.coerce(model, _1) }
+        else
+        end
+
+        case page_data
+        in {paging: Hash | nil => paging}
+          @paging = FinchAPI::Internal::Type::Converter.coerce(FinchAPI::Models::Paging, paging)
+        else
+        end
+      end
+
+      # @return [Boolean]
+      def next_page?
+        paging&.offset.to_i + individuals.to_a.size < paging&.count.to_i
+      end
+
+      # @raise [FinchAPI::HTTP::Error]
+      # @return [FinchAPI::Internal::IndividualsPage]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = FinchAPI::Internal::Util.deep_merge(
+          @req,
+          {query: {offset: paging&.offset.to_i + individuals.to_a.size}}
+        )
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+        page = self
+        loop do
+          page.individuals&.each { blk.call(_1) }
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @return [String]
+      def inspect
+        "#<#{self.class}:0x#{object_id.to_s(16)} individuals=#{individuals.inspect} paging=#{paging.inspect}>"
+      end
+    end
+  end
+end

lib/finch_api/internal/individuals_page.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Internal
+    # @example
+    #   if page.has_next?
+    #     page = page.next_page
+    #   end
+    #
+    # @example
+    #   page.auto_paging_each do |item|
+    #     puts(item)
+    #   end
+    #
+    # @example
+    #   items =
+    #     page
+    #     .to_enum
+    #     .lazy
+    #     .select { _1.object_id.even? }
+    #     .map(&:itself)
+    #     .take(2)
+    #     .to_a
+    #
+    #   items => Array
+    class Page
+      include FinchAPI::Internal::Type::BasePage
+
+      # @return [Array<Object>, nil]
+      attr_accessor :data
+
+      # @return [FinchAPI::Models::Paging]
+      attr_accessor :paging
+
+      # @api private
+      #
+      # @param client [FinchAPI::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Hash{Symbol=>Object}]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+        model = req.fetch(:model)
+
+        case page_data
+        in {data: Array | nil => data}
+          @data = data&.map { FinchAPI::Internal::Type::Converter.coerce(model, _1) }
+        else
+        end
+
+        case page_data
+        in {paging: Hash | nil => paging}
+          @paging = FinchAPI::Internal::Type::Converter.coerce(FinchAPI::Models::Paging, paging)
+        else
+        end
+      end
+
+      # @return [Boolean]
+      def next_page?
+        paging&.offset.to_i + data.to_a.size < paging&.count.to_i
+      end
+
+      # @raise [FinchAPI::HTTP::Error]
+      # @return [FinchAPI::Internal::Page]
+      def next_page
+        unless next_page?
+          message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+          raise RuntimeError.new(message)
+        end
+
+        req = FinchAPI::Internal::Util.deep_merge(
+          @req,
+          {query: {offset: paging&.offset.to_i + data.to_a.size}}
+        )
+        @client.request(req)
+      end
+
+      # @param blk [Proc]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+        page = self
+        loop do
+          page.data&.each { blk.call(_1) }
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @return [String]
+      def inspect
+        "#<#{self.class}:0x#{object_id.to_s(16)} data=#{data.inspect} paging=#{paging.inspect}>"
+      end
+    end
+  end
+end