hearth 1.0.0.pre2 → 1.0.0.pre3

data/lib/hearth/http/middleware/request_compression.rb

@@ -5,7 +5,6 @@ module Hearth
     module Middleware
       # A middleware that compresses the request body and
       # adds the Content-Encoding header
-      # @api private
       class RequestCompression
         include Hearth::Middleware::Logging
 
@@ -62,17 +61,16 @@ module Hearth
         def update_content_encoding(encoding, request)
           headers = request.headers
           if headers['Content-Encoding']
-            headers['Content-Encoding'] += ",#{encoding}"
+            headers['Content-Encoding'] += ", #{encoding}"
           else
             headers['Content-Encoding'] = encoding
           end
         end
 
         def compress_body(encoding, request)
-          case encoding
-          when 'gzip'
-            gzip_compress(request)
-          end
+          return unless encoding == 'gzip'
+
+          gzip_compress(request)
           update_content_encoding(encoding, request)
         end
 
@@ -100,10 +98,9 @@ module Hearth
         end
 
         def compress_streaming_body(encoding, request)
-          case encoding
-          when 'gzip'
-            request.body = GzipIO.new(request.body)
-          end
+          return unless encoding == 'gzip'
+
+          request.body = GzipIO.new(request.body)
           update_content_encoding(encoding, request)
         end
 

data/lib/hearth/http.rb

@@ -7,6 +7,8 @@ require_relative 'http/error_inspector'
 require_relative 'http/error_parser'
 require_relative 'http/field'
 require_relative 'http/fields'
+require_relative 'http/header_list_builder'
+require_relative 'http/header_list_parser'
 require_relative 'http/middleware'
 require_relative 'http/networking_error'
 require_relative 'http/request'

data/lib/hearth/{identity_resolver.rb → identity_provider.rb}

@@ -2,7 +2,7 @@
 
 module Hearth
   # Basic Identity resolver that uses a proc to resolve an Identity.
-  class IdentityResolver
+  class IdentityProvider
     # @param [Proc] proc A proc that takes identity properties (Hash)
     #   and returns a {Hearth::Identities::Base}.
     def initialize(proc)

data/lib/hearth/interceptor_context.rb

@@ -5,17 +5,18 @@ module Hearth
   # context to read and modify the input, request, response, and output.
   # Attributes can be used to pass additional data between interceptors.
   class InterceptorContext
-    # @param [Struct] input
+    # @param [Hearth::Structure] 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: {})
+    # @param [Logger] logger
+    def initialize(input:, request:, response:, output:, logger:)
       @input = input
       @request = request
       @response = response
       @output = output
-      @attributes = attributes
+      @logger = logger
+      @attributes = {}
     end
 
     # @return [Struct] Modeled input, i.e. Types::<Operation>Input
@@ -30,6 +31,9 @@ module Hearth
     # @return [Hearth::Output] Operation output
     attr_reader :output
 
+    # @return [Logger] logger
+    attr_reader :logger
+
     # @return [Hash] attributes Additional interceptor data
     attr_reader :attributes
   end

data/lib/hearth/interceptors.rb

@@ -42,7 +42,8 @@ module Hearth
           input: input,
           request: context.request,
           response: context.response,
-          output: output
+          output: output,
+          logger: context.logger
         )
       end
 

data/lib/hearth/json.rb

@@ -12,10 +12,10 @@ module Hearth
     class << self
       # @param [String] json
       # @return [Hash]
-      def load(json)
-        # rubocop:disable Security/JSONLoad
-        ::JSON.load(json)
-        # rubocop:enable Security/JSONLoad
+      def parse(json)
+        return nil if json.empty?
+
+        ::JSON.parse(json)
       rescue ::JSON::ParserError => e
         raise ParseError, e
       end

data/lib/hearth/middleware/auth.rb

@@ -3,7 +3,6 @@
 module Hearth
   module Middleware
     # A middleware that resolves identities for signing requests.
-    # @api private
     class Auth
       include Middleware::Logging
 
