aws-sdk-rails 3.6.1 → 3.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 839c723ba30e8acd11e135351278a0422b4f7e6a09a364b8a3fda7d33aa2e899
-  data.tar.gz: af1ba6b6525f17e6a46cc16aa4ccbaaf8317860ddf5cd6128d3883c82660ee24
+  metadata.gz: 48698b21d8248ac597ad8fd9d334e52d9399cf5880c994ffe556aa2e988f81e6
+  data.tar.gz: bd88191e84e5676435a2d2135ad6f6835cb8c624eef573c688a81c3bd9e8f255
 SHA512:
-  metadata.gz: 8288a0c8551bc30cac782c7510a825fdcd9d8ba31bd1d2feda8c2a20ad29f569194237f686f191f1a57ee12eb91a08bb1c5b65b07519af5b62bd7f56ab3f79cb
-  data.tar.gz: d6835fc12e6a4a5bc9573b4c5b997a1df5d17e49c28ea2ea16e76f8ebc7b2c8c515026b0a48fb0b15eaab3ba22f1904782f553a03a784dcd665d71723ddd47bd
+  metadata.gz: ec0f7a6f90b736285486d3a36d7aab50cf1d368d9ea69f4b76031634b16df1e899d8146586b9b806f0921f2afebecc5444fe25badf4f0d8bf54a3cf42f472b3c
+  data.tar.gz: bbfe9b2488cf8c141a5e196a2ebe9631705ed176327db28a1503213f82aac81f3ec37be4f77109665fbf3690c344c52870b39f5c12f35d031b89387b057bbe5a

data/VERSION

@@ -1 +1 @@
-3.6.1
+3.7.1

data/lib/action_dispatch/session/dynamodb_store.rb

@@ -1,4 +1,5 @@
 require 'aws-sessionstore-dynamodb'
+require 'action_dispatch/middleware/session/abstract_store'
 
 module ActionDispatch
   module Session
@@ -9,11 +10,14 @@ module ActionDispatch
     # This class will use the Rails secret_key_base unless otherwise provided.
     #
     # Configuration can also be provided in YAML files from Rails config, either
-    # in "config/session_store.yml" or "config/session_store/#{Rails.env}.yml".
+    # in "config/session_store.yml" or "config/session_store/#\\{Rails.env}.yml".
     # Configuration files that are environment-specific will take precedence.
     #
     # @see https://docs.aws.amazon.com/sdk-for-ruby/aws-sessionstore-dynamodb/api/Aws/SessionStore/DynamoDB/Configuration.html
     class DynamodbStore < Aws::SessionStore::DynamoDB::RackMiddleware
+      include StaleSessionCheck
+      include SessionObject
+
       def initialize(app, options = {})
         options[:config_file] ||= config_file if config_file.exist?
         options[:secret_key] ||= Rails.application.secret_key_base

data/lib/active_job/queue_adapters/amazon_sqs_adapter.rb

@@ -11,16 +11,16 @@ module ActiveJob
         _enqueue(job)
       end
 
-      def enqueue_at(job, timestamp, opts={})
+      def enqueue_at(job, timestamp)
         delay = (timestamp - Time.now.to_f).floor
         raise ArgumentError, 'Unable to queue a job with a delay great than 15 minutes' if delay > 15.minutes
-        _enqueue(job, delay_seconds: delay)
+        _enqueue(job, nil, delay_seconds: delay)
       end
 
       private
 
-      def _enqueue(job, send_message_opts = {})
-        body = job.serialize
+      def _enqueue(job, body = nil, send_message_opts = {})
+        body ||= job.serialize
         queue_url = Aws::Rails::SqsActiveJob.config.queue_url_for(job.queue_name)
         send_message_opts[:queue_url] = queue_url
         send_message_opts[:message_body] = Aws::Json.dump(body)
@@ -30,13 +30,15 @@ module ActiveJob
           # job_id is unique per initialization of job
           # Remove it from message dup id to ensure run-once behavior
           # with ActiveJob retries
-           send_message_opts[:message_deduplication_id] =
-             Digest::SHA256.hexdigest(
-               Aws::Json.dump(body.except('job_id'))
-             )
+          send_message_opts[:message_deduplication_id] =
+            Digest::SHA256.hexdigest(Aws::Json.dump(body.except('job_id')))
 
-           send_message_opts[:message_group_id] = Aws::Rails::SqsActiveJob.config.message_group_id
+          message_group_id = job.message_group_id if job.respond_to?(:message_group_id)
+          message_group_id ||= Aws::Rails::SqsActiveJob.config.message_group_id
+
+          send_message_opts[:message_group_id] = message_group_id
         end
+
         Aws::Rails::SqsActiveJob.config.client.send_message(send_message_opts)
       end
 

