longurl 0.0.1 → 0.0.2

data/VERSION.yml

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

data/lib/longurl.rb

@@ -6,46 +6,6 @@ require 'longurl/constants'
 require 'longurl/exceptions'
 require 'longurl/service'
 require 'longurl/direct'
-
-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>:try_unsupported</tt> : use longurl.org to resolve the address, even if it is not a supported service
-    # * <tt>:direct_resolution</tt> : fetch url and follow redirection to find the final 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, without any http call
-    #   LongURL.expand("http://www.linuxfr.org")                              # => "http://www.linuxfr.org"
-    #
-    #   # not expandable urls, calling longurl.org only
-    #   LongURL.expand("http://www.linuxfr.org", :try_unsupported => true)    # => "http://www.linuxfr.org/pub"
-    #
-    #   # not expandable urls, direct resolution only
-    #   LongURL.expand("http://www.linuxfr.org", :direct_resolution => true)  # => "http://www.linuxfr.org/pub"
-    #
-    #   # not expandable urls, longurl.org and direct resolution
-    #   LongURL.expand("http://www.linuxfr.org",
-    #                  :try_unsupported => true, :direct_resolution => true)  # => "http://www.linuxfr.org/pub"
-    # === Exceptions
-    # * LongURL::InvalidURL : will occurs if given url is nil, empty or invalid
-    # * LongURL::UnknownError : an unknown error occurs
-    def expand(url, options = {})
-      @@service ||= Service.new
-      options[:try_unsupported] ? @@service.query(url) : @@service.query_supported_service_only(url)
-    rescue UnsupportedService
-      options[:direct_resolution] ? Direct.follow_redirections(url) : url
-    end
-  end
-  
-end
+require 'longurl/cache'
+require 'longurl/expander'
+require 'longurl/expand'

data/lib/longurl/cache.rb

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

data/lib/longurl/exceptions.rb

@@ -1,13 +1,17 @@
 module LongURL
   # Raised by LongURL::Service class if longurl.org service returns unsupported service error.
-  class UnsupportedService < Exception
+  class UnsupportedService < StandardError
   end
 
   # Raised by LongURL::Service class if longurl.org service returns a not supported answer.
-  class UnknownError < Exception
+  class UnknownError < StandardError
   end
   
   # Raised by LongURL::Service if supplied url is invalid (nil, empty, ...)
-  class InvalidURL < Exception
+  class InvalidURL < StandardError
+  end
+  
+  # Raised if a network error occurs : timeout, unreachable network, ...
+  class NetworkError < StandardError
   end
 end

data/lib/longurl/expand.rb

@@ -0,0 +1,30 @@
+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 get and set functions. See LongURL::Cache.
+    # === 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::UnknownError : an unknown error occurs
+    def expand(url, options = {})
+      @@expander ||= Expander.new(:cache => options[:cache])
+      @@expander.expand(url)
+    end
+  end
+  
+end

data/lib/longurl/expander.rb

@@ -0,0 +1,56 @@
+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_with_service_only("http://www.linuxfr.org")            # => "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::UnknownError : an unknown error occurs
+  class Expander
+    # Initialize a new Expander.
+    # === Options
+    # * <tt>:cache</tt>: define a cache which Expander can use. It must implements set and get methods like LongURL::Cache.
+    def initialize(options = {})
+      @@cache = options[:cache] || LongURL::Cache.new
+      @@service = Service.new(:cache => @@cache)
+    end
+    
+    # Expand given url using LongURL::Service class first and then try a direct_resolution.
+    def expand(url)
+      @@service.query_supported_service_only url
+    rescue 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)
+      @@cache.get(url) || @@cache.set(url, Direct.follow_redirections(url))
+    end
+    
+    # Expand given url using LongURL::Service only. If given url is not a expandable url, it will still be given to Service.
+    def expand_with_service_only(url)
+      @@service.query url
+    end
+  end
+end

data/lib/longurl/service.rb

@@ -10,14 +10,21 @@ module LongURL
 
   class Service
     
-    def initialize
-      @@supported_services = fetch_supported_services
+    def initialize(params = {})
+      @@cache = params[:cache]
+
+      @@supported_services = @@cache.get('supported_services')
+      @@supported_services ||= @@cache.set('supported_services', fetch_supported_services)
     end
     
     def query_supported_service_only(url)
       check url
       raise LongURL::UnsupportedService unless service_supported?(url)
-      query url
+      cached_query url
+    end
+    
+    def cached_query(url)
+      @@cache.get(url) || @@cache.set(url, query(url))
     end
 
     def query(url)
@@ -25,6 +32,8 @@ module LongURL
       Net::HTTP.start(EndPoint.host, EndPoint.port) do |http|
         handle_response http.get("#{EndPoint.path}?format=json&url=#{escaped_url}")
       end
+    rescue Timeout::Error, Errno::ENETUNREACH
+      raise LongURL::NetworkError
     end
         
     def service_supported?(url)
@@ -48,6 +57,8 @@ module LongURL
         parsed = JSON.parse(response.body)
         parsed.values.flatten
       end
+    rescue Timeout::Error, Errno::ENETUNREACH
+      raise LongURL::NetworkError
     end
     
     def handle_response(response)

data/test/service_test.rb

@@ -1,7 +1,3 @@
-# tc_service.rb
-#
-#   Created by Vincent Foley on 2005-06-01
-
 $test_lib_dir = File.join(File.dirname(__FILE__), "..", "lib")
 $:.unshift($test_lib_dir)
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: longurl
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Fabien Jakimowicz
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-10 00:00:00 +01:00
+date: 2009-02-23 00:00:00 +01:00
 default_executable: longurl
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -34,9 +34,12 @@ files:
 - VERSION.yml
 - bin/longurl
 - lib/longurl
+- lib/longurl/cache.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