too_short 0.1.1 → 0.1.2

data/README.rdoc

@@ -1,6 +1,6 @@
 ==TooShort
 
-TooShort is a simple short URL service for your resources. And it works without an extra database table.
+TooShort allows you to create persistent short URLs for your resources. And it works without any additional storage.
 
 ---- 
 
@@ -33,19 +33,14 @@ In your models:
     has_as_short_url :scope => 'b'
   end
   
-  @foo.short_url # => http://2sh.de/*f*/2n9c
-  @bar.short_url # => http://2sh.de/*b*/2n9c    
+  @foo.short_url # => http://2sh.de/f/2n9c
+  @bar.short_url # => http://2sh.de/b/2n9c    
   
 ---
 
 ==Expanding a short URL
 
 Add routes:
-  (Rails 2)
-  map.connect '/:scope/:hash', :controller => :short_urls, :action => :expand # for multiple resources
-  map.connect '/:hash', :controller => :short_urls, :action => :expand # for a single resource
-  
-  (Rails 3)
   get '/:scope/:hash' => 'short_urls#expand' # for multiple resources
   get '/:hash' => 'short_urls#expand' # for a single resource
 
@@ -67,7 +62,7 @@ This can be overwritten by overwriting two methods
   respond_to_invalid_short_url
 
 The object that was looked up for the given short URL is stored in
-  @expanded_object
+  @object_from_short_url
   
 ---  
 
@@ -75,12 +70,13 @@ The object that was looked up for the given short URL is stored in
 
   @post = Post.create
   @post.id        # => 123456
-  post.short_url  # => http://2sh.de/*2n9c*
+  post.short_url  # => http://2sh.de/2n9c
   123456.to_i(36) # => "2n9c"
   "2n9c".to_s(36) # => 123456
 
-<em>I borrowed this from http://blog.saush.com/2009/04/13/clone-tinyurl-in-40-lines-of-ruby-code/
+<em>I borrowed this from http://blog.saush.com/2009/04/13/clone-tinyurl-in-40-lines-of-ruby-code/</em>
 
+I go into more detail on the inner workings of TooShort here: http://sens3.com/posts/tooshort-rubygem
 
 == Contributing to too_short
  

data/Rakefile

@@ -15,8 +15,8 @@ Jeweler::Tasks.new do |gem|
   gem.name = "too_short"
   gem.homepage = "http://github.com/sens3/too_short"
   gem.license = "MIT"
-  gem.summary = %Q{A simple short URL service for your resources}
-  gem.description = %Q{A simple short URL service for your resources, no extra database table necessary}
+  gem.summary = %Q{A URL shortener for your resources}
+  gem.description = %Q{TooShort allows you to create persistent short URLs for your resources, without any additional storage.}
   gem.email = "makesens3@gmail.com"
   gem.authors = ["Simon Baumgartner"]
   # Include your dependencies below. Runtime dependencies are required when using your gem,

data/VERSION

@@ -1 +1 @@
-0.1.1
+0.1.2

data/lib/ar_base_extensions.rb

@@ -1,6 +1,16 @@
 module TooShort
   module ARBaseExtensions
     
+    
+    # To be included in your model, i.e
+    # class Post
+    #   has_a_short_url
+    # end
+    #
+    # Takes the following options:
+    #   host: short URL host to use (alternatively to be defined in an initializer file)
+    #   scope: the scope for this model, necessary when short URLs are used in multiple models
+    #
     def has_a_short_url(options={})
       short_url_options = TooShort.options.merge(options)
       short_url_options.symbolize_keys!

data/lib/controller_methods.rb

@@ -1,16 +1,27 @@
 module TooShort
+  
+  # To be included in the controller that should handle short URLs, i.e
+  # class ShortUrlsController < ApplicationController
+  #   include TooShort::ControllerMethods
+  # end
+  #
+  # response handling can be customized by overwriting these methods
+  # respond_to_valid_short_url
+  # respond_to_invalid_short_url
+  #
+  # the object that was looked up can be accessed via @object_from_short_url
   module ControllerMethods
     def expand
       require_all_model_classes
-      if @expanded_object = TooShort.expand_to_object(params[:scope], params[:hash])
+      if @object_from_short_url = TooShort.expand_to_object(params[:scope], params[:hash])
         respond_to_valid_short_url
       else
         respond_to_invalid_short_url
       end    
     end
-  
+    
     def respond_to_valid_short_url
-      redirect_to @expanded_object
+      redirect_to @object_from_short_url
     end
   
     def respond_to_invalid_short_url

data/too_short.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{too_short}
-  s.version = "0.1.1"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Simon Baumgartner"]
-  s.date = %q{2011-01-30}
-  s.description = %q{A simple short URL service for your resources, no extra database table necessary}
+  s.date = %q{2011-01-31}
+  s.description = %q{TooShort allows you to create persistent short URLs for your resources, without any additional storage.}
   s.email = %q{makesens3@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
@@ -37,7 +37,7 @@ Gem::Specification.new do |s|
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{A simple short URL service for your resources}
+  s.summary = %q{A URL shortener for your resources}
   s.test_files = [
     "spec/ar_base_extensions_spec.rb",
     "spec/controller_methods_spec.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: too_short
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 31
   prerelease: false
   segments: 
   - 0
   - 1
-  - 1
-  version: 0.1.1
+  - 2
+  version: 0.1.2
 platform: ruby
 authors: 
 - Simon Baumgartner
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-01-30 00:00:00 +01:00
+date: 2011-01-31 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -112,7 +112,7 @@ dependencies:
         - 0
         version: "0"
   requirement: *id006
-description: A simple short URL service for your resources, no extra database table necessary
+description: TooShort allows you to create persistent short URLs for your resources, without any additional storage.
 email: makesens3@gmail.com
 executables: []
 
@@ -170,7 +170,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: A simple short URL service for your resources
+summary: A URL shortener for your resources
 test_files: 
 - spec/ar_base_extensions_spec.rb
 - spec/controller_methods_spec.rb