mongoid3_session_store 1.0.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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,41 @@
+= mongoid_session_store
+
+Store rails 3.1+ sessions using Mongoid 3.
+
+== Installation
+This gem supports rails 3.1+ and mongoid 3.0
+N.B. Mongoid 3 requires ruby 1.9.3. See http://mongoid.org/ for current requirements.
+
+== Setup
+
+In your Gemfile:
+
+  gem "mongoid", "~> 3.0.0"
+  gem "mongoid3_session_store", git: 'git@github.com:petercip/mongoid3_session_store.git'
+
+In the session_store initializer (config/initializers/session_store.rb) you can comment out every line as
+mongoid session store will be setup for use when added to the gemfile. 
+
+If you want to be more explicit you can comment the currently setup store and add: 
+ 
+  Example::Application.config.session_store :mongoid_store
+  
+== Rake Tasks
+Mongoid Session Store comes with a rake task to clear out the sessions it stores in mongoDB
+
+  rake db:mongoid:sessions:clear 
+  
+== 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 Peter Cipollone. Based largely on mongoid_session_store, copyright (c) 2010 Ryan Fitzgerald. See MIT-LICENSE for details.
+

data/Rakefile

@@ -0,0 +1,35 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+  require 'bundler/gem_tasks'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'MongoidSessionStore'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/mongoid3_session_store/mongoid_store.rb

@@ -0,0 +1,82 @@
+module ActionDispatch
+  module Session
+    class MongoidStore < AbstractStore
+
+      class Session
+        include Mongoid::Document
+        store_in :collection => 'sessions'
+
+        field :sid, :type => String
+        field :data, :type => String, :default => [Marshal.dump({})].pack("m*")
+        index({ :sid => 1 }, { :unique => true })
+      end
+
+      # The class used for session storage.
+      cattr_accessor :session_class
+      self.session_class = Session
+      
+      SESSION_RECORD_KEY = 'rack.session.record'
+      ENV_SESSION_OPTIONS_KEY = Rack::Session::Abstract::ENV_SESSION_OPTIONS_KEY if ::Rails.version >= "3.1"
+
+      private
+
+        def get_session(env, sid)
+          sid ||= generate_sid
+          session = find_session(sid)
+          env[SESSION_RECORD_KEY] = session
+          [sid, unpack(session.data)]
+        end
+
+        def set_session(env, sid, session_data, options = nil)
+          record = get_session_model(env, sid)
+          record.data = pack(session_data)
+
+          # Rack spec dictates that set_session should return true or false
+          # depending on whether or not the session was saved or not.
+          # However, ActionPack seems to want a session id instead.
+          record.save ? sid : false
+        end
+
+        def find_session(id)
+          @@session_class.find_or_create_by(:sid => id)
+        end
+
+        # def destroy(env)
+        #   if sid = current_session_id(env)
+        #     find_session(sid).destroy
+        #   end
+        # end
+        
+        def destroy(env)
+          destroy_session(env, current_session_id(env), {})
+        end
+        
+        def destroy_session(env, session_id, options)
+          if sid = current_session_id(env)
+            get_session_model(env, sid).destroy
+            env[SESSION_RECORD_KEY] = nil
+          end
+
+          generate_sid unless options[:drop]
+        end
+
+        def get_session_model(env, sid)
+          if env[ENV_SESSION_OPTIONS_KEY][:id].nil?
+            env[SESSION_RECORD_KEY] = find_session(sid)
+          else
+            env[SESSION_RECORD_KEY] ||= find_session(sid)
+          end
+        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/mongoid3_session_store.rb

@@ -0,0 +1,16 @@
+require 'rails'
+
+module MongoidSessionStore
+  
+  class Railtie < Rails::Railtie
+    rake_tasks do
+      load "tasks/mongoid3_session_store_tasks.rake"
+    end
+          
+    initializer "setup mongoid session store" do |app|
+      require 'mongoid3_session_store/mongoid_store'
+      app.config.session_store :mongoid_store
+    end  
+  end
+  
+end

data/lib/tasks/mongoid3_session_store_tasks.rake

@@ -0,0 +1,10 @@
+namespace :db do
+  namespace :mongoid do
+    namespace :sessions do
+      desc "Clears sessions stored in mongoDB"
+      task :clear => :environment do
+        ActionDispatch::Session::MongoidStore::Session.destroy_all
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,86 @@
+--- !ruby/object:Gem::Specification
+name: mongoid3_session_store
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Peter Cipollone
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Store rails 3.1+ sessions using Mongoid 3.
+email:
+- peter.cipollone@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/mongoid3_session_store/mongoid_store.rb
+- lib/mongoid3_session_store.rb
+- lib/tasks/mongoid3_session_store_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.rdoc
+homepage: http://github.com/petercip/mongoid3_session_store
+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: -3069011305836536140
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Store rails 3.1+ sessions using Mongoid 3.
+test_files: []