mongo_session_store-rails3 3.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+/pkg
+/doc
+/coverage
+Gemfile.lock
+Gemfile_Rails_*.lock

data/Gemfile

@@ -0,0 +1,32 @@
+source :rubygems
+
+MONGO_VERS = '1.3.1' unless defined? MONGO_VERS
+
+RAILS_VERS = case ENV['RAILS_VERS']
+             when '3.0'
+               '~>3.0'
+             when '3.1'
+               '>3.1.0.pre'
+             when nil
+               nil
+             else
+               raise "Invalid RAILS_VERS.  Available versions are 3.0 and 3.1."
+             end
+
+gemspec
+
+group :development, :test do
+  gem 'rake'
+  gem 'mongo_mapper', '>= 0.9.0'
+  gem 'mongoid',      '>= 2.0'
+  gem 'mongo',         MONGO_VERS
+  gem 'bson_ext',      MONGO_VERS
+  
+  gem 'system_timer', :platforms => :ruby_18
+  gem 'ruby-debug',   :platforms => :ruby_18
+  gem 'ruby-debug19', :platforms => :ruby_19
+
+  RAILS_VERS ? gem('rails', RAILS_VERS) : gem('rails')
+  gem 'rspec-rails'
+  gem 'devise'
+end

data/README.md

@@ -0,0 +1,128 @@
+# MongoSessionStore
+
+## Description
+
+MongoSessionStore is a collection of Rails-compatible session stores for MongoMapper and Mongoid, but also included is a generic Mongo store that works with any (or no!) Mongo ODM.
+
+## Usage
+
+MongoSessionStore is compatible with Rails 3.0 and 3.1
+
+In your Gemfile:
+
+    gem "mongo_mapper"
+    gem "mongo_session_store-rails3"
+
+In the session_store initializer (config/initializers/session_store.rb):
+
+    # MongoMapper
+    MyApp::Application.config.session_store = :mongo_mapper_store
+    
+    # Mongoid
+    MyApp::Application.config.session_store = :mongoid_store
+    
+    # anything else
+    MyApp::Application.config.session_store = :mongo_store
+    ActionDispatch::Session:MongoStore::Session.database = Mongo::Connection.new.db('my_app_development')
+
+Note: If you choose to use the :mongo_store you only need to set its database if you aren't using MongoMapper or Mongoid in your project.
+
+By default, the sessions will be stored in the "sessions" collection in MongoDB.  If you want to use a different collection, you can set that in the initializer:
+
+    MongoSessionStore.collection_name = "client_sessions"
+
+If for some reason you want to query your sessions:
+
+    # MongoMapper
+    ActionDispatch::Session:MongoMapperStore::Session.where(:updated_at.gt => 2.days.ago)
+
+    # Mongoid
+    ActionDispatch::Session:MongoidStore::Session.where(:updated_at.gt => 2.days.ago)
+    
+    # Plain old Mongo
+    ActionDispatch::Session:MongoStore::Session.where('updated_at' => { '$gt' => 2.days.ago })
+
+## Performance
+
+The following is the benchmark run with bson_ext installed.  Without bson_ext, speeds are about 10x slower.  The benchmark saves 2000 sessions (~12kb each) and then finds/reloads each one.
+
+    $ ruby perf/benchmark.rb
+    MongoMapperStore...
+    3.65ms per session save
+    2.25ms per session load
+               Total Size: 23648924
+             Object count: 2000
+      Average object size: 11824.462
+              Index sizes: {"_id_"=>172032}
+    MongoidStore...
+    2.59ms per session save
+    1.33ms per session load
+               Total Size: 23648924
+             Object count: 2000
+      Average object size: 11824.462
+              Index sizes: {"_id_"=>172032}
+    MongoStore...
+    1.42ms per session save
+    1.11ms per session load
+               Total Size: 23648924
+             Object count: 2000
+      Average object size: 11824.462
+              Index sizes: {"_id_"=>204800}
+
+## Development
+
+To run all the tests:
+
+    rake
+
+To switch to the Rails 3.0 Gemfile.lock:
+
+    rake use_rails_30
+
+To switch to the Rails 3.1 Gemfile.lock:
+
+    rake use_rails_31
+
+To run the tests for a specific store:
+
+    MONGO_SESSION_STORE_ORM=mongo_mapper bundle exec rspec spec
+    MONGO_SESSION_STORE_ORM=mongoid bundle exec rspec spec    
+    
+## Previous contributors
+
+MongoSessionStore started as a fork of the DataMapper session store, modified to work with MongoMapper and Mongoid.  Much thanks to all the previous contributors:
+
+* Nicolas Mérouze
+* Chris Brickley
+* Tony Pitale
+* Nicola Racco
+* Matt Powell
+* Ryan Fitzgerald
+
+## License
+
+Copyright (c) 2011 Brian Hempel
+Copyright (c) 2010 Nicolas Mérouze
+Copyright (c) 2009 Chris Brickley
+Copyright (c) 2009 Tony Pitale
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,49 @@
+require 'rubygems'
+require 'rake'
+
+def run_with_output(command)
+  puts "Running: #{command}"
+  
+  Process.wait( fork { exec command } )
+end
+
+def set_rails_version(rails_vers)
+  unless File.exists?("Gemfile_Rails_#{rails_vers}.lock")
+    run_with_output "export RAILS_VERS=#{rails_vers}; bundle update rails"
+    run_with_output "cp Gemfile.lock Gemfile_Rails_#{rails_vers}.lock"
+  else
+    run_with_output "rm Gemfile.lock"
+    run_with_output "cp Gemfile_Rails_#{rails_vers}.lock Gemfile.lock"    
+  end
+end
+
+task :default => :test_all
+
+desc 'Test each session store against Rails 3.0 and Rails 3.1'
+task :test_all do
+  # inspired by http://pivotallabs.com/users/jdean/blog/articles/1728-testing-your-gem-against-multiple-rubies-and-rails-versions-with-rvm
+  
+  orms = ['mongo_mapper', 'mongoid', 'mongo']
+  
+  set_rails_version('3.0')
+  
+  orms.each do |orm|
+    run_with_output "export MONGO_SESSION_STORE_ORM=#{orm}; bundle exec rspec spec"
+  end
+
+  set_rails_version('3.1')
+  
+  orms.each do |orm|
+    run_with_output "export MONGO_SESSION_STORE_ORM=#{orm}; bundle exec rspec spec"
+  end
+end
+
+desc 'Set Rails version to 3.0'
+task :use_rails_30 do
+  set_rails_version('3.0')
+end
+
+desc 'Set Rails version to 3.1'
+task :use_rails_31 do
+  set_rails_version('3.1')
+end

data/VERSION

@@ -0,0 +1 @@
+3.0.1

data/lib/mongo_session_store-rails3.rb

@@ -0,0 +1,32 @@
+require 'securerandom'
+
+$:.unshift File.dirname(__FILE__)
+
+module MongoSessionStore
+  def self.collection_name=(name)
+    @collection_name = name
+    
+    if defined?(ActionDispatch::Session::MongoStore::Session)
+      ActionDispatch::Session::MongoStore::Session.reset_collection
+    end
+
+    if defined?(ActionDispatch::Session::MongoMapperStore::Session)
+      ActionDispatch::Session::MongoMapperStore::Session.set_collection_name(name)
+    end
+
+    if defined?(ActionDispatch::Session::MongoidStore::Session)
+      ActionDispatch::Session::MongoidStore::Session.store_in(name)
+    end
+  end
+
+  def self.collection_name
+    @collection_name 
+  end
+  
+  # default collection name for all the stores
+  self.collection_name = "sessions"
+end
+
+require 'mongo_session_store/mongo_mapper_store'
+require 'mongo_session_store/mongoid_store'
+require 'mongo_session_store/mongo_store'

data/lib/mongo_session_store/mongo_mapper_store.rb

@@ -0,0 +1,20 @@
+begin
+  require 'mongo_mapper'
+  require 'mongo_session_store/mongo_store_base'
+
+  module ActionDispatch
+    module Session
+      class MongoMapperStore < MongoStoreBase
+        class Session
+          include MongoMapper::Document
+          set_collection_name MongoSessionStore.collection_name
+          key :_id, String
+          key :data, Binary, :default => Marshal.dump({})
+          timestamps!
+        end
+      end
+    end
+  end
+
+rescue LoadError
+end

data/lib/mongo_session_store/mongo_store.rb