data/lib/active_job/queue_adapters/amazon_sqs_async_adapter.rb

@@ -18,19 +18,22 @@ module ActiveJob
 
       private
 
-      def _enqueue(job, send_message_opts = {})
+      def _enqueue(job, body = nil, send_message_opts = {})
         # FIFO jobs must be queued in order, so do not queue async
         queue_url = Aws::Rails::SqsActiveJob.config.queue_url_for(job.queue_name)
         if Aws::Rails::SqsActiveJob.fifo?(queue_url)
-          super(job, send_message_opts)
+          super(job, body, send_message_opts)
         else
-          Concurrent::Promise
-          .execute { super(job, send_message_opts) }
-          .on_error do |e|
-            Rails.logger.error "Failed to queue job #{job}.  Reason: #{e}"
-            error_handler = Aws::Rails::SqsActiveJob.config.async_queue_error_handler
-            error_handler.call(e, job, send_message_opts) if error_handler
-          end
+          # Serialize is called here because the job’s locale needs to be
+          # determined in this thread and not in some other thread.
+          body = job.serialize
+          Concurrent::Promises
+            .future { super(job, body, send_message_opts) }
+            .rescue do |e|
+              Rails.logger.error "Failed to queue job #{job}. Reason: #{e}"
+              error_handler = Aws::Rails::SqsActiveJob.config.async_queue_error_handler
+              error_handler&.call(e, job, send_message_opts)
+            end
         end
       end
     end

data/lib/aws/rails/middleware/ebs_sqs_active_job_middleware.rb

@@ -11,7 +11,7 @@ module Aws
 
       def initialize(app)
         @app = app
-        @logger = ActiveSupport::Logger.new(STDOUT)
+        @logger = ::Rails.logger
       end
 
       def call(env)
@@ -20,11 +20,11 @@ module Aws
         # Pass through unless user agent is the SQS Daemon
         return @app.call(env) unless from_sqs_daemon?(request)
 
-        @logger.debug('aws-rails-sdk middleware detected call from Elastic Beanstalk SQS Daemon.')
+        @logger.debug('aws-sdk-rails middleware detected call from Elastic Beanstalk SQS Daemon.')
 
         # Only accept requests from this user agent if it is from localhost or a docker host in case of forgery.
         unless request.local? || sent_from_docker_host?(request)
-          @logger.warn("SQSD request detected from untrusted address #{request.remote_ip}; returning 403 forbidden.")
+          @logger.warn("SQSD request detected from untrusted address #{request.ip}; returning 403 forbidden.")
           return FORBIDDEN_RESPONSE
         end
 
@@ -81,12 +81,30 @@ module Aws
       end
 
       def sent_from_docker_host?(request)
-        app_runs_in_docker_container? && request.remote_ip == '172.17.0.1'
+        app_runs_in_docker_container? && default_gw_ips.include?(request.ip)
       end
 
       def app_runs_in_docker_container?
         @app_runs_in_docker_container ||= `[ -f /proc/1/cgroup ] && cat /proc/1/cgroup` =~ /docker/
       end
+
+      def default_gw_ips
+        default_gw_ips = ['172.17.0.1']
+
+        if File.exist?('/proc/net/route')
+          File.open('/proc/net/route').each_line do |line|
+            fields = line.strip.split
+            next if fields.size != 11
+
+            # Destination == 0.0.0.0 and Flags & RTF_GATEWAY != 0
+            if fields[1] == '00000000' && (fields[3].hex & 0x2) != 0
+              default_gw_ips << IPAddr.new_ntoh([fields[2].hex].pack('L')).to_s
+            end
+          end
+        end
+
+        default_gw_ips
+      end
     end
   end
 end

data/lib/aws/rails/railtie.rb

@@ -10,6 +10,7 @@ module Aws
         # Initialization Actions
         Aws::Rails.use_rails_encrypted_credentials
         Aws::Rails.add_action_mailer_delivery_method
+        Aws::Rails.add_action_mailer_delivery_method(:sesv2)
         Aws::Rails.log_to_rails_logger
       end
 
@@ -28,11 +29,15 @@ module Aws
     #
     # @param [Symbol] name The name of the ActionMailer delivery method to
     #   register.
-    # @param [Hash] options The options you wish to pass on to the
-    #   Aws::SES::Client initialization method.
-    def self.add_action_mailer_delivery_method(name = :ses, options = {})
+    # @param [Hash] client_options The options you wish to pass on to the
+    #   Aws::SES[V2]::Client initialization method.
+    def self.add_action_mailer_delivery_method(name = :ses, client_options = {})
       ActiveSupport.on_load(:action_mailer) do
-        add_delivery_method(name, Aws::Rails::Mailer, options)
+        if name == :sesv2
+          add_delivery_method(name, Aws::Rails::Sesv2Mailer, client_options)
+        else
+          add_delivery_method(name, Aws::Rails::SesMailer, client_options)
+        end
       end
     end
 

