rack-rewrite 1.0.2 → 1.1.0

data/Gemfile

@@ -0,0 +1,3 @@
+source "http://rubygems.org"
+
+gemspec

data/Gemfile.lock

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

data/History.rdoc

@@ -1,3 +1,10 @@
+=== 1.1.0 / 2011-08-15
+* API
+  * :host and :method option to match SERVER_NAME and REQUEST_METHOD env params.
+  * :not option to negative match against path.
+* Maintenance
+  * Refactored internals a bit.
+
 === 1.0.2 / 2010-10-01
 * Maintenance
   * :send_file rules return content in an Array for Ruby 1.9.2 compatibility

data/README.rdoc

@@ -169,6 +169,25 @@ capture group and substitution pattern in your rewrite rule to achieve this.
 This rule will store the querystring in a capture group (via '(?.*)' ) and
 will substitute the querystring back into the rewritten URL (via $1).
 
+=== Matching on a host
+
+Using the :host option you can match requests to a specific hostname.
+
+  r301 "/features", "/facial_features", :host => "facerecognizer.com"
+
+This rule will only match when the hostname is "facerecognizer.com"
+
+=== Restrict rule to HTTP methods (GET, POST, PUT, DELETE, etc)
+
+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.
+
+  # redirect GET's one way
+  r301 "/players", "/current_players", :method => :get
+
+  # and redirect POST's another way
+  r302 "/players", "/no_longer_available.html?message=No&longer&supported", :method => :post
+
 === Rule Guards
 
 All rules support passing guards as Procs/lambdas.  Guards simply return

data/VERSION

@@ -0,0 +1 @@
+1.1.0

data/lib/rack/rewrite.rb

@@ -1,6 +1,7 @@
-require 'rack/rewrite/rule'
-
 module Rack
+  autoload :RuleSet, 'rack/rewrite/rule'
+  autoload :VERSION, 'rack/rewrite/version'
+  
   # A rack middleware for defining and applying rewrite rules. In many cases you 
   # can get away with rack-rewrite instead of writing Apache mod_rewrite rules.  
   class Rewrite

data/lib/rack/rewrite/rule.rb

@@ -19,36 +19,32 @@ module Rack
         #  rewrite '/wiki/John_Trupiano', '/john'
         #  rewrite %r{/wiki/(\w+)_\w+}, '/$1'
         #  rewrite %r{(.*)}, '/maintenance.html', :if => lambda { File.exists?('maintenance.html') }
-        def rewrite(from, to, *args)
-          options = args.last.is_a?(Hash) ? args.last : {}
-          @rules << Rule.new(:rewrite, from, to, options[:if])
+        def rewrite(*args)
+          add_rule :rewrite, *args
         end
         
         # Creates a redirect rule that will send a 301 when matching.
         #
         #  r301 '/wiki/John_Trupiano', '/john'
         #  r301 '/contact-us.php', '/contact-us'
-        def r301(from, to, *args)
-          options = args.last.is_a?(Hash) ? args.last : {}
-          @rules << Rule.new(:r301, from, to, options[:if])
+        def r301(*args)
+          add_rule :r301, *args
         end
         
         # Creates a redirect rule that will send a 302 when matching.
         #
         #  r302 '/wiki/John_Trupiano', '/john'
         #  r302 '/wiki/(.*)', 'http://www.google.com/?q=$1'
-        def r302(from, to, *args)
-          options = args.last.is_a?(Hash) ? args.last : {}
-          @rules << Rule.new(:r302, from, to, options[:if])
+        def r302(*args)
+          add_rule :r302, *args
         end
         
         # Creates a rule that will render a file if matched.
         #
         #  send_file /*/, 'public/system/maintenance.html', 
         #    :if => Proc.new { File.exists?('public/system/maintenance.html') }
-        def send_file(from, to, *args)
-          options = args.last.is_a?(Hash) ? args.last : {}
-          @rules << Rule.new(:send_file, from, to, options[:if])          
+        def send_file(*args)
+          add_rule :send_file, *args
         end
         
         # Creates a rule that will render a file using x-send-file
@@ -56,29 +52,29 @@ module Rack
         #
         #  x_send_file /*/, 'public/system/maintenance.html', 
         #    :if => Proc.new { File.exists?('public/system/maintenance.html') }
-        def x_send_file(from, to, *args)
-          options = args.last.is_a?(Hash) ? args.last : {}
-          @rules << Rule.new(:x_send_file, from, to, options[:if])
-        end        
+        def x_send_file(*args)
+          add_rule :x_send_file, *args
+        end
+        
+      private
+        def add_rule(method, from, to, options = {}) #:nodoc:
+          @rules << Rule.new(method.to_sym, from, to, options)
+        end
+        
     end
 
     # TODO: Break rules into subclasses
     class Rule #:nodoc:
