rack-rewrite 1.2.1 → 1.3.0

data/Gemfile.lock

@@ -1,20 +1,20 @@
 PATH
   remote: .
   specs:
-    rack-rewrite (1.2.1)
+    rack-rewrite (1.3.0)
 
 GEM
   remote: http://rubygems.org/
   specs:
     mocha (0.9.12)
-    rack (1.2.1)
+    rack (1.4.1)
     shoulda (2.10.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.0.10)
+  bundler
   mocha (~> 0.9.7)
   rack
   rack-rewrite!

data/README.rdoc

@@ -16,21 +16,53 @@ can get away with rack-rewrite instead of writing Apache mod_rewrite rules.
   gem 'rack-rewrite', '~> 1.2.1'
   require 'rack/rewrite'
   use Rack::Rewrite do
-    rewrite '/wiki/John_Trupiano', '/john'
-    r301 '/wiki/Yair_Flicker', '/yair'
-    r302 '/wiki/Greg_Jastrab', '/greg'
-    r301 %r{/wiki/(\w+)_\w+}, '/$1'
+    rewrite   '/wiki/John_Trupiano',  '/john'
+    r301      '/wiki/Yair_Flicker',   '/yair'
+    r302      '/wiki/Greg_Jastrab',   '/greg'
+    r301      %r{/wiki/(\w+)_\w+},    '/$1'
   end
 
 === Sample usage in a rails app
 
   config.middleware.insert_before(Rack::Lock, Rack::Rewrite) do
-    rewrite '/wiki/John_Trupiano', '/john'
-    r301 '/wiki/Yair_Flicker', '/yair'
-    r302 '/wiki/Greg_Jastrab', '/greg'
-    r301 %r{/wiki/(\w+)_\w+}, '/$1'
+    rewrite   '/wiki/John_Trupiano',  '/john'
+    r301      '/wiki/Yair_Flicker',   '/yair'
+    r302      '/wiki/Greg_Jastrab',   '/greg'
+    r301      %r{/wiki/(\w+)_\w+},    '/$1'
   end
 
+== Redirection codes
+
+All +redirect+ status codes from the HTTP spec[http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html] are supported:
+
+* 301 moved permanently
+* 302 found
+* 303 see other
+* 307 temporary redirect
+
+These translate to the following methods inside the Rack::Rewrite block:
+
+  r301                '/wiki/John_Trupiano', '/john'
+  moved_permanently   '/wiki/John_Trupiano', '/john'
+  p                   '/wiki/John_Trupiano', '/john'    # shortcut alias
+  
+  r302                '/wiki/John_Trupiano', '/john'
+  found               '/wiki/John_Trupiano', '/john'
+  
+  r303                '/wiki/John_Trupiano', '/john'
+  see_other           '/wiki/John_Trupiano', '/john'
+  
+  r307                '/wiki/John_Trupiano', '/john'
+  temporary_redirect  '/wiki/John_Trupiano', '/john'
+  t                   '/wiki/John_Trupiano', '/john'    # shortcut alias
+
+The 303 and 307 codes were added to the HTTP spec to make unambiguously clear
+what clients should do with the request method. 303 means that the new request
+should always be made via GET. 307 means that the new request should use the
+same method as the original request. Status code 302 was left as it is, since
+it was already in use by the time these issues came to light. In practice it
+behaves the same as 303.
+
 == Use Cases
 
 === Rebuild of existing site in a new technology
