ivey-longurl 0.1.7

data/.gitignore

@@ -0,0 +1,4 @@
+.DS_Store
+doc
+pkg
+rdoc

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009, Fabien Jakimowicz <fabien@jakimowicz.com>
+
+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/Manifest

@@ -0,0 +1,13 @@
+bin/longurl
+ChangeLog
+lib/longurl/constants.rb
+lib/longurl/direct.rb
+lib/longurl/exceptions.rb
+lib/longurl/service.rb
+lib/longurl.rb
+LICENSE
+longurl.gemspec
+Manifest
+Rakefile
+README
+TODO

data/README.rdoc

@@ -0,0 +1,73 @@
+= LongURL
+
+== DESCRIPTION
+LongURL expands short urls (tinyurl, is.gd, ...) to original ones, using on LongURL.org, internal resolution or direct resolution
+First, expand will try to expand url using longurl.org service.
+Then, it will try to direct follow redirections on the given url and returns final one.
+
+== SYNOPSIS
+=== Options
+* <tt>:cache</tt> : cache object to use, must implement [] and []= functions.
+
+=== Types
+<tt>url</tt> is expected to be a String and returns a String with the url.
+
+=== Examples
+  # simple expands
+  LongURL.expand("http://tinyurl.com/1c2")                              # => "http://www.google.com"
+  LongURL.expand("http://tinyurl.com/blnhsg")                           # => "http://www.google.com/search?q=number+of+horns+on+a+unicorn&ie=UTF-8"
+  LongURL.expand("http://is.gd/iUKg")                                   # => "http://fabien.jakimowicz.com"
+
+  # not expandable urls, without any http call
+  LongURL.expand("http://www.linuxfr.org")                              # => "http://www.linuxfr.org"
+
+	# Use MemCache
+	LongURL.expand("http://is.gd/iUKg", :cache => MemCache.new("localhost:11211", :namespace => "LongURL"))
+																																				# => "http://fabien.jakimowicz.com"
+																																				
+	# Expander class
+	expander = LongURL::Expander.new
+	expander.expand("http://tinyurl.com/1c2")                             # => "http://www.google.com"
+  # not expandable urls, direct resolution only
+  expander.direct_resolution("http://www.linuxfr.org")                  # => "http://www.linuxfr.org/pub"
+  # not expandable urls, calling longurl.org only
+  expander.expand_with_service_only("http://www.linuxfr.org")           # => "http://www.linuxfr.org/pub"
+	# ... with MemCache
+	expander = LongURL::Expander.new(:cache => MemCache.new("localhost:11211", :namespace => "LongURL"))
+	expander.expand("http://tinyurl.com/1c2")                             # => "http://www.google.com"
+
+=== Exceptions
+* LongURL::InvalidURL : will occurs if given url is nil, empty or invalid
+* LongURL::NetworkError : a network (timeout, host could be reached, ...) error occurs
+* LongURL::UnknownError : an unknown error occurs
+
+== REQUIREMENTS
+
+* json gem
+
+== INSTALL
+  gem install longurl
+
+== LICENSE
+
+(The MIT License)
+
+Copyright (c) 2009, Fabien Jakimowicz <fabien@jakimowicz.com>
+
+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/Rakefile

@@ -0,0 +1,70 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name              = "ivey-longurl"
+    s.summary           = %q{LongURL expands shorten urls (tinyurl, is.gd, ...)}
+    s.homepage          = "http://github.com/ivey/longurl"
+    s.description       = %q{LongURL expands short urls (tinyurl, is.gd, ...) to original ones, using on LongURL.org, internal resolution or direct resolution}
+    s.authors           = ["Fabien Jakimowicz", "Michael D. Ivey"]
+    s.email             = "ivey@gweezlebur.com"
+    s.rubyforge_project = 'longurl'
+
+    s.add_dependency 'json'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+desc "build rdoc using hanna theme"
+task :rdoc do
+  `rm -rf rdoc && rdoc --op=rdoc --title=LongURL --inline-source --format=darkfish LICENSE README* lib/**/*.rb`
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |t|
+    t.libs << 'test'
+    t.test_files = FileList['test/**/*_test.rb']
+    t.verbose = true
+  end
+rescue LoadError
+  puts "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+end
+
+# Rubyforge publishing
+begin
+  require 'rake/contrib/sshpublisher'
+  namespace :rubyforge do
+
+    desc "Release gem and RDoc documentation to RubyForge"
+    task :release => ["rubyforge:release:gem", "rubyforge:release:docs"]
+
+    namespace :release do
+      desc "Publish RDoc to RubyForge."
+      task :docs => [:rdoc] do
+        config = YAML.load(
+            File.read(File.expand_path('~/.rubyforge/user-config.yml'))
+        )
+
+        host = "#{config['username']}@rubyforge.org"
+        remote_dir = "/var/www/gforge-projects/longurl/"
+        local_dir = 'rdoc'
+
+        Rake::SshDirPublisher.new(host, remote_dir, local_dir).upload
+      end
+    end
+  end
+rescue LoadError
+  puts "Rake SshDirPublisher is unavailable or your rubyforge environment is not configured."
+end
+
+task :default => :test

