mongo_session_store-rails4 5.0.0

data/lib/mongo_session_store/mongo_store_base.rb

@@ -0,0 +1,77 @@
+module ActionDispatch
+  module Session
+    class MongoStoreBase < AbstractStore
+      
+      SESSION_RECORD_KEY = 'rack.session.record'.freeze
+      begin
+        ENV_SESSION_OPTIONS_KEY = Rack::Session::Abstract::ENV_SESSION_OPTIONS_KEY
+      rescue NameError
+        # Rack 1.2.x has access to the ENV_SESSION_OPTIONS_KEY
+      end
+
+      def self.session_class
+        self::Session
+      end
+
+      private
+        def session_class
+          self.class.session_class
+        end
+
+        def generate_sid
+          # 20 random bytes in url-safe base64
+          SecureRandom.base64(20).gsub('=','').gsub('+','-').gsub('/','_')
+        end
+
+        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 = {})
+          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.where(:_id => id).first || session_class.new(:_id => id)
+        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 destroy_session(env, session_id, options)
+          destroy(env)
+          generate_sid unless options[:drop]
+        end
+
+        def destroy(env)
+          if sid = current_session_id(env)
+            get_session_model(env, sid).destroy
+            env[SESSION_RECORD_KEY] = nil
+          end
+        end
+
+        def pack(data)
+          Marshal.dump(data)
+        end
+
+        def unpack(packed)
+          return nil unless packed
+          Marshal.load(StringIO.new(packed.to_s))
+        end
+
+    end
+  end
+end

data/lib/mongo_session_store/mongoid_store.rb

@@ -0,0 +1,53 @@
+require 'mongoid'
+require 'mongo_session_store/mongo_store_base'
+
+module ActionDispatch
+  module Session
+    class MongoidStore < MongoStoreBase
+      BINARY_CLASS = defined?(Moped::BSON::Binary) ? Moped::BSON::Binary : BSON::Binary
+
+      class Session
+        include Mongoid::Document
+        include Mongoid::Timestamps
+
+        store_in :collection => MongoSessionStore.collection_name
+
+        field :_id, :type => String
+        field :data, :type => BINARY_CLASS, :default => -> { marshaled_binary({}) }
+        attr_accessible :_id, :data if respond_to?(:attr_accessible)
+
+        def marshaled_binary(data)
+          self.class.marshaled_binary(data)
+        end
+
+        def self.marshaled_binary(data)
+          if BINARY_CLASS.to_s == 'BSON::Binary'
+            BSON::Binary.new(Marshal.dump(data), :generic)
+          else
+            Moped::BSON::Binary.new(:generic, Marshal.dump(data))
+          end
+        end
+      end
+
+      private
+      def pack(data)
+        session_class.marshaled_binary(data)
+      end
+
+      def unpack(packed)
+        return nil unless packed
+        Marshal.load(extract_data(packed))
+      end
+
+      def extract_data(packed)
+        if packed.class.to_s == 'BSON::Binary'
+          packed.data
+        else
+          packed.to_s
+        end
+      end
+    end
+  end
+end
+
+MongoidStore = ActionDispatch::Session::MongoidStore

data/lib/mongo_session_store/version.rb

@@ -0,0 +1,3 @@
+module MongoSessionStore
+  VERSION = "5.0.0"
+end

data/mongo_session_store-rails3.gemspec

