aws-sessionstore-dynamodb 1.0.0 → 2.0.0

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

@@ -1,18 +1,5 @@
-# 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.
-
 require 'yaml'
-require 'aws-sdk'
+require 'aws-sdk-dynamodb'
 
 module Aws::SessionStore::DynamoDB
   # This class provides a Configuration object for all DynamoDB transactions
@@ -240,24 +227,15 @@ module Aws::SessionStore::DynamoDB
       file_path = config_file_path(options)
       if file_path
         load_from_file(file_path)
-      elsif rails_defined && File.exists?(rails_config_file_path)
-        load_from_file(rails_config_file_path)
       else
         {}
       end
     end
 
-    # @return [Boolean] Necessary Rails variables defined.
-    def rails_defined
-      defined?(Rails) && defined?(Rails.root) && defined?(Rails.env)
-    end
-
-    # Load options from YAML file depending on existence of Rails
-    # and possible development stage defined.
+    # Load options from YAML file
     def load_from_file(file_path)
       require "erb"
       opts = YAML.load(ERB.new(File.read(file_path)).result) || {}
-      opts = opts[Rails.env] if rails_defined && opts.key?(Rails.env)
       symbolize_keys(opts)
     end
 
@@ -266,11 +244,6 @@ module Aws::SessionStore::DynamoDB
       options[:config_file] || ENV["DYNAMO_DB_SESSION_CONFIG_FILE"]
     end
 
-    # @return [String] Rails configuraton path to YAML file default.
-    def rails_config_file_path
-      File.join(Rails.root, "config", "sessionstore/dynamodb.yml")
-    end
-
     # Set accessible attributes after merged options.
     def set_attributes(options)
       @options.keys.each do |opt_name|

data/lib/aws/session_store/dynamo_db/errors/base_handler.rb

@@ -1,17 +1,3 @@
-# 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.
-
-
 module Aws::SessionStore::DynamoDB::Errors
   # BaseErrorHandler provides an interface for error handlers
   # that can be passed in to {Aws::SessionStore::DynamoDB::RackMiddleware}.

data/lib/aws/session_store/dynamo_db/errors/default_handler.rb

@@ -1,17 +1,3 @@
-# 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.
-
-
 module Aws::SessionStore::DynamoDB::Errors
   # This class handles errors raised from DynamoDB.
   class DefaultHandler < Aws::SessionStore::DynamoDB::Errors::BaseHandler

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

@@ -1,17 +1,4 @@
-# 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.
-
-require 'aws-sdk'
+require 'aws-sdk-dynamodb'
 
 module Aws::SessionStore::DynamoDB
   # Collects and deletes unwanted sessions based on
@@ -50,7 +37,7 @@ module Aws::SessionStore::DynamoDB
     # @api private
     def eliminate_unwanted_sessions(config, last_key = nil)
       scan_result = scan(config, last_key)
-      batch_delete(config, scan_result[:member])
+      batch_delete(config, scan_result[:items])
       scan_result[:last_evaluated_key] || {}
     end
 

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

@@ -1,17 +1,3 @@
-# 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.
-
-
 module Aws::SessionStore::DynamoDB
   class InvalidIDError < RuntimeError
     def initialize(msg = "Corrupt Session ID!")

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

@@ -1,17 +1,3 @@
-# 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.
-
-
 module Aws::SessionStore::DynamoDB
   class LockWaitTimeoutError < RuntimeError
     def initialize(msg = 'Maximum time spent to acquire lock has been exceeded!')

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

@@ -1,17 +1,3 @@
-# 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.
-
-
 module Aws::SessionStore::DynamoDB::Locking
   # This class provides a framework for implementing
   # locking strategies.
@@ -65,7 +51,7 @@ module Aws::SessionStore::DynamoDB::Locking
 
     # @return [Hash] Options for deleting session.
     def delete_opts(sid)
-      merge_all(table_opts(sid), expected_attributes(sid))
+      table_opts(sid)
     end
 
     # @return [Hash] Options for updating item in Session table.
