foolabs-rack-flash-session 1.0.2

data/README.rdoc

@@ -0,0 +1,43 @@
+== Install
+
+ $ gem install rack-flash-session
+
+=== Rails
+
+ # config/environment.rb
+ config.gem 'rack-flash-session', :lib => 'rack/flash-session'
+ config.middleware.insert_before(ActionController::Base.session_store, 'Rack::FlashSession');
+
+=== Middleware
+
+ # add a use line to your builder
+ require 'rack/flash-session'
+ Rack::Builder.new do
+   use Rack::FlashSession
+   run MyApp.new
+ end
+
+== Options
+
+The default session key is '_session_id' but you can specify your
+own:
+
+ use Rack::FlashSession, 'sid'
+
+Or in Rails you can reference the key defined to be used as session key:
+
+ config.middleware.insert_before(ActionController::Base.session_store, 'Rack::FlashSession', config.action_controller.session[:key])
+
+Note that the session key is used for both the query parameter name
+and the cookie name.
+
+You can specify multiple session keys:
+
+ use Rack::FlashSession, 'sid', 'my_other_session_key'
+
+== Thanks to:
+
+Rob Anderton for posting Flash uploaders, Rails, cookie based
+sessions and CSRF: Rack Middleware to the rescue!
+(http://thewebfellas.com/blog/2008/12/22/flash-uploaders-rails-cookie-based-sessions-and-csrf-rack-middleware-to-the-rescue)
+on which this gem is based.

data/lib/rack/flash-session.rb

@@ -0,0 +1,21 @@
+require 'rack/utils'
+
+module Rack
+  class FlashSession
+
+    def initialize(app, *args)
+      args = ['_session_id'] if args.empty?
+      @app = app
+      @session_keys = args
+    end
+
+    def call(env)
+      if env['HTTP_USER_AGENT'] =~ /^(Adobe|Shockwave) Flash/ then
+        params = ::Rack::Request.new(env).params
+        env['HTTP_COOKIE'] = params.select{|k,v| @session_keys.include?(k)}.map{|k,v| [k, ::Rack::Utils.escape(v)].join('=')}.join(';')
+      end
+      @app.call(env)
+    end
+
+  end
+end

data/spec/flash_session_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Rack::FlashSession do
+  def app(*args)
+    Rack::Builder.new {
+      use Rack::Lint
+      use Rack::FlashSession, *args
+      run lambda {|env| [200, {'Content-Type' => 'text/html'}, ['']] }
+    }.to_app
+  end
+
+  def env_for(params = {}, options={})
+    Rack::MockRequest.env_for('', options.merge(:params => params))
+  end
+
+  def do_call(params, options, *args)
+    env = env_for(params, options)
+    app(*args).call(env)
+    Rack::Request.new(env)
+  end
+
+  context 'flash request' do
+    def request(params, *args)
+      options = {'HTTP_USER_AGENT' => 'Adobe Flash'}
+      do_call(params, options, *args)
+    end
+
+    describe 'default _session_id' do
+      subject {request({'_session_id' => '12345'})}
+      its(:cookies){should == {'_session_id' => '12345'}}
+    end
+
+    describe 'custom session id' do
+      subject {request({'my_session_id' => '12345'}, 'my_session_id')}
+      its(:cookies){should == {'my_session_id' => '12345'}}
+    end
+
+    describe 'multiple cookies' do
+      subject {request({'my_session_id' => '12345', 'my_other_session_id' => '54321'}, 'my_session_id', 'my_other_session_id')}
+      its(:cookies){should include({'my_session_id' => '12345'})}
+      its(:cookies){should include({'my_other_session_id' => '54321'})}
+      its(:cookies){should have(2).items}
+    end
+  end
+
+  context 'non flash request' do
+    def request(params, *args)
+      options = {'HTTP_USER_AGENT' => 'some browser'}
+      do_call(params, options, *args)
+    end
+
+    subject {request({'_session_id' => '12345'})}
+    its(:cookies){should be_empty}
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+
+require 'spec'
+require 'rack'
+require 'rack/mock'
+
+require 'rack/flash-session'

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification 
+name: foolabs-rack-flash-session
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 2
+  version: 1.0.2
+platform: ruby
+authors: 
+- Bart Teeuwisse
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-27 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 1
+        - 1
+        version: "1.1"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rack-test
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 13
+        segments: 
+        - 0
+        - 5
+        - 3
+        version: 0.5.3
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id004
+description: |+
+  
+  Rack::FlashSession converts a session query parameter to a cookie if the request's user agent is flash.
+  http://github.com/bartt/rack-flash-session
+  
+email: <bart.teeuwisse@thecodemill.biz>
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- lib/rack/flash-session.rb
+- README.rdoc
+- spec/flash_session_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/bartt/rack-flash-session
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rack::FlashSession converts a session query parameter to a cookie if the request's user agent is flash
+test_files: 
+- spec/flash_session_spec.rb
+- spec/spec_helper.rb