simplify_redirector 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42c4f36de9e435fa6a85e08d397c1e8b06a3216a
+  data.tar.gz: 7d2c1ed72a2b7c4539c56db7603603bd10bc17e9
+SHA512:
+  metadata.gz: 25122e7a1cb140ca973379fabddc8db4ba0681ea16fdf42e5d334f84c61dae4e6016ada72ee0dc0b8727824f47184e7a6ef2316602d742848141226fde8cdb72
+  data.tar.gz: 42f2b87fca748930cbc6a039d185fd112ea057e41d278f4f1ba991956042a0315f7c983f91487dc33e44a8a6e55891ae2bd364ff3b226bc6dad382354f87e31d

data/HISTORY

@@ -0,0 +1,37 @@
+== 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
+
+
+== 0.1.1 / 2012-08-24
+* Destroy RequestEnvironmentRules when the parent RedirectRule is destroyed
+* Add some more indexes to redirect_rules table
+* Allow query strings to be part of the match on RedirectRules
+
+== 0.1.2 / 2012-08-27
+* Change ordering on match to prefer exact matches and longer matches
+
+== 0.1.3 / 2012-08-28
+* Include request_environment_rules when pulling back possible matches
+
+== 0.1.4 / 2012-09-07
+* Allow nested attributes for request environment rules on redirect rules and be set by mass assignment.
+* [BUG] Allow active to be set to false
+* [BUG] Handle a nil value for a match group correctly
+
+== 0.1.5 / 2014-01-16
+* Officially support Rails 4
+* Add `silence_sql_logs` config option
+* Handle ports on redirects properly
+* Better handle `URI::InvalidURIError` exceptions inside middleware by raising custom error
+* Minor bug fix
+
+== 1.0.0 / 2014-03-07
+* Add `preserve_query` option to preserve the query string from source to destination URL
+
+== 1.0.1 / 2014-09-26
+* Fix case sensitive/insensitive matching for non-regex rules

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,119 @@
+# Redirector
+
+[![Code Climate](https://codeclimate.com/github/vigetlabs/redirector.png)](https://codeclimate.com/github/vigetlabs/redirector) [![Build Status](https://travis-ci.org/vigetlabs/redirector.png?branch=master)](https://travis-ci.org/vigetlabs/redirector) [![Coverage Status](https://coveralls.io/repos/vigetlabs/redirector/badge.png?branch=master)](https://coveralls.io/r/vigetlabs/redirector?branch=master) [![Gem Version](https://badge.fury.io/rb/redirector.png)](http://badge.fury.io/rb/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`:
+
+    ```ruby  
+    gem 'redirector'
+    ```
+
+2. `$ rake redirector_engine:install:migrations`
+3. `$ rake db:migrate`
+4. Create an interface for admins to manage the redirect rules.
+
+
+### Config options
+
+`include_query_in_source`: If you want your redirect rules to also match against the query string as well as the path then you need to set this to `true` (the default is `false`).
+
+`silence_sql_logs`: This option silences the logging of Redirector related SQL queries in your log file.
+
+`preserve_query`: Pass the query string parameters through from the source to the target URL.
+
+`use_environment_variables`: This options disable querying to request_environment_rules table.
+
+`blacklisted_extensions`: Skip queries for request_path with extension ['.js', '.css', '.jpg', '.png', '.woff', '.ico']
+
+You can set these inside your configuration in `config/application.rb` of your Rails application like so:
+
+```ruby
+module MyApplication
+  class Application < Rails::Application
+    # ...
+
+    config.redirector.include_query_in_source = true
+    config.redirector.silence_sql_logs = true
+  end
+end
+```
+
+## 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:
+
+```ruby
+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.
+  * We're using [Appraisal](https://github.com/thoughtbot/appraisal) to test against different Rails versions.
+  * In order to run the tests you'll need to do the following:
+    1. `cp spec/dummy/config/database.yml.example spec/dummy/config/database.yml`
+    2. modify that `spec/dummy/config/database.yml` with your mysql configuration details
+    3. run `appraisal install` (should only need to do this once)
+    4. run `appraisal rake spec`
+* 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.
+
+***
+
+<a href="http://code.viget.com">
+  <img src="http://code.viget.com/github-banner.png" alt="Code At Viget">
+</a>
+
+Visit [code.viget.com](http://code.viget.com) to see more projects from [Viget.](https://viget.com)

data/Rakefile

@@ -0,0 +1,22 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+  require 'appraisal'
+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
+
+Dir[File.join(File.dirname(__FILE__), 'tasks/**/*.rake')].each {|f| load f }
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+desc "Run all specs in spec directory (excluding plugin specs)"
+RSpec::Core::RakeTask.new(:spec => 'app:db:test:prepare')
+
+task :default => :spec

data/app/models/redirect_rule.rb

@@ -0,0 +1,86 @@
+class RedirectRule < ActiveRecord::Base
+  extend Redirector::RegexAttribute
+  regex_attribute :source
+
+  has_many :request_environment_rules, :inverse_of => :redirect_rule, :dependent => :destroy
+
+  attr_accessible :source,
+                  :source_is_regex,
+                  :destination,
+                  :active,
+                  :source_is_case_sensitive,
+                  :request_environment_rules_attributes if Redirector.active_record_protected_attributes?
+
+  accepts_nested_attributes_for :request_environment_rules, :allow_destroy => true, :reject_if => :all_blank
+
+  validates :source, :destination, :presence => true
+  validates :active, :inclusion => { :in => ['0', '1', true, false] }
+
+  before_save :strip_source_whitespace
+
+  def self.regex_expression
+    if connection_mysql?
+      '(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)'
+    else
+      '(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)'
+    end
+  end
+
+  def self.match_sql_condition
+    <<-SQL
+      redirect_rules.active = :true AND
+      ((source_is_regex = :false AND source_is_case_sensitive = :false AND LOWER(redirect_rules.source) = LOWER(:source)) OR
+      (source_is_regex = :false AND source_is_case_sensitive = :true AND #{'BINARY' if connection_mysql?} redirect_rules.source = :source) OR
+      (source_is_regex = :true AND (#{regex_expression})))
+    SQL
+  end
+
+  def self.match_for(source, environment)
+    match_scope = where(match_sql_condition.strip, {:true => true, :false => false, :source => source})
+    match_scope = match_scope.order('redirect_rules.source_is_regex ASC, LENGTH(redirect_rules.source) DESC')
+
+    return match_scope.first unless Redirector.use_environment_variables
+
+    match_scope = match_scope.includes(:request_environment_rules)
+    match_scope = match_scope.references(:request_environment_rules) if Rails.version.to_i == 4
+    match_scope.detect do |rule|
+      rule.request_environment_rules.all? {|env_rule| env_rule.matches?(environment) }
+    end
+  end
+
+  def self.destination_for(source, environment)
+    return if Redirector.blacklisted_extensions.include? File.extname(source)
+
+    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].to_s)
+      end
+
+      final_destination
+    else
+      destination
+    end
+  end
+
+  private
+
+  def self.connection_mysql?
+    connection.adapter_name.downcase.include?('mysql')
+  end
+
+  def strip_source_whitespace
+    self.source = self.source.strip
+  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 if Redirector.active_record_protected_attributes?
+
+  validates :redirect_rule, :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,16 @@
+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
+    add_index :redirect_rules, :source_is_regex
+    add_index :redirect_rules, :source_is_case_sensitive
+  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.rb

@@ -0,0 +1,16 @@
+module Redirector
+  autoload :Middleware, 'redirector/middleware'
+  autoload :RegexAttribute, 'redirector/regex_attribute'
+
+  mattr_accessor :include_query_in_source
+  mattr_accessor :preserve_query
+  mattr_accessor :silence_sql_logs
+  mattr_accessor :use_environment_variables
+  mattr_accessor :blacklisted_extensions
+
+  def self.active_record_protected_attributes?
+    @active_record_protected_attributes ||= Rails.version.to_i < 4 || defined?(ProtectedAttributes)
+  end
+end
+
+require "redirector/engine"

data/lib/redirector/engine.rb

@@ -0,0 +1,20 @@
+module Redirector
+  class Engine < ::Rails::Engine
+    config.redirector = ActiveSupport::OrderedOptions.new
+
+    initializer "redirector.add_middleware", :after => 'build_middleware_stack' do |app|
+      app.middleware.insert_before(Rack::Runtime, Redirector::Middleware)
+    end
+
+    initializer "redirector.apply_options" do |app|
+      config = app.config.redirector
+
+      Redirector.include_query_in_source   = config.include_query_in_source || false
+      Redirector.preserve_query            = config.preserve_query || false
+      Redirector.silence_sql_logs          = config.silence_sql_logs || false
+
+      Redirector.use_environment_variables = config.use_environment_variables.nil? ? true : config.use_environment_variables
+      Redirector.blacklisted_extensions    = config.blacklisted_extensions || []
+    end
+  end
+end

data/lib/redirector/middleware.rb

@@ -0,0 +1,95 @@
+module Redirector
+  class RuleError < StandardError; end
+
+  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 ||= with_optional_silencing do
+          RedirectRule.destination_for(request_path, env)
+        end
+      end
+
+      def with_optional_silencing(&block)
+        if Redirector.silence_sql_logs
+          ActiveRecord::Base.logger.silence { yield }
+        else
+          yield
+        end
+      end
+
+      def request_path
+        if Redirector.include_query_in_source
+          env['ORIGINAL_FULLPATH']
+        else
+          env['PATH_INFO']
+        end
+      end
+
+      def request_host
+        env['HTTP_HOST'].split(':').first
+      end
+
+      def request_port
+        @request_port ||= begin
+          if env['HTTP_HOST'].include?(':')
+            env['HTTP_HOST'].split(':').last.to_i
+          end
+        end
+      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)
+      rescue URI::InvalidURIError
+        rule = RedirectRule.match_for(request_path, env)
+        raise Redirector::RuleError, "RedirectRule #{rule.id} generated the bad destination: #{matched_destination}"
+      end
+
+      def redirect_uri
+        destination_uri.tap do |uri|
+          uri.scheme ||= 'http'
+          uri.host   ||= request_host
+          uri.port   ||= request_port if request_port.present?
+          uri.query  ||= env['QUERY_STRING'] if Redirector.preserve_query
+        end
+      end
+
+      def redirect_url_string
+        @redirect_url_string ||= redirect_uri.to_s
+      end
+    end
+  end
+end