shortener 0.1.2 → 0.2.0

data/.gitignore

@@ -11,3 +11,4 @@ bin/*
 *.gem
 *.swp
 Gemfile.lock
+.rvmrc

data/README.rdoc

@@ -77,6 +77,22 @@ And to access those URLs:
 
   user.shortened_urls
 
+=== Shorten URLs in generated emails
+
+You can register the included mail interceptor to shorten all links in the emails generated by your Rails app. For example, add to your mailer:
+
+  class MyMailer < ActionMailer::Base
+    register_interceptor Shortener::ShortenUrlInterceptor.new
+  end
+
+This will replace all long URLs in the emails generated by MyMailer with shortened versions. The base URL for the shortener will be infered from the mailer's default_url_options. If you use a different hostname for your shortener, you can use:
+
+  class MyMailer < ActionMailer::Base
+    register_interceptor Shortener::ShortenUrlInterceptor.new :base_url => "http://shortener.host"
+  end
+
+The interceptor supports a few more arguments, see the implementation for details.
+
 == Origins
 
 Shortener is based on code from Dealush[http://dealush.com], for a bit of backstory to Shortener see this {blog post}[http://jamespmcgrath.com/a-simple-link-shortener-in-rails/].

data/app/controllers/shortener/shortened_urls_controller.rb

@@ -2,8 +2,11 @@ class Shortener::ShortenedUrlsController < ActionController::Base
 
   # find the real link for the shortened link key and redirect
   def show
+    # only use the leading valid characters
+    token = /^([#{Shortener.key_chars.join}]*).*/.match(params[:id])[1]
+
     # pull the link out of the db
-    sl = ::Shortener::ShortenedUrl.find_by_unique_key(params[:id])
+    sl = ::Shortener::ShortenedUrl.find_by_unique_key(token)
 
     if sl
       # don't want to wait for the increment to happen, make it snappy!

data/lib/shortener.rb

@@ -3,6 +3,7 @@ require "active_support/dependencies"
 module Shortener
 
   autoload :ActiveRecordExtension, "shortener/active_record_extension"