data/TODO

@@ -0,0 +1,6 @@
+* add a cache to avoid multiple calls for same url
+ * cache could be : hash, memcache, ...
+* handle http errors
+* handle json parsing errors
+* handle ServiceUnknown exception
+* possible infinite loop in Direct::follow_redirections

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:patch: 7
+:major: 0
+:minor: 1

data/bin/longurl

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+
+require "rubygems"
+require "longurl"
+
+def usage
+  puts "Usage: #$0 <url>"
+  exit(-1)
+end
+
+if ARGV.size < 1
+  usage
+end
+
+puts LongURL.expand(ARGV[0])

data/lib/longurl.rb

@@ -0,0 +1,11 @@
+# Copyright (c) 2009 by Fabien Jakimowicz (fabien@jakimowicz.com)
+#
+# Please see the LICENSE file for licensing.
+
+require 'longurl/constants'
+require 'longurl/exceptions'
+require 'longurl/url'
+require 'longurl/service'
+require 'longurl/direct'
+require 'longurl/expander'
+require 'longurl/expand'

data/lib/longurl/constants.rb

@@ -0,0 +1,9 @@
+require "uri"
+
+module LongURL
+  ShortURLMatchRegexp = /http:\/\/[\/\-_.a-z0-9]+/im
+
+  # Urls for longurl
+  EndPoint        = URI.parse("http://api.longurl.org/v2/expand")
+  ServiceEndPoint = URI.parse("http://api.longurl.org/v2/services")
+end

data/lib/longurl/direct.rb

@@ -0,0 +1,26 @@
+require "net/http"
+require "longurl/url"
+require "longurl/exceptions"
+
+module LongURL
+  module Direct
+    # Will follow redirections given url <tt>orig</tt>.
+    # === Exceptions
+    # * LongURL::NetworkError in case of a network error (timeout, socket error, ...)
+    # * LongURL::InvalidURL in case of a bad url (nil, empty, not http scheme ...)
+    # * LongURL::TooManyRedirections if there are too many redirection for destination
+    def self.follow_redirections(orig, limit = 5)
+      raise LongURL::TooManyRedirections if limit == 0
+      uri = LongURL::URL.check(orig)
+      Net::HTTP.start(uri.host, uri.port) do |http|
+        answer = http.get(uri.path.empty? ? '/' : uri.path)
+        dest = answer['Location']
+        (dest && dest[0, 7] == 'http://' && follow_redirections(dest, limit - 1)) || orig
+      end
+    rescue Timeout::Error, Errno::ENETUNREACH, Errno::ETIMEDOUT, SocketError
+      raise LongURL::NetworkError
+    rescue
+      raise LongURL::UnknownError
+    end
+  end
+end

data/lib/longurl/exceptions.rb

@@ -0,0 +1,21 @@
+module LongURL
+  # Raised by LongURL::Service class if longurl.org service returns unsupported service error.
+  class UnsupportedService < StandardError
+  end
+
+  # Raised by LongURL::Service class if longurl.org service returns a not supported answer.
+  class UnknownError < StandardError
+  end
+  
+  # Raised by LongURL::Service if supplied url is invalid (nil, empty, ...)
+  class InvalidURL < StandardError
+  end
+  
+  # Raised if a network error occurs : timeout, unreachable network, ...
+  class NetworkError < StandardError
+  end
+  
+  # Raised if there are too many redirection in a direct resolution.
+  class TooManyRedirections < StandardError
+  end
+end

