flash_cookie_session 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+pkg/*
+*.gem
+.bundle

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in flash_cookie_session.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/Readme.rdoc

@@ -0,0 +1,76 @@
+=== Rails 3 cookie sessions can cooperate with Flash
+
+This is useful for Flash-based file uploaders (SWFUpload, Uploadify, Plupload, etc)
+
+The problem is that Rails uses cookie-based sessions to keep track of the current_user, etc. You may also have to worry about the +authenticity_token+ being passed around if you're using +protect_from_forgery+ and you'd like to avoid those pesky +InvalidAuthenticityToken+ errors.
+
+There are many, many blog posts about this: http://www.google.co.uk/search?q=rails+flash+upload
+
+I'm not sure who first figured everything out, so I won't bother trying to credit anyone. Thank you, though, kind person who figured all of this out in the first place. This gem represents a meager attempt to make this all a bit easier to deal with in Rails 3. No need for special routes, no need to manually configure FlashSessionCookieMiddleware, etc.
+
+=== Installation
+
+1) Add this gem to your Gemfile:
+
+    gem 'flash_cookie_session'
+
+2) Convince your Flash uploader to pass in the additional params necessary. This is going to be different given the Flash uploader you're using, but see the provided SWFUpload example below, and note the +post_params+ section:
+
+    var swfu = new SWFUpload({
+      debug : false,
+      flash_url : '/flash/swfupload.swf',
+      upload_url: '<%= upload_url %>',
+
+      post_params : {
+        "<%= key = Rails.application.config.session_options[:key] %>" : "<%= cookies[key] %>",
+        "<%= request_forgery_protection_token %>" : "<%= form_authenticity_token %>",
+      },
+
+      button_image_url: "/images/swfupload.png",
+      button_width: "100",
+      button_height: "100",
+      button_placeholder_id: "swfupload",
+
+      file_size_limit : "20 MB",
+      file_types : "*",
+      file_types_description : "Files",
+      file_upload_limit : 20,
+      file_queue_limit : 20,
+
+      file_queued_handler : fileQueued,
+      upload_start_handler : uploadStart,
+      upload_progress_handler : uploadProgress,
+      upload_success_handler : uploadSuccess,
+      upload_complete_handler : uploadComplete
+    });
+
+    function fileQueued(file){
+      // alert('queued');
+      this.startUpload();
+    }
+
+    function uploadStart(file){
+      // alert('start');
+    }
+
+    function uploadProgress(file, bytesLoaded, bytesTotal){
+    }
+
+    function uploadSuccess(file, serverData){
+      // alert('success');
+    }
+
+    function uploadComplete(file){
+      // alert('complete');
+      this.startUpload();
+    }
+
+With SWFUpload, the post_params are sent along with the file upload, which would be in params[:Filedata] in this example.
+
+=== Additional info
+
+This is frustrating and annoying stuff, and I'm sorry that we have to deal with it. If you have an idea about how to improve the situation or example for additional Flash uploaders, pull requests that expand on the README and/or Rails 3 gem are more than welcome.
+
+=== License
+
+Released under the MIT License: http://en.wikipedia.org/wiki/MIT_License

data/flash_cookie_session.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "flash_cookie_session/version"
+
+Gem::Specification.new do |s|
+  s.name        = "flash_cookie_session"
+  s.version     = FlashCookieSession::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Trevor Turk"]
+  s.email       = ["trevorturk@gmail.com"]
+  s.homepage    = "http://rubygems.org/gems/flash_cookie_session"
+  s.summary     = %q{Rails 3 cookie sessions can cooperate with Flash}
+  s.description = %q{Useful for Flash-based file uploaders (SWFUpload, Uploadify, Plupload, etc)}
+
+  s.rubyforge_project = "flash_cookie_session"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  
+  s.add_dependency("rails", ["~> 3.0"])
+end

data/lib/flash_cookie_session.rb

@@ -0,0 +1,3 @@
+require 'rails'
+require 'flash_cookie_session/middleware.rb'
+require 'flash_cookie_session/railtie.rb'

data/lib/flash_cookie_session/middleware.rb

@@ -0,0 +1,19 @@
+require 'rack/utils'
+
+module FlashCookieSession
+  class Middleware
+    def initialize(app, session_key = '_session_id')
+      @app = app
+      @session_key = session_key
+    end
+
+    def call(env)
+      if env['HTTP_USER_AGENT'] =~ /^(Adobe|Shockwave) Flash/
+        req = Rack::Request.new(env)
+        env['HTTP_COOKIE'] = [ @session_key, req.params[@session_key] ].join('=').freeze if req.params[@session_key]
+      end
+
+      @app.call(env)
+    end
+  end
+end

data/lib/flash_cookie_session/railtie.rb

@@ -0,0 +1,21 @@
+module FlashCookieSession
+  class Railtie < Rails::Railtie
+    initializer "flash_cookie_session.initializer" do
+
+      # Manually load the session_store config file
+      # even though this shouldn't be necessary
+      # otherwise Rails.application.config.session_options[:key] comes up nil :(
+      session_store_config = Rails.root.join('config/initializers/session_store.rb')
+
+      if session_store_config.exist?
+        require session_store_config
+      end
+
+      Rails.application.middleware.insert_before(
+        Rails.application.config.session_store,
+        "FlashCookieSession::Middleware",
+        Rails.application.config.session_options[:key]
+      )
+    end
+  end
+end

data/lib/flash_cookie_session/version.rb

@@ -0,0 +1,3 @@
+module FlashCookieSession
+  VERSION = "0.0.1"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: flash_cookie_session
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: false
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Trevor Turk
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-10-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 3
+        - 0
+        version: "3.0"
+  type: :runtime
+  version_requirements: *id001
+description: Useful for Flash-based file uploaders (SWFUpload, Uploadify, Plupload, etc)
+email: 
+- trevorturk@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Rakefile
+- Readme.rdoc
+- flash_cookie_session.gemspec
+- lib/flash_cookie_session.rb
+- lib/flash_cookie_session/middleware.rb
+- lib/flash_cookie_session/railtie.rb
+- lib/flash_cookie_session/version.rb
+has_rdoc: true
+homepage: http://rubygems.org/gems/flash_cookie_session
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+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: flash_cookie_session
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Rails 3 cookie sessions can cooperate with Flash
+test_files: []
+