mongo_rack 0.0.2 → 0.0.3

data/Rakefile

@@ -15,17 +15,17 @@ require 'mongo_rack'
 task :default => 'spec:run'
 
 PROJ.name      = 'mongo_rack'
+PROJ.version   = "0.0.3"
 PROJ.authors   = 'Fernand Galiana'
 PROJ.email     = 'fernand.galiana@gmail.com'
 PROJ.url       = 'http://github.com/derailed/mongo_rack'
 PROJ.summary   = "Rackable mongoDB based session management"
-PROJ.version   = "0.0.2"
 PROJ.ruby_opts = %w[-W0]
 PROJ.readme    = 'README.rdoc'
 PROJ.rcov.opts = ["--sort", "coverage", "-T"]
 PROJ.spec.opts << '--color'
 
 # Dependencies
-depend_on "rack"     , ">= 1.0.0"
-depend_on "mongo"    , ">= 0.18.1"
-depend_on "mongo_ext", ">= 0.18.1"
+depend_on "rack"     , ">= 1.0.1"
+depend_on "mongo"    , ">= 0.18.2"
+depend_on "mongo_ext", ">= 0.18.2"

data/aa.rb

@@ -0,0 +1,22 @@
+require 'rubygems'
+require 'yaml'
+require 'json'
+
+class Fred
+  attr_accessor :blee, :duh, :zob
+  
+  def initialize( blee, duh )
+    @blee = blee
+    @duh  = duh
+    @zob  = 100
+  end  
+end
+
+f = Fred.new( 10, "Hello" )
+
+buff = f.to_yaml
+
+nf = YAML.load( buff )
+
+puts nf.inspect
+

data/fred.rb

@@ -0,0 +1,26 @@
+# tnum = 10
+# r = Array.new(tnum) do
+#   Thread.new do
+#     puts "Making request"
+#     10
+#   end
+# end.reverse.map{|t| puts t.inspect;t.join; puts t.value }
+# 
+# r.each do |res|
+#   puts "Checking request #{res}"        
+# end
+
+
+a = Array.new( 10 ) do
+  Thread.new( 20 ) do |run| 
+    puts "Blee + #{run}"
+    20
+  end
+end
+
+puts a.inspect
+
+b = a.reverse.map{ |t| t.join.value }
+
+puts "Here"
+puts b.inspect

data/lib/mongo_rack.rb

@@ -2,6 +2,8 @@ require 'rack/session/abstract/id'
 require 'mongo'
 require File.expand_path( File.join( File.dirname(__FILE__), %w[mongo_rack session_hash.rb] ) )
 require File.expand_path( File.join( File.dirname(__FILE__), %w[core_ext hash.rb] ) )
+require 'yaml'
+require 'logger'
 
 module Rack  
   module Session    
@@ -19,10 +21,13 @@ module Rack
       # :pool_timeout :: 
       #   The connection pool timeout. see mongo-ruby-driver docs for settings.
       #   Defaults to 1 sec.
+      # :logging ::
+      #   Set to true to enable logger. Default is false
       DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge \
         :server       => 'localhost:27017/mongo_session/sessions',
         :pool_size    => 1,
-        :pool_timeout => 1.0
+        :pool_timeout => 1.0,
+        :log_level    => :fatal
 
       # Initializes mongo_rack. Pass in options for default override.
       def initialize(app, options={})
@@ -31,13 +36,18 @@ module Rack
         host, port, db_name, cltn_name = parse_server_desc( @default_options[:server] )
         
         @mutex      = Mutex.new      
