finch-api 0.1.0.pre.alpha.1

data/lib/finch-api/base_page.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  # @private
+  #
+  # @abstract
+  #
+  module BasePage
+    # @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
+  end
+end

data/lib/finch-api/client.rb

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  class Client < FinchAPI::BaseClient
+    # Default max number of retries to attempt after a failed retryable request.
+    DEFAULT_MAX_RETRIES = 2
+
+    # Default per-request timeout.
+    DEFAULT_TIMEOUT_IN_SECONDS = 60.0
+
+    # Default initial retry delay in seconds.
+    # Overall delay is calculated using exponential backoff + jitter.
+    DEFAULT_INITIAL_RETRY_DELAY = 0.5
+
+    # Default max retry delay in seconds.
+    DEFAULT_MAX_RETRY_DELAY = 8.0
+
+    # @return [String, nil]
+    attr_reader :access_token
+
+    # @return [String, nil]
+    attr_reader :client_id
+
+    # @return [String, nil]
+    attr_reader :client_secret
+
+    # @return [FinchAPI::Resources::AccessTokens]
+    attr_reader :access_tokens
+
+    # @return [FinchAPI::Resources::HRIS]
+    attr_reader :hris
+
+    # @return [FinchAPI::Resources::Providers]
+    attr_reader :providers
+
+    # @return [FinchAPI::Resources::Account]
+    attr_reader :account
+
+    # @return [FinchAPI::Resources::Webhooks]
+    attr_reader :webhooks
+
+    # @return [FinchAPI::Resources::RequestForwarding]
+    attr_reader :request_forwarding
+
+    # @return [FinchAPI::Resources::Jobs]
+    attr_reader :jobs
+
+    # @return [FinchAPI::Resources::Sandbox]
+    attr_reader :sandbox
+
+    # @return [FinchAPI::Resources::Payroll]
+    attr_reader :payroll
+
+    # @return [FinchAPI::Resources::Connect]
+    attr_reader :connect
+
+    # @private
+    #
+    # @return [Hash{String=>String}]
+    #
+    private def auth_headers
+      {**bearer_auth, **basic_auth}
+    end
+
+    # @private
+    #
+    # @return [Hash{String=>String}]
+    #
+    private def bearer_auth
+      return {} if @access_token.nil?
+
+      {"authorization" => "Bearer #{@access_token}"}
+    end
+
+    # @private
+    #
+    # @return [Hash{String=>String}]
+    #
+    private def basic_auth
+      return {} if @client_id.nil? || @client_secret.nil?
+
+      base64_credentials = ["#{@client_id}:#{@client_secret}"].pack("m0")
+      {"authorization" => "Basic #{base64_credentials}"}
+    end
+
+    # Creates and returns a new client for interacting with the API.
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g., `"https://api.example.com/v2/"`
+    #
+    # @param access_token [String, nil]
+    #
+    # @param client_id [String, nil] Defaults to `ENV["FINCH_CLIENT_ID"]`
+    #
+    # @param client_secret [String, nil] Defaults to `ENV["FINCH_CLIENT_SECRET"]`
+    #
+    # @param max_retries [Integer] Max number of retries to attempt after a failed retryable request.
+    #
+    # @param timeout [Float]
+    #
+    # @param initial_retry_delay [Float]
+    #
+    # @param max_retry_delay [Float]
+    #
+    def initialize(
+      base_url: nil,
+      access_token: nil,
+      client_id: ENV["FINCH_CLIENT_ID"],
+      client_secret: ENV["FINCH_CLIENT_SECRET"],
+      max_retries: DEFAULT_MAX_RETRIES,
+      timeout: DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://api.tryfinch.com"
+
+      headers = {
+        "finch-api-version" => "2020-09-17"
+      }
+
+      @access_token = access_token&.to_s
+      @client_id = client_id&.to_s
+      @client_secret = client_secret&.to_s
+
+      super(
+        base_url: base_url,
+        timeout: timeout,
+        max_retries: max_retries,
+        initial_retry_delay: initial_retry_delay,
+        max_retry_delay: max_retry_delay,
+        headers: headers
+      )
+
+      @access_tokens = FinchAPI::Resources::AccessTokens.new(client: self)
+      @hris = FinchAPI::Resources::HRIS.new(client: self)
+      @providers = FinchAPI::Resources::Providers.new(client: self)
+      @account = FinchAPI::Resources::Account.new(client: self)
+      @webhooks = FinchAPI::Resources::Webhooks.new(client: self)
+      @request_forwarding = FinchAPI::Resources::RequestForwarding.new(client: self)
+      @jobs = FinchAPI::Resources::Jobs.new(client: self)
+      @sandbox = FinchAPI::Resources::Sandbox.new(client: self)
+      @payroll = FinchAPI::Resources::Payroll.new(client: self)
+      @connect = FinchAPI::Resources::Connect.new(client: self)
+    end
+  end
+end

data/lib/finch-api/errors.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  class Error < StandardError
+    # @!parse
+    #   # @return [StandardError, nil]
+    #   attr_reader :cause
+  end
+
+  class ConversionError < FinchAPI::Error
+  end
+
+  class APIError < FinchAPI::Error
+    # @return [URI::Generic]
+    attr_reader :url
+
+    # @return [Integer, nil]
+    attr_reader :status
+
+    # @return [Object, nil]
+    attr_reader :body
+
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [Integer, nil]
+    # @param body [Object, nil]
+    # @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
+      @body = body
+      @request = request
+      @response = response
+      super(message)
+    end
+  end
+
+  class APIConnectionError < FinchAPI::APIError
+    # @!parse
+    #   # @return [nil]
+    #   attr_reader :status
+
+    # @!parse
+    #   # @return [nil]
+    #   attr_reader :body
+
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [nil]
+    # @param body [nil]
+    # @param request [nil]
+    # @param response [nil]
+    # @param message [String, nil]
+    #
+    def initialize(
+      url:,
+      status: nil,
+      body: nil,
+      request: nil,
+      response: nil,
+      message: "Connection error."
+    )
+      super
+    end
+  end
+
+  class APITimeoutError < FinchAPI::APIConnectionError
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [nil]
+    # @param body [nil]
+    # @param request [nil]
+    # @param response [nil]
+    # @param message [String, nil]
+    #
+    def initialize(
+      url:,
+      status: nil,
+      body: nil,
+      request: nil,
+      response: nil,
+      message: "Request timed out."
+    )
+      super
+    end
+  end
+
+  class APIStatusError < FinchAPI::APIError
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [Integer]
+    # @param body [Object, nil]
+    # @param request [nil]
+    # @param response [nil]
+    # @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}
+
+      case status
+      in 400
+        FinchAPI::BadRequestError.new(**kwargs)
+      in 401
+        FinchAPI::AuthenticationError.new(**kwargs)
+      in 403
+        FinchAPI::PermissionDeniedError.new(**kwargs)
+      in 404
+        FinchAPI::NotFoundError.new(**kwargs)
+      in 409
+        FinchAPI::ConflictError.new(**kwargs)
+      in 422
+        FinchAPI::UnprocessableEntityError.new(**kwargs)
+      in 429
+        FinchAPI::RateLimitError.new(**kwargs)
+      in (500..)
+        FinchAPI::InternalServerError.new(**kwargs)
+      else
+        FinchAPI::APIStatusError.new(**kwargs)
+      end
+    end
+
+    # @!parse
+    #   # @return [Integer]
+    #   attr_reader :status
+
+    # @private
+    #
+    # @param url [URI::Generic]
+    # @param status [Integer]
+    # @param body [Object, nil]
+    # @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(
+        url: url,
+        status: status,
+        body: body,
+        request: request,
+        response: response,
+        message: message&.to_s
+      )
+    end
+  end
+
+  class BadRequestError < FinchAPI::APIStatusError
+    HTTP_STATUS = 400
+  end
+
+  class AuthenticationError < FinchAPI::APIStatusError
+    HTTP_STATUS = 401
+  end
+
+  class PermissionDeniedError < FinchAPI::APIStatusError
+    HTTP_STATUS = 403
+  end
+
+  class NotFoundError < FinchAPI::APIStatusError
+    HTTP_STATUS = 404
+  end
+
+  class ConflictError < FinchAPI::APIStatusError
+    HTTP_STATUS = 409
+  end
+
+  class UnprocessableEntityError < FinchAPI::APIStatusError
+    HTTP_STATUS = 422
+  end
+
+  class RateLimitError < FinchAPI::APIStatusError
+    HTTP_STATUS = 429
+  end
+
+  class InternalServerError < FinchAPI::APIStatusError
+    HTTP_STATUS = (500..)
+  end
+end

