expurrel 0.1.0 → 0.2.0

data/README.rdoc

@@ -1,17 +1,20 @@
 = Expurrel
 
-Expurrel is a mini library to does tiny url decoding. It supports most of the tiny url 
-providers by doing a request to the tiny url provider and getting back the redirect code. In
-this implementation the urls are cached.
+Expurrel is a library that does short url decoding for each url shortener service. It supports most of the tiny url 
+providers by doing a request to the tiny url provider and getting back the redirect code. Expurrel tries to be fast by also doing
+some simple caching.
 
 == Install
 
+To install expurrel:
+
+  gem install expurrel
 
 == Usage
   
 
   e = Expurrel.new('http://bit.ly/aanv6P')
-  e.decode.should eql('http://www.jaapvandermeer.com/2010/02/12/introducing-myself/')
+  e.decode == 'http://www.jaapvandermeer.com/2010/02/12/introducing-myself/'
 
 == Notes
 
@@ -19,7 +22,25 @@ The cache size is standard 1000 urls, to make it bigger:
   
   Expurrel.cache = SimpleCache.new(:max_size => 10000)
   
-  
+== Adding new tiny URL providers
+
+Standard there is a list of about 200 providers. If one is missing, please add it to
+urlshorteners.txt or let me know by adding a issue.
+
+  e = Expurrel.PROVIDERS << 'bit.ly'
+
+
+== Source
+
+The source is maintained here:
+
+http://github.com/japetheape/expurrel
+
+
+An introductory post is here:
+
+http://www.jaapvandermeer.com/2010/02/13/expurrel-a-library-to-decode-short-urls-in-ruby
+
 
 
 == Note on Patches/Pull Requests

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.2.0

data/expurrel.gemspec

