Add rbs and touch up public methods (#157)

codegen/smithy-ruby-codegen-test/integration-specs/interceptor_spec.rb

@@ -26,7 +26,7 @@ def read_before_execution(context); end
         client = Client.new(config)
 
         expect(interceptor).to receive(hook)
-          .with(instance_of(Hearth::InterceptorContext))
+          .with(instance_of(Hearth::Interceptor::Context))
 
         client.kitchen_sink
       end
@@ -38,7 +38,7 @@ def read_before_execution(context); end
         client = Client.new(config)
 
         expect(interceptor).to receive(hook)
-          .with(instance_of(Hearth::InterceptorContext))
+          .with(instance_of(Hearth::Interceptor::Context))
 
         client.kitchen_sink({}, interceptors: [interceptor])
       end

codegen/smithy-ruby-codegen/src/main/java/software/amazon/smithy/ruby/codegen/Hearth.java

@@ -48,7 +48,7 @@ public final class Hearth {
             .build();
 
     public static final Symbol STUBS = Symbol.builder()
-            .namespace("Hearth::Stubbing", "::")
+            .namespace("Hearth", "::")
             .name("Stubs")
             .build();
 

hearth/Steepfile

@@ -2,11 +2,8 @@
 
 D = Steep::Diagnostic
 
-target :app do
+target :lib do
   signature 'sig'
 
-  check 'lib/hearth/structure'
-  check 'lib/hearth/union'
-
   configure_code_diagnostics(D::Ruby.strict)
 end

hearth/lib/hearth.rb

@@ -9,6 +9,7 @@
 
 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'
@@ -24,7 +25,6 @@
 require_relative 'hearth/http'
 require_relative 'hearth/identity_resolver'
 require_relative 'hearth/interceptor'
-require_relative 'hearth/interceptor_context'
 require_relative 'hearth/interceptor_list'
 require_relative 'hearth/json'
 require_relative 'hearth/plugin_list'
@@ -38,8 +38,7 @@
 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'

hearth/lib/hearth/config/env_provider.rb

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
 module Hearth
+  # @api private
   module Config
     # Parses and validates values provided in ENV
-    # @api private
     class EnvProvider
       def initialize(env_key, type: 'String')
         @env_key = env_key

hearth/lib/hearth/config/resolver.rb

@@ -1,8 +1,9 @@
 # frozen_string_literal: true
 
 module Hearth
+  # @api private
   module Config
-    # @api private
+    # Resolves configuration options.
     class Resolver
       private_class_method :new
 

hearth/lib/hearth/configuration.rb

@@ -2,6 +2,7 @@
 
 module Hearth
   # A module mixed into Config structs that resolves default value providers.
+  # @api private
   module Configuration
     def initialize(**options)
       Hearth::Validator.validate_unknown!(self, options, context: 'config')

hearth/lib/hearth/context.rb

@@ -42,7 +42,7 @@ def initialize(options = {})
 
     # @api private
     def interceptor_context(input, output)
-      Hearth::InterceptorContext.new(
+      Hearth::Interceptor::Context.new(
         input: input,
         request: request,
         response: response,

hearth/lib/hearth/dns.rb

@@ -14,6 +14,7 @@
 # Ruby DNS resolution, which may be Resolv or the system resolver.
 
 # Patch IPSocket
+# @api private
 class << IPSocket
   alias original_hearth_getaddress getaddress
 
@@ -30,6 +31,7 @@ def getaddress(host)
 end
 
 # Patch TCPSocket
+# @api private
 class TCPSocket < IPSocket
   alias original_hearth_initialize initialize
 

hearth/lib/hearth/http/client.rb

@@ -31,7 +31,7 @@ class Client
       #
       # @param [Hash] options The options for this HTTP Client
       #
-      # @param options [Logger] (Logger.new($stdout)) :logger A logger
+      # @option options [Logger] (Logger.new($stdout)) :logger A logger
       #   used to log Net::HTTP requests and responses when `:debug_output`
       #   is enabled.
       #
@@ -100,7 +100,7 @@ def initialize(options = {})
 
       # @param [Request] request
       # @param [Response] response
-      # @param [Logger] (nil) logger
+      # @param [Logger] logger (nil)
       # @return [Response]
       def transmit(request:, response:, logger: nil)
         net_request = build_net_request(request)
@@ -263,7 +263,7 @@ def pool_config
 
       # Helper methods extended onto Net::HTTP objects.
       # @api private
-      class HTTP < Delegator
+      class HTTP < SimpleDelegator
         def initialize(http)
           super(http)
           @http = http
@@ -272,14 +272,6 @@ def initialize(http)
         # @return [Integer, nil]
         attr_reader :last_used
 
-        def __getobj__
-          @http
-        end
-
-        def __setobj__(obj)
-          @http = obj
-        end
-
         # Sends the request and tracks that this connection has been used.
         def request(...)
           @http.request(...)

hearth/lib/hearth/interceptor.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative 'interceptor/context'
 require_relative 'interceptor/hooks'
 
 module Hearth

hearth/lib/hearth/interceptor/context.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Hearth
+  module Interceptor
+    # Context provided to interceptor hook methods.
+    class Context
+      # @param [Struct] input
+      # @param [Hearth::Request] request
+      # @param [Hearth::Response] response
+      # @param [Hearth::Output] output
+      # @param [Hash] attributes ({}) additional interceptor data
+      def initialize(input:, request:, response:, output:, attributes: {})
+        @input = input
+        @request = request
+        @response = response
+        @output = output
+        @attributes = attributes
+      end
+
+      # @return [Struct] Modeled input, i.e. Types::<Operation>Input
+      attr_reader :input
+
+      # @return [Hearth::Request]
+      attr_reader :request
+
+      # @return [Hearth::Response]
+      attr_reader :response
+
+      # @return [Hearth::Output] only available to hooks after transmit
+      attr_reader :output
+
+      # @return [Hash] attributes additional interceptor data
+      attr_reader :attributes
+    end
+  end
+end

hearth/lib/hearth/interceptor_list.rb

@@ -7,7 +7,7 @@ class InterceptorList
 
     # Initialize an InterceptorList.
     #
-    # @param [Array] ([]) interceptors A list of interceptors.
+    # @param [Array] interceptors ([]) A list of interceptors.
     def initialize(interceptors = [])
       unless interceptors.respond_to?(:each)
         raise ArgumentError, 'Interceptors must be an enumerable'

hearth/lib/hearth/middleware/send.rb

@@ -15,7 +15,7 @@ class Send
       #   that are responsible for creating a stubbed error response. They
       #   must respond to #stub and take the response and stub data as
       #   arguments.
-      # @param [Stubs] stubs A {Hearth::Stubbing:Stubs} object containing
+      # @param [Stubs] stubs A {Hearth::Stubs} object containing
       #   stubbed data for any given operation.
       def initialize(_app, client:, stub_responses:,
                      stub_data_class:, stub_error_classes:, stubs:)

hearth/lib/hearth/plugin_list.rb

@@ -9,7 +9,7 @@ class PluginList
 
     # Initialize a PluginList.
     #
-    # @param [Array] ([]) plugins A list of plugins to initialize with
+    # @param [Array] plugins ([]) A list of plugins to initialize with
     def initialize(plugins = [])
       unless plugins.respond_to?(:each)
         raise ArgumentError, 'Plugins must be an enumerable'

hearth/lib/hearth/refreshing_identity_resolver.rb

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 module Hearth
-  # Resolves an identity from identity properties.
+  # A module that can be included in a class to provide a #identity method.
+  # The class must implement #refresh(properties) that sets @identity. The
+  # refresh method will be called when #identity is called and the identity
+  # is nil or near expiration.
   module RefreshingIdentityResolver
     SYNC_EXPIRATION_LENGTH = 300 # 5 minutes
     ASYNC_EXPIRATION_LENGTH = 600 # 10 minutes

hearth/lib/hearth/retry.rb

@@ -3,6 +3,7 @@
 require_relative 'retry/strategy'
 
 require_relative 'retry/adaptive'
+require_relative 'retry/capacity_not_available_error'
 require_relative 'retry/client_rate_limiter'
 require_relative 'retry/exponential_backoff'
 require_relative 'retry/retry_quota'

hearth/lib/hearth/retry/capacity_not_available_error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Hearth
+  module Retry
+    # Raised by Retry::Adaptive when the client rate limiter
+    # doesn't have capacity.
+    class CapacityNotAvailableError < RuntimeError; end
+  end
+end

hearth/lib/hearth/retry/client_rate_limiter.rb

@@ -2,9 +2,6 @@
 
 module Hearth
   module Retry
-    # Raised when ClientRateLimiter doesn't have capacity.
-    class CapacityNotAvailableError < RuntimeError; end
-
     # @api private
     # Used only in 'adaptive' retry mode
     class ClientRateLimiter

hearth/lib/hearth/retry/exponential_backoff.rb

@@ -2,7 +2,6 @@
 
 module Hearth
   module Retry
-    # @api private
     # Computes an exponential backoff delay for a retry attempt.
     class ExponentialBackoff
       # Max backoff (in seconds)