tpitale-dm_session_store 0.1.0

data/README.textile

@@ -0,0 +1,46 @@
+h1. DmSessionStore
+
+h2. Description
+
+  For those using DataMapper with Rails there was no option for storing sessions
+  in a database (most people remove ActiveRecord). This little gem adds the
+  required classes to use DataMapper to store sessions in the database.
+
+h2. Installation
+
+    sudo gem install tpitale-dm_session_store
+
+h2. Usage
+
+  In Rails config/environment.rb
+
+    config.gem 'tpitale-dm_session_store, :lib => 'dm_session_store'
+    config.action_controller.session_store = CGI::Session::DMSessionStore
+
+  Obviously, for this to work, you had better follow one of the many online
+  resources for using DataMapper with Rails.
+
+h2. License
+
+  Copyright (c) 2009 Tony Pitale
+
+  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/Rakefile

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+
+require 'lib/dm_session_store/version'
+
+task :default => :test
+
+spec = Gem::Specification.new do |s|
+  s.name            = 'dm_session_store'
+  s.version         = DmSessionStore::Version.to_s
+  s.summary         = "Database session store using DataMapper in Rails"
+  s.author          = 'Tony Pitale'
+  s.email           = 'tpitale@gmail.com'
+  s.homepage        = 'http://t.pitale.com'
+  s.files           = %w(README.textile Rakefile) + Dir.glob("lib/**/*")
+  s.test_files      = Dir.glob("test/**/*_test.rb")
+  
+  s.add_dependency('dm-core', '~> 0.9.11')
+end
+
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end
+
+desc 'Generate the gemspec to serve this Gem from Github'
+task :github do
+  file = File.dirname(__FILE__) + "/#{spec.name}.gemspec"
+  File.open(file, 'w') {|f| f << spec.to_ruby }
+  puts "Created gemspec: #{file}"
+end
+
+begin
+  require 'rcov/rcovtask'
+  
+  desc "Generate RCov coverage report"
+  Rcov::RcovTask.new(:rcov) do |t|
+    t.test_files = FileList['test/**/*_test.rb']
+    t.rcov_opts << "-x lib/dm_session_store.rb -x lib/dm_session_store/version.rb"
+  end
+rescue LoadError
+  nil
+end
+
+task :default => 'test'

data/lib/dm_session_store/session_ext.rb

@@ -0,0 +1,85 @@
+require 'cgi'
+require 'cgi/session'
+require 'dm-core'
+
+class CGI
+  class Session
+    attr_reader :data
+
+    # Return this session's underlying Session instance. Useful for the DB-backed session stores.
+    def model
+      @dbman.model if @dbman
+    end
+
+    class DMSessionStore
+      class DMSession
+        include DataMapper::Resource
+
+        storage_names[:default] = 'sessions'
+
+        property :session_id, String, :size => 32, :nullable => false, :key => true
+        property :data, Object, :default => {}, :lazy => false
+        property :created_at, DateTime, :default => Proc.new { |r, p| DateTime.now }
+
+        def self.find_by_session_id(session_id)
+          first(:session_id => session_id)
+        end
+      end
+      
+      # The class used for session storage.
+      cattr_accessor :session_class
+      self.session_class = DMSession
+
+      # Find or instantiate a session given a CGI::Session.
+      def initialize(session, option = nil)
+        session_id = session.session_id
+        unless @session = @@session_class.find_by_session_id(session_id)
+          unless session.new_session
+            raise CGI::Session::NoSession, 'uninitialized session'
+          end
+          @session = @@session_class.new(:session_id => session_id, :data => {})
+        end
+      end
+
+      # Access the underlying session model.
+      def model
+        @session
+      end
+
+      # Restore session state.  The session model handles unmarshaling.
+      def restore
+        if @session
+          @session.data
+        end
+      end
+
+      # Save session store.
+      def update
+        if @session
+          @session.save
+        end
+      end
+
+      # Save and close the session store.
+      def close
+        if @session
+          update
+          @session = nil
+        end
+      end
+
+      # Delete and close the session store.
+      def delete
+        if @session
+          @session.destroy
+          @session = nil
+        end
+      end
+
+      protected
+        def logger
+          DataMapper::Logger.new(STDERR, :fatal) rescue nil
+        end
+    end
+  end
+end

data/lib/dm_session_store/version.rb

@@ -0,0 +1,13 @@
+module DmSessionStore
+  module Version
+    
+    MAJOR = 0
+    MINOR = 1
+    TINY  = 0
+    
+    def self.to_s # :nodoc:
+      [MAJOR, MINOR, TINY].join('.')
+    end
+    
+  end
+end

data/lib/dm_session_store.rb

@@ -0,0 +1,3 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'dm_session_store/session_ext'

data/test/unit/dm_session_store_test.rb

@@ -0,0 +1,62 @@
+require File.join(File.dirname(__FILE__), "..", "test_helper")
+require 'cgi'
+require 'cgi/session'
+
+class CGI
+  class Session
+
+    class DMSessionStoreTest < Test::Unit::TestCase
+      context "The DMSessionStore initialize method" do
+        should "raise CGI:Session::NoSession if session is not a new_session" do
+          DMSessionStore::DMSession.stubs(:find_by_session_id).with("1").returns(nil)
+          session = DMSessionStore::DMSession.new(:session_id => "1")
+          session.stubs(:new_session).with().returns(false)
+          assert_raise CGI::Session::NoSession, "uninitialized session" do
+            DMSessionStore.new(session)
+          end
+        end
+      end
+
+      context "An instance of the DMSessionStore class" do
+        setup do
+          @session = DMSessionStore::DMSession.new(:session_id => "1", :data => {:hello => 'world'})
+          DMSessionStore::DMSession.stubs(:find_by_session_id).with("1").returns(nil)
+          old_session = DMSessionStore::DMSession.new(:session_id => "1")
+          old_session.stubs(:new_session).with().returns(true)
+          DMSessionStore::DMSession.stubs(:new).with(:session_id => "1", :data => {}).returns(@session)
+          @session_store = DMSessionStore.new(old_session)
+        end
+
+        should "have the session" do
+          assert_equal @session, @session_store.model
+        end
+
+        should "return the data from session" do
+          assert_equal({:hello => 'world'}, @session_store.restore)
+        end
+
+        should "save the session" do
+          @session.expects(:save).with().returns(true)
+          assert_equal true, @session_store.update
+        end
+
+        should "save and unreference the session" do
+          @session_store.expects(:update)
+          @session_store.close
+          assert_equal nil, @session_store.model
+        end
+
+        should "destroy and unreference the session" do
+          @session.expects(:destroy)
+          @session_store.delete
+          assert_equal nil, @session_store.model
+        end
+
+        should "log with DataMapper" do
+          DataMapper::Logger.expects(:new).with(STDERR, :fatal).returns('logger')
+          assert_equal 'logger', @session_store.send(:logger)
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,68 @@
+--- !ruby/object:Gem::Specification 
+name: tpitale-dm_session_store
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Tony Pitale
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-05-02 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: dm-core
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.9.11
+    version: 
+description: 
+email: tpitale@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.textile
+- Rakefile
+- lib/dm_session_store
+- lib/dm_session_store/session_ext.rb
+- lib/dm_session_store/version.rb
+- lib/dm_session_store.rb
+- test/unit/dm_session_store_test.rb
+has_rdoc: false
+homepage: http://t.pitale.com
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Database session store using DataMapper in Rails
+test_files: 
+- test/unit/dm_session_store_test.rb