finch-api 0.1.0.pre.alpha.1 → 0.1.0.pre.alpha.2

data/lib/finch-api/base_page.rb

@@ -1,40 +1,59 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  # @private
+  # @example
+  #   if page.has_next?
+  #     page = page.next_page
+  #   end
   #
-  # @abstract
+  # @example
+  #   page.auto_paging_each do |access_token|
+  #     puts(access_token)
+  #   end
   #
+  # @example
+  #   access_tokens =
+  #     page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
+  #
+  #   access_tokens => Array
   module BasePage
+    # rubocop:disable Lint/UnusedMethodArgument
+
     # @return [Boolean]
-    #
     def next_page? = (raise NotImplementedError)
 
     # @raise [FinchAPI::APIError]
     # @return [FinchAPI::BasePage]
-    #
     def next_page = (raise NotImplementedError)
 
     # @param blk [Proc]
     #
     # @return [void]
-    #
     def auto_paging_each(&) = (raise NotImplementedError)
 
     # @return [Enumerable]
-    #
     def to_enum = super(:auto_paging_each)
 
     alias_method :enum_for, :to_enum
 
-    # @!parse
-    #   # @private
-    #   #
-    #   # @param client [FinchAPI::BaseClient]
-    #   # @param req [Hash{Symbol=>Object}]
-    #   # @param headers [Hash{String=>String}, Net::HTTPHeader]
-    #   # @param unwrapped [Object]
-    #   #
-    #   def initialize(client:, req:, headers:, unwrapped:); end
+    # @api private
+    #
+    # @param client [FinchAPI::BaseClient]
+    # @param req [Hash{Symbol=>Object}]
+    # @param headers [Hash{String=>String}, Net::HTTPHeader]
+    # @param page_data [Object]
+    def initialize(client:, req:, headers:, page_data:)
+      @client = client
+      @req = req
+      super()
+    end
+
+    # rubocop:enable Lint/UnusedMethodArgument
   end
 end

data/lib/finch-api/client.rb

@@ -54,28 +54,25 @@ module FinchAPI
     # @return [FinchAPI::Resources::Connect]
     attr_reader :connect
 
-    # @private
+    # @api private
     #
     # @return [Hash{String=>String}]
-    #
     private def auth_headers
       {**bearer_auth, **basic_auth}
     end
 
-    # @private
+    # @api private
     #
     # @return [Hash{String=>String}]
-    #
     private def bearer_auth
       return {} if @access_token.nil?
 
       {"authorization" => "Bearer #{@access_token}"}
     end
 
-    # @private
+    # @api private
     #
     # @return [Hash{String=>String}]
-    #
     private def basic_auth
       return {} if @client_id.nil? || @client_secret.nil?
 
@@ -100,7 +97,6 @@ module FinchAPI
     # @param initial_retry_delay [Float]
     #
     # @param max_retry_delay [Float]
