redirector 0.1.0

data/HISTORY

@@ -0,0 +1,7 @@
+== 0.1.0 / 2012-08-24
+* Middleware for redirecting users based on rules stored in the database.
+* Rules can have a regex or string source to match against.
+* Regex rules can evaluate the destination using groupings from the source.
+* Rules can have further request environment conditions to match based on HTTP Headers or Rack environment variables.
+* RequestEnvironmentRules can be exact string matches or regex matches.
+* Make regex's case sensitivity configurable

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Brian Landau
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,71 @@
+# Redirector
+
+Redirector is a Rails engine that adds a piece of middleware to the top of your middleware stack that looks for redirect rules stored in your database and redirects you accordingly.
+
+## Install
+
+1. Add this to your Gemfile and then `bundle install`:
+  <pre><code>gem 'redirector'</code></pre>
+2. `$ rake redirector:install:migrations`
+3. `$ rake db:migrate`
+4. Create an interface for admins to manage the redirect rules.
+
+
+## Redirect Rule definitions
+
+Redirect rules have 3 parts:
+
+1. A Source
+2. A Destination
+3. Request environment conditions
+
+The source defines how to match the incoming request path and the destination is where to send the visitor if the match is made. A source can be a strict string equality match or it can be a regular expression that is matched. If a regular expression is used and it uses groupings, you can reference those groupings inside of the destination. For instance a regex like `/my_custom_path\/([0-9]+)/` could use that grouping in the destination like this `"/my_destination/$1"`. So, if the request path was `"/my_custom_path/10"` then the destination for that rule would be `"/my_destination/10"`.
+
+Redirect rules can also have further Rack/HTTP environment (mainly HTTP headers) conditions via RequestEnvironmentRules. These define a key in the rack environment passed into the middleware and a value match you require for the redirect rule it's tied too. Similar to the redirect rules these RequestEnvironmentRules can be string matches or regex matches. A redirect rule can have as many of these environment rules as you need.
+
+When using regex matching on either a redirect rule source or a request environment rule environment value you can specify if you want the matching to be case sensitive or case insensitive with a boolean column that's on the table.
+
+### Schema Definition
+
+Here's the schema definition used for the two tables:
+
+    create_table "redirect_rules", :force => true do |t|
+      t.string   "source",                                      :null => false # Matched against the request path
+      t.boolean  "source_is_regex",          :default => false, :null => false # Is the source a regular expression or not
+      t.boolean  "source_is_case_sensitive", :default => false, :null => false # Is the source regex cas sensitive or not
+      t.string   "destination",                                 :null => false
+      t.boolean  "active",                   :default => false                 # Should this rule be applied or not
+      t.datetime "created_at",                                  :null => false
+      t.datetime "updated_at",                                  :null => false
+    end
+    
+    create_table "request_environment_rules", :force => true do |t|
+      t.integer  "redirect_rule_id",                                       :null => false
+      t.string   "environment_key_name",                                   :null => false # Name of the enviornment key (e.g. "QUERY_STRING", "HTTP_HOST")
+      t.string   "environment_value",                                      :null => false # What to match the value of the specified environment attribute against
+      t.boolean  "environment_value_is_regex",          :default => false, :null => false # Is the value match a regex or not
+      t.boolean  "environment_value_is_case_sensitive", :default => true,  :null => false # is the value regex case sensitive or not
+      t.datetime "created_at",                                             :null => false
+      t.datetime "updated_at",                                             :null => false
+    end
+
+## Databases supported
+
+* MySQL
+* PostgreSQL
+
+If you require support for another database, the only thing that needs to be added is a definition for a SQL regular expression conditional (see `app/models/redirect_rule.rb`). If you create a pull request that adds support for another database, it will most likely be merged in.
+
+## Contributing to Redirector
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2012 Brian Landau (Viget). See MIT_LICENSE for further details.

data/Rakefile

@@ -0,0 +1,19 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/models/redirect_rule.rb

