aws-sessionstore-dynamodb 2.2.0 → 3.0.0

data/lib/aws/session_store/dynamo_db/rack_middleware.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rack/session/abstract/id'
 require 'openssl'
 require 'aws-sdk-dynamodb'
@@ -6,55 +8,29 @@ module Aws::SessionStore::DynamoDB
   # This class is an ID based Session Store Rack Middleware
   # that uses a DynamoDB backend for session storage.
   class RackMiddleware < Rack::Session::Abstract::Persisted
-    # @return [Configuration] An instance of Configuration that is used for
-    #   this middleware.
-    attr_reader :config
-
     # Initializes SessionStore middleware.
     #
     # @param app Rack application.
     # @option (see Configuration#initialize)
-    # @raise [Aws::DynamoDB::Errors::ResourceNotFoundException] If valid table
-    #   name is not provided.
-    # @raise [Aws::SessionStore::DynamoDB::MissingSecretKey] If secret key is
-    #   not provided.
+    # @raise [Aws::DynamoDB::Errors::ResourceNotFoundException] If a valid table name is not provided.
+    # @raise [Aws::SessionStore::DynamoDB::MissingSecretKey] If a secret key is not provided.
     def initialize(app, options = {})
       super
       @config = Configuration.new(options)
+      validate_config
       set_locking_strategy
     end
 
-    private
-
-    # Sets locking strategy for session handler
-    #
-    # @return [Locking::Null] If locking is not enabled.
-    # @return [Locking::Pessimistic] If locking is enabled.
-    def set_locking_strategy
-      if @config.enable_locking
-        @lock = Aws::SessionStore::DynamoDB::Locking::Pessimistic.new(@config)
-      else
-        @lock = Aws::SessionStore::DynamoDB::Locking::Null.new(@config)
-      end
-    end
-
-    # Determines if the correct session table name is being used for
-    # this application. Also tests existence of secret key.
+    # Get session from the database or create a new session.
     #
-    # @raise [Aws::DynamoDB::Errors::ResourceNotFoundException] If wrong table
-    #   name.
-    def validate_config
-      raise MissingSecretKeyError unless @config.secret_key
-    end
-
-    # Gets session data.
+    # @raise [Aws::SessionStore::DynamoDB::Errors::LockWaitTimeoutError] If the session
+    #   has waited too long to obtain lock.
     def find_session(req, sid)
-      validate_config
       case verify_hmac(sid)
       when nil
         set_new_session_properties(req.env)
       when false
-        handle_error { raise InvalidIDError }
+        handle_error { raise Errors::InvalidIDError }
         set_new_session_properties(req.env)
       else
         data = @lock.get_session_data(req.env, sid)
@@ -62,11 +38,6 @@ module Aws::SessionStore::DynamoDB
       end
     end
 
-    def set_new_session_properties(env)
-      env['dynamo_db.new_session'] = 'true'
-      [generate_sid, {}]
-    end
-
     # Sets the session in the database after packing data.
     #
     # @return [Hash] If session has been saved.
@@ -83,27 +54,50 @@ module Aws::SessionStore::DynamoDB
       generate_sid unless options[:drop]
     end
 
+    # @return [Configuration] An instance of Configuration that is used for
+    #   this middleware.
+    attr_reader :config
+
+    private
+
+    def set_locking_strategy
+      @lock =
+        if @config.enable_locking
+          Aws::SessionStore::DynamoDB::Locking::Pessimistic.new(@config)
+        else
+          Aws::SessionStore::DynamoDB::Locking::Null.new(@config)
+        end
+    end
+
+    def validate_config
+      raise Errors::MissingSecretKeyError unless @config.secret_key
+    end
+
+    # Sets new session properties.
+    def set_new_session_properties(env)
+      env['dynamo_db.new_session'] = 'true'
+      [generate_sid, {}]
+    end
+
     # Each database operation is placed in this rescue wrapper.
     # This wrapper will call the method, rescue any exceptions and then pass
     # exceptions to the configured session handler.