-        @connection = ::Mongo::Connection.new( host, port,
+        @connection = ::Mongo::Connection.new( 
+          host, 
+          port,
           :pool_size => @default_options[:pool_size],
           :timeout   => @default_options[:pool_timeout] )
         @db         = @connection.db( db_name )
         @sessions   = @db[cltn_name]
+
+        @logger = Logger.new( $stdout )
+        @logger.level = set_log_level( @default_options[:log_level] )
       end
-                    
+      
       # Fetch session with optional session id. Retrieve session from mongodb if any    
       def get_session( env, sid )
         return _get_session( env, sid ) unless env['rack.multithread']
@@ -85,35 +95,57 @@ module Rack
           raise "Invalid host:port description" unless server_desc.size == 2        
           return server_desc.first, server_desc.last.to_i, tokens[1], tokens[2]
         end
-
+        
+        # Use YAML to store session objects
+        def serialize( ses )
+          YAML::dump( ses )
+        end
+        
+        # Session object stored in YAML
+        def deserialize( buff )
+          YAML::load( buff )
+        end
+        
         # fetch session with optional session id
         def _get_session(env, sid)
+          logger.debug "Getting session info for #{sid.inspect}"
           if sid
             ses_obj = sessions.find_one( { :_id => sid } )
-            session = MongoRack::SessionHash.new( ses_obj['data'] ) if ses_obj and fresh?( ses_obj )
+            if ses_obj                       
+              logger.debug "Found session object on #{sid.inspect}"
+            else
+              logger.debug "Unable to find session object #{sid.inspect}"
+            end
+            session = MongoRack::SessionHash.new( deserialize(ses_obj['data']) ) if ses_obj and fresh?( ses_obj )
           end
     
           unless sid and session
-            env['rack.errors'].puts("Session '#{sid.inspect}' not found, initializing...") if $VERBOSE and not sid.nil?
-            session = {}
+            logger.warn "Session ID not found - #{sid.inspect} - Creating new session"
+            session = MongoRack::SessionHash.new
             sid     = generate_sid
-            ret     = sessions.save( { :_id => sid, :data => session } )
+            ret     = sessions.save( { :_id => sid, :data => serialize(session) } )
             raise "Session collision on '#{sid.inspect}'" unless ret
           end
-          session.instance_variable_set( '@old', MongoRack::SessionHash.new.merge(session) )
-          return [sid, session]        
-        rescue => boom
-          warn "#{self} is unable to find server."
-          warn $!.inspect
-          return [ nil, {} ]
+          merged = MongoRack::SessionHash.new.merge(session)
+          logger.debug "Setting old session #{merged.inspect}"          
+          session.instance_variable_set( '@old', merged )
+          return [sid, session]
+        rescue => boom          
+          logger.error "#{self} Hoy! something bad happened loading session data"
+          logger.error $!.inspect
+          boom.backtrace.each{ |l| logger.error l }          
+          return [ nil, MongoRack::SessionHash.new ]
         end
             
         # update session information with new settings
         def _set_session(env, sid, new_session, options)
+          logger.debug "Setting session #{new_session.inspect}"          
           ses_obj = sessions.find_one( { :_id => sid } )
           if ses_obj
-            session = MongoRack::SessionHash.new( ses_obj['data'] )
+            logger.debug "Found existing session for -- #{sid.inspect}"
+            session = MongoRack::SessionHash.new( deserialize( ses_obj['data'] ) )
           else
+            logger.debug "Unable to find session for -- #{sid.inspect}"
             session = MongoRack::SessionHash.new
           end
     
@@ -124,37 +156,67 @@ module Rack
             sessions.insert( {:_id => sid, :data => {} } )
           end
           old_session = new_session.instance_variable_get('@old') || MongoRack::SessionHash.new
+          logger.debug "Setting old session -- #{old_session.inspect}"          
           merged = merge_sessions( sid, old_session, new_session, session )
 
           expiry = options[:expire_after]
           expiry = expiry ? Time.now + options[:expire_after] : 0
 
           # BOZO ! Use upserts here if minor changes ?
-          sessions.save( { :_id => sid, :data => merged, :expire => expiry } )
+          logger.debug "Updating session -- #{merged.inspect}"          
+          sessions.save( { :_id => sid, :data => serialize( merged ), :expire => expiry } )
           return sid
-        rescue => boom
-          warn "#{self} is unable to find server."
-          warn $!.inspect
+        rescue => boom      
+          logger.error "#{self} Hoy! Something went wrong. Unable to persist session."
+          logger.error $!.inspect
+          boom.backtrace.each{ |l| logger.error l }
           return false
         end
 
         # merge old, new to current session state
         def merge_sessions( sid, old_s, new_s, cur={} )
           unless Hash === old_s and Hash === new_s
-            warn 'Bad old or new sessions provided.'
+            logger.error 'Bad old or new sessions provided.'
             return cur
           end
-                    
+              
           delete = old_s.keys - new_s.keys
-          warn "//@#{sid}: delete #{delete*','}" if $VERBOSE and not delete.empty?
+          logger.info "//@#{sid}: delete #{delete*','}" if not delete.empty?
           delete.each{ |k| cur.delete(k) }
 
-          update = new_s.keys.select{ |k| new_s[k] != old_s[k] }
-          warn "//@#{sid}: update #{update*','}" if $VERBOSE and not update.empty?          
-          update.each{ |k| cur[k] = new_s[k] }
+          update = new_s.keys.select do |k| 
+            logger.debug "Update #{k}-#{new_s[k] != old_s[k]}? #{new_s[k].inspect} - #{old_s[k].inspect}";
+            new_s[k] != old_s[k]
+          end
           
+          logger.info "//@#{sid}: update #{update*','}" if not update.empty?          
+          update.each{ |k| cur[k] = new_s[k] }          
           cur
         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/spec/mongo_rack_spec.rb

@@ -1,10 +1,11 @@
-require File.expand_path( File.join( File.dirname(__FILE__), %w[spec_helper] ) )
+require File.expand_path(File.join(File.dirname(__FILE__), %w[spec_helper]))
+require 'core_ext/hash'
 
 describe Rack::Session::Mongo do
   before :all do
     @session_key   = 'rack.session'
     @session_match = /#{@session_key}=[0-9a-fA-F]+;/    
-    @db_name       = 'mongo_test'
+    @db_name       = 'mongo_rack_test'
     @cltn_name     = 'sessions'
     
     @con      = Mongo::Connection.new
@@ -45,9 +46,11 @@ describe Rack::Session::Mongo do
       req    = Rack::MockRequest.new( @pool )
       res    = req.get("/", 'rack.multithread' => false )
       cookie = res["Set-Cookie"]
-      req.get("/", "HTTP_COOKIE" => cookie, 'rack.multithread' => false ).body.should == '{"counter"=>2}'
+      res = req.get("/", "HTTP_COOKIE" => cookie, 'rack.multithread' => false )
+      res.body.should == '{"counter"=>2}'
       mongo_check( res, :counter, 2 )
-      req.get("/", "HTTP_COOKIE" => cookie, 'rack.multithread' => false ).body.should == '{"counter"=>3}'
+      res = req.get("/", "HTTP_COOKIE" => cookie, 'rack.multithread' => false )
+      res.body.should == '{"counter"=>3}'
       mongo_check( res, :counter, 3 )    
     end
     
@@ -157,6 +160,7 @@ describe Rack::Session::Mongo do
       res3.body.should == '{"counter"=>4}'
     end
     
+    # BOZO !! Review...
     it "multithread: should cleanly merge sessions" do
       pending do
         @pool = Rack::Session::Mongo.new( @incrementor, :server => "localhost:27017/#{@db_name}/#{@cltn_name}", :pool_size => 10 ) 
@@ -182,7 +186,7 @@ describe Rack::Session::Mongo do
         drop_counter = proc do |env|
           env['rack.session'].delete 'counter'
           env['rack.session']['foo'] = 'bar'
-          [200, {'Content-Type'=>'text/plain'}, [env['rack.session'].inspect]]
+          [200, {'Content-Type'=>'text/plain'}, env['rack.session'].inspect]
         end
         tses = Rack::Utils::Context.new @pool, drop_counter
         treq = Rack::MockRequest.new( tses )
@@ -198,11 +202,52 @@ describe Rack::Session::Mongo do
           res.body.should include('"foo"=>"bar"')
         end
       
-        session = @pool.sessions.find_one( {:_id => sess_id } )
-        session['data'].size.should == 1
-        session['data']['counter'].should be_nil
-        session['data'].should == {"foo"=>"bar"}
+        result = @pool.sessions.find_one( {:_id => sess_id } )
+        result.should_not be_nil
+        session = YAML.load( result['data'] )
+        session.size.should == 1
+        session['counter'].should be_nil
+        session['foo'].should == 'bar'      
       end
-    end    
+    end
+  end
+
+  describe "serialization" do
+    before( :all ) do
+      @pool = Rack::Session::Mongo.new( @incrementor, :server => "localhost:27017/#{@db_name}/#{@cltn_name}" )
+      @env  = {}
+      @opts = {}
+    end
+    
+    it "should store a hash in session correctly" do
+      sid = 10
+      ses = { 'a' => 1, 'b' => 2 }
+      @pool.send(:_set_session, @env, sid, ses, @opts )
+      results = @pool.send(:_get_session, @env, sid )
+      results.last.should == ses
+    end
+    
+    it "should store an object in session correctly" do
+      sid = 11
+      fred = Fred.new( 10, "Hello" )
+      ses = { :fred => fred }
+      @pool.send(:_set_session, @env, sid, ses, @opts )
+      results = @pool.send(:_get_session, @env, sid )
+      [:fred, 'fred'].each do |key|
+        results.last[key].blee.should  == 10
+        results.last[key].duh.should   == "Hello"
+        results.last[key].zob.should   == 100
+      end
+    end
   end
+  
+  class Fred
+    attr_accessor :blee, :duh, :zob
+    def initialize( blee, duh )
+      @blee = blee
+      @duh  = duh
+      @zob  = 100
+    end
+  end
+  
 end

data/spec/session_hash_spec.rb

@@ -1,5 +1,4 @@
-require File.expand_path( File.join( File.dirname(__FILE__), %w[spec_helper] ) )
-require File.expand_path( File.join( File.dirname(__FILE__), %w[.. lib core_ext hash] ) )
+require File.expand_path(File.join(File.dirname(__FILE__), %w[spec_helper]))
 
 describe MongoRack::SessionHash do
   before :all do

data/spec/spec_helper.rb

@@ -2,6 +2,7 @@ require 'rubygems'
 require 'rack'
 require 'rack/test'
 require 'rack/response'
+require 'yaml'
 
 require File.expand_path( File.join( File.dirname(__FILE__), %w[.. lib mongo_rack] ) )
 
@@ -10,9 +11,10 @@ end
 
 def mongo_check( res, key, val )
   session_id = res['Set-Cookie'].match( /^#{@session_key}=(.*?);.*?/ )[1]
-  ses = @sessions.find_one( { :_id => session_id } )  
-  ses.should_not be_nil
-  ses['data'][key.to_s].should == val
+  result     = @sessions.find_one( { :_id => session_id } )  
+  result.should_not be_nil
+  ses       = YAML.load( result['data'] )
+  ses[key.to_s].should == val    
 end
 
 def clear_sessions

data/tasks/gem.rake

@@ -50,7 +50,7 @@ class GemPackageTask < Rake::PackageTask
     task :package => ['gem:prereqs', "#{package_dir_path}/#{gem_file}"]
     file "#{package_dir_path}/#{gem_file}" => [package_dir_path] + package_files + bones_files do
       when_writing("Creating GEM") {
-        chdir(package_dir_path) do
+        chdir(package_dir_path) do          
           Gem::Builder.new(gem_spec).build
           verbose(true) {
             mv gem_file, "../#{gem_file}"

data/tasks/rdoc.rake

@@ -1,4 +1,5 @@
 require 'rake/rdoctask'
+# require 'darkfish-rdoc'
 
 namespace :doc do
 
@@ -26,8 +27,8 @@ namespace :doc do
 
     rd.options << "-t #{title}"
     rd.options << "-SHN"
-#    rd.options << "-f"
-#    rd.options << "darkfish"    
+    rd.options << "-f"
+    # rd.options << "darkfish"    
     rd.options.concat(rdoc.opts)
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mongo_rack
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Fernand Galiana
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-05 00:00:00 -07:00
+date: 2010-02-03 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -20,7 +20,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.0.0
+        version: 1.0.1
     version: 
 - !ruby/object:Gem::Dependency 
   name: mongo
@@ -30,7 +30,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.18.1
+        version: 0.18.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: mongo_ext
@@ -40,7 +40,17 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.18.1
+        version: 0.18.2
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: bones
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.5.1
     version: 
 description: ""
 email: fernand.galiana@gmail.com
@@ -54,6 +64,8 @@ files:
 - HISTORY
 - README.rdoc
 - Rakefile
+- aa.rb
+- fred.rb
 - lib/core_ext/hash.rb
 - lib/mongo_rack.rb
 - lib/mongo_rack/session_hash.rb