modern_treasury 0.0.0 → 0.1.0.pre.alpha.16

data/rbi/lib/modern_treasury/util.rbi

@@ -0,0 +1,281 @@
+# typed: strong
+
+module ModernTreasury
+  # @api private
+  module Util
+    # Due to the current WIP status of Shapes support in Sorbet, types referencing
+    #   this alias might be refined in the future.
+    AnyHash = T.type_alias { T::Hash[Symbol, T.anything] }
+
+    # @api private
+    sig { returns(Float) }
+    def self.monotonic_secs
+    end
+
+    class << self
+      # @api private
+      sig { returns(String) }
+      def arch
+      end
+
+      # @api private
+      sig { returns(String) }
+      def os
+      end
+    end
+
+    class << self
+      # @api private
+      sig { params(input: T.anything).returns(T::Boolean) }
+      def primitive?(input)
+      end
+
+      # @api private
+      sig { params(input: T.anything).returns(T.any(T::Boolean, T.anything)) }
+      def coerce_boolean(input)
+      end
+
+      # @api private
+      sig { params(input: T.anything).returns(T.nilable(T::Boolean)) }
+      def coerce_boolean!(input)
+      end
+
+      # @api private
+      sig { params(input: T.anything).returns(T.any(Integer, T.anything)) }
+      def coerce_integer(input)
+      end
+
+      # @api private
+      sig { params(input: T.anything).returns(T.any(Float, T.anything)) }
+      def coerce_float(input)
+      end
+
+      # @api private
+      sig { params(input: T.anything).returns(T.any(T::Hash[T.anything, T.anything], T.anything)) }
+      def coerce_hash(input)
+      end
+    end
+
+    # Use this to indicate that a value should be explicitly removed from a data
+    #   structure when using `ModernTreasury::Util.deep_merge`.
+    #
+    #   e.g. merging `{a: 1}` and `{a: OMIT}` should produce `{}`, where merging
+    #   `{a: 1}` and `{}` would produce `{a: 1}`.
+    OMIT = T.let(T.anything, T.anything)
+
+    class << self
+      # @api private
+      sig { params(lhs: T.anything, rhs: T.anything, concat: T::Boolean).returns(T.anything) }
+      private def deep_merge_lr(lhs, rhs, concat: false)
+      end
+
+      # @api private
+      #
+      # Recursively merge one hash with another. If the values at a given key are not
+      #   both hashes, just take the new value.
+      sig do
+        params(values: T::Array[T.anything], sentinel: T.nilable(T.anything), concat: T::Boolean)
+          .returns(T.anything)
+      end
+      def deep_merge(
+        *values,
+        # the value to return if no values are provided.
+        sentinel: nil,
+        # whether to merge sequences by concatenation.
+        concat: false
+      )
+      end
+
+      # @api private
+      sig do
+        params(
+          data: T.any(ModernTreasury::Util::AnyHash, T::Array[T.anything], T.anything),
+          pick: T.nilable(T.any(Symbol, Integer, T::Array[T.any(Symbol, Integer)])),
+          sentinel: T.nilable(T.anything),
+          blk: T.nilable(T.proc.returns(T.anything))
+        )
+          .returns(T.nilable(T.anything))
+      end
+      def dig(data, pick, sentinel = nil, &blk)
+      end
+    end
+
+    class << self
+      # @api private
+      sig { params(uri: URI::Generic).returns(String) }
+      def uri_origin(uri)
+      end
+
+      # @api private
+      sig { params(path: T.any(String, T::Array[String])).returns(String) }
+      def interpolate_path(path)
+      end
+    end
+
+    class << self
+      # @api private
+      sig { params(query: T.nilable(String)).returns(T::Hash[String, T::Array[String]]) }
+      def decode_query(query)
+      end
+
+      # @api private
+      sig do
+        params(query: T.nilable(T::Hash[String, T.nilable(T.any(T::Array[String], String))]))
+          .returns(T.nilable(String))
+      end
+      def encode_query(query)
+      end
+    end
+
+    ParsedUriShape =
+      T.type_alias do
+        {
+          scheme: T.nilable(String),
+          host: T.nilable(String),
+          port: T.nilable(Integer),
+          path: T.nilable(String),
+          query: T::Hash[String, T::Array[String]]
+        }
+      end
+
+    class << self
+      # @api private
+      sig { params(url: T.any(URI::Generic, String)).returns(ModernTreasury::Util::ParsedUriShape) }
+      def parse_uri(url)
+      end
+
+      # @api private
+      sig { params(parsed: ModernTreasury::Util::ParsedUriShape).returns(URI::Generic) }
+      def unparse_uri(parsed)
+      end
+
+      # @api private
+      sig do
+        params(lhs: ModernTreasury::Util::ParsedUriShape, rhs: ModernTreasury::Util::ParsedUriShape)
+          .returns(URI::Generic)
+      end
+      def join_parsed_uri(lhs, rhs)
+      end
+    end
+
+    class << self
+      # @api private
+      sig do
+        params(
+          headers: T::Hash[String,
+                           T.nilable(T.any(String, Integer, T::Array[T.nilable(T.any(String, Integer))]))]
+        )
+          .returns(T::Hash[String, String])
+      end
+      def normalized_headers(*headers)
+      end
+    end
+
+    # @api private
+    #
+    # An adapter that satisfies the IO interface required by `::IO.copy_stream`
+    class ReadIOAdapter
+      # @api private
+      sig { params(max_len: T.nilable(Integer)).returns(String) }
+      private def read_enum(max_len)
+      end
+
+      # @api private
+      sig { params(max_len: T.nilable(Integer), out_string: T.nilable(String)).returns(T.nilable(String)) }
+      def read(max_len = nil, out_string = nil)
+      end
+
+      # @api private
+      sig do
+        params(
+          stream: T.any(String, IO, StringIO, T::Enumerable[String]),
+          blk: T.proc.params(arg0: String).void
+        )
+          .returns(T.attached_class)
+      end
+      def self.new(stream, &blk)
+      end
+    end
+
+    class << self
+      sig { params(blk: T.proc.params(y: Enumerator::Yielder).void).returns(T::Enumerable[String]) }
+      def string_io(&blk)
+      end
+    end
+
+    class << self
+      # @api private
+      sig do
+        params(y: Enumerator::Yielder, boundary: String, key: T.any(Symbol, String), val: T.anything).void
+      end
+      private def encode_multipart_formdata(y, boundary:, key:, val:)
+      end
+
+      # @api private
+      sig { params(body: T.anything).returns([String, T::Enumerable[String]]) }
+      private def encode_multipart_streaming(body)
+      end
+
+      # @api private
+      sig { params(headers: T::Hash[String, String], body: T.anything).returns(T.anything) }
+      def encode_content(headers, body)
+      end
+
+      # @api private
+      sig do
+        params(
+          headers: T.any(T::Hash[String, String], Net::HTTPHeader),
+          stream: T::Enumerable[String],
+          suppress_error: T::Boolean
+        )
+          .returns(T.anything)
+      end
+      def decode_content(headers, stream:, suppress_error: false)
+      end
+    end
+
+    class << self
+      # @api private
+      #
+      # https://doc.rust-lang.org/std/iter/trait.FusedIterator.html
+      sig do
+        params(enum: T::Enumerable[T.anything], external: T::Boolean, close: T.proc.void)
+          .returns(T::Enumerable[T.anything])
+      end
+      def fused_enum(enum, external: false, &close)
+      end
+
+      # @api private
+      sig { params(enum: T.nilable(T::Enumerable[T.anything])).void }
+      def close_fused!(enum)
+      end
+
+      # @api private
+      sig do
+        params(enum: T.nilable(T::Enumerable[T.anything]), blk: T.proc.params(arg0: Enumerator::Yielder).void)
+          .returns(T::Enumerable[T.anything])
+      end
+      def chain_fused(enum, &blk)
+      end
+    end
+
+    ServerSentEvent =
+      T.type_alias do
+        {event: T.nilable(String), data: T.nilable(String), id: T.nilable(String), retry: T.nilable(Integer)}
+      end
+
+    class << self
+      # @api private
+      sig { params(enum: T::Enumerable[String]).returns(T::Enumerable[String]) }
+      def decode_lines(enum)
+      end
+
+      # @api private
+      #
+      # https://html.spec.whatwg.org/multipage/server-sent-events.html#parsing-an-event-stream
+      sig { params(lines: T::Enumerable[String]).returns(ModernTreasury::Util::ServerSentEvent) }
+      def decode_sse(lines)
+      end
+    end
+  end
+end