@@ -23,11 +22,11 @@ module Hearth
         @auth_params = auth_params
         @auth_schemes = auth_schemes.to_h { |s| [s.scheme_id, s] }
 
-        @identity_resolvers = {}
+        @identity_providers = {}
         kwargs.each do |key, value|
           next unless key.superclass == Hearth::Identities::Base
 
-          @identity_resolvers[key] = value
+          @identity_providers[key] = value
         end
       end
 
@@ -46,6 +45,7 @@ module Hearth
       private
 
       ResolvedAuth = Struct.new(
+        :scheme_id,
         :signer,
         :signer_properties,
         :identity,
@@ -56,6 +56,8 @@ module Hearth
       def resolve_auth(auth_options)
         failures = []
 
+        raise 'No auth options were resolved' if auth_options.empty?
+
         auth_options.each do |auth_option|
           auth_scheme = @auth_schemes[auth_option.scheme_id]
           resolved_auth = try_load_auth_scheme(
@@ -78,17 +80,18 @@ module Hearth
           return
         end
 
-        identity_resolver = auth_scheme.identity_resolver(@identity_resolvers)
-        unless identity_resolver
+        identity_provider = auth_scheme.identity_provider(@identity_providers)
+        unless identity_provider
           failures << "Auth scheme #{scheme_id} did not have an " \
                       'identity resolver configured'
           return
         end
 
         identity_properties = auth_option.identity_properties
-        identity = identity_resolver.identity(identity_properties)
+        identity = identity_provider.identity(identity_properties)
 
         ResolvedAuth.new(
+          scheme_id: scheme_id,
           identity: identity,
           identity_properties: auth_option.identity_properties,
           signer: auth_scheme.signer,

data/lib/hearth/middleware/build.rb

@@ -3,7 +3,6 @@
 module Hearth
   module Middleware
     # A middleware that builds a request object.
-    # @api private
     class Build
       include Middleware::Logging
 

data/lib/hearth/middleware/endpoint.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+# in Hearth middleware
+module Hearth
+  module Middleware
+    # Resolves endpoints from endpoint parameters and modifies
+    # the request with resolved endpoint, headers and auth schemes.
+    class Endpoint
+      include Middleware::Logging
+
+      # @param [Class] app The next middleware in the stack.
+      # @param [#resolve(endpoint_params)] endpoint_resolver An object
+      #   that responds to a `resolve(endpoint_params)` method
+      #   where `endpoint_params` is a service specific struct.
+      #   The method must return an {Hearth::Endpoints::Endpoint} object.
+      # @param [#build(config, input, context)] param_builder An object that
+      #   responds to a `build(config, input, context)` method and returns
+      #   an endpoint_params object.
+      def initialize(
+        app, endpoint_resolver:, param_builder:, **kwargs
+      )
+        @app = app
+        @param_builder = param_builder
+        @endpoint_resolver = endpoint_resolver
+        @config = kwargs
+      end
+
+      def call(input, context)
+        params = @param_builder.build(@config, input, context)
+        log_debug(context, "Endpoint params: #{params}")
+        endpoint = @endpoint_resolver.resolve(params)
+        log_debug(context, "Resolved endpoint: #{endpoint}")
+        update_request(context, endpoint)
+        log_debug(context, "Updated request: #{context.request}")
+        update_auth_properties(context, endpoint.auth_schemes)
+        log_debug(context, "Updated auth properties: #{context.auth}")
+
+        @app.call(input, context)
+      end
+
+      private
+
+      # apply the resolved endpoint to the request
+      def update_request(context, endpoint)
+        context.request.uri = merge_endpoints(
+          URI(endpoint.uri), context.request.uri
+        )
+        endpoint.headers.each do |key, val|
+          context.request.headers[key] = val
+        end
+      end
+
+      # merge the path and query parameters from serialization
+      # URIs from endpoint resolution MUST contain port and hostname
+      # and MAY contain port and base path.
+      def merge_endpoints(resolved_uri, request_uri)
+        merged = URI(resolved_uri)
+        merged.path = resolved_uri.path + request_uri.path
+        merged.query = request_uri.query
+        merged
+      end
+
+      # merge properties from the endpoint resolved auth schemes onto
+      # the auth scheme resolved by the auth resolver.
+      def update_auth_properties(context, auth_schemes)
+        context[:endpoint_auth_schemes] = auth_schemes
+        return unless context.auth
+
+        matching = auth_schemes.find do |a|
+          context.auth.scheme_id == a.scheme_id
+        end
+
+        return unless matching
+
+        context.auth.signer_properties.merge!(matching.properties)
+      end
+    end
+  end
+end

data/lib/hearth/middleware/host_prefix.rb

@@ -3,7 +3,6 @@
 module Hearth
   module Middleware
     # A middleware that prefixes the host.
-    # @api private
     class HostPrefix
       include Middleware::Logging
 
@@ -37,7 +36,7 @@ module Hearth
       end
 
       def apply_labels(host_prefix, input)
-        host_prefix.gsub(/\{.+?\}/) do |host_label|
+        host_prefix.gsub(/\{.+?}/) do |host_label|
           key = host_label.delete('{}')
           value = input[key.to_sym]
           if value.nil? || value.empty?

data/lib/hearth/middleware/initialize.rb

@@ -3,7 +3,6 @@
 module Hearth
   module Middleware
     # A middleware used to initialize the request, called first in the stack
-    # @api private
     class Initialize
       include Middleware::Logging
 

data/lib/hearth/middleware/parse.rb

@@ -3,7 +3,6 @@
 module Hearth
   module Middleware
     # A middleware that parses a response object.
-    # @api private
     class Parse
       include Middleware::Logging
 

data/lib/hearth/middleware/retry.rb

@@ -3,7 +3,6 @@
 module Hearth
   module Middleware
     # A middleware that retries the request using a retry strategy.
-    # @api private
     class Retry
       include Middleware::Logging
 
@@ -75,6 +74,8 @@ module Hearth
 
           if (error = output.error)
             log_debug(context, "Request failed with error: #{error}")
+            break unless retryable?(context.request)
+
             error_info = @error_inspector_class.new(error, context.response)
             token = @retry_strategy.refresh_retry_token(token, error_info)
             break unless token
@@ -93,14 +94,20 @@ module Hearth
           @retries += 1
         end
         log_debug(context, 'Finished retry loop')
+        log_debug(context, "Total retries: #{@retries}")
         output
       end
 
       private
 
+      def retryable?(request)
+        # IO responds to #rewind however it returns an illegal seek error
+        request.body.respond_to?(:rewind) && !request.body.instance_of?(IO)
+      end
+
       def reset_request(context)
         request = context.request
-        request.body.rewind if request.body.respond_to?(:rewind)
+        request.body.rewind
 
         context.auth.signer.reset(
           request: request,

data/lib/hearth/middleware/send.rb

@@ -3,7 +3,6 @@
 module Hearth
   module Middleware
     # A middleware used to send the request.
-    # @api private
     class Send
       include Middleware::Logging
 

data/lib/hearth/middleware.rb

@@ -18,6 +18,7 @@ end
 
 require_relative 'middleware/auth'
 require_relative 'middleware/build'
+require_relative 'middleware/endpoint'
 require_relative 'middleware/host_prefix'
 require_relative 'middleware/parse'
 require_relative 'middleware/retry'

data/lib/hearth/middleware_stack.rb

@@ -15,7 +15,7 @@ module Hearth
     # @param context
     # @return [Output]
     def run(input, context)
-      stack.call(input, context)
+      stack&.call(input, context) || Output.new
     end
 
     private

data/lib/hearth/number_helper.rb

@@ -18,7 +18,7 @@ module Hearth
       end
 
       # @param [String] str
-      # @return [Number] The input as a number
+      # @return [Float, nil] The input as a number
       def deserialize(str)
         case str
         when 'Infinity' then ::Float::INFINITY

data/lib/hearth/query/param.rb

@@ -5,7 +5,7 @@ module Hearth
     # A class used to represent a query parameter before serialization.
     class Param
       # @param [String] name
-      # @param [String, Array<String>] value (nil)
+      # @param [String, Array<String>, nil] value (nil)
       def initialize(name, value = nil)
         @name = name
         @value = value
@@ -20,7 +20,7 @@ module Hearth
       # @return [String]
       def to_s
         if value.is_a?(Array)
-          value.map { |v| serialize(name, v) }.join('&')
+          serialize_array(name, value)
         else
           serialize(name, value)
         end
@@ -33,7 +33,7 @@ module Hearth
           other.value == value
       end
 
-      # @return [Boolean]
+      # @return [Integer]
       def <=>(other)
         name <=> other.name
       end
@@ -44,6 +44,10 @@ module Hearth
         value.nil? ? escape(name) : "#{escape(name)}=#{escape(value)}"
       end
 
+      def serialize_array(name, values)
+        values.map { |v| serialize(name, v) }.join('&')
+      end
+
       def escape(value)
         Hearth::HTTP.uri_escape(value.to_s)
       end

data/lib/hearth/query/param_matcher.rb

@@ -3,7 +3,6 @@
 require 'rspec/expectations'
 
 # Provides an rspec matcher for CGI.parse to check Float precision.
-# @api private
 RSpec::Matchers.define :match_query_params do |expected|
   match do |actual|
     return true if actual == expected
@@ -19,11 +18,11 @@ RSpec::Matchers.define :match_query_params do |expected|
 
       a.zip(e).each do |a0, e0|
         # Timestamps can have optional precision.
-        if (float = Float(a0) rescue false)
-          expect(float).to eq(e0.to_f)
-        else
-          expect(a0).to eq(e0)
-        end
+
+        float = Float(a0)
+        expect(float).to eq(e0.to_f)
+      rescue StandardError
+        expect(a0).to eq(e0)
       end
     end
   end

data/lib/hearth/{refreshing_identity_resolver.rb → refreshing_identity_provider.rb}

@@ -5,7 +5,7 @@ module Hearth
   # 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
+  module RefreshingIdentityProvider
     SYNC_EXPIRATION_LENGTH = 300 # 5 minutes
     ASYNC_EXPIRATION_LENGTH = 600 # 10 minutes
 
@@ -13,7 +13,7 @@ module Hearth
       @mutex = Mutex.new
     end
 
-    # @return [Identity]
+    # @return [Identities::Base]
     def identity(properties = {})
       if @identity
         refresh_if_near_expiration!(properties)

data/lib/hearth/request.rb

@@ -7,7 +7,7 @@ module Hearth
   # Represents a base request.
   class Request
     # @param [URI] uri (URI(''))
-    # @param [IO] body (StringIO.new)
+    # @param [IO, StringIO] body (StringIO.new)
     def initialize(uri: URI(''), body: StringIO.new)
       @uri = uri
       @body = body
@@ -16,7 +16,7 @@ module Hearth
     # @return [URI]
     attr_accessor :uri
 
-    # @return [IO]
+    # @return [IO, StringIO]
     attr_accessor :body
   end
 end

data/lib/hearth/response.rb

@@ -5,12 +5,12 @@ require 'stringio'
 module Hearth
   # Represents a base response.
   class Response
-    # @param [IO] body (StringIO.new)
+    # @param [IO, StringIO] body (StringIO.new)
     def initialize(body: StringIO.new)
       @body = body
     end
 
-    # @return [IO]
+    # @return [IO, StringIO]
     attr_accessor :body
 
     # Replace attributes from other response
@@ -26,7 +26,10 @@ module Hearth
     # Resets the response.
     # @return [Response]
     def reset
+      # IO does not respond to #truncate but it does respond to #rewind
+      # however it returns an illegal seek error.
       @body.truncate(0) if @body.respond_to?(:truncate)
+      @body.rewind if @body.respond_to?(:rewind) && !@body.instance_of?(IO)
       self
     end
   end

data/lib/hearth/retry/adaptive.rb

@@ -3,7 +3,7 @@
 module Hearth
   module Retry
     # Adaptive retry strategy for retrying requests.
-    class Adaptive < Strategy
+    class Adaptive
       # @param [#call] backoff (ExponentialBackoff) A callable object that
       #   calculates a backoff delay for a retry attempt.
       # @param [Integer] max_attempts (3) The maximum number of attempts that
@@ -22,7 +22,7 @@ module Hearth
         # instance state
         @client_rate_limiter = ClientRateLimiter.new
         @retry_quota = RetryQuota.new
-        @capacity_amount = nil
+        @capacity_amount = 0
       end
 
       def acquire_initial_retry_token(_token_scope = nil)

data/lib/hearth/retry/client_rate_limiter.rb

@@ -52,12 +52,6 @@ module Hearth
           update_measured_rate
 
           if is_throttling_error
-            rate_to_use = if @enabled
-                            [@measured_tx_rate, @fill_rate].min
-                          else
-                            @measured_tx_rate
-                          end
-
             # The fill_rate is from the token bucket
             @last_max_rate = rate_to_use
             calculate_time_window
@@ -138,6 +132,14 @@ module Hearth
       def cubic_throttle(rate_to_use)
         rate_to_use * BETA
       end
+
+      def rate_to_use
+        if @enabled
+          [@measured_tx_rate, @fill_rate].min
+        else
+          @measured_tx_rate
+        end
+      end
     end
   end
 end

data/lib/hearth/retry/exponential_backoff.rb

@@ -8,7 +8,7 @@ module Hearth
       MAX_BACKOFF = 20
 
       def call(attempts)
-        [Kernel.rand * (2**attempts), MAX_BACKOFF].min
+        [Kernel.rand * (2**attempts), MAX_BACKOFF].min || 0
       end
     end
   end

data/lib/hearth/retry/standard.rb

@@ -3,7 +3,7 @@
 module Hearth
   module Retry
     # Standard retry strategy for retrying requests.
-    class Standard < Strategy
+    class Standard
       # @param [#call] backoff (ExponentialBackoff) A callable object that
       #   calculates a backoff delay for a retry attempt.
       # @param [Integer] max_attempts (3) The maximum number of attempts that
@@ -15,7 +15,7 @@ module Hearth
 
         # instance state
         @retry_quota = RetryQuota.new
-        @capacity_amount = nil
+        @capacity_amount = 0
       end
 
       def acquire_initial_retry_token(_token_scope = nil)

data/lib/hearth/retry.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require_relative 'retry/strategy'
-
 require_relative 'retry/adaptive'
 require_relative 'retry/capacity_not_available_error'
 require_relative 'retry/client_rate_limiter'
@@ -11,6 +9,21 @@ require_relative 'retry/standard'
 
 module Hearth
   module Retry
-    Token = Struct.new(:retry_count, :retry_delay, keyword_init: true)
+    # Represents a token that can be used to retry an operation.
+    # @!attribute retry_count
+    #   The number of times the operation has been retried.
+    #   @return [Integer]
+    # @!attribute retry_delay
+    #   The delay before the next retry.
+    #   @return [Numeric]
+    Token = Struct.new(:retry_count, :retry_delay, keyword_init: true) do
+      # @option args [Integer] :retry_count (0)
+      # @option args [Numeric] :retry_delay (0)
+      def initialize(*args)
+        super
+        self.retry_count ||= 0
+        self.retry_delay ||= 0
+      end
+    end
   end
 end

data/lib/hearth/structure.rb

@@ -6,15 +6,15 @@ module Hearth
     # Deeply converts the Struct into a hash. Structure members that
     # are `nil` are omitted from the resultant hash.
     #
-    # @return [Hash]
+    # @return [Hash, Structure]
     def to_h(obj = self)
       case obj
       when Struct
         _to_h_struct(obj)
       when Hash
         _to_h_hash(obj)
-      when Array, Set
-        obj.collect { |value| to_hash(value) }
+      when Array
+        _to_h_array(obj)
       when Union
         obj.to_h
       else
@@ -36,5 +36,9 @@ module Hearth
         hash[key] = to_hash(value)
       end
     end
+
+    def _to_h_array(obj)
+      obj.collect { |value| to_hash(value) }
+    end
   end
 end