@@ -0,0 +1,59 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{expurrel}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jaap van der Meer"]
+  s.date = %q{2010-02-13}
+  s.description = %q{Expurrel decodes tiny urls in a efficient way.}
+  s.email = %q{jaapvandermeer@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "expurrel.gemspec",
+     "lib/expurrel.rb",
+     "lib/simple_cache.rb",
+     "spec/expurrel_spec.rb",
+     "spec/simple_cache_spec.rb",
+     "spec/spec.opts",
+     "spec/spec_helper.rb",
+     "urlshorteners.txt"
+  ]
+  s.homepage = %q{http://github.com/japetheape/expurrel}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Library to decode tiny urls in a efficient way}
+  s.test_files = [
+    "spec/expurrel_spec.rb",
+     "spec/simple_cache_spec.rb",
+     "spec/spec_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
+    else
+      s.add_dependency(%q<rspec>, [">= 1.2.9"])
+    end
+  else
+    s.add_dependency(%q<rspec>, [">= 1.2.9"])
+  end
+end
+

data/lib/expurrel.rb

@@ -2,48 +2,46 @@ require 'open-uri'
 require 'net/http'
 require 'simple_cache'
 
-# Expurrel is a tiny url that can be decoded.
+# Expurrel is a url that can be a shortened one Expurrel can decode it then.
 class Expurrel
   PROVIDERS = []
-  PROVIDERS_LIST_FILE = File.join(File.dirname(__FILE__), '..', 'tinyurlproviders.txt')
-  
+  PROVIDERS_LIST_FILE = File.join(File.dirname(__FILE__), '..', 'urlshorteners.txt')
   
   @@cache = SimpleCache.new(:max_size => 1000)
   
-  # Give expurrel a new url 
+  # Give expurrel a new url.
   def initialize(url)
     @url = url
   end
   
   
   # This method checks first if it's a tiny url domain from the list. 
-  # 1. Is it a tinyurl?
+  # 1. Is it a short url?
   # 2. It is cached? (tinyurls won't change we can cache forever)
   # 3. Decode (slow!), does http request.
   def decode
     return begin
-      if !self.is_tiny_url?
+      if !self.is_short_url?
         @url
       elsif @@cache.has_key?(@url)
         @@cache.value(@url)
       else
         # TODO add it to the cache
-        decoded_url = self.class.reverse_tinyurl(@url)
+        decoded_url = self.class.reverse_shorturl(@url)
         @@cache.cache!(@url, decoded_url)
         decoded_url
       end
     end
   end
   
-  
-  # Is this a tiny url
-  def is_tiny_url?
-    is_tiny_domain?(self.domain)
+  # Is this a short url
+  def is_short_url?
+    is_short_domain?(self.domain)
   end
   
   
-  # Is it a tiny domain?
-  def is_tiny_domain?(domain)
+  # Is it a short domain?
+  def is_short_domain?(domain)
     PROVIDERS.each do |l|
       # TODO regular expression matching
       if domain.include?(l)
@@ -71,18 +69,17 @@ class Expurrel
     def load_providers!
       return if !PROVIDERS.empty?
       File.open(PROVIDERS_LIST_FILE, "r") .each_line do |line|
-        PROVIDERS << line
+        l = line.strip
+        PROVIDERS << l unless l.empty?
       end
     end
     
     
-    
-    
     # Uses the header file sent back to decode 
-    # the tiny url. 
+    # the shortened url. 
     # Trick provided by:
     # http://garrickvanburen.com/archive/how-to-decode-tinyurls-with-ruby
-    def reverse_tinyurl(tinyurl)
+    def reverse_shorturl(tinyurl)
       Net::HTTP.get_response(URI.parse(tinyurl)).to_hash['location'].to_s
     end
     

data/spec/expurrel_spec.rb

@@ -1,10 +1,6 @@
 require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
 
 describe "Expurrel" do
-  it "fails" do
-    #fail "hey buddy, you should probably rename this file and start specing for real"
-    1.should eql(1)
-  end
   
   it "should load the text file into a constant" do    
     Expurrel::PROVIDERS.include?('bit.ly').should be true
@@ -21,4 +17,8 @@ describe "Expurrel" do
   end
 
 
+  it "should decode a url from bacn.me" do
+    e = Expurrel.new('http://bacn.me/xg4')
+    e.decode.should eql('http://www.jo.com')
+  end
 end

data/urlshorteners.txt

@@ -0,0 +1,210 @@
+bit.ly
+0rz.tw
+2tu.us
+307.to
+6url.com
+a.gg
+a.nf
+a2n.eu
+ad.vu
+adf.ly
+adjix.com
+alturl.com
+atu.ca
+azqq.com
+b23.ru
+b65.com
+bacn.me
+bit.ly
+bloat.me
+budurl.com
+buk.me
+canurl.com
+chilp.it
+clck.ru
+cli.gs
+cliccami.info
+clipurl.us
+clop.in
+cort.as
+cuturls.com
+decenturl.com
+digg.com
+doiop.com
+dwarfurl.com
+easyurl.net
+eepurl.com
+ewerl.com
+ff.im
+fff.to
+fhurl.com
+flingk.com
+flq.us
+fly2.ws
+fwd4.me
+fwdurl.net
+g8l.us
+gl.am
+go.9nl.com
+goshrink.com
+hex.io
+href.in
+htxt.it
+hugeurl.com
+hurl.ws
+icanhaz.com
+idek.net
+is.gd
+jijr.com
+kissa.be
+kl.am
+klck.me
+korta.nu
+l9k.net
+liip.to
+liltext.com
+lin.cr
+linkgap.com
+liurl.cn
+ln-s.net
+ln-s.ru
+lnkurl.com
+lru.jp
+lu.to
+lurl.no
+memurl.com
+merky.de
+migre.me
+minilien.com
+moourl.com
+myurl.in
+nanoref.com
+nanourl.se
+netnet.me
+ni.to
+nn.nf
+notlong.com
+nutshellurl.com
+o-x.fr
+offur.com
+omf.gd
+onsaas.info
+ow.ly
+parv.us
+peaurl.com
+ping.fm
+piurl.com
+plumurl.com
+plurl.me
+pnt.me
+poprl.com
+post.ly
+ptiturl.com
+qlnk.net
+qurlyq.com
+r.im
+rb6.me
+rde.me
+reallytinyurl.com
+redir.ec
+redirects.ca
+redirx.com
+ri.ms
+rickroll.it
+rubyurl.com
+s3nt.com
+s7y.us
+shink.de
+short.ie
+short.to
+shortenurl.com
+shorterlink.com
+shortlinks.co.uk
+shoturl.us
+shredurl.com
+shrinkify.com
+shrinkr.com
+shrinkurl.us
+shrtnd.com
+shurl.net
+shw.me
+smallr.com
+smurl.com
+sn.im
+sn.vc
+snadr.it
+snipr.com
+snipurl.com
+snurl.com
+sp2.ro
+spedr.com
+srnk.net
+srs.li
+starturl.com
+surl.co.uk
+ta.gd
+tcrn.ch
+tgr.me
+tighturl.com
+tiny.cc
+tiny.pl
+tinylink.com
+tinyurl.com
+to.ly
+togoto.us
+tr.im
+tra.kz
+trunc.it
+tubeurl.com
+twitclicks.com
+twitterurl.net
+twiturl.de
+twurl.cc
+twurl.nl
+u.mavrev.com
+u.nu
+u76.org
+ub0.cc
+ulu.lu
+updating.me
+ur1.ca
+url.az
+url.co.uk
+url.ie
+urlborg.com
+urlbrief.com
+urlcut.com
+urlcutter.com
+urlhawk.com
+urlkiss.com
+urlpire.com
+urlvi.be
+urlx.ie
+virl.com
+wapurl.co.uk
+wipi.es
+x.se
+xil.in
+xrl.in
+xrl.us
+xurl.jp
+xzb.cc
+yatuc.com
+yep.it
+yfrog.com
+zi.ma
+zurl.ws
+zz.gd
+zzang.kr
+›.ws
+✩.ws
+✿.ws
+❥.ws
+➔.ws
+➞.ws
+➡.ws
+➨.ws
+➯.ws
+➹.ws
+➽.ws
+        

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: expurrel
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors: 
 - Jaap van der Meer
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-12 00:00:00 +01:00
+date: 2010-02-13 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -38,13 +38,14 @@ files:
 - README.rdoc
 - Rakefile
 - VERSION
+- expurrel.gemspec
 - lib/expurrel.rb
 - lib/simple_cache.rb
 - spec/expurrel_spec.rb
 - spec/simple_cache_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
-- tinyurlproviders.txt
+- urlshorteners.txt
 has_rdoc: true
 homepage: http://github.com/japetheape/expurrel
 licenses: []

data/tinyurlproviders.txt

@@ -1 +0,0 @@
-bit.ly