aws-actiondispatch-dynamodb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fbf249640ad7b03a6ee1b2d8617224d845e34b9b4d59863fcc5f12aac4063ca6
+  data.tar.gz: 959dcfeb5068909a0ef6ea3df0c91231655cf3661938acb3ce2beec3e735f2ba
+SHA512:
+  metadata.gz: b86ef4c100aa1e1977044e7152ec8ba37103838e164301cb5835dbdbe05fa295aa6b51e289e884af8d3dd4a28869d4672e14cff8ba3194da845fda7817defeef
+  data.tar.gz: bccc2d67979b16ead29e8546412ca0ce10635e3953f00664a440c1b6ba825e467d7ba052e50bb56be7f41da6eeb1acedf90c764f761e9f5b01243eff11f8d268

data/CHANGELOG.md

@@ -0,0 +1,4 @@
+0.1.0 (2024-11-16)
+------------------
+
+* Feature - Initial version of this gem.

data/LICENSE

@@ -0,0 +1,175 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/action_dispatch/session/dynamo_db_store.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'action_dispatch/middleware/session/abstract_store'
+require 'aws-sessionstore-dynamodb'
+
+module ActionDispatch
+  module Session
+    # Uses the DynamoDB Session Store implementation to create a class that
+    # extends `ActionDispatch::Session`. Rails will create a `:dynamo_db_store`
+    # configuration for `:session_store` from this class name.
+    #
+    # This class will use `Rails.application.secret_key_base` as the secret key
+    # unless otherwise provided.
+    #
+    # Configuration can also be provided in YAML files from Rails config, either
+    # in `config/dynamo_db_session_store.yml` or `config/dynamo_db_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 < ActionDispatch::Session::AbstractStore
+      def initialize(app, options = {})
+        Rails.logger.warn('** Dynamo DB Session Storage no longer lives in aws-sdk-rails. ' \
+                          'To avoid disruption, please add aws-actiondispatch-dynamodb ~> 0 to your Gemfile to ' \
+                          'enable this feature when upgrading to aws-sdk-rails ~> 5. **')
+        options[:config_file] ||= config_file
+        options[:secret_key] ||= Rails.application.secret_key_base
+        @middleware = Aws::SessionStore::DynamoDB::RackMiddleware.new(app, options)
+        config.dynamo_db_client.config.user_agent_frameworks << 'aws-actiondispatch-dynamodb'
+        super
+      end
+
+      # @return [Aws::SessionStore::DynamoDB::Configuration]
+      def config
+        @middleware.config
+      end
+
+      private
+
+      # Required by `ActionDispatch::Session::AbstractStore`
+      def find_session(req, sid)
+        @middleware.find_session(req, sid)
+      end
+
+      # Required by `ActionDispatch::Session::AbstractStore`
+      def write_session(req, sid, session, options)
+        @middleware.write_session(req, sid, session, options)
+      end
+
+      # Required by `ActionDispatch::Session::AbstractStore`
+      def delete_session(req, sid, options)
+        @middleware.delete_session(req, sid, options)
+      end
+
+      # rubocop:disable Metrics
+      def config_file
+        file = ENV.fetch('AWS_DYNAMO_DB_SESSION_CONFIG_FILE', nil)
+        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)
+        if File.exist?(file)
+          Rails.logger.warn('The dynamo_db_session_store configuration file has been renamed.' \
+                            'Please use aws_dynamo_db_session_store/<Rails.env>.yml or ' \
+                            'aws_dynamo_db_session_store.yml. This will be removed in ' \
+                            'aws-actiondispatch-dynamodb ~> 1')
+        else
+          file = Rails.root.join("config/aws_dynamo_db_session_store/#{Rails.env}.yml")
+          file = Rails.root.join('config/aws_dynamo_db_session_store.yml') unless File.exist?(file)
+        end
+
+        file if File.exist?(file)
+      end
+    end
+    # rubocop:enable Metrics
+
+    # @api private
+    class DynamodbStore < DynamoDbStore
+      def initialize(app, options = {})
+        Rails.logger.warn('** Session Store :dynamodb_store configuration key has been renamed to :dynamo_db_store, ' \
+                          'please use the new key instead. The :dynamodb_store key name will be removed in ' \
+                          'aws-actiondispatch-dynamodb ~> 1 **')
+        super
+      end
+    end
+  end
+end

data/lib/aws-actiondispatch-dynamodb.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'action_dispatch/session/dynamo_db_store'
+
+module Aws
+  module ActionDispatch
+    module DynamoDb
+      VERSION = File.read(File.expand_path('../VERSION', __dir__)).strip
+
+      # @api private
+      class Railtie < ::Rails::Railtie
+        rake_tasks do
+          load 'tasks/dynamo_db/session_store.rake'
+        end
+      end
+    end
+  end
+end

