hearth 1.0.0.pre1 → 1.0.0.pre2

data/lib/hearth.rb

@@ -1,22 +1,49 @@
 # frozen_string_literal: true
 
 require_relative 'hearth/api_error'
+require_relative 'hearth/auth_option'
+
+# must be required before auth_schemes
+require_relative 'hearth/identities'
+require_relative 'hearth/auth_schemes'
+
 require_relative 'hearth/block_io'
+require_relative 'hearth/checksums'
+require_relative 'hearth/client_stubs'
+require_relative 'hearth/configuration'
+require_relative 'hearth/config/env_provider'
+require_relative 'hearth/config/resolver'
+require_relative 'hearth/connection_pool'
 require_relative 'hearth/context'
+require_relative 'hearth/dns'
+
+# must be required before http
+require_relative 'hearth/middleware'
+require_relative 'hearth/networking_error'
+require_relative 'hearth/request'
+require_relative 'hearth/response'
+
 require_relative 'hearth/http'
+require_relative 'hearth/identity_resolver'
+require_relative 'hearth/interceptor'
+require_relative 'hearth/interceptors'
+require_relative 'hearth/interceptor_context'
+require_relative 'hearth/interceptor_list'
 require_relative 'hearth/json'
-require_relative 'hearth/middleware'
-require_relative 'hearth/middleware_builder'
+require_relative 'hearth/plugin_list'
 require_relative 'hearth/middleware_stack'
 require_relative 'hearth/number_helper'
 require_relative 'hearth/output'
+require_relative 'hearth/query/param'
+require_relative 'hearth/query/param_list'
+require_relative 'hearth/refreshing_identity_resolver'
+require_relative 'hearth/retry'
+require_relative 'hearth/signers'
 require_relative 'hearth/structure'
-require_relative 'hearth/stubbing/client_stubs'
-require_relative 'hearth/stubbing/stubs'
+require_relative 'hearth/stubs'
 require_relative 'hearth/time_helper'
 require_relative 'hearth/union'
 require_relative 'hearth/validator'
-require_relative 'hearth/waiters/errors'
 require_relative 'hearth/waiters/poller'
 require_relative 'hearth/waiters/waiter'
 require_relative 'hearth/xml'

data/sig/lib/hearth/aliases.rbs

@@ -0,0 +1,4 @@
+type document = Hash[Symbol,document] | Array[document] | String | bool | Numeric
+
+type stub = Hearth::Structure | Hearth::Response | { data: Hash[Symbol, untyped] } |
+  { error: { class: Class, data: Hash[Symbol, untyped] } } | Hearth::ApiError | Proc

data/sig/lib/hearth/api_error.rbs

@@ -0,0 +1,13 @@
+module Hearth
+  class ApiError < StandardError
+    def initialize: (error_code: String, ?metadata: Hash[Symbol, untyped], ?message: String?) -> void
+
+    attr_reader error_code: String
+
+    attr_reader metadata: Hash[Symbol, untyped]
+
+    def retryable?: () -> false
+
+    def throttling?: () -> false
+  end
+end

data/sig/lib/hearth/auth_option.rbs

@@ -0,0 +1,11 @@
+module Hearth
+  class AuthOption
+    def initialize: (scheme_id: String, ?identity_properties: Hash[Symbol, untyped], ?signer_properties: Hash[Symbol, untyped]) -> void
+
+    attr_reader scheme_id: String
+
+    attr_reader identity_properties: Hash[Symbol, untyped]
+
+    attr_reader signer_properties: Hash[Symbol, untyped]
+  end
+end

data/sig/lib/hearth/auth_schemes/anonymous.rbs

@@ -0,0 +1,7 @@
+module Hearth
+  module AuthSchemes
+    class Anonymous < AuthSchemes::Base
+      def initialize: () -> void
+    end
+  end
+end

data/sig/lib/hearth/auth_schemes/http_api_key.rbs

@@ -0,0 +1,7 @@
+module Hearth
+  module AuthSchemes
+    class HTTPApiKey < AuthSchemes::Base
+      def initialize: () -> void
+    end
+  end
+end

data/sig/lib/hearth/auth_schemes/http_basic.rbs

