aws-sdk-rails 2.1.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 105a6ec68c6b8ca61c5d4601a3102223b2a7bd29cd643635b8f46b50c0b918a4
-  data.tar.gz: ef976f4a27a8542e5a264f2baad36a914ad2918068461b083a166a5ab8590f39
+  metadata.gz: b252fc5ed5514c1ab48750fc65acde4008f1f6a8b685bae42903708f7b987a14
+  data.tar.gz: da794888829a46dfeec19350997e753b9858bf07a0668ef603594d9db46bdf9a
 SHA512:
-  metadata.gz: 39f7819a13cfa4ec5a95d7ef85e11830224b445006f2b2f168700ac2840f4f02646cfb694316a4c973ead7c56325bd1fb9f7ac67ec8f3d61b41e38a9f7513361
-  data.tar.gz: 6b60ca1d73b53de41c89a2c6d4acd15500240dc34514b5291de56a1ebfcb7962df9242d3576b7512724d041f5771d4fc1c792959e3449613c0e1f6a075379fa2
+  metadata.gz: 5c5a5f74b8faab027f2d8b3b64e32a4feb2e85c29207d051a66e93424b6b71d8dbdf0dd80ba1baac1b9be66489759c8efba1860fdba7d41990fbd8279d173b08
+  data.tar.gz: 227f06499dbd9a1705eae1ffb00777502cbfa3f512c8e07b1a037d5b04a35afcc651487518ea582e646cf6060682112a85d8baf59e6a9d543eb7beb16c8e3fa7

data/VERSION

@@ -0,0 +1 @@
+3.4.0

data/bin/aws_sqs_active_job

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/aws/rails/sqs_active_job/poller'
+
+Aws::Rails::SqsActiveJob::Poller.new.run

data/lib/action_dispatch/session/dynamodb_store.rb

@@ -0,0 +1,32 @@
+require 'aws-sessionstore-dynamodb'
+
+module ActionDispatch
+  module Session
+    # Uses the Dynamo DB Session Store implementation to create a class that
+    # extends ActionDispatch::Session. Rails will create a :dynamodb_store
+    # configuration for session_store from this class name.
+    #
+    # 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".
+    # 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
+      def initialize(app, options = {})
+        options[:config_file] ||= config_file if config_file.exist?
+        options[:secret_key] ||= Rails.application.secret_key_base
+        super
+      end
+
+      private
+
+      def config_file
+        file = Rails.root.join("config/dynamo_db_session_store/#{Rails.env}.yml")
+        file = Rails.root.join('config/dynamo_db_session_store.yml') unless file.exist?
+        file
+      end
+    end
+  end
+end

data/lib/active_job/queue_adapters/amazon_sqs_adapter.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sqs'
+
+module ActiveJob
+  module QueueAdapters
+
+    class AmazonSqsAdapter
+
+      def enqueue(job)
+        _enqueue(job)
+      end
+
+      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)
+      end
+
+      private
+
+      def _enqueue(job, 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)
+        send_message_opts[:message_attributes] = message_attributes(job)
+        Aws::Rails::SqsActiveJob.config.client.send_message(send_message_opts)
+      end
+
+      def message_attributes(job)
+        {
+          'aws_sqs_active_job_class' => {
+            string_value: job.class.to_s,
+            data_type: 'String'
+          },
+          'aws_sqs_active_job_version' => {
+            string_value: Aws::Rails::VERSION,
+            data_type: 'String'
+          }
+        }
+      end
+    end
+
+    # create an alias to allow `:amazon` to be used as the adapter name
+    # `:amazon` is the convention used for ActionMailer and ActiveStorage
+    AmazonAdapter = AmazonSqsAdapter
+  end
+end

data/lib/active_job/queue_adapters/amazon_sqs_async_adapter.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-sqs'
+require 'concurrent'
+
+module ActiveJob
+  module QueueAdapters
+
+    # == Async adapter for Amazon SQS ActiveJob
+    #
+    # This adapter queues jobs asynchronously (ie non-blocking).  Error handler can be configured
+    # with +Aws::Rails::SqsActiveJob.config.async_queue_error_handler+.
+    #
+    # To use this adapter, set up as:
+    #
+    # config.active_job.queue_adapter = :amazon_sqs_async
+    class AmazonSqsAsyncAdapter < AmazonSqsAdapter
+
+      private
+
+      def _enqueue(job, send_message_opts = {})
+        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
+      end
+    end
+  end
+end

data/lib/aws-sdk-rails.rb

@@ -1,37 +1,21 @@
-require_relative 'aws/rails/mailer'
-
-module Aws
-  module Rails
+# frozen_string_literal: true
 
-    # @api private
-    class Railtie < ::Rails::Railtie
-      initializer "aws-sdk-rails.initialize", before: :load_config_initializers do |app|
-        # Initialization Actions
-        Aws::Rails.add_action_mailer_delivery_method
-        Aws::Rails.log_to_rails_logger
-      end
-    end
+require_relative 'aws/rails/mailer'
+require_relative 'aws/rails/railtie'
+require_relative 'aws/rails/notifications'
+require_relative 'aws/rails/sqs_active_job/configuration'
+require_relative 'aws/rails/sqs_active_job/executor'
+require_relative 'aws/rails/sqs_active_job/job_runner'
+require_relative 'aws/rails/sqs_active_job/lambda_handler'
 
