aws-sessionstore-dynamodb 2.0.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e17edceb1591e5e714e577d518f8c1f5f9b0b0a9c4edc6e8fbd7b275f63d33d5
-  data.tar.gz: 78cdaebe833c199b3d11a4fa0259d53fb5f770027808c55b8b96fbdece0a8401
+  metadata.gz: 567a54a1d54a1c4e00d6c85e98636320e6b1dcdddadf7acbeb1240244a32555e
+  data.tar.gz: 299b7c0b5780a980c963fe18c7f053919c8e7157ea092f0fbdfb88b263b39f5c
 SHA512:
-  metadata.gz: 2b69bc3462d6e224f29c58d3ef8077772c8f279b1ec5502e526639c750dddceff3ba350d73c8a7070df63b8e39a0cf46371fdd3ff47407115c137c84baf0a299
-  data.tar.gz: 389006735c32ad4ed30dc1c95fd82bfaefd41b2849435bb8e49ca3b0ac6539d6a84824a5e6ceaf97a5c9e4e3b743407ba6da8f450f65f122401db2c88b798f48
+  metadata.gz: 9b244ab47e504e446d268570f0fd54d47b6d142c31f17bb30053145f13aaea3a2a34f512841767fe9b0db2b5330983545e7e1c4b8209f309f95137f39762dc3a
+  data.tar.gz: 36d11102937288958a31899e99b8cd7d0e84e8e252bdc901e2a7d9514e74853ecd208c63217034c791b477eb83de058e06e0b790203fc5efc8aac94aa5b1bedc

data/.github/workflows/ci.yml

@@ -0,0 +1,32 @@
+name: CI
+
+on:
+  push:
+    branches:
+      - main
+
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.3, 2.4, 2.5, 2.6, 2.7, '3.0', 3.1, 3.2, jruby-9.1, jruby-9.2, jruby-9.3, jruby-9.4]
+
+    steps:
+      - name: Setup
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+
+      - uses: actions/checkout@v2
+
+      - name: Install
+        run: bundle install --without docs
+
+      - name: Test
+        run: bundle exec rake spec

data/.gitignore

@@ -3,3 +3,4 @@ coverage
 .yardoc
 Gemfile.lock
 .release
+.idea/

data/.travis.yml

@@ -5,8 +5,6 @@ branches:
 language: ruby
 
 rvm:
-  - 2.0
-  - 2.1
   - 2.2
   - 2.3
   - 2.4
@@ -21,6 +19,6 @@ sudo: false
 env:
   - AWS_REGION=us-west-2
 
-script: bundle exec rake test:unit
+script: bundle exec rake spec
 
 bundler_args: --without docs release repl

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+2.1.0 (2023-06-02)
+------------------
+
+* Feature - Improve User-Agent tracking and bump minimum DynamoDB version.
+
+2.0.1 (2020-11-16)
+------------------
+
+* Issue - Expose `:config` in `RackMiddleware` and `:config_file` in `Configuration`.
+
+* Issue - V2 of this release was still loading SDK V1 credential keys. This removes support for client options specified in YAML configuration (behavior change). Instead, construct `Aws::DynamoDB::Client` and use the `dynamo_db_client` option.
+
 2.0.0 (2020-11-11)
 ------------------
 

data/Gemfile

@@ -13,4 +13,8 @@ group :test do
   gem 'rspec'
   gem 'simplecov', require: false
   gem 'rack-test'
+
+  if RUBY_VERSION >= '3.0'
+    gem 'rexml'
+  end
 end

data/Rakefile

@@ -1,8 +1,9 @@
+require 'rspec/core/rake_task'
+
 $REPO_ROOT = File.dirname(__FILE__)
 $LOAD_PATH.unshift(File.join($REPO_ROOT, 'lib'))
 $VERSION = ENV['VERSION'] || File.read(File.join($REPO_ROOT, 'VERSION')).strip
 
