hearth 1.0.0.pre1 → 1.0.0.pre3

data/sig/lib/hearth/endpoint_rules.rbs

@@ -0,0 +1,17 @@
+module Hearth
+  module EndpointRules
+    class AuthScheme < Struct[untyped]
+      attr_accessor scheme_id: String
+
+      attr_accessor properties: Hash[String, untyped]
+    end
+
+    class Endpoint < Struct[untyped]
+      attr_accessor uri: String
+
+      attr_accessor auth_schemes: Array[AuthScheme]
+
+      attr_accessor headers: Hash[String, String | Array[String]]
+    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, ?(_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) -> Field
+
+        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/header_list_builder.rbs

@@ -0,0 +1,15 @@
+module Hearth
+  module HTTP
+    module HeaderListBuilder
+      def self.build_list: (Array[untyped] value) -> String
+
+      def self.build_string_list: (Array[String] value ) -> String
+
+      def self.build_http_date_list: (Array[Time] value) -> String
+
+      def self.build_date_time_list: (Array[Time] value) -> String
+
+      def self.build_epoch_seconds_list: (Array[Time] value) -> String
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+module Hearth
+  module HTTP
+    module HeaderListParser
+      def self.parse_boolean_list: (String value) -> Array[bool]
+
+      def self.parse_integer_list: (String value) -> Array[Integer]
+
+      def self.parse_float_list: (String value) -> Array[Float]
+
+      def self.build_string_list: (String value ) -> Array[String]
+
+      def self.build_http_date_list: (String value ) -> Array[Time]
+
+      def self.build_date_time_list: (String value ) -> Array[Time]
+
+      def self.build_epoch_seconds_list: (String value ) -> Array[Time]
+    end
+  end
+end

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

@@ -0,0 +1,6 @@
+module Hearth
+  module HTTP
+    class NetworkingError < Hearth::NetworkingError
+    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:  _WritableIO) -> 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_provider.rbs

@@ -0,0 +1,7 @@
+module Hearth
+  class IdentityProvider
+    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,17 @@
+module Hearth
+  class InterceptorContext
+    def initialize: (input: Structure, request: Request, response: Response, output: Output[Structure], logger: Logger) -> void
+
+    attr_reader input: Structure
+
+    attr_reader request: Request
+
+    attr_reader response: Response
+
+    attr_reader output: Output[Structure]
+
+    attr_reader logger: Logger
+
+    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,87 @@
+# 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
+
+module Hearth
+  interface _Plugin[ServiceConfig]
+    def call: (ServiceConfig) -> void
+  end
+
+  interface _Interceptor
+    def read_before_execution: (InterceptorContext) -> void
+
+    def modify_before_serialization: (InterceptorContext) -> void
+
+    def read_before_serialization: (InterceptorContext) -> void
+
+    def read_after_serialization: (InterceptorContext) -> void
+
+    def modify_before_retry_loop: (InterceptorContext) -> void
+
+    def read_before_attempt: (InterceptorContext) -> void
+
+    def modify_before_signing: (InterceptorContext) -> void
+
+    def read_before_signing: (InterceptorContext) -> void
+
+    def read_after_signing: (InterceptorContext) -> void
+
+    def modify_before_transmit: (InterceptorContext) -> void
+
+    def read_before_transmit: (InterceptorContext) -> void
+
+    def read_after_transmit: (InterceptorContext) -> void
+
+    def modify_before_deserialization: (InterceptorContext) -> void
+
+    def read_before_deserialization: (InterceptorContext) -> void
+
+    def read_after_deserialization: (InterceptorContext) -> void
+
+    def modify_before_attempt_completion: (InterceptorContext) -> void
+
+    def read_after_attempt: (InterceptorContext) -> void
+
+    def modify_before_completion: (InterceptorContext) -> void
+
+    def read_after_execution: (InterceptorContext) -> void
+  end
+
+  interface _ErrorInspector
+    def initialize: (ApiError, Response) -> void
+
+    def retryable?: () -> bool
+
+    def error_type: () -> String
+
+    def hints: () -> Hash[Symbol, untyped]
+  end
+
+  interface _RetryStrategy
+    def acquire_initial_retry_token: (?String? _token_scope) -> Retry::Token
+
+    def refresh_retry_token: (Retry::Token _retry_token, _ErrorInspector _error_info) -> Retry::Token?
+
+    def record_success: (Retry::Token _retry_token) -> Retry::Token
+  end
+
+  interface _AuthResolver[Params]
+    def resolve: (Params) -> AuthSchemes::Base
+  end
+
+  interface _EndpointResolver[Params]
+    def resolve: (Params) -> EndpointRules::Endpoint
+  end
+
+  interface _WritableIO
+    def write: (*_ToS) -> Integer
+  end
+end

