bartt-ssl_requirement 1.2.3 → 1.2.4

data/README

@@ -8,17 +8,17 @@ they should be redirected.
 Example:
 
     class ApplicationController < ActionController::Base
-      include SslRequirement
+      include ::SslRequirement
     end
 
     class AccountController < ApplicationController
-      ssl_required :signup, :payment 
+      ssl_required :signup, :payment
       ssl_allowed :index
-      
+
       def signup
         # Non-SSL access will be redirected to SSL
       end
-      
+
       def payment
         # Non-SSL access will be redirected to SSL
       end
@@ -31,18 +31,29 @@ Example:
         # SSL access will be redirected to non-SSL
       end
     end
-  
+
 If a majority (or all) of your actions require SSL, then use ssl_exceptions instead of ssl_required.
-You can list out the actions that you do NOT want to be SSL protected. Calling ssl_exceptions without 
-any actions listed will make ALL actions SSL protected. 
- 
+You can list out the actions that you do NOT want to be SSL protected. Calling ssl_exceptions without
+any actions listed will make ALL actions SSL protected.
+
+To allow SSL for any action  use ssl_allowed and pass in :all
+
+Example:
+
+   # This will enable SSL for any action in your application.
+   class ApplicationController < ActionController::Base
+      include ::SslRequirement
+
+      ssl_allowed :all
+    end
+
 You can overwrite the protected method ssl_required? to rely on other things
 than just the declarative specification. Say, only premium accounts get SSL.
 
-For SSL domains that differ from the domain of the redirecting site, add the 
+For SSL domains that differ from the domain of the redirecting site, add the
 following code to development.rb / test.rb / production.rb:
 
-    # Redirects to https://secure.example.com instead of the default 
+    # Redirects to https://secure.example.com instead of the default
     # https://www.example.com.
     config.after_initialize do
       SslRequirement.ssl_host = 'secure.example.com'
@@ -51,35 +62,35 @@ following code to development.rb / test.rb / production.rb:
 For non-SSL domains that differ from domain of redirecting site, add the
 following code to development.rb / test.rb / production.rb:
 
-	# Redirects to http://nonsecure.example.com instead of the default 
-	# http://www.example.com.
-	config.after_initialize do
-	  SslRequirement.non_ssl_host = 'nonsecure.example.com'
-	end
+  # Redirects to http://nonsecure.example.com instead of the default
+  # http://www.example.com.
+  config.after_initialize do
+    SslRequirement.non_ssl_host = 'nonsecure.example.com'
+  end
 
 You can also use a Proc to determine the ssl_host or non_ssl_host on the fly:
 
-	config.after_initialize do
+  config.after_initialize do
       SslRequirement.ssl_host = Proc.new do
-		'secure.example.com'
-	  end
+    'secure.example.com'
+    end
     end
 
 You are able to turn disable ssl redirects by adding the following environment configuration file:
 
     SslRequirement.disable_ssl_check = true
-  
+
 P.S.: Beware when you include the SslRequirement module. At the time of
 inclusion, it'll add the before_filter that validates the declarations. Some
 times you'll want to run other before_filters before that. They should then be
 declared ahead of including this module.
-  
+
 SSL URL Helper
 ==============
 This plugin also adds a helper a :secure option to url_for and named_routes. This property
 allows you to set a url as secure or not secure. It uses the disable_ssl_check to determine
 if the option should be ignored or not so you can develop as normal. It also
-will obey if you override SslRequirement.ssl_host or 
+will obey if you override SslRequirement.ssl_host or
 SslRequirement.non_ssl_host (see above)
 
 Here is an example of creating a secure url:
@@ -130,7 +141,7 @@ If you are using Shoulda, a few contexts and macros are provided:
         end
       end
     end
-    
+
 
 Copyright
 =========

data/Rakefile

@@ -10,9 +10,9 @@ begin
     gemspec.name = "bartt-ssl_requirement"
     gemspec.summary = "Allow controller actions to force SSL on specific parts of the site."
     gemspec.description = "SSL requirement adds a declarative way of specifying that certain actions should only be allowed to run under SSL, and if they're accessed without it, they should be redirected."
-    gemspec.email = 'bartt@vurve.com'
+    gemspec.email = 'bart@thecodemill.biz'
     gemspec.homepage = 'http://github.com/bartt/ssl_requirement'