@@ -0,0 +1,17 @@
+require File.expand_path('../lib/mongo_session_store/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = File.basename(__FILE__).gsub(".gemspec", "")
+  s.version = MongoSessionStore::VERSION
+
+  s.authors          = ["Brian Hempel", "Nicolas M\303\251rouze", "Tony Pitale", "Chris Brickley"]
+  s.email            = ["plasticchicken@gmail.com"]
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features,perf}/*`.split("\n")
+  s.homepage         = "http://github.com/brianhempel/mongo_session_store"
+  s.require_paths    = ["lib"]
+  s.rubygems_version = "1.3.7"
+  s.summary          = "Rails session stores for MongoMapper, Mongoid, or any other ODM. Rails 3.1, 3.2, 4.0, and 4.1 compatible."
+
+  s.add_dependency "actionpack", ">= 3.1"
+end

data/mongo_session_store-rails4.gemspec

@@ -0,0 +1,17 @@
+require File.expand_path('../lib/mongo_session_store/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.name = File.basename(__FILE__).gsub(".gemspec", "")
+  s.version = MongoSessionStore::VERSION
+
+  s.authors          = ["Brian Hempel", "Nicolas M\303\251rouze", "Tony Pitale", "Chris Brickley"]
+  s.email            = ["plasticchicken@gmail.com"]
+  s.files            = `git ls-files`.split("\n")
+  s.test_files       = `git ls-files -- {test,spec,features,perf}/*`.split("\n")
+  s.homepage         = "http://github.com/brianhempel/mongo_session_store"
+  s.require_paths    = ["lib"]
+  s.rubygems_version = "1.3.7"
+  s.summary          = "Rails session stores for MongoMapper, Mongoid, or any other ODM. Rails 3.1, 3.2, 4.0, and 4.1 compatible."
+
+  s.add_dependency "actionpack", ">= 3.1"
+end

data/perf/benchmark.rb

@@ -0,0 +1,92 @@
+require 'benchmark'
+require 'rubygems'
+require 'bundler/setup'
+require 'action_dispatch'
+require File.expand_path('../../lib/mongo_session_store-rails3', __FILE__)
+
+MongoMapper.database = "test_session_stores"
+# get around Mongoid's unnecessary "requires MongoDB 2.0.0" error which is NOT triggered when loading from mongo.yml!
+Mongoid.config.from_hash('database' => "test_session_stores", 'logger' => false)
+
+RUNS = 2000
+
+def benchmark(test_name, &block)
+  sleep 2 # cool off for my poor laptop
+  time = Benchmark.realtime do
+    RUNS.times do 
+      yield
+    end
+  end
+  puts "#{(time/RUNS*100_000).round / 100.0}ms per #{test_name}"
+end
+
+def benchmark_store(store)
+  collection = store.class.session_class.collection
+  collection.remove
+  
+  large_session =  {
+    :something => "not nothing",
+    :left => "not right",
+    :welcome => "not despised",
+    :visits => [
+      "http://www.google.com",
+      "localhost:3000",
+      "http://localhost:3000/increment_session",
+      "http://www.iso.org/iso/country_codes/iso_3166_code_lists/iso-3166-1_decoding_table.htm",
+      "http://www.geonames.org/search.html?q=2303+australia&country="
+    ],
+    :one_k_of_data => "a"*1024,
+    :another_k => "b"*1024,
+    :more_data => [5]*500,
+    :too_much_data_for_a_cookie => "c"*8000,
+    :a_bunch_of_floats_in_embedded_docs => [{:float_a => 3.141, :float_b => -1.1}]*100
+  }
+  
+  ids = []
+
+  env = {
+    'rack.session'               => large_session,
+    'rack.session.options'       => { :id => store.send(:generate_sid) }
+  }
+  benchmark "session save" do
+    id = store.send(:generate_sid)
+    ids << id
+    store.send(:set_session, env.merge({'rack.session.options' => { :id => id }}), id, env['rack.session'])
+    # store.send(:commit_session, env.merge({'rack.session.options' => { :id => ids.last }}), 200, {}, [])
+  end
+
+  ids.shuffle!
+  
+  env = {
+    'rack.request.cookie_string' => "",
+    'HTTP_COOKIE'                => "",
+    'rack.request.cookie_hash'   => { '_session_id' => store.class.session_class.last._id }
+  }
+  benchmark "session load" do
+    id = ids.pop
+    local_env = env.merge({'rack.request.cookie_hash'   => { '_session_id' => id }})
+    # store.send(:prepare_session, local_env)
+    sid, data = store.send(:get_session, local_env, id)
+    # something = local_env['rack.session']["something"] # trigger the load
+    raise data.inspect unless data[:something] == "not nothing" && data[:a_bunch_of_floats_in_embedded_docs][0] == {:float_a => 3.141, :float_b => -1.1} 
+  end
+  
+  stats = collection.stats
+  puts "           Total Size: #{stats['size']}"
+  puts "         Object count: #{stats['count']}"
+  puts "  Average object size: #{stats['avgObjSize']}"
+  puts "          Index sizes: #{stats['indexSizes'].inspect}"
+end
+
+mongo_mapper_store = MongoMapperStore.new(nil)
+mongoid_store = MongoidStore.new(nil)
+mongo_store = MongoStore.new(nil)
+
+puts "MongoMapperStore..."
+benchmark_store(mongo_mapper_store)
+
+puts "MongoidStore..."
+benchmark_store(mongoid_store)
+
+puts "MongoStore..."
+benchmark_store(mongo_store)

data/spec/integration_with_devise_spec.rb

@@ -0,0 +1,89 @@
+require 'spec_helper'
+
+describe Devise::SessionsController do
+  def create_user
+    post_data = {
+       'user[email]'                 => 'person@example.com',
+       'user[password]'              => 'secret',
+       'user[password_confirmation]' => 'secret'
+    }
+    post '/users', post_data
+  end
+  
+  def login
+    post_data = {
+       'user[email]'                 => 'person@example.com',
+       'user[password]'              => 'secret',
+       'user[password_confirmation]' => 'secret'
+    }
+    post '/users/sign_in', post_data
+  end
+  
+  def logout
+    delete '/users/sign_out'
+  end
+  
+  def i_should_be_logged_in
+    controller.user_signed_in?.should be_true
+    get '/'
+    response.body.squish.should =~ /You are logged in as person@example.com/
+  end
+
+  def i_should_not_be_logged_in
+    controller.user_signed_in?.should be_false
+    get '/'
+    response.body.squish.should =~ /You are logged out/
+  end
+    
+  it "does not explode" do
+  end
+  
+  it "allows user creation" do
+    User.count.should == 0
+    create_user
+    response.status.should == 302
+    get response.redirect_url
+    User.count.should == 1
+    response.body.squish.should =~ /You are logged in as person@example.com/
+    response.body.squish.should =~ /You have signed up successfully/
+  end
+  
+  it "allows user logout" do
+    create_user
+    i_should_be_logged_in
+    logout
+    response.status.should == 302
+    i_should_not_be_logged_in
+    response.body.squish.should =~ /Signed out successfully/
+  end
+  
+  it "allows user login" do
+    create_user
+    logout
+    i_should_not_be_logged_in
+    login
+    response.status.should == 302
+    i_should_be_logged_in
+    response.body.squish.should =~ /Signed in successfully/
+  end
+  
+  it "uses the right session store class" do
+    store = Rails.application.config.session_store
+    store.session_class.to_s.should == "ActionDispatch::Session::#{ENV["MONGO_SESSION_STORE_ORM"].camelize}Store::Session"
+  end
+  
+  it "stores the session in the sessions collection" do
+    collection = db["sessions"]
+    collection.find.count.should == 0
+    create_user
+    collection.find.count.should == 1
+  end
+  
+  it "allows renaming of the collection that stores the sessions" do
+    collection = db["dance_parties"]
+    collection.find.count.should == 0
+    MongoSessionStore.collection_name = "dance_parties"
+    create_user
+    collection.find.count.should == 1
+  end
+end

data/spec/rails_3.1_app/.gitignore

@@ -0,0 +1,5 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/
+.sass-cache/

data/spec/rails_3.1_app/README

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.