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

data/rbi/lib/finch-api/models/sandbox/payment_create_params.rbi

@@ -4,7 +4,7 @@ module FinchAPI
   module Models
     module Sandbox
       class PaymentCreateParams < FinchAPI::BaseModel
-        extend FinchAPI::RequestParameters::Converter
+        extend FinchAPI::Type::RequestParameters::Converter
         include FinchAPI::RequestParameters
 
         sig { returns(T.nilable(String)) }

data/rbi/lib/finch-api/page.rbi

@@ -2,7 +2,7 @@
 
 module FinchAPI
   class Page
-    include FinchAPI::BasePage
+    include FinchAPI::Type::BasePage
 
     Elem = type_member
 

data/rbi/lib/finch-api/request_options.rbi

@@ -1,21 +1,6 @@
 # typed: strong
 
 module FinchAPI
-  # @api private
-  module RequestParameters
-    # Options to specify HTTP behaviour for this request.
-    sig { returns(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash)) }
-    attr_accessor :request_options
-
-    # @api private
-    module Converter
-      # @api private
-      sig { params(params: T.anything).returns([T.anything, FinchAPI::Util::AnyHash]) }
-      def dump_request(params)
-      end
-    end
-  end
-
   # Specify HTTP behaviour to use for a specific request. These options supplement
   #   or override those provided at the client level.
   #

data/rbi/lib/finch-api/responses_page.rbi

@@ -2,7 +2,7 @@
 
 module FinchAPI
   class ResponsesPage
-    include FinchAPI::BasePage
+    include FinchAPI::Type::BasePage
 
     Elem = type_member
 

data/rbi/lib/finch-api/single_page.rbi

@@ -2,7 +2,7 @@
 
 module FinchAPI
   class SinglePage < ::Array
-    include FinchAPI::BasePage
+    include FinchAPI::Type::BasePage
 
     Elem = type_member
 

data/rbi/lib/finch-api/transport/base_client.rbi

