Renamed DynamoDB::SessionStore to SessionStore::DynamoDB

Author: lsegal

README.md

@@ -37,7 +37,7 @@ Ruby file using the following method:
 
     require 'aws-sessionstore-dynamodb'
 
-    AWS::DynamoDB::SessionStore::Table.create_table
+    AWS::SessionStore::DynamoDB::Table.create_table
 
 Run the session store as a Rack middleware in the following way:
 
@@ -46,7 +46,7 @@ Run the session store as a Rack middleware in the following way:
 
     options = { :secret_key => 'SECRET_KEY' }
 
-    use AWS::DynamoDB::SessionStore::RackMiddleware.new(options)
+    use AWS::SessionStore::DynamoDB::RackMiddleware.new(options)
     run SomeRackApp
 
 Note that `:secret_key` is a mandatory configuration option that must be set.
@@ -69,7 +69,7 @@ scalable storage container with a much larger data size limit for session data.
 ### Configuration Options
 
 The following options are available to be set in
-`AWS::DynamoDB::SessionStore::Configuration`, which is used by the
+`AWS::SessionStore::DynamoDB::Configuration`, which is used by the
 `RackMiddleware` class. These options can be set in the YAML configuration
 file in a Rails application, directly by Ruby code, or environment variables.
 
@@ -203,7 +203,7 @@ You can create your own Rake task for garbage collection similar to below:
     desc 'Perform Garbage Collection'
     task :garbage_collect do |t|
      options = {:max_age => 3600*24, max_stale => 5*3600 }
-     AWS::DynamoDB::SessionStore::GarbageCollection.collect_garbage(options)
+     AWS::SessionStore::DynamoDB::GarbageCollection.collect_garbage(options)
     end
 
 The above example will clear sessions older than one day or that have been
@@ -241,5 +241,5 @@ locking strategy according to your needs:
 
 You can pass in your own error handler for raised exceptions or you can allow
 the default error handler to them for you. See the API documentation
-on the {AWS::DynamoDB::SessionStore::Errors::BaseHandler} class for more
+on the {AWS::SessionStore::DynamoDB::Errors::BaseHandler} class for more
 details.

aws-sessionstore-dynamodb.gemspec

@@ -1,8 +1,11 @@
+require File.dirname(__FILE__) + '/lib/aws/session_store/dynamo_db/version'
+
 Gem::Specification.new do |spec|
   spec.name          = "aws-sessionstore-dynamodb"
-  spec.version       = "0.5.0"
+  spec.version       = AWS::SessionStore::DynamoDB::VERSION
   spec.authors       = ["Ruby Robinson"]
-  spec.summary       = "The Amazon DynamoDB Session Store handles sessions for Ruby web applications using a DynamoDB backend."
+  spec.summary       = "The Amazon DynamoDB Session Store handles sessions " +
+                       "for Ruby web applications using a DynamoDB backend."
   spec.homepage      = "http://github.com/aws/aws-sessionstore-dynamodb-ruby"
   spec.license       = "Apache License 2.0"
 

lib/aws-sessionstore-dynamodb.rb

@@ -12,17 +12,23 @@
 # language governing permissions and limitations under the License.
 
 
-require 'aws/dynamo_db/session_store/configuration'
-require 'aws/dynamo_db/session_store/invalid_id_error'
-require 'aws/dynamo_db/session_store/missing_secret_key_error'
-require 'aws/dynamo_db/session_store/lock_wait_timeout_error'
-require 'aws/dynamo_db/session_store/errors/base_handler'
-require 'aws/dynamo_db/session_store/errors/default_handler'
-require 'aws/dynamo_db/session_store/garbage_collection'
-require 'aws/dynamo_db/session_store/locking/base'
-require 'aws/dynamo_db/session_store/locking/null'
-require 'aws/dynamo_db/session_store/locking/pessimistic'
-require 'aws/dynamo_db/session_store/rack_middleware'
-require 'aws/dynamo_db/session_store/table'
-require 'aws/dynamo_db/session_store/version'
-require 'aws/dynamo_db/session_store/railtie' if defined?(Rails)
+module AWS
+  module SessionStore
+    module DynamoDB; 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 'aws/session_store/dynamo_db/railtie' if defined?(Rails)

lib/aws/session_store/dynamo_db/configuration.rb

@@ -14,7 +14,7 @@
 require 'yaml'
 require 'aws-sdk'
 
-module AWS::DynamoDB::SessionStore
+module AWS::SessionStore::DynamoDB
   # This class provides a Configuration object for all DynamoDB transactions
   # by pulling configuration options from Runtime, a YAML file, the ENV and
   # default settings.
@@ -210,7 +210,7 @@ def gen_dynamo_db_client
 
     # @return [Hash] Default Error Handler
     def gen_error_handler