@@ -128,11 +160,11 @@ and rewrite them as the first name only.  This is an actual catch-all rule we
 applied when we rebuilt our website in September 2009 
 ( http://www.smartlogicsolutions.com ).
 
-=== :r301, :302
+=== :r301, :r302, :r303, :r307
 
 Calls to #r301 and #r302 have the same signature as #rewrite.  The difference,
 however, is that these actually short-circuit the rack stack and send back
-301's and 302's, respectively.  See these examples:
+their respective status codes.  See these examples:
 
   r301 '/wiki/John_Trupiano', '/john'                # [1]
   r301 '/wiki/(.*)', 'http://www.google.com/?q=$1'   # [2]

data/Rakefile

@@ -1,7 +1,8 @@
 require 'rubygems'
 require 'rake'
-
 require 'rake/testtask'
+require 'rdoc/task'
+
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test' << '.'
   test.pattern = 'test/**/*_test.rb'
@@ -23,7 +24,6 @@ end
 
 task :default => :test
 
-require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
   if File.exist?('VERSION')
     version = File.read('VERSION')

data/VERSION

@@ -1 +1 @@
-1.2.1
+1.3.0

data/lib/rack/rewrite/rule.rb

@@ -27,18 +27,52 @@ module Rack
         #
         #  r301 '/wiki/John_Trupiano', '/john'
         #  r301 '/contact-us.php', '/contact-us'
+        #
+        # You can use +moved_permanently+ or just +p+ instead of +r301+.
         def r301(*args)
           add_rule :r301, *args
         end
         
+        alias :moved_permanently :r301
+        alias :p :r301
+        
         # Creates a redirect rule that will send a 302 when matching.
         #
         #  r302 '/wiki/John_Trupiano', '/john'
         #  r302 '/wiki/(.*)', 'http://www.google.com/?q=$1'
+        #
+        # You can use +found+ instead of +r302+.
         def r302(*args)
           add_rule :r302, *args
         end
         
+        alias :found :r302
+        
+        # Creates a redirect rule that will send a 303 when matching.
+        #
+        #  r303 '/wiki/John_Trupiano', '/john'
+        #  r303 '/wiki/(.*)', 'http://www.google.com/?q=$1'
+        #
+        # You can use +see_other+ instead of +r303+.
+        def r303(*args)
+          add_rule :r303, *args
+        end
+        
+        alias :see_other :r303
+        
+        # Creates a redirect rule that will send a 307 when matching.
+        #
+        #  r307 '/wiki/John_Trupiano', '/john'
+        #  r307 '/wiki/(.*)', 'http://www.google.com/?q=$1'
+        #
+        # You can use +temporary_redirect+ or +t+ instead of +r307+.
+        def r307(*args)
+          add_rule :r307, *args
+        end
+        
+        alias :temporary_redirect :r307
+        alias :t :r307
+        
         # Creates a rule that will render a file if matched.
         #
         #  send_file /*/, 'public/system/maintenance.html', 
@@ -87,6 +121,10 @@ module Rack
           [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))}.merge!(additional_headers), [redirect_message(interpreted_to)]]