@@ -0,0 +1,204 @@
+# typed: strong
+
+module FinchAPI
+  module Transport
+    # @api private
+    class BaseClient
+      abstract!
+
+      RequestComponentsShape =
+        T.type_alias do
+          {
+            method: Symbol,
+            path: T.any(String, T::Array[String]),
+            query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
+            headers: T.nilable(
+              T::Hash[String,
+                      T.nilable(
+                        T.any(
+                          String,
+                          Integer,
+                          T::Array[T.nilable(T.any(String, Integer))]
+                        )
+                      )]
+            ),
+            body: T.nilable(T.anything),
+            unwrap: T.nilable(Symbol),
+            page: T.nilable(T::Class[FinchAPI::Type::BasePage[FinchAPI::BaseModel]]),
+            stream: T.nilable(T::Class[T.anything]),
+            model: T.nilable(FinchAPI::Type::Converter::Input),
+            options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
+          }
+        end
+
+      RequestInputShape =
+        T.type_alias do
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: T::Hash[String, String],
+            body: T.anything,
+            max_retries: Integer,
+            timeout: Float
+          }
+        end
+
+      # from whatwg fetch spec
+      MAX_REDIRECTS = 20
+
+      PLATFORM_HEADERS = T::Hash[String, String]
+
+      class << self
+        # @api private
+        sig { params(req: FinchAPI::Transport::BaseClient::RequestComponentsShape).void }
+        def validate!(req)
+        end
+
+        # @api private
+        sig do
+          params(
+            status: Integer,
+            headers: T.any(
+              T::Hash[String, String],
+              Net::HTTPHeader
+            )
+          ).returns(T::Boolean)
+        end
+        def should_retry?(status, headers:)
+        end
+
+        # @api private
+        sig do
+          params(
+            request: FinchAPI::Transport::BaseClient::RequestInputShape,
+            status: Integer,
+            response_headers: T.any(T::Hash[String, String], Net::HTTPHeader)
+          )
+            .returns(FinchAPI::Transport::BaseClient::RequestInputShape)
+        end
+        def follow_redirect(request, status:, response_headers:)
+        end
+
+        # @api private
+        sig do
+          params(
+            status: T.any(Integer, FinchAPI::APIConnectionError),
+            stream: T.nilable(T::Enumerable[String])
+          ).void
+        end
+        def reap_connection!(status, stream:)
+        end
+      end
+
+      # @api private
+      sig { returns(FinchAPI::Transport::PooledNetRequester) }
+      attr_accessor :requester
+
+      # @api private
+      sig do
+        params(
+          base_url: String,
+          timeout: Float,
+          max_retries: Integer,
+          initial_retry_delay: Float,
+          max_retry_delay: Float,
+          headers: T::Hash[String,
+                           T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))],
+          idempotency_header: T.nilable(String)
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(
+        base_url:,
+        timeout: 0.0,
+        max_retries: 0,
+        initial_retry_delay: 0.0,
+        max_retry_delay: 0.0,
+        headers: {},
+        idempotency_header: nil
+      )
+      end
+
+      # @api private
+      sig { overridable.returns(T::Hash[String, String]) }
+      private def auth_headers
+      end
+
+      # @api private
+      sig { returns(String) }
+      private def generate_idempotency_key
+      end
+
+      # @api private
+      sig do
+        overridable
+          .params(req: FinchAPI::Transport::BaseClient::RequestComponentsShape, opts: FinchAPI::Util::AnyHash)
+          .returns(FinchAPI::Transport::BaseClient::RequestInputShape)
+      end
+      private def build_request(req, opts)
+      end
+
+      # @api private
+      sig { params(headers: T::Hash[String, String], retry_count: Integer).returns(Float) }
+      private def retry_delay(headers, retry_count:)
+      end
+
+      # @api private
+      sig do
+        params(
+          request: FinchAPI::Transport::BaseClient::RequestInputShape,
+          redirect_count: Integer,
+          retry_count: Integer,
+          send_retry_header: T::Boolean
+        )
+          .returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
+      end
+      private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
+      end
+
+      # Execute the request specified by `req`. This is the method that all resource
+      #   methods call into.
+      sig do
+        params(
+          method: Symbol,
+          path: T.any(String, T::Array[String]),
+          query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]),
+          headers: T.nilable(
+            T::Hash[String,
+                    T.nilable(
+                      T.any(
+                        String,
+                        Integer,
+                        T::Array[T.nilable(T.any(String, Integer))]
+                      )
+                    )]
+          ),
+          body: T.nilable(T.anything),
+          unwrap: T.nilable(Symbol),
+          page: T.nilable(T::Class[FinchAPI::Type::BasePage[FinchAPI::BaseModel]]),
+          stream: T.nilable(T::Class[T.anything]),
+          model: T.nilable(FinchAPI::Type::Converter::Input),
+          options: T.nilable(T.any(FinchAPI::RequestOptions, FinchAPI::Util::AnyHash))
+        )
+          .returns(T.anything)
+      end
+      def request(
+        method,
+        path,
+        query: {},
+        headers: {},
+        body: nil,
+        unwrap: nil,
+        page: nil,
+        stream: nil,
+        model: FinchAPI::Unknown,
+        options: {}
+      )
+      end
+
+      sig { returns(String) }
+      def inspect
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/transport/pooled_net_requester.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module FinchAPI
+  module Transport
+    # @api private
+    class PooledNetRequester
+      RequestShape =
+        T.type_alias do
+          {
+            method: Symbol,
+            url: URI::Generic,
+            headers: T::Hash[String, String],
+            body: T.anything,
+            deadline: Float
+          }
+        end
+
+      # from the golang stdlib
+      #   https://github.com/golang/go/blob/c8eced8580028328fde7c03cbfcb720ce15b2358/src/net/http/transport.go#L49
+      KEEP_ALIVE_TIMEOUT = 30
+
+      class << self
+        # @api private
+        sig { params(url: URI::Generic).returns(Net::HTTP) }
+        def connect(url)
+        end
+
+        # @api private
+        sig { params(conn: Net::HTTP, deadline: Float).void }
+        def calibrate_socket_timeout(conn, deadline)
+        end
+
+        # @api private
+        sig do
+          params(
+            request: FinchAPI::Transport::PooledNetRequester::RequestShape,
+            blk: T.proc.params(arg0: String).void
+          )
+            .returns(Net::HTTPGenericRequest)
+        end
+        def build_request(request, &blk)
+        end
+      end
+
+      # @api private
+      sig { params(url: URI::Generic, deadline: Float, blk: T.proc.params(arg0: Net::HTTP).void).void }
+      private def with_pool(url, deadline:, &blk)
+      end
+
+      # @api private
+      sig do
+        params(request: FinchAPI::Transport::PooledNetRequester::RequestShape)
+          .returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
+      end
+      def execute(request)
+      end
+
+      # @api private
+      sig { params(size: Integer).returns(T.attached_class) }
+      def self.new(size: Etc.nprocessors)
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/type/array_of.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module FinchAPI
+  module Type
+    # @api private
+    #
+    # Array of items of a given type.
+    class ArrayOf
+      include FinchAPI::Type::Converter
+
+      abstract!
+      final!
+
+      Elem = type_member(:out)
+
+      sig(:final) do
+        params(
+          type_info: T.any(
+            FinchAPI::Util::AnyHash,
+            T.proc.returns(FinchAPI::Type::Converter::Input),
+            FinchAPI::Type::Converter::Input
+          ),
+          spec: FinchAPI::Util::AnyHash
+        )
+          .returns(T.attached_class)
+      end
+      def self.[](type_info, spec = {})
+      end
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def ===(other)
+      end
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def ==(other)
+      end
+
+      # @api private
+      sig(:final) do
+        override
+          .params(value: T.any(T::Enumerable[Elem], T.anything), state: FinchAPI::Type::Converter::State)
+          .returns(T.any(T::Array[T.anything], T.anything))
+      end
+      def coerce(value, state:)
+      end
+
+      # @api private
+      sig(:final) do
+        override
+          .params(value: T.any(T::Enumerable[Elem], T.anything))
+          .returns(T.any(T::Array[T.anything], T.anything))
+      end
+      def dump(value)
+      end
+
+      # @api private
+      sig(:final) { returns(Elem) }
+      protected def item_type
+      end
+
+      # @api private
+      sig(:final) { returns(T::Boolean) }
+      protected def nilable?
+      end
+
+      # @api private
+      sig(:final) do
+        params(
+          type_info: T.any(
+            FinchAPI::Util::AnyHash,
+            T.proc.returns(FinchAPI::Type::Converter::Input),
+            FinchAPI::Type::Converter::Input
+          ),
+          spec: FinchAPI::Util::AnyHash
+        )
+          .void
+      end
+      def initialize(type_info, spec = {})
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/type/base_model.rbi