-    def handle_error(env = nil, &block)
-      begin
-        yield
-      rescue Aws::DynamoDB::Errors::Base,
-             Aws::SessionStore::DynamoDB::InvalidIDError => e
-        @config.error_handler.handle_error(e, env)
-      end
+    def handle_error(env = nil)
+      yield
+    rescue Aws::DynamoDB::Errors::Base,
+           Aws::SessionStore::DynamoDB::Errors::InvalidIDError => e
+      @config.error_handler.handle_error(e, env)
     end
 
     # Generate HMAC hash based on MD5
     def generate_hmac(sid, secret)
-      OpenSSL::HMAC.hexdigest(OpenSSL::Digest::MD5.new, secret, sid).strip()
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest.new('MD5'), secret, sid).strip
     end
 
     # Generate sid with HMAC hash
     def generate_sid(secure = @sid_secure)
-      sid = super(secure)
-      sid = "#{generate_hmac(sid, @config.secret_key)}--" + sid
+      sid = super
+      "#{generate_hmac(sid, @config.secret_key)}--" + sid
     end
 
     # Verify digest of HMACed hash
@@ -112,8 +106,10 @@ module Aws::SessionStore::DynamoDB
     # @return [false] If the HMAC id has been corrupted.
     def verify_hmac(sid)
       return unless sid
-      digest, ver_sid  = sid.split("--")
+
+      digest, ver_sid = sid.split('--')
       return false unless ver_sid
+
       digest == generate_hmac(ver_sid, @config.secret_key)
     end
   end

data/lib/aws/session_store/dynamo_db/table.rb

@@ -1,85 +1,82 @@
+# frozen_string_literal: true
+
 require 'aws-sdk-dynamodb'
 require 'logger'
 
 module Aws::SessionStore::DynamoDB
-  # This class provides a way to create and delete a session table.
+  # This module provides a way to create and delete a session table.
   module Table
-    module_function
-
-    # Creates a session table.
-    # @option (see Configuration#initialize)
-    def create_table(options = {})
-      config = load_config(options)
-      ddb_options = properties(config.table_name, config.table_key).merge(
-          throughput(config.read_capacity, config.write_capacity)
-        )
-      config.dynamo_db_client.create_table(ddb_options)
-      logger << "Table #{config.table_name} created, waiting for activation...\n"
-      block_until_created(config)
-      logger << "Table #{config.table_name} is now ready to use.\n"
-    rescue Aws::DynamoDB::Errors::ResourceInUseException
-      logger << "Table #{config.table_name} already exists, skipping creation.\n"
-    end
+    class << self
+      # Creates a session table.
+      # @option (see Configuration#initialize)
+      def create_table(options = {})
+        config = load_config(options)
+        config.dynamo_db_client.create_table(create_opts(config))
+        logger.info "Table #{config.table_name} created, waiting for activation..."
+        config.dynamo_db_client.wait_until(:table_exists, table_name: config.table_name)
+        logger.info "Table #{config.table_name} is now ready to use."
+      rescue Aws::DynamoDB::Errors::ResourceInUseException
+        logger.warn "Table #{config.table_name} already exists, skipping creation."
+      end
 
-    # Deletes a session table.
-    # @option (see Configuration#initialize)
-    def delete_table(options = {})
-      config = load_config(options)
-      config.dynamo_db_client.delete_table(:table_name => config.table_name)
-    end
+      # Deletes a session table.
+      # @option (see Configuration#initialize)
+      def delete_table(options = {})
+        config = load_config(options)
+        config.dynamo_db_client.delete_table(table_name: config.table_name)
+        config.dynamo_db_client.wait_until(:table_not_exists, table_name: config.table_name)
+        logger.info "Table #{config.table_name} deleted."
+      end
 
-    # @api private
-    def logger
-      @logger ||= Logger.new($STDOUT)
-    end
+      private
 
-    # Loads configuration options.
-    # @option (see Configuration#initialize)
-    # @api private
-    def load_config(options = {})
-      Aws::SessionStore::DynamoDB::Configuration.new(options)
-    end
+      def logger
+        @logger ||= Logger.new($stdout)
+      end
 