+        when :r303
+          [303, {'Location' => interpreted_to, 'Content-Type' => Rack::Mime.mime_type(::File.extname(interpreted_to))}.merge!(additional_headers), [redirect_message(interpreted_to)]]
+        when :r307
+          [307, {'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

data/rack-rewrite.gemspec

@@ -3,10 +3,10 @@ Gem::Specification.new do |s|
   s.version = File.read('VERSION')
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["John Trupiano"]
+  s.authors = ["Travis Jeffery", "John Trupiano"]
   s.date = Date.today.to_s
   s.description = %q{A rack middleware for enforcing rewrite rules. In many cases you can get away with rack-rewrite instead of writing Apache mod_rewrite rules.}
-  s.email = %q{jtrupiano@gmail.com}
+  s.email = %q{travisjeffery@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
     "History.rdoc",
@@ -43,9 +43,8 @@ Gem::Specification.new do |s|
     "test/rule_test.rb",
     "test/test_helper.rb"
   ]
-  #s.add_dependency 'rack'
   
-  s.add_development_dependency 'bundler', '~> 1.0.10'
+  s.add_development_dependency 'bundler'
   s.add_development_dependency 'shoulda', '~> 2.10.2'
   s.add_development_dependency 'mocha', '~> 0.9.7'
   s.add_development_dependency 'rack'

data/test/rack-rewrite_test.rb

@@ -56,24 +56,28 @@ class RackRewriteTest < Test::Unit::TestCase
       should_not_halt
     end
     
-    context 'when a 301 rule matches' do
-      setup {
-        @rack = Rack::Rewrite.new(@app) do
-          r301 '/wiki/Yair_Flicker', '/yair'
-        end
-      }
-      should_halt
-      should_location_redirect_to('/yair', 301)
+    [301, 302, 303, 307].each do |status|
+      context "when a #{status} rule matches" do
+        setup {
+          @rack = Rack::Rewrite.new(@app) do
+            send("r#{status}", '/wiki/Yair_Flicker', '/yair')
+          end
+        }
+        should_halt
+        should_location_redirect_to('/yair', status)
+      end
     end
     
-    context 'when a 302 rule matches' do
-      setup {
-        @rack = Rack::Rewrite.new(@app) do
-          r302 '/wiki/Yair_Flicker', '/yair'
-        end
-      }
-      should_halt
-      should_location_redirect_to('/yair', 302)
+    [[:p, 301], [:moved_permanently, 301], [:found, 302], [:see_other, 303], [:t, 307], [:temporary_redirect, 307]].each do |rule|
+      context "when a #{rule.first} rule matches" do
+        setup {
+          @rack = Rack::Rewrite.new(@app) do
+            send(rule.first, '/wiki/Yair_Flicker', '/yair')
+          end
+        }
+        should_halt
+        should_location_redirect_to('/yair', rule.last)
+      end
     end
     
     context 'when a rewrite rule matches' do

data/test/rule_test.rb

@@ -34,16 +34,20 @@ class RuleTest < Test::Unit::TestCase
   end
   
   context '#Rule#apply' do
-    should 'set Location header to result of #interpret_to for a 301' do
-      rule = Rack::Rewrite::Rule.new(:r301, %r{/abc}, '/def')
-      env = {'PATH_INFO' => '/abc'}
-      assert_equal rule.send(:interpret_to, '/abc'), rule.apply!(env)[1]['Location']
+    supported_status_codes.each do |rule_type|
+      should "set Location header to result of #interpret_to for a #{rule_type}" do
+        rule = Rack::Rewrite::Rule.new(rule_type, %r{/abc}, '/def')
+        env = {'PATH_INFO' => '/abc'}
+        assert_equal rule.send(:interpret_to, '/abc'), rule.apply!(env)[1]['Location']
+      end
     end
     
-    should 'include a link to the result of #interpret_to for a 301' do
-      rule = Rack::Rewrite::Rule.new(:r301, %r{/abc}, '/def')
-      env = {'PATH_INFO' => '/abc'}
-      assert_match /\/def/, rule.apply!(env)[2][0]
+    supported_status_codes.each do |rule_type|
+      should "include a link to the result of #interpret_to for a #{rule_type}" do
+        rule = Rack::Rewrite::Rule.new(rule_type, %r{/abc}, '/def')
+        env = {'PATH_INFO' => '/abc'}
+        assert_match /\/def/, rule.apply!(env)[2][0]
+      end
     end
     
     should 'keep the QUERY_STRING when a 301 rule matches a URL with a querystring' do
@@ -71,7 +75,7 @@ class RuleTest < Test::Unit::TestCase
     end
 
     should 'set Content-Type header to text/html for a 301 and 302 request for a .html page' do
-      [:r301, :r302].each do |rule_type|
+      supported_status_codes.each do |rule_type|
         rule = Rack::Rewrite::Rule.new(rule_type, %r{/abc}, '/def.html')
         env = {'PATH_INFO' => '/abc'}
         assert_equal 'text/html', rule.apply!(env)[1]['Content-Type']
@@ -79,7 +83,7 @@ class RuleTest < Test::Unit::TestCase
     end
     
     should 'set Content-Type header to text/css for a 301 and 302 request for a .css page' do
-      [:r301, :r302].each do |rule_type|
+      supported_status_codes.each do |rule_type|
         rule = Rack::Rewrite::Rule.new(rule_type, %r{/abc}, '/def.css')
         env = {'PATH_INFO' => '/abc'}
         assert_equal 'text/css', rule.apply!(env)[1]['Content-Type']

data/test/test_helper.rb

@@ -7,3 +7,7 @@ require 'test/unit'
 
 class Test::Unit::TestCase
 end
+
+def supported_status_codes
+  [:r301, :r302, :r303, :r307]
+end

metadata

@@ -1,31 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: rack-rewrite
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
   prerelease: 
 platform: ruby
 authors:
+- Travis Jeffery
 - John Trupiano
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-20 00:00:00.000000000 -05:00
-default_executable: 
+date: 2012-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &2153125460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: 1.0.10
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153125460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &2153125000 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +38,15 @@ dependencies:
         version: 2.10.2
   type: :development
   prerelease: false
-  version_requirements: *2153125000
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.2
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &2153148840 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +54,15 @@ dependencies:
         version: 0.9.7
   type: :development
   prerelease: false
-  version_requirements: *2153148840
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.7
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &2153148460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,10 +70,15 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2153148460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 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
+email: travisjeffery@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files:
@@ -82,7 +102,6 @@ files:
 - test/rack-rewrite_test.rb
 - test/rule_test.rb
 - test/test_helper.rb
-has_rdoc: true
 homepage: http://github.com/jtrupiano/rack-rewrite
 licenses: []
 post_install_message: 
@@ -104,13 +123,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: johntrupiano
-rubygems_version: 1.6.2
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A rack middleware for enforcing rewrite rules
 test_files:
 - test/rack-rewrite_test.rb
 - test/geminstaller.yml
-- test/rack-rewrite_test.rb
 - test/rule_test.rb
 - test/test_helper.rb