smart_cookie_store 0.0.1

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2010 Urban Hafner
+
+ 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,41 @@
+The Problem
+===========
+
+`SmartCookieStore` is a fix for the current (as of 2.3.5) Rails
+`CookieStore`. The problem with the `CookieStore` as is, is that it
+sends a `Set-Cookie` header whenever the `session` (including the `flash`)
+is accessed. This means that whenever you have a call to `flash[:notice]`
+in your layout file, a `Set-Cookie` will be sent to the client. Even if
+the session/flash is completely empty! This is problematic when you want
+to use something like Varnish. By default it doesn't cache pages that
+send a header (and rightly so).
+
+The Solution
+============
+
+This plugin adds a new `CookieStore`, the `SmartCookieStore` that checks
+if the session is empty and only sends the `Set-Cookie` header when the
+session is not empty.
+
+Usage
+=====
+
+Install as a plugin:
+
+    script/plugin install git://github.com/msales/smart_cookie_store.git
+    
+The configure your app to use the new `SmartCookieStore`:
+
+    ActionController::Base.session_store = :smart_cookie_store
+
+Compatibility
+=============
+
+This is an initial release that was only tested on Rails 2.3.5!
+
+To Do
+=====
+
+This plugin should also include a `SmartAbstractStore` that fixes the
+Rails `AbstractStore`. This is the parent class of the `ActiveRecordStore`
+which would fix its behaviour in turn. Some unit tests would be good, too ;)

data/Rakefile

@@ -0,0 +1,30 @@
+require 'rake/gempackagetask'
+
+PKG_FILES = FileList[
+  '[a-zA-Z]*',
+  'generators/**/*',
+  'lib/**/*',
+  'rails/**/*',
+  'tasks/**/*',
+  'test/**/*'
+]
+
+spec = Gem::Specification.new do |s|
+  s.name = "smart_cookie_store"
+  s.version = "0.0.1"
+  s.author = "Urban Hafner"
+  s.email = "urban@bettong.net"
+  s.homepage = "http://github.com/msales/smart_cookie_store"
+  s.platform = Gem::Platform::RUBY
+  s.summary = "Enhanced Rails CookieStore"
+  s.files = PKG_FILES.to_a
+  s.require_path = "lib"
+
+  s.has_rdoc = false
+  s.extra_rdoc_files = ["README.md"]
+end
+
+desc 'Turn this plugin into a gem.'
+Rake::GemPackageTask.new(spec) do |pkg|
+  pkg.gem_spec = spec
+end

data/lib/smart_cookie_store.rb

@@ -0,0 +1,39 @@
+class SmartCookieStore < ActionController::Session::CookieStore
+  
+  SH = ActionController::Session::AbstractStore::SessionHash
+  def call(env)
+    env[ENV_SESSION_KEY] = SH.new(self, env)
+    env[ENV_SESSION_OPTIONS_KEY] = @default_options.dup
+
+    status, headers, body = @app.call(env)
+
+    session_data = env[ENV_SESSION_KEY]
+    options = env[ENV_SESSION_OPTIONS_KEY]
+
+    if !session_data.is_a?(SH) || session_data.send(:loaded?) || options[:expire_after]
+      session_data.send(:load!) if session_data.is_a?(SH) && !session_data.send(:loaded?)
+      
+      unless session_data.keys.reject {|k| k == :session_id }.empty?
+        marshaled_session_data = marshal(session_data.to_hash)
+
+        raise CookieOverflow if marshaled_session_data.size > MAX
+
+        cookie = Hash.new
+        cookie[:value] = marshaled_session_data
+        unless options[:expire_after].nil?
+          cookie[:expires] = Time.now + options[:expire_after]
+        end
+
+        cookie = build_cookie(@key, cookie.merge(options))
+        unless headers[HTTP_SET_COOKIE].blank?
+          headers[HTTP_SET_COOKIE] << "\n#{cookie}"
+        else
+          headers[HTTP_SET_COOKIE] = cookie
+        end
+      end
+    end
+
+    [status, headers, body]
+  end
+  
+end

metadata

@@ -0,0 +1,58 @@
+--- !ruby/object:Gem::Specification 
+name: smart_cookie_store
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Urban Hafner
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-01-29 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: 
+email: urban@bettong.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+files: 
+- LICENSE
+- Rakefile
+- README.md
+- lib/smart_cookie_store.rb
+has_rdoc: true
+homepage: http://github.com/msales/smart_cookie_store
+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: Enhanced Rails CookieStore
+test_files: []
+