mongo-store 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 Jonathan Rudenberg
+
+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/README.rdoc

@@ -0,0 +1,24 @@
+= mongo-store
+
+Rack session store for MongoDB. See the docs[http://rdoc.info/projects/titanous/mongo-store] for more usage details.
+
+== Installation
+    gem install mongo-store
+
+== Usage
+    use Rack::Session::Mongo, :connection => @existing_mongodb_connection,
+                              :expire_after => 1800
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jonathan Rudenberg. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,38 @@
+require 'rubygems'
+require 'rake'
+require 'jeweler'
+require 'spec/rake/spectask'
+require 'yard'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = 'mongo-store'
+  gem.summary = 'Rack session store for MongoDB'
+  gem.email = 'jonathan@titanous.com'
+  gem.homepage = 'http://github.com/titanous/mongo-store'
+  gem.authors = ['Jonathan Rudenberg']
+  gem.add_dependency 'mongo'
+  gem.add_dependency 'rack', '~> 1.1.0'
+  gem.add_development_dependency 'rspec', '>= 1.2.9'
+  gem.add_development_dependency 'yard', '>= 0'
+end
+
+Jeweler::GemcutterTasks.new
+
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+YARD::Rake::YardocTask.new(:doc) do |t|
+  t.options = ['--legacy'] if RUBY_VERSION < '1.9.0'
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/mongo-store.rb

@@ -0,0 +1,4 @@
+require 'rubygems'
+require 'mongo'
+require 'rack/session/abstract/id'
+require 'rack/session/mongo'

data/lib/rack/session/mongo.rb

@@ -0,0 +1,147 @@
+require 'rubygems'
+require 'mongo'
+require 'rack/session/abstract/id'
+
+module Rack
+  module Session
+    # Implements the +Rack::Session::Abstract::ID+ session store interface
+    #
+    # Cookies sent to the client for maintaining sessions will only contain an
+    # id reference. See {Rack::Session::Mongo#initialize below} for options.
+    #
+    # == Usage Example
+    #
+    #     use Rack::Session::Mongo, :connection => @existing_mongodb_connection,
+    #                               :expire_after => 1800
+    class Mongo < Abstract::ID
+      attr_reader :mutex, :pool, :connection
+      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
+      # it his way. See the overview for standard usage instructions.
+      #
+      # Unless specified, the options can be set on a per request basis, in the
+      # +rack.session.options+ environment hash. Additionally the id of
+      # the session can be found within the options hash at the key +:id+. It is
+      # highly not recommended to change its value.
+      #
+      # @param app a Rack application
+      # @param [Hash] options configuration for the session pool
+      # @option options [Mongo::Connection] :connection (Mongo::Connection.new)
+      #   used to create the pool. Change this if you already have a connection
+      #   setup, or want to connect to a server other than +localhost+.
+      #   — <i>pool instance global</i>
+      # @option options [String] :db ('rack') the Mongo db to use — <i>pool
+      #   instance global</i>
+      # @option options [String] :collection ('sessions') the Mongo collection
+      #   to use. — <i>pool instance global</i>
+      # @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 [true, false] :defer (false) don't set the session
+      #   cookie for this request.
+      # @option options [true, false] :renew (false) causes the generation of
+      #   a new session id, and migrates the data to id. Overrides +:defer+.
+      # @option options [true, false] :drop (false) destroys the current
+      #   session, and creates a new one.
+      # @option options [String] :key ('rack.session') the name of the cookie
+      #   that stores the session id
+      # @option options [String] :path ('/') the cookie path
+      # @option options [String] :domain (nil) the cookie domain
+      # @option options [true, false] :secure (false) the cookie security flag;
+      #   tells the client to only send the cookie over HTTPS.
+      # @option options [true, false] :httponly (true) the cookie HttpOnly flag;
+      #   makes the cookie invisible to client-side Javascript.
+      def initialize(app, options = {})
+        super
+        @mutex = Mutex.new
+        @connection = @default_options[:connection] || ::Mongo::Connection.new
+        @pool = @connection.db(@default_options[:db]).collection(@default_options[:collection])
+        @pool.create_index('sid', true)
+      end
+      
+      def get_session(env, sid)
+        @mutex.lock if env['rack.multithread']
+        session = find_session(sid) if sid
+        unless sid and session
+          env['rack.errors'].puts("Session '#{sid}' not found, initializing...") if $VERBOSE and not sid.nil?
+          session = {}
+          sid = generate_sid
+          save_session(sid)
+        end
+        session.instance_variable_set('@old', {}.merge(session))
+        return [sid, session]
+      ensure
+        @mutex.unlock if env['rack.multithread']
+      end
+      
+      def set_session(env, sid, new_session, options)
+        @mutex.lock if env['rack.multithread']
+        expires = Time.now + options[:expire_after] if !options[:expire_after].nil?
+        session = find_session(sid) || {}
+        if options[:renew] or options[:drop]
+          delete_session(sid)
+          return false if options[:drop]
+          sid = generate_sid
+          save_session(sid, session, expires)
+        end
+        old_session = new_session.instance_variable_get('@old') || {}
+        session = merge_sessions(sid, old_session, new_session, session)
+        save_session(sid, session, expires)
+        return sid
+      ensure
+        @mutex.unlock if env['rack.multithread']
+      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 
+          session = @pool.find_one :sid => sid
+          session ? unpack(session['data']) : false
+        end
+        
+        def delete_session(sid)
+          @pool.remove :sid => sid
+        end
+        
+        def save_session(sid, session={}, expires=nil)
+          @pool.update({:sid => sid}, {:sid => sid, :data => pack(session), :expires => expires}, :upsert => true)
+        end
+        
+        def merge_sessions(sid, old, new, current=nil)
+          current ||= {}
+          unless Hash === old and Hash === new
+            warn 'Bad old or new sessions provided.'
+            return current
+          end
+
+          delete = old.keys - new.keys
+          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] }
+          warn "//@#{sid}: updating #{update*','}" if $DEBUG and not update.empty?
+          update.each{|k| current[k] = new[k] }
+
+          current
+        end
+      
+        def pack(data)
+          [Marshal.dump(data)].pack("m*")
+        end
+
+        def unpack(packed)
+          return nil unless packed
+          Marshal.load(packed.unpack("m*").first)
+        end
+    end
+  end
+end