-    #
     def initialize(
       base_url: nil,
       access_token: nil,

data/lib/finch-api/errors.rb

@@ -4,7 +4,7 @@ module FinchAPI
   class Error < StandardError
     # @!parse
     #   # @return [StandardError, nil]
-    #   attr_reader :cause
+    #   attr_accessor :cause
   end
 
   class ConversionError < FinchAPI::Error
@@ -12,15 +12,15 @@ module FinchAPI
 
   class APIError < FinchAPI::Error
     # @return [URI::Generic]
-    attr_reader :url
+    attr_accessor :url
 
     # @return [Integer, nil]
-    attr_reader :status
+    attr_accessor :status
 
     # @return [Object, nil]
-    attr_reader :body
+    attr_accessor :body
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [Integer, nil]
@@ -28,7 +28,6 @@ module FinchAPI
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(url:, status: nil, body: nil, request: nil, response: nil, message: nil)
       @url = url
       @status = status
@@ -42,13 +41,13 @@ module FinchAPI
   class APIConnectionError < FinchAPI::APIError
     # @!parse
     #   # @return [nil]
-    #   attr_reader :status
+    #   attr_accessor :status
 
     # @!parse
     #   # @return [nil]
-    #   attr_reader :body
+    #   attr_accessor :body
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [nil]
@@ -56,7 +55,6 @@ module FinchAPI
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(
       url:,
       status: nil,
@@ -70,7 +68,7 @@ module FinchAPI
   end
 
   class APITimeoutError < FinchAPI::APIConnectionError
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [nil]
@@ -78,7 +76,6 @@ module FinchAPI
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(
       url:,
       status: nil,
@@ -92,7 +89,7 @@ module FinchAPI
   end
 
   class APIStatusError < FinchAPI::APIError
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [Integer]
@@ -102,7 +99,6 @@ module FinchAPI
     # @param message [String, nil]
     #
     # @return [FinchAPI::APIStatusError]
-    #
     def self.for(url:, status:, body:, request:, response:, message: nil)
       kwargs = {url: url, status: status, body: body, request: request, response: response, message: message}
 
@@ -130,9 +126,9 @@ module FinchAPI
 
     # @!parse
     #   # @return [Integer]
-    #   attr_reader :status
+    #   attr_accessor :status
 
-    # @private
+    # @api private
     #
     # @param url [URI::Generic]
     # @param status [Integer]
@@ -140,7 +136,6 @@ module FinchAPI
     # @param request [nil]
     # @param response [nil]
     # @param message [String, nil]
-    #
     def initialize(url:, status:, body:, request:, response:, message: nil)
       message ||= {url: url.to_s, status: status, body: body}
       super(

data/lib/finch-api/extern.rb

@@ -1,10 +1,7 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  # @private
-  #
-  # @abstract
-  #
+  # @api private
   module Extern
   end
 end

data/lib/finch-api/individuals_page.rb

@@ -2,84 +2,79 @@
 
 module FinchAPI
   # @example
-  # ```ruby
-  # if individuals_page.has_next?
-  #   page = individuals_page.next_page
-  # end
-  # ```
+  #   if individuals_page.has_next?
+  #     individuals_page = individuals_page.next_page
+  #   end
   #
   # @example
-  # ```ruby
-  # individuals_page.auto_paging_each do |item|
-  # #   item ...
-  # end
-  # ```
+  #   individuals_page.auto_paging_each do |directory|
+  #     puts(directory)
+  #   end
   #
   # @example
-  # ```ruby
-  # items = individuals_page.to_enum.take(2)
+  #   directories =
+  #     individuals_page
+  #     .to_enum
+  #     .lazy
+  #     .select { _1.object_id.even? }
+  #     .map(&:itself)
+  #     .take(2)
+  #     .to_a
   #
-  # items => Array
-  # ```
+  #   directories => Array
   class IndividualsPage
     include FinchAPI::BasePage
 
-    # @return [Array<Object>]
+    # @return [Array<Object>, nil]
     attr_accessor :individuals
 
     # @return [FinchAPI::Models::Paging]
     attr_accessor :paging
 
-    # rubocop:disable Lint/UnusedMethodArgument
-    # @private
+    # @api private
     #
     # @param client [FinchAPI::BaseClient]
     # @param req [Hash{Symbol=>Object}]
     # @param headers [Hash{String=>String}, Net::HTTPHeader]
-    # @param unwrapped [Hash{Symbol=>Object}]
-    #
-    def initialize(client:, req:, headers:, unwrapped:)
-      @client = client
-      @req = req
+    # @param page_data [Hash{Symbol=>Object}]
+    def initialize(client:, req:, headers:, page_data:)
+      super
       model = req.fetch(:model)
 
-      case unwrapped
+      case page_data
       in {individuals: Array | nil => individuals}
-        @individuals = individuals&.map { model.coerce(_1) }
+        @individuals = individuals&.map { FinchAPI::Converter.coerce(model, _1) }
       else
       end
 
-      case unwrapped
+      case page_data
       in {paging: Hash | nil => paging}
         @paging = FinchAPI::Models::Paging.coerce(paging)
       else
       end
     end
-    # rubocop:enable Lint/UnusedMethodArgument
 
     # @return [Boolean]
-    #
     def next_page?
-      paging&.offset.to_i + individuals.size < paging&.count.to_i
+      paging&.offset.to_i + individuals.to_a.size < paging&.count.to_i
     end
 
     # @raise [FinchAPI::HTTP::Error]
     # @return [FinchAPI::IndividualsPage]
-    #
     def next_page
       unless next_page?
-        raise RuntimeError.new("No more pages available; please check #next_page? before calling #next_page")
+        message = "No more pages available. Please check #next_page? before calling ##{__method__}"
+        raise RuntimeError.new(message)
       end
 
-      req = FinchAPI::Util.deep_merge(@req, {query: {offset: paging&.offset.to_i + individuals.size}})
+      req = FinchAPI::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 #auto_paging_each")
+        raise ArgumentError.new("A block must be given to ##{__method__}")
       end
       page = self
       loop do
@@ -90,7 +85,6 @@ module FinchAPI
     end
 
     # @return [String]
-    #
     def inspect
       "#<#{self.class}:0x#{object_id.to_s(16)} individuals=#{individuals.inspect} paging=#{paging.inspect}>"
     end

data/lib/finch-api/models/account_update_event.rb

@@ -1918,26 +1918,10 @@ module FinchAPI
             end
           end
 
-          # @abstract
-          #
           # The type of authentication method.
-          #
-          # @example
-          # ```ruby
-          # case type
-          # in :assisted
-          #   # ...
-          # in :credential
-          #   # ...
-          # in :api_token
-          #   # ...
-          # in :api_credential
-          #   # ...
-          # in :oauth
-          #   # ...
-          # end
-          # ```
-          class Type < FinchAPI::Enum
+          module Type
+            extend FinchAPI::Enum
+
             ASSISTED = :assisted
             CREDENTIAL = :credential
             API_TOKEN = :api_token
@@ -1948,29 +1932,20 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
       end
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case event_type
-      # in :"account.updated"
-      #   # ...
-      # end
-      # ```
-      class EventType < FinchAPI::Enum
+      module EventType
+        extend FinchAPI::Enum
+
         ACCOUNT_UPDATED = :"account.updated"
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/finch-api/models/company_event.rb

@@ -25,23 +25,15 @@ module FinchAPI
 
       # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-      # @abstract
-      #
-      # @example
-      # ```ruby
-      # case event_type
-      # in :"company.updated"
-      #   # ...
-      # end
-      # ```
-      class EventType < FinchAPI::Enum
+      module EventType
+        extend FinchAPI::Enum
+
         COMPANY_UPDATED = :"company.updated"
 
         finalize!
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end

data/lib/finch-api/models/connect/session_new_params.rb

@@ -85,28 +85,10 @@ module FinchAPI
 
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-        # @abstract
-        #
         # The Finch products that can be requested during the Connect flow.
-        #
-        # @example
-        # ```ruby
-        # case product
-        # in :company
-        #   # ...
-        # in :directory
-        #   # ...
-        # in :individual
-        #   # ...
-        # in :employment
-        #   # ...
-        # in :payment
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class Product < FinchAPI::Enum
+        module Product
+          extend FinchAPI::Enum
+
           COMPANY = :company
           DIRECTORY = :directory
           INDIVIDUAL = :individual
@@ -120,7 +102,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
 
@@ -145,22 +126,9 @@ module FinchAPI
 
           # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-          # @abstract
-          #
-          # @example
-          # ```ruby
-          # case auth_method
-          # in :assisted
-          #   # ...
-          # in :credential
-          #   # ...
-          # in :oauth
-          #   # ...
-          # in :api_token
-          #   # ...
-          # end
-          # ```
-          class AuthMethod < FinchAPI::Enum
+          module AuthMethod
+            extend FinchAPI::Enum
+
             ASSISTED = :assisted
             CREDENTIAL = :credential
             OAUTH = :oauth
@@ -170,23 +138,13 @@ module FinchAPI
 
             # @!parse
             #   # @return [Array<Symbol>]
-            #   #
             #   def self.values; end
           end
         end
 
-        # @abstract
-        #
-        # @example
-        # ```ruby
-        # case sandbox
-        # in :finch
-        #   # ...
-        # in :provider
-        #   # ...
-        # end
-        # ```
-        class Sandbox < FinchAPI::Enum
+        module Sandbox
+          extend FinchAPI::Enum
+
           FINCH = :finch
           PROVIDER = :provider
 
@@ -194,7 +152,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/finch-api/models/connect/session_reauthenticate_params.rb

@@ -46,28 +46,10 @@ module FinchAPI
 
         # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-        # @abstract
-        #
         # The Finch products that can be requested during the Connect flow.
-        #
-        # @example
-        # ```ruby
-        # case product
-        # in :company
-        #   # ...
-        # in :directory
-        #   # ...
-        # in :individual
-        #   # ...
-        # in :employment
-        #   # ...
-        # in :payment
-        #   # ...
-        # in ...
-        #   #...
-        # end
-        # ```
-        class Product < FinchAPI::Enum
+        module Product
+          extend FinchAPI::Enum
+
           COMPANY = :company
           DIRECTORY = :directory
           INDIVIDUAL = :individual
@@ -81,7 +63,6 @@ module FinchAPI
 
           # @!parse
           #   # @return [Array<Symbol>]
-          #   #
           #   def self.values; end
         end
       end

data/lib/finch-api/models/connection_status_type.rb

@@ -2,26 +2,9 @@
 
 module FinchAPI
   module Models
-    # @abstract
-    #
-    # @example
-    # ```ruby
-    # case connection_status_type
-    # in :pending
-    #   # ...
-    # in :processing
-    #   # ...
-    # in :connected
-    #   # ...
-    # in :error_no_account_setup
-    #   # ...
-    # in :error_permissions
-    #   # ...
-    # in ...
-    #   #...
-    # end
-    # ```
-    class ConnectionStatusType < FinchAPI::Enum
+    module ConnectionStatusType
+      extend FinchAPI::Enum
+
       PENDING = :pending
       PROCESSING = :processing
       CONNECTED = :connected
@@ -33,7 +16,6 @@ module FinchAPI
 
       # @!parse
       #   # @return [Array<Symbol>]
-      #   #
       #   def self.values; end
     end
   end

data/lib/finch-api/models/create_access_token_response.rb

@@ -103,22 +103,10 @@ module FinchAPI
 
       # def initialize: (Hash | FinchAPI::BaseModel) -> void
 
-      # @abstract
-      #
       # The type of application associated with a token.
-      #
-      # @example
-      # ```ruby
-      # case client_type
-      # in :production
-      #   # ...
-      # in :development
-      #   # ...
-      # in :sandbox
-      #   # ...
-      # end
-      # ```
-      class ClientType < FinchAPI::Enum
+      module ClientType
+        extend FinchAPI::Enum
+
         PRODUCTION = :production
         DEVELOPMENT = :development
         SANDBOX = :sandbox
@@ -127,27 +115,16 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
 
-      # @abstract
-      #
       # The type of the connection associated with the token.
       #
       #   - `provider` - connection to an external provider
       #   - `finch` - finch-generated data.
-      #
-      # @example
-      # ```ruby
-      # case connection_type
-      # in :provider
-      #   # ...
-      # in :finch
-      #   # ...
-      # end
-      # ```
-      class ConnectionType < FinchAPI::Enum
+      module ConnectionType
+        extend FinchAPI::Enum
+
         PROVIDER = :provider
         FINCH = :finch
 
@@ -155,7 +132,6 @@ module FinchAPI
 
         # @!parse
         #   # @return [Array<Symbol>]
-        #   #
         #   def self.values; end
       end
     end