moped-session_store 0.0.1

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mongoid-session.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 JGW Maxwell
+
+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,37 @@
+# Moped::SessionStore
+
+Moped::SessionStore is a highly performant MongoDB ActiveSupport Session Store implementation using the excellent new Moped driver from Mongoid 3.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'moped-session_store'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install moped-session_store
+
+## Usage
+
+In *config/initializers/session_store.rb* set the session store as follows:
+
+    YourApp::Application.config.session_store :moped_store, :key => "_session_id", :collection => $a_moped_collection_object
+
+The collection key is required, and currently it is required to be an existing Moped collection object, to avoid adding unneccessary additional connections to your MongoDB instance.
+
+*MORE TO FOLLOW*
+
+## Contributing
+
+This is in development at the moment, and there are some cool improvements to come regarding optimising the way that ActiveSupport deals with sessions. I'm always happy to accept contributions, and any new authors will be acknowledged fully for their contributions.
+
+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

data/Rakefile

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rake'
+
+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 :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "moped-session #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/lib/action_dispatch/session.rb

@@ -0,0 +1,10 @@
+require 'moped/session_store'
+require 'action_dispatch/middleware/session/abstract_store'
+
+module ActionDispatch
+    module Session
+        class MopedStore < AbstractStore
+            include Moped::SessionStore
+        end
+    end
+end

data/lib/moped/session_store/base.rb

@@ -0,0 +1,44 @@
+module Moped
+    module SessionStore
+        module Base
+            def collection
+                @collection
+            end
+
+            # Sets up a new instance of Moped::Session::Store
+            def initialize(app, options = {})
+                
+                unless options[:collection]
+                    raise "To avoid creating unneccessary connections to MongoDB" +
+                    "this Session Store will only reuse an existing Moped connection"  +
+                    "this behaviour WILL CHANGE in the future, but not yet"
+                end
+                @collection = options[:collection].respond_to?(:call) ? options[:collection].call : options[:collection]
+        
+                super
+            end
+
+            private
+            def destroy(env)
+                if sid = current_session_id(env)
+                    collection.remove({'_id' => sid})
+                end
+            end
+
+            def set_session(env, sid, session_data, options = {})
+                sid ||= generate_sid
+                collection.update({'_id' => sid}, {'_id' => sid, 't' => Time.now, 's' => pack(session_data), 'user_id' => session_data['user_id']}, {:upsert => true})
+                return 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
+end

data/lib/moped/session_store/version.rb

@@ -0,0 +1,5 @@
+module Moped
+    module SessionStore
+        VERSION = "0.0.1"
+   end
+end

data/lib/moped/session_store.rb

@@ -0,0 +1,11 @@
+require 'action_dispatch/session'
+require 'rack/session/abstract/id'
+require 'moped'
+require 'moped/session_store/version'
+require 'moped/session_store/base'
+
+module Moped
+    module SessionStore
+        include Base
+    end
+end

data/moped-session_store.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/moped/session_store/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["JGW Maxwell"]
+  gem.email         = ["jgwmaxwell@gmail.com"]
+  gem.description   = %q{Moped::SessionStore is a performant ActiveSupport Session store implementation for MongoDB
+    using the latest Moped driver from Mongoid 3}
+  gem.summary       = %q{A performant MongoDB session store on a Moped}
+  gem.homepage      = "http://jgwmaxwell.com/open-source/moped-session_store"
+
+  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          = "moped-session_store"
+  gem.require_paths = ["lib/moped/session_store", "lib"]
+  gem.version       = Moped::SessionStore::VERSION
+
+  gem.add_dependency("moped", "~> 1.0.0.rc")
+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_mongoid_session_store.rb

@@ -0,0 +1,144 @@
+require 'rubygems'
+require 'moped'
+require 'action_dispatch'
+require 'action_dispatch/testing/integration'
+require 'helper'
+require 'moped-session/moped-session'
+
+class MopedSessionStoreTest < 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 rescure_action(e) raise end
+    end
+
+    $COLLECTION = Moped::Session.new(["localhost:28017"])
+    $COLLECTION.use :moped_sessions_test
+    $COLLECTION = $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 [], header['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 test_with_route_set
+        with_routing do |set|
+            set.draw do |map|
+                match ':action' => ::MopedSessionStoreTest::TestController, :key => "_session_id", :collection => COLLECTION
+            end
+
+            ::MopedSessionStoreTest::TestController.class_eval do
+                include set.url_helpers
+            end
+
+
+            @app = self.class.build_app(set) do |middleware|
+                middleware.use ActionDispatch::Session::MopedStore, :key => "_session_id", :collection => $COLLECTION
+            end
+
+            yield
+        end
+    end
+
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: moped-session_store
+version: !ruby/object:Gem::Version
+  prerelease:
+  version: 0.0.1
+platform: ruby
+authors:
+- JGW Maxwell
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2012-06-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: moped
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0.rc
+    none: false
+  prerelease: false
+  type: :runtime
+description: ! "Moped::SessionStore is a performant ActiveSupport Session store implementation\
+  \ for MongoDB\n    using the latest Moped driver from Mongoid 3"
+email:
+- jgwmaxwell@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- !binary |-
+  LmdpdGlnbm9yZQ==
+- !binary |-
+  R2VtZmlsZQ==
+- !binary |-
+  TElDRU5TRQ==
+- !binary |-
+  UkVBRE1FLm1k
+- !binary |-
+  UmFrZWZpbGU=
+- !binary |-
+  bGliL2FjdGlvbl9kaXNwYXRjaC9zZXNzaW9uLnJi
+- !binary |-
+  bGliL21vcGVkL3Nlc3Npb25fc3RvcmUucmI=
+- !binary |-
+  bGliL21vcGVkL3Nlc3Npb25fc3RvcmUvYmFzZS5yYg==
+- !binary |-
+  bGliL21vcGVkL3Nlc3Npb25fc3RvcmUvdmVyc2lvbi5yYg==
+- !binary |-
+  bW9wZWQtc2Vzc2lvbl9zdG9yZS5nZW1zcGVj
+- !binary |-
+  dGVzdC9oZWxwZXIucmI=
+- !binary |-
+  dGVzdC90ZXN0X21vbmdvaWRfc2Vzc2lvbl9zdG9yZS5yYg==
+homepage: http://jgwmaxwell.com/open-source/moped-session_store
+licenses: []
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib/moped/session_store
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: !binary |-
+        MA==
+  none: false
+requirements: []
+rubyforge_project:
+rubygems_version: 1.8.24
+signing_key:
+specification_version: 3
+summary: A performant MongoDB session store on a Moped
+test_files:
+- !binary |-
+  dGVzdC9oZWxwZXIucmI=
+- !binary |-
+  dGVzdC90ZXN0X21vbmdvaWRfc2Vzc2lvbl9zdG9yZS5yYg==
+...