@@ -0,0 +1,191 @@
+# typed: strong
+
+module FinchAPI
+  module Type
+    class BaseModel
+      extend FinchAPI::Type::Converter
+
+      abstract!
+
+      KnownFieldShape = T.type_alias { {mode: T.nilable(Symbol), required: T::Boolean, nilable: T::Boolean} }
+
+      class << self
+        # @api private
+        #
+        # Assumes superclass fields are totally defined before fields are accessed /
+        #   defined on subclasses.
+        sig do
+          returns(
+            T::Hash[
+            Symbol,
+            T.all(
+              FinchAPI::BaseModel::KnownFieldShape,
+              {type_fn: T.proc.returns(FinchAPI::Type::Converter::Input)}
+            )
+            ]
+          )
+        end
+        def known_fields
+        end
+
+        # @api private
+        sig do
+          returns(
+            T::Hash[Symbol,
+                    T.all(FinchAPI::BaseModel::KnownFieldShape, {type: FinchAPI::Type::Converter::Input})]
+          )
+        end
+        def fields
+        end
+
+        # @api private
+        sig do
+          params(
+            name_sym: Symbol,
+            required: T::Boolean,
+            type_info: T.any(
+              {
+                const: T.nilable(T.any(NilClass, T::Boolean, Integer, Float, Symbol)),
+                enum: T.nilable(T.proc.returns(FinchAPI::Type::Converter::Input)),
+                union: T.nilable(T.proc.returns(FinchAPI::Type::Converter::Input)),
+                api_name: Symbol,
+                nil?: T::Boolean
+              },
+              T.proc.returns(FinchAPI::Type::Converter::Input),
+              FinchAPI::Type::Converter::Input
+            ),
+            spec: FinchAPI::Util::AnyHash
+          )
+            .void
+        end
+        private def add_field(name_sym, required:, type_info:, spec:)
+        end
+
+        # @api private
+        sig do
+          params(
+            name_sym: Symbol,
+            type_info: T.any(
+              FinchAPI::Util::AnyHash,
+              T.proc.returns(FinchAPI::Type::Converter::Input),
+              FinchAPI::Type::Converter::Input
+            ),
+            spec: FinchAPI::Util::AnyHash
+          )
+            .void
+        end
+        def required(name_sym, type_info, spec = {})
+        end
+
+        # @api private
+        sig do
+          params(
+            name_sym: Symbol,
+            type_info: T.any(
+              FinchAPI::Util::AnyHash,
+              T.proc.returns(FinchAPI::Type::Converter::Input),
+              FinchAPI::Type::Converter::Input
+            ),
+            spec: FinchAPI::Util::AnyHash
+          )
+            .void
+        end
+        def optional(name_sym, type_info, spec = {})
+        end
+
+        # @api private
+        #
+        # `request_only` attributes not excluded from `.#coerce` when receiving responses
+        #   even if well behaved servers should not send them
+        sig { params(blk: T.proc.void).void }
+        private def request_only(&blk)
+        end
+
+        # @api private
+        #
+        # `response_only` attributes are omitted from `.#dump` when making requests
+        sig { params(blk: T.proc.void).void }
+        private def response_only(&blk)
+        end
+
+        sig { params(other: T.anything).returns(T::Boolean) }
+        def ==(other)
+        end
+      end
+
+      sig { params(other: T.anything).returns(T::Boolean) }
+      def ==(other)
+      end
+
+      class << self
+        # @api private
+        sig do
+          override
+            .params(
+              value: T.any(FinchAPI::BaseModel, T::Hash[T.anything, T.anything], T.anything),
+              state: FinchAPI::Type::Converter::State
+            )
+            .returns(T.any(T.attached_class, T.anything))
+        end
+        def coerce(value, state:)
+        end
+
+        # @api private
+        sig do
+          override
+            .params(value: T.any(T.attached_class, T.anything))
+            .returns(T.any(T::Hash[T.anything, T.anything], T.anything))
+        end
+        def dump(value)
+        end
+      end
+
+      # Returns the raw value associated with the given key, if found. Otherwise, nil is
+      #   returned.
+      #
+      #   It is valid to lookup keys that are not in the API spec, for example to access
+      #   undocumented features. This method does not parse response data into
+      #   higher-level types. Lookup by anything other than a Symbol is an ArgumentError.
+      sig { params(key: Symbol).returns(T.nilable(T.anything)) }
+      def [](key)
+      end
+
+      # Returns a Hash of the data underlying this object. O(1)
+      #
+      #   Keys are Symbols and values are the raw values from the response. The return
+      #   value indicates which values were ever set on the object. i.e. there will be a
+      #   key in this hash if they ever were, even if the set value was nil.
+      #
+      #   This method is not recursive. The returned value is shared by the object, so it
+      #   should not be mutated.
+      sig { overridable.returns(FinchAPI::Util::AnyHash) }
+      def to_h
+      end
+
+      # Returns a Hash of the data underlying this object. O(1)
+      #
+      #   Keys are Symbols and values are the raw values from the response. The return
+      #   value indicates which values were ever set on the object. i.e. there will be a
+      #   key in this hash if they ever were, even if the set value was nil.
+      #
+      #   This method is not recursive. The returned value is shared by the object, so it
+      #   should not be mutated.
+      sig { overridable.returns(FinchAPI::Util::AnyHash) }
+      def to_hash
+      end
+
+      sig { params(keys: T.nilable(T::Array[Symbol])).returns(FinchAPI::Util::AnyHash) }
+      def deconstruct_keys(keys)
+      end
+
+      # Create a new instance of a model.
+      sig { params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(T.attached_class) }
+      def self.new(data = {})
+      end
+
+      sig { returns(String) }
+      def inspect
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/type/base_page.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module FinchAPI
+  module Type
+    module BasePage
+      Elem = type_member(:out)
+
+      sig { overridable.returns(T::Boolean) }
+      def next_page?
+      end
+
+      sig { overridable.returns(T.self_type) }
+      def next_page
+      end
+
+      sig { overridable.params(blk: T.proc.params(arg0: Elem).void).void }
+      def auto_paging_each(&blk)
+      end
+
+      sig { returns(T::Enumerable[Elem]) }
+      def to_enum
+      end
+
+      # @api private
+      sig do
+        params(
+          client: FinchAPI::Transport::BaseClient,
+          req: FinchAPI::Transport::BaseClient::RequestComponentsShape,
+          headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+          page_data: T.anything
+        )
+          .void
+      end
+      def initialize(client:, req:, headers:, page_data:)
+      end
+    end
+  end
+end

data/rbi/lib/finch-api/type/boolean_model.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module FinchAPI
+  module Type
+    # @api private
+    #
+    # Ruby has no Boolean class; this is something for models to refer to.
+    class BooleanModel
+      extend FinchAPI::Type::Converter
+
+      abstract!
+      final!
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def self.===(other)
+      end
+
+      sig(:final) { params(other: T.anything).returns(T::Boolean) }
+      def self.==(other)
+      end
+
+      class << self
+        # @api private
+        sig(:final) do
+          override
+            .params(value: T.any(T::Boolean, T.anything), state: FinchAPI::Type::Converter::State)
+            .returns(T.any(T::Boolean, T.anything))
+        end
+        def coerce(value, state:)
+        end
+
+        # @api private
+        sig(:final) do
+          override.params(value: T.any(T::Boolean, T.anything)).returns(T.any(T::Boolean, T.anything))
+        end
+        def dump(value)
+        end
+      end
+    end
+  end
+end