-require 'rspec/core/rake_task'
 
 Dir.glob('**/*.rake').each do |task_file|
   load task_file
@@ -12,27 +13,23 @@ task 'test:coverage:clear' do
   sh("rm -rf #{File.join($REPO_ROOT, 'coverage')}")
 end
 
-# Override the test task definitions
-# this package uses rspec tags to define integration tests
-Rake::Task["test:unit"].clear
 desc 'Runs unit tests'
-RSpec::Core::RakeTask.new('test:unit') do |t|
+RSpec::Core::RakeTask.new do |t|
   t.rspec_opts = "-I #{$REPO_ROOT}/lib -I #{$REPO_ROOT}/spec --tag ~integration"
   t.pattern = "#{$REPO_ROOT}/spec"
 end
-task 'test:unit' => 'test:coverage:clear'
+task :spec => 'test:coverage:clear'
 
-Rake::Task["test:integration"].clear
 desc 'Runs integration tests'
-RSpec::Core::RakeTask.new('test:integration') do |t|
+RSpec::Core::RakeTask.new('spec:integration') do |t|
   t.rspec_opts = "-I #{$REPO_ROOT}/lib -I #{$REPO_ROOT}/spec --tag integration"
   t.pattern = "#{$REPO_ROOT}/spec"
 end
-task 'test:integration' => 'test:coverage:clear'
 
 desc 'Runs unit and integration tests'
-task 'test' => ['test:unit', 'test:integration']
+task 'test' => [:spec, 'spec:integration']
 
-task :default => 'test:unit'
+task :default => :spec
+task 'release:test' => [:spec, 'spec:integration']
 
 

data/VERSION

@@ -1 +1 @@
-2.0.0
+2.1.0

data/aws-sessionstore-dynamodb.gemspec

@@ -15,6 +15,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'aws-sdk-dynamodb', '~> 1'
+  # Require 1.85.0 for user_agent_frameworks config
+  spec.add_dependency 'aws-sdk-dynamodb', '~> 1', '>= 1.85.0'
   spec.add_dependency 'rack', '~> 2'
 end

data/doc-src/templates/default/layout/html/footer.erb

@@ -4,7 +4,3 @@
   <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
   <div id="awsdocs-legal-zone-copyright"></div>
 </div>
-
-<!-- Gitter chat -->
-<script>((window.gitter = {}).chat = {}).options = { room: 'aws/aws-sdk-ruby' };</script>
-<script src="https://sidecar.gitter.im/dist/sidecar.v1.js" async defer></script>

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

@@ -56,6 +56,8 @@ module Aws::SessionStore::DynamoDB
       :secret_key => nil
     }
 
+    ### Feature options
+
     # @return [String] Session table name.
     attr_reader :table_name
 
@@ -84,14 +86,6 @@ module Aws::SessionStore::DynamoDB
     #   ErrorHandler is used.
     attr_reader :raise_errors
 
-    # @return [DynamoDB Client] DynamoDB client.
-    attr_reader :dynamo_db_client
-
-    # @return [Error Handler] An error handling object that handles all exceptions
-    #   thrown during execution of the AWS DynamoDB Session Store Rack Middleware.
-    #   For more information see the Handling Errors Section.
-    attr_reader :error_handler
-
     # @return [Integer] Maximum number of seconds earlier
     #   from the current time that a session was created.
     attr_reader :max_age
@@ -100,9 +94,6 @@ module Aws::SessionStore::DynamoDB
     #   before the current time that the session was last accessed.
     attr_reader :max_stale
 
-    # @return [String] The secret key for HMAC encryption.
-    attr_reader :secret_key
-
     # @return [true] Pessimistic locking strategy will be implemented for
     #   all session accesses.
     # @return [false] No locking strategy will be implemented for
@@ -120,6 +111,21 @@ module Aws::SessionStore::DynamoDB
     #   before giving up.
     attr_reader :lock_max_wait_time
 
