jakimowicz-longurl 0.0.4 → 0.1.1

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009, Fabien Jakimowicz
+
+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

@@ -0,0 +1,40 @@
+== LongURL
+
+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.
+
+=== 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

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |s|
+    s.name              = "longurl"
+    s.summary           = %q{LongURL expands shorten urls (tinyurl, is.gd, ...)}
+    s.homepage          = "http://longurl.rubyforge.org"
+    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"]
+    s.email             = "fabien@jakimowicz.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
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = 'longurl'
+  rdoc.options << '--line-numbers' << '--inline-source'
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('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
+
+task :default => :test

data/VERSION.yml

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

data/lib/longurl/direct.rb

@@ -1,14 +1,21 @@
-require 'uri'
 require "net/http"
+require "longurl/url"
+require "longurl/exceptions"
 
 module LongURL
   module Direct
-    def self.follow_redirections(orig)
-      uri = URI.parse(orig)
+    # 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)) || orig
+        (dest && dest[0, 7] == 'http://' && follow_redirections(dest, limit - 1)) || orig
       end
     rescue Timeout::Error, Errno::ENETUNREACH, Errno::ETIMEDOUT, SocketError
       raise LongURL::NetworkError

data/lib/longurl/exceptions.rb

@@ -14,4 +14,8 @@ module LongURL
   # 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

@@ -1,3 +1,5 @@
+require 'longurl/expander'
+
 module LongURL
   
   class << self

data/lib/longurl/expander.rb

@@ -1,3 +1,7 @@
+require "longurl/exceptions"
+require "longurl/service"
+require "longurl/direct"
+
 module LongURL
   
   # == URL Expander class.
@@ -30,9 +34,17 @@ module LongURL
   class Expander
     # Initialize a new Expander.
     # === Options
-    # * <tt>:cache</tt>: define a cache which Expander can use. It must implements [] and []= methods.
+    # * <tt>:cache</tt>: define a cache which Expander can use.
+    #   It must implements [] and []= methods. It can be disabled using false.
     def initialize(options = {})
-      @@cache = options[:cache] || Hash.new
+      # 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)
     end
     
@@ -46,7 +58,12 @@ module LongURL
     # Try to directly resolve url using LongURL::Direct to get final redirection.
     # This call is cached.
     def direct_resolution(url)
-      @@cache[url] ||= Direct.follow_redirections(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 given url using LongURL::Service only. If given url is not a expandable url, it will still be given to Service.

data/lib/longurl/service.rb

@@ -5,20 +5,27 @@ require "rubygems"
 require "json"
 require "longurl/constants"
 require "longurl/exceptions"
+require "longurl/url"
 
 module LongURL
 
   class Service
     
     def initialize(params = {})
-      @@cache = params[:cache] || Hash.new
+      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)
       check url
       raise LongURL::UnsupportedService unless service_supported?(url)
-      cached_query url
+      (@@cache && cached_query(url)) || query(url)
     end
     
     def cached_query(url)
@@ -34,25 +41,38 @@ module LongURL
       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
     
-    def check(url)
-      raise LongURL::InvalidURL if url.nil? or url.empty?
-    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
-      @@cache['supported_services'] ||= 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")

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/lib/longurl.rb

@@ -4,6 +4,7 @@
 
 require 'longurl/constants'
 require 'longurl/exceptions'
+require 'longurl/url'
 require 'longurl/service'
 require 'longurl/direct'
 require 'longurl/expander'

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,10 @@
+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"
+  }
+}

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,30 @@
+$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 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,43 @@
+$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"]
+                 
+  GoodURL = "http://www.google.com"
+
+  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
+    assert_equal URI.parse(GoodURL), LongURL::URL.check(GoodURL)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: jakimowicz-longurl
 version: !ruby/object:Gem::Version 
-  version: 0.0.4
+  version: 0.1.1
 platform: ruby
 authors: 
 - Fabien Jakimowicz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-03-06 00:00:00 -08:00
+date: 2009-04-30 00:00:00 -07:00
 default_executable: longurl
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -28,26 +28,34 @@ executables:
 - longurl
 extensions: []
 
-extra_rdoc_files: []
-
+extra_rdoc_files: 
+- LICENSE
+- README
 files: 
+- LICENSE
+- Rakefile
 - VERSION.yml
 - bin/longurl
-- lib/longurl
-- lib/longurl/cache.rb
+- 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.rb
-- test/service_test.rb
+- lib/longurl/url.rb
+- test/cache_mock.rb
+- test/constants.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
+- README
 has_rdoc: true
 homepage: http://longurl.rubyforge.org
 post_install_message: 
 rdoc_options: 
-- --inline-source
 - --charset=UTF-8
 require_paths: 
 - lib
@@ -70,5 +78,11 @@ rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
 summary: LongURL expands shorten urls (tinyurl, is.gd, ...)
-test_files: []
-
+test_files: 
+- test/cache_mock.rb
+- test/constants.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

data/lib/longurl/cache.rb

@@ -1,6 +0,0 @@
-module LongURL
-  class Cache < Hash
-    alias :get :[]
-    alias :set :[]=
-  end
-end

data/test/service_test.rb

@@ -1,43 +0,0 @@
-$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
-  
-  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"
-                 }
-                }
-
-  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_tiny_url
-    ShortToLong[:tiny_url].each {|short, long| assert_equal long, @service.query(short)}
-  end
-
-  def test_query_should_returns_expanded_url_for_is_gd
-    ShortToLong[:is_gd].each {|short, long| assert_equal long, @service.query(short)}
-  end
-end