aws-sessionstore-dynamodb 0.5.0

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

@@ -0,0 +1,21 @@
+# 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 = "0.5.0"
+    end
+  end
+end

data/lib/rails/generators/sessionstore/dynamodb/dynamodb_generator.rb

@@ -0,0 +1,55 @@
+# 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 'rails/generators/named_base'
+
+# This class generates
+# a migration file for deleting and creating
+# a DynamoDB sessions table.
+module Sessionstore
+  module Generators
+    class DynamodbGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path('templates', File.dirname(__FILE__))
+
+      # Desired name of migration class
+      argument :name, :type => :string, :default => "sessionstore_migration"
+
+      # @return [Rails Migration File] migration file for creation and deletion of
+      #   session table.
+      def generate_migration_file
+        migration_template "sessionstore_migration.rb",
+          "#{Rails.root}/db/migrate/#{file_name}"
+      end
+
+
+      def copy_sample_config_file
+        file = File.join("sessionstore", "dynamodb.yml")
+        template file, File.join(Rails.root, "config", file)
+      end
+
+      private
+
+      # @return [String] filename
+      def file_name
+        name.underscore
+      end
+
+      # @return [String] migration version using time stamp YYYYMMDDHHSS
+      def self.next_migration_number(dir = nil)
+        Time.now.utc.strftime("%Y%m%d%H%M%S")
+      end
+    end
+  end
+end

data/lib/rails/generators/sessionstore/dynamodb/templates/sessionstore/USAGE

@@ -0,0 +1,13 @@
+Description:
+    Generates a migration file for deleting and a creating a DynamoDB
+    sessions table, and a configuration file for the session store.
+
+Example:
+    rails generate sessionstore:dynamodb <MigrationName>
+
+    This will create:
+        db/migrate/VERSION_migration_name.rb
+        config/sessionstore/dynamodb.yml
+
+    The migration will be run when the command rake db:migrate is run
+    in the command line.

data/lib/rails/generators/sessionstore/dynamodb/templates/sessionstore/dynamodb.yml

@@ -0,0 +1,71 @@
+# Uncomment and manipulate the key value pairs below
+# in order to configure the DynamoDB Session Store Application.
+
+# [String] The secret key for HMAC encryption.
+# Must define secret_key here or ENV or at runtime!
+# By default, a random key was generated for you!
+#
+secret_key: <%= require 'securerandom'; SecureRandom.hex(64) %>
+
+# [String] Session table name.
+#
+# table_name: Sessions
+
+# [String] Session table hash key name.
+#
+# table_key: session_id
+
+# [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/rails/generators/sessionstore/dynamodb/templates/sessionstore_migration.rb

@@ -0,0 +1,10 @@
+class <%= name.camelize %> < ActiveRecord::Migration
+  def up
+    AWS::SessionStore::DynamoDB::Table.create_table
+  end
+
+  def down
+    AWS::SessionStore::DynamoDB::Table.delete_table
+  end
+end
+

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

@@ -0,0 +1,19 @@
+# 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.
+
+  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/config/dynamo_db_session.yml

@@ -0,0 +1,24 @@
+# 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.
+
+development:
+  key1: development value 1
+test:
+  table_name: NewTable
+  table_key: Somekey
+  consistent_read: true
+  AWS_ACCESS_KEY_ID: FakeKey
+  AWS_SECRET_ACCESS_KEY: Secret
+  AWS_REGION: New York
+production:
+  key1: production value 1

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

@@ -0,0 +1,101 @@
+# 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 "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
+    }
+  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'
+    }
+  end
+
+  let(:runtime_options) do
+    {
+      :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)
+  end
+
+  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)
+    end
+
+    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)
+    end
+
+    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)
+      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
+      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)
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# 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 'spec_helper'
+
+describe AWS::SessionStore::DynamoDB do
+  include Rack::Test::Methods
+
+  instance_exec(&ConstantHelpers)
+
+  before do
+    @options = { :dynamo_db_client => client, :secret_key => 'meltingbutter' }
+  end
+
+  let(:base_app) { MultiplierApplication.new }
+  let(:app) { AWS::SessionStore::DynamoDB::RackMiddleware.new(base_app, @options) }
+  let(:client) { double('AWS::DynamoDB::Client') }
+
+  context "Error handling for Rack Middleware with default error handler" do
+    it "raises error for missing secret key" do
+      client.stub(:update_item).and_raise(missing_key_error)
+      lambda { get "/" }.should raise_error(missing_key_error)
+    end
+
+    it "catches exception for inaccurate table name and raises error " do
+      client.stub(:update_item).and_raise(resource_error)
+      lambda { get "/" }.should raise_error(resource_error)
+    end
+
+    it "catches exception for inaccurate table key" do
+      client.stub(:update_item).and_raise(key_error)
+      client.stub(:get_item).and_raise(key_error)
+      get "/"
+      last_request.env["rack.errors"].string.should include(key_error_msg)
+    end
+  end
+
+  context "Test ExceptionHandler with true as return value for handle_error" do
+    it "raises all errors" do
+      @options[:raise_errors] = true
+      client.stub(:update_item).and_raise(client_error)
+      lambda { get "/" }.should raise_error(client_error)
+    end
+
+    it "catches exception for inaccurate table key and raises error" do
+      @options[:raise_errors] = true
+      client.stub(:update_item).and_raise(key_error)
+      lambda { get "/" }.should raise_error(key_error)
+    end
+  end
+end

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