-      default_handler = AWS::DynamoDB::SessionStore::Errors::DefaultHandler
+      default_handler = AWS::SessionStore::DynamoDB::Errors::DefaultHandler
       error_handler = @options[:error_handler] ||
                             default_handler.new(@options[:raise_errors])
       {:error_handler => error_handler}

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

@@ -12,9 +12,9 @@
 # language governing permissions and limitations under the License.
 
 
-module AWS::DynamoDB::SessionStore::Errors
+module AWS::SessionStore::DynamoDB::Errors
   # BaseErrorHandler provides an interface for error handlers
-  # that can be passed in to {AWS::DynamoDB::SessionStore::RackMiddleware}.
+  # that can be passed in to {AWS::SessionStore::DynamoDB::RackMiddleware}.
   # Each error handler must implement a handle_error method.
   #
   # @example Sample ErrorHandler class
@@ -34,7 +34,7 @@ class BaseHandler
     # You may reraise the error passed.
     #
     # @param [AWS::DynamoDB::Errors::Base] error error passed in from
-    #  AWS::DynamoDB::SessionStore::RackMiddleware.
+    #  AWS::SessionStore::DynamoDB::RackMiddleware.
     # @param [Rack::Request::Environment,nil] env Rack environment
     # @return [false] If exception was handled and will not reraise exception.
     # @raise [AWS::DynamoDB::Errors] If error has be reraised.

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

@@ -12,15 +12,15 @@
 # language governing permissions and limitations under the License.
 
 
-module AWS::DynamoDB::SessionStore::Errors
+module AWS::SessionStore::DynamoDB::Errors
   # This class handles errors raised from DynamoDB.
-  class DefaultHandler < AWS::DynamoDB::SessionStore::Errors::BaseHandler
+  class DefaultHandler < AWS::SessionStore::DynamoDB::Errors::BaseHandler
     # Array of errors that will always be passed up the Rack stack.
     HARD_ERRORS = [
       AWS::DynamoDB::Errors::ResourceNotFoundException,
       AWS::DynamoDB::Errors::ConditionalCheckFailedException,
-      AWS::DynamoDB::SessionStore::MissingSecretKeyError,
-      AWS::DynamoDB::SessionStore::LockWaitTimeoutError
+      AWS::SessionStore::DynamoDB::MissingSecretKeyError,
+      AWS::SessionStore::DynamoDB::LockWaitTimeoutError
     ]
 
     # Determines behavior of DefaultErrorHandler

lib/aws/session_store/dynamo_db/garbage_collection.rb

@@ -13,7 +13,7 @@
 
 require 'aws-sdk'
 
-module AWS::DynamoDB::SessionStore
+module AWS::SessionStore::DynamoDB
   # Collects and deletes unwanted sessions based on
   # their creation and update dates.
   module GarbageCollection
@@ -34,7 +34,7 @@ def collect_garbage(options = {})
     # @option (see Configuration#initialize)
     # @api private
     def load_config(options = {})
-      AWS::DynamoDB::SessionStore::Configuration.new(options)
+      AWS::SessionStore::DynamoDB::Configuration.new(options)
     end
 
     # Sets scan filter attributes based on attributes specified.

lib/aws/session_store/dynamo_db/invalid_id_error.rb

@@ -12,7 +12,7 @@
 # language governing permissions and limitations under the License.
 
 
-module AWS::DynamoDB::SessionStore
+module AWS::SessionStore::DynamoDB
   class InvalidIDError < RuntimeError
     def initialize(msg = "Corrupt Session ID!")
       super

lib/aws/session_store/dynamo_db/lock_wait_timeout_error.rb

@@ -12,7 +12,7 @@
 # language governing permissions and limitations under the License.
 
 
-module AWS::DynamoDB::SessionStore
+module AWS::SessionStore::DynamoDB
   class LockWaitTimeoutError < RuntimeError
     def initialize(msg = 'Maximum time spent to acquire lock has been exceeded!')
       super

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

@@ -12,7 +12,7 @@
 # language governing permissions and limitations under the License.
 
 
-module AWS::DynamoDB::SessionStore::Locking
+module AWS::SessionStore::DynamoDB::Locking
   # This class provides a framework for implementing
   # locking strategies.
   class Base

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

@@ -12,10 +12,10 @@
 # language governing permissions and limitations under the License.
 
 
-module AWS::DynamoDB::SessionStore::Locking
+module AWS::SessionStore::DynamoDB::Locking
   # This class gets and sets sessions
   # without a locking strategy.
-  class Null < AWS::DynamoDB::SessionStore::Locking::Base
+  class Null < AWS::SessionStore::DynamoDB::Locking::Base
     # Retrieve session if it exists from the database by id.
     # Unpack the data once retrieved from the database.
     def get_session_data(env, sid)

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

