smithy-client 1.0.0.pre0 → 1.0.0.pre1

data/lib/smithy-client/util.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Client
+    # @api private
+    module Util
+      def self.str_to_bool(str) # rubocop:disable Naming/PredicateMethod
+        case str
+        when 'true' then true
+        when 'false' then false
+        end
+      end
+    end
+  end
+end

data/lib/smithy-client/waiters/poller.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Client
+    module Waiters
+      # Abstract poller class which polls a single API operation and inspects
+      # the output and/or error for states matching one of its acceptors.
+      class Poller
+        def initialize(options = {})
+          @operation_name = options[:operation_name]
+          @acceptors = options[:acceptors]
+        end
+
+        def call(client, params)
+          @input = params
+          request = client.build_request(@operation_name, params)
+          request.handlers.remove(Plugins::RaiseResponseErrors::Handler)
+          response = request.send_request
+          status = evaluate_acceptors(response)
+          [response, status.to_sym]
+        end
+
+        private
+
+        def evaluate_acceptors(response)
+          @acceptors.each do |acceptor|
+            return acceptor['state'] if acceptor_matches?(acceptor['matcher'], response)
+          end
+          response.error.nil? ? 'retry' : 'error'
+        end
+
+        def acceptor_matches?(matcher, response)
+          matcher_type = matcher.keys.first
+          send("matches_#{matcher_type}?", matcher[matcher_type], response)
+        end
+
+        def matches_output?(path_matcher, response)
+          return false if response.data.nil?
+
+          actual = JMESPath.search(path_matcher['path'], response.data)
+          equal?(actual, path_matcher['expected'], path_matcher['comparator'])
+        end
+
+        # rubocop:disable Naming/MethodName
+        def matches_inputOutput?(path_matcher, response)
+          return false unless !response.data.nil? && @input
+
+          data = {
+            input: @input,
+            output: response.data
+          }
+          actual = JMESPath.search(path_matcher['path'], data)
+          equal?(actual, path_matcher['expected'], path_matcher['comparator'])
+        end
+
+        def matches_success?(path_matcher, response)
+          path_matcher == true ? !response.data.nil? : !response.error.nil?
+        end
+
+        def matches_errorType?(path_matcher, response)
+          return false if response.error.nil?
+
+          response.error.class.to_s.end_with?("Errors::#{path_matcher}")
+        end
+
+        def equal?(actual, expected, comparator)
+          send("#{comparator}?", actual, expected)
+        end
+
+        def stringEquals?(actual, expected)
+          actual == expected
+        end
+
+        def booleanEquals?(actual, expected)
+          actual.to_s == expected
+        end
+
+        def allStringEquals?(actual, expected)
+          return false if actual.nil? || actual.empty?
+
+          actual.all? { |value| value == expected }
+        end
+
+        def anyStringEquals?(actual, expected)
+          return false if actual.nil? || actual.empty?
+
+          actual.any? { |value| value == expected }
+        end
+        # rubocop:enable Naming/MethodName
+      end
+    end
+  end
+end

data/lib/smithy-client/waiters/waiter.rb

