Redir 0.0.4

data/Gemfile

@@ -0,0 +1,16 @@
+source 'https://rubygems.org'
+
+ruby '1.9.3'
+
+gem 'mongoid', '~> 3.0.0'
+gem 'rack'
+
+group :test, :development do
+  gem 'rack-test', require: 'rack/test'
+  gem 'rspec'
+  gem 'factory_girl'
+  gem 'timecop'
+  gem 'jeweler'
+  gem 'simplecov'
+  gem 'yard'
+end

data/Gemfile.lock

@@ -0,0 +1,64 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.8)
+      activesupport (= 3.2.8)
+      builder (~> 3.0.0)
+    activesupport (3.2.8)
+      i18n (~> 0.6)
+      multi_json (~> 1.0)
+    builder (3.0.3)
+    diff-lcs (1.1.3)
+    factory_girl (4.1.0)
+      activesupport (>= 3.0.0)
+    git (1.2.5)
+    i18n (0.6.1)
+    jeweler (1.8.4)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.7.5)
+    mongoid (3.0.6)
+      activemodel (~> 3.1)
+      moped (~> 1.1)
+      origin (~> 1.0)
+      tzinfo (~> 0.3.22)
+    moped (1.2.5)
+    multi_json (1.3.6)
+    origin (1.0.9)
+    rack (1.4.1)
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
+    simplecov (0.7.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.7.1)
+    simplecov-html (0.7.1)
+    timecop (0.5.3)
+    tzinfo (0.3.33)
+    yard (0.8.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  factory_girl
+  jeweler
+  mongoid (~> 3.0.0)
+  rack
+  rack-test
+  rspec
+  simplecov
+  timecop
+  yard

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Springbot
+
+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,87 @@
+Redir
+=====
+
+There are many gems that allow you to create a short url and redirect a user to another website.  But there are not many store information about the requests that use Mongo which is why we created redir.  
+
+### Features
+* Fully rack compliant
+* Generates a unique shortened url for you
+* Takes care of the mongo heavy lifting for you
+* Stores all of the request header information to gather analytics
+* Allows the addition to two sets of request parameters for conversion analytics 
+
+How to use it
+-------------
+
+Redir is currently under active development.  
+
+### Rails
+include the gem in your Gemfile
+in your application.rb add 
+
+    config.middleware.use Rack::Redir
+
+in your environments/ development.rb,  test.rb or production.rb file add.
+
+    Redirect.host = '<your hostname>/'
+
+add a config/mongoid.yml file.  Setup a local mongodb instance or use one from a cloud provider and add those configuration settings to your mongoid.yml file as described here http://mongoid.org/en/mongoid/docs/installation.html#configuration
+
+Redir by default uses the /a route for redirect requests.  IE:  http://<your url>/a/<shortened_id>  If you have another route that is already set at a you can change this by adding to your application.rb.
+
+    Redirect.path = '<new path>/' 
+
+To create a shortened Url in your code
+
+    Redir.create_shortened_url <your url>
+
+The Redirect object is a Mongoid object class.  Therefore you can search for redirect information based on it's attributes.  In the case of Redirect those attributes are original_url and shortened_id.  For example
+
+    results = Redirect.where(:original_url => www.polyglotprogramminginc.com).all  
+    
+Mongoid results a Mongoid::Criteria object.  To get at the results you can use something like
+  
+    results.to_a 
+
+to get an array of results.  See the mongoid documentation for further details.  The shortened id is only the 8 character unique id of the shortened url.  For example for http://www.springbot/a/ddffggrr ddffggrr would be the shortened_id.  There is also a shortened_url and shortened_path method.  See the redirect.rb docucumentation for more information.  To get the full url that the user will be able to hit to be redirected use the shortened_url helper....ie
+
+    redir = Redirect.create_shortened_url <your url>
+    redir.shortened_url #the full shortened url that the user would hit to be directed back to <your url>
+
+RedirectLog contains information about redirects that have been done.  We are currently working on helper methods to make this easier,  but for the time being you can get at that data by doing the following.
+
+read the _id field from a redirect object that you want to get logging information for. IE:
+
+      my_redirect = Redirect.where(:shortened_id => 'rrffttee').to_a.last
+      
+and running a query against the RedirectLog object
+
+      redir_log = RedirectLog.where(:redirect_id => my_redirect._id)
+
+an easier way to do this is
+    
+      Redirector.find_logs <a shortened id>
+
+you use the redir_log like any mongo object.  the headers attribute contains the raw request headers and request time has the date/time the request came in.
+    
+### Other configuration options
+
+      Redirect.append_tracking_info
+
+adds redirect_mongo_id=<Redirect._id>&redirect_log_mongo_id=<RedirectLog._id> to the end of the url being redirected to for conversion tracking
+
+      Redirect.append_google_analytics
+
+adds utm_source=<@@host>&utm_campaign=<Redirect._id>__<RedirectLog._id> to the end of the url being redirected to for google analytics tracking
+
+Contributing
+------------
+
+Just fork us on GitHub and send a pull request when you are ready.
+
+License
+-------
+
+redir is released under the MIT license:
+
+* http://www.opensource.org/licenses/MIT

data/Rakefile

@@ -0,0 +1,37 @@
+# encoding: utf-8
+
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "Redir"
+  gem.homepage = "http://github.com/springbot/redir"
+  gem.license = "MIT"
+  gem.summary = %Q{A Mongo based url shortener and data gathering gem.}
+  gem.description = %Q{This gem adds functionality to shorten url's and gather data about requests going through it.}
+  gem.email = "lgleason@polyglotprogramminginc.com"
+  gem.authors = ["Lance Gleason"]
+  # dependencies defined in Gemfile
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+task :default => :spec
+
+require 'yard'
+YARD::Rake::YardocTask.new

data/VERSION

@@ -0,0 +1 @@
+0.0.4

data/lib/model/redirect.rb

@@ -0,0 +1,91 @@
+class Redirect
+  include Mongoid::Document
+
+  field :original_url
+  field :shortened_id
+
+  @@host = 'http://localhost:3000/'
+  @@path = 'a/'
+  @@append_tracking_info = false
+  @@append_google_analytics = false
+
+  # Sets the value of the flag to determine if google analytics info should be sent with the url
+  # appends utm_source=<@@host>&utm_campaign=<Redirect._id>__<RedirectLog._id>
+  # @param [Boolean] value to set append_google_analytics flag to
+  def self.append_google_analytics= google_analytics_flag
+    @@append_google_analytics = google_analytics_flag
+  end
+
+  # Gets the value of the flag to determine if google analytics info should be sent with the url
+  # @returns [Boolean] value of the append_google_analytics flag
+  def self.append_google_analytics
+    @@append_google_analytics
+  end
+
+  # Sets the value of the flag to determine if tracking info should be sent with the url
+  # adds the following to the url being redirected to
+  # redirect_mongo_id=<Redirect._id>&redirect_log_mongo_id=<RedirectLog._id>
+  # @param [Boolean] value to set append_tracking_info flag to
+  def self.append_tracking_info= tracking_info_flag
+    @@append_tracking_info = tracking_info_flag
+  end
+
+  # Gets the value of the flag to determine if tracking info should be sent with the url
+  # @returns [Boolean] value of append_tracking_info flag
+  def self.append_tracking_info
+    @@append_tracking_info
+  end
+
+  # Sets the path to use in the shortened url
+  # @param [String] the path you want to use for your shortened url instead of the default a/
+  def self.path= path
+    @@path = path
+  end
+
+  # Gets the path for the shortened url
+  # @return [String] the path
+  def self.path
+    path = @@path.end_with?('/') ? @@path : "#{@@path}/"
+    path.start_with?('/') ? path[1..path.length] : path
+  end
+
+  # Sets the host to use in the shortened url
+  # @param [String] the host to use in the shotened url
+  def self.host= host
+    @@host = host
+  end
+
+  # Gets the host for the shortened url
+  # @return [String] the host for the shortened url
+  def self.host
+    @@host.end_with?('/') ? @@host : "#{@@host}/"
+  end
+
+  # Creates a shortened url id of 8 characters,  creates and saves a redirect object with the 
+  #   new shortened url id.  
+  # @param [String] the url to redirect to
+  # @return [Redirect] a saved redirect object with the newly created shortened url.
+  def self.create_shortened_url(original_url)
+    redir = self.new :original_url => original_url
+    shortened_id =  SecureRandom.urlsafe_base64(6)
+    duplicate_find = Redirect.where(:shortened_id => shortened_id) 
+    if duplicate_find and duplicate_find.last and (shortened_id == duplicate_find.last.shortened_id)
+      shortened_id = SecureRandom.urlsafe_base64(6)
+    end
+    redir.shortened_id = shortened_id
+    redir.save!
+    redir
+  end
+
+  # Returns the entire shortened url which consists of the host,  path and shortened id
+  # @return [String] the shortened url
+  def shortened_url
+    "#{self.class.host}#{self.class.path}#{shortened_id}"
+  end
+
+  # Returns the shortened url path consisting of the path and shortened id
+  # @return [String] the shortened path
+  def shortened_path
+    "#{self.class.path}#{shortened_id}"
+  end
+end

data/lib/model/redirect_log.rb

@@ -0,0 +1,7 @@
+class RedirectLog
+  include Mongoid::Document
+
+  field :redirect_id
+  field :headers
+  field :request_time, type: DateTime
+end

data/lib/rack/redir.rb

@@ -0,0 +1,51 @@
+require 'mongoid'
+
+module Rack
+  # Bounce those annoying favicon.ico requests
+  class Redir
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      env['PATH_INFO'] =~ %r{^a/(.+)$}
+      parsed_path = env['PATH_INFO'].split(/\//)
+      if "#{parsed_path.second}/" == Redirect.path
+        redir_asset = parsed_path.last 
+        redirect_record = (Redirect.where shortened_id: redir_asset).to_a.last
+        headers = env.select {|k,v| k.start_with? 'HTTP_'}
+        if redirect_record and redirect_record.shortened_id == redir_asset
+          redirect_url = redirect_record.original_url.strip 
+          redirect_to_url = redirect_url.start_with?('http') ? redirect_url : "http://#{redirect_url}"
+          redirect_log = RedirectLog.new(:redirect_id => redirect_record.id, 
+                                         :headers => headers, :request_time => Time.now)
+          redirect_log.save!
+          if Redirect.append_tracking_info
+            redirect_to_url = append_parameter_separater redirect_to_url
+            redirect_to_url = "#{redirect_to_url}redirect_mongo_id=" +
+                              "#{redirect_log.redirect_id}&redirect_log_mongo_id=#{redirect_log._id}"
+          end
+          if Redirect.append_google_analytics
+            redirect_to_url = append_parameter_separater redirect_to_url 
+            redirect_to_url = "#{redirect_to_url}utm_source=#{Rack::Utils.escape Redirect.host}" +
+                              "&utm_campaign=#{redirect_log.redirect_id}__#{redirect_log._id}"
+          end  
+          [302, {'Location' => redirect_to_url}, self]
+        else
+          [404, {}, self]
+        end
+      else
+        @app.call env
+      end
+
+    end
+
+    def append_parameter_separater url
+      url.match('\?') ? "#{url}&" : "#{url}?"
+    end
+
+    def each(&block)
+    end
+  end
+end
+

data/lib/redir.rb

@@ -0,0 +1,5 @@
+require 'rack/redir'
+require 'model/redirect'
+require 'model/redirect_log'
+require 'mongoid'
+require 'redirector'

data/lib/redirector.rb

@@ -0,0 +1,18 @@
+module Redirector
+  # finds logs associated with the shortened url
+  # @params [String] the shortened id to find logs for
+  # @returns [Array] the logs for the shortened id as an array
+  def Redirector.find_logs shortened_id
+    RedirectLog.where(:redirect_id => find_redirect_by_shortened_id(shortened_id)).to_a
+  end
+
+  # finds the number of times a redirect has been accessed
+  # @returns [Integer] the number of times the redirect has been accessed
+  def Redirector.number_of_redirect_hits shortened_id
+    RedirectLog.where(:redirect_id => find_redirect_by_shortened_id(shortened_id)).count
+  end
+
+  def Redirector.find_redirect_by_shortened_id shortened_id
+    Redirect.where(:shortened_id => shortened_id).to_a.last._id
+  end
+end

data/redir.gemspec

@@ -0,0 +1,81 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "Redir"
+  s.version = "0.0.4"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Lance Gleason"]
+  s.date = "2012-10-24"
+  s.description = "This gem adds functionality to shorten url's and gather data about requests going through it."
+  s.email = "lgleason@polyglotprogramminginc.com"
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.md"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.md",
+    "Rakefile",
+    "VERSION",
+    "lib/model/redirect.rb",
+    "lib/model/redirect_log.rb",
+    "lib/rack/redir.rb",
+    "lib/redir.rb",
+    "lib/redirector.rb",
+    "redir.gemspec",
+    "spec/factories/redirect.rb",
+    "spec/mongoid.yml",
+    "spec/spec_helper.rb",
+    "spec/unit/model/redirect_spec.rb",
+    "spec/unit/rack/redir_spec.rb",
+    "spec/unit/redirector_spec.rb"
+  ]
+  s.homepage = "http://github.com/springbot/redir"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.24"
+  s.summary = "A Mongo based url shortener and data gathering gem."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<mongoid>, ["~> 3.0.0"])
+      s.add_runtime_dependency(%q<rack>, [">= 0"])
+      s.add_development_dependency(%q<rack-test>, [">= 0"])
+      s.add_development_dependency(%q<rspec>, [">= 0"])
+      s.add_development_dependency(%q<factory_girl>, [">= 0"])
+      s.add_development_dependency(%q<timecop>, [">= 0"])
+      s.add_development_dependency(%q<jeweler>, [">= 0"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<mongoid>, ["~> 3.0.0"])
+      s.add_dependency(%q<rack>, [">= 0"])
+      s.add_dependency(%q<rack-test>, [">= 0"])
+      s.add_dependency(%q<rspec>, [">= 0"])
+      s.add_dependency(%q<factory_girl>, [">= 0"])
+      s.add_dependency(%q<timecop>, [">= 0"])
+      s.add_dependency(%q<jeweler>, [">= 0"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<mongoid>, ["~> 3.0.0"])
+    s.add_dependency(%q<rack>, [">= 0"])
+    s.add_dependency(%q<rack-test>, [">= 0"])
+    s.add_dependency(%q<rspec>, [">= 0"])
+    s.add_dependency(%q<factory_girl>, [">= 0"])
+    s.add_dependency(%q<timecop>, [">= 0"])
+    s.add_dependency(%q<jeweler>, [">= 0"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/spec/factories/redirect.rb

@@ -0,0 +1,6 @@
+FactoryGirl.define do
+  factory :redirect do
+    sequence(:original_url) {|n| "http://www.google.com/#{n}"}
+    sequence(:shortened_id) {|n| "goo#{n}"}
+  end
+end

data/spec/mongoid.yml

@@ -0,0 +1,29 @@
+# Tell Mongoid which environment this configuration is for.
+test:
+  # This starts the session configuration settings. You may have as
+  # many sessions as you like, but you must have at least 1 named
+  # 'default'.
+  sessions:
+    # Define the default session.
+    default:
+      # A session can have any number of hosts. Usually 1 for a single
+      # server setup, and at least 3 for a replica set. Hosts must be
+      # an array of host:port pairs. This session is single server.
+      hosts:
+        - localhost:27017
+      # Define the default database name.
+      database: www_test
+      # Since this database points at a session connected to MongoHQ, we must
+      # provide the authentication details.
+  options:
+    allow_dynamic_fields: true
+    identity_map_enabled: true
+    include_root_in_json: true
+    # Note this can also be true if you want to preload everything, but this is
+    # almost never necessary. Most of the time set this to false.
+    scope_overwrite_exception: true
+    raise_not_found_error: false
+    skip_version_check: false
+    use_activesupport_time_zone: false
+    use_utc: true
+

data/spec/spec_helper.rb

@@ -0,0 +1,31 @@
+require 'rubygems'
+require 'rack/test'
+require 'bundler'
+require 'mongoid'
+require 'factory_girl'
+require 'simplecov'
+SimpleCov.start
+
+Mongoid.load!('./spec/mongoid.yml', :test)
+
+RSpec.configure do |config|
+  config.include FactoryGirl::Syntax::Methods
+end
+
+FactoryGirl.find_definitions
+
+Dir['lib/**/*.rb'].each {|f| require File.join(File.dirname(__FILE__), '..', f.gsub(/.rb/, ''))}
+
+module RedirHelper
+  require 'rack/test'
+  include Rack::Test::Methods
+
+  def app
+    test_app = lambda do |env|
+     [200, {}, 'test app']
+    end 
+    
+    Rack::Redir.new test_app
+  end
+end
+

data/spec/unit/model/redirect_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+include RedirHelper
+
+describe :redirect do
+
+  after :each do
+    Redirect.delete_all
+    RedirectLog.delete_all
+  end
+
+  context 'redirect generator' do
+    context 'should generate a unique url' do
+      before :each do
+        SecureRandom.should_receive(:urlsafe_base64).with(6).and_return('eeeeee')
+      end
+      
+      let(:redirect) { Redirect.create_shortened_url 'http://www.google.com' }
+      subject {redirect}
+      its (:shortened_id) {should eq 'eeeeee'}
+      its (:shortened_path) {should eq 'a/eeeeee'}
+      its (:shortened_url) {should eq 'http://localhost:3000/a/eeeeee'}
+    end
+
+
+    context 'duplicate redirects' do
+      before do
+        SecureRandom.should_receive(:urlsafe_base64).with(6).twice.and_return('eeeeee')
+        SecureRandom.should_receive(:urlsafe_base64).with(6).once.and_return('ffffff')
+      end
+
+      let(:redirect) { Redirect.create_shortened_url 'http://www.google.com' }
+      let(:second_redirect) { Redirect.create_shortened_url 'http://www.yahoo.com' }
+
+      it "should get a unique url on each request" do
+        redirect.shortened_id.should eq 'eeeeee'
+        second_redirect.shortened_id.should eq 'ffffff'
+      end
+    end
+  end
+
+  context 'leading and trailing slashes' do
+    context 'host' do
+      context 'no trailing slash' do
+        let (:redirect) {Redirect.create_shortened_url 'www.springbot.com'}
+
+        before do
+          Redirect.host = 'www.honeybadger.com'
+          SecureRandom.should_receive(:urlsafe_base64).with(6).at_most(:once).and_return('eeeeee')
+        end
+
+        context 'global host' do
+          subject {Redirect}
+          its (:host) {should eq 'www.honeybadger.com/'}
+        end
+
+        subject {redirect}
+        its (:shortened_url) {should eq 'www.honeybadger.com/a/eeeeee'}
+      end
+    end
+
+    context 'path' do
+
+      shared_examples_for 'a correct redirect' do
+        before {SecureRandom.should_receive(:urlsafe_base64).with(6).at_most(:once).and_return('eeeeee')}
+        let (:redirect) {Redirect.create_shortened_url 'www.springbot.com'}
+        context 'global host' do
+          subject {Redirect}
+          its (:path) {should eq 'badger/'}
+        end
+
+        subject {redirect}
+        its (:shortened_url) {should eq 'www.honeybadger.com/badger/eeeeee'}
+        its (:shortened_path) {should eq 'badger/eeeeee'}
+      end    
+
+      context 'no trailing slash' do        
+        before { Redirect.path = 'badger'}
+        it_behaves_like 'a correct redirect'
+      end
+
+      context 'no trailing slash and slash at the beginning' do        
+        before { Redirect.path = '/badger' }
+        it_behaves_like 'a correct redirect'
+      end
+
+    end
+  end
+end

data/spec/unit/rack/redir_spec.rb

@@ -0,0 +1,189 @@
+require 'spec_helper'
+include RedirHelper
+
+describe :redir do
+
+  after :each do
+    Redirect.delete_all
+    RedirectLog.delete_all
+  end
+
+  shared_examples_for 'code that redirects' do
+
+    before do
+      before
+      get redirect.shortened_path.to_s
+    end
+
+    context 'redirects' do
+      before do
+        follow_redirect!
+      end
+
+      context 'url' do
+        subject {last_request}
+        its(:url) {should eq redirect.original_url}
+      end
+
+      context 'response' do
+        subject {last_response.errors.size}
+        it {should eq 0}
+      end
+    end
+
+  end
+
+  let(:before) {Time.now}
+  let(:after) {Time.now}
+
+  context 'should apply class level settings for the url and path' do
+    before do
+      SecureRandom.should_receive(:urlsafe_base64).with(6).and_return('eeeeee')
+      Redirect.path = 'foo/'
+      Redirect.host = 'http://myredir.com/'
+    end
+
+    let(:redirect) { Redirect.create_shortened_url 'http://www.google.com/' }
+    subject {redirect}
+    its (:shortened_id) {should eq 'eeeeee'}
+    its (:shortened_path) {should eq 'foo/eeeeee'}
+    its (:shortened_url) {should eq 'http://myredir.com/foo/eeeeee'}
+
+    context 'non default path' do
+      it_behaves_like 'code that redirects'
+    end
+
+    after do
+      Redirect.path = 'a/'
+      Redirect.host = 'http://localhost:3000/'
+    end
+  end
+
+
+  context 'general redirect' do
+
+    let(:redirect) {create :redirect}
+    before do
+      before
+      get redirect.shortened_path.to_s
+    end
+
+    it_behaves_like 'code that redirects'
+
+    let(:redirect_log) {RedirectLog.where(:redirect_id => redirect.id).to_a.last}
+
+    context 'headers' do
+      subject {redirect_log.headers}
+      its (['HTTP_HOST']) {should eq 'example.org'}
+      its (['HTTP_COOKIE']) {should eq ''}
+    end
+
+    context 'request time' do
+      subject {redirect_log}
+      its (:request_time) {should > before}
+      its (:request_time) {should < after}
+    end 
+  end
+
+  context 'redirect with tracking info appended' do
+    before do
+      Redirect.append_tracking_info = true 
+      get redirect.shortened_path.to_s
+      follow_redirect!
+    end
+    let (:redirect_log) {Redirector.find_logs(redirect.shortened_id).last}
+
+    context 'with existing url data' do
+      let (:redirect) {create :redirect, :original_url => 'www.google.com/?foo=bar'}
+      subject {last_request}
+      its (:url) {should eq "http://www.google.com/?foo=bar&redirect_mongo_id=#{redirect_log.redirect_id}" +
+                            "&redirect_log_mongo_id=#{redirect_log._id}"}
+    end
+
+    context 'without existing url data' do
+      let (:redirect) {create :redirect, :original_url => 'www.google.com'}
+      subject {last_request}
+      its (:url) {should eq "http://www.google.com/?redirect_mongo_id=#{redirect_log.redirect_id}" +
+                            "&redirect_log_mongo_id=#{redirect_log._id}"}
+    end
+
+    after do
+      Redirect.append_tracking_info = false
+    end
+  end
+
+  context 'redirect with google analytics info appended' do
+    before do
+      Redirect.append_google_analytics = true 
+      get redirect.shortened_path.to_s
+      follow_redirect!
+    end
+    let (:redirect_log) {Redirector.find_logs(redirect.shortened_id).last}
+
+    context 'with existing url data' do
+      let (:redirect) {create :redirect, :original_url => 'www.google.com/?foo=bar'}
+      subject {last_request}
+      its (:url) {should eq "http://www.google.com/?foo=bar&utm_source=http%3A%2F%2Flocalhost%3A3000%2F" +
+                            "&utm_campaign=#{redirect_log.redirect_id}__#{redirect_log._id}"}
+    end
+
+    context 'without existing url data' do
+      let (:redirect) {create :redirect, :original_url => 'www.google.com'}
+      subject {last_request}
+      its (:url) {should eq "http://www.google.com/?utm_source=http%3A%2F%2Flocalhost%3A3000%2F" +
+                            "&utm_campaign=#{redirect_log.redirect_id}__#{redirect_log._id}"}
+    end
+
+    after do
+      Redirect.append_google_analytics = false
+    end
+  end
+
+  context 'redirect with no preceeding http' do
+    before do
+      get redirect.shortened_path.to_s
+      follow_redirect!
+    end
+
+    context 'url without http' do
+      let (:redirect) {create :redirect, :original_url => 'www.google.com'}
+      subject {last_request}
+      its (:url) {should eq 'http://www.google.com/'}
+    end
+
+    context 'url without http and leading space' do
+      let (:redirect) {create :redirect, :original_url => ' www.google.com'}
+      subject {last_request}
+      its (:url) {should eq 'http://www.google.com/'}
+    end
+  end
+
+  context 'bad redirect' do
+
+    before do
+      get "/a/ugh"
+    end
+
+    context 'status' do
+      subject {last_response.status}
+      it {should eq 404}
+    end
+
+  end
+
+  context 'non rdr path' do
+
+    before do
+      get "/rddd/ugh"
+    end
+
+    context 'status' do
+      subject {last_response.status}
+      it {should eq 200}
+    end
+
+  end
+
+end
+
+

data/spec/unit/redirector_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+include RedirHelper
+
+describe :redirector do
+
+  let(:redirect) { Redirect.create_shortened_url 'http://www.google.com/' }
+  before {get redirect.shortened_path.to_s}
+
+  context 'find logs' do
+
+    subject {Redirector.find_logs(redirect.shortened_id).to_a}
+    its(:size) {should eq 1}
+
+    context 'data' do
+      subject {Redirector.find_logs(redirect.shortened_id).to_a.last.headers['HTTP_HOST']}
+      it {should eq 'example.org'}
+    end
+
+    context 'multiple requests' do
+      before {get redirect.shortened_path.to_s}
+      subject {Redirector.find_logs(redirect.shortened_id).to_a}
+      its(:size) {should eq 2}
+    end 
+  end
+
+  context 'number of redirect hits' do
+    subject {Redirector.number_of_redirect_hits redirect.shortened_id}
+    it {should eq 1}
+
+    context 'multiple requests' do
+      before {get redirect.shortened_path.to_s}
+      subject {Redirector.number_of_redirect_hits redirect.shortened_id}
+      it {should eq 2}
+    end
+
+  end
+
+  after :all do
+    Redirect.delete_all
+    RedirectLog.delete_all
+  end
+end

metadata

@@ -0,0 +1,213 @@
+--- !ruby/object:Gem::Specification
+name: Redir
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+  prerelease: 
+platform: ruby
+authors:
+- Lance Gleason
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mongoid
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem adds functionality to shorten url's and gather data about requests
+  going through it.
+email: lgleason@polyglotprogramminginc.com
+executables: []
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.md
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- VERSION
+- lib/model/redirect.rb
+- lib/model/redirect_log.rb
+- lib/rack/redir.rb
+- lib/redir.rb
+- lib/redirector.rb
+- redir.gemspec
+- spec/factories/redirect.rb
+- spec/mongoid.yml
+- spec/spec_helper.rb
+- spec/unit/model/redirect_spec.rb
+- spec/unit/rack/redir_spec.rb
+- spec/unit/redirector_spec.rb
+homepage: http://github.com/springbot/redir
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3974193222744285079
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Mongo based url shortener and data gathering gem.
+test_files: []