data/spec/mongo-store_spec.rb

@@ -0,0 +1,238 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+
+describe 'Rack::Session::Mongo' do
+  before(:each) do
+    @session_key = Rack::Session::Mongo::DEFAULT_OPTIONS[:key]
+    @session_match = /#{@session_key}=[0-9a-fA-F]+;/
+    @incrementor = lambda do |env|
+      env['rack.session']['counter'] ||= 0
+      env['rack.session']['counter'] += 1
+      Rack::Response.new(env['rack.session'].inspect).to_a
+    end
+    @drop_session = proc do |env|
+      env['rack.session.options'][:drop] = true
+      @incrementor.call(env)
+    end
+    @renew_session = proc do |env|
+      env['rack.session.options'][:renew] = true
+      @incrementor.call(env)
+    end
+    @defer_session = proc do |env|
+      env['rack.session.options'][:defer] = true
+      @incrementor.call(env)
+    end
+  end
+
+  it 'should specify connection params' do
+    mongo = Rack::Session::Mongo.new(@incrementor,
+      :connection => Mongo::Connection.new('localhost'), :db => 'rack-test',
+      :collection => 'mongo-test')
+    pool = mongo.pool
+    connection = mongo.connection
+    
+    connection.host.should == 'localhost'
+    
+    pool.should be_kind_of(Mongo::Collection)
+    pool.db.name.should == 'rack-test'
+    pool.name.should == 'mongo-test'
+  end
+
+  it 'creates a new cookie' do
+    pool = Rack::Session::Mongo.new(@incrementor)
+    res = Rack::MockRequest.new(pool).get('/')
+    res['Set-Cookie'].should match(/#{@session_key}=/)
+    res.body.should == '{"counter"=>1}'
+  end
+
+  it 'determines session from a cookie' do
+    pool = Rack::Session::Mongo.new(@incrementor)
+    req = Rack::MockRequest.new(pool)
+    res = req.get('/')
+    cookie = res['Set-Cookie']
+    req.get('/', 'HTTP_COOKIE' => cookie).
+      body.should == '{"counter"=>2}'
+    req.get('/', 'HTTP_COOKIE' => cookie).
+      body.should == '{"counter"=>3}'
+  end
+  
+  it 'survives nonexistant cookies' do
+    bad_cookie = 'rack.session=blarghfasel'
+    pool = Rack::Session::Mongo.new(@incrementor)
+    res = Rack::MockRequest.new(pool).
+      get('/', 'HTTP_COOKIE' => bad_cookie)
+    res.body.should == '{"counter"=>1}'
+    cookie = res['Set-Cookie'][@session_match]
+    cookie.should_not match(/#{bad_cookie}/)
+  end
+
+  it 'should maintain freshness' do
+    pool = Rack::Session::Mongo.new(@incrementor, :expire_after => 3)
+    res = Rack::MockRequest.new(pool).get('/')
+    res.body.should include('"counter"=>1')
+    cookie = res['Set-Cookie']
+    res = Rack::MockRequest.new(pool).get('/', 'HTTP_COOKIE' => cookie)
+    res['Set-Cookie'].should == cookie
+    res.body.should include('"counter"=>2')
+    puts 'Sleeping to expire session' if $DEBUG
+    sleep 4
+    res = Rack::MockRequest.new(pool).get('/', 'HTTP_COOKIE' => cookie)
+    res['Set-Cookie'].should_not == cookie
+    res.body.should include('"counter"=>1')
+  end
+
+  it 'deletes cookies with :drop option' do
+    pool = Rack::Session::Mongo.new(@incrementor)
+    req = Rack::MockRequest.new(pool)
+    drop = Rack::Utils::Context.new(pool, @drop_session)
+    dreq = Rack::MockRequest.new(drop)
+
+    res0 = req.get('/')
+    session = (cookie = res0['Set-Cookie'])[@session_match]
+    res0.body.should == '{"counter"=>1}'
+
+    res1 = req.get('/', 'HTTP_COOKIE' => cookie)
+    res1['Set-Cookie'][@session_match].should == session
+    res1.body.should == '{"counter"=>2}'
+
+    res2 = dreq.get('/', 'HTTP_COOKIE' => cookie)
+    res2['Set-Cookie'].should be_nil
+    res2.body.should == '{"counter"=>3}'
+
+    res3 = req.get('/', 'HTTP_COOKIE' => cookie)
+    res3['Set-Cookie'][@session_match].should_not == session
+    res3.body.should == '{"counter"=>1}'
+  end
+
+  it 'provides new session id with :renew option' do
+    pool = Rack::Session::Mongo.new(@incrementor)
+    req = Rack::MockRequest.new(pool)
+    renew = Rack::Utils::Context.new(pool, @renew_session)
+    rreq = Rack::MockRequest.new(renew)
+
+    res0 = req.get('/')
+    session = (cookie = res0['Set-Cookie'])[@session_match]
+    res0.body.should == '{"counter"=>1}'
+
+    res1 = req.get('/', 'HTTP_COOKIE' => cookie)
+    res1['Set-Cookie'][@session_match].should == session
+    res1.body.should == '{"counter"=>2}'
+
+    res2 = rreq.get('/', 'HTTP_COOKIE' => cookie)
+    new_cookie = res2['Set-Cookie']
+    new_session = new_cookie[@session_match]
+    new_session.should_not == session
+    res2.body.should == '{"counter"=>3}'
+
+    res3 = req.get('/', 'HTTP_COOKIE' => new_cookie)
+    res3['Set-Cookie'][@session_match].should == new_session
+    res3.body.should == '{"counter"=>4}'
+  end
+
+  specify 'omits cookie with :defer option' do
+    pool = Rack::Session::Mongo.new(@incrementor)
+    req = Rack::MockRequest.new(pool)
+    defer = Rack::Utils::Context.new(pool, @defer_session)
+    dreq = Rack::MockRequest.new(defer)
+
+    res0 = req.get('/')
+    session = (cookie = res0['Set-Cookie'])[@session_match]
+    res0.body.should == '{"counter"=>1}'
+
+    res1 = req.get('/', 'HTTP_COOKIE' => cookie)
+    res1['Set-Cookie'][@session_match].should == session
+    res1.body.should == '{"counter"=>2}'
+
+    res2 = dreq.get('/', 'HTTP_COOKIE' => cookie)
+    res2['Set-Cookie'].should be_nil
+    res2.body.should == '{"counter"=>3}'
+
+    res3 = req.get('/', 'HTTP_COOKIE' => cookie)
+    res3['Set-Cookie'][@session_match].should == session
+    res3.body.should == '{"counter"=>4}'
+  end
+
+  # anyone know how to do this better?
+  specify 'multithread: should cleanly merge sessions' do
+    next unless $DEBUG
+    warn 'Running multithread test for Session::Mongo'
+    pool = Rack::Session::Mongo.new(@incrementor)
+    req = Rack::MockRequest.new(pool)
+
+    res = req.get('/')
+    res.body.should == '{"counter"=>1}'
+    cookie = res['Set-Cookie']
+    sess_id = cookie[/#{pool.key}=([^,;]+)/,1]
+
+    delta_incrementor = lambda do |env|
+      # emulate disconjoinment of threading
+      env['rack.session'] = env['rack.session'].dup
+      Thread.stop
+      env['rack.session'][(Time.now.usec*rand).to_i] = true
+      @incrementor.call(env)
+    end
+    tses = Rack::Utils::Context.new pool, delta_incrementor
+    treq = Rack::MockRequest.new(tses)
+    tnum = rand(7).to_i+5
+    r = Array.new(tnum) do
+      Thread.new(treq) do |run|
+        run.get('/', 'HTTP_COOKIE' => cookie, 'rack.multithread' => true)
+      end
+    end.reverse.map{|t| t.run.join.value }
+    r.each do |res|
+      res['Set-Cookie'].should == cookie
+      res.body.should include('"counter"=>2')
+    end
+
+    session = pool.pool.get(sess_id)
+    session.size.should == tnum+1 # counter
+    session['counter'].should == 2 # meeeh
+
+    tnum = rand(7).to_i+5
+    r = Array.new(tnum) do |i|
+      delta_time = proc do |env|
+        env['rack.session'][i]  = Time.now
+        Thread.stop
+        env['rack.session']     = env['rack.session'].dup
+        env['rack.session'][i] -= Time.now
+        @incrementor.call(env)
+      end
+      app = Rack::Utils::Context.new pool, time_delta
+      req = Rack::MockRequest.new app
+      Thread.new(req) do |run|
+        run.get('/', 'HTTP_COOKIE' => cookie, 'rack.multithread' => true)
+      end
+    end.reverse.map{|t| t.run.join.value }
+    r.each do |res|
+      res['Set-Cookie'].should == cookie
+      res.body.should include('"counter"=>3')
+    end
+
+    session = pool.pool.get(sess_id)
+    session.size.should == tnum+1
+    session['counter'].should == 3
+
+    drop_counter = proc do |env|
+      env['rack.session'].delete 'counter'
+      env['rack.session']['foo'] = 'bar'
+      [200, {'Content-Type'=>'text/plain'}, env['rack.session'].inspect]
+    end
+    tses = Rack::Utils::Context.new pool, drop_counter
+    treq = Rack::MockRequest.new(tses)
+    tnum = rand(7).to_i+5
+    r = Array.new(tnum) do
+      Thread.new(treq) do |run|
+        run.get('/', 'HTTP_COOKIE' => cookie, 'rack.multithread' => true)
+      end
+    end.reverse.map{|t| t.run.join.value }
+    r.each do |res|
+      res['Set-Cookie'].should == cookie
+      res.body.should include('"foo"=>"bar"')
+    end
+
+    session = pool.pool.get(sess_id)
+    session.size.should == r.size+1
+    session['counter'].should be_nil
+    session['foo'].should == 'bar'
+  end
+end

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--color
+-fs

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'mongo-store'
+require 'spec'
+require 'spec/autorun'
+require 'rack/mock'
+require 'rack/response'
+require 'thread'
+
+Spec::Runner.configure do |config|
+  config.before do
+    Mongo::Connection.new.db('rack').collection('rack-sessions').drop
+  end
+end

metadata

@@ -0,0 +1,125 @@
+--- !ruby/object:Gem::Specification 
+name: mongo-store
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jonathan Rudenberg
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-23 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 2
+        - 9
+        version: 1.2.9
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id004
+description: 
+email: jonathan@titanous.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mongo-store.rb
+- lib/rack/session/mongo.rb
+- spec/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
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Rack session store for MongoDB
+test_files: 
+- spec/mongo-store_spec.rb
+- spec/spec_helper.rb