rack-policy 0.3.0 → 0.4.0

data/.travis.yml

@@ -1,4 +1,9 @@
 ---
+branches:
+  only: master
+matrix:
+  allow_failures:
+        - rvm: ruby-head
 rvm:
 - 1.8.7
 - 1.9.2

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+0.4.0 (July 8, 2012)
+
+* Add helpers module to hold common rack apps extensions together with tests.
+* Add extensions loader.
+* Add view extensions for Rails 2, 3 & Sinatra.
+* Add specs for finish method to verify headers removal.
+* Add specs to test for consent token and environment variable setup.
+
 0.3.0 (June 30, 2012)
 
 * Add thread safety.

data/README.md

@@ -32,6 +32,8 @@ Rack::Policy::CookieLimiter, consent_token: 'allow_me'
 
 The very same `consent_token` is used to toggle the limiter behaviour.
 
+The `cookies_accpeted?` view helper method is automatically loaded for Rails, Sinatra & Padrino apps.
+
 ## Examples
 
 Adding `Rack::Policy::CookieLimiter` to Rack applications
@@ -43,7 +45,7 @@ Adding `Rack::Policy::CookieLimiter` to Rack applications
 require 'rack/policy'
 
 class Application < Rails::Application
-  config.middleware.use Rack::Policy::CookieLimiter, consent_token: 'rack.policy'
+  config.middleware.insert_before ActionDispatch::Cookies, Rack::Policy::CookieLimiter, consent_token: 'rack.policy'
 end
 ```
 
@@ -68,6 +70,22 @@ class CookiePolicyController < ApplicationController
 end
 ```
 
+Finally, in your view you can use helper method `cookies_accepted?` to display/toggle cookie information
+
+```ruby
+<% cookies_accepted? do %>
+  Accepted Cookies!
+<% end %>
+
+or
+
+<% if cookies_accepted? %>
+  Accepted Cookies!
+<% else %>
+  Cookies Not Accepted!
+<% end %>
+```
+
 ### Rails 2.x
 
 ```ruby
@@ -79,7 +97,7 @@ Rails::Initializer.run do |config|
 end
 ```
 
-Set and unset cookie consent in similar way to Rails 3.x example.
+Set and unset cookie consent in your controller and modify views logic in similar way to Rails 3.x example.
 
 ### Sinatra
 
@@ -101,6 +119,8 @@ get('/allow') { response.set_cookie 'rack.policy' }
 get('/deny') { response.delete_cookie 'rack.policy' }
 ```
 
+Similiar to Rails 3.x example you can use `cookies_accpeted?` helper to manage view logic related to cookie policy information.
+
 ### Padrino
 
 ```ruby
@@ -109,7 +129,7 @@ require 'padrino'
 require 'rack/policy'
 
 class MyApp < Padrino::Application
-  use Rack::Policy::CookieLimiter consent_token: 'rack.policy'
+  use Rack::Policy::CookieLimiter, consent_token: 'rack.policy'
 end
 ```
 
@@ -119,7 +139,7 @@ end
 #!/usr/bin/env rackup
 require 'rack/policy'
 
-use Rack::Policy::CookieLimiter consent_token: 'rack.policy'
+use Rack::Policy::CookieLimiter, consent_token: 'rack.policy'
 
 run lambda { |env| [200, {'Content-Type' => 'text/plain'}, "Hello, world!\n"] }
 ```

data/lib/rack/policy.rb

@@ -7,6 +7,10 @@ module Rack
 
     autoload :CookieLimiter,  'rack/policy/cookie_limiter'
     autoload :Version,        'rack/policy/version'
+    autoload :Helpers,        'rack/policy/helpers'
+
+    # Initialize Rack::Policy extensions within an application
+    require 'rack/policy/extensions'
 
   end # Policy
 end # Rack

data/lib/rack/policy/cookie_limiter.rb

@@ -12,7 +12,12 @@ module Rack
       CONSENT_TOKEN = "cookie_limiter".freeze
 
       attr_reader :app, :options
-      attr_accessor :status, :headers, :body
+
+      # The environment of the request
+      attr_reader :env
+
+      # HTTP message
+      attr_reader :status, :headers, :body
 
       # @option options [String] :consent_token
       #
@@ -33,11 +38,24 @@ module Rack
       end
 
       def call!(env)
-        self.status, self.headers, self.body = @app.call(env)
+        @env = env
         request = Rack::Request.new(env)
+        accepts?(request)
+        @status, @headers, @body = @app.call(env)
         response = Rack::Response.new body, status, headers
         clear_cookies!(request, response) unless allowed?(request)
