riak_sessions 0.1

data/CONTRIBUTORS

@@ -0,0 +1,3 @@
+* Dan Reverri (dan@appush.com)
+* Igor Guerrero (igor@appush.com)
+* Matt Heitzenroder (matt@appush.com)

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Igor Guerrero
+
+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.md

@@ -0,0 +1,65 @@
+Riak Sessions
+=============
+
+Using [Riak][1] to store sessions in Rack based applications.
+
+Overview
+--------
+
+Lets say you are already using Riak, this awesome document-oriented Web and you
+might think of avoiding using Memcache, Pool and since you already have a 
+database, lets store it there right?, this library plugs it into Rack so you
+can use it in your Sinatra, Merb, Camping, etc.
+
+Why?
+----
+
+Because I kinda like Riak.
+
+Installing
+----------
+
+Get Riak: [http://riak.basho.com/][1]
+Get the Jiak Ruby client: [http://hg.basho.com/riak/src/tip/client_lib/jiak.rb][2]
+
+Usage
+-----
+
+Quick Sinatra app, using flash to test the sessions (included in the examples folder too):
+
+/config.ru:
+
+    require 'app'
+
+    run App
+
+/app.rb:
+
+    require 'rubygems'
+    require 'sinatra/base'
+    require 'rack-flash'
+    require 'rack_sessions'
+
+    class App < Sinatra::Base
+      use Rack::Session::Riak
+
+      use Rack::Flash
+
+      get '/' do
+        flash[:notice] = "hello!"
+        erb :index   
+      end
+    end
+
+/views/index.erb
+
+    <% if flash.has?(:notice) %>
+      <h1>Notice: <%= flash[:notice] %></h1>
+    <% end %>
+
+You can also specify options to your Riak server and port and options:
+
+    use Rack::Session::Riak, :riak_server => 'example.com', :riak_port => 8888, :options => {'w'=>'3','dw'=>'3'}
+
+[1]: http://riak.basho.com/
+[2]: http://hg.basho.com/riak/src/tip/client_lib/jiak.rb

data/example/app.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'sinatra/base'
+require 'rack-flash'
+
+require '../lib/riak_sessions'
+
+class App < Sinatra::Base
+  use Rack::Session::Riak
+
+  use Rack::Flash
+
+  get '/' do
+    flash[:notice] = "hello!"
+    erb :index   
+  end
+end

data/example/config.ru

@@ -0,0 +1,3 @@
+require 'app'
+
+run App

data/example/views/index.erb

@@ -0,0 +1,3 @@
+<% if flash.has?(:notice) %>
+  <h1>Notice: <%= flash[:notice] %></h1>
+<% end %>

data/lib/riak_sessions.rb

@@ -0,0 +1,109 @@
+require 'rack/session/abstract/id'
+require 'thread'
+require 'base64'
+require 'jiak'
+
+module Rack
+
+  # The Rack::Session::Riak uses the open source document-oriented web database Riak as a sessions backend,
+  # it uses the Jiak ruby client library: http://hg.basho.com/riak/src/tip/client_lib/jiak.rb
+  # more info about Riak: http://riak.basho.com/
+  #
+  # Examples:
+  #     use Rack::Session::Riak
+  #     will use Riak as a session handler
+
+  module Session
+    class RiakPool
+      def initialize(server, port, options)
+        @riak = JiakClient.new(server, port, '/jiak/', options)
+      end
+
+      def [](session_id)
+        get(session_id)
+      end
+
+      def get(session_id)
+        raise if session_id.nil? or session_id.empty?
+        session = @riak.fetch('rack_session', session_id)
+        data = Marshal.load(Base64.decode64(session['object']['data']))
+        return data
+      rescue JiakException => e
+        return nil
+      end
+
+      def store(session_id, data)
+        set(session_id, data)
+      end
+
+      def set(session_id, data)
+        begin
+          raise JiakException if session_id.nil?
+          session = @riak.fetch('rack_session', session_id)
+        rescue JiakException => e
+          session = {'bucket'=>'rack_session', 'key'=>session_id, 'links'=>[]}
+        end
+        session['object'] = {'data'=>Base64.encode64(Marshal.dump(data))}
+        @riak.store(session)
+        return true
+      end
+
+      def delete(session_id)
+        @riak.delete('rack_session', session_id)
+      end
+    end
+
+    class Riak < Abstract::ID
+      attr_reader :mutex, :pool
+      DEFAULT_OPTIONS = Abstract::ID::DEFAULT_OPTIONS.merge(
+        :drop         => false,
+        :riak_server  => '127.0.0.1',
+        :riak_port    => 8098,
+        :riak_options => {'w'=>'3','dw'=>'3'})
+
+      def initialize(app, options={})
+        super
+
+        @pool = RiakPool.new(@default_options[:riak_server],
+                             @default_options[:riak_port],
+                             @default_options[:riak_options])
+        @mutex = Mutex.new
+      end
+
+      def get_session(env, sid)
+        session = @pool[sid] if sid
+        @mutex.lock if env['rack.multithread']
+
+        unless sid and session
+          env['rack.errors'].puts("Session '#{sid.inspect}' not found, initializing...") if $VERBOSE and not sid.nil?
+          session = {}
+          sid = generate_sid
+          @pool.store sid, session
+        end
+
+        return [sid, session]
+      ensure
+        @mutex.unlock if env['rack.multithread']
+      end
+
+      def set_session(env, session_id, new_session, options)
+        @mutex.lock if env['rack.multithread']
+
+        if options[:renew] or options[:drop]
+          @pool.delete session_id
+          return false if options[:drop]
+          session_id = generate_sid
+          @pool.store session_id, 0
+        end
+
+        @pool.store session_id, new_session
+        return session_id
+      rescue
+        warn "#{new_session.inspect} has been lost."
+        warn $!.inspect
+      ensure
+        @mutex.unlock if env['rack.multithread']
+      end
+    end
+  end
+end

data/riak_sessions.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = 'riak_sessions'
+  s.version = '0.1'
+
+  s.authors = ['Igor Guerrero']
+  s.date = '2009-11-24'
+  s.description = "Riak sessions for Rack based application."
+  s.email = ['igor@appush.com']
+  s.homepage = 'http://appush.com'
+  s.files = ['riak_sessions.gemspec', 'CONTRIBUTORS', 'LICENSE', 'README.md', 'lib/riak_sessions.rb',
+    'example/app.rb', 'example/config.ru', 'example/views/index.erb']
+  s.summary ='Riak sessions for Rack based applications'
+
+  s.add_dependency 'rack', '>= 1.0'
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification 
+name: riak_sessions
+version: !ruby/object:Gem::Version 
+  version: "0.1"
+platform: ruby
+authors: 
+- Igor Guerrero
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-24 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "1.0"
+    version: 
+description: Riak sessions for Rack based application.
+email: 
+- igor@appush.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- riak_sessions.gemspec
+- CONTRIBUTORS
+- LICENSE
+- README.md
+- lib/riak_sessions.rb
+- example/app.rb
+- example/config.ru
+- example/views/index.erb
+has_rdoc: true
+homepage: http://appush.com
+licenses: []
+
+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.3.5
+signing_key: 
+specification_version: 3
+summary: Riak sessions for Rack based applications
+test_files: []
+