shortener 0.0.1 → 0.0.2

data/README.rdoc

@@ -2,6 +2,30 @@
 
 Shortener makes it easy to create shortened URLs for your rails application.
 
+== Overview
+
+The majority of the solution consists of two parts:
+
+* a model for storing the details of the shortened link (including the user the shortened link belongs to and counter that increments as the link is clicked);
+* a controller to accept incoming requests, grab the shortened link data out of the database and redirecting the visitors request to the target URL;
+
+=== Some niceities of shortener:
+
+* The controller does a 301 redirect, which is the recommended type of redirect for maintaining maximum google juice to the original URL;
+* A unique code of is generated for each shortened link, instead of using the id of the shortened link record. This means that we can get more unique combinations than if we just used numbers;
+* The link records a count of how many times it has been “un-shortened”;
+* The link can be linked to a user, this allows for stats of the link usage for a particular user and other interesting things;
+* The controller spawns a new thread to record information to the database, allowing the redirect to happen as quickly as possible;
+
+=== Future (possible) improvements:
+
+* There has not been an attempt to remove ambiguous characters (i.e. 1 l and capital i, or 0 and O etc.) from the unique key generated for the link. This means people might copy the link incorrectly if copying the link by hand;
+* The shortened links are found with a case-insensitive search on the unique key. This means that the system can’t take advantage of upper and lower case  to increase the number of unique combinations. This may have an effect for people copying the link by hand;
+* The system could pre-generate unique keys in advance, avoiding the database penalty when checking that a newly generated key is unique;
+* The system could store the shortened URL if the url is to be continually rendered;
+* Some implementations might want duplicate links to be generated each time a user requests it.
+
+
 == Installation
 
 You can use the latest Rails 3 gem with the latest Shortener gem. In your Gemfile:

data/app/helpers/shortener/shortener_helper.rb

@@ -12,10 +12,10 @@ module Shortener::ShortenerHelper
         # 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)
+        short_url = Shortener::ShortenedUrl.generate(shortened_url(url_object), user)
       end
     else
-      short_url = ShortenedUrl.generate(url_object, user)
+      short_url = Shortener::ShortenedUrl.generate(url_object, user)
     end
     
     return short_url.nil? ? nil : shortener_translate_url(short_url.unique_key)

data/lib/shortener/version.rb

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

data/shortener.gemspec

@@ -5,7 +5,7 @@ require File.expand_path("../lib/shortener/version", __FILE__)
 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.description               = "Shortener is a Rails Engine that allows you to generate and store shortened URLs and serve them up for your own application."
   s.files                     = `git ls-files`.split("\n")
   s.version                   = Shortener::VERSION
   s.platform                  = Gem::Platform::RUBY

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: shortener
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-09-01 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &19471660 !ruby/object:Gem::Requirement
+  requirement: &10296620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *19471660
+  version_requirements: *10296620
 - !ruby/object:Gem::Dependency
   name: rails
-  requirement: &19471040 !ruby/object:Gem::Requirement
+  requirement: &10296020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,8 +32,9 @@ dependencies:
         version: 3.0.7
   type: :runtime
   prerelease: false
-  version_requirements: *19471040
-description: Shortener makes it easy to create shortened URLs for your rails application.
+  version_requirements: *10296020
+description: Shortener is a Rails Engine that allows you to generate and store shortened
+  URLs and serve them up for your own application.
 email:
 - gems@jamespmcgrath.com
 executables: []