@@ -0,0 +1,113 @@
+# frozen_string_literal: true
+
+module Smithy
+  module Client
+    module Waiters
+      # Raised when a waiter detects a condition where the waiter can never
+      # succeed.
+      class WaiterFailed < StandardError; end
+
+      # Raised when a waiter enters a failure state.
+      class FailureStateError < WaiterFailed
+        def initialize(error)
+          msg = "stopped waiting, encountered a failure state: #{error}"
+          super(msg)
+        end
+      end
+
+      # Raised when the total wait time of a waiter exceeds the maximum
+      # wait time.
+      class MaxWaitTimeExceededError < WaiterFailed
+        def initialize(max_wait_time)
+          msg = "stopped waiting after maximum wait time of #{max_wait_time} seconds was exceeded"
+          super(msg)
+        end
+      end
+
+      # Raised when a waiter encounters an unexpected error.
+      class UnexpectedError < WaiterFailed
+        def initialize(error)
+          msg = "stopped waiting due to an unexpected error: #{error}"
+          super(msg)
+        end
+      end
+
+      # Raised when attempting to get a waiter by name and the waiter has not
+      # been defined.
+      class NoSuchWaiterError < ArgumentError
+        def initialize(waiter_name, valid_waiters)
+          msg = "no such waiter: #{waiter_name}; valid waiter names are: #{valid_waiters}"
+          super(msg)
+        end
+      end
+
+      # Abstract waiter class which waits for a resource to reach a desired
+      # state.
+      class Waiter
+        def initialize(options = {})
+          @max_wait_time = max_wait_time(options[:max_wait_time])
+          @remaining_time = @max_wait_time
+          @max_delay = max_delay(options[:max_delay])
+          @min_delay = min_delay(options[:min_delay])
+          @poller = options[:poller]
+        end
+
+        def wait(client, params)
+          poll(client, params)
+        end
+
+        private
+
+        def max_wait_time(time)
+          unless time.is_a?(Integer)
+            raise ArgumentError, "expected `:max_wait_time` to be an Integer, got: #{time.class}"
+          end
+
+          time
+        end
+
+        def max_delay(delay)
+          raise ArgumentError, '`:max_delay` must be greater than 0' if delay < 1
+
+          delay
+        end
+
+        def min_delay(delay)
+          if delay < 1 || delay > @max_delay
+            raise ArgumentError, '`:min_delay` must be greater than 0 and less than or equal to `:max_delay`'
+          end
+
+          delay
+        end
+
+        def poll(client, params)
+          attempts = 0
+          loop do
+            response, status = @poller.call(client, params)
+            attempts += 1
+
+            case status
+            when :success then return
+            when :failure then raise FailureStateError, response.error
+            when :error then raise UnexpectedError, response.error
+            when :retry
+              raise MaxWaitTimeExceededError, @max_wait_time if @remaining_time.zero?
+
+              delay = delay(attempts)
+              @remaining_time -= delay
+              sleep(delay)
+            end
+          end
+        end
+
+        def delay(attempts)
+          attempt_ceiling = (Math.log(@max_delay / @min_delay) / Math.log(2)) + 1
+          delay = attempts > attempt_ceiling ? @max_delay : @min_delay * (2**(attempts - 1))
+          delay = rand(@min_delay..delay)
+          delay = @remaining_time if @remaining_time - delay <= @min_delay
+          delay
+        end
+      end
+    end
+  end
+end

data/lib/smithy-client.rb

@@ -1,7 +1,72 @@
 # frozen_string_literal: true
 
+require 'base64'
+require 'bigdecimal'
+require 'jmespath'
+
+require 'smithy-cbor'
+require 'smithy-schema'
+
+# client
+
+require_relative 'smithy-client/block_io'
+require_relative 'smithy-client/configuration'
+require_relative 'smithy-client/default_params'
+require_relative 'smithy-client/dynamic_errors'
+require_relative 'smithy-client/endpoint_rules'
+require_relative 'smithy-client/handler'
+require_relative 'smithy-client/handler_builder'
+require_relative 'smithy-client/handler_context'
+require_relative 'smithy-client/handler_list'
+require_relative 'smithy-client/handler_list_entry'
+require_relative 'smithy-client/log_formatter'
+require_relative 'smithy-client/log_param_filter'
+require_relative 'smithy-client/log_param_formatter'
+require_relative 'smithy-client/managed_file'
+require_relative 'smithy-client/networking_error'
+require_relative 'smithy-client/pageable_response'
+require_relative 'smithy-client/param_converter'
+require_relative 'smithy-client/param_validator'
+require_relative 'smithy-client/plugin'
+require_relative 'smithy-client/plugin_list'
+require_relative 'smithy-client/retry'
+require_relative 'smithy-client/service_error'
+require_relative 'smithy-client/util'
+require_relative 'smithy-client/waiters/poller'
+require_relative 'smithy-client/waiters/waiter'
+require_relative 'smithy-client/request'
+require_relative 'smithy-client/response'
+require_relative 'smithy-client/base'
+
+# client http
+
+require_relative 'smithy-client/http/error_inspector'
+require_relative 'smithy-client/http/headers'
+require_relative 'smithy-client/http/response'
+require_relative 'smithy-client/http/request'
+require_relative 'smithy-client/net_http/connection_pool'
+require_relative 'smithy-client/net_http/handler'
+
+# identity and auth
+
+require_relative 'smithy-client/auth_option'
+require_relative 'smithy-client/auth_scheme'
+require_relative 'smithy-client/identity'
+require_relative 'smithy-client/refreshing_identity_provider'
+require_relative 'smithy-client/signer'
+
+# protocols
+
+require_relative 'smithy-client/rpc_v2_cbor/protocol'
+
+# stubbing
+
+require_relative 'smithy-client/stubs'
+require_relative 'smithy-client/stubbing'
+
 module Smithy
+  # Base module for a generated Smithy gem.
   module Client
-    VERSION = File.read(File.expand_path('../VERSION', __dir__)).strip
+    VERSION = File.read(File.expand_path('../VERSION', __dir__.to_s)).strip
   end
 end

metadata

@@ -1,18 +1,78 @@
 --- !ruby/object:Gem::Specification
 name: smithy-client
 version: !ruby/object:Gem::Version
-  version: 1.0.0.pre0
+  version: 1.0.0.pre1
 platform: ruby
 authors:
 - Amazon Web Services
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-20 00:00:00.000000000 Z
-dependencies: []
+date: 2025-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: base64
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jmespath
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+- !ruby/object:Gem::Dependency
+  name: smithy-cbor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
+- !ruby/object:Gem::Dependency
+  name: smithy-schema
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0.pre1
 description: Smithy is a code generation toolkit for creating Client and Server SDKs
   from Smithy models.
-email:
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -20,11 +80,106 @@ files:
 - CHANGELOG.md
 - VERSION
 - lib/smithy-client.rb
