mongo-store 0.1.2 → 0.2.0

data/Rakefile

@@ -29,7 +29,6 @@ Spec::Rake::SpecTask.new(:rcov) do |spec|
   spec.rcov = true
 end
 
-task :spec => :check_dependencies
 
 task :default => :spec
 

data/VERSION

@@ -1 +1,2 @@
-0.1.2
+0.2.0
+

data/lib/rack/session/mongo.rb

@@ -11,10 +11,10 @@ module Rack
     #
     # == Usage Example
     #
-    #     use Rack::Session::Mongo, :connection => @existing_mongodb_connection,
+    #     use Rack::Session::Mongo, :connection => @existing_mongodb_connection;,
     #                               :expire_after => 1800
     class Mongo < Abstract::ID
-      attr_reader :mutex, :pool, :connection
+      attr_reader :mutex, :pool, :connection, :marshal_data
       DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge :db => 'rack', :collection => 'sessions', :drop => false
       
       # Creates a new Mongo session store pool. You probably won't initialize
@@ -35,10 +35,27 @@ module Rack
       #   instance global</i>
       # @option options [String] :collection ('sessions') the Mongo collection
       #   to use. — <i>pool instance global</i>
+      # @option options [boolean] :marshal_data (true) Marshal data into string 
+      #   otherwise store as hash in db. — <i>pool instance global</i>
+      #   Note:  if you use this then the keys used to lookup values must be strings
+      #          even if you put in symbols.  *Example:* 
+      #       request1: session[:test] = true
+      #       request2: session[:test]
+      #             > nil
+      #                 session['test']
+      #             > true
+      # 
+      #      The advantage is that you can query the contents of the sessions and 
+      #      potentially make changes on the fly
       # @option options [Integer] :expire_after (nil) the time in seconds for
       #   the session to last for. *Example:* If this is set to +1800+, the
       #   session will be deleted if the client doesn't make a request within 30
       #   minutes of its last request.
+      # @option options [Integer] :clear_expired_after (1800) the time in seconds
+      #   before we clear out old sessions. *Example:* If this is set to +1800+, the
+      #   the session will be cleared from mongodb when a session is requested, if
+      #   it has been 1800 seconds since it was last cleared.  setting to -1 will 
+      #   disable this.
       # @option options [true, false] :defer (false) don't set the session
       #   cookie for this request.
       # @option options [true, false] :renew (false) causes the generation of
@@ -58,7 +75,11 @@ module Rack
         @mutex = Mutex.new
         @connection = @default_options[:connection] || ::Mongo::Connection.new
         @pool = @connection.db(@default_options[:db]).collection(@default_options[:collection])
+        @pool.create_index([['expires', -1]])
         @pool.create_index('sid', :unique => true)
+        @marshal_data = @default_options[:marshal_data].nil? ? true : @default_options[:marshal_data] == true
+        @next_expire_period = nil
+        @recheck_expire_period = @default_options[:clear_expired_after].nil? ? 1800 : @default_options[:clear_expired_after].to_i
       end
       
       def get_session(env, sid)
@@ -71,6 +92,7 @@ module Rack
           save_session(sid)
         end
         session.instance_variable_set('@old', {}.merge(session))
+        session.instance_variable_set('@sid', sid)
         return [sid, session]
       ensure
         @mutex.unlock if env['rack.multithread']
@@ -95,16 +117,25 @@ module Rack
       end
       
       private
+
         def generate_sid
           loop do
             sid = super
             break sid unless find_session(sid)
           end
         end
-      
+        
         def find_session(sid)
-          @pool.remove :expires => {'$lte' => Time.now} # clean out expired sessions 
+          time = Time.now
+          if @recheck_expire_period != -1 && (@next_expire_period.nil? || @next_expire_period < time)
+            @next_expire_period = time + @recheck_expire_period
+            @pool.remove :expires => {'$lte' => time} # clean out expired sessions 
+          end
           session = @pool.find_one :sid => sid