-    # This is called automatically from the SDK's Railtie, but if you want to
-    # manually specify options for building the Aws::SES::Client object, you
-    # can manually call this method.
-    #
-    # @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 = :aws_sdk, options = {})
-      ActiveSupport.on_load(:action_mailer) do
-        self.add_delivery_method(name, Aws::Rails::Mailer, options)
-      end
-    end
+require_relative 'action_dispatch/session/dynamodb_store'
+require_relative 'active_job/queue_adapters/amazon_sqs_adapter'
+require_relative 'active_job/queue_adapters/amazon_sqs_async_adapter'
 
-    # Configures the AWS SDK for Ruby's logger to use the Rails logger.
-    def self.log_to_rails_logger
-      Aws.config[:logger] = ::Rails.logger
-      nil
-    end
+require_relative 'generators/aws_record/base'
 
+module Aws
+  module Rails
+    VERSION = File.read(File.expand_path('../VERSION', __dir__)).strip
   end
 end
-

data/lib/aws/rails/mailer.rb

@@ -1,23 +1,23 @@
+# frozen_string_literal: true
+
 require 'aws-sdk-ses'
 
 module Aws
   module Rails
-
     # Provides a delivery method for ActionMailer that uses Amazon Simple Email
     # Service.
-    # 
+    #
     # Once you have an SES 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 = :aws_sdk
+    #     config.action_mailer.delivery_method = :ses
     #
-    # Uses the AWS SDK for Ruby V2's credential provider chain when creating an
-    # SES client instance.
+    # Uses the AWS SDK for Ruby's credential provider chain when creating an SES
+    # client instance.
     class Mailer
-
       # @param [Hash] options Passes along initialization options to
-      #   [Aws::SES::Client.new](http://docs.aws.amazon.com/sdkforruby/api/Aws/SES/Client.html#initialize-instance_method).
+      #   [Aws::SES::Client.new](https://docs.aws.amazon.com/sdk-for-ruby/v3/api/Aws/SES/Client.html#initialize-instance_method).
       def initialize(options = {})
         @client = SES::Client.new(options)
       end
@@ -42,7 +42,6 @@ module Aws
       def settings
         {}
       end
-
     end
   end
 end

