mongo_sessions 0.3.0

data/.document

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

data/.gitignore

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

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Mathias Biilmann
+
+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,35 @@
+= mongo_sessions
+
+MongoDB Session store for Rails 3 and Rack applications
+
+Uses the ruby Mongo driver to store sessions in a MongoDB collection.
+
+= When Using in Rails 3 Applications
+
+To use the session store in rails (In this example with Mongoid) add the rails store to your Gemfile:
+
+    gem "mongo_sessions", :require => "mongo_sessions/rails_mongo_store"
+  
+And change config/application.rb to something like:
+
+    config.session_store :mongo_store, :key => '_my_session', :collection => lambda { Mongoid.master.collection('sessions') }
+
+= When Using in Rack Applications
+
+Require the rack mongo store and add the Rack Middleware to your app:
+
+    use Rack::Session::MongoStore
+
+== 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 Mathias Biilmann. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mongo_sessions"
+    gem.summary = %Q{MongoDB Session store for Rails and Rack}
+    gem.description = %Q{Uses the ruby Mongo driver to store sessions in a MongoDB collection}
+    gem.email = "info@mathias-biilmann.net"
+    gem.homepage = "http://github.com/biilmann/mongo_sessions"
+    gem.authors = ["Mathias Biilmann"]
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+    
+    gem.add_dependency 'actionpack',  '~> 3.0'
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mongo_sessions #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.3.0

data/lib/mongo_sessions/mongo_store.rb

@@ -0,0 +1,46 @@
+#require 'action_dispatch/middleware/session/abstract_store'
+require 'rack/session/abstract/id'
+
+module MongoSessions
+  module MongoStore
+    def collection
+      @collection
+    end
+    
+    def initialize(app, options = {})
+      require 'mongo'
+      
+      unless options[:collection]
+        raise "To avoid creating multiple connections to MongoDB, " +
+              "the Mongo Session Store will not create it's own connection " +
+              "to MongoDB - you must pass in a collection with the :collection option"
+      end
+      
+      @collection = options[:collection].respond_to?(:call) ? options[:collection].call : options[:collection]
+      
+      super
+    end
+
+    private
+    def get_session(env, sid)
+      sid ||= generate_sid
+      data = collection.find_one('_id' => sid)
+      [sid, data ? unpack(data['s']) : {}]
+    end
+
+    def set_session(env, sid, session_data, options = {})
+      sid ||= generate_sid
+      collection.update({'_id' => sid}, {'_id' => sid, 's' => pack(session_data)}, {:upsert => true})
+      sid
+    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

data/lib/mongo_sessions/rack_mongo_store.rb

@@ -0,0 +1,10 @@
+require 'mongo_sessions/mongo_store'
+require 'rack/session/abstract/id'
+
+module Rack
+  module Session
+    class MongoStore < Rack::Session::Abstract::ID
+      include MongoSessions::MongoStore
+    end
+  end
+end

data/lib/mongo_sessions/rails_mongo_store.rb

@@ -0,0 +1,10 @@
+require 'mongo_sessions/mongo_store'
+require 'action_dispatch/middleware/session/abstract_store'
+
+module ActionDispatch
+  module Session
+    class MongoStore < Rack::Session::Abstract::ID
+      include MongoSessions::MongoStore
+    end
+  end
+end

data/test/helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'test/unit'
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+class Test::Unit::TestCase
+end

data/test/test_mongo_store.rb