@@ -0,0 +1,80 @@
+require 'mongo'
+require 'mongo_session_store/mongo_store_base'
+
+module ActionDispatch
+  module Session
+    class MongoStore < MongoStoreBase
+      class Session
+        attr_accessor :_id, :data, :created_at, :updated_at
+        
+        def initialize(options={})
+          @_id        = options[:_id]
+          @data       = options[:data] || BSON::Binary.new(Marshal.dump({}))
+          @created_at = options[:created_at]
+          @updated_at = options[:updated_at]
+        end
+        
+        def self.load(options={})
+          options[:data] = options["data"].to_s if options["data"]
+          new(options)
+        end
+        
+        def destroy
+          collection.remove :_id => _id
+        end
+        
+        def save
+          @created_at ||= Time.now
+          @updated_at   = Time.now
+          
+          collection.save(
+            :_id        => @_id,
+            :data       => BSON::Binary.new(@data),
+            :created_at => @created_at,
+            :updated_at => @updated_at
+          )
+        end
+        
+        def data=(stuff)
+          @data = stuff.to_s
+        end
+        
+        def self.where(query = {})
+          collection.find(query).map { |doc| load(doc) }
+        end
+        
+        def self.last
+          where.last
+        end
+        
+        def self.database
+          if @database
+            @database
+          elsif defined?(MongoMapper)
+            MongoMapper.database
+          elsif defined?(Mongoid)
+            Mongoid.database
+          else
+            raise "MongoStore needs a database, e.g. #{name.to_s}.database = Mongo::Connection.new.db('my_app_development')"
+          end
+        end
+        
+        def self.database=(database)
+          @database = database
+        end
+        
+        def self.collection
+          @collection ||= database[MongoSessionStore.collection_name]
+        end
+        
+        def self.reset_collection
+          @collection = nil
+        end
+        
+        def collection
+          self.class.collection
+        end
+      end
+    end
+  end
+end

data/lib/mongo_session_store/mongo_store_base.rb

@@ -0,0 +1,77 @@
+module ActionDispatch
+  module Session
+    class MongoStoreBase < AbstractStore
+      
+      SESSION_RECORD_KEY = 'rack.session.record'.freeze
+      begin
+        ENV_SESSION_OPTIONS_KEY = Rack::Session::Abstract::ENV_SESSION_OPTIONS_KEY
+      rescue NameError
+        # Rack 1.2.x has access to the ENV_SESSION_OPTIONS_KEY
+      end
+
+      def self.session_class
+        self::Session
+      end
+            
+      private
+        def session_class
+          self.class.session_class
+        end
+      
+        def generate_sid
+          # 20 random bytes in url-safe base64
+          SecureRandom.base64(20).gsub('=','').gsub('+','-').gsub('/','_')
+        end
+
+        def get_session(env, sid)
+          sid ||= generate_sid
+          session = find_session(sid)
+          env[SESSION_RECORD_KEY] = session
+          [sid, unpack(session.data)]
+        end
+
+        def set_session(env, sid, session_data, options = {})
+          record = get_session_model(env, sid)
+          record.data = pack(session_data)
+          # Rack spec dictates that set_session should return true or false
+          # depending on whether or not the session was saved or not.
+          # However, ActionPack seems to want a session id instead.
+          record.save ? sid : false
+        end
+        
+        def find_session(id)
+          session_class.where(:_id => id).first || session_class.new(:_id => id)
+        end
+
+        def get_session_model(env, sid)
+          if env[ENV_SESSION_OPTIONS_KEY][:id].nil?
+            env[SESSION_RECORD_KEY] = find_session(sid)
+          else
+            env[SESSION_RECORD_KEY] ||= find_session(sid)
+          end
+        end
+
+        def destroy_session(env, session_id, options)
+          destroy(env)
+          generate_sid unless options[:drop]
+        end
+        
+        def destroy(env)
+          if sid = current_session_id(env)
+            get_session_model(env, sid).destroy
+            env[SESSION_RECORD_KEY] = nil
+          end
+        end
+
+        def pack(data)
+          Marshal.dump(data)
+        end
+
+        def unpack(packed)
+          return nil unless packed
+          Marshal.load(StringIO.new(packed.to_s))
+        end
+
+    end
+  end
+end

data/lib/mongo_session_store/mongoid_store.rb

@@ -0,0 +1,34 @@
+begin
+  require 'mongoid'
+  require 'mongo_session_store/mongo_store_base'
+
+  module ActionDispatch
+    module Session
+      class MongoidStore < MongoStoreBase
+        
+        class Session
+          include Mongoid::Document
+          include Mongoid::Timestamps
+          self.collection_name = MongoSessionStore.collection_name
+        
+          identity :type => String
+
+          field :data, :type => BSON::Binary, :default => BSON::Binary.new(Marshal.dump({}))
+        end
+
+        private
+          def pack(data)
+            BSON::Binary.new(Marshal.dump(data))
+          end
+
+          def unpack(packed)
+            return nil unless packed
+            Marshal.load(StringIO.new(packed.to_s))
+          end
+      
+      end
+    end
+  end
+
+rescue LoadError
+end