expurrel 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jaap van der Meer
+
+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.rdoc

@@ -0,0 +1,37 @@
+= 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.
+
+== Install
+
+
+== Usage
+  
+
+  e = Expurrel.new('http://bit.ly/aanv6P')
+  e.decode.should eql('http://www.jaapvandermeer.com/2010/02/12/introducing-myself/')
+
+== Notes
+
+The cache size is standard 1000 urls, to make it bigger:
+  
+  Expurrel.cache = SimpleCache.new(:max_size => 10000)
+  
+  
+
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Jaap van der Meer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,45 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "expurrel"
+    gem.summary = %Q{Library to decode tiny urls in a efficient way}
+    gem.description = %Q{Expurrel decodes tiny urls in a efficient way.}
+    gem.email = "jaapvandermeer@gmail.com"
+    gem.homepage = "http://github.com/japetheape/expurrel"
+    gem.authors = ["Jaap van der Meer"]
+    gem.add_development_dependency "rspec", ">= 1.2.9"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'spec/rake/spectask'
+Spec::Rake::SpecTask.new(:spec) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.spec_files = FileList['spec/**/*_spec.rb']
+end
+
+Spec::Rake::SpecTask.new(:rcov) do |spec|
+  spec.libs << 'lib' << 'spec'
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :spec => :check_dependencies
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "expurrel #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/expurrel.rb

@@ -0,0 +1,93 @@
+require 'open-uri'
+require 'net/http'
+require 'simple_cache'
+
+# Expurrel is a tiny url that can be decoded.
+class Expurrel
+  PROVIDERS = []
+  PROVIDERS_LIST_FILE = File.join(File.dirname(__FILE__), '..', 'tinyurlproviders.txt')
+  
+  
+  @@cache = SimpleCache.new(:max_size => 1000)
+  
+  # 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?
+  # 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?
+        @url
+      elsif @@cache.has_key?(@url)
+        @@cache.value(@url)
+      else
+        # TODO add it to the cache
+        decoded_url = self.class.reverse_tinyurl(@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)
+  end
+  
+  
+  # Is it a tiny domain?
+  def is_tiny_domain?(domain)
+    PROVIDERS.each do |l|
+      # TODO regular expression matching
+      if domain.include?(l)
+        return true
+      end
+    end
+    false
+  end
+  
+  
+  
+  # Get the domain
+  def domain
+    return @domain if !@domain.nil? 
+    unpacked_link = @url.scan(/(https?:\/\/|www\.)([-\w\.]+)+(:\d+)?(\/([\w\/_\.]*(\?\S+)?)?)?/)
+    @domain = unpacked_link.first[1]
+    return @domain
+  end
+  
+  
+  class << self
+    
+    # Loads the list with providers into
+    # the PROVIDERS constant.
+    def load_providers!
+      return if !PROVIDERS.empty?
+      File.open(PROVIDERS_LIST_FILE, "r") .each_line do |line|
+        PROVIDERS << line
+      end
+    end
+    
+    
+    
+    
+    # Uses the header file sent back to decode 
+    # the tiny url. 
+    # Trick provided by:
+    # http://garrickvanburen.com/archive/how-to-decode-tinyurls-with-ruby
+    def reverse_tinyurl(tinyurl)
+      Net::HTTP.get_response(URI.parse(tinyurl)).to_hash['location'].to_s
+    end
+    
+  end
+end
+
+
+Expurrel.load_providers!

data/lib/simple_cache.rb

@@ -0,0 +1,35 @@
+
+# SimpleCache is a very simple cache store.
+class SimpleCache
+  attr_accessor :options
+  attr_accessor :store
+  
+  # Create a new cache store:
+  #   SimpleCache.new(:max_size => 100)
+  # to set the size of the cache
+  def initialize(options = {:max_size => 10})
+    @options = options
+    @store = {}
+  end
+  
+  # Does it have this key
+  def has_key?(key)
+    !@store[key].nil?
+  end
+  
+  # Cache an item
+  def cache!(key, value)
+    if @store.size >= @options[:max_size]
+      @store.delete(@store.keys.first)
+    end
+      
+    @store[key] = value
+  end
+  
+  
+  # Get value of an key
+  def value(key)
+    @store[key]
+  end
+  
+end

data/spec/expurrel_spec.rb

@@ -0,0 +1,24 @@
+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
+  end
+  
+  it "should not decode a normal url" do
+    e = Expurrel.new('http://www.jaapvandermeer.com/test')
+    e.decode.should eql('http://www.jaapvandermeer.com/test')
+  end
+  
+  it "should decode a url that is on the tinyurlproviders.txt list" do
+    e = Expurrel.new('http://bit.ly/aanv6P')
+    e.decode.should eql('http://www.jaapvandermeer.com/2010/02/12/introducing-myself/')
+  end
+
+
+end

data/spec/simple_cache_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
+
+describe "SimpleCache" do
+
+  it 'should do proper caching' do
+    s = SimpleCache.new
+    s.cache!('hoi', 'jo')
+    s.has_key?('hoi').should be true
+    s.value('hoi').should eql('jo')
+    
+  end
+  
+  it 'should not exceed the maximum caching' do
+    s = SimpleCache.new
+    20.times do |i|
+      s.cache!(i, 'something to cache')
+    end
+    s.store.size.should <= 10
+  end
+  
+  
+  
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--color

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+require 'expurrel'
+require 'simple_cache'
+require 'rubygems'
+require 'spec'
+require 'spec/autorun'
+
+
+Spec::Runner.configure do |config|
+  
+end

data/tinyurlproviders.txt

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

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: expurrel
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jaap van der Meer
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-02-12 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.9
+    version: 
+description: Expurrel decodes tiny urls in a efficient way.
+email: jaapvandermeer@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- 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
+has_rdoc: true
+homepage: http://github.com/japetheape/expurrel
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --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: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Library to decode tiny urls in a efficient way
+test_files: 
+- spec/expurrel_spec.rb
+- spec/simple_cache_spec.rb
+- spec/spec_helper.rb