rack-rewrite 1.1.0 → 1.2.0

data/History.rdoc

@@ -1,3 +1,7 @@
+=== 1.2.0 / 2011-09--20
+* API
+  * :headers option to send additional headers with the response
+
 === 1.1.0 / 2011-08-15
 * API
   * :host and :method option to match SERVER_NAME and REQUEST_METHOD env params.

data/README.rdoc

@@ -6,7 +6,6 @@ can get away with rack-rewrite instead of writing Apache mod_rewrite rules.
 == References
 
 * Source[http://github.com/jtrupiano/rack-rewrite]
-* Documentation[http://johntrupiano.rubyforge.org/rack-rewrite]
 * {Rack::Rewrite for Site Maintenance and Downtime}[http://blog.smartlogicsolutions.com/2009/11/16/rack-rewrite-for-site-maintenance-and-downtime/]
 * {Rack::Rewrite + Google Analytics Makes Site Transitions Seamless}[http://blog.smartlogicsolutions.com/2009/11/24/rack-rewrite-google-analytics-makes-site-transitions-seamless/]
 
@@ -14,7 +13,7 @@ can get away with rack-rewrite instead of writing Apache mod_rewrite rules.
 
 === Sample rackup file
   
-  gem 'rack-rewrite', '~> 1.0.0'
+  gem 'rack-rewrite', '~> 1.2.0'
   require 'rack/rewrite'
   use Rack::Rewrite do
     rewrite '/wiki/John_Trupiano', '/john'
@@ -24,7 +23,7 @@ can get away with rack-rewrite instead of writing Apache mod_rewrite rules.
   end
 
 === Sample usage in a rails app
-  config.gem 'rack-rewrite', '~> 1.0.0'
+  config.gem 'rack-rewrite', '~> 1.2.0'
   require 'rack/rewrite'
   config.middleware.insert_before(Rack::Lock, Rack::Rewrite) do
     rewrite '/wiki/John_Trupiano', '/john'
@@ -156,20 +155,12 @@ to be rendered instead of passing the application call up the rack stack.
     File.exists?('public/blog_offline.htm')
   }
 
-== Tips
-
-=== Keeping your querystring
-
-When rewriting a URL, you may want to keep your querystring in tact (for 
-example if you're tracking traffic sources).  You will need to include a
-capture group and substitution pattern in your rewrite rule to achieve this.
+== Options Parameter
 
-  rewrite %r{/wiki/John_Trupiano(\?.*)?}, '/john$1'
-  
-This rule will store the querystring in a capture group (via '(?.*)' ) and
-will substitute the querystring back into the rewritten URL (via $1).
+Each rewrite rule takes an optional options parameter.  The following options
+are supported.
 
-=== Matching on a host
+=== :host
 
 Using the :host option you can match requests to a specific hostname.
 
@@ -177,10 +168,17 @@ Using the :host option you can match requests to a specific hostname.
 
 This rule will only match when the hostname is "facerecognizer.com"
 
-=== Restrict rule to HTTP methods (GET, POST, PUT, DELETE, etc)
+=== :headers
+
+Using the :headers option you can set custom response headers e.g. for HTTP 
+caching instructions.
 
-In certain scenarios you will want to restrict your rules by the HTTP method
-of a given request.  rack-rewrite exposes the :method option for this purpose.
+  r301 "/features", "/facial_features", :headers => {'Cache-Control' => 'no-cache'}
+
+=== :method
+
+Using the :method option you can restrict the matching of a rule by the HTTP 
+method of a given request.
 
   # redirect GET's one way
   r301 "/players", "/current_players", :method => :get
@@ -188,18 +186,40 @@ of a given request.  rack-rewrite exposes the :method option for this purpose.
   # and redirect POST's another way
   r302 "/players", "/no_longer_available.html?message=No&longer&supported", :method => :post
 
-=== Rule Guards
+=== :if
 
-All rules support passing guards as Procs/lambdas.  Guards simply return
-true or false indicating whether the rule declaration is a match.  The
-following example demonstrates how the presence of a maintenance page
-on the filesystem can be utilized to take your site(s) offline.
+Using the :if option you can define arbitrary rule guards.  Guards are any
+object responding to #call that return true or false indicating whether the 
+rule matches.  The following example demonstrates how the presence of a 
+maintenance page on the filesystem can be utilized to take your site(s) offline.
 
   maintenance_file = File.join(RAILS_ROOT, 'public', 'system', 'maintenance.html')
   x_send_file /.*/, maintenance_file, :if => Proc.new { |rack_env| 
     File.exists?(maintenance_file)
   }
 
+=== :not
+
+Using the :not option you can negatively match against the path.  This can
+be useful when writing a regular expression match is difficult.
+
+  rewrite %r{^\/features}, '/facial_features', :not => '/features'
+
+This will not match the relative URL /features but would match /features.xml.
+
+== Tips
+
+=== Keeping your querystring
+
+When rewriting a URL, you may want to keep your querystring in tact (for 
+example if you're tracking traffic sources).  You will need to include a
+capture group and substitution pattern in your rewrite rule to achieve this.
+
+  rewrite %r{/wiki/John_Trupiano(\?.*)?}, '/john$1'
+  
+This rule will store the querystring in a capture group (via '(?.*)' ) and
+will substitute the querystring back into the rewritten URL (via $1).
+
 === Arbitrary Rewriting
 
 All rules support passing a Proc as the second argument allowing you to
@@ -212,4 +232,4 @@ received between 12AM and 8AM to an unavailable page.
   
 == Copyright
 
-Copyright (c) 2009-2010 John Trupiano. See LICENSE for details.
+Copyright (c) 2009-2011 John Trupiano. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-1.1.0
+1.2.0

data/lib/rack/rewrite/rule.rb

@@ -81,11 +81,12 @@ module Rack
       # (b) alter env as necessary and return true
       def apply!(env) #:nodoc:
         interpreted_to = self.interpret_to(env)
+        additional_headers = @options[:headers] || {}
         case self.rule_type
         when :r301
-          [301, {'Location' => interpreted_to, 'Content-Type' => Rack::Mime.mime_type(::File.extname(interpreted_to))}, [redirect_message(interpreted_to)]]
+          [301, {'Location' => interpreted_to, 'Content-Type' => Rack::Mime.mime_type(::File.extname(interpreted_to))}.merge!(additional_headers), [redirect_message(interpreted_to)]]
         when :r302
-          [302, {'Location' => interpreted_to, 'Content-Type' => Rack::Mime.mime_type(::File.extname(interpreted_to))}, [redirect_message(interpreted_to)]]
+          [302, {'Location' => interpreted_to, 'Content-Type' => Rack::Mime.mime_type(::File.extname(interpreted_to))}.merge!(additional_headers), [redirect_message(interpreted_to)]]
         when :rewrite
           # return [200, {}, {:content => env.inspect}]
           env['REQUEST_URI'] = interpreted_to
@@ -101,13 +102,13 @@ module Rack
           [200, {
             'Content-Length' => ::File.size(interpreted_to).to_s,
             'Content-Type'   => Rack::Mime.mime_type(::File.extname(interpreted_to))
-            }, [::File.read(interpreted_to)]]
+            }.merge!(additional_headers), [::File.read(interpreted_to)]]
         when :x_send_file
           [200, {
             'X-Sendfile'     => interpreted_to,
             'Content-Length' => ::File.size(interpreted_to).to_s,
             'Content-Type'   => Rack::Mime.mime_type(::File.extname(interpreted_to))
-            }, []]
+            }.merge!(additional_headers), []]
         else
           raise Exception.new("Unsupported rule: #{self.rule_type}")
         end

data/test/rule_test.rb

@@ -86,10 +86,18 @@ class RuleTest < Test::Unit::TestCase
       end      
     end
     
+    should 'set additional headers for a 301 and 302 request' do
+      [:r301, :r302].each do |rule_type|
+        rule = Rack::Rewrite::Rule.new(rule_type, %r{/abc}, '/def.css', {:headers => {'Cache-Control' => 'no-cache'}})
+        env = {'PATH_INFO' => '/abc'}
+        assert_equal 'no-cache', rule.apply!(env)[1]['Cache-Control']
+      end      
+    end
+    
     context 'Given an :x_send_file rule that matches' do
       setup do
         @file = File.join(TEST_ROOT, 'geminstaller.yml')
-        @rule = Rack::Rewrite::Rule.new(:x_send_file, /.*/, @file)
+        @rule = Rack::Rewrite::Rule.new(:x_send_file, /.*/, @file, :headers => {'Cache-Control' => 'no-cache'})
         env = {'PATH_INFO' => '/abc'}
         @response = @rule.apply!(env)
       end
@@ -110,6 +118,10 @@ class RuleTest < Test::Unit::TestCase
         assert_equal File.size(@file).to_s, @response[1]['Content-Length']
       end
       
+      should 'return additional headers' do
+        assert_equal 'no-cache', @response[1]['Cache-Control']
+      end
+      
       should 'return empty content' do
         assert_equal [], @response[2]
       end
@@ -118,7 +130,7 @@ class RuleTest < Test::Unit::TestCase
     context 'Given a :send_file rule that matches' do
       setup do
         @file = File.join(TEST_ROOT, 'geminstaller.yml')
-        @rule = Rack::Rewrite::Rule.new(:send_file, /.*/, @file)
+        @rule = Rack::Rewrite::Rule.new(:send_file, /.*/, @file, :headers => {'Cache-Control' => 'no-cache'})
         env = {'PATH_INFO' => '/abc'}
         @response = @rule.apply!(env)
       end
@@ -139,6 +151,10 @@ class RuleTest < Test::Unit::TestCase
         assert_equal File.size(@file).to_s, @response[1]['Content-Length']
       end
       
+      should 'return additional headers' do
+        assert_equal 'no-cache', @response[1]['Cache-Control']
+      end
+      
       should 'return the contents of geminstaller.yml in an array for Ruby 1.9.2 compatibility' do
         assert_equal [File.read(@file)], @response[2]
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rack-rewrite
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-08-15 00:00:00.000000000 -04:00
+date: 2011-09-20 00:00:00.000000000 -05:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2152850260 !ruby/object:Gem::Requirement
+  requirement: &2156177220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.10
   type: :development
   prerelease: false
-  version_requirements: *2152850260
+  version_requirements: *2156177220
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2152849800 !ruby/object:Gem::Requirement
+  requirement: &2156176760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 2.10.2
   type: :development
   prerelease: false
-  version_requirements: *2152849800
+  version_requirements: *2156176760
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2152849340 !ruby/object:Gem::Requirement
+  requirement: &2156200620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: 0.9.7
   type: :development
   prerelease: false
-  version_requirements: *2152849340
+  version_requirements: *2156200620
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2152848960 !ruby/object:Gem::Requirement
+  requirement: &2156200240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2152848960
+  version_requirements: *2156200240
 description: A rack middleware for enforcing rewrite rules. In many cases you can
   get away with rack-rewrite instead of writing Apache mod_rewrite rules.
 email: jtrupiano@gmail.com