+          #if session is expired but hasn't been cleared yet.  don't return it.
+          if session && session['expires'] != nil && session['expires'] < time
+            session = nil
+          end
           session ? unpack(session['data']) : false
         end
         
@@ -113,7 +144,7 @@ module Rack
         end
         
         def save_session(sid, session={}, expires=nil)
-          @pool.update({:sid => sid}, {:sid => sid, :data => pack(session), :expires => expires}, :upsert => true)
+          @pool.update({:sid => sid}, {"$set" => {:data => pack(session), :expires => expires}}, :upsert => true)
         end
         
         def merge_sessions(sid, old, new, current=nil)
@@ -127,7 +158,7 @@ module Rack
           warn "//@#{sid}: dropping #{delete*','}" if $DEBUG and not delete.empty?
           delete.each{|k| current.delete k }
 
-          update = new.keys.select{|k| new[k] != old[k] }
+          update = new.keys.select{|k| new[k] != old[k] || new[k].kind_of?(Hash) || new[k].kind_of?(Array) }    
           warn "//@#{sid}: updating #{update*','}" if $DEBUG and not update.empty?
           update.each{|k| current[k] = new[k] }
 
@@ -135,12 +166,20 @@ module Rack
         end
       
         def pack(data)
-          [Marshal.dump(data)].pack("m*")
+          if(@marshal_data)
+            [Marshal.dump(data)].pack("m*")
+          else
+            data
+          end
         end
 
         def unpack(packed)
           return nil unless packed
-          Marshal.load(packed.unpack("m*").first)
+          if(@marshal_data)
+            Marshal.load(packed.unpack("m*").first)
+          else
+            packed
+          end
         end
     end
   end

data/mongo-store.gemspec

