shortener 0.0.1

data/.gitignore

@@ -0,0 +1,34 @@
+.DS_Store
+log/*
+tmp/**/*
+bin/*
+
+config/database.yml
+db/*.sqlite3
+*~
+public/photos/*
+\#*\#
+#Ignore all log files and process ID files
+*.log
+*.pid
+
+#ignore all generated pshinx config files
+*.sphinx.conf
+
+#ignore all sphinx DB files
+*.spa
+*.spd
+*.sph
+*.spi                  
+*.spk
+*.spl
+*.spm
+*.spp
+
+#ignore radrails files and temp files
+.project
+.loadpath
+._*
+
+.bundle
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify any dependencies in the gemspec
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 James P. McGrath
+
+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.rdoc

@@ -0,0 +1,35 @@
+= Shortener
+
+Shortener makes it easy to create shortened URLs for your rails application.
+
+== Installation
+
+You can use the latest Rails 3 gem with the latest Shortener gem. In your Gemfile:
+
+  gem 'shortener'
+  
+After you install Shortener run the generator:
+
+  rails generate shortener
+  
+This generator will create a migration to create the shortened_urls table where your shortened URLs will be stored.
+
+== Usage
+
+To generate a Shortened URL object for the URL "http://dealush.com" within your controller / models do the following:
+  
+  Shortener::ShortenedURL.generate("http://dealush.com")
+  
+or
+
+  Shortener::ShortenedURL.generate("dealush.com")
+
+To generate and display a shortened URL in your application use the helper method:
+
+  shortened_url("dealush.com")
+  
+This will generate a shortened URL. store it to the db and return a string representing the shortened URL.
+
+== Notes
+
+This is the first release and still has some bugs. I will be releasing fixes for these bugs soon.

data/Rakefile

@@ -0,0 +1,29 @@
+# encoding: UTF-8
+require 'rubygems'
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rake'
+require 'rake/rdoctask'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+task :default => :test
+
+Rake::RDocTask.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Shortener'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/app/controllers/shortener/shortened_urls_controller.rb

@@ -0,0 +1,27 @@
+module Shortener
+  class ShortenedUrlsController < ::ApplicationController
+    
+    # find the real link for the shortened link key and redirect
+    def translate
+      # pull the link out of the db
+      sl = ShortenedUrl.find_by_unique_key(params[:unique_key])
+      
+      if sl
+        # don't want to wait for the increment to happen, make it snappy!
+        # this is the place to enhance the metrics captured
+        # for the system. You could log the request origin
+        # browser type, ip address etc.
+        Thread.new do
+          sl.increment!(:use_count)
+        end
+        # do a 301 redirect to the destination url
+        head :moved_permanently, :location => sl.url
+      else
+        # if we don't find the shortened link, redirect to the root
+        # make this configurable in future versions
+        head :moved_permanently, :location => root_url
+      end
+    end
+    
+  end
+end

data/app/helpers/shortener/shortener_helper.rb

@@ -0,0 +1,24 @@
+module Shortener::ShortenerHelper
+  
+  # generate a url from either a url string, or a shortened url object
+  def shortened_url(url_object, user=nil)
+    
+    short_url = nil
+    
+    if url_object.class != String #== ShortenedUrl
+      if user.nil?
+        short_url = url_object
+      else
+        # if the user has passed in a shortened url, with a user, then 
+        # work out the link for the shortened url and make another with the 
+        # passed user
+        short_url = ShortenedUrl.generate(shortened_url(url_object), user)
+      end
+    else
+      short_url = ShortenedUrl.generate(url_object, user)
+    end
+    
+    return short_url.nil? ? nil : shortener_translate_url(short_url.unique_key)
+  end
+
+end

data/app/models/shortener/shortened_url.rb

@@ -0,0 +1,80 @@
+module Shortener
+  class ShortenedUrl < ActiveRecord::Base
+    
+    UNIQUE_KEY_LENGTH = 5
+    URL_PROTOCOL_HTTP = "http://"
+    
+    REGEX_HTTP_URL = /^\s*(http[s]?:\/\/)?[a-z0-9]+([-.]{1}[a-z0-9]+)*\.[a-z]{2,5}(([0-9]{1,5})?\/.*)?\s*$/i
+    REGEX_LINK_HAS_PROTOCOL = Regexp.new('\Ahttp:\/\/|\Ahttps:\/\/', Regexp::IGNORECASE)
+    REGEX_EMAIL = /^([^@\s]+)@((?:[-a-z0-9]+\.)+[a-z]{2,})$/i
+    
+    validates_format_of :url, :with => REGEX_HTTP_URL, :allow_blank => true
+    validates_presence_of :url
+    validates_uniqueness_of :unique_key
+    
+    belongs_to :user # allows the shortened link to be associated with a user
+    
+    before_validation :clean_destination_url, :init_unique_key, :on => :create
+    
+    
+    # ensure the url starts with it protocol
+    def clean_destination_url
+      if !self.url.blank? and self.url !~ REGEX_LINK_HAS_PROTOCOL
+        self.url.insert(0, URL_PROTOCOL_HTTP)
+      end
+    end
+    
+    def init_unique_key
+      # generate a unique key for the link
+      begin
+        # has about 50 million possible combos
+        self.unique_key = ShortenedUrl::generate_unique_key
+      end while ShortenedUrl::find_by_unique_key self.unique_key
+    end
+    
+    # generate a shortened link from a url
+    # link to a user if one specified
+    # throw an exception if anything goes wrong
+    def self.generate!(orig_url, user=nil)
+      # don't want to generate the link if it has already been generated
+      # so check the datastore
+      uid = user.nil? ? nil : user.id
+      sl = ShortenedUrl.find_by_url_and_user_id(orig_url, uid)
+      
+      return sl if sl
+      
+      # create the shortened link, storing it
+      sl = ShortenedUrl.create!(:url => orig_url, :user => user)
+      
+      # return the url
+      return sl
+    end
+    
+    # return shortened url on success, nil on failure
+    def self.generate(orig_url, user=nil)
+      
+      sl = nil
+      
+      begin
+        sl = ShortenedUrl::generate!(orig_url, user)
+      rescue
+        sl = nil
+      end
+      
+      return sl
+    end
+    
+    
+    
+    private
+    
+    # generate a random string
+    # future mod to allow specifying a more expansive charst, like utf-8 chinese
+    def self.generate_unique_key(size = UNIQUE_KEY_LENGTH)
+      # not doing uppercase as url is case insensitive
+      charset = ('a'..'z').to_a + (0..9).to_a
+      (0...size).map{ charset.to_a[rand(charset.size)] }.join
+    end
+      
+  end
+end

data/config/routes.rb

@@ -0,0 +1,3 @@
+Rails.application.routes.draw do
+  get '/s/:unique_key', :to => 'shortener/shortened_urls#translate', :as => 'shortener_translate'
+end

data/lib/generators/shortener/shortener_generator.rb

@@ -0,0 +1,21 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class ShortenerGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+  
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.new.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+  
+  def create_migration_file
+    migration_template 'migration.rb', 'db/migrate/create_shortened_urls_table.rb'
+  end
+end

data/lib/generators/shortener/templates/migration.rb

@@ -0,0 +1,22 @@
+class CreateShortenedUrlsTable < ActiveRecord::Migration
+  def self.up
+    create_table :shortened_urls do |t|
+      
+      t.integer :user_id # we can link this to a user for interesting things
+      t.string :url, :null => false # the real url that we will redirect to
+      t.string :unique_key, :null => false # the unique key 
+      t.integer :use_count, :null => false, :default => 0 # how many times the link has been clicked
+
+      t.timestamps
+    end
+    
+    add_index :shortened_urls, :unique_key # we will lookup the links in the db with this 
+    add_index :shortened_urls, :user_id # and this
+  end
+
+  def self.down
+    remove_index :shortened_urls, :unique_key
+    remove_index :shortened_urls, :user_id
+    drop_table :shortened_urls
+  end
+end

data/lib/shortener.rb

@@ -0,0 +1,17 @@
+require "active_support/dependencies"
+
+module Shortener
+  
+  # Our host application root path
+  # We set this when the engine is initialized
+  mattr_accessor :app_root
+  
+  # Yield self on setup for nice config blocks
+  def self.setup
+    yield self
+  end
+  
+end
+
+# Require our engine
+require "shortener/engine"

data/lib/shortener/engine.rb

@@ -0,0 +1,10 @@
+require "rails/engine"
+require "shortener"
+
+module Shortener
+  
+  class ShortenerEngine < Rails::Engine
+ 
+  end
+  
+end

data/lib/shortener/version.rb

@@ -0,0 +1,3 @@
+module Shortener
+  VERSION = "0.0.1"
+end

data/shortener.gemspec

@@ -0,0 +1,21 @@
+require File.expand_path("../lib/shortener/version", __FILE__)
+
+# Provide a simple gemspec so you can easily use your enginex
+# project in your rails apps through git.
+Gem::Specification.new do |s|
+  s.name                      = "shortener"
+  s.summary                   = "Shortener makes it easy to create shortened URLs for your rails application."
+  s.description               = "Shortener makes it easy to create shortened URLs for your rails application."
+  s.files                     = `git ls-files`.split("\n")
+  s.version                   = Shortener::VERSION
+  s.platform                  = Gem::Platform::RUBY
+  s.authors                   = [ "James P. McGrath" ]
+  s.email                     = [ "gems@jamespmcgrath.com" ]
+  s.homepage                  = "http://jamespmcgrath.com/projects/shortener"
+  s.rubyforge_project         = "shortener"
+  s.required_rubygems_version = "> 1.3.6"
+  s.add_dependency "activesupport" , ">= 3.0.7"
+  s.add_dependency "rails"         , ">= 3.0.7"
+  s.executables = `git ls-files`.split("\n").map{|f| f =~ /^bin\/(.*)/ ? $1 : nil}.compact
+  s.require_path = 'lib'
+end

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# 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__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "shortener"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end