-    gemspec.authors = ['RailsJedi', 'David Heinemeier Hansson', 'jcnetdev', 'bcurren', 'bmpercy','revo','nathany', 'bartt']
+    gemspec.authors = ['RailsJedi', 'David Heinemeier Hansson', 'jcnetdev', 'bcurren', 'bmpercy','revo','nathany', 'bartt', 'Thorben Schröder']
   end
 rescue LoadError
   puts "Jeweler not available. Install it with: gem install jeweler"

data/VERSION

@@ -1 +1 @@
-1.2.3
+1.2.4

data/bartt-ssl_requirement.gemspec

@@ -1,42 +1,40 @@
 # Generated by jeweler
 # DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
   s.name = %q{bartt-ssl_requirement}
-  s.version = "1.2.3"
+  s.version = "1.2.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["RailsJedi", "David Heinemeier Hansson", "jcnetdev", "bcurren", "bmpercy", "revo", "nathany", "bartt"]
-  s.date = %q{2010-07-28}
+  s.authors = ["RailsJedi", "David Heinemeier Hansson", "jcnetdev", "bcurren", "bmpercy", "revo", "nathany", "bartt", "Thorben Schr\303\266der"]
+  s.date = %q{2011-01-05}
   s.description = %q{SSL requirement adds a declarative way of specifying that certain actions should only be allowed to run under SSL, and if they're accessed without it, they should be redirected.}
-  s.email = %q{bartt@vurve.com}
+  s.email = %q{bart@thecodemill.biz}
   s.extra_rdoc_files = [
     "README"
   ]
   s.files = [
-    ".gitignore",
-     "README",
-     "Rakefile",
-     "VERSION",
-     "bartt-ssl_requirement.gemspec",
-     "init.rb",
-     "lib/ssl_requirement.rb",
-     "lib/url_for.rb",
-     "rails/init.rb",
-     "shoulda_macros/ssl_requirement_macros.rb",
-     "test/ssl_requirement_test.rb",
-     "test/url_for_test.rb"
+    "README",
+    "Rakefile",
+    "VERSION",
+    "bartt-ssl_requirement.gemspec",
+    "init.rb",
+    "lib/ssl_requirement.rb",
+    "lib/url_for.rb",
+    "rails/init.rb",
+    "shoulda_macros/ssl_requirement_macros.rb",
+    "test/ssl_requirement_test.rb",
+    "test/url_for_test.rb"
   ]
   s.homepage = %q{http://github.com/bartt/ssl_requirement}
-  s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{Allow controller actions to force SSL on specific parts of the site.}
   s.test_files = [
     "test/ssl_requirement_test.rb",
-     "test/url_for_test.rb"
+    "test/url_for_test.rb"
   ]
 
   if s.respond_to? :specification_version then

data/lib/ssl_requirement.rb

@@ -60,7 +60,9 @@ module SslRequirement
     def ssl_exceptions(*actions)
       write_inheritable_array(:ssl_required_except_actions, actions)
     end
-
+    
+    # To allow SSL for any action pass :all as action like this:
+    # ssl_allowed :all
     def ssl_allowed(*actions)
       write_inheritable_array(:ssl_allowed_actions, actions)
     end
@@ -80,7 +82,9 @@ module SslRequirement
   end
 
   def ssl_allowed?
-    (self.class.read_inheritable_attribute(:ssl_allowed_actions) || []).include?(action_name.to_sym)
+    allowed_actions = (self.class.read_inheritable_attribute(:ssl_allowed_actions) || [])
+    
+    allowed_actions == [:all] || allowed_actions.include?(action_name.to_sym)
   end
 
   # normal ports are the ports used when no port is specified by the user to the browser
@@ -90,12 +94,14 @@ module SslRequirement
   private
   def ensure_proper_protocol
     return true if SslRequirement.disable_ssl_check?
-    return true if ssl_allowed?
-
+    
     if ssl_required? && !request.ssl?
       redirect_to determine_redirect_url(request, true)
       flash.keep
       return false
+    elsif request.ssl? && ssl_allowed?
+      flash.keep
+      return true
     elsif request.ssl? && !ssl_required?
       redirect_to determine_redirect_url(request, false)
       flash.keep

data/test/ssl_requirement_test.rb

@@ -19,7 +19,7 @@ MSG
   end
 end
 
-require 'action_controller/test_process'
+require 'action_dispatch/testing/test_process'
 require 'test/unit'
 require "#{File.dirname(__FILE__)}/../lib/ssl_requirement"
 
@@ -32,6 +32,13 @@ ActionController::Routing::Routes.reload rescue nil
 # this first controller modifies the flash in every action so that flash
 # set in set_flash is eventually expired (see NOTE below...)
 
+ROUTES = ActionDispatch::Routing::RouteSet.new
+ROUTES.draw do
+  match ':controller(/:action(/:id(.:format)))'
+end
+ROUTES.finalize!
+
+
 class SslRequirementController < ActionController::Base
   include SslRequirement
   
@@ -60,6 +67,11 @@ class SslRequirementController < ActionController::Base
 
   def set_flash
     flash[:foo] = "bar"
+    render :nothing => true
+  end
+  
+  def self._routes
+    ROUTES
   end
 end
 
@@ -86,6 +98,9 @@ class SslExceptionController < ActionController::Base
     render :nothing => true
   end
   
+  def self._routes
+    ROUTES
+  end
 end
 
 class SslAllActionsController < ActionController::Base
@@ -97,6 +112,31 @@ class SslAllActionsController < ActionController::Base
     render :nothing => true
   end
   
+  def self._routes
+    ROUTES
+  end
+end
+
+class SslAllowAllActionsController < ActionController::Base
+  include SslRequirement
+  
+  ssl_allowed :all
+    
+  def a
+    render :nothing => true
+  end
+  
+  def b
+    render :nothing => true
+  end
+  
+  def self._routes
+    ROUTES
+  end
+end
+
+class SslAllowAllAndRequireController < SslAllowAllActionsController
+  ssl_required :a, :b
 end
 
 # NOTE: The only way I could get the flash tests to work under Rails 2.3.2
@@ -117,8 +157,11 @@ end
 #
 #       This feels a little hacky, so if anyone can improve it, please do so!
 
+
 class SslRequirementTest < ActionController::TestCase
   def setup
+    @routes = ROUTES
+    
     @controller = SslRequirementController.new
     @ssl_host_override = 'www.example.com:80443'
     @non_ssl_host_override = 'www.example.com:8080'
@@ -128,7 +171,9 @@ class SslRequirementTest < ActionController::TestCase
 
   def test_redirect_to_https_preserves_non_normal_port
     assert_not_equal "on", @request.env["HTTPS"]
+    @request.host = 'www.example.com:4567'
     @request.port = 4567
+
     get :b
     assert_response :redirect
     assert_match %r{^https://.*:4567/}, @response.headers['Location']
@@ -339,4 +384,38 @@ class SslRequirementTest < ActionController::TestCase
                  @response.headers['Location']
     SslRequirement.non_ssl_host = nil
   end
+  
+  # test allowing ssl on any action by the :all symbol
+  def test_controller_that_allows_ssl_on_all_actions_allows_requests_with_or_without_ssl_enabled
+    @controller = SslAllowAllActionsController.new
+    
+    assert_not_equal "on", @request.env["HTTPS"]
+    
+    get :a
+    assert_response :success
+    
+    get :b
+    assert_response :success
+    
+    @request.env["HTTPS"] = "on"
+    
+    get :a
+    assert_response :success
+    
+    get :b
+    assert_response :success
+  end
+  
+  def test_required_without_ssl_and_allowed_all
+    @controller = SslAllowAllAndRequireController.new
+    
+    assert_not_equal "on", @request.env["HTTPS"]
+    get :a
+    assert_response :redirect
+    assert_match %r{^https://}, @response.headers['Location']
+    get :b
+    assert_response :redirect
+    assert_match %r{^https://}, @response.headers['Location']
+  end
+  
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bartt-ssl_requirement
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: false
   segments: 
   - 1
   - 2
-  - 3
-  version: 1.2.3
+  - 4
+  version: 1.2.4
 platform: ruby
 authors: 
 - RailsJedi
@@ -18,16 +18,17 @@ authors:
 - revo
 - nathany
 - bartt
+- "Thorben Schr\xC3\xB6der"
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2010-07-28 00:00:00 -07:00
+date: 2011-01-05 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
 description: SSL requirement adds a declarative way of specifying that certain actions should only be allowed to run under SSL, and if they're accessed without it, they should be redirected.
-email: bartt@vurve.com
+email: bart@thecodemill.biz
 executables: []
 
 extensions: []
@@ -35,7 +36,6 @@ extensions: []
 extra_rdoc_files: 
 - README
 files: 
-- .gitignore
 - README
 - Rakefile
 - VERSION
@@ -52,8 +52,8 @@ homepage: http://github.com/bartt/ssl_requirement
 licenses: []
 
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
+rdoc_options: []
+
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/.gitignore

@@ -1 +0,0 @@
-*.gem