aws-sdk-core 2.8.4 → 3.129.1

data/lib/aws-sdk-core/client_stubs.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'thread'
 
 module Aws
@@ -6,6 +8,9 @@ module Aws
   # return when a client is using stubbed responses. Pass
   # `:stub_responses => true` to a client constructor to enable this
   # behavior.
+  #
+  # Also allows you to see the requests made by the client by reading the
+  # api_requests instance variable
   module ClientStubs
 
     # @api private
@@ -16,7 +21,19 @@ module Aws
         @config.stub_responses.each do |operation_name, stubs|
           apply_stubs(operation_name, Array === stubs ? stubs : [stubs])
         end
-        @config.stub_responses = true
+      end
+
+      # When a client is stubbed allow the user to access the requests made
+      @api_requests = []
+
+      requests = @api_requests
+      self.handle do |context|
+        requests << {
+          operation_name: context.operation_name,
+          params: context.params,
+          context: context
+        }
+        @handler.call(context)
       end
     end
 
@@ -77,6 +94,19 @@ module Aws
     #     Aws::S3::Resource.new.buckets.map(&:name)
     #     #=> ['my-bucket']
     #
+    # ## Dynamic Stubbing
+    #
+    # In addition to creating static stubs, it's also possible to generate
+    # stubs dynamically based on the parameters with which operations were
+    # called, by passing a `Proc` object:
+    #
+    #     s3 = Aws::S3::Resource.new(stub_responses: true)
+    #     s3.client.stub_responses(:put_object, -> (context) {
+    #       s3.client.stub_responses(:get_object, content_type: context.params[:content_type])
+    #     })
+    #
+    # The yielded object is an instance of {Seahorse::Client::RequestContext}.
+    #
     # ## Stubbing Errors
     #
     # When stubbing is enabled, the SDK will default to generate
@@ -143,17 +173,39 @@ module Aws
     # @raise [RuntimeError] Raises a runtime error when called
     #   on a client that has not enabled response stubbing via
     #   `:stub_responses => true`.
-    #
     def stub_responses(operation_name, *stubs)
       if config.stub_responses
         apply_stubs(operation_name, stubs.flatten)
       else
-        msg = 'stubbing is not enabled; enable stubbing in the constructor '
-        msg << 'with `:stub_responses => true`'
+        msg = 'stubbing is not enabled; enable stubbing in the constructor '\
+              'with `:stub_responses => true`'
         raise msg
       end
     end
 
+    # Allows you to access all of the requests that the stubbed client has made.
+    #
+    # @param [Hash] options The options for the api requests.
+    # @option options [Boolean] :exclude_presign (false) Set to true to filter
+    #   out unsent requests from generated presigned urls.
+    # @return [Array] Returns an array of the api requests made. Each request
+    #   object contains the :operation_name, :params, and :context.
+    # @raise [NotImplementedError] Raises `NotImplementedError` when the client
+    #   is not stubbed.
+    def api_requests(options = {})
+      if config.stub_responses
+        if options[:exclude_presign]
+          @api_requests.reject {|req| req[:context][:presigned_url] }
+        else
+          @api_requests
+        end
+      else
+        msg = 'This method is only implemented for stubbed clients, and is '\
+              'available when you enable stubbing in the constructor with `stub_responses: true`'
+        raise NotImplementedError.new(msg)
+      end
+    end
+
     # Generates and returns stubbed response data from the named operation.
     #
     #     s3 = Aws::S3::Client.new
@@ -173,7 +225,7 @@ module Aws
     # @return [Structure] Returns a stubbed response data structure. The
     #   actual class returned will depend on the given `operation_name`.
     def stub_data(operation_name, data = {})
-      Stubbing::StubData.new(operation(operation_name)).stub(data)
+      Stubbing::StubData.new(config.api.operation(operation_name)).stub(data)
     end
 
     # @api private
@@ -210,13 +262,17 @@ module Aws
     end
 
     def convert_stub(operation_name, stub)