data/lib/longurl/expand.rb

@@ -0,0 +1,39 @@
+require 'longurl/expander'
+
+module LongURL
+  
+  class << self
+
+    # Expand given <tt>:url</tt> to a longest one.
+    # First, expand will try to expand url using longurl.org service.
+    # Then, it will try to direct follow redirections on the given url and returns final one.
+    # === Options
+    # * <tt>:cache</tt> : cache object to use, must implement [] and []= functions.
+    # * <tt>:first_only</tt> : if true, users all-redirects option to the API to fetch only the first redirect
+    #   instead of following all of them. Useful to identify the original URL that was shortened, not the
+    #   destination.
+    # === Types
+    # <tt>url</tt> is expected to be a String and returns a String with the url.
+    # === Examples
+    #   # simple expands
+    #   LongURL.expand("http://tinyurl.com/1c2")                              # => "http://www.google.com"
+    #   LongURL.expand("http://tinyurl.com/blnhsg")                           # => "http://www.google.com/search?q=number+of+horns+on+a+unicorn&ie=UTF-8"
+    #   LongURL.expand("http://is.gd/iUKg")                                   # => "http://fabien.jakimowicz.com"
+    #
+    #   # not expandable urls
+    #   LongURL.expand("http://www.linuxfr.org")                              # => "http://www.linuxfr.org"
+    #
+    # === Exceptions
+    # * LongURL::InvalidURL : will occurs if given url is nil, empty or invalid
+    # * LongURL::NetworkError : a network (timeout, host could be reached, ...) error occurs
+    # * LongURL::UnknownError : an unknown error occurs
+    def expand(url, options = {})
+      @@expander ||= Expander.new(
+        :cache => options[:cache],
+        :first_only => options[:first_only]
+      )
+      @@expander.expand(url)
+    end
+  end
+  
+end

data/lib/longurl/expander.rb

@@ -0,0 +1,95 @@
+require "longurl/exceptions"
+require "longurl/service"
+require "longurl/direct"
+
+module LongURL
+  
+  # == URL Expander class.
+  # Will use Service and Direct classes to expand an url.
+  # Each call to external services is cached to save time and cache object is customizable.
+  # You can for example use MemCache for the cache. it will allow different instances of Expander and Service to share the same cache.
+  # === Examples
+  #   # Simple usage
+  #   e = LongURL::Expander.new
+  #   e.expand("http://tinyurl.com/1c2")                              # => "http://www.google.com"
+  #   e.expand("http://tinyurl.com/blnhsg")                           # => "http://www.google.com/search?q=number+of+horns+on+a+unicorn&ie=UTF-8"
+  #   e.expand("http://is.gd/iUKg")                                   # => "http://fabien.jakimowicz.com"
+  #
+  #   # not expandable urls
+  #   e.expand("http://www.linuxfr.org")                              # => "http://www.linuxfr.org"
+  #
+  #   # not expandable urls, calling longurl.org only
+  #   e.expand("http://www.linuxfr.org", :direct_resolution => true)  # => "http://www.linuxfr.org/pub"
+  #
+  #   # not expandable urls, direct resolution only
+  #   e.direct_resolution("http://www.linuxfr.org")                   # => "http://www.linuxfr.org/pub"
+  #
+  #   # MemCache as cache
+  #   e = LongURL::Expander.new(:cache => MemCache.new("localhost:11211", :namespace => "LongURL"))
+  #   e.expand("http://is.gd/iUKg")                                   # => "http://fabien.jakimowicz.com"
+  # === Exceptions
+  # * LongURL::InvalidURL : will occurs if given url is nil, empty or invalid
+  # * LongURL::NetworkError : a network (timeout, host could be reached, ...) error occurs
+  # * LongURL::UnknownError : an unknown error occurs
+  class Expander
+
+    attr_accessor :first_only
+    
+    # Initialize a new Expander.
+    # === Options
+    # * <tt>:cache</tt>: define a cache which Expander can use.
+    #   It must implements [] and []= methods. It can be disabled using false.
+    # * <tt>:first_only</tt> : if true, users all-redirects option to the API to fetch only the first redirect
+    #   instead of following all of them. Useful to identify the original URL that was shortened, not the
+    #   destination.
+    def initialize(options = {})
+      # OPTIMIZE : This code is a complete duplicate of cache handling in service.
+      if options[:cache].nil?
+        @@cache = Hash.new
+      elsif options[:cache] == false
+        @@cache = nil
+      else
+        @@cache = options[:cache]
+      end
+      @@service = Service.new(:cache => @@cache)
+      @first_only = options[:first_only]
+    end
+    
+    # Expand given url using LongURL::Service class first and then try a direct_resolution,
+    # unless :direct_resolution is set to false in options hash.
+    def expand(url, options={ })
+      @@service.query_supported_service_only url, :first_only => first_only
+    rescue UnsupportedService
+      options[:direct_resolution] == false ? raise(UnsupportedService) : direct_resolution(url)
+    end
+    
+    # Try to directly resolve url using LongURL::Direct to get final redirection.
+    # This call is cached.
+    def direct_resolution(url)
+      # OPTIMIZE : this code is almost identical as the one in service for handling service retrieval.
+      if @@cache
+        @@cache[url] ||= Direct.follow_redirections(url)
+      else
+        Direct.follow_redirections(url)
+      end
+    end
+    
+    # Expand all url in the given string, if an error occurs while expanding url, then the original url is used.
+    # <tt>options</tt> accepts same options as expand, see expand for more details.
+    def expand_each_in(text, options = {})
+      text.gsub(ShortURLMatchRegexp) do |shorturl| 
+        begin
+          expand shorturl
+        rescue  InvalidURL,
+                NetworkError,
+                TooManyRedirections,
+                UnknownError,
+                UnsupportedService,
+                JSON::ParserError
+          shorturl
+        end
+      end
+    end # expand_each_in
+    
+  end # Expander
+end # LongURL