-    # @return [Hash] Attribute settings for creating a session table.
-    # @api private
-    def attributes(hash_key)
-      attributes = [{:attribute_name => hash_key, :attribute_type => 'S'}]
-      { :attribute_definitions => attributes }
-    end
+      # Loads configuration options.
+      # @option (see Configuration#initialize)
+      def load_config(options = {})
+        Aws::SessionStore::DynamoDB::Configuration.new(options)
+      end
 
-    # @return Shema values for session table
-    # @api private
-    def schema(table_name, hash_key)
-      {
-        :table_name => table_name,
-        :key_schema => [ {:attribute_name => hash_key, :key_type => 'HASH'} ]
-      }
-    end
+      def create_opts(config)
+        properties(config.table_name, config.table_key).merge(
+          throughput(config.read_capacity, config.write_capacity)
+        )
+      end
 
-    # @return Throughput for Session table
-    # @api private
-    def throughput(read, write)
-      units = {:read_capacity_units=> read, :write_capacity_units => write}
-      { :provisioned_throughput => units }
-    end
+      # @return Properties for the session table.
+      def properties(table_name, hash_key)
+        attributes(hash_key).merge(schema(table_name, hash_key))
+      end
 
-    # @return Properties for Session table
-    # @api private
-    def properties(table_name, hash_key)
-      attributes(hash_key).merge(schema(table_name, hash_key))
-    end
+      # @return [Hash] Attribute settings for creating the session table.
+      def attributes(hash_key)
+        {
+          attribute_definitions: [
+            { attribute_name: hash_key, attribute_type: 'S' }
+          ]
+        }
+      end
 
-    # @api private
-    def block_until_created(config)
-      created = false
-      until created
-        params = { :table_name => config.table_name }
-        response = config.dynamo_db_client.describe_table(params)
-        created = response[:table][:table_status] == 'ACTIVE'
+      # @return Schema values for the session table.
+      def schema(table_name, hash_key)
+        {
+          table_name: table_name,
+          key_schema: [{ attribute_name: hash_key, key_type: 'HASH' }]
+        }
+      end
 
-        sleep 10
+      # @return Throughput for the session table.
+      def throughput(read, write)
+        {
+          provisioned_throughput: {
+            read_capacity_units: read,
+            write_capacity_units: write
+          }
+        }
       end
     end
-
   end
 end

data/lib/aws-sessionstore-dynamodb.rb

@@ -1,19 +1,19 @@
+# frozen_string_literal: true
+
 module Aws
   module SessionStore
-    module DynamoDB; end
+    # Namespace for DynamoDB rack session storage.
+    module DynamoDB
+      VERSION = File.read(File.expand_path('../VERSION', __dir__)).strip
+    end
   end
 end
 
-require 'aws/session_store/dynamo_db/configuration'
-require 'aws/session_store/dynamo_db/invalid_id_error'
-require 'aws/session_store/dynamo_db/missing_secret_key_error'
-require 'aws/session_store/dynamo_db/lock_wait_timeout_error'
-require 'aws/session_store/dynamo_db/errors/base_handler'
-require 'aws/session_store/dynamo_db/errors/default_handler'
-require 'aws/session_store/dynamo_db/garbage_collection'
-require 'aws/session_store/dynamo_db/locking/base'
-require 'aws/session_store/dynamo_db/locking/null'
-require 'aws/session_store/dynamo_db/locking/pessimistic'
-require 'aws/session_store/dynamo_db/rack_middleware'
-require 'aws/session_store/dynamo_db/table'
-require 'aws/session_store/dynamo_db/version'
+require_relative 'aws/session_store/dynamo_db/configuration'
+require_relative 'aws/session_store/dynamo_db/errors'
+require_relative 'aws/session_store/dynamo_db/garbage_collection'
+require_relative 'aws/session_store/dynamo_db/locking/base'
+require_relative 'aws/session_store/dynamo_db/locking/null'
+require_relative 'aws/session_store/dynamo_db/locking/pessimistic'
+require_relative 'aws/session_store/dynamo_db/rack_middleware'
+require_relative 'aws/session_store/dynamo_db/table'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sessionstore-dynamodb
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 3.0.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-25 00:00:00.000000000 Z
+date: 2024-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -34,42 +34,30 @@ dependencies:
   name: rack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '2'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rack-session
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '1'
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '3'
+        version: '2'
 description:
 email:
 - aws-dr-rubygems@amazon.com