-        finish(env)
+        finish
+      end
+
+      # Identifies the approval of cookie policy inside rack app.
+      #
+      def accepts?(request)
+        if ( request.cookies.has_key?(consent_token.to_s) )
+          @env['rack-policy.consent'] = 'true'
+        else
+          @env.delete(HTTP_COOKIE) if @env[HTTP_COOKIE]
+          @env['rack-policy.consent'] = nil
+        end
       end
 
       # Returns `false` if the cookie policy disallows cookie storage
@@ -53,7 +71,7 @@ module Rack
       end
 
       # Finish http response with proper headers
-      def finish(env)
+      def finish
         if [204, 304].include?(status.to_i) || (status.to_i / 100 == 1)
           headers.delete "Content-Length"
           headers.delete "Content-Type"
@@ -86,7 +104,6 @@ module Rack
       def clear_cookies!(request, response)
         cookies = parse_cookies
         headers.delete(SET_COOKIE)
-        request.env.delete(HTTP_COOKIE)
         revalidate_cache!
 
         cookies.merge(request.cookies).each do |key, value|

data/lib/rack/policy/extensions.rb

@@ -0,0 +1,18 @@
+# -*- encoding: utf-8 -*-
+
+# Autoload Rails extensions
+if defined?(Rails) && Rails.respond_to?(:application)
+  # Rails 3
+  require 'rack/policy/railtie'
+
+elsif defined?(Rails::Initializer)
+  # Rails 2.3
+  require 'action/view/base'
+
+  ActionView::Base.send :include, Rack::Policy::Helpers
+elsif defined?(Sinatra)
+  require 'rack/policy/sinatra'
+
+elsif defined?(Padrino)
+  require 'padrino-core'
+end

data/lib/rack/policy/helpers.rb

@@ -0,0 +1,16 @@
+# -*- encoding: utf-8 -*-
+
+module Rack
+  module Policy
+    module Helpers
+
+      def cookies_accepted?
+        return false unless request.env.has_key? 'rack-policy.consent'
+        accepted = !request.env['rack-policy.consent'].nil?
+        yield if block_given? && accepted
+        accepted
+      end
+
+    end # Helpers
+  end # Policy
+end # Rack

data/lib/rack/policy/railtie.rb

@@ -0,0 +1,11 @@
+# -*- encoding: utf-8 -*-
+
+module Rack
+  module Policy
+    class Railtie < ::Rails::Railtie
+      initializer "rack-policy.view_helpers" do |app|
+        ActionView::Base.send :include, Helpers
+      end
+    end # Railtie
+  end # Policy
+end # Rack

data/lib/rack/policy/sinatra.rb

@@ -0,0 +1,13 @@
+# -*- encoding: utf-8 -*-
+
+module Rack
+  module Policy
+    module Sinatra
+      def self.registered(app)
+        app.helpers Rack::Policy::Helpers
+      end
+    end # Sinatra
+  end # Policy
+end # Rack
+
+Sinatra.register Rack::Policy::Sinatra

data/lib/rack/policy/version.rb

@@ -2,6 +2,6 @@
 
 module Rack
   module Policy
-    VERSION = "0.3.0"
+    VERSION = "0.4.0"
   end
 end

data/spec/cookie_limiter_spec.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require File.expand_path('../spec_helper.rb', __FILE__)
 
 describe Rack::Policy::CookieLimiter do
@@ -29,6 +31,16 @@ describe Rack::Policy::CookieLimiter do
       last_response.headers['Set-Cookie'].should be_nil
     end
 
