Initial commit of aws-actiondispatch-dynamodb

Author: mullermp

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,6 @@
+*Issue #, if available:*
+
+*Description of changes:*
+
+By submitting this pull request, I confirm that my contribution is made under
+the terms of the Apache 2.0 license.

.github/workflows/ci.yml

@@ -0,0 +1,85 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+env:
+  ruby_version: 3.3
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.7, '3.0', 3.1, 3.2, 3.3, jruby-9.4]
+        rails: [7.1, 7.2, '8.0', main]
+
+        exclude:
+          # Rails 7.2 is Ruby >= 3.1
+          - rails: 7.2
+            ruby: 2.7
+          - rails: 7.2
+            ruby: 3.0
+          # Rails 8.0 is Ruby >= 3.2
+          - rails: '8.0'
+            ruby: 2.7
+          - rails: '8.0'
+            ruby: 3.0
+          - rails: '8.0'
+            ruby: 3.1
+          - rails: '8.0'
+            ruby: jruby-9.4
+          # Rails main is Ruby >= 3.2
+          - rails: main
+            ruby: 2.7
+          - rails: main
+            ruby: 3.0
+          - rails: main
+            ruby: 3.1
+          - rails: main
+            ruby: jruby-9.4
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Install gems
+        run: bundle install
+        env:
+          BUNDLE_GEMFILE: gemfiles/rails-${{ matrix.rails }}.gemfile
+
+      - name: Test
+        run: bundle exec rake spec
+        env:
+          BUNDLE_GEMFILE: gemfiles/rails-${{ matrix.rails }}.gemfile
+
+  rubocop:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ env.ruby_version }}
+
+      - name: Install gems
+        run: |
+          bundle config set --local with 'development'
+          bundle install
+
+      - name: Rubocop
+        run: bundle exec rake rubocop

.gitignore

@@ -0,0 +1,6 @@
+.idea/
+Gemfile.lock
+gemfiles/*.gemfile.lock
+
+test/dummy/db/migrate
+test/dummy/log/

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "tasks/release"]
+	path = tasks/release
+	url = https://github.com/aws/aws-sdk-ruby-release-tools

.rubocop.yml

@@ -0,0 +1,20 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.7
+  SuggestExtensions: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*.rb'
+
+Naming/FileName:
+  Exclude:
+    - 'gemfiles/*.gemfile'
+    - 'lib/aws-actiondispatch-dynamodb.rb'
+
+Style/BlockComments:
+  Exclude:
+    - 'spec/spec_helper.rb'

CHANGELOG.md

@@ -0,0 +1,4 @@
+Unreleased Changes
+------------------
+
+* Feature - Initial version of this gem.

Gemfile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', require: false
+
+group :development do
+  gem 'byebug', platforms: :ruby
+  gem 'rubocop'
+end
+
+group :test do
+  gem 'minitest-spec-rails'
+end
+
+group :docs do
+  gem 'yard'
+  gem 'yard-sitemap', '~> 1.0'
+end
+
+group :release do
+  gem 'octokit'
+end

Rakefile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Dir.glob('tasks/**/*.rake').each do |task_file|
+  load task_file
+end
+
+RuboCop::RakeTask.new
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.warning = false
+end
+
+task 'release:test' => :test

VERSION

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

aws-actiondispatch-dynamodb.gemspec

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+version = File.read(File.expand_path('VERSION', __dir__)).strip
+
+Gem::Specification.new do |spec|
+  spec.name         = 'aws-actiondispatch-dynamodb'
+  spec.version      = version
+  spec.author       = 'Amazon Web Services'
+  spec.email        = ['[email protected]']
+  spec.summary      = 'ActionDispatch integration with DynamoDB'
+  spec.description  = 'Amazon Dynamo DB as an ActionDispatch session store'
+  spec.homepage     = 'https://github.com/aws/aws-actiondispatch-dynamodb-ruby'
+  spec.license      = 'Apache-2.0'
+  spec.files        = Dir['LICENSE', 'CHANGELOG.md', 'VERSION', 'lib/**/*']
+
+  spec.add_dependency('actionpack', '>= 7.1.0')
+  spec.add_dependency('aws-sessionstore-dynamodb', '~> 3')
+
+  spec.required_ruby_version = '>= 2.7'
+end

gemfiles/rails-7.1.gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+eval_gemfile '../Gemfile'
+
+gem 'rails', '~> 7.1.0'

gemfiles/rails-7.2.gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+eval_gemfile '../Gemfile'
+
+gem 'rails', '~> 7.2.0'

gemfiles/rails-8.0.gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+eval_gemfile '../Gemfile'
+
+gem 'rails', '~> 8.0.0'

gemfiles/rails-main.gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+eval_gemfile '../Gemfile'
+
+gem 'rails', github: 'rails/rails'

lib/action_dispatch/session/dynamo_db_store.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require 'action_dispatch/middleware/session/abstract_store'
+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 `: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
+
+      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
+
+    # @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

lib/aws-actiondispatch-dynamodb.rb

@@ -0,0 +1,11 @@
+# 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
+    end
+  end
+end

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

lib/generators/dynamo_db/session_store_config/session_store_config_generator.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+
+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