mongodb_store 0.1.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store
+coverage
+rdoc
+*~
+tmp
+log
+.yardoc
+doc
+
+test/dummy/db/*sqlite3
+test/dummy/log/*log
+test/dummy/tmp/
+test/dummy/test/
+test/dummy/Gemfile.lock

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in mongodb_store.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 2011 Kichiro IKEMOTO
+
+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,50 @@
+= mongodb_store
+
+MongoDB based session store for Rails.
+
+== DESCRIPTION:
+
+A MongoDB based session store. Can be used to share session between several rails instances.
+  
+== Installation
+
+  gem install mongodb_store
+  
+== PROJECT INFORMATION
+
+* Developer:  Kichiro IKEMOTO
+* Git:  git://github.com/kichiro/mongodb_store.git
+
+== REQUIREMENTS:
+
+* rails 3.0.x or later
+* mongo 1.3.1 or later
+
+== USAGE:
+
+In your Gemfile:
+
+  gem "mongodb_store"
+
+And change config/initializers/session_store.rb like:
+
+  YourAppName::Application.config.session_store :mongodb_store, :key => "_your_session", :server => "localhost:27017/your_database_name/collection_name_for_sessions"
+
+Or change config/application.rb to something like:
+
+  config.session_store :key => "_your_session", :server => "localhost:27017/your_database_name/collection_name_for_sessions" 
+
+Server option requires the following format
+
+  {server_name_or_ip}:{port}/{database_name}/{collection_name}
+
+The Server description by default will be localhost:27017/mongodb_store/sessions
+
+Other options includes:
+
+  pool_size (default is 1)
+  pool_timeout (defaults to 1)
+
+== LICENSE:
+
+Copyright (c) 2011 Kichiro IKEMOTO. See LICENSE for details.

data/Rakefile

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

data/lib/mongodb_store.rb

@@ -0,0 +1,183 @@
+# config:utf-8
+
+require "mongodb_store/version"
+require 'mongo'
+require 'logger'
+
+module ActionDispatch
+  module Session
+    class MongodbStore < AbstractStore
+      cattr_reader :sessions #:nodoc:
+      
+      # Initialize mongodb_store. Pass in options for default override.
+      def initialize(app, options={})
+        super
+        
+        # ==== Options for mongodb_store
+        # :server ::
+        #   Specifies server, port, database, and collection location.
+        #   Defaults to
+        #   localhost:28017/mongodb_store/sessions
+        #   Format must conform to the format
+        #   {host}:{port}/{database_name}/{collection_name}
+        # :pool_size ::
+        #   The connection socket pool size. Defaults to 1.
+        #   See mongo-ruby-driver docs for settings.
+        # :pool_timeout ::
+        #   The connection pool timeout. Defaults to 1 sec.
+        #   See mongo-ruby-driver docs for settings.
+        # :logging ::
+        #   Set to true to enable logger. Default is false
+        # ==========
+        @default_options = {
+          :server => "localhost:27017/mongodb_store/sessions",
+          :pool_size => 1,
+          :pool_timeout => 1.0,
+          :log_level => :error
+        }.merge(@default_options)
+        
+        host, port, database_name, collection_name = parse_server_description(@default_options[:server])
+        
+        connection = ::Mongo::Connection.new(
+          host,
+          port,
+          :pool_size => @default_options[:pool_size],
+          :timeout => @default_options[:pool_timeout])
+        database = connection.db(database_name)
+        @@sessions = database[collection_name]
+        
+        @mutex = Mutex.new
+        
+        @logger = ::Logger.new($stdout)
+        @logger.level = set_log_level(@default_options[:log_level])
+      end
+      
+      # Remove all sessions
+      def self.clear_all_sessions
+        sessions.remove({})
+      end
+      
+      private
+      
+      # Parse server description string into host, port, database, collection
+      def parse_server_description(desc)
+        tokens = desc.split('/')
+        raise "Invalid server description" unless tokens.size == 3
+        server_description = tokens[0].split(":")
+        raise "Invalid host:port description" unless server_description.size == 2
+        return server_description.first, server_description.last.to_i, tokens[1], tokens[2]
+      end
+      
+      # Generate unique session id
+      def generate_sid
+        loop do
+          sid = super
+          break sid unless sessions.find_one({:_id => sid})
+        end
+      end
+      
+      # Fetch session with optional session id
+      def get_session(env, sid)
+        return _get_session(env, sid) unless env['rack.multithread']
+        mutex.synchronize do
+          return _get_session(env, sid)
+        end
+      end
+      
+      def _get_session(env, sid)
+        if sid
+          session_object = sessions.find_one({:_id => sid})
+          session = deserialize(session_object['data']) if session_object and fresh?(session_object)
+        end
+        
+        unless sid and session
+          logger.warn "Session ID not found - #{sid.inspect} - Creating new session"
+          session = Hash.new
+          sid = generate_sid
+          ret = sessions.save({:_id => sid, :data => serialize(session)})
+          raise "Session collision on '#{sid.inspect}'" unless ret
+        end
+        return [sid, session]
+      rescue => e
+        logger.error "#{self} Something bad happened loading session data."
+        logger.error $!.inspect
+        e.backtrace.each{|l| logger.error l}
+        return [nil, Hash.new]
+      end
+      
+      # Update session params and sync to MongoDB
+      def set_session(env, sid, new_session)
+        return _set_session(env, sid, new_session) unless env['rack.multithread']
+        mutex.synchronize do
+          return _set_session(env, sid, new_session)
+        end
+      end
+      
+      def _set_session(env, sid, session_data)
+        options = env['rack.session.options']
+        expiry = options[:expire_after] || 0
+        sessions.update({:_id => sid}, {:_id => sid, :data => serialize(session_data), :user_id => session_data['user_id'], :expires => expiry, :updated_at => Time.now}, {:upsert => true})
+        sid
+      rescue => e
+        logger.error "#{self} Something went wrong. Unable to persist session."
+        logger.error $!.inspect
+        e.backtrace.each{|l| logger.error l}
+        return false
+      end
+      
+      # Destroy session object
+      def destroy(env)
+        _destroy(env, current_session_id(env), options={})
+      end
+      
+      def _destroy(env, sid, options)
+        if sid = current_session_id(env)
+          sessions.remove({:_id => sid})
+        end
+        
+        generate_sid unless options[:drop]
+      end
+      
+      # Check session expiration data
+      def fresh?(session_object)
+        return true if session_object['expires'] == 0
+        now = Time.now
+        session_object['expires'] >= now
+      end
+      
+      # Serialize session object
+      def serialize(data)
+        [Marshal.dump(data)].pack("m*")        
+      end
+      
+      # Hydrate session object
+      def deserialize(data)
+        return nil unless data
+        Marshal.load(data.unpack("m*").first)
+      end
+      
+      # Logger handle
+      def logger
+        @logger
+      end
+      
+      # Set the log level
+      def set_log_level(level)
+        case level
+        when :fatal
+          ::Logger::FATAL
+        when :error
+          ::Logger::ERROR
+        when :warn
+          ::Logger::WARN
+        when :info
+          ::Logger::INFO
+        when :debug
+          ::Logger::DEBUG
+        else
+          ::Logger::INFO
+        end
+      end
+    end
+  end
+end

data/lib/mongodb_store/version.rb

@@ -0,0 +1,3 @@
+module MongodbStore
+  VERSION = "0.1.0"
+end

data/mongodb_store.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "mongodb_store/version"
+
+Gem::Specification.new do |s|
+  s.name        = "mongodb_store"
+  s.version     = MongodbStore::VERSION
+  s.authors     = ["Kichiro IKEMOTO"]
+  s.email       = ["kichiro@yomukaku.net"]
+  s.homepage    = "http://github.com/kichiro/mongodb_store"
+  s.summary     = %q{MongoDB session store for Rails.}
+  s.description = %q{MongoDB session store for Rails. Uses the ruby Mongo driver to store sessions to store sessions in a MongoDB collection.}
+
+  s.rubyforge_project = "mongodb_store"
+
+  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"]
+end

data/test/dummy/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/

data/test/dummy/Gemfile

@@ -0,0 +1,6 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.9'
+gem 'mongo'
+gem 'bson_ext'
+

data/test/dummy/README

@@ -0,0 +1,256 @@
+== 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.find(: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.com/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
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |   |-- images
+  |   |-- javascripts
+  |   `-- stylesheets
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+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. Contains subdirectories for
+  images, stylesheets, and javascripts. 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.