-      case stub
+      stub = case stub
       when Proc then stub
       when Exception, Class then { error: stub }
       when String then service_error_stub(stub)
       when Hash then http_response_stub(operation_name, stub)
       else { data: stub }
       end
+      if Hash === stub
+        stub[:mutex] = Mutex.new
+      end
+      stub
     end
 
     def service_error_stub(error_code)
@@ -242,17 +298,18 @@ module Aws
     def data_to_http_resp(operation_name, data)
       api = config.api
       operation = api.operation(operation_name)
-      ParamValidator.validate!(operation.output, data)
+      ParamValidator.new(operation.output, input: false).validate!(data)
       protocol_helper.stub_data(api, operation, data)
     end
 
     def protocol_helper
       case config.api.metadata['protocol']
-      when 'json'      then Stubbing::Protocols::Json
-      when 'query'     then Stubbing::Protocols::Query
-      when 'ec2'       then Stubbing::Protocols::EC2
-      when 'rest-json' then Stubbing::Protocols::RestJson
-      when 'rest-xml'  then Stubbing::Protocols::RestXml
+      when 'json'        then Stubbing::Protocols::Json
+      when 'query'       then Stubbing::Protocols::Query
+      when 'ec2'         then Stubbing::Protocols::EC2
+      when 'rest-json'   then Stubbing::Protocols::RestJson
+      when 'rest-xml'    then Stubbing::Protocols::RestXml
+      when 'api-gateway' then Stubbing::Protocols::ApiGateway
       else raise "unsupported protocol"
       end.new
     end

data/lib/aws-sdk-core/credential_provider.rb

@@ -1,8 +1,8 @@
+# frozen_string_literal: true
+
 module Aws
   module CredentialProvider
 
-    extend Deprecations
-
     # @return [Credentials]
     attr_reader :credentials
 
@@ -11,32 +11,5 @@ module Aws
       !!credentials && credentials.set?
     end
 
-    # @deprecated Deprecated in 2.1.0. This method is subject to errors
-    #   from a race condition when called against refreshable credential
-    #   objects. Will be removed in 2.2.0.
-    # @see #credentials
-    def access_key_id
-      credentials ? credentials.access_key_id : nil
-    end
-    deprecated(:access_key_id, use: '#credentials')
-
-    # @deprecated Deprecated in 2.1.0. This method is subject to errors
-    #   from a race condition when called against refreshable credential
-    #   objects. Will be removed in 2.2.0.
-    # @see #credentials
-    def secret_access_key
-      credentials ? credentials.secret_access_key : nil
-    end
-    deprecated(:secret_access_key, use: '#credentials')
-
-    # @deprecated Deprecated in 2.1.0. This method is subject to errors
-    #   from a race condition when called against refreshable credential
-    #   objects. Will be removed in 2.2.0.
-    # @see #credentials
-    def session_token
-      credentials ? credentials.session_token : nil
-    end
-    deprecated(:session_token, use: '#credentials')
-
   end
 end

data/lib/aws-sdk-core/credential_provider_chain.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module Aws
   # @api private
   class CredentialProviderChain
-
     def initialize(config = nil)
       @config = config
     end
@@ -20,14 +21,22 @@ module Aws
     def providers
       [
         [:static_credentials, {}],
+        [:static_profile_assume_role_web_identity_credentials, {}],
+        [:static_profile_sso_credentials, {}],
+        [:static_profile_assume_role_credentials, {}],
+        [:static_profile_credentials, {}],
+        [:static_profile_process_credentials, {}],
         [:env_credentials, {}],
+        [:assume_role_web_identity_credentials, {}],
+        [:sso_credentials, {}],
         [:assume_role_credentials, {}],
         [:shared_credentials, {}],
+        [:process_credentials, {}],
         [:instance_profile_credentials, {
           retries: @config ? @config.instance_profile_credentials_retries : 0,
           http_open_timeout: @config ? @config.instance_profile_credentials_timeout : 1,
-          http_read_timeout: @config ? @config.instance_profile_credentials_timeout : 1,
-        }],
+          http_read_timeout: @config ? @config.instance_profile_credentials_timeout : 1
+        }]
       ]
     end
 