@@ -0,0 +1,7 @@
+module Hearth
+  module AuthSchemes
+    class HTTPBasic < AuthSchemes::Base
+      def initialize: () -> void
+    end
+  end
+end

data/sig/lib/hearth/auth_schemes/http_bearer.rbs

@@ -0,0 +1,7 @@
+module Hearth
+  module AuthSchemes
+    class HTTPBearer < AuthSchemes::Base
+      def initialize: () -> void
+    end
+  end
+end

data/sig/lib/hearth/auth_schemes/http_digest.rbs

@@ -0,0 +1,7 @@
+module Hearth
+  module AuthSchemes
+    class HTTPDigest < AuthSchemes::Base
+      def initialize: () -> void
+    end
+  end
+end

data/sig/lib/hearth/auth_schemes.rbs

@@ -0,0 +1,13 @@
+module Hearth
+  module AuthSchemes
+    class Base
+      def initialize: (scheme_id: String, signer: Signers::Base, identity_type: Class) -> void
+
+      attr_reader scheme_id: String
+
+      def identity_resolver: (?Hash[Symbol, IdentityResolver] identity_resolvers) -> IdentityResolver
+
+      attr_reader signer: Signers::Base
+    end
+  end
+end

data/sig/lib/hearth/block_io.rbs

@@ -0,0 +1,9 @@
+module Hearth
+  class BlockIO
+    def initialize: (Proc block) -> void
+
+    attr_reader bytes_yielded: Integer
+
+    def write: (String data) -> Integer
+  end
+end

data/sig/lib/hearth/client_stubs.rbs

@@ -0,0 +1,5 @@
+module Hearth
+  module ClientStubs
+    def stub_responses: (Symbol operation_name, *stub stubs) -> void
+  end
+end

data/sig/lib/hearth/configuration.rbs

@@ -0,0 +1,7 @@
+module Hearth
+  module Configuration
+    def initialize: (**Hash[Symbol, untyped] options) -> void
+
+    def dup: () -> Hearth::Configuration
+  end
+end

data/sig/lib/hearth/dns/host_address.rbs

@@ -0,0 +1,13 @@
+module Hearth
+  module DNS
+    class HostAddress
+      def initialize: (address_type: Symbol, address: String, hostname: String) -> void
+
+      attr_reader address_type: Symbol
+
+      attr_reader address: String
+
+      attr_reader hostname: String
+    end
+  end
+end

data/sig/lib/hearth/dns/host_resolver.rbs

@@ -0,0 +1,19 @@
+module Hearth
+  module DNS
+    class HostResolver
+      def initialize: (?service: Integer, ?family: Integer?, ?socktype: Symbol, ?protocol: Integer?, ?flags: Integer?) -> void
+
+      attr_reader service: Integer
+
+      attr_reader family: Integer
+
+      attr_reader socktype: Symbol
+
+      attr_reader protocol: Integer
+
+      attr_reader flags: Integer
+
+      def resolve_address: (nodename: String, ?service: Integer, ?family: Integer?, ?socktype: Symbol, ?protocol: Integer?, ?flags: Integer?) -> Array[HostAddress]
+    end
+  end
+end

data/sig/lib/hearth/http/api_error.rbs

@@ -0,0 +1,13 @@
+module Hearth
+  module HTTP
+    class ApiError < Hearth::ApiError
+      def initialize: (http_resp: Response, error_code: String, ?metadata: Hash[Symbol, untyped], ?message: String?) -> void
+
+      attr_reader http_status: Integer
+
+      attr_reader http_fields: Fields
+
+      attr_reader http_body: IO
+    end
+  end
+end

data/sig/lib/hearth/http/client.rbs

@@ -0,0 +1,9 @@
+module Hearth
+  module HTTP
+    class Client
+      def initialize: (?::Hash[Symbol, untyped] options) -> void
+
+      def transmit: (request: HTTP::Request, response: HTTP::Response, ?logger: Logger?) -> void
+    end
+  end
+end

data/sig/lib/hearth/http/field.rbs

@@ -0,0 +1,19 @@
+module Hearth
+  module HTTP
+    class Field
+      def initialize: (String name, ?(Array[String] | _ToS)? value, ?kind: Symbol) -> void
+
+      attr_reader name: String
+
+      attr_reader kind: Symbol
+
+      def value: (?String? encoding) -> String
+
+      def header?: () -> bool
+
+      def trailer?: () -> bool
+
+      def to_h: () -> Hash[String, String]
+    end
+  end
+end

data/sig/lib/hearth/http/fields.rbs

@@ -0,0 +1,43 @@
+module Hearth
+  module HTTP
+    class Fields
+      include Enumerable[Field]
+
+      def initialize: (?Array[Field] fields, ?encoding: String) -> void
+
+      attr_reader encoding: String
+
+      def []: (String key) -> Field
+
+      def []=: (String key, Field value) -> Field
+
+      def key?: (String key) -> bool
+
+      def delete: (String key) -> (Field | nil)
+
+      def each: () { (Field) -> void } -> void
+
+      def size: () -> Integer
+
+      def clear: () -> void
+
+      class Proxy
+        include Enumerable[Hash[String, String]]
+
+        def initialize: (Array[Field] fields, Symbol kind) -> void
+
+        def []: (String key) -> (String | nil)
+
+        def []=: (String, String) -> String
+
+        def key?: (String) -> bool
+
+        def delete: (String key) -> (String | nil)
+
+        def each: () { (Hash[String, String]) -> void } -> void
+
+        alias each_pair each
+      end
+    end
+  end
+end

data/sig/lib/hearth/http/request.rbs

@@ -0,0 +1,25 @@
+module Hearth
+  module HTTP
+    class Request < Hearth::Request
+      def initialize: (?http_method: Symbol?, ?fields: Fields, ?uri: URI, ?body: IO) -> void
+
+      attr_accessor http_method: Symbol
+
+      attr_reader fields: Fields
+
+      attr_reader headers: Fields::Proxy
+
+      attr_reader trailers: Fields::Proxy
+
+      def append_path: (String path) -> void
+
+      def append_query_param: (String name, String? value) -> void
+
+      def append_query_param_list: (Query::ParamList param_list) -> void
+
+      def remove_query_param: (String name) -> void
+
+      def prefix_host: (String prefix) -> void
+    end
+  end
+end

data/sig/lib/hearth/http/response.rbs

@@ -0,0 +1,21 @@
+module Hearth
+  module HTTP
+    class Response < Hearth::Response
+      def initialize: (?status: Integer, ?reason: String?, ?fields: Fields, ?body: IO) -> void
+
+      attr_accessor status: Integer
+
+      attr_accessor reason: (String | nil)
+
+      attr_reader fields: Fields
+
+      attr_reader headers: Fields::Proxy
+
+      attr_reader trailers: Fields::Proxy
+
+      def replace: (Response other) -> self
+
+      def reset: () -> void
+    end
+  end
+end

data/sig/lib/hearth/identities/anonymous.rbs

@@ -0,0 +1,6 @@
+module Hearth
+  module Identities
+    class Anonymous < Identities::Base
+    end
+  end
+end

data/sig/lib/hearth/identities/http_api_key.rbs

@@ -0,0 +1,9 @@
+module Hearth
+  module Identities
+    class HTTPApiKey < Identities::Base
+      def initialize: (key: String, ?expiration: Time?) -> void
+
+      attr_reader key: String
+    end
+  end
+end

data/sig/lib/hearth/identities/http_bearer.rbs

@@ -0,0 +1,9 @@
+module Hearth
+  module Identities
+    class HTTPBearer < Identities::Base
+      def initialize: (token: String, ?expiration: Time?) -> void
+
+      attr_reader token: String
+    end
+  end
+end

data/sig/lib/hearth/identities/http_login.rbs

@@ -0,0 +1,11 @@
+module Hearth
+  module Identities
+    class HTTPLogin < Identities::Base
+      def initialize: (username: String, password: String, ?expiration: Time?) -> void
+
+      attr_reader username: String
+
+      attr_reader password: String
+    end
+  end
+end

data/sig/lib/hearth/identities.rbs

@@ -0,0 +1,9 @@
+module Hearth
+  module Identities
+    class Base
+      def initialize: (?expiration: Time?) -> void
+
+      attr_reader expiration: Time
+    end
+  end
+end

