rack-session-leveldb 0.0.1

data/.gitignore

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

data/.travis.yml

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

data/CHANGES.md

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

data/Gemfile

@@ -0,0 +1,11 @@
+source :rubygems
+
+# Specify your gem's dependencies in rack-session-leveldb.gemspec
+# gemspec
+
+gem 'rack'
+gem 'leveldb-ruby'
+
+group :test do
+  gem 'bacon'
+end

data/Gemfile.lock

@@ -0,0 +1,14 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    bacon (1.1.0)
+    leveldb-ruby (0.10)
+    rack (1.4.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bacon
+  leveldb-ruby
+  rack

data/README.md

@@ -0,0 +1,41 @@
+rack-session-leveldb
+====================
+
+Rack session store for LevelDB
+
+## Installation
+
+    gem install rack-session-leveldb
+
+## Usage
+
+Simple (db\_path: ENV['TMP']/rack.session)
+
+    use Rack::Session::LevelDB
+
+Specify DB path
+
+    use Rack::Session::LevelDB, File.dirname(__FILE__) + '/tmp/rack.session'
+
+Set LevelDB instance
+
+    leveldb = LevelDB::DB.new(File.dirname(__FILE__) + '/db')
+    use Rack::Session::LevelDB, leveldb
+
+Specify DB path with some config
+
+    use Rack::Session::LevelDB, {
+      :db_path      => File.dirname(__FILE__) + '/tmp/rack.session',
+      :expire_after => 600
+    }
+
+Set LevelDB instance with some config
+
+    leveldb = LevelDB::DB.new(File.dirname(__FILE__) + '/db')
+    use Rack::Session::LevelDB, {
+      :cache        => leveldb,
+      :cleanup      => false,
+      :expire_after => 600
+    }
+
+

data/Rakefile

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

data/lib/rack-session-leveldb.rb

@@ -0,0 +1 @@
+require "rack/session/leveldb"

data/lib/rack/session/leveldb.rb

@@ -0,0 +1,108 @@
+require 'rack/session/abstract/id'
+require 'leveldb'
+module Rack
+  module Session
+    class LevelDB < Abstract::ID
+      VERSION = '0.0.1'
+
+      attr_reader :mutex, :pool
+
+      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge \
+        :namespace => 'rack.session:',
+        :db_path  => "#{ENV['TMP'] || '/tmp'}/rack.session",
+        :cleanup => true
+
+      def initialize(app, options={})
+        options = {:db_path => options } if options.is_a? String
+        options = {:cache   => options } if options.is_a? ::LevelDB::DB
+        super
+        if options[:cache]
+          if options[:cache].kind_of? ::LevelDB::DB
+            @pool = options[:cache]
+          else
+            raise ":cache is not LevelDB"
+          end
+        else
+          @pool = ::LevelDB::DB.new @default_options[:db_path]
+        end
+
+        cleanup_expired if @default_options[:cleanup]
+        @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
+        warn "#{self} is unable to open #{@default_options[:db_path]}."
+        warn $!.inspect
+        default
+      ensure
+        @mutex.unlock if @mutex.locked?
+      end
+
+
+      def cleanup_expired(time = Time.now)
+        return unless @default_options[:expire_after]
+        @pool.each do |k, v|
+          if k.start_with?(@default_options[:namespace]) and
+              time - Marshal.load(v)[:datetime] > @default_options[:expire_after]
+            @pool.delete(k)
+          end
+        end
+      end
+
+    private
+      def _put(sid, session)
+        @pool.put(_key(sid), Marshal.dump({:data => session, :datetime => Time.now}))
+      end
+
+      def _get(sid)
+        Marshal.load(@pool.get(_key(sid)))[:data] rescue nil
+      end
+
+      def _delete(sid)
+        @pool.delete(_key(sid))
+      end
+
+      def _exists?(sid)
+        @pool.exists?(_key(sid))
+      end
+
+      def _key(sid)
+        "#{@default_options[:namespace]}#{sid}"
+      end
+    end
+  end
+end

data/rack-session-leveldb.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "rack-session-leveldb"
+
+Gem::Specification.new do |s|
+  s.name        = "rack-session-leveldb"
+  s.version     = Rack::Session::LevelDB::VERSION
+  s.authors     = ["Masato Igarashi"]
+  s.email       = ["m@igrs.jp"]
+  s.homepage    = "http://github.com/migrs/rack-session-leveldb"
+  s.summary     = %q{Rack session store for LevelDB}
+  s.description = %q{Rack session store for LevelDB}
+
+  #s.rubyforge_project = "rack-session-leveldb"
+
+  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 "leveldb-ruby"
+end

data/spec/spec_session_leveldb.rb

@@ -0,0 +1,215 @@
+require 'thread'
+require 'rack/mock'
+require 'rack/session/leveldb'
+require 'fileutils'
+
+describe Rack::Session::LevelDB do
+  session_key = Rack::Session::LevelDB::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
+
+  before do
+    Rack::Session::LevelDB::DEFAULT_OPTIONS[:db_path] = "#{ENV['TMP'] || '/tmp'}/rack.session-#{rand}"
+  end
+
+  after do
+    FileUtils.rm_r(Rack::Session::LevelDB::DEFAULT_OPTIONS[:db_path])
+  end
+
+  it "creates a new cookie" do
+    pool = Rack::Session::LevelDB.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::LevelDB.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::LevelDB.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::LevelDB.new(incrementor)
+    req = Rack::MockRequest.new(pool)
+
+    res0 = req.get("/")
+    cookie = res0["Set-Cookie"][session_match]
+    res0.body.should.equal '{"counter"=>1}'
+    pool.pool.size.should.equal 1
+
+    res1 = req.get("/", "HTTP_COOKIE" => cookie)
+    res1["Set-Cookie"].should.be.nil
+    res1.body.should.equal '{"counter"=>2}'
+    pool.pool.size.should.equal 1
+
+    res2 = req.get("/", "HTTP_COOKIE" => cookie)
+    res2["Set-Cookie"].should.be.nil
+    res2.body.should.equal '{"counter"=>3}'
+    pool.pool.size.should.equal 1
+  end
+
+  it "deletes cookies with :drop option" do
+    pool = Rack::Session::LevelDB.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.size.should.equal 1
+
+    res2 = dreq.get("/", "HTTP_COOKIE" => cookie)
+    res2["Set-Cookie"].should.be.nil
+    res2.body.should.equal '{"counter"=>2}'
+    pool.pool.size.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.size.should.equal 1
+  end
+
+  it "provides new session id with :renew option" do
+    pool = Rack::Session::LevelDB.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.size.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.size.should.equal 1
+
+    res3 = req.get("/", "HTTP_COOKIE" => new_cookie)
+    res3.body.should.equal '{"counter"=>3}'
+    pool.pool.size.should.equal 1
+
+    res4 = req.get("/", "HTTP_COOKIE" => cookie)
+    res4.body.should.equal '{"counter"=>1}'
+    pool.pool.size.should.equal 2
+  end
+
+  it "omits cookie with :defer option" do
+    pool = Rack::Session::LevelDB.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.size.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::LevelDB'
+    pool = Rack::Session::LevelDB.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.size.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::LevelDB.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::LevelDB.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::LevelDB.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::LevelDB.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-leveldb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Masato Igarashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-21 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bacon
+  requirement: &70238763246740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70238763246740
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &70238763245760 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70238763245760
+- !ruby/object:Gem::Dependency
+  name: leveldb-ruby
+  requirement: &70238763244980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70238763244980
+description: Rack session store for LevelDB
+email:
+- m@igrs.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGES.md
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- lib/rack-session-leveldb.rb
+- lib/rack/session/leveldb.rb
+- rack-session-leveldb.gemspec
+- spec/spec_session_leveldb.rb
+homepage: http://github.com/migrs/rack-session-leveldb
+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 LevelDB
+test_files:
+- spec/spec_session_leveldb.rb