+- lib/smithy-client/anonymous_provider.rb
+- lib/smithy-client/auth_option.rb
+- lib/smithy-client/auth_scheme.rb
+- lib/smithy-client/auth_schemes/anonymous.rb
+- lib/smithy-client/auth_schemes/http_api_key.rb
+- lib/smithy-client/auth_schemes/http_basic.rb
+- lib/smithy-client/auth_schemes/http_bearer.rb
+- lib/smithy-client/auth_schemes/http_digest.rb
+- lib/smithy-client/base.rb
+- lib/smithy-client/block_io.rb
+- lib/smithy-client/configuration.rb
+- lib/smithy-client/default_params.rb
+- lib/smithy-client/dynamic_errors.rb
+- lib/smithy-client/endpoint_rules.rb
+- lib/smithy-client/handler.rb
+- lib/smithy-client/handler_builder.rb
+- lib/smithy-client/handler_context.rb
+- lib/smithy-client/handler_list.rb
+- lib/smithy-client/handler_list_entry.rb
+- lib/smithy-client/http/error_inspector.rb
+- lib/smithy-client/http/headers.rb
+- lib/smithy-client/http/request.rb
+- lib/smithy-client/http/response.rb
+- lib/smithy-client/http_api_key_provider.rb
+- lib/smithy-client/http_bearer_provider.rb
+- lib/smithy-client/http_login_provider.rb
+- lib/smithy-client/identities/anonymous.rb
+- lib/smithy-client/identities/http_api_key.rb
+- lib/smithy-client/identities/http_bearer.rb
+- lib/smithy-client/identities/http_login.rb
+- lib/smithy-client/identity.rb
+- lib/smithy-client/log_formatter.rb
+- lib/smithy-client/log_param_filter.rb
+- lib/smithy-client/log_param_formatter.rb
+- lib/smithy-client/managed_file.rb
+- lib/smithy-client/net_http/connection_pool.rb
+- lib/smithy-client/net_http/handler.rb
+- lib/smithy-client/net_http/patches.rb
+- lib/smithy-client/networking_error.rb
+- lib/smithy-client/pageable_response.rb
+- lib/smithy-client/param_converter.rb
+- lib/smithy-client/param_validator.rb
+- lib/smithy-client/plugin.rb
+- lib/smithy-client/plugin_list.rb
+- lib/smithy-client/plugins/anonymous_auth.rb
+- lib/smithy-client/plugins/checksum_required.rb
+- lib/smithy-client/plugins/content_length.rb
+- lib/smithy-client/plugins/default_params.rb
+- lib/smithy-client/plugins/host_prefix.rb
+- lib/smithy-client/plugins/http_api_key_auth.rb
+- lib/smithy-client/plugins/http_basic_auth.rb
+- lib/smithy-client/plugins/http_bearer_auth.rb
+- lib/smithy-client/plugins/http_digest_auth.rb
+- lib/smithy-client/plugins/idempotency_token.rb
+- lib/smithy-client/plugins/logging.rb
+- lib/smithy-client/plugins/net_http.rb
+- lib/smithy-client/plugins/pageable_response.rb
+- lib/smithy-client/plugins/param_converter.rb
+- lib/smithy-client/plugins/param_validator.rb
+- lib/smithy-client/plugins/protocol.rb
+- lib/smithy-client/plugins/raise_response_errors.rb
+- lib/smithy-client/plugins/request_compression.rb
+- lib/smithy-client/plugins/response_target.rb
+- lib/smithy-client/plugins/retry_errors.rb
+- lib/smithy-client/plugins/sign_requests.rb
+- lib/smithy-client/plugins/stub_responses.rb
+- lib/smithy-client/protocol_spec_matcher.rb
+- lib/smithy-client/refreshing_identity_provider.rb
+- lib/smithy-client/request.rb
+- lib/smithy-client/response.rb
+- lib/smithy-client/retry.rb
+- lib/smithy-client/retry/adaptive.rb
+- lib/smithy-client/retry/client_rate_limiter.rb
+- lib/smithy-client/retry/quota.rb
+- lib/smithy-client/retry/standard.rb
+- lib/smithy-client/rpc_v2_cbor/protocol.rb
+- lib/smithy-client/rpc_v2_cbor/request_builder.rb
+- lib/smithy-client/rpc_v2_cbor/response_parser.rb
+- lib/smithy-client/rpc_v2_cbor/response_stubber.rb
+- lib/smithy-client/service_error.rb
+- lib/smithy-client/signer.rb
+- lib/smithy-client/signers/anonymous.rb
+- lib/smithy-client/signers/http_api_key.rb
+- lib/smithy-client/signers/http_basic.rb
+- lib/smithy-client/signers/http_bearer.rb
+- lib/smithy-client/signers/http_digest.rb
+- lib/smithy-client/stubbing.rb
+- lib/smithy-client/stubbing/data_applicator.rb
+- lib/smithy-client/stubbing/empty_stub.rb
+- lib/smithy-client/stubbing/endpoint_provider.rb
+- lib/smithy-client/stubbing/protocol.rb
+- lib/smithy-client/stubbing/stub_data.rb
+- lib/smithy-client/stubs.rb
+- lib/smithy-client/util.rb
+- lib/smithy-client/waiters/poller.rb
+- lib/smithy-client/waiters/waiter.rb
 homepage: https://github.com/smithy-lang/smithy-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -32,15 +187,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '3.0'
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.11
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Base runtime dependency for Smithy generated clients
 test_files: []