@@ -0,0 +1,156 @@
+require 'rubygems'
+require 'mongo'
+require 'action_dispatch'
+require 'action_dispatch/testing/integration'
+require 'helper'
+require 'mongo_sessions/rails_mongo_store'
+
+class RoutedRackApp
+  attr_reader :routes
+
+  def initialize(routes, &blk)
+    @routes = routes
+    @stack = ActionDispatch::MiddlewareStack.new(&blk).build(@routes)
+  end
+
+  def call(env)
+    @stack.call(env)
+  end
+end
+
+# You need to start a mongodb server inorder to run these tests
+class MongoStoreTest < ActionController::IntegrationTest
+  class TestController < ActionController::Base
+    def no_session_access
+      head :ok
+    end
+
+    def set_session_value
+      session[:foo] = "bar"
+      head :ok
+    end
+
+    def get_session_value
+      render :text => "foo: #{session[:foo].inspect}"
+    end
+
+    def get_session_id
+      session[:foo]
+      render :text => "#{request.session_options[:id]}"
+    end
+
+    def call_reset_session
+      session[:bar]
+      reset_session
+      session[:bar] = "baz"
+      head :ok
+    end
+
+    def rescue_action(e) raise end
+  end
+
+  COLLECTION = Mongo::Connection.new.db('mongo_sessions').collection('sessions')
+  
+  def test_setting_and_getting_session_value
+    with_test_route_set do
+      get '/set_session_value'
+      assert_response :success
+      assert cookies['_session_id']
+
+      get '/get_session_value'
+      assert_response :success
+      assert_equal 'foo: "bar"', response.body
+    end
+  end
+
+  def test_getting_nil_session_value
+    with_test_route_set do
+      get '/get_session_value'
+      assert_response :success
+      assert_equal 'foo: nil', response.body
+    end
+  end
+
+  def test_setting_session_value_after_session_reset
+    with_test_route_set do
+      get '/set_session_value'
+      assert_response :success
+      assert cookies['_session_id']
+      session_id = cookies['_session_id']
+
+      get '/call_reset_session'
+      assert_response :success
+      assert_not_equal [], headers['Set-Cookie']
+
+      get '/get_session_value'
+      assert_response :success
+      assert_equal 'foo: nil', response.body
+
+      get '/get_session_id'
+      assert_response :success
+      assert_not_equal session_id, response.body
+    end
+  end
+
+  def test_getting_session_id
+    with_test_route_set do
+      get '/set_session_value'
+      assert_response :success
+      assert cookies['_session_id']
+      session_id = cookies['_session_id']
+
+      get '/get_session_id'
+      assert_response :success
+      assert_equal session_id, response.body
+    end
+  end
+
+  def test_prevents_session_fixation
+    with_test_route_set do
+      get '/get_session_value'
+      assert_response :success
+      assert_equal 'foo: nil', response.body
+      session_id = cookies['_session_id']
+
+      reset!
+
+      get '/set_session_value', :_session_id => session_id
+      assert_response :success
+      assert_not_equal session_id, cookies['_session_id']
+    end
+  end
+  
+  def self.build_app(routes = nil)
+    RoutedRackApp.new(routes || ActionDispatch::Routing::RouteSet.new) do |middleware|
+      middleware.use "ActionDispatch::Callbacks"
+      middleware.use "ActionDispatch::ParamsParser"
+      middleware.use "ActionDispatch::Cookies"
+      middleware.use "ActionDispatch::Flash"
+      middleware.use "ActionDispatch::Head"
+      yield(middleware) if block_given?
+    end
+  end
+
+  self.app = build_app
+
+  private
+  def with_test_route_set
+    with_routing do |set|
+      set.draw do |map|
+        match ':action', :to => ::MongoStoreTest::TestController
+      end
+      ::MongoStoreTest::TestController.class_eval do
+        include set.url_helpers
+      end
+
+
+      @app = self.class.build_app(set) do |middleware|
+        middleware.use ActionDispatch::Session::MongoStore, :key => '_session_id', :collection => COLLECTION
+      end
+
+      yield
+    end
+  end
+  
+  
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: mongo_sessions
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Mathias Biilmann
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-15 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+description: Uses the ruby Mongo driver to store sessions in a MongoDB collection
+email: info@mathias-biilmann.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/mongo_sessions/mongo_store.rb
+- lib/mongo_sessions/rack_mongo_store.rb
+- lib/mongo_sessions/rails_mongo_store.rb
+- test/helper.rb
+- test/test_mongo_store.rb
+has_rdoc: true
+homepage: http://github.com/biilmann/mongo_sessions
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  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
+signing_key: 
+specification_version: 3
+summary: MongoDB Session store for Rails and Rack
+test_files: 
+- test/helper.rb
+- test/test_mongo_store.rb