data/sig/lib/hearth/identity_resolver.rbs

@@ -0,0 +1,7 @@
+module Hearth
+  class IdentityResolver
+    def initialize: (Proc) -> void
+
+    def identity: (?Hash[Symbol, untyped] properties) -> Identities::Base
+  end
+end

data/sig/lib/hearth/interceptor.rbs

@@ -0,0 +1,9 @@
+module Hearth
+  class Interceptor
+    def initialize: (?Hash[Symbol, Proc] callbacks) -> void
+
+    attr_reader callbacks: Hash[Symbol, Proc]
+
+    attr_reader self.hooks: Array[Symbol]
+  end
+end

data/sig/lib/hearth/interceptor_context.rbs

@@ -0,0 +1,15 @@
+module Hearth
+  class InterceptorContext
+    def initialize: (input: Structure, request: Request, response: Response, output: Structure, ?attributes: Hash[Symbol, untyped]) -> void
+
+    attr_reader input: Structure
+
+    attr_reader request: Request
+
+    attr_reader response: Response
+
+    attr_reader output: Structure
+
+    attr_reader attributes: Hash[Symbol, untyped]
+  end
+end

data/sig/lib/hearth/interceptor_list.rbs

@@ -0,0 +1,16 @@
+module Hearth
+  class InterceptorList
+    include Enumerable[_Interceptor]
+
+    def initialize: (?Array[_Interceptor] interceptors) -> void
+
+    def append: (_Interceptor interceptor) -> void
+    alias << append
+
+    def concat: (InterceptorList other) -> self
+
+    def dup: () -> InterceptorList
+
+    def each: () { (_Interceptor) -> untyped } -> untyped
+  end
+end

data/sig/lib/hearth/interfaces.rbs

@@ -0,0 +1,65 @@
+# Hack - https://github.com/ruby/delegate/issues/8
+class SimpleDelegator
+end
+
+# Hack - https://github.com/ruby/rbs/issues/1481
+class URI
+end
+
+# Hack - https://github.com/ruby/rbs/issues/1482
+class Logger
+end
+
+interface _Plugin
+  def call: (Hearth::Configuration) -> void
+end
+
+interface _Interceptor
+  def read_before_execution: (Hearth::InterceptorContext) -> void
+
+  def modify_before_serialization: (Hearth::InterceptorContext) -> void
+
+  def read_before_serialization: (Hearth::InterceptorContext) -> void
+
+  def read_after_serialization: (Hearth::InterceptorContext) -> void
+
+  def modify_before_retry_loop: (Hearth::InterceptorContext) -> void
+
+  def read_before_attempt: (Hearth::InterceptorContext) -> void
+
+  def modify_before_signing: (Hearth::InterceptorContext) -> void
+
+  def read_before_signing: (Hearth::InterceptorContext) -> void
+
+  def read_after_signing: (Hearth::InterceptorContext) -> void
+
+  def modify_before_transmit: (Hearth::InterceptorContext) -> void
+
+  def read_before_transmit: (Hearth::InterceptorContext) -> void
+
+  def read_after_transmit: (Hearth::InterceptorContext) -> void
+
+  def modify_before_deserialization: (Hearth::InterceptorContext) -> void
+
+  def read_before_deserialization: (Hearth::InterceptorContext) -> void
+
+  def read_after_deserialization: (Hearth::InterceptorContext) -> void
+
+  def modify_before_attempt_completion: (Hearth::InterceptorContext) -> void
+
+  def read_after_attempt: (Hearth::InterceptorContext) -> void
+
+  def modify_before_completion: (Hearth::InterceptorContext) -> void
+
+  def read_after_execution: (Hearth::InterceptorContext) -> void
+end
+
+interface _ErrorInspector
+  def initialize: (Hearth::ApiError, Hearth::Response) -> void
+
+  def retryable?: () -> bool
+
+  def error_type: () -> String
+
+  def hints: () -> Hash[Symbol, untyped]
+end

data/sig/lib/hearth/output.rbs