@@ -77,48 +65,23 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/PULL_REQUEST_TEMPLATE.md"
-- ".github/workflows/ci.yml"
-- ".gitignore"
-- ".gitmodules"
-- ".yardopts"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- CONTRIBUTING.md
-- Gemfile
-- LICENSE
-- README.md
-- Rakefile
+- LICENSE.txt
 - VERSION
-- aws-sessionstore-dynamodb.gemspec
-- doc-src/templates/default/layout/html/footer.erb
-- doc-src/templates/default/layout/html/layout.erb
 - lib/aws-sessionstore-dynamodb.rb
 - lib/aws/session_store/dynamo_db/configuration.rb
+- lib/aws/session_store/dynamo_db/errors.rb
 - lib/aws/session_store/dynamo_db/errors/base_handler.rb
 - lib/aws/session_store/dynamo_db/errors/default_handler.rb
 - lib/aws/session_store/dynamo_db/garbage_collection.rb
-- lib/aws/session_store/dynamo_db/invalid_id_error.rb
-- lib/aws/session_store/dynamo_db/lock_wait_timeout_error.rb
 - lib/aws/session_store/dynamo_db/locking/base.rb
 - lib/aws/session_store/dynamo_db/locking/null.rb
 - lib/aws/session_store/dynamo_db/locking/pessimistic.rb
-- lib/aws/session_store/dynamo_db/missing_secret_key_error.rb
 - lib/aws/session_store/dynamo_db/rack_middleware.rb
 - lib/aws/session_store/dynamo_db/table.rb
-- lib/aws/session_store/dynamo_db/version.rb
-- spec/aws/session_store/dynamo_db/app_config.yml
-- spec/aws/session_store/dynamo_db/configuration_spec.rb
-- spec/aws/session_store/dynamo_db/error/default_error_handler_spec.rb
-- spec/aws/session_store/dynamo_db/garbage_collection_spec.rb
-- spec/aws/session_store/dynamo_db/locking/threaded_sessions_spec.rb
-- spec/aws/session_store/dynamo_db/rack_middleware_database_spec.rb
-- spec/aws/session_store/dynamo_db/rack_middleware_spec.rb
-- spec/aws/session_store/dynamo_db/table_spec.rb
-- spec/spec_helper.rb
-homepage: http://github.com/aws/aws-sessionstore-dynamodb-ruby
+homepage: https://github.com/aws/aws-sessionstore-dynamodb-ruby
 licenses:
-- Apache License 2.0
+- Apache-2.0
 metadata: {}
 post_install_message:
 rdoc_options: []
@@ -128,25 +91,16 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.5
+rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: The Amazon DynamoDB Session Store handles sessions for Ruby web applications
+summary: The Amazon DynamoDB Session Store handles sessions for Rack web applications
   using a DynamoDB backend.
-test_files:
-- spec/aws/session_store/dynamo_db/app_config.yml
-- spec/aws/session_store/dynamo_db/configuration_spec.rb
-- spec/aws/session_store/dynamo_db/error/default_error_handler_spec.rb
-- spec/aws/session_store/dynamo_db/garbage_collection_spec.rb
-- spec/aws/session_store/dynamo_db/locking/threaded_sessions_spec.rb
-- spec/aws/session_store/dynamo_db/rack_middleware_database_spec.rb
-- spec/aws/session_store/dynamo_db/rack_middleware_spec.rb
-- spec/aws/session_store/dynamo_db/table_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +0,0 @@
-*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.

data/.github/workflows/ci.yml