@@ -0,0 +1,156 @@
+# 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 'spec_helper'
+
+describe AWS::SessionStore::DynamoDB::GarbageCollection do
+  def member(min,max)
+    member = []
+    for i in min..max
+      member << {"session_id"=>{:s=>"#{i}"}}
+    end
+    member
+  end
+
+  def format_scan_result
+    member = []
+    for i in 31..49
+      member << {"session_id"=>{:s=>"#{i}"}}
+    end
+
+    member.inject([]) do |rqst_array, item|
+      rqst_array << {:delete_request => {:key => item}}
+      rqst_array
+    end
+  end
+
+  def collect_garbage
+    options = { :dynamo_db_client => dynamo_db_client, :max_age => 100, :max_stale => 100 }
+    AWS::SessionStore::DynamoDB::GarbageCollection.collect_garbage(options)
+  end
+
+  let(:scan_resp1){
+    resp = {
+      :member => member(0, 49),
+      :count => 50,
+      :scanned_count => 1000,
+      :last_evaluated_key => {}
+    }
+  }
+
+  let(:scan_resp2){
+    {
+      :member => member(0, 31),
+      :last_evaluated_key => {"session_id"=>{:s=>"31"}}
+    }
+  }
+
+  let(:scan_resp3){
+    {
+      :member => member(31,49),
+      :last_evaluated_key => {}
+    }
+  }
+
+  let(:write_resp1){
+    {
+      :unprocessed_items => {}
+    }
+  }
+
+  let(:write_resp2){
+    {
+      :unprocessed_items => {
+        "sessions" => [
+          {
+            :delete_request => {
+              :key => {
+                "session_id" =>
+                {
+                  :s => "1"
+                }
+              }
+            }
+          },
+          {
+            :delete_request => {
+              :key => {
+                "session_id" =>
+                {
+                  :s => "17"
+                }
+              }
+            }
+          }
+        ]
+      }
+    }
+  }
+
+  let(:dynamo_db_client) {AWS::DynamoDB::Client.new}
+
+  context "Mock DynamoDB client with garbage collection" do
+
+    it "processes scan result greater than 25 and deletes in batches of 25" do
+      dynamo_db_client.should_receive(:scan).
+        exactly(1).times.and_return(scan_resp1)
+      dynamo_db_client.should_receive(:batch_write_item).
+        exactly(2).times.and_return(write_resp1)
+      collect_garbage
+    end
+
+    it "gets scan results then returns last evaluated key and resumes scanning" do
+      dynamo_db_client.should_receive(:scan).
+        exactly(2).times.and_return(scan_resp2, scan_resp3)
+      dynamo_db_client.should_receive(:batch_write_item).
+        exactly(3).times.and_return(write_resp1)
+        collect_garbage
+    end
+
+    it "it formats unprocessed_items and then batch deletes them" do
+      dynamo_db_client.should_receive(:scan).
+        exactly(1).times.and_return(scan_resp3)
+      dynamo_db_client.should_receive(:batch_write_item).ordered.
+        with(:request_items => {"sessions" => format_scan_result}).
+        and_return(write_resp2)
+      dynamo_db_client.should_receive(:batch_write_item).ordered.with(
+        :request_items =>
+        {
+          "sessions" => [
+            {
+              :delete_request => {
+                :key => {
+                  "session_id" =>
+                  {
+                    :s => "1"
+                  }
+                }
+              }
+            },
+            {
+              :delete_request => {
+                :key => {
+                  "session_id" =>
+                  {
+                    :s => "17"
+                  }
+                }
+              }
+            }
+          ]
+        }
+        ).and_return(write_resp1)
+      collect_garbage
+    end
+  end
+end