JunKikuchi-rack-session-stack 0.0.2

data/COPYING

@@ -0,0 +1,18 @@
+Copyright (c) 2009 Jun Kikuchi
+
+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 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,137 @@
+= rack-session-stack
+
+セッションの保存先を積み重ねられたらどうかと思ってやってみた。
+
+== Memcache から Sequel さらに RAWS::SDB へフォールバック
+
+これは 3 段重ねの極端な例です。あらかじめご了承下さい。
+
+セッション情報を書き込む場合は Memcache と Sequel, RAWS::SDB (Ruby Amazon Web Service - SimpleDB) の全てに書き込みます。
+
+セッション情報を読み込む場合は、最初に Memcache から読み込みます。データが取得出来れば Memcache のデータを使い、データが取得出来なかった場合は Sequel からデータを読み込んで使います。Sequel からデータを取得出来なかった場合は RAWS::SDB へと同様にフォールバックします。
+
+書き込みは遅いのですが、読み込みはそこそこ。
+
+  require 'rubygems'
+  require 'sinatra'
+  require 'rack-session-stack'
+
+  require 'sequel'
+  DB = Sequel.sqlite
+  DB.create_table(:session) do
+    primary_key :id
+    String :sid, :unique => true, :null => false
+    Datetime :created
+    Datetime :updated
+    column :session, File
+  end
+  
+  require 'raws'
+  RAWS.aws_access_key_id = _AWS_ACCESS_KEY_ID_
+  RAWS.aws_secret_access_key = _AWS_SECRET_ACCESS_KEY_
+  RAWS::SDB.create_domain 'session'
+  
+  use Rack::Session::Stack,
+    :stack => Rack::Session::Stack::Memcache.new(
+      {:server => 'localhost:11211'},
+      Rack::Session::Stack::Sequel.new(
+        {:dataset => DB[:session]},
+        Rack::Session::Stack::RAWS::SDB.new(
+          {:domain => 'session'}
+        )
+      )
+    )
+  
+  get '/' do
+    if session['cnt']
+      session['cnt'] += 1
+    else
+      session['cnt']  = 1
+    end
+  
+    "cnt = #{session['cnt']}"
+  end
+
+= Memcache
+
+Memcache を単体で使う場合。
+
+  require 'rubygems'
+  require 'sinatra'
+  require 'rack-session-stack'
+  
+  use Rack::Session::Stack,
+    :stack => Rack::Session::Stack::Memcache.new(
+      :server => 'localhost:11211'
+    )
+  
+  get '/' do
+    if session['cnt']
+      session['cnt'] += 1
+    else
+      session['cnt']  = 1
+    end
+  
+    "cnt = #{session['cnt']}"
+  end
+
+= Sequel
+
+Sequel を単体で使う場合。
+
+  require 'rubygems'
+  require 'sinatra'
+  require 'rack-session-stack'
+
+  require 'sequel'
+  DB = Sequel.sqlite
+  DB.create_table(:session) do
+    primary_key :id
+    String :sid, :unique => true, :null => false
+    Datetime :created
+    Datetime :updated
+    column :session, File
+  end
+  
+  use Rack::Session::Stack,
+    :stack => Rack::Session::Stack::Sequel.new(
+      {:dataset => DB[:session]},
+    )
+  
+  get '/' do
+    if session['cnt']
+      session['cnt'] += 1
+    else
+      session['cnt']  = 1
+    end
+  
+    "cnt = #{session['cnt']}"
+  end
+
+== RAWS::SDB
+
+RAWS::SDB を単体で使う場合。
+
+  require 'rubygems'
+  require 'sinatra'
+  require 'rack-session-stack'
+  
+  require 'raws'
+  RAWS.aws_access_key_id = _AWS_ACCESS_KEY_ID_
+  RAWS.aws_secret_access_key = _AWS_SECRET_ACCESS_KEY_
+  RAWS::SDB.create_domain 'session'
+  
+  use Rack::Session::Stack,
+    :stack => Rack::Session::Stack::RAWS::SDB.new(
+      :domain => 'session'
+    )
+  
+  get '/' do
+    if session['cnt']
+      session['cnt'] += 1
+    else
+      session['cnt']  = 1
+    end
+  
+    "cnt = #{session['cnt']}"
+  end

data/Rakefile

@@ -0,0 +1,29 @@
+require 'rubygems'
+require 'spec/rake/spectask'
+
+NAME = 'rack-session-stack'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name = NAME
+    s.platform = Gem::Platform::RUBY
+    s.summary = NAME
+    s.description = NAME
+    s.author = "Jun Kikuchi"
+    s.email = "kikuchi@bonnou.com"
+    s.homepage = "http://github.com/JunKikuchi/rack-session-stack"
+    s.files = %w(COPYING CHANGELOG README.rdoc Rakefile) + Dir.glob("{bin,doc,spec,lib}/**/*")
+    s.require_path = "lib"
+    s.has_rdoc = true
+    s.add_dependency('uuidtools','>= 2.0.0')
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+Spec::Rake::SpecTask.new do |t|
+  #t.spec_opts = ['-c --format specdoc']
+  t.spec_opts = ['-c']
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

data/lib/rack-session-stack.rb

