finch-api 0.1.0.pre.alpha.5 → 0.1.0.pre.alpha.13

data/lib/finch_api/client.rb

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  class Client < FinchAPI::Internal::Transport::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
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def auth_headers
+      {**bearer_auth, **basic_auth}
+    end
+
+    # @api private
+    #
+    # @return [Hash{String=>String}]
+    private def bearer_auth
+      return {} if @access_token.nil?
+
+      {"authorization" => "Bearer #{@access_token}"}
+    end
+
+    # @api 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 client_id [String, nil] Defaults to `ENV["FINCH_CLIENT_ID"]`
+    #
+    # @param client_secret [String, nil] Defaults to `ENV["FINCH_CLIENT_SECRET"]`
+    #
+    # @param access_token [String, nil]
+    #
+    # @param base_url [String, nil] Override the default base URL for the API, e.g.,
+    # `"https://api.example.com/v2/"`. Defaults to `ENV["FINCH_BASE_URL"]`
+    #
+    # @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(
+      client_id: ENV["FINCH_CLIENT_ID"],
+      client_secret: ENV["FINCH_CLIENT_SECRET"],
+      access_token: nil,
+      base_url: ENV["FINCH_BASE_URL"],
+      max_retries: FinchAPI::Client::DEFAULT_MAX_RETRIES,
+      timeout: FinchAPI::Client::DEFAULT_TIMEOUT_IN_SECONDS,
+      initial_retry_delay: FinchAPI::Client::DEFAULT_INITIAL_RETRY_DELAY,
+      max_retry_delay: FinchAPI::Client::DEFAULT_MAX_RETRY_DELAY
+    )
+      base_url ||= "https://api.tryfinch.com"
+
+      headers = {
+        "finch-api-version" => "2020-09-17"
+      }
+
+      @client_id = client_id&.to_s
+      @client_secret = client_secret&.to_s
+      @access_token = access_token&.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,192 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Errors
+    class Error < StandardError
+      # @!attribute cause
+      #
+      #   @return [StandardError, nil]
+    end
+
+    class ConversionError < FinchAPI::Errors::Error
+    end
+
+    class APIError < FinchAPI::Errors::Error
+      # @return [URI::Generic]
+      attr_accessor :url
+
+      # @return [Integer, nil]
+      attr_accessor :status
+
+      # @return [Object, nil]
+      attr_accessor :body
+
+      # @api 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::Errors::APIError
+      # @!attribute status
+      #
+      #   @return [nil]
+
+      # @!attribute body
+      #
+      #   @return [nil]
+
+      # @api 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::Errors::APIConnectionError
+      # @api 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::Errors::APIError
+      # @api private
+      #
+      # @param url [URI::Generic]
+      # @param status [Integer]
+      # @param body [Object, nil]
+      # @param request [nil]
+      # @param response [nil]
+      # @param message [String, nil]
+      #
+      # @return [FinchAPI::Errors::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::Errors::BadRequestError.new(**kwargs)
+        in 401
+          FinchAPI::Errors::AuthenticationError.new(**kwargs)
+        in 403
+          FinchAPI::Errors::PermissionDeniedError.new(**kwargs)
+        in 404
+          FinchAPI::Errors::NotFoundError.new(**kwargs)
+        in 409
+          FinchAPI::Errors::ConflictError.new(**kwargs)
+        in 422
+          FinchAPI::Errors::UnprocessableEntityError.new(**kwargs)
+        in 429
+          FinchAPI::Errors::RateLimitError.new(**kwargs)
+        in (500..)
+          FinchAPI::Errors::InternalServerError.new(**kwargs)
+        else
+          FinchAPI::Errors::APIStatusError.new(**kwargs)
+        end
+      end
+
+      # @!parse
+      #   # @return [Integer]
+      #   attr_accessor :status
+
+      # @api 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::Errors::APIStatusError
+      HTTP_STATUS = 400
+    end
+
+    class AuthenticationError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 401
+    end
+
+    class PermissionDeniedError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 403
+    end
+
+    class NotFoundError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 404
+    end
+
+    class ConflictError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 409
+    end
+
+    class UnprocessableEntityError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 422
+    end
+
+    class RateLimitError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = 429
+    end
+
+    class InternalServerError < FinchAPI::Errors::APIStatusError
+      HTTP_STATUS = (500..)
+    end
+  end
+end

