chuyeow-longurl

= 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

• :cache: cache object to use, must implement [] and []= functions.
• :supported_services_only: If true, only attempts to expand URLs that are listed as supported by LongURL.org's API. Defaults to false.

=== Types url 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 [e-mail]

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.