-      attr_reader :rule_type, :from, :to, :guard
-      def initialize(rule_type, from, to, guard=nil) #:nodoc:
-        @rule_type, @from, @to, @guard = rule_type, from, to, guard
+      attr_reader :rule_type, :from, :to, :options
+      def initialize(rule_type, from, to, options={}) #:nodoc:
+        @rule_type, @from, @to, @options = rule_type, from, to, normalize_options(options)
       end
 
       def matches?(rack_env) #:nodoc:
-        return false if !guard.nil? && !guard.call(rack_env)
+        return false if options[:if].respond_to?(:call) && !options[:if].call(rack_env)
         path = build_path_from_env(rack_env)
-        if self.is_a_regexp?(self.from)
-          path =~ self.from
-        elsif self.from.is_a?(String)
-          path == self.from
-        else
-          false
-        end
+        
+        self.match_options?(rack_env) && string_matches?(path, self.from)
       end
 
       # Either (a) return a Rack response (short-circuiting the Rack stack), or
@@ -128,8 +124,27 @@ module Rack
         def is_a_regexp?(obj)
           obj.is_a?(Regexp) || (Object.const_defined?(:Oniguruma) && obj.is_a?(Oniguruma::ORegexp))
         end
-
+        
+        def match_options?(env, path = build_path_from_env(env))
+          matches = []
+          
+          # negative matches
+          matches << !string_matches?(path, options[:not]) if options[:not]
+          
+          # possitive matches
+          matches << string_matches?(env['REQUEST_METHOD'], options[:method]) if options[:method]
+          matches << string_matches?(env['SERVER_NAME'], options[:host]) if options[:host]
+          
+          matches.all?
+        end
+        
       private
+        def normalize_options(arg)
+          options = arg.respond_to?(:call) ? {:if => arg} : arg
+          options.symbolize_keys! if options.respond_to? :symbolize_keys!
+          options.freeze
+        end
+      
         def interpret_to_proc(path, env)
           return self.to.call(match(path), env) if self.from.is_a?(Regexp)
           self.to.call(self.from, env)
@@ -142,6 +157,16 @@ module Rack
         def match(path) 
           self.from.match(path)
         end
+        
+        def string_matches?(string, matcher)
+          if self.is_a_regexp?(matcher)
+            string =~ matcher
+          elsif matcher.is_a?(String)
+            string == matcher
+          else
+            false
+          end
+        end
 
         def computed_to(path)
           # is there a better way to do this?

data/lib/rack/rewrite/version.rb

@@ -0,0 +1,5 @@
+module Rack
+  class Rewrite
+    VERSION = File.read File.join(File.expand_path("..", __FILE__), "..", "..", "..", "VERSION")
+  end
+end

data/rack-rewrite.gemspec

@@ -1,10 +1,10 @@
 Gem::Specification.new do |s|
-  s.name = %q{rack-rewrite}
-  s.version = "1.0.2"
+  s.name = 'rack-rewrite'
+  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.date = %q{2010-10-01}
+  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.extra_rdoc_files = [
@@ -13,16 +13,17 @@ Gem::Specification.new do |s|
     "README.rdoc"
   ]
   s.files = [
-    ".document",
-    ".gitignore",
     "History.rdoc",
     "LICENSE",
     "README.rdoc",
     "Rakefile",
-    "RELEASING",
+    "VERSION",
+    "Gemfile",
+    "Gemfile.lock",
     "lib/rack-rewrite.rb",
     "lib/rack/rewrite.rb",
     "lib/rack/rewrite/rule.rb",
+    "lib/rack/rewrite/version.rb",
     "rack-rewrite.gemspec",
     "test/geminstaller.yml",
     "test/rack-rewrite_test.rb",
@@ -36,11 +37,19 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.7}
   s.summary = %q{A rack middleware for enforcing rewrite rules}
   s.test_files = [
+    "test/rack-rewrite_test.rb",
+    "test/geminstaller.yml",
     "test/rack-rewrite_test.rb",
     "test/rule_test.rb",
     "test/test_helper.rb"
   ]
-
+  #s.add_dependency 'rack'
+  
+  s.add_development_dependency 'bundler', '~> 1.0.10'
+  s.add_development_dependency 'shoulda', '~> 2.10.2'
+  s.add_development_dependency 'mocha', '~> 0.9.7'
+  s.add_development_dependency 'rack'
+  
   if s.respond_to? :specification_version then
     s.specification_version = 3
   end

data/test/rule_test.rb

@@ -1,4 +1,4 @@
-require File.join(File.dirname(__FILE__), 'test_helper')
+require 'test_helper'
 
 class RuleTest < Test::Unit::TestCase
   
@@ -146,6 +146,46 @@ class RuleTest < Test::Unit::TestCase
   end
   
   context 'Rule#matches' do