@@ -12,11 +12,11 @@
 # language governing permissions and limitations under the License.
 
 
-module AWS::DynamoDB::SessionStore::Locking
+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::DynamoDB::SessionStore::Locking::Base
+  class Pessimistic < AWS::SessionStore::DynamoDB::Locking::Base
     WAIT_ERROR =
 
     # Saves the session.
@@ -58,7 +58,7 @@ def get_session_with_lock(env, sid)
     # @raise [Error] When time for attempting to get lock has
     #   been exceeded.
     def exceeded_wait_time?(max_attempt_date)
-      lock_error = AWS::DynamoDB::SessionStore::LockWaitTimeoutError
+      lock_error = AWS::SessionStore::DynamoDB::LockWaitTimeoutError
       raise lock_error if Time.now.to_f > max_attempt_date
     end
 

lib/aws/session_store/dynamo_db/missing_secret_key_error.rb

@@ -12,7 +12,7 @@
 # language governing permissions and limitations under the License.
 
 
-module AWS::DynamoDB::SessionStore
+module AWS::SessionStore::DynamoDB
   class MissingSecretKeyError < RuntimeError
     def initialize(msg = "No secret key provided!")
       super

lib/aws/session_store/dynamo_db/rack_middleware.rb

@@ -15,7 +15,7 @@
 require 'openssl'
 require 'aws-sdk'
 
-module AWS::DynamoDB::SessionStore
+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
@@ -26,7 +26,7 @@ class RackMiddleware < Rack::Session::Abstract::ID
     # @option (see Configuration#initialize)
     # @raise [AWS::DynamoDB::Errors::ResourceNotFoundException] If valid table
     #   name is not provided.
-    # @raise [AWS::DynamoDB::SessionStore::MissingSecretKey] If secret key is
+    # @raise [AWS::SessionStore::DynamoDB::MissingSecretKey] If secret key is
     #   not provided.
     def initialize(app, options = {})
       super
@@ -42,9 +42,9 @@ def initialize(app, options = {})
     # @return [Locking::Pessimistic] If locking is enabled.
     def set_locking_strategy
       if @config.enable_locking
-        @lock = AWS::DynamoDB::SessionStore::Locking::Pessimistic.new(@config)
+        @lock = AWS::SessionStore::DynamoDB::Locking::Pessimistic.new(@config)
       else
-        @lock = AWS::DynamoDB::SessionStore::Locking::Null.new(@config)
+        @lock = AWS::SessionStore::DynamoDB::Locking::Null.new(@config)
       end
     end
 
@@ -100,7 +100,7 @@ def handle_error(env = nil, &block)
       begin
         yield
       rescue AWS::DynamoDB::Errors::Base,
-             AWS::DynamoDB::SessionStore::InvalidIDError => e
+             AWS::SessionStore::DynamoDB::InvalidIDError => e
         @config.error_handler.handle_error(e, env)
       end
     end

lib/aws/session_store/dynamo_db/railtie.rb

@@ -12,10 +12,10 @@
 # language governing permissions and limitations under the License.
 
 
-module AWS::DynamoDB::SessionStore
+module AWS::SessionStore::DynamoDB
   class Railtie < Rails::Railtie
     initializer 'aws-sessionstore-dynamodb-rack-middleware' do
-      ActionDispatch::Session::DynamoDbStore = AWS::DynamoDB::SessionStore::RackMiddleware
+      ActionDispatch::Session::DynamoDbStore = AWS::SessionStore::DynamoDB::RackMiddleware
     end
 
     # Load all rake tasks

lib/aws/session_store/dynamo_db/table.rb

@@ -14,7 +14,7 @@
 require 'aws-sdk'
 require 'logger'
 
-module AWS::DynamoDB::SessionStore
+module AWS::SessionStore::DynamoDB
   # This class provides a way to create and delete a session table.
   module Table
     module_function
@@ -50,7 +50,7 @@ def logger
     # @option (see Configuration#initialize)
     # @api private
     def load_config(options = {})
-      AWS::DynamoDB::SessionStore::Configuration.new(options)
+      AWS::SessionStore::DynamoDB::Configuration.new(options)
     end
 
     # @return [Hash] Attribute settings for creating a session table.

lib/aws/session_store/dynamo_db/tasks/session_table.rake

@@ -15,7 +15,7 @@ namespace "db" do
   namespace "sessions" do
     desc 'Clean up Amazon DynamoDB session table'
     task :cleanup => :environment do |t|
-      AWS::DynamoDB::SessionStore::GarbageCollection.collect_garbage
+      AWS::SessionStore::DynamoDB::GarbageCollection.collect_garbage
     end
   end
 end

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

lib/rails/generators/dynamo_db_session_handler/templates/dynamo_db_session.rb

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