rack-secure_only 0.3.1 → 0.4.0

data/README.rdoc

@@ -43,6 +43,33 @@ This can be disabled by setting the :use_http_x_forwarded_proto option to false.
 	
 This will redirect all requests to /secure to https and all requests to /notsecure to http.
 
+=== Rack::Request
+
+When rack-secure_only is required the Rack::Request will be extended with some convenience methods
+to determine if the current request is http or https
+
+ 	require 'rack-secure_only'
+
+	run lambda { |env| 
+		req = Request.new(env)
+		
+		res_body = ""
+		
+		if req.https?
+			res_body = "You just made a request on https"
+		elsif req.http?
+			res_body = "You just made a request on http"
+		elsif req.https?(false) # do not check the HTTP_X_FORWARDED_PROTO header
+			res_body = "You just made a request on a url with scheme https"	
+		elsif req.http?(false) # do not check the HTTP_X_FORWARDED_PROTO header
+			res_body = "You just made a request on a url with scheme http, I did not check the HTTP_X_FORWARDED_PROTO header"
+		end
+		
+		res_body << " and the HTTP_X_FORWARDED_PROTO header was set to" + req.forwarded_proto
+		
+		[200, { 'Content-Type' => 'text/plain' }, res_body]
+	}
+
 == Note on Patches/Pull Requests
  
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.4.0

data/lib/rack/secure_only/request.rb

@@ -0,0 +1,38 @@
+require "rack/request"
+
+module Rack
+  
+  # The secure_only extention add some convenience methods
+  # to determin if the request is a http or a https request
+  #
+  class Request 
+   
+    # Returns true if the current url scheme is http
+    # and the HTTP_X_FORWARDED_PROTO header is not set to https
+    #
+    def http?(use_forwarded_proto=true)
+      if use_forwarded_proto
+        scheme == 'http' && forwarded_proto != 'https'
+      else
+        scheme == 'http'
+      end
+    end
+
+    # Returns true if the current url scheme is https or 
+    # the HTTP_X_FORWARDED_PROTO header is set to https
+    #    
+    def https?(use_forwarded_proto=true)
+      if use_forwarded_proto
+        scheme == 'https' || forwarded_proto == 'https'
+      else
+        scheme == 'https'
+      end
+    end
+    
+    # @return [String] the value of the HTTP_X_FORWARDED_PROTO header
+    #
+    def forwarded_proto
+      @env['HTTP_X_FORWARDED_PROTO']
+    end
+  end
+end

data/lib/rack/secure_only.rb

@@ -1,4 +1,5 @@
 require "rack"
+require "rack/secure_only/request"
 
 module Rack
   
@@ -13,45 +14,33 @@ module Rack
   #
   # @param [Hash] opts options for redirect rules
   # @option opts [Boolean] :secure If set to false will redirect https to http, defaults to true
-  # @option opts [Fixnum] :status_code Status code to redirect with, defaults to 301
+  # @option opts [Fixnum]  :status_code Status code to redirect with, defaults to 301
   # @option opts [Boolean] :use_http_x_forwarded_proto When set to false will not check for HTTP_X_FORWARDED_PROTO header
-  # @option opts [String] :redirect_to When set will use the provided url to redirect to
+  # @option opts [String]  :redirect_to When set will use the provided url to redirect to
   #
   class SecureOnly
     def initialize(app, opts={})
-      opts    = { :secure => true, :status_code => 301, :redirect_to => nil, :use_http_x_forwarded_proto => true }.merge(opts)
       @app    = app
-      
-      @secure               = opts[:secure]
-      @redirect_status_code = opts[:status_code]
-      @redirect_to          = opts[:redirect_to]
-      @use_http_x_forward  = !!opts[:use_http_x_forwarded_proto]
+      @opts    = { 
+                  :secure => true, 
+                  :status_code => 301, 
+                  :redirect_to => nil, 
+                  :use_http_x_forwarded_proto => true 
+                  }.merge(opts)      
     end
     
     def call(env)
       should_redirect, to_path = redirect?(env)
-      return [@redirect_status_code, { 'Content-Type'  => 'text/plain', 'Location' => to_path }, ["Redirect"]] if should_redirect
+      if should_redirect
+        return [@opts[:status_code], { 'Content-Type'  => 'text/plain', 'Location' => to_path }, ["Redirect"]]
+      end
       @app.call(env)
     end
     
-    # Returns true if the current url scheme is http
-    # and the HTTP_X_FORWARDED_PROTO header is not set to https
-    # 
-    def on_http?(env)
-      ( env['rack.url_scheme'] == 'http' && ( use_x_forward? ? env['HTTP_X_FORWARDED_PROTO'] != 'https' : true ) )
-    end
-    
-    # Returns true if the current url scheme is https or 
-    # the HTTP_X_FORWARDED_PROTO header is set to https
-    # 
-    def on_https?(env)
-      ( env['rack.url_scheme'] == 'https' || ( use_x_forward? ? env['HTTP_X_FORWARDED_PROTO'] == 'https' : false ) )
-    end
-    
     # Boolean accesor for :secure
     #  
     def secure?
-      !!@secure
+      !!@opts[:secure]
     end
 
     # Inversed boolean accesor for :secure
@@ -64,18 +53,14 @@ module Rack
     
     def redirect?(env)
       req = Request.new(env)
-      url = @redirect_to || req.url
-      if secure? && on_http?(env)
+      url = @opts[:redirect_to] || req.url
+      if secure? && req.http?(@opts[:use_http_x_forwarded_proto])
         return [true, url.gsub(/^http:/,'https:')]
-      elsif not_secure? && on_https?(env)
+      elsif not_secure? && req.https?(@opts[:use_http_x_forwarded_proto])
         return [true, url.gsub(/^https:/,'http:')]
       else
         return [false, req.url]
       end
     end