data/sig/lib/hearth/json/parse_error.rbs

@@ -0,0 +1,9 @@
+module Hearth
+  module JSON
+    class ParseError < StandardError
+      def initialize: (StandardError original_error) -> void
+
+      attr_reader original_error: StandardError
+    end
+  end
+end

data/sig/lib/hearth/networking_error.rbs

@@ -0,0 +1,7 @@
+module Hearth
+    class NetworkingError < StandardError
+      def initialize: (StandardError original_error) -> void
+
+      attr_reader original_error: StandardError
+    end
+end

data/sig/lib/hearth/output.rbs

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

data/sig/lib/hearth/plugin_list.rbs

@@ -0,0 +1,13 @@
+module Hearth
+  class PluginList[ServiceConfig]
+    def initialize: (?Array[_Plugin[ServiceConfig]] plugins) -> void
+
+    def add: (_Plugin[ServiceConfig] plugin) -> void
+
+    alias << add
+
+    def apply: (ServiceConfig) -> void
+
+    def each: () ?{ (_Plugin[ServiceConfig]) -> 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) -> Integer
+    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/refreshing_identity_provider.rbs

@@ -0,0 +1,10 @@
+module Hearth
+  module RefreshingIdentityProvider
+    ASYNC_EXPIRATION_LENGTH: Integer
+    SYNC_EXPIRATION_LENGTH: Integer
+
+    def initialize: -> void
+
+    def identity: (?Hash[Symbol, untyped] properties) -> Identities::Base
+  end
+end

data/sig/lib/hearth/request.rbs

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

data/sig/lib/hearth/response.rbs

@@ -0,0 +1,11 @@
+module Hearth
+  class Response
+    def initialize: (?body: (IO | StringIO)) -> void
+
+    attr_accessor body: (IO | StringIO)
+
+    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) -> Numeric
+    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

data/sig/lib/hearth/retry.rbs

@@ -0,0 +1,9 @@
+module Hearth
+  module Retry
+    class Token < Struct[untyped]
+      attr_accessor retry_count (): Integer
+
+      attr_accessor retry_delay (): Numeric
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Hearth
+  module Signers
+    class Anonymous < Signers::Base
+      def sign: (request: Request, identity: Identities::Anonymous, ?properties: Hash[Symbol, untyped]) -> void
+
+      def reset: (request: Request, ?properties: Hash[Symbol, untyped]) -> void
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Hearth
+  module Signers
+    class HTTPApiKey < Signers::Base
+      def sign: (request: HTTP::Request, identity: Identities::HTTPApiKey, ?properties: Hash[Symbol, untyped]) -> void
+
+      def reset: (request: HTTP::Request, ?properties: Hash[Symbol, untyped]) -> void
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Hearth
+  module Signers
+    class HTTPBasic < Signers::Base
+      def sign: (request: HTTP::Request, identity: Identities::HTTPLogin, ?properties: Hash[Symbol, untyped]) -> void
+
+      def reset: (request: HTTP::Request, ?properties: Hash[Symbol, untyped]) -> void
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Hearth
+  module Signers
+    class HTTPBearer < Signers::Base
+      def sign: (request: HTTP::Request, identity: Identities::HTTPBearer, ?properties: Hash[Symbol, untyped]) -> void
+
+      def reset: (request: HTTP::Request, ?properties: Hash[Symbol, untyped]) -> void
+    end
+  end
+end

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

@@ -0,0 +1,9 @@
+module Hearth
+  module Signers
+    class HTTPDigest < Signers::Base
+      def sign: (request: HTTP::Request, identity: Identities::HTTPLogin, ?properties: Hash[Symbol, untyped]) -> void
+
+      def reset: (request: HTTP::Request, ?properties: Hash[Symbol, untyped]) -> void
+    end
+  end
+end

data/sig/lib/hearth/signers.rbs

@@ -0,0 +1,9 @@
+module Hearth
+  module Signers
+    class Base
+      def sign: (request: Request, identity: Identities::Base, ?properties: Hash[Symbol, untyped]) -> void
+
+      def reset: (request: Request, ?properties: Hash[Symbol, untyped]) -> void
+    end
+  end
+end

data/sig/lib/hearth/structure.rbs

@@ -0,0 +1,6 @@
+module Hearth
+  module Structure
+    def to_h: (self) -> (Hash[Symbol, untyped] | self)
+    alias to_hash to_h
+  end
+end

data/sig/lib/hearth/stubs.rbs

@@ -0,0 +1,9 @@
+module Hearth
+  class Stubs
+    def initialize: (?Hash[Symbol, Array[stub]]) -> void
+
+    def set_stubs: (Symbol, Array[stub]) -> void
+
+    def next: (Symbol) -> stub?
+  end
+end