@@ -109,8 +95,8 @@ module Aws::SessionStore::DynamoDB::Locking
     def attr_updts(env, session, add_attrs = {})
       data = data_unchanged?(env, session) ? {} : data_attr(session)
       {
-        :attribute_updates => merge_all(updated_attr, data, add_attrs),
-        :return_values => "UPDATED_NEW"
+        attribute_updates: merge_all(updated_attr, data, add_attrs, expire_attr),
+        return_values: 'UPDATED_NEW'
       }
     end
 
@@ -124,6 +110,17 @@ module Aws::SessionStore::DynamoDB::Locking
       { "created_at" => updated_at }
     end
 
+    # Update client with current time + max_stale.
+    def expire_at
+      max_stale = @config.max_stale || 0
+      { value: (Time.now + max_stale).to_i, action: 'PUT' }
+    end
+
+    # Attribute for TTL expiration of session.
+    def expire_attr
+      { 'expire_at' => expire_at }
+    end
+
     # Attribute for updating session.
     def updated_attr
       {

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

@@ -1,17 +1,3 @@
-# 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.
-
-
 module Aws::SessionStore::DynamoDB::Locking
   # This class gets and sets sessions
   # without a locking strategy.

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

@@ -1,24 +1,8 @@
-# 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.
-
-
 module Aws::SessionStore::DynamoDB::Locking
   # This class implements a pessimistic locking strategy for the
   # DynamoDB session handler. Sessions obtain an exclusive lock
   # for reads that is only released when the session is saved.
   class Pessimistic < Aws::SessionStore::DynamoDB::Locking::Base
-    WAIT_ERROR =
-
     # Saves the session.
     def set_session_data(env, sid, session, options = {})
       super(env, sid, session, set_lock_options(env, options))

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

@@ -1,17 +1,3 @@
-# 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.
-
-
 module Aws::SessionStore::DynamoDB
   class MissingSecretKeyError < RuntimeError
     def initialize(msg = "No secret key provided!")

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

@@ -1,24 +1,11 @@
-# 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.
-
 require 'rack/session/abstract/id'
 require 'openssl'
-require 'aws-sdk'
+require 'aws-sdk-dynamodb'
 
 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::ID
+  class RackMiddleware < Rack::Session::Abstract::Persisted
 
     # Initializes SessionStore middleware.
     #
@@ -58,16 +45,16 @@ module Aws::SessionStore::DynamoDB
     end
 
     # Gets session data.
-    def get_session(env, sid)
+    def find_session(req, sid)
       validate_config
       case verify_hmac(sid)
       when nil
-        set_new_session_properties(env)
+        set_new_session_properties(req.env)
       when false
-        handle_error {raise InvalidIDError}
-        set_new_session_properties(env)
+        handle_error { raise InvalidIDError }
+        set_new_session_properties(req.env)
       else
-        data = @lock.get_session_data(env, sid)
+        data = @lock.get_session_data(req.env, sid)
         [sid, data || {}]
       end
     end
@@ -81,15 +68,15 @@ module Aws::SessionStore::DynamoDB
     #
     # @return [Hash] If session has been saved.
     # @return [false] If session has could not be saved.
-    def set_session(env, sid, session, options)
-      @lock.set_session_data(env, sid, session, options)
+    def write_session(req, sid, session, options)
+      @lock.set_session_data(req.env, sid, session, options)
     end
 
     # Destroys session and removes session from database.
     #
     # @return [String] return a new session id or nil if options[:drop]
-    def destroy_session(env, sid, options)
-      @lock.delete_session(env, sid)
+    def delete_session(req, sid, options)
+      @lock.delete_session(req.env, sid)
       generate_sid unless options[:drop]
     end
 

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

@@ -1,17 +1,4 @@
-# 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.
-
-require 'aws-sdk'
+require 'aws-sdk-dynamodb'
 require 'logger'
 
 module Aws::SessionStore::DynamoDB

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

@@ -1,21 +1,7 @@
-# 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.
-
-
 module Aws
   module SessionStore
     module DynamoDB
-      VERSION = "1.0.0"
+      VERSION = "2.0.0"
     end
   end
 end

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

@@ -11,9 +11,9 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-  table_name: NewTable
-  table_key: Somekey
-  consistent_read: true
-  AWS_ACCESS_KEY_ID: FakeKey
-  AWS_SECRET_ACCESS_KEY: Secret
-  AWS_REGION: New York
+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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Copyright 2013 Amazon.com, Inc. or its affiliates. All Rights Reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License"). You
@@ -11,91 +13,66 @@
 # ANY KIND, either express or implied. See the License for the specific
 # language governing permissions and limitations under the License.
 
-require "spec_helper"
+require 'spec_helper'
 
 describe Aws::SessionStore::DynamoDB::Configuration do
-
   let(:defaults) do
     {
-      :table_name => "sessions",
-      :table_key => "session_id",
-      :consistent_read => true,
-      :read_capacity => 10,
-      :write_capacity => 5,
-      :raise_errors => false
+      table_name: 'sessions',
+      table_key: 'session_id',
+      consistent_read: true,
+      read_capacity: 10,
+      write_capacity: 5,
+      raise_errors: false
     }
   end
 
   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'
+      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(:runtime_options) do
     {
-      :table_name => "SessionTable",
-      :table_key => "session_id_stuff"
+      table_name: 'SessionTable',
+      table_key: 'session_id_stuff'
     }
   end
 
   def expected_options(opts)
     cfg = Aws::SessionStore::DynamoDB::Configuration.new(opts)
     expected_opts = defaults.merge(expected_file_opts).merge(opts)
-    cfg.to_hash.should include(expected_opts)
+    expect(cfg.to_hash).to include(expected_opts)
   end
 
-  context "Configuration Tests" do
-    it "configures option with out runtime,YAML or ENV options" do
+  context 'Configuration Tests' do
+    it 'configures option with out runtime,YAML or ENV options' do
       cfg = Aws::SessionStore::DynamoDB::Configuration.new
-      cfg.to_hash.should include(defaults)
+      expect(cfg.to_hash).to include(defaults)
     end
 
-    it "configures accurate option hash with runtime options, no YAML or ENV" do
+    it 'configures accurate option hash with runtime options, no YAML or ENV' do
       cfg = Aws::SessionStore::DynamoDB::Configuration.new(runtime_options)
       expected_opts = defaults.merge(runtime_options)
-      cfg.to_hash.should include(expected_opts)
+      expect(cfg.to_hash).to include(expected_opts)
     end
 
-    it "merge YAML and runtime options giving runtime precendence" do
+    it 'merge YAML and runtime options giving runtime precendence' do
       config_path = File.dirname(__FILE__) + '/app_config.yml'
-      runtime_opts = {:config_file => config_path}.merge(runtime_options)
+      runtime_opts = { config_file: config_path }.merge(runtime_options)
       expected_options(runtime_opts)
     end
 
-    it "loads options from YAML file based on Rails environment" do
-      rails = double('Rails', {:env => 'test', :root => ''})
-      stub_const("Rails", rails)
-      config_path = File.dirname(__FILE__) + '/rails_app_config.yml'
-      runtime_opts = {:config_file => config_path}.merge(runtime_options)
-      expected_options(runtime_opts)
-    end
-
-    it "has rails defiend but no file specified, no error thrown" do
-      rails = double('Rails', {:env => 'test', :root => ''})
-      stub_const("Rails", rails)
-      cfg = Aws::SessionStore::DynamoDB::Configuration.new(runtime_options)
-      expected_opts = defaults.merge(runtime_options)
-      cfg.to_hash.should include(expected_opts)
-    end
-
-    it "has rails defiend but and default rails YAML file loads" do
-      rails = double('Rails', {:env => 'test', :root => File.dirname(__FILE__)})
-      stub_const("Rails", rails)
-      cfg = Aws::SessionStore::DynamoDB::Configuration.new(runtime_options)
-      expected_opts = defaults.merge(runtime_options)
-      cfg.to_hash.should include(expected_opts)
-    end
-
-    it "throws an exception when wrong path for file" do
+    it 'throws an exception when wrong path for file' do
       config_path = 'Wrong path!'
-      runtime_opts = {:config_file => config_path}.merge(runtime_options)
-      expect{cfg = Aws::SessionStore::DynamoDB::Configuration.new(runtime_opts)}.to raise_error(Errno::ENOENT)
+      runtime_opts = { config_file: config_path }.merge(runtime_options)
+      expect { cfg = Aws::SessionStore::DynamoDB::Configuration.new(runtime_opts) }.to raise_error(Errno::ENOENT)
     end
   end
 end