@@ -0,0 +1,61 @@
+class RedirectRule < ActiveRecord::Base
+  extend Redirector::RegexAttribute
+  regex_attribute :source
+
+  has_many :request_environment_rules
+  
+  attr_accessible :source,
+                  :source_is_regex,
+                  :destination,
+                  :active,
+                  :source_is_case_sensitive
+  
+  validates :source, :destination, :active, :presence => true
+
+  def self.regex_expression
+    case connection.adapter_name
+    when 'PostgreSQL'
+      '(redirect_rules.source_is_case_sensitive = :true AND :source ~ redirect_rules.source) OR '+
+      '(redirect_rules.source_is_case_sensitive = :false AND :source ~* redirect_rules.source)'
+    when /mysql/i
+      '(redirect_rules.source_is_case_sensitive = :true AND :source REGEXP BINARY redirect_rules.source) OR '+
+      '(redirect_rules.source_is_case_sensitive = :false AND :source REGEXP redirect_rules.source)'
+    end
+  end
+
+  def self.match_sql_condition
+    <<-SQL
+      redirect_rules.active = :true AND
+      ((source_is_regex = :false AND redirect_rules.source = :source) OR 
+      (source_is_regex = :true AND (#{regex_expression})))
+    SQL
+  end
+
+  def self.match_for(source, environment)
+    where(match_sql_condition.strip, {:true => true, :false => false, :source => source}).detect do |rule|
+      rule.request_environment_rules.all? {|env_rule| env_rule.matches?(environment) }
+    end
+  end
+
+  def self.destination_for(source, environment)
+    rule = match_for(source, environment)
+    rule.evaluated_destination_for(source) if rule
+  end
+
+  def evaluated_destination_for(request_path)
+    if source_is_regex? && request_path =~ source_regex
+      matches = $~
+      number_of_grouped_matches = matches.length - 1
+      final_destination = destination.dup
+
+      number_of_grouped_matches.downto(1) do |index|
+        final_destination.gsub!(/\$#{index}/, matches[index])
+      end
+
+      final_destination
+    else
+      destination
+    end
+  end
+
+end

data/app/models/request_environment_rule.rb

@@ -0,0 +1,23 @@
+class RequestEnvironmentRule < ActiveRecord::Base
+  extend Redirector::RegexAttribute
+  regex_attribute :environment_value
+  
+  belongs_to :redirect_rule
+
+  attr_accessible :redirect_rule_id,
+                  :environment_key_name,
+                  :environment_value,
+                  :environment_value_is_regex,
+                  :environment_value_is_case_sensitive
+
+  validates :redirect_rule_id, :environment_key_name, :environment_value, :presence => true
+
+  def matches?(environment)
+    if environment_value_is_regex?
+      environment[environment_key_name] && environment[environment_key_name] =~ environment_value_regex
+    else
+      environment[environment_key_name] == environment_value
+    end
+  end
+
+end

data/db/migrate/20120815212612_create_redirect_rules.rb

@@ -0,0 +1,14 @@
+class CreateRedirectRules < ActiveRecord::Migration
+  def change
+    create_table :redirect_rules do |t|
+      t.string :source, :null => false
+      t.boolean :source_is_regex, :null => false, :default => false
+      t.boolean :source_is_case_sensitive, :null => false, :default => false
+      t.string :destination, :null => false
+      t.boolean :active, :default => false
+      t.timestamps
+    end
+    add_index :redirect_rules, :source
+    add_index :redirect_rules, :active
+  end
+end

data/db/migrate/20120823163756_create_request_environment_rules.rb

@@ -0,0 +1,13 @@
+class CreateRequestEnvironmentRules < ActiveRecord::Migration
+  def change
+    create_table :request_environment_rules do |t|
+      t.integer :redirect_rule_id, :null => false
+      t.string :environment_key_name, :null => false
+      t.string :environment_value, :null => false
+      t.boolean :environment_value_is_regex, :null => false, :default => false
+      t.boolean :environment_value_is_case_sensitive, :null => false, :default => true
+      t.timestamps
+    end
+    add_index :request_environment_rules, :redirect_rule_id
+  end
+end

data/lib/redirector/engine.rb

@@ -0,0 +1,7 @@
+module Redirector
+  class Engine < ::Rails::Engine
+    initializer "redirector.add_middleware" do |app|
+      app.middleware.insert_before(Rack::Lock, Redirector::Middleware)
+    end
+  end
+end

data/lib/redirector/middleware.rb

@@ -0,0 +1,66 @@
+module Redirector
+  class Middleware
+    def initialize(application)
+      @application = application
+    end
+    
+    def call(environment)
+      Responder.new(@application, environment).response
+    end
+    
+    class Responder
+      attr_reader :app, :env
+
+      def initialize(application, environment)
+        @app = application
+        @env = environment
+      end
+
+      def response
+        if redirect?
+          redirect_response
+        else
+          app.call(env)
+        end
+      end
+
+      private
+      
+      def redirect?
+        matched_destination.present?
+      end
+      
+      def matched_destination
+        @matched_destination ||= RedirectRule.destination_for(request_path, env)
+      end
+
+      def request_path
+        env['PATH_INFO']
+      end
+      
+      def request_host
+        env['HTTP_HOST'].split(':').first
+      end
+
+      def redirect_response
+        [301, {'Location' => redirect_url_string}, 
+          %{You are being redirected <a href="#{redirect_url_string}">#{redirect_url_string}</a>}]
+      end
+
+      def destination_uri
+        URI.parse(matched_destination)
+      end
+
+      def redirect_uri
+        destination_uri.tap do |uri|
+          uri.scheme ||= 'http'
+          uri.host   ||= request_host
+        end
+      end
+      
+      def redirect_url_string
+        @redirect_url_string ||= redirect_uri.to_s
+      end
+    end
+  end
+end

data/lib/redirector/regex_attribute.rb

@@ -0,0 +1,38 @@
+module Redirector
+  module RegexAttribute
+    
+    def regex_attribute(attribute_name)
+      include ValidationMethod
+
+      cattr_accessor :regex_attribute_name
+      self.regex_attribute_name = attribute_name
+
+      validates "#{attribute_name}_is_regex".to_sym, :inclusion => { :in => ['0', '1', true, false] }
+      validates "#{attribute_name}_is_case_sensitive".to_sym, :inclusion => { :in => ['0', '1', true, false] }
+      validate :regex_attribute_is_valid_regex
+
+      define_method("#{regex_attribute_name}_regex") do
+        if self.send("#{regex_attribute_name}_is_case_sensitive?")
+          Regexp.compile(self.send(regex_attribute_name))
+        else
+          Regexp.compile(self.send(regex_attribute_name), Regexp::IGNORECASE)
+        end
+      end
+    end
+    
+    module ValidationMethod
+      
+      protected
+      
+      def regex_attribute_is_valid_regex
+        if self.send("#{regex_attribute_name}_is_regex?") && self.send("#{regex_attribute_name}?")
+          begin
+            Regexp.compile(self.send(regex_attribute_name))
+          rescue RegexpError
+            errors.add(regex_attribute_name, 'is an invalid regular expression')
+          end
+        end
+      end
+    end
+  end
+end

data/lib/redirector/version.rb

@@ -0,0 +1,3 @@
+module Redirector
+  VERSION = "0.1.0"
+end

data/lib/redirector.rb

@@ -0,0 +1,6 @@
+module Redirector
+  autoload :Middleware, 'redirector/middleware'
+  autoload :RegexAttribute, 'redirector/regex_attribute'
+end
+
+require "redirector/engine"

data/redirector.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+
+# Maintain your gem's version:
+require "redirector/version"
+
+# Describe your gem and declare its dependencies:
+Gem::Specification.new do |s|
+  s.name        = "redirector"
+  s.version     = Redirector::VERSION
+  s.authors     = ["Brian Landau"]
+  s.email       = ["brian.landau@viget.com"]
+  s.homepage    = "https://github.com/vigetlabs/redirector"
+  s.summary     = "A Rails engine that adds a piece of middleware to the top of your middleware stack that looks for redirect rules stored in your database and redirects you accordingly."
+  s.description = "A Rails engine that adds a piece of middleware to the top of your middleware stack that looks for redirect rules stored in your database and redirects you accordingly."
+
+  s.files = Dir["{app,config,db,lib}/**/*"] + ["MIT-LICENSE", "Rakefile", 
+    "README.md", "redirector.gemspec", "HISTORY"]
+  s.test_files = Dir["spec/**/*"]
+
+  s.add_dependency "rails", "~> 3.1"
+  # s.add_dependency "jquery-rails"
+
+  s.add_development_dependency "mysql2"
+  s.add_development_dependency 'rspec-rails'
+  s.add_development_dependency 'shoulda-matchers'
+  s.add_development_dependency 'capybara'
+  s.add_development_dependency 'database_cleaner'
+  s.add_development_dependency 'factory_girl_rails', '~> 1.7'
+end

data/spec/dummy/README.rdoc

@@ -0,0 +1,261 @@
+== Welcome to Rails
+
+Rails is a web-application framework that includes everything needed to create
+database-backed web applications according to the Model-View-Control pattern.
+
+This pattern splits the view (also called the presentation) into "dumb"
+templates that are primarily responsible for inserting pre-built data in between
+HTML tags. The model contains the "smart" domain objects (such as Account,
+Product, Person, Post) that holds all the business logic and knows how to
+persist themselves to a database. The controller handles the incoming requests
+(such as Save New Account, Update Product, Show Post) by manipulating the model
+and directing data to the view.
+
+In Rails, the model is handled by what's called an object-relational mapping
+layer entitled Active Record. This layer allows you to present the data from
+database rows as objects and embellish these data objects with business logic
+methods. You can read more about Active Record in
+link:files/vendor/rails/activerecord/README.html.
+
+The controller and view are handled by the Action Pack, which handles both
+layers by its two parts: Action View and Action Controller. These two layers
+are bundled in a single package due to their heavy interdependence. This is
+unlike the relationship between the Active Record and Action Pack that is much
+more separate. Each of these packages can be used independently outside of
+Rails. You can read more about Action Pack in
+link:files/vendor/rails/actionpack/README.html.
+
+
+== Getting Started
+
+1. At the command prompt, create a new Rails application:
+       <tt>rails new myapp</tt> (where <tt>myapp</tt> is the application name)
+
+2. Change directory to <tt>myapp</tt> and start the web server:
+       <tt>cd myapp; rails server</tt> (run with --help for options)
+
+3. Go to http://localhost:3000/ and you'll see:
+       "Welcome aboard: You're riding Ruby on Rails!"
+
+4. Follow the guidelines to start developing your application. You can find
+the following resources handy:
+
+* The Getting Started Guide: http://guides.rubyonrails.org/getting_started.html
+* Ruby on Rails Tutorial Book: http://www.railstutorial.org/
+
+
+== Debugging Rails
+
+Sometimes your application goes wrong. Fortunately there are a lot of tools that
+will help you debug it and get it back on the rails.
+
+First area to check is the application log files. Have "tail -f" commands
+running on the server.log and development.log. Rails will automatically display
+debugging and runtime information to these files. Debugging info will also be
+shown in the browser on requests from 127.0.0.1.
+
+You can also log your own messages directly into the log file from your code
+using the Ruby logger class from inside your controllers. Example:
+
+  class WeblogController < ActionController::Base
+    def destroy
+      @weblog = Weblog.find(params[:id])
+      @weblog.destroy
+      logger.info("#{Time.now} Destroyed Weblog ID ##{@weblog.id}!")
+    end
+  end
+
+The result will be a message in your log file along the lines of:
+
+  Mon Oct 08 14:22:29 +1000 2007 Destroyed Weblog ID #1!
+
+More information on how to use the logger is at http://www.ruby-doc.org/core/
+
+Also, Ruby documentation can be found at http://www.ruby-lang.org/. There are
+several books available online as well:
+
+* Programming Ruby: http://www.ruby-doc.org/docs/ProgrammingRuby/ (Pickaxe)
+* Learn to Program: http://pine.fm/LearnToProgram/ (a beginners guide)
+
+These two books will bring you up to speed on the Ruby language and also on
+programming in general.
+
+
+== Debugger
+
+Debugger support is available through the debugger command when you start your
+Mongrel or WEBrick server with --debugger. This means that you can break out of
+execution at any point in the code, investigate and change the model, and then,
+resume execution! You need to install ruby-debug to run the server in debugging
+mode. With gems, use <tt>sudo gem install ruby-debug</tt>. Example:
+
+  class WeblogController < ActionController::Base
+    def index
+      @posts = Post.all
+      debugger
+    end
+  end
+
+So the controller will accept the action, run the first line, then present you
+with a IRB prompt in the server window. Here you can do things like:
+
+  >> @posts.inspect
+  => "[#<Post:0x14a6be8
+          @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>,
+       #<Post:0x14a6620
+          @attributes={"title"=>"Rails", "body"=>"Only ten..", "id"=>"2"}>]"
+  >> @posts.first.title = "hello from a debugger"
+  => "hello from a debugger"
+
+...and even better, you can examine how your runtime objects actually work:
+
+  >> f = @posts.first
+  => #<Post:0x13630c4 @attributes={"title"=>nil, "body"=>nil, "id"=>"1"}>
+  >> f.
+  Display all 152 possibilities? (y or n)
+
+Finally, when you're ready to resume execution, you can enter "cont".
+
+
+== Console
+
+The console is a Ruby shell, which allows you to interact with your
+application's domain model. Here you'll have all parts of the application
+configured, just like it is when the application is running. You can inspect
+domain models, change values, and save to the database. Starting the script
+without arguments will launch it in the development environment.
+
+To start the console, run <tt>rails console</tt> from the application
+directory.
+
+Options:
+
+* Passing the <tt>-s, --sandbox</tt> argument will rollback any modifications
+  made to the database.
+* Passing an environment name as an argument will load the corresponding
+  environment. Example: <tt>rails console production</tt>.
+
+To reload your controllers and models after launching the console run
+<tt>reload!</tt>
+
+More information about irb can be found at:
+link:http://www.rubycentral.org/pickaxe/irb.html
+
+
+== dbconsole
+
+You can go to the command line of your database directly through <tt>rails
+dbconsole</tt>. You would be connected to the database with the credentials
+defined in database.yml. Starting the script without arguments will connect you
+to the development database. Passing an argument will connect you to a different
+database, like <tt>rails dbconsole production</tt>. Currently works for MySQL,
+PostgreSQL and SQLite 3.
+
+== Description of Contents
+
+The default directory structure of a generated Ruby on Rails application:
+
+  |-- app
+  |   |-- assets
+  |       |-- images
+  |       |-- javascripts
+  |       `-- stylesheets
+  |   |-- controllers
+  |   |-- helpers
+  |   |-- mailers
+  |   |-- models
+  |   `-- views
+  |       `-- layouts
+  |-- config
+  |   |-- environments
+  |   |-- initializers
+  |   `-- locales
+  |-- db
+  |-- doc
+  |-- lib
+  |   `-- tasks
+  |-- log
+  |-- public
+  |-- script
+  |-- test
+  |   |-- fixtures
+  |   |-- functional
+  |   |-- integration
+  |   |-- performance
+  |   `-- unit
+  |-- tmp
+  |   |-- cache
+  |   |-- pids
+  |   |-- sessions
+  |   `-- sockets
+  `-- vendor
+      |-- assets
+          `-- stylesheets
+      `-- plugins
+
+app
+  Holds all the code that's specific to this particular application.
+
+app/assets
+  Contains subdirectories for images, stylesheets, and JavaScript files.
+
+app/controllers
+  Holds controllers that should be named like weblogs_controller.rb for
+  automated URL mapping. All controllers should descend from
+  ApplicationController which itself descends from ActionController::Base.
+
+app/models
+  Holds models that should be named like post.rb. Models descend from
+  ActiveRecord::Base by default.
+
+app/views
+  Holds the template files for the view that should be named like
+  weblogs/index.html.erb for the WeblogsController#index action. All views use
+  eRuby syntax by default.
+
+app/views/layouts
+  Holds the template files for layouts to be used with views. This models the
+  common header/footer method of wrapping views. In your views, define a layout
+  using the <tt>layout :default</tt> and create a file named default.html.erb.
+  Inside default.html.erb, call <% yield %> to render the view using this
+  layout.
+
+app/helpers
+  Holds view helpers that should be named like weblogs_helper.rb. These are
+  generated for you automatically when using generators for controllers.
+  Helpers can be used to wrap functionality for your views into methods.
+
+config
+  Configuration files for the Rails environment, the routing map, the database,
+  and other dependencies.
+
+db
+  Contains the database schema in schema.rb. db/migrate contains all the
+  sequence of Migrations for your schema.
+
+doc
+  This directory is where your application documentation will be stored when
+  generated using <tt>rake doc:app</tt>
+
+lib
+  Application specific libraries. Basically, any kind of custom code that
+  doesn't belong under controllers, models, or helpers. This directory is in
+  the load path.
+
+public
+  The directory available for the web server. Also contains the dispatchers and the
+  default HTML files. This should be set as the DOCUMENT_ROOT of your web
+  server.
+
+script
+  Helper scripts for automation and generation.
+
+test
+  Unit and functional tests along with fixtures. When using the rails generate
+  command, template test files will be generated for you and placed in this
+  directory.
+
+vendor
+  External libraries that the application depends on. Also includes the plugins
+  subdirectory. If the app has frozen rails, those gems also go here, under
+  vendor/rails/. This directory is in the load path.

data/spec/dummy/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+
+Dummy::Application.load_tasks