finch-api 0.1.0.pre.alpha.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 260e53c135137f098cf627393777300544df0b1dfd30489389af1b5703ce2acd
+  data.tar.gz: 219d07fcc8c72e40aea5bdcc41e3de9eefae11f4dad02c7fa269d55df370276f
+SHA512:
+  metadata.gz: 3b4f44ef66f40d2dea1c354c256983ed4749aad16e978cacfee6513cccf895fa0ca8fb9bbb3455ca75c85820772cc92caca029f6578b522d941d742932dd8f32
+  data.tar.gz: 342f5568ee0508357aeef589fc05eba8f06b119b3935ef6b4c83a04c16cb686085feacbd8f6083d785e39de6dfb121dcb2d8c6107744e8f828b855100357ca39

data/README.md

@@ -0,0 +1,124 @@
+# Finch Ruby API library
+
+The Finch Ruby library provides convenient access to the Finch REST API from any Ruby 3.0.0+
+application.
+
+It is generated with [Stainless](https://www.stainless.com/).
+
+## Documentation
+
+Documentation for the most recent release of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api/latest).
+
+The underlying REST API documentation can be found on [developer.tryfinch.com](https://developer.tryfinch.com/).
+
+## Installation
+
+To use this gem during the beta, install directly from GitHub with Bundler by
+adding the following to your application's `Gemfile`:
+
+```ruby
+gem "finch-api", git: "https://github.com/Finch-API/finch-api-ruby", branch: "main"
+```
+
+To fetch an initial copy of the gem:
+
+```sh
+bundle install
+```
+
+To update the version used by your application when updates are pushed to
+GitHub:
+
+```sh
+bundle update finch-api
+```
+
+## Usage
+
+```ruby
+require "bundler/setup"
+require "finch-api"
+
+finch = FinchAPI::Client.new(access_token: "My Access Token")
+
+page = finch.hris.directory.list
+
+puts(page.id)
+```
+
+### Errors
+
+When the library is unable to connect to the API, or if the API returns a
+non-success status code (i.e., 4xx or 5xx response), a subclass of
+`FinchAPI::Error` will be thrown:
+
+```ruby
+begin
+  company = finch.hris.company.retrieve
+rescue FinchAPI::Error => e
+  puts(e.status) # 400
+end
+```
+
+Error codes are as followed:
+
+| Cause            | Error Type                 |
+| ---------------- | -------------------------- |
+| HTTP 400         | `BadRequestError`          |
+| HTTP 401         | `AuthenticationError`      |
+| HTTP 403         | `PermissionDeniedError`    |
+| HTTP 404         | `NotFoundError`            |
+| HTTP 409         | `ConflictError`            |
+| HTTP 422         | `UnprocessableEntityError` |
+| HTTP 429         | `RateLimitError`           |
+| HTTP >=500       | `InternalServerError`      |
+| Other HTTP error | `APIStatusError`           |
+| Timeout          | `APITimeoutError`          |
+| Network error    | `APIConnectionError`       |
+
+### Retries
+
+Certain errors will be automatically retried 2 times by default, with a short
+exponential backoff. Connection errors (for example, due to a network
+connectivity problem), 408 Request Timeout, 409 Conflict, 429 Rate Limit, >=500 Internal errors,
+and timeouts will all be retried by default.
+
+You can use the `max_retries` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+finch = FinchAPI::Client.new(
+  max_retries: 0 # default is 2
+)
+
+# Or, configure per-request:
+finch.hris.directory.list(request_options: {max_retries: 5})
+```
+
+### Timeouts
+
+By default, requests will time out after 60 seconds.
+Timeouts are applied separately to the initial connection and the overall request time,
+so in some cases a request could wait 2\*timeout seconds before it fails.
+
+You can use the `timeout` option to configure or disable this:
+
+```ruby
+# Configure the default for all requests:
+finch = FinchAPI::Client.new(
+  timeout: nil # default is 60
+)
+
+# Or, configure per-request:
+finch.hris.directory.list(request_options: {timeout: 5})
+```
+
+## Versioning
+
+This package follows [SemVer](https://semver.org/spec/v2.0.0.html) conventions. As the
+library is in initial development and has a major version of `0`, APIs may change
+at any time.
+
+## Requirements
+
+Ruby 3.0 or higher.

data/lib/finch-api/base_client.rb

@@ -0,0 +1,464 @@
+# frozen_string_literal: true
+
+module FinchAPI
+  # @private
+  #
+  # @abstract
+  #
+  class BaseClient
+    # from whatwg fetch spec
+    MAX_REDIRECTS = 20
+
+    # rubocop:disable Style/MutableConstant
+    PLATFORM_HEADERS = {
+      "x-stainless-arch" => FinchAPI::Util.arch,
+      "x-stainless-lang" => "ruby",
+      "x-stainless-os" => FinchAPI::Util.os,
+      "x-stainless-package-version" => FinchAPI::VERSION,
+      "x-stainless-runtime" => ::RUBY_ENGINE,
+      "x-stainless-runtime-version" => ::RUBY_ENGINE_VERSION
+    }
+    # rubocop:enable Style/MutableConstant
+
+    class << self
+      # @private
+      #
+      # @param req [Hash{Symbol=>Object}]
+      #
+      # @raise [ArgumentError]
+      #
+      def validate!(req)
+        keys = [:method, :path, :query, :headers, :body, :unwrap, :page, :stream, :model, :options]
+        case req
+        in Hash
+          req.each_key do |k|
+            unless keys.include?(k)
+              raise ArgumentError.new("Request `req` keys must be one of #{keys}, got #{k.inspect}")
+            end
+          end
+        else
+          raise ArgumentError.new("Request `req` must be a Hash or RequestOptions, got #{req.inspect}")
+        end
+      end
+
+      # @private
+      #
+      # @param status [Integer]
+      # @param headers [Hash{String=>String}, Net::HTTPHeader]
+      #
+      # @return [Boolean]
+      #
+      def should_retry?(status, headers:)
+        coerced = FinchAPI::Util.coerce_boolean(headers["x-should-retry"])
+        case [coerced, status]
+        in [true | false, _]
+          coerced
+        in [_, 408 | 409 | 429 | (500..)]
+          # retry on:
+          # 408: timeouts
+          # 409: locks
+          # 429: rate limits
+          # 500+: unknown errors
+          true
+        else
+          false
+        end
+      end
+
+      # @private
+      #
+      # @param request [Hash{Symbol=>Object}] .
+      #
+      #   @option request [Symbol] :method
+      #
+      #   @option request [URI::Generic] :url
+      #
+      #   @option request [Hash{String=>String}] :headers
+      #
+      #   @option request [Object] :body
+      #
+      #   @option request [Integer] :max_retries
+      #
+      #   @option request [Float] :timeout
+      #
+      # @param status [Integer]
+      #
+      # @param response_headers [Hash{String=>String}, Net::HTTPHeader]
+      #
+      # @return [Hash{Symbol=>Object}]
+      #
+      def follow_redirect(request, status:, response_headers:)
+        method, url, headers = request.fetch_values(:method, :url, :headers)
+        location =
+          Kernel.then do
+            URI.join(url, response_headers["location"])
+          rescue ArgumentError
+            message = "Server responded with status #{status} but no valid location header."
+            raise FinchAPI::APIConnectionError.new(url: url, message: message)
+          end
+
+        request = {**request, url: location}
+
+        case [url.scheme, location.scheme]
+        in ["https", "http"]
+          message = "Tried to redirect to a insecure URL"
+          raise FinchAPI::APIConnectionError.new(url: url, message: message)
+        else
+          nil
+        end
+
+        # from whatwg fetch spec
+        case [status, method]
+        in [301 | 302, :post] | [303, _]
+          drop = %w[content-encoding content-language content-length content-location content-type]
+          request = {
+            **request,
+            method: method == :head ? :head : :get,
+            headers: headers.except(*drop),
+            body: nil
+          }
+        else
+        end
+
+        # from undici
+        if FinchAPI::Util.uri_origin(url) != FinchAPI::Util.uri_origin(location)
+          drop = %w[authorization cookie host proxy-authorization]
+          request = {**request, headers: request.fetch(:headers).except(*drop)}
+        end
+
+        request
+      end
+    end
+
+    # @private
+    #
+    # @return [FinchAPI::PooledNetRequester]
+    attr_accessor :requester
+
+    # @private
+    #
+    # @param base_url [String]
+    # @param timeout [Float]
+    # @param max_retries [Integer]
+    # @param initial_retry_delay [Float]
+    # @param max_retry_delay [Float]
+    # @param headers [Hash{String=>String, Integer, Array<String, Integer, nil>, nil}]
+    # @param idempotency_header [String, nil]
+    #
+    def initialize(
+      base_url:,
+      timeout: 0.0,
+      max_retries: 0,
+      initial_retry_delay: 0.0,
+      max_retry_delay: 0.0,
+      headers: {},
+      idempotency_header: nil
+    )
+      @requester = FinchAPI::PooledNetRequester.new
+      @headers = FinchAPI::Util.normalized_headers(
+        self.class::PLATFORM_HEADERS,
+        {
+          "accept" => "application/json",
+          "content-type" => "application/json"
+        },
+        headers
+      )
+      @base_url = FinchAPI::Util.parse_uri(base_url)
+      @idempotency_header = idempotency_header&.to_s&.downcase
+      @max_retries = max_retries
+      @timeout = timeout
+      @initial_retry_delay = initial_retry_delay
+      @max_retry_delay = max_retry_delay
+    end
+
+    # @private
+    #
+    # @return [Hash{String=>String}]
+    #
+    private def auth_headers = {}
+
+    # @private
+    #
+    # @return [String]
+    #
+    private def generate_idempotency_key = "stainless-ruby-retry-#{SecureRandom.uuid}"
+
+    # @private
+    #
+    # @param req [Hash{Symbol=>Object}] .
+    #
+    #   @option req [Symbol] :method
+    #
+    #   @option req [String, Array<String>] :path
+    #
+    #   @option req [Hash{String=>Array<String>, String, nil}, nil] :query
+    #
+    #   @option req [Hash{String=>String, Integer, Array<String, Integer, nil>, nil}, nil] :headers
+    #
+    #   @option req [Object, nil] :body
+    #
+    #   @option req [Symbol, nil] :unwrap
+    #
+    #   @option req [Class, nil] :page
+    #
+    #   @option req [Class, nil] :stream
+    #
+    #   @option req [FinchAPI::Converter, Class, nil] :model
+    #
+    # @param opts [Hash{Symbol=>Object}] .
+    #
+    #   @option opts [String, nil] :idempotency_key
+    #
+    #   @option opts [Hash{String=>Array<String>, String, nil}, nil] :extra_query
+    #
+    #   @option opts [Hash{String=>String, nil}, nil] :extra_headers
+    #
+    #   @option opts [Hash{Symbol=>Object}, nil] :extra_body
+    #
+    #   @option opts [Integer, nil] :max_retries
+    #
+    #   @option opts [Float, nil] :timeout
+    #
+    # @return [Hash{Symbol=>Object}]
+    #
+    private def build_request(req, opts)
+      method, uninterpolated_path = req.fetch_values(:method, :path)
+
+      path = FinchAPI::Util.interpolate_path(uninterpolated_path)
+
+      query = FinchAPI::Util.deep_merge(req[:query].to_h, opts[:extra_query].to_h)
+
+      headers = FinchAPI::Util.normalized_headers(
+        @headers,
+        auth_headers,
+        req[:headers].to_h,
+        opts[:extra_headers].to_h
+      )
+
+      if @idempotency_header &&
+         !headers.key?(@idempotency_header) &&
+         !Net::HTTP::IDEMPOTENT_METHODS_.include?(method.to_s.upcase)
+        headers[@idempotency_header] = opts.fetch(:idempotency_key) { generate_idempotency_key }
+      end
+
+      unless headers.key?("x-stainless-retry-count")
+        headers["x-stainless-retry-count"] = "0"
+      end
+
+      timeout = opts.fetch(:timeout, @timeout).to_f.clamp((0..))
+      unless headers.key?("x-stainless-read-timeout") || timeout.zero?
+        headers["x-stainless-read-timeout"] = timeout.to_s
+      end
+
+      headers.reject! { |_, v| v.to_s.empty? }
+
+      body =
+        case method
+        in :get | :head | :options | :trace
+          nil
+        else
+          FinchAPI::Util.deep_merge(*[req[:body], opts[:extra_body]].compact)
+        end
+
+      headers, encoded = FinchAPI::Util.encode_content(headers, body)
+      {
+        method: method,
+        url: FinchAPI::Util.join_parsed_uri(@base_url, {**req, path: path, query: query}),
+        headers: headers,
+        body: encoded,
+        max_retries: opts.fetch(:max_retries, @max_retries),
+        timeout: timeout
+      }
+    end
+
+    # @private
+    #
+    # @param headers [Hash{String=>String}]
+    # @param retry_count [Integer]
+    #
+    # @return [Float]
+    #
+    private def retry_delay(headers, retry_count:)
+      # Non-standard extension
+      span = Float(headers["retry-after-ms"], exception: false)&.then { _1 / 1000 }
+      return span if span
+
+      retry_header = headers["retry-after"]
+      return span if (span = Float(retry_header, exception: false))
+
+      span = retry_header&.then do
+        Time.httpdate(_1) - Time.now
+      rescue ArgumentError
+        nil
+      end
+      return span if span
+
+      scale = retry_count**2
+      jitter = 1 - (0.25 * rand)
+      (@initial_retry_delay * scale * jitter).clamp(0, @max_retry_delay)
+    end
+
+    # @private
+    #
+    # @param request [Hash{Symbol=>Object}] .
+    #
+    #   @option request [Symbol] :method
+    #
+    #   @option request [URI::Generic] :url
+    #
+    #   @option request [Hash{String=>String}] :headers
+    #
+    #   @option request [Object] :body
+    #
+    #   @option request [Integer] :max_retries
+    #
+    #   @option request [Float] :timeout
+    #
+    # @param redirect_count [Integer]
+    #
+    # @param retry_count [Integer]
+    #
+    # @param send_retry_header [Boolean]
+    #
+    # @raise [FinchAPI::APIError]
+    # @return [Array(Integer, Net::HTTPResponse, Enumerable)]
+    #
+    private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
+      url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
+      input = {**request.except(:timeout), deadline: FinchAPI::Util.monotonic_secs + timeout}
+
+      if send_retry_header
+        headers["x-stainless-retry-count"] = retry_count.to_s
+      end
+
+      begin
+        response, stream = @requester.execute(input)
+        status = Integer(response.code)
+      rescue FinchAPI::APIConnectionError => e
+        status = e
+      end
+
+      # normally we want to drain the response body and reuse the HTTP session by clearing the socket buffers
+      # unless we hit a server error
+      srv_fault = (500...).include?(status)
+
+      case status
+      in ..299
+        [status, response, stream]
+      in 300..399 if redirect_count >= self.class::MAX_REDIRECTS
+        message = "Failed to complete the request within #{self.class::MAX_REDIRECTS} redirects."
+
+        stream.each { next }
+        raise FinchAPI::APIConnectionError.new(url: url, message: message)
+      in 300..399
+        request = self.class.follow_redirect(request, status: status, response_headers: response)
+
+        stream.each { next }
+        send_request(
+          request,
+          redirect_count: redirect_count + 1,
+          retry_count: retry_count,
+          send_retry_header: send_retry_header
+        )
+      in FinchAPI::APIConnectionError if retry_count >= max_retries
+        raise status
+      in (400..) if retry_count >= max_retries || !self.class.should_retry?(status, headers: response)
+        decoded = FinchAPI::Util.decode_content(response, stream: stream, suppress_error: true)
+
+        if srv_fault
+          FinchAPI::Util.close_fused!(stream)
+        else
+          stream.each { next }
+        end
+
+        raise FinchAPI::APIStatusError.for(
+          url: url,
+          status: status,
+          body: decoded,
+          request: nil,
+          response: response
+        )
+      in (400..) | FinchAPI::APIConnectionError
+        delay = retry_delay(response, retry_count: retry_count)
+
+        if srv_fault
+          FinchAPI::Util.close_fused!(stream)
+        else
+          stream&.each { next }
+        end
+        sleep(delay)
+
+        send_request(
+          request,
+          redirect_count: redirect_count,
+          retry_count: retry_count + 1,
+          send_retry_header: send_retry_header
+        )
+      end
+    end
+
+    # Execute the request specified by `req`. This is the method that all resource
+    #   methods call into.
+    #
+    # @param req [Hash{Symbol=>Object}] .
+    #
+    #   @option req [Symbol] :method
+    #
+    #   @option req [String, Array<String>] :path
+    #
+    #   @option req [Hash{String=>Array<String>, String, nil}, nil] :query
+    #
+    #   @option req [Hash{String=>String, Integer, Array<String, Integer, nil>, nil}, nil] :headers
+    #
+    #   @option req [Object, nil] :body
+    #
+    #   @option req [Symbol, nil] :unwrap
+    #
+    #   @option req [Class, nil] :page
+    #
+    #   @option req [Class, nil] :stream
+    #
+    #   @option req [FinchAPI::Converter, Class, nil] :model
+    #
+    #   @option req [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil] :options
+    #
+    # @raise [FinchAPI::APIError]
+    # @return [Object]
+    #
+    def request(req)
+      self.class.validate!(req)
+      model = req.fetch(:model) { FinchAPI::Unknown }
+      opts = req[:options].to_h
+      FinchAPI::RequestOptions.validate!(opts)
+      request = build_request(req.except(:options), opts)
+      url = request.fetch(:url)
+
+      # Don't send the current retry count in the headers if the caller modified the header defaults.
+      send_retry_header = request.fetch(:headers)["x-stainless-retry-count"] == "0"
+      status, response, stream = send_request(
+        request,
+        redirect_count: 0,
+        retry_count: 0,
+        send_retry_header: send_retry_header
+      )
+
+      decoded = FinchAPI::Util.decode_content(response, stream: stream)
+      case req
+      in { stream: Class => st }
+        st.new(model: model, url: url, status: status, response: response, messages: decoded)
+      in { page: Class => page }
+        page.new(client: self, req: req, headers: response, unwrapped: decoded)
+      else
+        unwrapped = FinchAPI::Util.dig(decoded, req[:unwrap])
+        FinchAPI::Converter.coerce(model, unwrapped)
+      end
+    end
+
+    # @return [String]
+    #
+    def inspect
+      base_url = FinchAPI::Util.unparse_uri(@base_url)
+      "#<#{self.class.name}:0x#{object_id.to_s(16)} base_url=#{base_url} max_retries=#{@max_retries} timeout=#{@timeout}>"
+    end
+  end
+end