data/lib/longurl/service.rb

@@ -0,0 +1,121 @@
+require "net/http"
+require "cgi"
+require "uri"
+require "rubygems"
+require "json"
+require "longurl/constants"
+require "longurl/exceptions"
+require "longurl/url"
+
+module LongURL
+
+  class Service
+    
+    def initialize(params = {})
+      if params[:cache].nil?
+        @@cache = Hash.new
+      elsif params[:cache] == false
+        @@cache = nil
+      else
+        @@cache = params[:cache]
+      end
+      @@supported_services = cached_or_fetch_supported_services
+    end
+    
+    def query_supported_service_only(url, options={ })
+      check url
+      raise LongURL::UnsupportedService unless service_supported?(url)
+      (@@cache && cached_query(url, options)) || query(url, options)
+    end
+    
+    def cached_query(url, options={ })
+      @@cache[url] ||= query(url, options)
+    end
+
+    def query(url, options={ })
+      escaped_url = check_and_escape(url)
+      api_url = "#{EndPoint.path}?format=json&url=#{escaped_url}"
+      if options[:first_only]
+        api_url += "&all-redirects=1"
+      end
+      Net::HTTP.start(EndPoint.host, EndPoint.port) do |http|
+        handle_response http.get(api_url)
+      end
+    rescue Timeout::Error, Errno::ENETUNREACH, Errno::ETIMEDOUT, SocketError
+      raise LongURL::NetworkError
+    end
+        
+    # Check among supported services by longurl.org if given <tt>url</tt> is supported.
+    # Returns true if supported, false otherwise.
+    def service_supported?(url)
+      @@supported_services.include? URI.parse(url).host.downcase
+    end
+    
+    protected
+    
+    # Returns a list of supported services.
+    # Use cache to get the list or fetch it if cache is empty.
+    def cached_or_fetch_supported_services
+      if @@cache
+        @@cache['supported_services'] ||= fetch_supported_services
+      else
+        fetch_supported_services
+      end
+    end
+    
+    # Check given <tt>url</tt> using LongURL::URL.check
+    def check(url)
+      LongURL::URL.check url
+    end
+    
+    # Check given url and escape it for http query argument passing.
+    def check_and_escape(url)
+      check url
+      CGI.escape url
+    end
+    
+    # Fetch supported services from longurl.org api.
+    # Returns supported services in an Array.
+    # Raises LongURL::NetworkError in case of a network error (timeout, ...)
+    def fetch_supported_services
+      Net::HTTP.start(ServiceEndPoint.host, ServiceEndPoint.port) do |http|
+        response = http.get("#{ServiceEndPoint.path}?format=json")
+        parsed = JSON.parse(response.body)
+        parsed.values.collect { |x| x["domain"] }.flatten
+      end
+    rescue Timeout::Error, Errno::ENETUNREACH, Errno::ETIMEDOUT, SocketError
+      raise LongURL::NetworkError
+    rescue
+      raise LongURL::UnknownError
+    end
+    
+    def handle_response(response)
+      parsed = JSON.parse(response.body)
+      parsed = parsed.first if parsed.is_a?(Array)
+      if parsed['all-redirects']
+        parsed['all-redirects'].first
+      elsif parsed['long-url']
+        parsed['long-url']
+      elsif parsed['message'] # Error
+        raise exception_regarding_message(parsed['message'])
+      else
+        raise LongURL::UnknownError
+      end
+    end
+    
+    def exception_class_regarding_message(message)
+      case message
+      when 'Unsupported service.'
+        LongURL::UnsupportedService
+      when 'Connection timeout'
+        LongURL::NetworkError
+      when 'Could not expand URL. Please check that you have submitted a valid URL.'
+        LongURL::InvalidURL
+      else
+        LongURL::UnknownError
+      end
+    end
+
+  end  
+
+end

