panmind-sslhelper 0.8.2 → 0.9.2

data/README.md

@@ -1,5 +1,5 @@
-SSLHelper: an SSL plugin for Rails
-==================================
+SSLHelper: an SSL plugin for Rails 3
+====================================
 
 Purpose
 -------
@@ -17,7 +17,7 @@ Via RubyGems:
 
 Or via Rails Plugin:
 
-    script/plugin install git://github.com/Panmind/ssl_helper.git
+    rails plugin install git://github.com/Panmind/ssl_helper.git
 
 Usage
 -----
@@ -66,7 +66,7 @@ tests (e.g. use them in your `setup` method).
 Compatibility
 -------------
 
-Tested with Rails 2.3.8 running under Ruby 1.9.1-p378.
+Tested with Rails 3.0.3 running under Ruby 1.9.2p0
 
 
 Server configuration
@@ -74,8 +74,11 @@ Server configuration
 
 The plugin relies on the HTTPS server variable, that is set automatically by
 Rails if the `X-Forwarded-Proto` header is set to `https`. To avoid clients
-setting that header, take care to add a `proxy_set_header` in your nginx
-config file, such as:
+setting that header, take care to add the corresponding configuration for your web server.
+
+Nginx
+=====
+Set `proxy_set_header` in your nginx config file, such as:
 
     server {
       listen 80;
@@ -97,4 +100,24 @@ config file, such as:
       }
     }
 
-For Apache, you're on your own for now :-) more documentation will follow!
+
+Apache
+=====
+Set RequestHeader in your apache sites, such as:
+
+    <VirtualHost *:80>
+    
+        ...
+    
+        RequestHeader set X_FORWARDED_PROTO 'http'
+    </VirtualHost>
+
+    
+    <IfModule mod_ssl.c>
+    <VirtualHost *:443>
+    
+        ...
+    
+    	RequestHeader set X_FORWARDED_PROTO 'https'
+    </VirtualHost>
+    </IfModule>

data/Rakefile

@@ -1,7 +1,7 @@
 require 'rake'
-require 'rake/rdoctask'
+require 'rdoc/task'
 
-require 'lib/panmind/ssl_helper'
+require './lib/panmind/ssl_helper'
 
 begin
   require 'jeweler'
@@ -14,8 +14,8 @@ begin
                                'and named route counterparts (e.g. ssl_login_url) to clean up your '\
                                'view and controller code. HTTP(S) ports are configurable.'
 
-    gemspec.authors          = ['Marcello Barnaba']
-    gemspec.email            = 'vjt@openssl.it'
+    gemspec.authors          = ['Marcello Barnaba', 'Fabrizio Regini']
+    gemspec.email            = ['vjt@openssl.it', 'freegenie@gmail.com']
     gemspec.homepage         = 'http://github.com/Panmind/ssl_helper'
 
     gemspec.files            = %w( README.md Rakefile rails/init.rb ) + Dir['lib/**/*']
@@ -23,11 +23,11 @@ begin
     gemspec.has_rdoc         = true
 
     gemspec.version          = Panmind::SSLHelper::Version
-    gemspec.date             = '2010-07-31'
+    gemspec.date             = '2012-02-12'
 
     gemspec.require_path     = 'lib'
 
-    gemspec.add_dependency('rails', '>= 2.3.8')
+    gemspec.add_dependency 'rails', '~> 3.0'
   end
 rescue LoadError
   puts 'Jeweler not available. Install it with: gem install jeweler'

data/lib/panmind/ssl_helper.rb

@@ -1,6 +1,8 @@
+require 'panmind/ssl_helper/railtie' if defined? Rails
+
 module Panmind
   module SSLHelper
-    Version     = '0.8.2'
+    Version     = '0.9.2'
 
     WITH_SSL    = {:protocol => 'https'}
     WITHOUT_SSL = {:protocol => 'http' }
@@ -19,30 +21,39 @@ module Panmind
     end
 
     module Routing
-      def reload!
-        returning super do
-          helpers = create_ssl_helpers
-          return unless helpers # Not ready yet.
-
-          classes = [
-            ActionController::Base,
-            ActionController::Integration::Session,
-            ActionController::TestCase,
-
-            ActionView::Base
-          ]
-
-          # Include the helper_module into each class to patch.
-          #
-          classes.each {|k| k.instance_eval { include helpers } }
-
-          # Set the helpers as public in the AC::Integration::Session class
-          # for easy testing in the console.
-          #
-          ActionController::Integration::Session.module_eval do
-            public *helpers.instance_methods
-          end
+      def self.included(base)
+        base.instance_eval do
+          alias_method_chain :finalize!, :ssl
+        end
+      end
+
+      Classes = [
+        ActionController::Base,
+        ActionController::Integration::Session,
+        ActionController::TestCase,
+
+        ActionView::Base
+      ] if defined? Rails
+
+      def finalize_with_ssl!
+        helpers = create_ssl_helpers
+        return unless helpers # Not ready yet.
+
+        return if Classes.first.included_modules.include? helpers
+
+        # Include the helper_module into each class to patch.
+        #
+        Classes.each {|k| k.instance_eval { include helpers } }
+
+        # Set the helpers as public in the AC::Integration::Session class
+        # for easy testing in the console.
+        #
+        ActionController::Integration::Session.module_eval do
+          public *helpers.instance_methods
         end