+    # @return [String] The secret key for HMAC encryption.
+    attr_reader :secret_key
+
+    # @return [String,Pathname]
+    attr_reader :config_file
+
+    ### Client and Error Handling options
+
+    # @return [DynamoDB Client] DynamoDB client.
+    attr_reader :dynamo_db_client
+
+    # @return [Error Handler] An error handling object that handles all exceptions
+    #   thrown during execution of the AWS DynamoDB Session Store Rack Middleware.
+    #   For more information see the Handling Errors Section.
+    attr_reader :error_handler
 
     # Provides configuration object that allows access to options defined
     # during Runtime, in a YAML file, in the ENV and by default.
@@ -163,18 +169,16 @@ module Aws::SessionStore::DynamoDB
     # @option options [Integer] :lock_retry_delay (500) Time in milleseconds to
     #   wait before retrying to obtain lock once an attempt to obtain lock
     #   has been made and has failed.
-    # @option options [Integer] :lock_max_wait_time (500) Maximum time in seconds
-    #   to wait to acquire lock before giving up.
+    # @option options [Integer] :lock_max_wait_time (500) Maximum time
+    #   in seconds to wait to acquire lock before giving up.
     # @option options [String] :secret_key (SecureRandom.hex(64))
     #   Secret key for HMAC encription.
     def initialize(options = {})
       @options = default_options.merge(
-      env_options.merge(
-          file_options(options).merge(
-            symbolize_keys(options)
-           )
-         )
-       )
+        env_options.merge(
+          file_options(options).merge(symbolize_keys(options))
+        )
+      )
       @options = client_error.merge(@options)
       set_attributes(@options)
     end
@@ -188,10 +192,9 @@ module Aws::SessionStore::DynamoDB
 
     # @return [Hash] DDB client.
     def gen_dynamo_db_client
-      client_opts = client_subset(@options)
-      client_opts[:user_agent_suffix] = _user_agent(@options.delete(:user_agent_suffix))
-      client = Aws::DynamoDB::Client
-      dynamo_db_client = @options[:dynamo_db_client] || client.new(client_opts)
+      dynamo_db_client = @options[:dynamo_db_client] || Aws::DynamoDB::Client.new
+      # this used to be aws-sessionstore/version on user_agent_suffix
+      dynamo_db_client.config.user_agent_frameworks << "aws-sessionstore-dynamodb"
       {:dynamo_db_client => dynamo_db_client}
     end
 
@@ -258,22 +261,5 @@ module Aws::SessionStore::DynamoDB
         opts
       end
     end
-
-    # @return [Hash] Client subset options hash.
-    def client_subset(options = {})
-      client_keys = [:aws_secret_key, :aws_region, :aws_access_key, :api_version]
-      options.inject({}) do |opts, (opt_name, opt_value)|
-        opts[opt_name.to_sym] = opt_value if client_keys.include?(opt_name.to_sym)
-        opts
-      end
-    end
-
-    def _user_agent(custom)
-      if custom
-        custom
-      else
-        " aws-sessionstore/#{VERSION}"
-      end
-    end
   end
 end

data/lib/aws/session_store/dynamo_db/locking/base.rb

@@ -14,7 +14,7 @@ module Aws::SessionStore::DynamoDB::Locking
       packed_session = pack_data(session)
       handle_error(env) do
         save_opts = update_opts(env, sid, packed_session, options)
-        result = @config.dynamo_db_client.update_item(save_opts)
+        @config.dynamo_db_client.update_item(save_opts)
         sid
       end
     end

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

@@ -6,6 +6,9 @@ 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.
     #

data/spec/aws/session_store/dynamo_db/app_config.yml

@@ -14,6 +14,3 @@
 table_name: NewTable
 table_key: Somekey
 consistent_read: true
-AWS_ACCESS_KEY_ID: FakeKey
-AWS_SECRET_ACCESS_KEY: Secret
-AWS_REGION: New York

