longurl 0.0.1

data/VERSION.yml

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

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,51 @@
+# Copyright (c) 2009 by Fabien Jakimowicz (fabien@jakimowicz.com)
+#
+# Please see the LICENSE file for licensing.
+
+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

data/lib/longurl/constants.rb

@@ -0,0 +1,6 @@
+require "uri"
+
+module LongURL
+  EndPoint        = URI.parse("http://api.longurl.org/v1/expand")
+  ServiceEndPoint = URI.parse("http://api.longurl.org/v1/services")
+end

data/lib/longurl/direct.rb

@@ -0,0 +1,15 @@
+require 'uri'
+require "net/http"
+
+module LongURL
+  module Direct
+    def self.follow_redirections(orig)
+      uri = URI.parse(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
+      end
+    end
+  end
+end

data/lib/longurl/exceptions.rb

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

data/lib/longurl/service.rb

@@ -0,0 +1,66 @@
+require "net/http"
+require "cgi"
+require "uri"
+require "rubygems"
+require "json"
+require "longurl/constants"
+require "longurl/exceptions"
+
+module LongURL
+
+  class Service
+    
+    def initialize
+      @@supported_services = fetch_supported_services
+    end
+    
+    def query_supported_service_only(url)
+      check url
+      raise LongURL::UnsupportedService unless service_supported?(url)
+      query url
+    end
+
+    def query(url)
+      escaped_url = check_and_escape(url)
+      Net::HTTP.start(EndPoint.host, EndPoint.port) do |http|
+        handle_response http.get("#{EndPoint.path}?format=json&url=#{escaped_url}")
+      end
+    end
+        
+    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
+    
+    def check_and_escape(url)
+      check url
+      CGI.escape url
+    end
+    
+    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.flatten
+      end
+    end
+    
+    def handle_response(response)
+      parsed = JSON.parse(response.body)
+      if parsed['long_url']
+        parsed['long_url']
+      elsif parsed['message'] # Error
+        raise LongURL::UnsupportedService if parsed['messages']['message'] == 'Unsupported service.'
+      else
+        raise LongURL::UnknownError
+      end
+    end
+
+  end  
+
+end

data/test/service_test.rb

@@ -0,0 +1,47 @@
+# tc_service.rb
+#
+#   Created by Vincent Foley on 2005-06-01
+
+$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

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: longurl
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Fabien Jakimowicz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-10 00:00:00 +01: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: fabien@jakimowicz.com
+executables: 
+- longurl
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- VERSION.yml
+- bin/longurl
+- lib/longurl
+- lib/longurl/constants.rb
+- lib/longurl/direct.rb
+- lib/longurl/exceptions.rb
+- lib/longurl/service.rb
+- lib/longurl.rb
+- test/service_test.rb
+has_rdoc: true
+homepage: http://longurl.rubyforge.org
+post_install_message: 
+rdoc_options: 
+- --inline-source
+- --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.1
+signing_key: 
+specification_version: 2
+summary: LongURL expands shorten urls (tinyurl, is.gd, ...)
+test_files: []
+