+
+      ensure
+        finalize_without_ssl!
       end
 
       # Populates the @ssl_helpers module with ssl_ and plain_ helper
@@ -56,16 +67,16 @@ module Panmind
         return @ssl_helpers if @ssl_helpers.frozen?
 
         route_helpers =
-          if defined? ActionController::Routing::Routes.named_routes.helpers
+          if defined? Rails.application.routes.named_routes.helpers
             # This is a Private Rails API, so we check whether it's defined
             # and reject all the hash_for_*() and the *_path() helpers.
             #
-            ActionController::Routing::Routes.named_routes.helpers.
-              reject { |h| h.to_s =~ /(^hash_for)|(path$)/ }
+            Rails.application.routes.named_routes.helpers.
+              reject { |h| h =~ /^hash_for|path$/ }
           else
             # Warn the developer and fall back.
             #
-            Rails.logger.warn "SSLHelper: AC::Routing::Routes.named_routes disappeared"
+            Rails.logger.warn "SSLHelper: Rails.application.routes.named_routes.helpers disappeared"
             Rails.logger.warn "SSLHelper: falling back to filtering controller methods"
 
             ac   = ActionController::Base
@@ -135,11 +146,19 @@ module Panmind
 
       protected
         def ssl_required
-          redirect_to params.merge(WITH_SSL) unless request.ssl?
+          unless request.ssl?
+            raise SSLHelper::SSLRequired unless request.get?
+            Rails.logger.info("SSL Helper: redirecting to SSL url")
+            redirect_to params.merge(WITH_SSL)
+          end
         end
 
         def ssl_refused
-          redirect_to params.merge(WITHOUT_SSL) if request.ssl?
+          if request.ssl?
+            raise SSLHelper::SSLRefused unless request.get?
+            Rails.logger.info("SSL Helper: redirecting to non-SSL url")
+            redirect_to params.merge(WITHOUT_SSL)
+          end
         end
     end # Filters
 
@@ -175,5 +194,9 @@ module Panmind
           @request.env.update('HTTPS' => https, 'SERVER_PORT' => port)
         end
     end # TestHelpers
+
+    class SSLRequired < StandardError ; end
+    class SSLRefused <  StandardError ; end
+
   end # SSLHelper
 end # Panmind

data/lib/panmind/ssl_helper/railtie.rb

@@ -3,9 +3,19 @@ require 'panmind/ssl_helper'
 module Panmind
   module SSLHelper
 
+    if defined? Rails::Railtie
+      class Railtie < Rails::Railtie
+        initializer 'panmind.ssl_helper.insert_into_action_controller' do
+          ActiveSupport.on_load :action_controller do
+            Panmind::SSLHelper::Railtie.insert
+          end
+        end
+      end
+    end
+
     class Railtie
       def self.insert
-        ActionController::Routing::Routes.extend(Panmind::SSLHelper::Routing)
+        ActionController::Routing::RouteSet.instance_eval { include Panmind::SSLHelper::Routing }
         ActionController::Base.instance_eval { include Panmind::SSLHelper::Filters }
         ActiveSupport::TestCase.instance_eval { include Panmind::SSLHelper::TestHelpers } if Rails.env.test?
       end

data/rails/init.rb

@@ -1,2 +1,2 @@
-require 'panmind/ssl_helper/railtie'
+require 'panmind/ssl_helper'
 Panmind::SSLHelper::Railtie.insert

metadata

@@ -1,45 +1,41 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: panmind-sslhelper
-version: !ruby/object:Gem::Version 
-  prerelease: false
-  segments: 
-  - 0
-  - 8
-  - 2
-  version: 0.8.2
+version: !ruby/object:Gem::Version
+  version: 0.9.2
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Marcello Barnaba
+- Fabrizio Regini
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-08-14 00:00:00 +02:00
+date: 2012-02-12 00:00:00.000000000 +01:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: rails
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        segments: 
-        - 2
-        - 3
-        - 8
-        version: 2.3.8
+  requirement: &2160776120 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id001
-description: SSLHelper provides controller helpers to require/refuse SSL onto specific actions, test helpers to verify controller behaviours and named route counterparts (e.g. ssl_login_url) to clean up your view and controller code. HTTP(S) ports are configurable.
-email: vjt@openssl.it
+  prerelease: false
+  version_requirements: *2160776120
+description: SSLHelper provides controller helpers to require/refuse SSL onto specific
+  actions, test helpers to verify controller behaviours and named route counterparts
+  (e.g. ssl_login_url) to clean up your view and controller code. HTTP(S) ports are
+  configurable.
+email:
+- vjt@openssl.it
+- freegenie@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.md
-files: 
+files:
 - README.md
 - Rakefile
 - lib/panmind/ssl_helper.rb
@@ -48,32 +44,26 @@ files:
 has_rdoc: true
 homepage: http://github.com/Panmind/ssl_helper
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: SSL requirement filters and SSL-aware named route helpers for Rails apps
 test_files: []
-