@@ -0,0 +1,11 @@
+module Hearth
+  class Output
+    def initialize: (?error: (ApiError)?, ?data: (Structure)?, ?metadata: Hash[Symbol, untyped]) -> void
+
+    attr_accessor error: (ApiError | nil)
+
+    attr_accessor data: (Structure | nil)
+
+    attr_accessor metadata: Hash[Symbol, untyped]
+  end
+end

data/sig/lib/hearth/plugin_list.rbs

@@ -0,0 +1,15 @@
+module Hearth
+  class PluginList
+    def initialize: (?Array[_Plugin] plugins) -> void
+
+    def add: (_Plugin plugin) -> void
+
+    alias << add
+
+    def apply: (Hearth::Configuration) -> void
+
+    def dup: () -> PluginList
+
+    def each: () ?{ (_Plugin) -> void } -> void
+  end
+end

data/sig/lib/hearth/query/param.rbs

@@ -0,0 +1,17 @@
+module Hearth
+  module Query
+    class Param
+      def initialize: (String name, ?(String | Array[String])? value) -> void
+
+      attr_reader name: String
+
+      attr_reader value: (String | Array[String])
+
+      def to_s: () -> String
+
+      def ==: (Param other) -> bool
+
+      def <=>: (Param other) -> bool
+    end
+  end
+end

data/sig/lib/hearth/query/param_list.rbs

@@ -0,0 +1,25 @@
+module Hearth
+  module Query
+    class ParamList
+      include Enumerable[String]
+
+      def initialize: () -> void
+
+      def set: (String param_name, ?String? param_value) -> Param
+
+      alias []= set
+
+      def []: (Param param_name) -> (Param | nil)
+
+      def delete: (Param param_name) -> (Param | nil)
+
+      def each: () { (String) -> void } -> void
+
+      def empty?: () -> bool
+
+      def to_a: () -> Array[Param]
+
+      def to_s: () -> String
+    end
+  end
+end

data/sig/lib/hearth/request.rbs

@@ -0,0 +1,9 @@
+module Hearth
+  class Request
+    def initialize: (?uri: URI, ?body: IO) -> void
+
+    attr_accessor uri: URI
+
+    attr_accessor body: IO
+  end
+end

data/sig/lib/hearth/response.rbs

@@ -0,0 +1,11 @@
+module Hearth
+  class Response
+    def initialize: (?body: IO) -> void
+
+    attr_accessor body: IO
+
+    def replace: (Response other) -> self
+
+    def reset: () -> self
+  end
+end

data/sig/lib/hearth/retry/adaptive.rbs

@@ -0,0 +1,13 @@
+module Hearth
+  module Retry
+    class Adaptive < Strategy
+      def initialize: (?backoff: ExponentialBackoff, ?max_attempts: Integer, ?wait_to_fill: bool) -> void
+
+      def acquire_initial_retry_token: (?String? _token_scope) -> Token
+
+      def refresh_retry_token: (Token retry_token, _ErrorInspector error_info) -> (nil | Token)
+
+      def record_success: (Token retry_token) -> Token
+    end
+  end
+end

data/sig/lib/hearth/retry/exponential_backoff.rbs

@@ -0,0 +1,7 @@
+module Hearth
+  module Retry
+    class ExponentialBackoff
+      def call: (Integer attempts) -> Float
+    end
+  end
+end

data/sig/lib/hearth/retry/standard.rbs

@@ -0,0 +1,13 @@
+module Hearth
+  module Retry
+    class Standard < Strategy
+      def initialize: (?backoff: ExponentialBackoff, ?max_attempts: Integer) -> void
+
+      def acquire_initial_retry_token: (?String? _token_scope) -> Token
+
+      def refresh_retry_token: (Token retry_token, _ErrorInspector error_info) -> (nil | Token)
+
+      def record_success: (Token retry_token) -> Token
+    end
+  end
+end

data/sig/lib/hearth/retry/strategy.rbs

@@ -0,0 +1,11 @@
+module Hearth
+  module Retry
+    class Strategy
+      def acquire_initial_retry_token: (?String? _token_scope) -> Token
+
+      def refresh_retry_token: (Token _retry_token, _ErrorInspector _error_info) -> (nil | Token)
+
+      def record_success: (Token _retry_token) -> Token
+    end
+  end
+end