@@ -36,33 +45,90 @@ module Aws
         Credentials.new(
           options[:config].access_key_id,
           options[:config].secret_access_key,
-          options[:config].session_token)
-      else
-        nil
+          options[:config].session_token
+        )
+      end
+    end
+
+    def static_profile_assume_role_web_identity_credentials(options)
+      if Aws.shared_config.config_enabled? && options[:config] && options[:config].profile
+        Aws.shared_config.assume_role_web_identity_credentials_from_config(
+          profile: options[:config].profile,
+          region: options[:config].region
+        )
+      end
+    end
+
+    def static_profile_sso_credentials(options)
+      if Aws.shared_config.config_enabled? && options[:config] && options[:config].profile
+        Aws.shared_config.sso_credentials_from_config(
+          profile: options[:config].profile
+        )
+      end
+    end
+
+    def static_profile_assume_role_credentials(options)
+      if Aws.shared_config.config_enabled? && options[:config] && options[:config].profile
+        assume_role_with_profile(options, options[:config].profile)
       end
     end
 
-    def env_credentials(options)
-      key =    %w(AWS_ACCESS_KEY_ID     AMAZON_ACCESS_KEY_ID     AWS_ACCESS_KEY)
-      secret = %w(AWS_SECRET_ACCESS_KEY AMAZON_SECRET_ACCESS_KEY AWS_SECRET_KEY)
-      token =  %w(AWS_SESSION_TOKEN     AMAZON_SESSION_TOKEN)
+    def static_profile_credentials(options)
+      if options[:config] && options[:config].profile
+        SharedCredentials.new(profile_name: options[:config].profile)
+      end
+    rescue Errors::NoSuchProfileError
+      nil
+    end
+
+    def static_profile_process_credentials(options)
+      if Aws.shared_config.config_enabled? && options[:config] && options[:config].profile
+        process_provider = Aws.shared_config.credential_process(profile: options[:config].profile)
+        ProcessCredentials.new(process_provider) if process_provider
+      end
+    rescue Errors::NoSuchProfileError
+      nil
+    end
+
+    def env_credentials(_options)
+      key =    %w[AWS_ACCESS_KEY_ID AMAZON_ACCESS_KEY_ID AWS_ACCESS_KEY]
+      secret = %w[AWS_SECRET_ACCESS_KEY AMAZON_SECRET_ACCESS_KEY AWS_SECRET_KEY]
+      token =  %w[AWS_SESSION_TOKEN AMAZON_SESSION_TOKEN]
       Credentials.new(envar(key), envar(secret), envar(token))
     end
 
     def envar(keys)
       keys.each do |key|
-        if ENV.key?(key)
-          return ENV[key]
-        end
+        return ENV[key] if ENV.key?(key)
       end
       nil
     end
 
+    def determine_profile_name(options)
+      (options[:config] && options[:config].profile) || ENV['AWS_PROFILE'] || ENV['AWS_DEFAULT_PROFILE'] || 'default'
+    end
+
     def shared_credentials(options)
-      if options[:config]
-        SharedCredentials.new(profile_name: options[:config].profile)
-      else
-        SharedCredentials.new(profile_name: 'default')
+      profile_name = determine_profile_name(options)
+      SharedCredentials.new(profile_name: profile_name)
+    rescue Errors::NoSuchProfileError
+      nil
+    end
+
+    def process_credentials(options)
+      profile_name = determine_profile_name(options)
+      if Aws.shared_config.config_enabled? &&
+         (process_provider = Aws.shared_config.credential_process(profile: profile_name))
+        ProcessCredentials.new(process_provider)
+      end
+    rescue Errors::NoSuchProfileError
+      nil
+    end
+
+    def sso_credentials(options)
+      profile_name = determine_profile_name(options)
+      if Aws.shared_config.config_enabled?
+        Aws.shared_config.sso_credentials_from_config(profile: profile_name)
       end
     rescue Errors::NoSuchProfileError
       nil