+  autoload :ShortenUrlInterceptor, "shortener/shorten_url_interceptor"
 
   CHARSETS = {
     :alphanum => ('a'..'z').to_a + (0..9).to_a,

data/lib/shortener/railtie.rb

@@ -6,6 +6,8 @@ class Shortener::Railtie < ::Rails::Railtie #:nodoc:
     ActiveSupport.on_load :active_record do
       extend Shortener::ActiveRecordExtension
     end
-    ActionView::Base.send :include, Shortener::ShortenerHelper
+    ActiveSupport.on_load :action_view do
+      include Shortener::ShortenerHelper
+    end
   end
 end

data/lib/shortener/shorten_url_interceptor.rb

@@ -0,0 +1,63 @@
+# -*- coding: utf-8 -*-
+module Shortener
+=begin
+The Shorten URL Interceptor is a mail interceptor which shortens any URLs
+in generated emails.
+
+Usage:
+
+  class MyMailer < ActionMailer::Base
+    register_interceptor Shortener::ShortenUrlInterceptor.new
+  end
+=end
+  class ShortenUrlInterceptor
+
+    DEFAULT_NOT_SHORTEN = [ 'twitter\.com/',
+                            'facebook\.com/',
+                            'cloudfront\.net/' ].map {|r| Regexp.new(r) }
+    DEFAULT_LENGTH_THRESHOLD = 20
+
+    URL_REGEX = /\b((https?):\/\/\w+\.)[-A-Z0-9+&@#\/%?=~_|$!:,.;]*[-A-Z0-9+&@#\/%=~_|$]/i
+    MIME_TYPES = %w(text/plain text/html application/xhtml+xml)
+
+    def initialize(opts = {})
+      @not_shorten = opts[:not_shorten] || DEFAULT_NOT_SHORTEN
+      @length_threshold = opts[:length_threshold] || DEFAULT_LENGTH_THRESHOLD
+      @base_url = opts[:base_url] || ShortenUrlInterceptor.infer_base_url
+    end
+
+    def delivering_email(email)
+      [email, email.all_parts].flatten.compact.each do |part|
+        if MIME_TYPES.include?(part.mime_type)
+          part.body = part.body.decoded.gsub(URL_REGEX) do |url|
+            shorten_url(url)
+          end
+        end
+      end
+    end
+
+    protected
+
+    def shorten_url(url)
+      if url.length > @length_threshold && ! @not_shorten.any?{|r| r =~ url}
+        short_url = Shortener::ShortenedUrl.generate!(url)
+        File.join(@base_url, short_url.unique_key)
+      else
+        url
+      end
+    rescue => err
+      raise err if Rails.env.test?
+      Airbrake.notify(err, :url => url) if defined?(Airbrake)
+      return url
+    end
+
+    def self.infer_base_url
+      host = ActionMailer::Base.default_url_options[:host]
+      if host.blank?
+        raise "Please supply :base_url for ShortenUrlInterceptor or define default_url_options for mailer"
+      else
+        "http://#{host}/"
+      end
+    end
+  end
+end

data/lib/shortener/version.rb

@@ -1,3 +1,3 @@
 module Shortener
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 end

data/spec/controllers/shortened_urls_controller_spec.rb

@@ -1,19 +1,40 @@
 # -*- coding: utf-8 -*-
 require 'spec_helper'
 
+shared_examples_for "good code" do
+  it "redirects to actual url" do
+    get :show, :id => code
+    response.should redirect_to("http://www.doorkeeperhq.com/")
+  end
+end
+
+shared_examples_for "wrong code" do
+  it "redirects to actual url" do
+    get :show, :id => code
+    response.should redirect_to("/")
+  end
+end
+
 describe Shortener::ShortenedUrlsController do
   let(:short_url) { Shortener::ShortenedUrl.generate("www.doorkeeperhq.com") }
 
-  describe "GET show with good code" do
-    it "redirects to actual url" do
-      get :show, :id => short_url.unique_key
-      response.should redirect_to("http://www.doorkeeperhq.com/")
-    end
+  describe "GET show with actual code" do
+    let(:code) { short_url.unique_key}
+    it_should_behave_like "good code"
   end
+
+  describe "GET show with good code but trailing characters" do
+    let(:code) { "#{short_url.unique_key}-" }
+    it_should_behave_like "good code"
+  end
+
   describe "GET show with wrong code" do
-    it "redirects to actual url" do
-      get :show, :id => "testing"
-      response.should redirect_to("/")
-    end
+    let(:code) { "testing" }
+    it_should_behave_like "wrong code"
+  end
+
+  describe "GET show with code of invalid characters" do
+    let(:code) { "-" }
+    it_should_behave_like "wrong code"
   end
 end

data/spec/dummy/config/application.rb

@@ -1,10 +1,6 @@
 require File.expand_path('../boot', __FILE__)
 
-require "active_model/railtie"
-require "active_record/railtie"
-require "action_controller/railtie"
-require "action_view/railtie"
-
+require "rails/all"
 Bundler.require
 require "shortener"
 
@@ -40,5 +36,7 @@ module Dummy
 
     # Configure sensitive parameters which will be filtered from the log file.
     config.filter_parameters += [:password]
+
+    config.action_mailer.default_url_options = { :host => "mbln.jp" }
   end
 end

data/spec/shortener/shorten_url_interceptor_spec.rb

@@ -0,0 +1,62 @@
+# -*- coding: utf-8 -*-
+require 'spec_helper'
+require 'mail'
+
+describe Shortener::ShortenUrlInterceptor do
+
+  def create_email(body)
+    Mail.new(:from => 'test@mbln.jp', :to => 'test@mbln.jp', :body => body).tap do |m|
+      m.encoded
+      Shortener::ShortenUrlInterceptor.new.delivering_email(m)
+    end
+  end
+
+  TEXTS = [ "Test with URL: %{url}",
+            "Test with URL: %{url}!",
+            "Test with URL: %{url}, hu!",
+            "Test with URL: %{url}. hu!",
+            "Test with URL: <a href='%{url}'>test</a>",
+            "Test with URL: <a href=\"%{url}\">test</a>" ]
+  
+  shared_examples_for "shortens URL in text" do |url|
+    TEXTS.each do |raw_email_body_text|
+      email_body_text = raw_email_body_text % {:url => url}
+      it("shortens for #{email_body_text}") do
+        email = create_email(email_body_text)
+        short_url = Shortener::ShortenedUrl.find_by_url(url)
+        short_url.should_not be_nil
+        email.body.should == (raw_email_body_text % {:url => "http://mbln.jp/#{short_url.unique_key}"})
+      end
+    end
+  end
+
+  shared_examples_for "does not shorten URL" do |url|
+    TEXTS.each do |raw_email_body_text|
+      email_body_text = raw_email_body_text % {:url => url}
+      it("keeps URL for #{email_body_text}") do
+        email = create_email(email_body_text)
+        short_url = Shortener::ShortenedUrl.find_by_url(url)
+        short_url.should be_nil
+        email.body.should == email_body_text
+      end
+    end
+  end
+
+  [ "http://client.doorkeeper.jp/events/124-title",
+    "http://client.doorkeeper.jp/events/124-",
+    "http://client.doorkeeper.jp/events/124-title?auth_token=xabagangs",
+    "http://client.doorkeeper.jp/events/124-%E4%F6%A0",
+  ].each do |url|
+    it_should_behave_like "shortens URL in text", url
+  end
+
+  # we won't shorten certain URLs:
+  [ "http://t.co/asdvk",                  # short URL
+    "http://twitter.com/doorkeeper_app",  # twitter URL
+    "http://facebook.com/doorkeeper_app", # facebook URL
+    "http://d1dqic1fklzs1z.cloudfront.net/assets/doorkeeper_group_normal-3a3292fd09e39a70084c247aef60cba9.gif" # asset URL
+  ].each do |url|
+    it_should_behave_like "does not shorten URL", url
+  end    
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortener
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-23 00:00:00.000000000Z
+date: 2012-04-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &17116840 !ruby/object:Gem::Requirement
+  requirement: &70307977503340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -22,10 +22,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *17116840
+  version_requirements: *70307977503340
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &17116300 !ruby/object:Gem::Requirement
+  requirement: &70307977519260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -33,10 +33,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17116300
+  version_requirements: *70307977519260
 - !ruby/object:Gem::Dependency
   name: rspec-rails
-  requirement: &17115620 !ruby/object:Gem::Requirement
+  requirement: &70307977518620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -44,10 +44,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17115620
+  version_requirements: *70307977518620
 - !ruby/object:Gem::Dependency
   name: shoulda-matchers
-  requirement: &17114280 !ruby/object:Gem::Requirement
+  requirement: &70307977517720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -55,7 +55,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17114280
+  version_requirements: *70307977517720
 description: Shortener is a Rails Engine Gem that makes it easy to create and interpret
   shortened URLs on your own domain from within your Rails application. Once installed
   Shortener will generate, store URLS and "unshorten" shortened URLs for your applications
@@ -82,6 +82,7 @@ files:
 - lib/shortener/active_record_extension.rb
 - lib/shortener/engine.rb
 - lib/shortener/railtie.rb
+- lib/shortener/shorten_url_interceptor.rb
 - lib/shortener/version.rb
 - shortener.gemspec
 - spec/controllers/shortened_urls_controller_spec.rb
@@ -113,6 +114,7 @@ files:
 - spec/dummy/script/rails
 - spec/helpers/shortener_helper_spec.rb
 - spec/models/shortened_url_spec.rb
+- spec/shortener/shorten_url_interceptor_spec.rb
 - spec/spec_helper.rb
 homepage: http://jamespmcgrath.com/projects/shortener
 licenses: []
@@ -134,7 +136,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: shortener
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Shortener is a Rails Engine that makes it easy to create shortened URLs for