data/lib/aws/rails/notifications.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+require 'aws-sdk-core'
+require 'active_support/notifications'
+
+module Aws
+  module Rails
+
+    # Instruments client operation calls for ActiveSupport::Notifications
+    # Each client operation will produce an event with name:
+    # <operation>.<service>.aws
+    # @api private
+    class Notifications < Seahorse::Client::Plugin
+
+      def add_handlers(handlers, config)
+        # This plugin needs to be first
+        # which means it is called first in the stack, to start recording time,
+        # and returns last
+        handlers.add(Handler, step: :initialize, priority: 99)
+      end
+
+      class Handler < Seahorse::Client::Handler
+
+        def call(context)
+          event_name = "#{context.operation_name}.#{context.config.api.metadata['serviceId']}.aws"
+          ActiveSupport::Notifications.instrument(event_name, context: context) do
+            @handler.call(context)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/aws/rails/railtie.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Aws
+  # Use the Rails namespace.
+  module Rails
+    # @api private
+    class Railtie < ::Rails::Railtie
+      initializer 'aws-sdk-rails.initialize',
+                  before: :load_config_initializers do
+        # Initialization Actions
+        Aws::Rails.use_rails_encrypted_credentials
+        Aws::Rails.add_action_mailer_delivery_method
+        Aws::Rails.log_to_rails_logger
+      end
+
+      rake_tasks do
+        load 'tasks/dynamo_db/session_store.rake'
+        load 'tasks/aws_record/migrate.rake'
+      end
+    end
+
+    # This is called automatically from the SDK's Railtie, but can be manually
+    # called if you want to specify options for building the Aws::SES::Client.
+    #
+    # @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 = {})
+      ActiveSupport.on_load(:action_mailer) do
+        add_delivery_method(name, Aws::Rails::Mailer, options)
+      end
+    end
+
+    # Configures the AWS SDK for Ruby's logger to use the Rails logger.
+    def self.log_to_rails_logger
+      Aws.config[:logger] = ::Rails.logger
+      nil
+    end
+
+    # Configures the AWS SDK with credentials from Rails encrypted credentials.
+    def self.use_rails_encrypted_credentials
+      # limit the config keys we merge to credentials only
+      aws_credential_keys = %i[access_key_id secret_access_key session_token]
+
+      Aws.config.merge!(
+        ::Rails.application
+          .try(:credentials)
+          .try(:aws)
+          .to_h.slice(*aws_credential_keys)
+      )
+    end
+
+    # Adds ActiveSupport Notifications instrumentation to AWS SDK
+    # client operations.  Each operation will produce an event with a name:
+    # <operation>.<service>.aws.  For example, S3's put_object has an event
+    # name of: put_object.S3.aws
+    def self.instrument_sdk_operations
+      Aws.constants.each do |c|
+        m = Aws.const_get(c)
+        if m.is_a?(Module) && m.const_defined?(:Client) &&
+           m.const_get(:Client).superclass == Seahorse::Client::Base
+          m.const_get(:Client).add_plugin(Aws::Rails::Notifications)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Aws
+  module Rails
+    module SqsActiveJob
+
+      # @return [Configuration] the (singleton) Configuration
+      def self.config
+        @config ||= Configuration.new
+      end
+
+      # @yield Configuration
+      def self.configure
+        yield(config)
+      end
+
+      # Configuration for AWS SQS ActiveJob.
+      # Use +Aws::Rails::SqsActiveJob.config+ to access the singleton config instance.
+      class Configuration
+
+        # Default configuration options
+        # @api private
+        DEFAULTS = {
+          max_messages:  10,
+          visibility_timeout: 120,
+          shutdown_timeout: 15,
+          queues: {},
+          logger: ::Rails.logger
+        }
+
+        # @api private
+        attr_accessor :queues, :max_messages, :visibility_timeout,
+                      :shutdown_timeout, :client, :logger, :async_queue_error_handler
+
+        # Don't use this method directly: Confugration is a singleton class, use
+        # +Aws::Rails::SqsActiveJob.config+ to access the singleton config.
+        #
+        # @param [Hash] options
+        # @option options [Hash[Symbol, String]] :queues A mapping between the
+        #   active job queue name and the SQS Queue URL. Note: multiple active
+        #   job queues can map to the same SQS Queue URL.
+        #
+        # @option options  [Integer] :max_messages
+        #    The max number of messages to poll for in a batch.
+        #
+        # @option options [Integer] :visibility_timeout
+        #   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
+        #   to prevent other processes from picking up an running job.
+        #   See the (SQS Visibility Timeout Documentation)[https://docs.aws.amazon.com/AWSSimpleQueueService/latest/SQSDeveloperGuide/sqs-visibility-timeout.html]
+        #
+        # @option options [Integer] :shutdown_timeout
+        #   the amount of time to wait
+        #   for a clean shutdown.  Jobs that are unable to complete in this time
+        #   will not be deleted from the SQS queue and will be retryable after
+        #   the visibility timeout.
+        #
+        # @option options [ActiveSupport::Logger] :logger Logger to use
+        #   for the poller.
+        #
+        # @option options [String] :config_file
+        #   Override file to load configuration from.  If not specified will
+        #   attempt to load from config/aws_sqs_active_job.yml.
+        #
+        # @option options [Callable] :async_queue_error_handler An error handler
+        #   to be called when the async active job adapter experiances an error
+        #   queueing a job.  Only applies when
+        #   +active_job.queue_adapter = :amazon_sqs_async+.  Called with:
+        #   [error, job, job_options]
+        #
+        # @option options [SQS::Client] :client SQS Client to use.  A default
+        #   client will be created if none is provided.
+        def initialize(options = {})
+          options[:config_file] ||= config_file if config_file.exist?
+          options = DEFAULTS
+             .merge(file_options(options))
+             .merge(options)
+          set_attributes(options)
+        end
+
+        def client
+          @client ||= Aws::SQS::Client.new(user_agent_suffix: user_agent)
+        end
+
+        # Return the queue_url for a given job_queue name
+        def queue_url_for(job_queue)
+          job_queue = job_queue.to_sym
+          raise ArgumentError, "No queue defined for #{job_queue}" unless queues.key? job_queue
+
+          queues[job_queue.to_sym]
+        end
+
+        # @api private
+        def to_s
+          to_h.to_s
+        end
+
+        # @api private
+        def to_h
+          h = {}
+          self.instance_variables.each do |v|
+            v_sym = v.to_s.gsub('@', '').to_sym
+            val = self.instance_variable_get(v)
+            h[v_sym] = val
+          end
+          h
+        end
+
+        private
+
+        # Set accessible attributes after merged options.
+        def set_attributes(options)
+          options.keys.each do |opt_name|
+            instance_variable_set("@#{opt_name}", options[opt_name])
+          end
+        end
+
+        def file_options(options = {})
+          file_path = config_file_path(options)
+          if file_path
+            load_from_file(file_path)
+          else
+            {}
+          end
+        end
+
+        def config_file
+          file = ::Rails.root.join("config/aws_sqs_active_job/#{::Rails.env}.yml")
+          file = ::Rails.root.join('config/aws_sqs_active_job.yml') unless file.exist?
+          file
+        end
+
+        # Load options from YAML file
+        def load_from_file(file_path)
+          require "erb"
+          opts = YAML.load(ERB.new(File.read(file_path)).result) || {}
+          opts.deep_symbolize_keys
+        end
+
+        # @return [String] Configuration path found in environment or YAML file.
+        def config_file_path(options)
+          options[:config_file] || ENV["AWS_SQS_ACTIVE_JOB_CONFIG_FILE"]
+        end
+
+        def user_agent
+          "ft/aws-sdk-rails-activejob/#{Aws::Rails::VERSION}"
+        end
+      end
+    end
+  end
+end