data/rbi/lib/modern_treasury/version.rbi

@@ -0,0 +1,5 @@
+# typed: strong
+
+module ModernTreasury
+  VERSION = "0.1.0-alpha.16"
+end

data/sig/modern_treasury/base_client.rbs

@@ -0,0 +1,108 @@
+module ModernTreasury
+  class BaseClient
+    type request_components =
+      {
+        method: Symbol,
+        path: String | ::Array[String],
+        query: ::Hash[String, (::Array[String] | String)?]?,
+        headers: ::Hash[String, (String
+        | Integer
+        | ::Array[(String | Integer)?])?]?,
+        body: top?,
+        unwrap: Symbol?,
+        page: Class?,
+        stream: Class?,
+        model: ModernTreasury::Converter::input?,
+        options: ModernTreasury::request_opts?
+      }
+
+    type request_input =
+      {
+        method: Symbol,
+        url: URI::Generic,
+        headers: ::Hash[String, String],
+        body: top,
+        max_retries: Integer,
+        timeout: Float
+      }
+
+    MAX_REDIRECTS: 20
+
+    PLATFORM_HEADERS: ::Hash[String, String]
+
+    def self.validate!: (
+      ModernTreasury::BaseClient::request_components req
+    ) -> void
+
+    def self.should_retry?: (
+      Integer status,
+      headers: ::Hash[String, String]
+    ) -> bool
+
+    def self.follow_redirect: (
+      ModernTreasury::BaseClient::request_input request,
+      status: Integer,
+      response_headers: ::Hash[String, String]
+    ) -> ModernTreasury::BaseClient::request_input
+
+    def self.reap_connection!: (
+      Integer | ModernTreasury::APIConnectionError status,
+      stream: Enumerable[String]?
+    ) -> void
+
+    # @api private
+    attr_accessor requester: top
+
+    def initialize: (
+      base_url: String,
+      ?timeout: Float,
+      ?max_retries: Integer,
+      ?initial_retry_delay: Float,
+      ?max_retry_delay: Float,
+      ?headers: ::Hash[String, (String
+      | Integer
+      | ::Array[(String | Integer)?])?],
+      ?idempotency_header: String?
+    ) -> void
+
+    private def auth_headers: -> ::Hash[String, String]
+
+    private def generate_idempotency_key: -> String
+
+    private def build_request: (
+      ModernTreasury::BaseClient::request_components req,
+      ModernTreasury::request_options opts
+    ) -> ModernTreasury::BaseClient::request_input
+
+    private def retry_delay: (
+      ::Hash[String, String] headers,
+      retry_count: Integer
+    ) -> Float
+
+    private def send_request: (
+      ModernTreasury::BaseClient::request_input request,
+      redirect_count: Integer,
+      retry_count: Integer,
+      send_retry_header: bool
+    ) -> [Integer, top, Enumerable[String]]
+
+    def request:
+      (
+        Symbol method,
+        String | ::Array[String] path,
+        ?query: ::Hash[String, (::Array[String] | String)?]?,
+        ?headers: ::Hash[String, (String
+        | Integer
+        | ::Array[(String | Integer)?])?]?,
+        ?body: top?,
+        ?unwrap: Symbol?,
+        ?page: Class?,
+        ?stream: Class?,
+        ?model: ModernTreasury::Converter::input?,
+        ?options: ModernTreasury::request_opts?
+      ) -> top
+      | (ModernTreasury::BaseClient::request_components req) -> top
+
+    def inspect: -> String
+  end
+end