+    context 'Given rule with :not option which matches "from" string' do
+      setup do
+        @rule = Rack::Rewrite::Rule.new(:rewrite, /^\/features/, '/facial_features', :not => '/features')
+      end
+      should 'not match PATH_INFO of /features' do
+        assert !@rule.matches?(rack_env_for("/features"))
+      end
+      should 'match PATH_INFO of /features.xml' do
+        assert @rule.matches?(rack_env_for("/features.xml"))
+      end
+    end
+    
+    context 'Given rule with :host option of testapp.com' do
+      setup do
+        @rule = Rack::Rewrite::Rule.new(:rewrite, /^\/features/, '/facial_features', :host => 'testapp.com')
+      end
+      
+      should 'match PATH_INFO of /features and HOST of testapp.com' do
+        assert @rule.matches?(rack_env_for("/features", 'SERVER_NAME' => 'testapp.com'))
+      end
+      
+      should 'not match PATH_INFO of /features and HOST of nottestapp.com' do
+        assert ! @rule.matches?(rack_env_for("/features", 'SERVER_NAME' => 'nottestapp.com'))
+      end
+    end
+    
+    context 'Given rule with :method option of POST' do
+      setup do
+        @rule = Rack::Rewrite::Rule.new(:rewrite, '/features', '/facial_features', :method => 'POST')
+      end
+      
+      should 'match PATH_INFO of /features and REQUEST_METHOD of POST' do
+        assert @rule.matches?(rack_env_for("/features", 'REQUEST_METHOD' => 'POST'))
+      end
+      
+      should 'not match PATH_INFO of /features and REQUEST_METHOD of DELETE' do
+        assert ! @rule.matches?(rack_env_for("/features", 'REQUEST_METHOD' => 'DELETE'))
+      end
+    end
+    
     context 'Given any rule with a "from" string of /features' do
       setup do
         @rule = Rack::Rewrite::Rule.new(:rewrite, '/features', '/facial_features')
@@ -307,8 +347,8 @@ class RuleTest < Test::Unit::TestCase
     end
   end
   
-  def rack_env_for(url)
+  def rack_env_for(url, options = {})
     components = url.split('?')
-    {'PATH_INFO' => components[0], 'QUERY_STRING' => components[1] || ''}
+    {'PATH_INFO' => components[0], 'QUERY_STRING' => components[1] || ''}.merge(options)
   end
 end

data/test/test_helper.rb

@@ -1,13 +1,9 @@
 require 'rubygems'
-require 'test/unit'
-gem 'shoulda', '~> 2.10.2'
-require 'shoulda'
-gem 'mocha', '~> 0.9.7'
-require 'mocha'
+require 'bundler/setup'
+
+Bundler.require :default, :development
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rack/rewrite'
+require 'test/unit'
 
 class Test::Unit::TestCase
 end

metadata

@@ -1,45 +1,82 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rack-rewrite
-version: !ruby/object:Gem::Version 
-  hash: 19
-  prerelease: false
-  segments: 
-  - 1
-  - 0
-  - 2
-  version: 1.0.2
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - John Trupiano
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2010-10-01 00:00:00 -04:00
+date: 2011-08-15 00:00:00.000000000 -04:00
 default_executable: 
-dependencies: []
-
-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.
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &2152850260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.10
+  type: :development
+  prerelease: false
+  version_requirements: *2152850260
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &2152849800 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.10.2
+  type: :development
+  prerelease: false
+  version_requirements: *2152849800
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &2152849340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+  type: :development
+  prerelease: false
+  version_requirements: *2152849340
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: &2152848960 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2152848960
+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
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - LICENSE
 - History.rdoc
 - README.rdoc
-files: 
-- .document
-- .gitignore
+files:
 - History.rdoc
 - LICENSE
 - README.rdoc
 - Rakefile
-- RELEASING
+- VERSION
+- Gemfile
+- Gemfile.lock
 - lib/rack-rewrite.rb
 - lib/rack/rewrite.rb
 - lib/rack/rewrite/rule.rb
+- lib/rack/rewrite/version.rb
 - rack-rewrite.gemspec
 - test/geminstaller.yml
 - test/rack-rewrite_test.rb
@@ -48,38 +85,32 @@ files:
 has_rdoc: true
 homepage: http://github.com/jtrupiano/rack-rewrite
 licenses: []
-
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --charset=UTF-8
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+required_ruby_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: johntrupiano
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: A rack middleware for enforcing rewrite rules
-test_files: 
+test_files:
+- test/rack-rewrite_test.rb
+- test/geminstaller.yml
 - test/rack-rewrite_test.rb
 - test/rule_test.rb
 - test/test_helper.rb

data/.document

@@ -1,5 +0,0 @@
-README.rdoc
-lib/**/*.rb
-bin/*
-features/**/*.feature
-LICENSE

data/.gitignore

@@ -1,5 +0,0 @@
-*.sw?
-.DS_Store
-coverage
-rdoc
-pkg

data/RELEASING

@@ -1,4 +0,0 @@
-Update History.txt with relevant details
-Manually edit .gemspec updating file list, version, and date.
-Tag the new version (git tag -a vX.X.X)
-Build and push the gem (gem build rack-rewrite.gemspec && gem push rack-rewrite-X.X.X.gem)