data/lib/longurl/url.rb

@@ -0,0 +1,18 @@
+require 'uri'
+require "longurl/exceptions"
+
+module LongURL
+  module URL
+    # Check given <tt>url</tt>
+    # Raises LongURL::InvalidURL if <tt>url</tt> is invalid.
+    # Returns a parsed http uri object on success.
+    def self.check(url)
+      raise LongURL::InvalidURL if url.nil? or url.empty?
+      result = URI.parse(url)
+      raise LongURL::InvalidURL unless result.is_a?(URI::HTTP)
+      result
+    rescue URI::InvalidURIError
+      raise LongURL::InvalidURL
+    end
+  end
+end

data/longurl.gemspec

@@ -0,0 +1,75 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{longurl}
+  s.version = "0.1.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Fabien Jakimowicz"]
+  s.date = %q{2009-07-20}
+  s.default_executable = %q{longurl}
+  s.description = %q{LongURL expands short urls (tinyurl, is.gd, ...) to original ones, using on LongURL.org, internal resolution or direct resolution}
+  s.email = %q{fabien@jakimowicz.com}
+  s.executables = ["longurl"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "Manifest",
+     "README.rdoc",
+     "Rakefile",
+     "TODO",
+     "VERSION.yml",
+     "bin/longurl",
+     "lib/longurl.rb",
+     "lib/longurl/constants.rb",
+     "lib/longurl/direct.rb",
+     "lib/longurl/exceptions.rb",
+     "lib/longurl/expand.rb",
+     "lib/longurl/expander.rb",
+     "lib/longurl/service.rb",
+     "lib/longurl/url.rb",
+     "longurl.gemspec",
+     "test/cache_mock.rb",
+     "test/constants.rb",
+     "test/expander_test.rb",
+     "test/service/no_cache_service_test.rb",
+     "test/service/service_cache_test.rb",
+     "test/service/service_test.rb",
+     "test/service/supported_services_test.rb",
+     "test/url_test.rb"
+  ]
+  s.has_rdoc = true
+  s.homepage = %q{http://longurl.rubyforge.org}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{longurl}
+  s.rubygems_version = %q{1.3.1}
+  s.summary = %q{LongURL expands shorten urls (tinyurl, is.gd, ...)}
+  s.test_files = [
+    "test/cache_mock.rb",
+     "test/constants.rb",
+     "test/expander_test.rb",
+     "test/service/no_cache_service_test.rb",
+     "test/service/service_cache_test.rb",
+     "test/service/service_test.rb",
+     "test/service/supported_services_test.rb",
+     "test/url_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<json>, [">= 0"])
+    else
+      s.add_dependency(%q<json>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<json>, [">= 0"])
+  end
+end

data/test/cache_mock.rb

@@ -0,0 +1,20 @@
+class CacheMock
+  
+  attr_accessor :keys_stored, :keys_asked, :storage
+  
+  def initialize(params = {})
+    @storage = {}
+    @keys_stored = []
+    @keys_asked = []
+  end
+  
+  def [](key)
+    @keys_asked << key
+    @storage[key]
+  end
+  
+  def []=(key, value)
+    @keys_stored << key
+    @storage[key] = value
+  end
+end

data/test/constants.rb

@@ -0,0 +1,15 @@
+ShortToLong = {
+  :tiny_url => { 
+    "http://tinyurl.com/cnuw9a" => "http://fabien.jakimowicz.com",
+    "http://tinyurl.com/blnhsg" => "http://www.google.com/search?q=number+of+horns+on+a+unicorn&ie=UTF-8"
+  },
+  :is_gd => {
+    "http://is.gd/iUKg" => "http://fabien.jakimowicz.com",
+    "http://is.gd/iYCo" => "http://www.google.com/search?q=number+of+horns+on+a+unicorn&ie=UTF-8"
+  },
+  :friendfeed => {
+    "http://ff.im/-31OFh" => "http://en.wikipedia.org/wiki/Product_requirements_document",
+    "http://ff.im/-31MWm" => "http://www.infrasystems.com/how-to-write-an-mrd.html"
+  }
+}
+MultipleRedirectURL = "http://bit.ly/9NiEKB"

data/test/expander_test.rb

@@ -0,0 +1,64 @@
+$test_lib_dir = File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift($test_lib_dir)
+
+require "test/unit"
+require "longurl/expander"
+
+class TextExpander < Test::Unit::TestCase
+  def setup
+    @expander = LongURL::Expander.new
+  end
+  
+  def test_expand_each_in_should_expand_friendfeed_urls
+    assert_equal "Product requirements document - Wikipedia, http://en.wikipedia.org/wiki/Product_requirements_document the free encyclopedia",
+      @expander.expand_each_in("Product requirements document - Wikipedia, http://ff.im/-31OFh the free encyclopedia")
+  end
+  
+  def test_expand_each_in_should_not_change_strings_with_no_urls
+    assert_equal "i'm not to be changed !!!", @expander.expand_each_in("i'm not to be changed !!!")
+  end
+  
+  def test_expand_each_in_should_be_able_to_expand_multiple_urls
+    assert_equal "Those websites are great: http://www.flickr.com/photos/jakimowicz & http://www.google.com/profiles/fabien.jakimowicz",
+      @expander.expand_each_in("Those websites are great: http://tinyurl.com/r9cm9p & http://is.gd/Bnxy")
+  end
+  
+  def test_expand_each_in_should_not_replace_unexpandable_urls_if_direct_resolution_is_false
+    assert_equal "Those websites are great: http://www.flickr.com/photos/jakimowicz & http://www.google.com/profiles/fabien.jakimowicz",
+      @expander.expand_each_in( "Those websites are great: http://www.flickr.com/photos/jakimowicz & http://is.gd/Bnxy",
+                                :direct_resolution => false )
+  end
+  
+  def test_expand_should_raise_UnsupportedService_if_service_is_not_supported_and_direct_resolution_disabled
+    assert_raise(LongURL::UnsupportedService) do
+      @expander.expand("http://www.google.com", :direct_resolution => false)
+    end
+  end
+
+  def test_expand_should_use_direct_resolution_by_default
+    assert_nothing_raised do
+      assert_equal "http://fabien.jakimowicz.com", @expander.expand("http://fabien.jakimowicz.com")
+    end
+  end
+  
+  def test_expand_should_expand_supported_services
+    assert_equal "http://www.flickr.com/photos/jakimowicz", @expander.expand('http://tinyurl.com/r9cm9p')
+  end
+  
+  def test_expand_should_handle_direct_resolution_if_asked
+    assert_equal "http://fabien.jakimowicz.com", @expander.expand("http://fabien.jakimowicz.com", :direct_resolution => true)
+  end
+  
+  def test_expand_with_should_continue_to_resolve_urls_even_if_direct_resolution_is_true
+    assert_equal "http://www.flickr.com/photos/jakimowicz", @expander.expand('http://tinyurl.com/r9cm9p', :direct_resolution => true)
+  end
+
+  def test_first_only_defaults_to_false
+    assert !@expander.first_only
+  end
+
+  def test_expand_with_first_only_should_resolve_to_first_not_final
+    expander = LongURL::Expander.new :first_only => true
+    assert_equal "http://gmail.com", expander.expand(MultipleRedirectURL)
+  end
+end

data/test/service/no_cache_service_test.rb

@@ -0,0 +1,31 @@
+$test_lib_dir = File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift($test_lib_dir)
+
+require "test/unit"
+require "constants"
+require "longurl/exceptions"
+require "longurl/service"
+
+class TestNoCacheService < Test::Unit::TestCase
+  # OPTIMIZE : all these tests are a plain copy from service_test.rb, we can make something better.
+  
+  def setup
+    @service = LongURL::Service.new(:cache => false)
+  end
+  
+  def test_query_should_raise_invalid_url_if_url_is_nil
+    assert_raise(LongURL::InvalidURL) { @service.query(nil) }
+  end
+
+  def test_query_should_raise_invalid_url_if_url_is_empty
+    assert_raise(LongURL::InvalidURL) { @service.query('') }
+  end
+
+  def test_query_should_returns_given_url_if_not_shorten_url
+    assert_equal "http://www.google.com", @service.query("http://www.google.com")
+  end
+
+  def test_query_should_returns_expanded_url_for_supported_services
+    ShortToLong.each_value {|service| service.each {|short, long| assert_equal long, @service.query(short)}}
+  end
+end

data/test/service/service_cache_test.rb

@@ -0,0 +1,34 @@
+$test_lib_dir = File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift($test_lib_dir)
+
+require "test/unit"
+require "cache_mock"
+require "constants"
+require "longurl/exceptions"
+require "longurl/service"
+
+class TestServiceCache < Test::Unit::TestCase
+  
+  def setup
+    @cache = CacheMock.new
+    @service = LongURL::Service.new(:cache => @cache)
+  end
+  
+  def test_query_should_use_cache_before_external_fetch
+    url = ShortToLong[:is_gd].keys.first
+    @service.query_supported_service_only(url)
+    assert_equal ['supported_services', url], @cache.keys_asked
+    @service.query_supported_service_only(url)
+    assert_equal ['supported_services', url, url], @cache.keys_asked
+  end
+  
+  def test_query_should_cache_results_from_supported_services
+    ShortToLong.each_value do |service|
+      service.each do |short, long|
+        @service.query_supported_service_only(short)
+        assert @cache.keys_stored.include?(short)
+        assert_equal long, @cache[short]
+      end
+    end
+  end
+end

data/test/service/service_test.rb

@@ -0,0 +1,29 @@
+$test_lib_dir = File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift($test_lib_dir)
+
+require "test/unit"
+require "longurl/exceptions"
+require "longurl/service"
+
+class TestService < Test::Unit::TestCase
+  
+  def setup
+    @service = LongURL::Service.new
+  end
+  
+  def test_query_should_raise_invalid_url_if_url_is_nil
+    assert_raise(LongURL::InvalidURL) { @service.query(nil) }
+  end
+
+  def test_query_should_raise_invalid_url_if_url_is_empty
+    assert_raise(LongURL::InvalidURL) { @service.query('') }
+  end
+
+  def test_query_should_returns_given_url_if_not_shorten_url
+    assert_equal "http://www.google.com", @service.query("http://www.google.com")
+  end
+  
+  def test_query_should_returns_expanded_url_for_supported_services
+    ShortToLong.each_value {|service| service.each {|short, long| assert_equal long, @service.query(short)}}
+  end
+end

data/test/service/supported_services_test.rb

@@ -0,0 +1,41 @@
+$test_lib_dir = File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift($test_lib_dir)
+
+require "test/unit"
+require "cache_mock"
+require "constants"
+require "longurl/exceptions"
+require "longurl/service"
+
+class TestSupportedServices < Test::Unit::TestCase
+  
+  def setup
+    @cache = CacheMock.new
+  end
+  
+  def test_service_should_check_if_available_services_are_in_cache
+    assert_equal [], @cache.keys_asked
+    @service = LongURL::Service.new(:cache => @cache)
+    assert_equal ['supported_services'], @cache.keys_asked
+  end
+
+  def test_service_should_store_available_services_in_cache
+    assert_equal [], @cache.keys_stored
+    @service = LongURL::Service.new(:cache => @cache)
+    assert_equal ['supported_services'], @cache.keys_stored
+  end
+  
+  def test_supported_services_stored_in_cache_should_be_a_flat_array_of_strings
+    @service = LongURL::Service.new(:cache => @cache)
+    assert_kind_of Array, @cache['supported_services']
+    assert @cache['supported_services'].all? {|object| object.is_a?(String)}
+  end
+  
+  def test_service_should_use_supported_services_stored_in_cache_if_available
+    @cache['supported_services'] = ['bleh.com', 'bli.com']
+    @service = LongURL::Service.new(:cache => @cache)
+    assert_equal ['supported_services'], @cache.keys_asked
+    assert_equal ['supported_services'], @cache.keys_stored
+    assert_raise(LongURL::UnsupportedService) { @service.query_supported_service_only(ShortToLong[:is_gd].keys.first) }
+  end
+end

data/test/url_test.rb

@@ -0,0 +1,44 @@
+$test_lib_dir = File.join(File.dirname(__FILE__), "..", "lib")
+$:.unshift($test_lib_dir)
+
+require "test/unit"
+require "uri"
+require "longurl/exceptions"
+require "longurl/url"
+
+class TestURL < Test::Unit::TestCase
+  
+  BadURLs = ["http:",
+             "http://",
+             "http://hoth.entp..."]
+  
+  NotHTTPURLs = ["bleh",
+                 "bleh://",
+                 "bleh://asfd.com",
+                 "ftp://asdf.com",
+                 "google.com",
+                 "asdf@toto.com",
+                 "httpd://asdf.com"]
+                 
+  GoodURLs = ["http://www.google.com", "https://rubyonrails.org"]
+
+  def test_check_should_raise_invalid_url_if_url_is_nil
+    assert_raise(LongURL::InvalidURL) { LongURL::URL.check nil }
+  end
+  
+  def test_check_should_raise_invalid_url_if_url_is_empty
+    assert_raise(LongURL::InvalidURL) { LongURL::URL.check "" }
+  end
+  
+  def test_check_should_raise_invalid_url_if_url_is_invalid
+    BadURLs.each {|bad_url| assert_raise(LongURL::InvalidURL) { LongURL::URL.check bad_url } }
+  end
+  
+  def test_check_should_raise_invalid_url_if_url_is_not_http
+    NotHTTPURLs.each {|bad_url| assert_raise(LongURL::InvalidURL) { LongURL::URL.check bad_url } }
+  end
+  
+  def test_check_should_returns_parsed_url_on_success
+    GoodURLs.each {|good_url| assert_equal URI.parse(good_url), LongURL::URL.check(good_url)}
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: ivey-longurl
+version: !ruby/object:Gem::Version 
+  version: 0.1.7
+platform: ruby
+authors: 
+- Fabien Jakimowicz
+- Michael D. Ivey
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-05-12 00:00:00 -04:00
+default_executable: longurl
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: json
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: LongURL expands short urls (tinyurl, is.gd, ...) to original ones, using on LongURL.org, internal resolution or direct resolution
+email: ivey@gweezlebur.com
+executables: 
+- longurl
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+- TODO
+files: 
+- .gitignore
+- LICENSE
+- Manifest
+- README.rdoc
+- Rakefile
+- TODO
+- VERSION.yml
+- bin/longurl
+- lib/longurl.rb
+- lib/longurl/constants.rb
+- lib/longurl/direct.rb
+- lib/longurl/exceptions.rb
+- lib/longurl/expand.rb
+- lib/longurl/expander.rb
+- lib/longurl/service.rb
+- lib/longurl/url.rb
+- longurl.gemspec
+- test/cache_mock.rb
+- test/constants.rb
+- test/expander_test.rb
+- test/service/no_cache_service_test.rb
+- test/service/service_cache_test.rb
+- test/service/service_test.rb
+- test/service/supported_services_test.rb
+- test/url_test.rb
+has_rdoc: true
+homepage: http://github.com/ivey/longurl
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: longurl
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: LongURL expands shorten urls (tinyurl, is.gd, ...)
+test_files: 
+- test/cache_mock.rb
+- test/constants.rb
+- test/expander_test.rb
+- test/service/no_cache_service_test.rb
+- test/service/service_cache_test.rb
+- test/service/service_test.rb
+- test/service/supported_services_test.rb
+- test/url_test.rb