redirect_follower 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) 2010 Christoph Olszowka
+
+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,44 @@
+= RedirectFollower
+
+Allows you to resolve redirecting urls (i.e. from url-shortening services like bit.ly) and find
+out their destination url as well as the body.
+
+The code is mostly ripped from John Nunemaker's blog post "Following Redirects with Net/HTTP"
+(http://railstips.org/blog/archives/2009/03/04/following-redirects-with-nethttp/), but wrapped 
+into a Rubygem
+
+Install with:
+
+  gem install redirect_follower
+  
+Then, either shorthand for the destination url only or for the full response:
+
+  $ irb
+  > require 'redirect_follower'
+  > RedirectFollower('http://is.gd/bNZYZ') # Just find out the destination url
+  => 'http://www.taschen.com/pages/en/catalogue/classics/all/06724/facts.byrne_six_books_of_euclid.htm'
+
+  > redirect = RedirectFollower.new('http://is.gd/bNZYZ')
+  > redirect.url 
+  => 'http://www.taschen.com/pages/en/catalogue/classics/all/06724/facts.byrne_six_books_of_euclid.htm'
+  > redirect.body
+  => 'a load of html...'
+  > redirect.response.body 
+  => 'a load of html...' # Same as redirect.body
+  > redirect.response
+  => # Full response object from Net::HTTP
+  
+
+== 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 Christoph Olszowka. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "redirect_follower"
+    gem.summary = %Q{Find out the destination of redirecting urls with Net::HTTP}
+    gem.description = %Q{Allows you to resolve redirecting urls (i.e. from url-shortening services like bit.ly) and find out their destination url as well as the body.}
+    gem.email = "christoph at olszowka de"
+    gem.homepage = "http://github.com/colszowka/redirect_follower"
+    gem.authors = ["Christoph Olszowka"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    # 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 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "redirect_follower #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

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

data/lib/redirect_follower.rb

@@ -0,0 +1,67 @@
+require 'net/http'
+
+#
+# Shorthand for RedirectFollower.new(url).resolve.url - just get the
+# destination url for given url
+#
+def RedirectFollower(url)
+  RedirectFollower.new(url).url
+end
+
+#
+# Follow redirects for given urls with net http to find out their destinations
+#
+# Source code mostly ripped from John Nunemaker:
+# http://railstips.org/blog/archives/2009/03/04/following-redirects-with-nethttp/
+#
+class RedirectFollower
+  class TooManyRedirects < StandardError; end
+  
+  attr_accessor :original_url, :redirect_limit
+  attr_writer :url, :response
+  
+  def initialize(original_url, limit=5)
+    @original_url, @redirect_limit = original_url, limit
+  end
+  
+  def url
+    resolve unless @url
+    @url
+  end
+  
+  def body
+    response.body
+  end
+  
+  def response
+    resolve unless @response
+    @response
+  end
+  
+  private
+  
+    def resolve
+      raise TooManyRedirects if redirect_limit < 0
+      
+      # Set up current url if not resolved yet
+      self.url = original_url unless @url
+      
+      self.response = Net::HTTP.get_response(URI.parse(url))
+
+      if response.kind_of?(Net::HTTPRedirection)
+        self.url = redirect_url
+        self.redirect_limit -= 1
+        resolve
+      end
+      
+      self
+    end
+
+    def redirect_url
+      if response['location'].nil?
+        response.body.match(/<a href=\"([^>]+)\">/i)[1]
+      else
+        response['location']
+      end
+    end
+end

data/redirect_follower.gemspec

@@ -0,0 +1,54 @@
+# 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{redirect_follower}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph Olszowka"]
+  s.date = %q{2010-04-30}
+  s.description = %q{Allows you to resolve redirecting urls (i.e. from url-shortening services like bit.ly) and find out their destination url as well as the body.}
+  s.email = %q{christoph at olszowka de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/redirect_follower.rb",
+     "redirect_follower.gemspec",
+     "test/helper.rb",
+     "test/test_redirect_follower.rb"
+  ]
+  s.homepage = %q{http://github.com/colszowka/redirect_follower}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Find out the destination of redirecting urls with Net::HTTP}
+  s.test_files = [
+    "test/test_redirect_follower.rb",
+     "test/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<thoughtbot-shoulda>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'redirect_follower'
+
+class Test::Unit::TestCase
+end

data/test/test_redirect_follower.rb

@@ -0,0 +1,68 @@
+require 'helper'
+
+class TestRedirectFollower < Test::Unit::TestCase
+  should "return the github url for RedirectFollower('http://bit.ly/cteFsP')" do
+    assert_equal 'http://github.com/colszowka/redirect_follower', RedirectFollower('http://bit.ly/cteFsP')
+  end
+  
+  should "return the github url minus the subdomain for RedirectFollower('http://bit.ly/cteFsP')" do
+    assert_equal 'http://github.com/colszowka/redirect_follower', RedirectFollower('http://www.github.com/colszowka/redirect_follower')
+  end
+  
+  context "A new RedirectFollower instance initialized with 'http://bit.ly/cteFsP'" do
+    setup { @redirect = RedirectFollower.new('http://bit.ly/cteFsP')}
+    
+    should "return the github url for url" do
+      assert_equal 'http://github.com/colszowka/redirect_follower', @redirect.url
+    end
+    
+    should "return some html for body" do
+      assert_match /\<div/, @redirect.body
+    end
+    
+    should "have body equal to response.body" do
+      assert_equal @redirect.response.body, @redirect.body
+    end
+    
+    should "have response kind of HTTPSuccess" do
+      assert @redirect.response.kind_of?(Net::HTTPSuccess)
+    end
+  end
+  
+  context "A new RedirectFollower instance initialized with 'http://bit.ly/aRmOtk' and a limit of 1" do
+    setup { @redirect = RedirectFollower.new('http://bit.ly/aRmOtk', 1)}
+    
+    should "raise RedirectFollower::TooManyRedirects when requesting url" do
+      assert_raise(RedirectFollower::TooManyRedirects) { @redirect.url }
+    end
+    
+    should "raise RedirectFollower::TooManyRedirects when requesting body" do
+      assert_raise(RedirectFollower::TooManyRedirects) { @redirect.body }
+    end
+    
+    should "raise RedirectFollower::TooManyRedirects when requesting response" do
+      assert_raise(RedirectFollower::TooManyRedirects) { @redirect.response }
+    end
+    
+    context "after modifiying the limit to 2" do
+      setup { @redirect.redirect_limit = 2 }
+      
+      should "return the github url for url" do
+        assert_equal 'http://github.com/colszowka/redirect_follower', @redirect.url
+      end
+      
+      should "return some html for body" do
+        assert_match /\<div/, @redirect.body
+      end
+      
+      should "have body equal to response.body" do
+        assert_equal @redirect.response.body, @redirect.body
+      end
+      
+      should "have response kind of HTTPSuccess" do
+        assert @redirect.response.kind_of?(Net::HTTPSuccess)
+      end
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification 
+name: redirect_follower
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Christoph Olszowka
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-04-30 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Allows you to resolve redirecting urls (i.e. from url-shortening services like bit.ly) and find out their destination url as well as the body.
+email: christoph at olszowka de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/redirect_follower.rb
+- redirect_follower.gemspec
+- test/helper.rb
+- test/test_redirect_follower.rb
+has_rdoc: true
+homepage: http://github.com/colszowka/redirect_follower
+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: Find out the destination of redirecting urls with Net::HTTP
+test_files: 
+- test/test_redirect_follower.rb
+- test/helper.rb