@@ -70,32 +136,45 @@ module Aws
 
     def assume_role_credentials(options)
       if Aws.shared_config.config_enabled?
-        profile, region = nil, nil
-        if options[:config]
-          profile = options[:config].profile
-          region = options[:config].region
-          assume_role_with_profile(options[:config].profile, options[:config].region)
-        end
-        assume_role_with_profile(profile, region)
-      else
-        nil
+        assume_role_with_profile(options, determine_profile_name(options))
+      end
+    end
+
+    def assume_role_web_identity_credentials(options)
+      region = options[:config].region if options[:config]
+      if (role_arn = ENV['AWS_ROLE_ARN']) && (token_file = ENV['AWS_WEB_IDENTITY_TOKEN_FILE'])
+        cfg = {
+          role_arn: role_arn,
+          web_identity_token_file: token_file,
+          role_session_name: ENV['AWS_ROLE_SESSION_NAME']
+        }
+        cfg[:region] = region if region
+        AssumeRoleWebIdentityCredentials.new(cfg)
+      elsif Aws.shared_config.config_enabled?
+        profile = options[:config].profile if options[:config]
+        Aws.shared_config.assume_role_web_identity_credentials_from_config(
+          profile: profile,
+          region: region
+        )
       end
     end
 
     def instance_profile_credentials(options)
-      if ENV["AWS_CONTAINER_CREDENTIALS_RELATIVE_URI"]
+      profile_name = determine_profile_name(options)
+      if ENV['AWS_CONTAINER_CREDENTIALS_RELATIVE_URI']
         ECSCredentials.new(options)
       else
-        InstanceProfileCredentials.new(options)
+        InstanceProfileCredentials.new(options.merge(profile: profile_name))
       end
     end
 
-    def assume_role_with_profile(prof, region)
+    def assume_role_with_profile(options, profile_name)
+      region = (options[:config] && options[:config].region)
       Aws.shared_config.assume_role_credentials_from_config(
-        profile: prof,
-        region: region
+        profile: profile_name,
+        region: region,
+        chain_config: @config
       )
     end
-
   end
 end

data/lib/aws-sdk-core/credentials.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aws
   class Credentials
 

data/lib/aws-sdk-core/deprecations.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Aws
 
   # A utility module that provides a class method that wraps
@@ -35,33 +37,37 @@ module Aws
   # @api private
   module Deprecations
 
-    # @param [Symbol] method_name The name of the deprecated method.
+    # @param [Symbol] method The name of the deprecated method.
     #
     # @option options [String] :message The warning message to issue
     #   when the deprecated method is called.
     #
-    # @option options [Symbol] :use The name of an use
-    #   method that should be used.
+    # @option options [String] :use The name of a method that should be used.
+    #
+    # @option options [String] :version The version that will remove the
+    #   deprecated method.
     #
-    def deprecated(method_name, options = {})
+    def deprecated(method, options = {})
 
       deprecation_msg = options[:message] || begin
-        msg = "DEPRECATION WARNING: called deprecated method `#{method_name}' "
-        msg << "of an #{self}"
-        msg << ", use #{options[:use]} instead" if options[:use]
-        msg
+        "#################### DEPRECATION WARNING ####################\n"\
+        "Called deprecated method `#{method}` of #{self}."\
+        "#{" Use `#{options[:use]}` instead.\n" if options[:use]}"\
+        "#{"Method `#{method}` will be removed in #{options[:version]}."\
+          if options[:version]}"\
+        "\n#############################################################"
       end
 
-      alias_method(:"deprecated_#{method_name}", method_name)
+      alias_method(:"deprecated_#{method}", method)
 
       warned = false # we only want to issue this warning once
 
-      define_method(method_name) do |*args,&block|
+      define_method(method) do |*args, &block|
         unless warned
           warned = true
           warn(deprecation_msg + "\n" + caller.join("\n"))
         end
-        send("deprecated_#{method_name}", *args, &block)
+        send("deprecated_#{method}", *args, &block)
       end
     end
 

data/lib/aws-sdk-core/eager_loader.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'set'
 
 module Aws