data/sig/modern_treasury/base_model.rbs

@@ -0,0 +1,262 @@
+module ModernTreasury
+  module Converter
+    type input = ModernTreasury::Converter | Class
+
+    def coerce: (top value) -> top
+
+    def dump: (top value) -> top
+
+    def try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+
+    def self.type_info: (
+      {
+        const: (nil | bool | Integer | Float | Symbol)?,
+        enum: ^-> ModernTreasury::Converter::input?,
+        union: ^-> ModernTreasury::Converter::input?
+      }
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input spec
+    ) -> (^-> top)
+
+    def self.coerce: (ModernTreasury::Converter::input target, top value) -> top
+
+    def self.dump: (ModernTreasury::Converter::input target, top value) -> top
+
+    def self.try_strict_coerce: (
+      ModernTreasury::Converter::input target,
+      top value
+    ) -> top
+  end
+
+  class Unknown
+    extend ModernTreasury::Converter
+
+    def self.===: (top other) -> bool
+
+    def self.==: (top other) -> bool
+
+    def self.coerce: (top value) -> top
+
+    def self.dump: (top value) -> top
+
+    def self.try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+  end
+
+  class BooleanModel
+    extend ModernTreasury::Converter
+
+    def self.===: (top other) -> bool
+
+    def self.==: (top other) -> bool
+
+    def self.coerce: (bool | top value) -> (bool | top)
+
+    def self.dump: (bool | top value) -> (bool | top)
+
+    def self.try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+  end
+
+  module Enum
+    include ModernTreasury::Converter
+
+    def self.values: -> ::Array[(nil | bool | Integer | Float | Symbol)]
+
+    private def self.finalize!: -> void
+
+    def ===: (top other) -> bool
+
+    def ==: (top other) -> bool
+
+    def coerce: (String | Symbol | top value) -> (Symbol | top)
+
+    def dump: (Symbol | top value) -> (Symbol | top)
+
+    def try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+  end
+
+  module Union
+    include ModernTreasury::Converter
+
+    private def self.known_variants: -> ::Array[[Symbol?, (^-> ModernTreasury::Converter::input)]]
+
+    def self.derefed_variants: -> ::Array[[Symbol?, top]]
+
+    def self.variants: -> ::Array[top]
+
+    private def self.discriminator: (Symbol property) -> void
+
+    private def self.variant: (
+      Symbol
+      | ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input key,
+      ?::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input spec
+    ) -> void
+
+    private def self.resolve_variant: (
+      top value
+    ) -> ModernTreasury::Converter::input?
+
+    def ===: (top other) -> bool
+
+    def ==: (top other) -> bool
+
+    def coerce: (top value) -> top
+
+    def dump: (top value) -> top
+
+    def try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+  end
+
+  class ArrayOf
+    include ModernTreasury::Converter
+
+    def self.[]: (
+      ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> instance
+
+    def ===: (top other) -> bool
+
+    def ==: (top other) -> bool
+
+    def coerce: (Enumerable[top] | top value) -> (::Array[top] | top)
+
+    def dump: (Enumerable[top] | top value) -> (::Array[top] | top)
+
+    def try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+
+    def item_type: -> top
+
+    def initialize: (
+      ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> void
+  end
+
+  class HashOf
+    include ModernTreasury::Converter
+
+    def self.[]: (
+      ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> instance
+
+    def ===: (top other) -> bool
+
+    def ==: (top other) -> bool
+
+    def coerce: (::Hash[top, top] | top value) -> (::Hash[Symbol, top] | top)
+
+    def dump: (::Hash[top, top] | top value) -> (::Hash[Symbol, top] | top)
+
+    def try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+
+    def item_type: -> top
+
+    def initialize: (
+      ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> void
+  end
+
+  class BaseModel
+    extend ModernTreasury::Converter
+
+    type known_field = { mode: (:coerce | :dump)?, required: bool }
+
+    def self.known_fields: -> ::Hash[Symbol, (ModernTreasury::BaseModel::known_field
+    & { type_fn: (^-> ModernTreasury::Converter::input) })]
+
+    def self.reverse_map: -> ::Hash[Symbol, Symbol]
+
+    def self.fields: -> ::Hash[Symbol, (ModernTreasury::BaseModel::known_field
+    & { type: ModernTreasury::Converter::input })]
+
+    def self.defaults: -> ::Hash[Symbol, (^-> Class)]
+
+    private def self.add_field: (
+      Symbol name_sym,
+      required: bool,
+      type_info: {
+        const: (nil | bool | Integer | Float | Symbol)?,
+        enum: ^-> ModernTreasury::Converter::input?,
+        union: ^-> ModernTreasury::Converter::input?,
+        api_name: Symbol
+      }
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input,
+      spec: ::Hash[Symbol, top]
+    ) -> void
+
+    def self.required: (
+      Symbol name_sym,
+      ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> void
+
+    def self.optional: (
+      Symbol name_sym,
+      ::Hash[Symbol, top]
+      | ^-> ModernTreasury::Converter::input
+      | ModernTreasury::Converter::input type_info,
+      ?::Hash[Symbol, top] spec
+    ) -> void
+
+    private def self.request_only: { -> void } -> void
+
+    private def self.response_only: { -> void } -> void
+
+    def ==: (top other) -> bool
+
+    def self.coerce: (
+      ModernTreasury::BaseModel | ::Hash[top, top] | top value
+    ) -> (instance | top)
+
+    def self.dump: (instance | top value) -> (::Hash[top, top] | top)
+
+    def self.try_strict_coerce: (
+      top value
+    ) -> ([true, top, nil] | [false, bool, Integer])
+
+    def []: (Symbol key) -> top?
+
+    def to_h: -> ::Hash[Symbol, top]
+
+    alias to_hash to_h
+
+    def deconstruct_keys: (::Array[Symbol]? keys) -> ::Hash[Symbol, top]
+
+    def initialize: (?::Hash[Symbol, top] | self data) -> void
+
+    def to_s: -> String
+
+    def inspect: -> String
+  end
+end

data/sig/modern_treasury/base_page.rbs

@@ -0,0 +1,20 @@
+module ModernTreasury
+  module BasePage[Elem]
+    def next_page?: -> bool
+
+    def next_page: -> self
+
+    def auto_paging_each: { (Elem arg0) -> void } -> void
+
+    def to_enum: -> Enumerable[Elem]
+
+    alias enum_for to_enum
+
+    def initialize: (
+      client: ModernTreasury::BaseClient,
+      req: ModernTreasury::BaseClient::request_components,
+      headers: ::Hash[String, String],
+      page_data: top
+    ) -> void
+  end
+end