data/lib/generators/dynamo_db/session_store_config/USAGE

@@ -0,0 +1,16 @@
+Description:
+    Generates a sample configuration file DynamoDB session store.
+
+Examples:
+    `rails generate dynamo_db:session_store_config`
+
+    This will create:
+        config/dynamo_db_session_store.yml
+
+    Optionally, you can specify the Rails environment to generate
+    the configuration file for:
+
+    `rails generate dynamo_db:session_store_config --environment=development`
+
+    This will create:
+        config/dynamo_db_session_store/development.yml

data/lib/generators/dynamo_db/session_store_config/session_store_config_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+# @api private
+module DynamoDb
+  module Generators
+    # Generates a config file for DynamoDB session storage.
+    class SessionStoreConfigGenerator < Rails::Generators::Base
+      source_root File.expand_path('templates', __dir__)
+
+      # Environment to generate the config file for
+      class_option :environment,
+                   desc: 'Optional rails environment to generate the config file for',
+                   type: :string,
+                   default: nil
+
+      def copy_sample_config_file
+        path = 'config/aws_dynamo_db_session_store'
+        path += "/#{options['environment']}" if options['environment']
+        template('aws_dynamo_db_session_store.yml', "#{path}.yml")
+      end
+    end
+  end
+end

data/lib/generators/dynamo_db/session_store_config/templates/aws_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] Session table name.
+#
+# table_name: Sessions
+
+# [String] Session table hash key name.
+#
+# table_key: session_id
+
+# [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
+
+# [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/USAGE

@@ -0,0 +1,17 @@
+Description:
+    Generates an ActiveRecord migration for deleting and a creating
+    a DynamoDB sessions table. The migration will be run when the
+    command `rake db:migrate` is run in the command line.
+
+Example:
+    `rails generate dynamo_db:session_store_migration`
+
+    This will create:
+        db/migrate/#{VERSION}_create_dynamo_db_sessions_table.rb
+
+    Optionally, you can specify the name of the migration:
+
+    `rails generate dynamo_db:session_store_migration MIGRATION_NAME`
+
+    This will create:
+        db/migrate/#{VERSION}_<MIGRATION_NAME>.rb

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+# @api private
+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 the migration class
+      argument :name,
+               desc: 'Optional name of the migration class',
+               type: :string,
+               default: 'create_dynamo_db_sessions_table'
+
+      def generate_migration_file
+        migration_template(
+          'session_store_migration.erb',
+          "db/migrate/#{name.underscore}.rb"
+        )
+      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
+
+      def migration_version
+        "#{Rails::VERSION::MAJOR}.#{Rails::VERSION::MINOR}"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+class <%= name.camelize %> < ActiveRecord::Migration[<%= migration_version %>]
+  def up
+    options = Rails.application.config.session_options
+    Aws::SessionStore::DynamoDB::Table.create_table(options)
+  end
+
+  def down
+    options = Rails.application.config.session_options
+    Aws::SessionStore::DynamoDB::Table.delete_table(options)
+  end
+end

data/lib/tasks/dynamo_db/session_store.rake

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+namespace 'dynamo_db' do
+  namespace 'session_store' do
+    desc 'Create the Amazon DynamoDB session store table'
+    task create_table: :environment do
+      options = Rails.application.config.session_options
+      Aws::SessionStore::DynamoDB::Table.create_table(options)
+    end
+
+    desc 'Delete the Amazon DynamoDB session store table'
+    task delete_table: :environment do
+      options = Rails.application.config.session_options
+      Aws::SessionStore::DynamoDB::Table.delete_table(options)
+    end
+
+    desc 'Clean up old sessions in the Amazon DynamoDB session store table'
+    task clean: :environment do
+      options = Rails.application.config.session_options
+      Aws::SessionStore::DynamoDB::GarbageCollection.collect_garbage(options)
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: aws-actiondispatch-dynamodb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Amazon Web Services
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-11-16 00:00:00.000000000 Z
+dependencies:
+- !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: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 7.1.0
+description: Amazon Dynamo DB as an ActionDispatch session store
+email:
+- aws-dr-rubygems@amazon.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- VERSION
+- lib/action_dispatch/session/dynamo_db_store.rb
+- lib/aws-actiondispatch-dynamodb.rb
+- lib/generators/dynamo_db/session_store_config/USAGE
+- lib/generators/dynamo_db/session_store_config/session_store_config_generator.rb
+- lib/generators/dynamo_db/session_store_config/templates/aws_dynamo_db_session_store.yml
+- 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/session_store_migration.erb
+- lib/tasks/dynamo_db/session_store.rake
+homepage: https://github.com/aws/aws-actiondispatch-dynamodb-ruby
+licenses:
+- Apache-2.0
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: ActionDispatch integration with DynamoDB
+test_files: []