-    
-    def use_x_forward?
-      @use_http_x_forward
-    end
   end
 end

data/rack-secure_only.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{rack-secure_only}
-  s.version = "0.3.1"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Klaas Speller"]
-  s.date = %q{2010-05-22}
+  s.date = %q{2010-05-23}
   s.description = %q{Redirect http to https and the other way around}
   s.email = %q{klaasspeller@gmail.com}
   s.extra_rdoc_files = [
@@ -25,7 +25,9 @@ Gem::Specification.new do |s|
      "VERSION",
      "lib/rack-secure_only.rb",
      "lib/rack/secure_only.rb",
+     "lib/rack/secure_only/request.rb",
      "rack-secure_only.gemspec",
+     "spec/rack/secure_only/request_spec.rb",
      "spec/rack/secure_only_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"
@@ -36,7 +38,8 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.6}
   s.summary = %q{Redirect http to https and the other way around}
   s.test_files = [
-    "spec/rack/secure_only_spec.rb",
+    "spec/rack/secure_only/request_spec.rb",
+     "spec/rack/secure_only_spec.rb",
      "spec/spec_helper.rb"
   ]
 

data/spec/rack/secure_only/request_spec.rb

@@ -0,0 +1,100 @@
+require File.join(File.dirname(__FILE__), '..', '..', 'spec_helper')
+
+require "rack/secure_only/request"
+require 'rack/mock'
+
+describe Rack::Request do
+  describe "when rack/secure_only/request is required" do
+    before(:each) do
+      @req = Rack::Request.new(Rack::MockRequest.env_for("http://example.com/"))
+    end
+    
+    it "should respond to http?" do
+      @req.should respond_to :http?
+    end
+    
+    it "should respond to https?" do
+      @req.should respond_to :https?      
+    end
+    
+    it "should respond to forwarded_proto" do
+      @req.should respond_to :forwarded_proto
+    end
+  end
+  
+  context "with request http://example.com/" do
+    before(:each) do
+      @req = Rack::Request.new(Rack::MockRequest.env_for("http://example.com/"))
+    end
+    
+    it "#http? should return true" do
+      @req.should be_http
+    end
+    
+    it "#https? should return false" do
+      @req.should_not be_https
+    end
+  end
+  
+  context "with request https://example.com/" do
+    before(:each) do
+      @req = Rack::Request.new(Rack::MockRequest.env_for("https://example.com/"))
+    end
+    
+    it "#http? should return false" do
+      @req.should_not be_http
+    end
+    
+    it "#https? should return true" do
+      @req.should be_https
+    end
+  end
+  
+  context "with request http://example.com/ and HTTP_X_FORWARDED_PROTO set to https" do
+    before(:each) do
+      @req = Rack::Request.new(Rack::MockRequest.env_for("http://example.com/", { 'HTTP_X_FORWARDED_PROTO' => 'https' }))
+    end
+    
+    it "#http? should return false" do
+      @req.should_not be_http
+    end
+    
+    it "#https? should return true" do
+      @req.should be_https
+    end
+    
+    context "and use_forwarded_proto set to false" do      
+      it "#http? should return true" do
+        @req.http?(false).should == true
+      end
+
+      it "#https? should return false" do
+        @req.https?(false).should == false
+      end
+    end
+  end
+  
+  context "with request https://example.com/ and HTTP_X_FORWARDED_PROTO set to https" do
+    before(:each) do
+      @req = Rack::Request.new(Rack::MockRequest.env_for("https://example.com/", { 'HTTP_X_FORWARDED_PROTO' => 'https' }))
+    end
+    
+    it "#http? should return false" do
+      @req.should_not be_http
+    end
+    
+    it "#https? should return true" do
+      @req.should be_https
+    end
+    
+    context "and use_forwarded_proto set to false" do      
+      it "#http? should return false" do
+        @req.http?(false).should == false
+      end
+
+      it "#https? should return true" do
+        @req.https?(false).should == true
+      end
+    end
+  end
+end

data/spec/rack/secure_only_spec.rb

@@ -37,7 +37,7 @@ describe Rack::SecureOnly do
 
       describe "with HTTP_X_FORWARDED_PROTO header set to https (like with heroku ssl)" do
         before(:each) do
-          @response = @request.get('http://www.example.com/secure', { 'HTTP_X_FORWARDED_PROTO' => 'https' })
+          @response = @request.get('https://www.example.com/secure', { 'HTTP_X_FORWARDED_PROTO' => 'https' })
         end
 
         it "should do no redirect" do
@@ -136,7 +136,7 @@ describe Rack::SecureOnly do
           @response = @request.get('http://www.example.com/notsecure', { 'HTTP_X_FORWARDED_PROTO' => 'https' })
         end
 
-        it "should do redirect" do
+        it "should do no redirect" do
           @response.location.should == "http://www.example.com/notsecure"
         end
       end

metadata

@@ -4,9 +4,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 3
-  - 1
-  version: 0.3.1
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Klaas Speller
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-22 00:00:00 +02:00
+date: 2010-05-23 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -77,7 +77,9 @@ files:
 - VERSION
 - lib/rack-secure_only.rb
 - lib/rack/secure_only.rb
+- lib/rack/secure_only/request.rb
 - rack-secure_only.gemspec
+- spec/rack/secure_only/request_spec.rb
 - spec/rack/secure_only_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
@@ -112,5 +114,6 @@ signing_key:
 specification_version: 3
 summary: Redirect http to https and the other way around
 test_files: 
+- spec/rack/secure_only/request_spec.rb
 - spec/rack/secure_only_spec.rb
 - spec/spec_helper.rb