data/spec/aws/session_store/dynamo_db/configuration_spec.rb

@@ -30,14 +30,13 @@ describe Aws::SessionStore::DynamoDB::Configuration do
   let(:expected_file_opts) do
     {
       consistent_read: true,
-      AWS_ACCESS_KEY_ID: 'FakeKey',
-      AWS_REGION: 'New York',
       table_name: 'NewTable',
       table_key: 'Somekey',
-      AWS_SECRET_ACCESS_KEY: 'Secret'
     }
   end
 
+  let(:client) { Aws::DynamoDB::Client.new(stub_responses: true) }
+
   let(:runtime_options) do
     {
       table_name: 'SessionTable',
@@ -51,6 +50,10 @@ describe Aws::SessionStore::DynamoDB::Configuration do
     expect(cfg.to_hash).to include(expected_opts)
   end
 
+  before do
+    allow(Aws::DynamoDB::Client).to receive(:new).and_return(client)
+  end
+
   context 'Configuration Tests' do
     it 'configures option with out runtime,YAML or ENV options' do
       cfg = Aws::SessionStore::DynamoDB::Configuration.new

data/spec/aws/session_store/dynamo_db/error/default_error_handler_spec.rb

@@ -26,7 +26,7 @@ describe Aws::SessionStore::DynamoDB do
 
   let(:base_app) { MultiplierApplication.new }
   let(:app) { Aws::SessionStore::DynamoDB::RackMiddleware.new(base_app, @options) }
-  let(:client) { double('Aws::DynamoDB::Client') }
+  let(:client) { double('Aws::DynamoDB::Client', config: double(user_agent_frameworks: [])) }
 
   context 'Error handling for Rack Middleware with default error handler' do
     it 'raises error for missing secret key' do

data/spec/aws/session_store/dynamo_db/garbage_collection_spec.rb

@@ -98,7 +98,7 @@ describe Aws::SessionStore::DynamoDB::GarbageCollection do
     }
   end
 
-  let(:dynamo_db_client) {Aws::DynamoDB::Client.new}
+  let(:dynamo_db_client) {Aws::DynamoDB::Client.new(stub_responses: true)}
 
   context 'Mock DynamoDB client with garbage collection' do
     it 'processes scan result greater than 25 and deletes in batches of 25' do
@@ -124,9 +124,9 @@ describe Aws::SessionStore::DynamoDB::GarbageCollection do
       expect(dynamo_db_client).to receive(:scan).
         exactly(1).times.and_return(scan_resp3)
       expect(dynamo_db_client).to receive(:batch_write_item).ordered.
-        with(request_items: { 'sessions' => format_scan_result }).
+        with({request_items: { 'sessions' => format_scan_result }}).
         and_return(write_resp2)
-      expect(dynamo_db_client).to receive(:batch_write_item).ordered.with(
+      expect(dynamo_db_client).to receive(:batch_write_item).ordered.with({
         request_items: {
           'sessions' => [
             {
@@ -151,7 +151,7 @@ describe Aws::SessionStore::DynamoDB::GarbageCollection do
             }
           ]
         }
-      ).and_return(write_resp1)
+      }).and_return(write_resp1)
       collect_garbage
     end
   end

data/spec/aws/session_store/dynamo_db/rack_middleware_spec.rb

@@ -53,7 +53,8 @@ module Aws
             delete_item: 'Deleted',
             list_tables: { table_names: ['Sessions'] },
             get_item: { item: { 'data' => sample_packed_data } },
-            update_item: { attributes: { created_at: 'now' } }
+            update_item: { attributes: { created_at: 'now' } },
+            config: double(user_agent_frameworks: [])
           )
         end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sessionstore-dynamodb
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-11 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -17,6 +17,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.85.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -24,6 +27,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.85.0
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -47,6 +53,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".gitmodules"
 - ".travis.yml"
@@ -104,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: The Amazon DynamoDB Session Store handles sessions for Ruby web applications