data/lib/finch_api/file_part.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  class FilePart
+    # @return [Pathname, StringIO, IO, String]
+    attr_reader :content
+
+    # @return [String, nil]
+    attr_reader :content_type
+
+    # @return [String, nil]
+    attr_reader :filename
+
+    # @api private
+    #
+    # @return [String]
+    private def read
+      case content
+      in Pathname
+        content.read(binmode: true)
+      in StringIO
+        content.string
+      in IO
+        content.read
+      in String
+        content
+      end
+    end
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_json(*a) = read.to_json(*a)
+
+    # @param a [Object]
+    #
+    # @return [String]
+    def to_yaml(*a) = read.to_yaml(*a)
+
+    # @param content [Pathname, StringIO, IO, String]
+    # @param filename [String, nil]
+    # @param content_type [String, nil]
+    def initialize(content, filename: nil, content_type: nil)
+      @content = content
+      @filename =
+        case content
+        in Pathname
+          filename.nil? ? content.basename.to_path : File.basename(filename)
+        else
+          filename.nil? ? nil : File.basename(filename)
+        end
+      @content_type = content_type
+    end
+  end
+end

data/lib/finch_api/internal/individuals_page.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if individuals_page.has_next?
+    #     individuals_page = individuals_page.next_page
+    #   end
+    #
+    # @example
+    #   individuals_page.auto_paging_each do |directory|
+    #     puts(directory)
+    #   end
+    class IndividualsPage
+      include FinchAPI::Internal::Type::BasePage
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :individuals
+
+      # @return [FinchAPI::Models::Paging]
+      attr_accessor :paging
+
+      # @return [Boolean]
+      def next_page?
+        paging&.offset.to_i + individuals.to_a.size < paging&.count.to_i
+      end
+
+      # @raise [FinchAPI::HTTP::Error]
+      # @return [self]
+      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]
+      #
+      # @yieldparam [generic<Elem>]
+      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)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @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
+
+        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
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = FinchAPI::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+    end
+  end
+end

data/lib/finch_api/internal/page.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if page.has_next?
+    #     page = page.next_page
+    #   end
+    #
+    # @example
+    #   page.auto_paging_each do |item|
+    #     puts(item)
+    #   end
+    class Page
+      include FinchAPI::Internal::Type::BasePage
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :data
+
+      # @return [FinchAPI::Models::Paging]
+      attr_accessor :paging
+
+      # @return [Boolean]
+      def next_page?
+        paging&.offset.to_i + data.to_a.size < paging&.count.to_i
+      end
+
+      # @raise [FinchAPI::HTTP::Error]
+      # @return [self]
+      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]
+      #
+      # @yieldparam [generic<Elem>]
+      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)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @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
+
+        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
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = FinchAPI::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+    end
+  end
+end

data/lib/finch_api/internal/responses_page.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  module Internal
+    # @generic Elem
+    #
+    # @example
+    #   if responses_page.has_next?
+    #     responses_page = responses_page.next_page
+    #   end
+    #
+    # @example
+    #   responses_page.auto_paging_each do |pay_statement_item|
+    #     puts(pay_statement_item)
+    #   end
+    class ResponsesPage
+      include FinchAPI::Internal::Type::BasePage
+
+      # @return [Array<generic<Elem>>, nil]
+      attr_accessor :responses
+
+      # @return [Boolean]
+      def next_page?
+        false
+      end
+
+      # @raise [FinchAPI::HTTP::Error]
+      # @return [self]
+      def next_page
+        RuntimeError.new("No more pages available.")
+      end
+
+      # @param blk [Proc]
+      #
+      # @yieldparam [generic<Elem>]
+      def auto_paging_each(&blk)
+        unless block_given?
+          raise ArgumentError.new("A block must be given to ##{__method__}")
+        end
+
+        page = self
+        loop do
+          page.responses&.each(&blk)
+
+          break unless page.next_page?
+          page = page.next_page
+        end
+      end
+
+      # @api private
+      #
+      # @param client [FinchAPI::Internal::Transport::BaseClient]
+      # @param req [Hash{Symbol=>Object}]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      # @param page_data [Array<Object>]
+      def initialize(client:, req:, headers:, page_data:)
+        super
+
+        case page_data
+        in {responses: Array | nil => responses}
+          @responses = responses&.map { FinchAPI::Internal::Type::Converter.coerce(@model, _1) }
+        else
+        end
+      end
+
+      # @api private
+      #
+      # @return [String]
+      def inspect
+        model = FinchAPI::Internal::Type::Converter.inspect(@model, depth: 1)
+
+        "#<#{self.class}[#{model}]:0x#{object_id.to_s(16)}>"
+      end
+    end
+  end
+end