data/lib/aws/rails/{mailer.rb → ses_mailer.rb}

@@ -15,7 +15,7 @@ module Aws
     #
     # Uses the AWS SDK for Ruby's credential provider chain when creating an SES
     # client instance.
-    class Mailer
+    class SesMailer
       # @param [Hash] options Passes along initialization options to
       #   [Aws::SES::Client.new](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SES/Client.html#initialize-instance_method).
       def initialize(options = {})
@@ -25,15 +25,12 @@ module Aws
       # Rails expects this method to exist, and to handle a Mail::Message object
       # correctly. Called during mail delivery.
       def deliver!(message)
-        send_opts = {}
-        send_opts[:raw_message] = {}
-        send_opts[:raw_message][:data] = message.to_s
-
-        if message.respond_to?(:destinations)
-          send_opts[:destinations] = message.destinations
-        end
-
-        @client.send_raw_email(send_opts).tap do |response|
+        params = {
+          raw_message: { data: message.to_s },
+          source: message.smtp_envelope_from, # defaults to From header
+          destinations: message.smtp_envelope_to # defaults to destinations (To,Cc,Bcc)
+        }
+        @client.send_raw_email(params).tap do |response|
           message.header[:ses_message_id] = response.message_id
         end
       end
@@ -45,3 +42,7 @@ module Aws
     end
   end
 end
+
+# This is for backwards compatibility after introducing support for SESv2.
+# The old mailer is now replaced with the new SES (v1) mailer.
+Aws::Rails::Mailer = Aws::Rails::SesMailer

data/lib/aws/rails/sesv2_mailer.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sesv2'
+
+module Aws
+  module Rails
+    # Provides a delivery method for ActionMailer that uses Amazon Simple Email
+    # Service V2.
+    #
+    # Once you have an SESv2 delivery method you can configure Rails to
+    # use this for ActionMailer in your environment configuration
+    # (e.g. RAILS_ROOT/config/environments/production.rb)
+    #
+    #     config.action_mailer.delivery_method = :sesv2
+    #
+    # Uses the AWS SDK for Ruby's credential provider chain when creating an SESV2
+    # client instance.
+    class Sesv2Mailer
+      # @param [Hash] options Passes along initialization options to
+      #   [Aws::SESV2::Client.new](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SESV2/Client.html#initialize-instance_method).
+      def initialize(options = {})
+        @client = SESV2::Client.new(options)
+      end
+
+      # Rails expects this method to exist, and to handle a Mail::Message object
+      # correctly. Called during mail delivery.
+      def deliver!(message)
+        params = { content: { raw: { data: message.to_s } } }
+        # smtp_envelope_from will default to the From address *without* sender names.
+        # By omitting this param, SESv2 will correctly use sender names from the mail headers.
+        # We should only use smtp_envelope_from when it was explicitly set (instance variable set)
+        params[:from_email_address] = message.smtp_envelope_from if message.instance_variable_get(:@smtp_envelope_from)
+        params[:destination] = {
+          to_addresses: to_addresses(message),
+          cc_addresses: message.cc,
+          bcc_addresses: message.bcc
+        }
+
+        @client.send_email(params).tap do |response|
+          message.header[:ses_message_id] = response.message_id
+        end
+      end
+
+      # ActionMailer expects this method to be present and to return a hash.
+      def settings
+        {}
+      end
+
+      private
+
+      # smtp_envelope_to will default to the full destinations (To, Cc, Bcc)
+      # SES v2 API prefers each component split out into a destination hash.
+      # When smtp_envelope_to was set, use it explicitly for to_address only.
+      def to_addresses(message)
+        message.instance_variable_get(:@smtp_envelope_to) ? message.smtp_envelope_to : message.to
+      end
+    end
+  end
+end

data/lib/aws/rails/sqs_active_job/configuration.rb

