rack-session-mongo 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+*.swp

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+script: "bacon -I./lib spec/spec_session_mongo.rb"
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - jruby

data/CHANGES.md

@@ -0,0 +1,6 @@
+CHANGES
+=======
+
+### [0.0.1](https://github.com/migrs/rack-session-mongo/tree/v0.0.1) / 2012-02-04
+
+  * Initial Release

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in rack-session-mongo.gemspec
+gemspec

data/README.md

@@ -0,0 +1,46 @@
+rack-session-mongo
+====================
+
+Rack session store for MongoDB
+
+<http://github.com/migrs/rack-session-mongo>
+
+[![Build Status](https://secure.travis-ci.org/migrs/rack-session-mongo.png)](http://travis-ci.org/migrs/rack-session-mongo)
+
+## Installation
+
+    gem install rack-session-mongo
+
+## Usage
+
+Simple (localhost:27017 db:sessions, collection:sessions)
+
+    use Rack::Session::Mongo
+
+Set MongoDB connection
+
+    conn = Mongo::Coneection.new('myhost', 27017)
+    use Rack::Session::Mongo, conn
+
+Set MongoDB instance
+
+    conn = Mongo::Coneection.new('myhost', 27017)
+    db = conn['myapp']
+    use Rack::Session::Mongo, db
+
+Specify DB host with some config
+
+    use Rack::Session::Mongo, {
+      :host         => 'myhost:27017',
+      :db_name      => 'myapp',
+      :marshal_data => false,
+      :expire_after => 600
+    }
+
+## About MongoDB
+
+- <http://www.mongodb.org/>
+- <https://github.com/mongodb/mongo-ruby-driver>
+
+## License
+[rack-session-mongo](http://github.com/migrs/rack-session-mongo) is Copyright (c) 2012 [Masato Igarashi](http://github.com/migrs)(@[migrs](http://twitter.com/migrs)) and distributed under the [MIT license](http://www.opensource.org/licenses/mit-license).

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rack-session-mongo.rb

@@ -0,0 +1,2 @@
+require "rack/session/mongo"
+require "rack-session-mongo/version"

data/lib/rack-session-mongo/version.rb

@@ -0,0 +1,7 @@
+module Rack
+  module Session
+    class Mongo
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/rack/session/mongo.rb

@@ -0,0 +1,99 @@
+require 'rack/session/abstract/id'
+require 'mongo'
+
+module Rack
+  module Session
+    class Mongo < Abstract::ID
+
+      attr_reader :mutex, :pool
+
+      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge \
+        :db_name => :sessions, :collection => :sessions, :marshal_data => true
+
+      def initialize(app, options={})
+        options = {:db         => options } if options.is_a? ::Mongo::DB
+        options = {:connection => options } if options.is_a? ::Mongo::Connection
+        super
+        db = @default_options[:db] || begin
+          conn = @default_options[:connection] || begin
+            @default_options[:host] ? ::Mongo::Connection.new(*@default_options[:host].split(':')) : ::Mongo::Connection.new
+          end
+          conn[@default_options[:db_name].to_s]
+        end
+        @pool = db[@default_options[:collection].to_s]
+        @pool.create_index('sid', :unique => true)
+        @mutex = Mutex.new
+      end
+
+      def generate_sid
+        loop do
+          sid = super
+          break sid unless _exists? sid
+        end
+      end
+
+      def get_session(env, sid)
+        with_lock(env, [nil, {}]) do
+          unless sid and session = _get(sid)
+            sid, session = generate_sid, {}
+            _put sid, session
+          end
+          [sid, session]
+        end
+      end
+
+      def set_session(env, session_id, new_session, options)
+        with_lock(env, false) do
+          _put session_id, new_session
+          session_id
+        end
+      end
+
+      def destroy_session(env, session_id, options)
+        with_lock(env) do
+          _delete(session_id)
+          generate_sid unless options[:drop]
+        end
+      end
+
+      def with_lock(env, default=nil)
+        @mutex.lock if env['rack.multithread']
+        yield
+      rescue
+        default
+      ensure
+        @mutex.unlock if @mutex.locked?
+      end
+
+    private
+      def _put(sid, session)
+        @pool.update({ :sid => sid },
+           {"$set" => {:data  => _pack(session), :updated_at => Time.now.utc}}, :upsert => true)
+      end
+
+      def _get(sid)
+        if doc = _exists?(sid)
+          _unpack(doc['data'])
+        end
+      end
+
+      def _delete(sid)
+        @pool.remove(:sid => sid)
+      end
+
+      def _exists?(sid)
+        @pool.find_one(:sid => sid)
+      end
+
+      def _pack(data)
+        return nil unless data
+        @default_options[:marshal_data] ? [Marshal.dump(data)].pack("m*") : data
+      end
+
+      def _unpack(packed)
+        return nil unless packed
+        @default_options[:marshal_data] ? Marshal.load(packed.unpack("m*").first) : packed
+      end
+    end
+  end
+end

data/rack-session-mongo.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack-session-mongo/version"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-session-mongo"
+  s.version     = Rack::Session::Mongo::VERSION
+  s.authors     = ["Masato Igarashi"]
+  s.email       = ["m@igrs.jp"]
+  s.homepage    = "http://github.com/migrs/rack-session-mongo"
+  s.summary     = %q{Rack session store for MongoDB}
+  s.description = %q{Rack session store for MongoDB}
+
+  #s.rubyforge_project = "rack-session-mongo"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "bacon"
+  s.add_runtime_dependency "rack"
+  s.add_runtime_dependency "mongo"
+end

data/spec/spec_session_mongo.rb

@@ -0,0 +1,212 @@
+require 'thread'
+require 'rack/mock'
+require 'rack-session-mongo'
+require 'fileutils'
+
+describe Rack::Session::Mongo 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
+
+  session_id = lambda do |env|
+    Rack::Response.new(env["rack.session"].inspect).to_a
+  end
+
+  nothing = lambda do |env|
+    Rack::Response.new("Nothing").to_a
+  end
+
+  drop_session = lambda do |env|
+    env['rack.session.options'][:drop] = true
+    incrementor.call(env)
+  end
+
+  renew_session = lambda do |env|
+    env['rack.session.options'][:renew] = true
+    incrementor.call(env)
+  end
+
+  defer_session = lambda do |env|
+    env['rack.session.options'][:defer] = true
+    incrementor.call(env)
+  end
+
+  after do
+    pool = Rack::Session::Mongo.new(incrementor)
+    pool.pool.remove({})
+  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_match
+    res.body.should.equal '{"counter"=>1}'
+  end
+
+  it "determines session from a cookie" do
+    pool = Rack::Session::Mongo.new(incrementor)
+    req = Rack::MockRequest.new(pool)
+    cookie = req.get("/")["Set-Cookie"]
+    req.get("/", "HTTP_COOKIE" => cookie).
+      body.should.equal '{"counter"=>2}'
+    req.get("/", "HTTP_COOKIE" => cookie).
+      body.should.equal '{"counter"=>3}'
+  end
+
+  it "survives nonexistant cookies" do
+    pool = Rack::Session::Mongo.new(incrementor)
+    res = Rack::MockRequest.new(pool).
+      get("/", "HTTP_COOKIE" => "#{session_key}=blarghfasel")
+    res.body.should.equal '{"counter"=>1}'
+  end
+
+  it "does not send the same session id if it did not change" do
+    pool = Rack::Session::Mongo.new(incrementor)
+    req = Rack::MockRequest.new(pool)
+
+    res0 = req.get("/")
+    cookie = res0["Set-Cookie"][session_match]
+    res0.body.should.equal '{"counter"=>1}'
+    pool.pool.count.should.equal 1
+
+    res1 = req.get("/", "HTTP_COOKIE" => cookie)
+    res1["Set-Cookie"].should.be.nil
+    res1.body.should.equal '{"counter"=>2}'
+    pool.pool.count.should.equal 1
+
+    res2 = req.get("/", "HTTP_COOKIE" => cookie)
+    res2["Set-Cookie"].should.be.nil
+    res2.body.should.equal '{"counter"=>3}'
+    pool.pool.count.should.equal 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)
+
+    res1 = req.get("/")
+    session = (cookie = res1["Set-Cookie"])[session_match]
+    res1.body.should.equal '{"counter"=>1}'
+    pool.pool.count.should.equal 1
+
+    res2 = dreq.get("/", "HTTP_COOKIE" => cookie)
+    res2["Set-Cookie"].should.be.nil
+    res2.body.should.equal '{"counter"=>2}'
+    pool.pool.count.should.equal 0
+
+    res3 = req.get("/", "HTTP_COOKIE" => cookie)
+    res3["Set-Cookie"][session_match].should.not.equal session
+    res3.body.should.equal '{"counter"=>1}'
+    pool.pool.count.should.equal 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)
+
+    res1 = req.get("/")
+    session = (cookie = res1["Set-Cookie"])[session_match]
+    res1.body.should.equal '{"counter"=>1}'
+    pool.pool.count.should.equal 1
+
+    res2 = rreq.get("/", "HTTP_COOKIE" => cookie)
+    new_cookie = res2["Set-Cookie"]
+    new_session = new_cookie[session_match]
+    new_session.should.not.equal session
+    res2.body.should.equal '{"counter"=>2}'
+    pool.pool.count.should.equal 1
+
+    res3 = req.get("/", "HTTP_COOKIE" => new_cookie)
+    res3.body.should.equal '{"counter"=>3}'
+    pool.pool.count.should.equal 1
+
+    res4 = req.get("/", "HTTP_COOKIE" => cookie)
+    res4.body.should.equal '{"counter"=>1}'
+    pool.pool.count.should.equal 2
+  end
+
+  it "omits cookie with :defer option" do
+    pool = Rack::Session::Mongo.new(incrementor)
+    defer = Rack::Utils::Context.new(pool, defer_session)
+    dreq = Rack::MockRequest.new(defer)
+
+    res1 = dreq.get("/")
+    res1["Set-Cookie"].should.equal nil
+    res1.body.should.equal '{"counter"=>1}'
+    pool.pool.count.should.equal 1
+  end
+
+  # anyone know how to do this better?
+  it "should merge sessions when multithreaded" do
+    unless $DEBUG
+      1.should.equal 1
+      next
+    end
+
+    warn 'Running multithread tests for Session::Mongo'
+    pool = Rack::Session::Mongo.new(incrementor)
+    req = Rack::MockRequest.new(pool)
+
+    res = req.get('/')
+    res.body.should.equal '{"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 |resp|
+      resp['Set-Cookie'].should.equal cookie
+      resp.body.should.include '"counter"=>2'
+    end
+
+    session = pool.pool[sess_id]
+    session.count.should.equal tnum+1 # counter
+    session['counter'].should.equal 2 # meeeh
+  end
+
+  it "does not return a cookie if cookie was not read/written" do
+    app = Rack::Session::Mongo.new(nothing)
+    res = Rack::MockRequest.new(app).get("/")
+    res["Set-Cookie"].should.be.nil
+  end
+
+  it "does not return a cookie if cookie was not written (only read)" do
+    app = Rack::Session::Mongo.new(session_id)
+    res = Rack::MockRequest.new(app).get("/")
+    res["Set-Cookie"].should.be.nil
+  end
+
+  it "returns even if not read/written if :expire_after is set" do
+    app = Rack::Session::Mongo.new(nothing, :expire_after => 3600)
+    res = Rack::MockRequest.new(app).get("/", 'rack.session' => {'not' => 'empty'})
+    res["Set-Cookie"].should.not.be.nil
+  end
+
+  it "returns no cookie if no data was written and no session was created previously, even if :expire_after is set" do
+    app = Rack::Session::Mongo.new(nothing, :expire_after => 3600)
+    res = Rack::MockRequest.new(app).get("/")
+    res["Set-Cookie"].should.be.nil
+  end
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: rack-session-mongo
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Masato Igarashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-04 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: &70265363549220 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70265363549220
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70265363548400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70265363548400
+- !ruby/object:Gem::Dependency
+  name: mongo
+  requirement: &70265363547140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70265363547140
+description: Rack session store for MongoDB
+email:
+- m@igrs.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGES.md
+- Gemfile
+- README.md
+- Rakefile
+- lib/rack-session-mongo.rb
+- lib/rack-session-mongo/version.rb
+- lib/rack/session/mongo.rb
+- rack-session-mongo.gemspec
+- spec/spec_session_mongo.rb
+homepage: http://github.com/migrs/rack-session-mongo
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Rack session store for MongoDB
+test_files:
+- spec/spec_session_mongo.rb