data/lib/finch-api/extern.rb

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

data/lib/finch-api/individuals_page.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  # @example
+  # ```ruby
+  # if individuals_page.has_next?
+  #   page = individuals_page.next_page
+  # end
+  # ```
+  #
+  # @example
+  # ```ruby
+  # individuals_page.auto_paging_each do |item|
+  # #   item ...
+  # end
+  # ```
+  #
+  # @example
+  # ```ruby
+  # items = individuals_page.to_enum.take(2)
+  #
+  # items => Array
+  # ```
+  class IndividualsPage
+    include FinchAPI::BasePage
+
+    # @return [Array<Object>]
+    attr_accessor :individuals
+
+    # @return [FinchAPI::Models::Paging]
+    attr_accessor :paging
+
+    # rubocop:disable Lint/UnusedMethodArgument
+    # @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
+      model = req.fetch(:model)
+
+      case unwrapped
+      in {individuals: Array | nil => individuals}
+        @individuals = individuals&.map { model.coerce(_1) }
+      else
+      end
+
+      case unwrapped
+      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
+    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")
+      end
+
+      req = FinchAPI::Util.deep_merge(@req, {query: {offset: paging&.offset.to_i + individuals.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")
+      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

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

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class AccessTokenCreateParams < FinchAPI::BaseModel
+      # @!parse
+      #   extend FinchAPI::RequestParameters::Converter
+      include FinchAPI::RequestParameters
+
+      # @!attribute code
+      #
+      #   @return [String]
+      required :code, String
+
+      # @!attribute [r] client_id
+      #
+      #   @return [String, nil]
+      optional :client_id, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :client_id
+
+      # @!attribute [r] client_secret
+      #
+      #   @return [String, nil]
+      optional :client_secret, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :client_secret
+
+      # @!attribute [r] redirect_uri
+      #
+      #   @return [String, nil]
+      optional :redirect_uri, String
+
+      # @!parse
+      #   # @return [String]
+      #   attr_writer :redirect_uri
+
+      # @!parse
+      #   # @param code [String]
+      #   # @param client_id [String]
+      #   # @param client_secret [String]
+      #   # @param redirect_uri [String]
+      #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {}, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class AccountDisconnectParams < FinchAPI::BaseModel
+      # @!parse
+      #   extend FinchAPI::RequestParameters::Converter
+      include FinchAPI::RequestParameters
+
+      # @!parse
+      #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+    end
+  end
+end

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Models
+    class AccountIntrospectParams < FinchAPI::BaseModel
+      # @!parse
+      #   extend FinchAPI::RequestParameters::Converter
+      include FinchAPI::RequestParameters
+
+      # @!parse
+      #   # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
+      #   #
+      #   def initialize(request_options: {}, **) = super
+
+      # def initialize: (Hash | FinchAPI::BaseModel) -> void
+    end
+  end
+end