@@ -26,7 +26,6 @@ module Aws
         # @api private
         DEFAULTS = {
           max_messages:  10,
-          visibility_timeout: 120,
           shutdown_timeout: 15,
           queues: {},
           logger: ::Rails.logger,
@@ -50,6 +49,8 @@ module Aws
         #    The max number of messages to poll for in a batch.
         #
         # @option options [Integer] :visibility_timeout
+        #   If unset, the visibility timeout configured on the
+        #   SQS queue will be used.
         #   The visibility timeout is the number of seconds
         #   that a message will not be processable by any other consumers.
         #   You should set this value to be longer than your expected job runtime
@@ -99,7 +100,7 @@ module Aws
           job_queue = job_queue.to_sym
           raise ArgumentError, "No queue defined for #{job_queue}" unless queues.key? job_queue
 
-          queues[job_queue.to_sym]
+          queues[job_queue]
         end
 
         # @api private
@@ -144,8 +145,7 @@ module Aws
 
         # Load options from YAML file
         def load_from_file(file_path)
-          require "erb"
-          opts = YAML.load(ERB.new(File.read(file_path)).result) || {}
+          opts = load_yaml(file_path) || {}
           opts.deep_symbolize_keys
         end
 
@@ -157,6 +157,19 @@ module Aws
         def user_agent
           "ft/aws-sdk-rails-activejob/#{Aws::Rails::VERSION}"
         end
+
+        def load_yaml(file_path)
+          require "erb"
+          source = ERB.new(File.read(file_path)).result
+
+          # Avoid incompatible changes with Psych 4.0.0
+          # https://bugs.ruby-lang.org/issues/17866
+          begin
+            YAML.load(source, aliases: true) || {}
+          rescue ArgumentError
+            YAML.load(source) || {}
+          end
+        end
       end
     end
   end

data/lib/aws/rails/sqs_active_job/poller.rb

@@ -17,7 +17,6 @@ module Aws
         DEFAULT_OPTS = {
           threads: 2*Concurrent.processor_count,
           max_messages: 10,
-          visibility_timeout: 60,
           shutdown_timeout: 15,
           backpressure: 10
         }

data/lib/aws-sdk-rails.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'aws/rails/mailer'
+require_relative 'aws/rails/ses_mailer'
+require_relative 'aws/rails/sesv2_mailer'
 require_relative 'aws/rails/railtie'
 require_relative 'aws/rails/notifications'
 require_relative 'aws/rails/sqs_active_job/configuration'

data/lib/generators/aws_record/model/model_generator.rb

@@ -9,11 +9,11 @@ module AwsRecord
       end
 
       def create_model
-        template "model.rb", File.join("app/models", class_path, "#{file_name}.rb")
+        template "model.erb", File.join("app/models", class_path, "#{file_name}.rb")
       end
 
       def create_table_config
-        template "table_config.rb", File.join("db/table_config", class_path, "#{file_name}_config.rb") if options["table_config"]
+        template "table_config.erb", File.join("db/table_config", class_path, "#{file_name}_config.rb") if options["table_config"]
       end
 
     end

data/lib/generators/dynamo_db/session_store_migration/session_store_migration_generator.rb

@@ -18,7 +18,7 @@ module DynamoDb
       #   of a DynamoDB session table.
       def generate_migration_file
         migration_template(
-          'session_store_migration.rb',
+          'session_store_migration.erb',
           "db/migrate/#{name.underscore}.rb"
         )
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rails
 version: !ruby/object:Gem::Version
-  version: 3.6.1
+  version: 3.7.1
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-06-08 00:00:00.000000000 Z
+date: 2023-02-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-record
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-sesv2
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: aws-sdk-sqs
   requirement: !ruby/object:Gem::Requirement
@@ -123,10 +137,11 @@ files:
 - lib/active_job/queue_adapters/amazon_sqs_adapter.rb
 - lib/active_job/queue_adapters/amazon_sqs_async_adapter.rb
 - lib/aws-sdk-rails.rb
-- lib/aws/rails/mailer.rb
 - lib/aws/rails/middleware/ebs_sqs_active_job_middleware.rb
 - lib/aws/rails/notifications.rb
 - lib/aws/rails/railtie.rb
+- lib/aws/rails/ses_mailer.rb
+- lib/aws/rails/sesv2_mailer.rb
 - lib/aws/rails/sqs_active_job/configuration.rb
 - lib/aws/rails/sqs_active_job/executor.rb
 - lib/aws/rails/sqs_active_job/job_runner.rb
@@ -136,13 +151,13 @@ files:
 - lib/generators/aws_record/generated_attribute.rb
 - lib/generators/aws_record/model/USAGE
 - lib/generators/aws_record/model/model_generator.rb
-- lib/generators/aws_record/model/templates/model.rb
-- lib/generators/aws_record/model/templates/table_config.rb
+- lib/generators/aws_record/model/templates/model.erb
+- lib/generators/aws_record/model/templates/table_config.erb
 - lib/generators/aws_record/secondary_index.rb
 - lib/generators/dynamo_db/session_store_migration/USAGE
 - lib/generators/dynamo_db/session_store_migration/session_store_migration_generator.rb
 - lib/generators/dynamo_db/session_store_migration/templates/dynamo_db_session_store.yml
-- lib/generators/dynamo_db/session_store_migration/templates/session_store_migration.rb
+- lib/generators/dynamo_db/session_store_migration/templates/session_store_migration.erb
 - lib/tasks/aws_record/migrate.rake
 - lib/tasks/dynamo_db/session_store.rake
 homepage: https://github.com/aws/aws-sdk-rails