aws-sdk-rails 3.1.0 → 3.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c6f3ca6246615704132c2a690056d8c8636fd40947f756e79318affd6148720
-  data.tar.gz: e17f171dba5c857c58358a6e35d962b398ada43439c78c8e0df496ed342dd1ef
+  metadata.gz: b16c1ca75c59341fdc3696d91648fda6901937f31b5b4c55b5d1ccf3bcc9af47
+  data.tar.gz: 9c9c22d4740ea76b06fa7ee6b8d525450fc982e3c73db0fe81234356dbd71a86
 SHA512:
-  metadata.gz: 61effb18895b3c4de7aa1cb8e44de99f5c497ac0ff996e5d74ae99af1b363dc634bb753e2c2160d437ede22988cdcb145b6683989864ee42b4cc029487649a0c
-  data.tar.gz: 3b7ebe7488bd432776e1c594dc0325b7d75a964276d7e5af1ab05bbb66f3139de581ccc8c77730d97d69b8b39d5ab0312cb9e5f1fb719b9c5da5f0ce9dde1c5b
+  metadata.gz: 2ef9e3bf5bde8d91b25635e2bed4028a163547f6e8eabb3ece2e08d1482e6edce16386a916240f344dcce27bc8efec3c5c424236fed6f150e4a6912165648914
+  data.tar.gz: 0052b3633ce5fc655f4b6fdd80851049196e1c7c7a7d6cc92e17d52fc6fcc8ae69712bc411d3f0feb369dfd835e23912c67802ff32abe3654cf3b4feee87c02a

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/aws-sdk-rails.rb

@@ -1,51 +1,7 @@
 # frozen_string_literal: true
 
 require_relative 'aws/rails/mailer'
+require_relative 'aws/rails/railtie'
+require_relative 'aws/rails/notifications'
 
-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
-    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
-  end
-end
+require_relative 'action_dispatch/session/dynamodb_store'

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,67 @@
+# 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'
+      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/generators/dynamo_db/session_store_migration/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Generates a migration file for deleting and a creating a DynamoDB
+    sessions table, and a configuration file for the session store.
+
+Example:
+    rails generate dynamo_db:session_store_migration <MIGRATION_NAME>
+
+    This will create:
+        db/migrate/#{VERSION}_#{MIGRATION_NAME}.rb
+        config/dynamo_db_session_store.yml
+
+    The migration will be run when the command rake db:migrate is run
+    in the command line.

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

@@ -0,0 +1,46 @@
+require 'rails/generators/named_base'
+
+# This class generates a migration file for deleting and creating
+# a DynamoDB sessions table.
+module DynamoDb
+  module Generators
+    # Generates an ActiveRecord migration that creates and deletes a DynamoDB
+    # Session table.
+    class SessionStoreMigrationGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('templates', __dir__)
+
+      # Desired name of migration class
+      argument :name, type: :string, default: 'create_dynamo_db_sessions_table'
+
+      # @return [Rails Migration File] migration file for creation and deletion
+      #   of a DynamoDB session table.
+      def generate_migration_file
+        migration_template(
+          'session_store_migration.rb',
+          "db/migrate/#{name.underscore}.rb"
+        )
+      end
+
+      def copy_sample_config_file
+        template(
+          'dynamo_db_session_store.yml',
+          'config/dynamo_db_session_store.yml'
+        )
+      end
+
+      # Next migration number - must be implemented
+      def self.next_migration_number(_dir = nil)
+        Time.now.utc.strftime('%Y%m%d%H%M%S')
+      end
+
+      private
+
+      # @return [String] activerecord migration version
+      def migration_version
+        "#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}"
+      end
+    end
+  end
+end

data/lib/generators/dynamo_db/session_store_migration/templates/dynamo_db_session_store.yml

@@ -0,0 +1,70 @@
+# Uncomment and manipulate the key value pairs below
+# in order to configure the DynamoDB Session Store Application.
+
+# [String] The secret key for HMAC encryption. This defaults to
+# `Rails.application.secret_key_base`. You can use a different key if desired.
+#
+# secret_key: SECRET_KEY
+
+# [String] Session table name.
+#
+# table_name: Sessions
+
+# [String] Session table hash key name.
+#
+# table_key: session_id
+
+# [Boolean] Define as true or false depending on if you want a strongly
+# consistent read.
+# See AWS DynamoDB documentation for table consistent_read for more
+# information on this setting.
+#
+# consistent_read: true
+
+# [Integer] Maximum number of reads consumed per second before
+# DynamoDB returns a ThrottlingException. See AWS DynamoDB documentation
+# or table read_capacity for more information on this setting.
+#
+# read_capacity: 10
+
+# [Integer] Maximum number of writes consumed per second before
+# DynamoDB returns a ThrottlingException. See AWS DynamoDB documentation
+# or table write_capacity for more information on this setting.
+#
+# write_capacity: 5
+
+# [Boolean] Define as true or false depending on whether you want all errors to be
+# raised up the stack.
+#
+# raise_errors: false
+
+# [Integer] Maximum number of seconds earlier
+# from the current time that a session was created.
+# By default this is 7 days.
+#
+# max_age: 604800
+
+# [Integer] Maximum number of seconds
+# before the current time that the session was last accessed.
+# By default this is 5 hours.
+#
+# max_stale: 18000
+
+# [Boolean] Define as true or false for whether you want to enable locking
+# for all accesses to session data.
+#
+# enable_locking: false
+
+# [Integer] Time in milleseconds after which lock will expire.
+#
+# lock_expiry_time: 500
+
+# [Integer] Time in milleseconds to wait before retrying to obtain
+# lock once an attempt to obtain lock has been made and has failed.
+#
+# lock_retry_delay: 500
+
+# [Integer] Maximum time in seconds to wait to acquire lock
+# before giving up.
+#
+# lock_max_wait_time: 1

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

@@ -0,0 +1,9 @@
+class <%= name.camelize %> < ActiveRecord::Migration[<%= migration_version %>]
+  def up
+    Aws::SessionStore::DynamoDB::Table.create_table
+  end
+
+  def down
+    Aws::SessionStore::DynamoDB::Table.delete_table
+  end
+end

data/lib/tasks/dynamo_db/session_store.rake

@@ -0,0 +1,8 @@
+namespace 'dynamo_db' do
+  namespace 'session_store' do
+    desc 'Clean up old sessions in the Amazon DynamoDB session store table.'
+    task clean: :environment do
+      Aws::SessionStore::DynamoDB::GarbageCollection.collect_garbage
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-rails
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.1
 platform: ruby
 authors:
 - Amazon Web Services
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-04-06 00:00:00.000000000 Z
+date: 2020-11-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ses
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: aws-sessionstore-dynamodb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: railties
   requirement: !ruby/object:Gem::Requirement
@@ -54,19 +68,27 @@ dependencies:
         version: '0'
 description: Integrates the AWS Ruby SDK with Ruby on Rails
 email:
-- chejingy@amazon.com
 - mamuller@amazon.com
+- alexwoo@amazon.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/action_dispatch/session/dynamodb_store.rb
 - lib/aws-sdk-rails.rb
 - lib/aws/rails/mailer.rb
+- lib/aws/rails/notifications.rb
+- lib/aws/rails/railtie.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/tasks/dynamo_db/session_store.rake
 homepage: https://github.com/aws/aws-sdk-rails
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -82,7 +104,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: AWS SDK for Ruby on Rails Plugin
 test_files: []