+    it 'clears all the cookies' do
+      mock_app {
+        use Rack::Policy::CookieLimiter, :consent_token => 'consent'
+        run DummyApp
+      }
+      set_cookie ["foo=1", "bar=2"]
+      request '/'
+      last_request.cookies.should == {}
+    end
+
     it 'revalidates caches' do
       mock_app {
         use Rack::Policy::CookieLimiter
@@ -59,6 +71,39 @@ describe Rack::Policy::CookieLimiter do
       get '/'
       last_response.headers['Set-Cookie'].should =~ /github.com=bot/
     end
+
+    context 'token' do
+      it 'preserves all the cookies if custom consent token present' do
+        mock_app {
+          use Rack::Policy::CookieLimiter, :consent_token => 'consent'
+          run DummyApp
+        }
+        set_cookie ["foo=1", "bar=2", "consent=true"]
+        request '/'
+        last_request.cookies.should == {'foo'=>'1', 'bar'=>'2', 'consent'=>'true'}
+      end
+    end
+  end
+
+  context 'accepts?' do
+    it "sets environment consent variable" do
+       mock_app {
+        use Rack::Policy::CookieLimiter
+        run DummyApp
+      }
+      request '/'
+      last_request.env.should have_key('rack-policy.consent')
+    end
+
+    it "assigns value for the consent variable" do
+       mock_app {
+        use Rack::Policy::CookieLimiter, :consent_token => 'consent'
+        run DummyApp
+      }
+      set_cookie ["consent=true"]
+      request '/'
+      last_request.env['rack-policy.consent'].should == 'true'
+    end
   end
 
   context 'finish response' do
@@ -70,6 +115,21 @@ describe Rack::Policy::CookieLimiter do
       head '/'
       last_response.should be_ok
     end
+
+    it "strips content headers for no content" do
+      mock_app with_status(204)
+      get '/'
+      last_response.headers['Content-Type'].should be_nil
+      last_response.headers['Content-Length'].should be_nil
+      last_response.body.should be_empty
+    end
+
+    it "strips headers for information request" do
+      mock_app with_status(102)
+      get '/'
+      last_response.headers['Content-Length'].should be_nil
+      last_response.body.should be_empty
+    end
   end
 
 end # Rack::Policy::CookieLimiter

data/spec/helpers_spec.rb

@@ -0,0 +1,49 @@
+# -*- encoding: utf-8 -*-
+
+require File.expand_path('../spec_helper.rb', __FILE__)
+
+class HelperTest
+  attr_accessor :request
+  include Rack::Policy::Helpers
+
+  def initialize
+    @request = HelperTest::Request.new
+  end
+
+  class Request
+    attr_reader :env
+    def initialize; @env = {}; end
+  end
+end
+
+describe Rack::Policy::Helpers do
+
+  let(:helper_test) { HelperTest.new }
+
+  before do
+    helper_test.request.env.stub(:has_key?).and_return true
+  end
+
+  it "guards against missing key" do
+    helper_test.request.env.stub(:has_key?).and_return false
+    helper_test.cookies_accepted?.should be_false
+  end
+
+  it "doesn't accept cookies" do
+    helper_test.request.env.stub(:[]).with('rack-policy.consent') { nil }
+    helper_test.cookies_accepted?.should be_false
+  end
+
+  it "accepts cookies" do
+    helper_test.request.env.stub(:[]).with('rack-policy.consent') { 'true' }
+    helper_test.cookies_accepted?.should be_true
+  end
+
+  it "yields to the block" do
+    helper_test.request.env.stub(:[]).with('rack-policy.consent') { 'true' }
+    block = Proc.new { 'Accepted'}
+    helper_test.should_receive(:cookies_accepted?).and_yield(&block)
+    helper_test.cookies_accepted?(&block)
+  end
+
+end # Rack::Policy::Helpers

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# -*- encoding: utf-8 -*-
+
 require 'rubygems'
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
@@ -19,12 +21,11 @@ module TestHelpers
     @app || mock_app(DummyApp)
   end
 
-  def mock_app(app=nil, &block)
+  def mock_app(app=nil, opts={}, &block)
     app = block if app.nil? and block.arity == 1
     if app
-      klass = described_class
       mock_app do
-        use klass
+        use Rack::Policy::CookieLimiter, opts
         run app
       end
     else
@@ -35,6 +36,10 @@ module TestHelpers
   def with_headers(headers)
     proc { [200, {'Content-Type' => 'text/plain' }.merge(headers), ['ok']] }
   end
+
+  def with_status(status=nil)
+    proc { [status || 200, {'Content-Type' => 'text/plain' }, ['ok']] }
+  end
 end
 
 RSpec.configure do |config|

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-policy
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-30 00:00:00.000000000 Z
+date: 2012-07-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2152543580 !ruby/object:Gem::Requirement
+  requirement: &2152743460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.1'
   type: :runtime
   prerelease: false
-  version_requirements: *2152543580
+  version_requirements: *2152743460
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &2152543140 !ruby/object:Gem::Requirement
+  requirement: &2152743000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152543140
+  version_requirements: *2152743000
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2152542560 !ruby/object:Gem::Requirement
+  requirement: &2152742320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152542560
+  version_requirements: *2152742320
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2152541880 !ruby/object:Gem::Requirement
+  requirement: &2152741600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152541880
+  version_requirements: *2152741600
 description: This is Rack middleware that makes your app compliant with the 'EU ePrivacy
   Directive'
 email:
@@ -78,9 +78,14 @@ files:
 - lib/rack-policy.rb
 - lib/rack/policy.rb
 - lib/rack/policy/cookie_limiter.rb
+- lib/rack/policy/extensions.rb
+- lib/rack/policy/helpers.rb
+- lib/rack/policy/railtie.rb
+- lib/rack/policy/sinatra.rb
 - lib/rack/policy/version.rb
 - rack-policy.gemspec
 - spec/cookie_limiter_spec.rb
+- spec/helpers_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/peter-murach/rack-policy
 licenses: []
@@ -110,4 +115,5 @@ summary: This is Rack middleware that makes your app compliant with the 'EU ePri
   stored on his machine.
 test_files:
 - spec/cookie_limiter_spec.rb
+- spec/helpers_spec.rb
 - spec/spec_helper.rb