@@ -1,39 +0,0 @@
-name: CI
-
-on:
-  push:
-    branches:
-      - main
-
-  pull_request:
-    branches:
-      - main
-
-jobs:
-  test:
-    runs-on: ubuntu-latest
-    strategy:
-      fail-fast: false
-      matrix:
-        ruby: [2.5, 2.6, 2.7, '3.0', 3.1, 3.2, 3.3, jruby-9.2, jruby-9.3, jruby-9.4]
-        env: [RACK2, RACK3]
-
-    steps:
-      - name: Setup Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{ matrix.ruby }}
-
-      - uses: actions/checkout@v4
-
-      - name: Setup environment
-        run: |
-          echo "${{ matrix.env }}=1" >> $GITHUB_ENV
-
-      - name: Install gems
-        run: |
-          bundle config set --local without 'docs'
-          bundle install
-
-      - name: Tests
-        run: bundle exec rake spec

data/.gitignore

@@ -1,12 +0,0 @@
-.DS_Store
-
-/.byebug_history
-/.bundle
-/.yardoc
-/doc
-/Gemfile.lock
-/coverage
-*.gem
-/.release
-
-.idea/

data/.gitmodules

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

data/.yardopts

@@ -1,4 +0,0 @@
---title 'AWS DynamoDB Session Store'
---template-path doc-src/templates
---hide-api private
---plugin sitemap

data/CODE_OF_CONDUCT.md

@@ -1,4 +0,0 @@
-## Code of Conduct
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 
-opensource-codeofconduct@amazon.com with any additional questions or comments.

data/CONTRIBUTING.md

@@ -1,61 +0,0 @@
-# Contributing Guidelines
-
-Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional 
-documentation, we greatly value feedback and contributions from our community.
-
-Please read through this document before submitting any issues or pull requests to ensure we have all the necessary 
-information to effectively respond to your bug report or contribution.
-
-
-## Reporting Bugs/Feature Requests
-
-We welcome you to use the GitHub issue tracker to report bugs or suggest features.
-
-When filing an issue, please check [existing open](https://github.com/aws/aws-sessionstore-dynamodb-ruby/issues), or [recently closed](https://github.com/aws/aws-sessionstore-dynamodb-ruby/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already 
-reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
-
-* A reproducible test case or series of steps
-* The version of our code being used
-* Any modifications you've made relevant to the bug
-* Anything unusual about your environment or deployment
-
-
-## Contributing via Pull Requests
-Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
-
-1. You are working against the latest source on the *master* branch.
-2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
-3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
-
-To send us a pull request, please:
-
-1. Fork the repository.
-2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
-3. Ensure local tests pass.
-4. Commit to your fork using clear commit messages.
-5. Send us a pull request, answering any default questions in the pull request interface.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
-
-GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and 
-[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
-
-
-## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels ((enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/aws-sessionstore-dynamodb-ruby/labels/help%20wanted) issues is a great place to start. 
-
-
-## Code of Conduct
-This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). 
-For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact 
-opensource-codeofconduct@amazon.com with any additional questions or comments.
-
-
-## Security issue notifications
-If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
-
-
-## Licensing
-
-See the [LICENSE](https://github.com/aws/aws-sessionstore-dynamodb-ruby/blob/master/LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
-
-We may ask you to sign a [Contributor License Agreement (CLA)](http://en.wikipedia.org/wiki/Contributor_License_Agreement) for larger changes.

data/Gemfile

@@ -1,24 +0,0 @@
-source 'https://rubygems.org'
-
-if ENV['RACK2']
-  gem 'rack', '~> 2'
-end
-
-gemspec
-
-gem 'rake', require: false
-
-group :docs do
-  gem 'yard'
-  gem 'yard-sitemap', '~> 1.0'
-end
-
-group :test do
-  gem 'rspec'
-  gem 'rack-test'
-  gem 'simplecov'
-
-  if RUBY_VERSION >= '3.0'
-    gem 'rexml'
-  end
-end

data/LICENSE

@@ -1,12 +0,0 @@
-Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
-
-Licensed under the Apache License, Version 2.0 (the "License"). You
-may not use this file except in compliance with the License. A copy of
-the License is located at
-
-    http://aws.amazon.com/apache2.0/
-
-or in the "license" file accompanying this file. This file is
-distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
-ANY KIND, either express or implied. See the License for the specific
-language governing permissions and limitations under the License.