rack-session-moped 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor/bundler

data/.rspec

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rack-session-moped.gemspec
+gemspec
+gem 'rake'
+gem 'rspec'
+gem 'yard'
+gem 'redcarpet'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 aoyagikouhei
+
+MIT License
+
+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.md

@@ -0,0 +1,49 @@
+# Rack::Session::Moped
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rack-session-moped'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rack-session-moped
+
+## Usage
+
+Simple (localhost:27017 db:rack, collection:sessions)
+
+    use Rack::Session::Moped
+
+Set Moped Session
+
+    session = Moped::Session.new(['localhost:27017'])
+    use Rack::Sessionn::Moped, {
+      session: session
+    }
+
+Set Config
+
+    use Rack::Sessionn::Moped, {
+      seeds: ['127.0.0.1:27017'],
+      db: 'rack_test',
+      collection: 'sessions_test'
+    }
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
+[rack-session-mongo](http://github.com/aoyagikouhei/rack-session-moped) is Copyright (c) 2012 [Kouhei Aoyagi](http://github.com/aoyagikouhei)(@[aoyagikouhei](http://twitter.com/aoyagikouhei)) and distributed under the [MIT license](http://www.opensource.org/licenses/mit-license).

data/Rakefile

@@ -0,0 +1,9 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'yard'
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+YARD::Rake::YardocTask.new(:doc)

data/lib/rack-session-moped.rb

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

data/lib/rack/session/moped.rb

@@ -0,0 +1,127 @@
+require "rack/session/abstract/id"
+require "moped"
+
+module Rack
+  module Session
+    class Moped < Abstract::ID
+      attr_reader :mutex, :pool, :marshal_data
+      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge(
+        db: :rack, 
+        collection: :sessions, 
+        drop: false, 
+        seeds: ["localhost:27017"]
+      )
+
+      def initialize(app, options={})
+        super
+        @mutex = Mutex.new
+        session = @default_options[:session] || ::Moped::Session.new(@default_options[:seeds])
+        session.use @default_options[:db]
+        @pool = session[@default_options[:collection]]
+        @pool.indexes.create(expires: -1)
+        @pool.indexes.create({sid: 1}, {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)
+        @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))
+        session.instance_variable_set('@sid', sid)
+        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
+
+      def destroy_session(env, sid, options)
+        delete_session(sid)
+        generate_sid unless options[:drop]
+      end
+
+      private
+
+      def find_session(sid)
+        time = Time.now
+        if @recheck_expire_period != -1 && (@next_expire_period.nil? || @next_expire_period < time)
+          @next_expire_period = time + @recheck_expire_period
+          @pool.find(expires: {'$lte' => time}).remove_all # clean out expired sessions 
+        end
+        session = @pool.find(sid: sid).first
+        #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
+
+      def delete_session(sid)
+        @pool.find(sid: sid).remove
+      end
+      
+      def save_session(sid, session={}, expires=nil)
+        @pool.find(sid: sid).upsert("$set" => {data: pack(session), expires: expires})
+      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 keys that are not in common
+        delete = current.keys - (new.keys & current.keys)
+        warn "//@#{sid}: dropping #{delete*','}" if $DEBUG and not delete.empty?
+        delete.each{|k| current.delete k }
+
+        update = new.keys.select{|k| !current.has_key?(k) || new[k] != current[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] }
+
+        current
+      end
+    
+      def pack(data)
+        if(@marshal_data)
+          [Marshal.dump(data)].pack("m*")
+        else
+          data
+        end
+      end
+
+      def unpack(packed)
+        return nil unless packed
+        if(@marshal_data)
+          Marshal.load(packed.unpack("m*").first)
+        else
+          packed
+        end
+      end
+    end
+  end
+end

data/lib/rack/session/moped/version.rb

@@ -0,0 +1,9 @@
+require "rack/session/abstract/id"
+
+module Rack
+  module Session
+    class Moped < Abstract::ID
+      VERSION = "0.0.1"
+    end
+  end
+end

data/rack-session-moped.gemspec

@@ -0,0 +1,19 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/rack/session/moped/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["aoyagikouhei"]
+  gem.email         = ["aoyagi.kouhei@gmail.com"]
+  gem.description   = %q{Rack session store for MongoDB}
+  gem.summary       = %q{Rack session store for MongoDB}
+  gem.homepage      = "https://github.com/aoyagikouhei/rack-session-moped"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "rack-session-moped"
+  gem.require_paths = ["lib"]
+  gem.version       = Rack::Session::Moped::VERSION
+  gem.add_dependency(%q<rack>)
+  gem.add_dependency(%q<moped>)
+end

data/spec/rack-session-moped_spec.rb

@@ -0,0 +1,260 @@
+require 'spec_helper'
+describe Rack::Session::Moped do
+  before(:each) do
+    @session_key = Rack::Session::Moped::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 default connection params' do
+    mongo = Rack::Session::Moped.new(@incrementor)
+    pool = mongo.pool
+    pool.database.session.cluster.nodes[0].address.should == 'localhost:27017'
+    
+    pool.should be_kind_of(Moped::Collection)
+    pool.database.name.should == :rack
+    pool.name.should == :sessions
+  end
+
+  it 'should specify connection params' do
+    mongo = Rack::Session::Moped.new(@incrementor,
+      seeds: ['127.0.0.1:27017'],
+      db: :rack_test,
+      collection: :sessions_test)
+    pool = mongo.pool
+    pool.database.session.cluster.nodes[0].address.should == '127.0.0.1:27017'
+    
+    pool.should be_kind_of(Moped::Collection)
+    pool.database.name.should == :rack_test
+    pool.name.should == :sessions_test
+  end
+
+  it 'creates a new cookie' do
+    pool = Rack::Session::Moped.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::Moped.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::Moped.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::Moped.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::Moped.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'].should be_nil
+    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::Moped.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'].should be_nil
+    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'].should be_nil
+    res3.body.should == '{"counter"=>4}'
+  end
+
+  it 'should default marshal_data to true' do
+    pool = Rack::Session::Moped.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::Moped.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::Moped.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'].should be_nil
+    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'].should be_nil
+    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::Moped.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_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+require 'rack/session/moped'
+require 'rack/mock'
+require 'rack/response'
+
+RSpec.configure do |config|
+    # some (optional) config here
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: rack-session-moped
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- aoyagikouhei
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: moped
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rack session store for MongoDB
+email:
+- aoyagi.kouhei@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/rack-session-moped.rb
+- lib/rack/session/moped.rb
+- lib/rack/session/moped/version.rb
+- rack-session-moped.gemspec
+- spec/rack-session-moped_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/aoyagikouhei/rack-session-moped
+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'
+      segments:
+      - 0
+      hash: 2177003043025176967
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2177003043025176967
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Rack session store for MongoDB
+test_files:
+- spec/rack-session-moped_spec.rb
+- spec/spec_helper.rb
+has_rdoc: