cookie_requirement 0.1.0

data/lib/cookie_requirement.rb

@@ -0,0 +1,143 @@
+require "uri"
+
+# CookieRequirement is a Rails plugin that lets you ensure that cookies are
+# enabled. Include the module in a controller, and declare the actions that
+# require cookies with the +cookies_required+ class method.
+#
+# ==Example
+#
+#   class UserController
+#
+#     include CookieRequirement
+#
+#     cookies_required :login
+#
+#     # if login is accessed without cookies, handle_cookies_disabled is
+#     # called
+#     def login
+#     end
+#
+#     def cookie_instructions
+#       # show some instructions
+#     end
+#
+#   protected
+#
+#     # override the default behavior to display instructions
+#     def handle_cookies_diabled
+#       redirect_to :action => "cookie_instructions"
+#     end
+#
+#   end
+#
+# ==How It Works
+#
+# CookieRequirement adds a before_filter to the controller in which it is
+# included. This filter checks if the invoked action requires cookies. If so,
+# it sets a test cookie and redirects to the same action, adding a query
+# parameter to indicate that a test cookie should exist. If the cookie does
+# not exist after the redirection, CookieRequirement concludes that cookies
+# are disabled and calls +handle_cookies_disabled+, which, by default, raises
+# +CookiesDisabled+.
+#
+# Note: CookieRequirement adds the before_filter when it is included.  If you
+# want other before_filters to run before CookieRequirement, declare them
+# before including CookieRequirement.
+#
+# ==Acknowledgments
+#
+# CookieRequirement is based on
+# * Blog post by James Halberg:
+#   http://jameshalberg.wordpress.com/2006/05/12/requiring-and-testing-cookies/
+# * SSL Requirement David Heinemeier Hansson:
+#   http://dev.rubyonrails.org/svn/rails/plugins/ssl_requirement/
+
+module CookieRequirement
+
+  class CookiesDisabled < StandardError
+  end
+
+  DEFAULT_TEST_COOKIE_NAME = "test_cookie"
+  DEFAULT_TEST_COOKIE_WRITTEN_PARAMETER_NAME = "tcw"
+
+  def self.included(controller)
+    controller.extend(ClassMethods)
+    controller.before_filter(:ensure_cookies)
+  end
+
+  module ClassMethods
+
+    def cookies_required( *actions )
+      write_inheritable_array( :cookies_required_actions, actions )
+    end
+  end
+
+protected
+
+  # Returns whether the invoked action has been declared to require cookies
+  # with +cookies_required+. Override to take into account other factors.
+  def cookies_required?
+    ( self.class.read_inheritable_attribute( :cookies_required_actions ) || [] ).include?( action_name.to_sym )
+  end
+
+  # Override to handle disabled cookies in another way.
+  def handle_cookies_disabled
+    raise CookiesDisabled, "Action #{self.params[ :action ]} in controller #{self.params[ :controller ]} requires cookies"
+  end
+
+  # Returns the name of the test cookie, "test_cookie" by default. Override
+  # if this name conflicts.
+  def get_test_cookie_name
+    self.class::DEFAULT_TEST_COOKIE_NAME
+  end
+
+  # Returns the name of the parameter added upon redirection to indicate that
+  # a test cookie has been written, "tcw" by default (short for test cookie
+  # written). Override if this name conflicts.
+  def get_test_cookie_written_parameter_name
+    self.class::DEFAULT_TEST_COOKIE_WRITTEN_PARAMETER_NAME
+  end
+
+private
+
+  def ensure_cookies
+    if cookies_required? && !test_cookie_exists?
+      if test_cookie_written?
+        handle_cookies_disabled
+      else
+        write_test_cookie
+        redirect_to( append_parameter_to_uri( get_full_request_uri, get_test_cookie_written_parameter_name, "1" ) )
+      end
+    end
+  end
+
+  def test_cookie_exists?
+    !cookies[ get_test_cookie_name ].nil?
+  end
+
+  def test_cookie_written?
+    !params[ get_test_cookie_written_parameter_name ].nil?
+  end
+
+  def write_test_cookie
+    cookies[ get_test_cookie_name ]  = "test"
+  end
+
+  def get_full_request_uri
+    request.protocol + request.host_with_port + request.request_uri
+  end
+
+  def append_parameter_to_uri( uri, name, value )
+    new_uri = URI.parse( uri )
+
+    if new_uri.query.nil?
+      new_uri.query = ""
+    else
+      new_uri.query << "&"
+    end
+
+    new_uri.query << URI.escape( name ) << "=" << URI.escape( value )
+    new_uri.to_s
+  end
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification 
+name: cookie_requirement
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jonah Burke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-01-01 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 2
+        - 3
+        - 0
+        version: 2.3.0
+  type: :runtime
+  version_requirements: *id002
+description: Ensure cookies are enabled in a Rails app.
+email: 
+- jonah@jonahb.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/cookie_requirement.rb
+has_rdoc: true
+homepage: http://github.com/jonahb/cookie_requirement
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ~>
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 17
+      segments: 
+      - 1
+      - 3
+      - 5
+      version: 1.3.5
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ensure cookies are enabled in a Rails app.
+test_files: []
+