@@ -1,62 +1,74 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{mongo-store}
-  s.version = "0.1.2"
+  s.version = "0.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Jonathan Rudenberg"]
-  s.date = %q{2010-10-03}
+  s.date = %q{2011-04-26}
   s.email = %q{jonathan@titanous.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+    "README.rdoc"
   ]
   s.files = [
     ".document",
-     ".gitignore",
-     "Gemfile",
-     "Gemfile.lock",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/mongo-store.rb",
-     "lib/rack/session/mongo.rb",
-     "mongo-store.gemspec",
-     "spec/rack-mongo-store_spec.rb",
-     "spec/spec.opts",
-     "spec/spec_helper.rb"
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "lib/mongo-store.rb",
+    "lib/rack/session/mongo.rb",
+    "mongo-store.gemspec",
+    "spec/rack-mongo-store_spec.rb",
+    "spec/spec.opts",
+    "spec/spec_helper.rb"
   ]
   s.homepage = %q{http://github.com/titanous/mongo-store}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
+  s.rubygems_version = %q{1.7.2}
   s.summary = %q{Rack session store for MongoDB}
   s.test_files = [
     "spec/rack-mongo-store_spec.rb",
-     "spec/spec_helper.rb"
+    "spec/spec_helper.rb"
   ]
 
   if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongo-store>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
       s.add_runtime_dependency(%q<mongo>, [">= 1.0.1"])
       s.add_runtime_dependency(%q<rack>, [">= 1.1.0"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_development_dependency(%q<yard>, [">= 0"])
     else
+      s.add_dependency(%q<mongo-store>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+      s.add_dependency(%q<yard>, [">= 0"])
       s.add_dependency(%q<mongo>, [">= 1.0.1"])
       s.add_dependency(%q<rack>, [">= 1.1.0"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
       s.add_dependency(%q<yard>, [">= 0"])
     end
   else
+    s.add_dependency(%q<mongo-store>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    s.add_dependency(%q<yard>, [">= 0"])
     s.add_dependency(%q<mongo>, [">= 1.0.1"])
     s.add_dependency(%q<rack>, [">= 1.1.0"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])

data/spec/rack-mongo-store_spec.rb

@@ -27,15 +27,14 @@ describe 'Rack::Session::Mongo' do
   it 'should specify connection params' do
     mongo = Rack::Session::Mongo.new(@incrementor,
       :connection => Mongo::Connection.new('localhost'), :db => 'rack-test',
-      :collection => 'mongo-test')
+      :collection => 'mongo_test')
     pool = mongo.pool
     connection = mongo.connection
-    
-    connection.host.should == 'localhost'
+    connection.primary[0].should == 'localhost'
     
     pool.should be_kind_of(Mongo::Collection)
     pool.db.name.should == 'rack-test'
-    pool.name.should == 'mongo-test'
+    pool.name.should == 'mongo_test'
   end
 
   it 'creates a new cookie' do
@@ -128,7 +127,20 @@ describe 'Rack::Session::Mongo' do
     res3['Set-Cookie'][@session_match].should == new_session
     res3.body.should == '{"counter"=>4}'
   end
-
+  it 'should default marshal_data to true' do
+    pool = Rack::Session::Mongo.new(@incrementor)
+    pool.marshal_data.should ==  true
+    data = {'test' => true}
+    pool.send(:pack, data).should  == [Marshal.dump(data)].pack("m*")
+    pool.send(:unpack, [Marshal.dump(data)].pack("m*"))['test']  == true
+  end
+  it 'should be able to set marshal_data to false' do
+    pool = Rack::Session::Mongo.new(@incrementor, :marshal_data => false)
+    pool.marshal_data.should ==  false
+    data = {'test' => true}
+    pool.send(:pack, data).should  === data
+    pool.send(:unpack, data).should === data
+  end
   specify 'omits cookie with :defer option' do
     pool = Rack::Session::Mongo.new(@incrementor)
     req = Rack::MockRequest.new(pool)

metadata

@@ -1,13 +1,8 @@
 --- !ruby/object:Gem::Specification 
 name: mongo-store
 version: !ruby/object:Gem::Version 
-  hash: 31
-  prerelease: false
-  segments: 
-  - 0
-  - 1
-  - 2
-  version: 0.1.2
+  prerelease: 
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jonathan Rudenberg
@@ -15,71 +10,107 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-10-03 00:00:00 -04:00
-default_executable: 
+date: 2011-04-26 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: mongo
-  prerelease: false
+  name: mongo-store
   requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 21
-        segments: 
-        - 1
-        - 0
-        - 1
-        version: 1.0.1
+        version: "0"
   type: :runtime
+  prerelease: false
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: rack
-  prerelease: false
+  name: rspec
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
-        segments: 
-        - 1
-        - 1
-        - 0
-        version: 1.1.0
-  type: :runtime
+        version: 1.2.9
+  type: :development
+  prerelease: false
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  prerelease: false
+  name: yard
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 13
-        segments: 
-        - 1
-        - 2
-        - 9
-        version: 1.2.9
+        version: "0"
   type: :development
+  prerelease: false
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+  type: :development
+  prerelease: false
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: yard
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.0.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: rack
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: yard
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
         version: "0"
   type: :development
-  version_requirements: *id004
+  prerelease: false
+  version_requirements: *id009
 description: 
 email: jonathan@titanous.com
 executables: []
@@ -91,7 +122,6 @@ extra_rdoc_files:
 - README.rdoc
 files: 
 - .document
-- .gitignore
 - Gemfile
 - Gemfile.lock
 - LICENSE
@@ -104,13 +134,12 @@ files:
 - spec/rack-mongo-store_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-has_rdoc: true
 homepage: http://github.com/titanous/mongo-store
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -118,23 +147,17 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.7.2
 signing_key: 
 specification_version: 3
 summary: Rack session store for MongoDB

data/.gitignore

@@ -1,23 +0,0 @@
-## MAC OS
-.DS_Store
-
-## TEXTMATE
-*.tmproj
-tmtags
-
-## EMACS
-*~
-\#*
-.\#*
-
-## VIM
-*.swp
-
-## PROJECT::GENERAL
-coverage
-doc
-.yardoc
-pkg
-
-## PROJECT::SPECIFIC
-.bundle