@@ -0,0 +1,78 @@
+require 'rack/session/abstract/id'
+require 'uuidtools'
+
+module Rack
+  module Session
+    class Stack < Abstract::ID
+      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge(:stack => nil)
+
+      def initialize(app, options={})
+        super
+        @stack = @default_options[:stack]
+      end
+
+      def generate_sid
+        UUIDTools::UUID.random_create.to_s
+      end
+
+      def get_session(env, sid)
+        unless sid && session = @stack[sid]
+          @stack.create(sid = generate_sid, session = {})
+        end
+
+        session.instance_variable_set('@old', {}.merge(session))
+      
+        return [sid, session]
+      end
+
+      def set_session(env, sid, session, options)
+        if options[:drop]
+          @stack.delete(sid)
+          return nil
+        end
+
+        if options[:renew]
+          @stack.delete(sid)
+          @stack.create(sid = generate_sid, session)
+        else
+          old = session.instance_variable_get('@old') || {}
+          @stack[sid] = session if session != old
+        end
+
+        return sid
+      end
+
+      class Base
+        PARAMS = {}
+
+        def initialize(params={}, fallback=nil)
+          @params, @fallback = self.class::PARAMS.merge(params), fallback
+        end
+
+        def create(sid, session)
+          @fallback && @fallback.create(sid, session)
+        end
+
+        def delete(sid)
+          @fallback && @fallback.delete(sid)
+        end
+
+        def [](sid)
+          @fallback && @fallback[sid]
+        end
+
+        def []=(sid, session)
+          @fallback && (@fallback[sid] = session)
+          session
+        end
+      end
+
+      autoload :Memcache, 'rack-session-stack/memcache'
+      autoload :Sequel,   'rack-session-stack/sequel'
+
+      module RAWS
+        autoload :SDB, 'rack-session-stack/raws/sdb'
+      end
+    end
+  end
+end

data/lib/rack-session-stack/memcache.rb

@@ -0,0 +1,40 @@
+require 'memcache'
+
+class Rack::Session::Stack::Memcache < Rack::Session::Stack::Base
+  attr_reader :pool
+  PARAMS = {:server => 'localhost:11211'}
+
+  def initialize(params={}, fallback=nil)
+    super
+    @pool = ::MemCache.new(@params[:server], @params)
+    raise 'No memcache servers' unless @pool.servers.any? { |s| s.alive? }
+  end
+
+  def create(sid, session)
+    unless /^STORED/ =~ @pool.add(sid, session)
+      raise "Session collision on '#{sid.inspect}'"
+    end
+  ensure
+    super
+  end
+
+  def delete(sid)
+    @pool.delete(sid)
+  ensure
+    super
+  end
+
+  def [](sid)
+    @pool.fetch(sid) do
+      super(sid)
+    end
+  rescue
+    super(sid)
+  end
+
+  def []=(sid, session)
+    @pool.set(sid, session, 0)
+  ensure
+    super
+  end
+end

data/lib/rack-session-stack/raws/sdb.rb

@@ -0,0 +1,58 @@
+require 'raws'
+require 'time'
+
+class Rack::Session::Stack::RAWS::SDB < Rack::Session::Stack::Base
+  attr_reader :pool
+  PARAMS = {:domain => nil}
+
+  def initialize(params={}, fallback=nil)
+    super
+    @pool = ::RAWS::SDB[@params[:domain]]
+  end
+
+  def create(sid, session)
+    @pool.put(
+      sid,
+      {
+        'session' => [Marshal.dump(session)].pack('m*'),
+        'created' => Time.now.utc.iso8601,
+        'updated' => Time.now.utc.iso8601
+      },
+      'session',
+      'created',
+      'updated'
+    )
+    super
+  end
+
+  def delete(sid)
+    @pool.delete(sid)
+    super
+  end
+
+  def store(sid, session)
+    @pool.put(
+      sid,
+      {
+        'session' => [Marshal.dump(session)].pack('m*'),
+        'updated' => Time.now.utc.iso8601
+      },
+      'session',
+      'updated'
+    )
+    session
+  end
+
+  def [](sid)
+    if data = @pool.get(sid)
+      Marshal.load(data['session'].unpack("m*").first)
+    else
+      store(sid, super)
+    end
+  end
+
+  def []=(sid, session)
+    store(sid, session)
+    super
+  end
+end

data/lib/rack-session-stack/sequel.rb

@@ -0,0 +1,48 @@
+require 'sequel'
+
+class Rack::Session::Stack::Sequel < Rack::Session::Stack::Base
+  PARAMS = {:dataset => nil}
+
+  def initialize(params={}, fallback=nil)
+    super
+    @pool = @params[:dataset]
+  end
+
+  def create(sid, session)
+    @pool.insert(
+      :sid     => sid,
+      :session => [Marshal.dump(session)].pack('m*'),
+      :created => Time.now.utc,
+      :updated => Time.now.utc
+    )
+    super
+  end
+
+  def delete(sid)
+    if data = @pool.filter('sid = ?', sid).first
+      data.delete
+    end
+    super
+  end
+
+  def store(sid, session)
+    @pool.filter('sid = ?', sid).update(
+      :session => [Marshal.dump(session)].pack('m*'),
+      :updated => Time.now.utc
+    )
+    session
+  end
+
+  def [](sid)
+    if data = @pool.filter('sid = ?', sid).first
+      Marshal.load(data[:session].unpack("m*").first)
+    else
+      store(sid, super)
+    end
+  end
+
+  def []=(sid, session)
+    store(sid, session)
+    super
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: JunKikuchi-rack-session-stack
+version: !ruby/object:Gem::Version 
+  version: 0.0.2
+platform: ruby
+authors: 
+- Jun Kikuchi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-28 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: uuidtools
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0
+    version: 
+description: rack-session-stack
+email: kikuchi@bonnou.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- CHANGELOG
+- COPYING
+- README.rdoc
+- Rakefile
+- lib/rack-session-stack.rb
+- lib/rack-session-stack/memcache.rb
+- lib/rack-session-stack/raws/sdb.rb
+- lib/rack-session-stack/sequel.rb
+has_rdoc: false
+homepage: http://github.com/JunKikuchi/rack-session-stack
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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.3.5
+signing_key: 
+specification_version: 3
+summary: rack-session-stack
+test_files: []
+