uncoil 0.0.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in uncoil.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,8 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :cli => "--color --format d" do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { "spec" }
+  # watch('spec/spec_helper.rb')  { "spec" }
+end

data/Manifest

@@ -0,0 +1,9 @@
+Gemfile
+Gemfile.lock
+Guardfile
+README.md
+Rakefile
+lib/uncoil.rb
+spec/spec_helper.rb
+spec/uncoil_spec.rb
+Manifest

data/README.md

@@ -0,0 +1,39 @@
+# uncoil
+
+The uncoil gem is a one stop shop for un-shortening urls.
+
+The idea is based off of my site http://uncoil.me and I built this as part of my UWE-Ruby fall project.
+
+## Why the heck does this exist?
+This gem is all about transparency and safety, and knowing where you are going on the internet.
+
+There are a few instances where it may come in handy:
+
+* You want to make sure you're not heading into an obviously sketchy site
+* You're at work and want to keep out the NSFW
+
+## Example
+I have no idea where http://bit.ly/2EEjBl really goes.
+
+But by expanding it with uncoil, I can see that it goes to http://www.cnn.com
+
+## How the app works
+
+1. Extract the domain from the url
+2. See if it matches with any of the supported APIs
+  * If so, it calls the correct API method
+  * If no matching method is found, it runs through an HTTP loop until it receives a 200 response
+3. It then returns a hash containing, among other items, the full url
+
+## Current Issues
+
+## Future Enhancements
+Here are a few ideas I have for the future:
+
+* Additional APIs as they become available
+  * These seem to be faster than a general HTTP request loop
+* Modularized structure with each API's content in its own file
+* Dynamic method assignment based on domain.  
+  * This goes with the modularized structure above, because it allows you to just drop more API files into the folder and not have to modify the main method
+* Better error handling (I'd appreciate any comments on what to catch and what to leave)
+* Offer the code as a gem

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+require 'rubygems'
+require 'rake'
+require 'rspec'
+
+desc "`rake` will default to running `rake:spec`"
+task :default => :spec
+
+desc "Run all the rspec examples"
+task :spec do
+  system "bundle exec rspec -c spec"
+end

data/lib/uncoil/version.rb

@@ -0,0 +1,3 @@
+class Uncoil
+  VERSION = "0.0.1"
+end

data/lib/uncoil.rb

@@ -0,0 +1,81 @@
+require 'bitly'
+require 'open-uri'
+require 'net/http'
+require 'json'
+
+class Uncoil
+  ISGD_ROOT_URL = "http://is.gd/forward.php?format=json&shorturl="
+  BITLY_DOM_ARRAY = %w[bit.ly, j.mp, bitlypro.com, cs.pn, nyti.ms]
+  
+    def initialize options = {}
+      Bitly.use_api_version_3
+      @bitly_access = false
+      
+      if options.has_key?(:bitlyuser) && options.has_key?(:bitlykey)
+        @bitly_instance = Bitly.new("#{options[:bitlyuser]}", "#{options[:bitlykey]}")
+        @bitly_access = true
+      end
+    end
+
+    def identify_domain short_url
+      clean_url(short_url).split("/")[2].to_s
+    end
+
+    def clean_url short_url
+      short_url = "http://" << short_url unless short_url =~ /^https?:\/\//
+      short_url.chop! if short_url[-1] == "/"
+      short_url
+    end
+
+    def expand url_arr
+      out_arr = Array(url_arr).flatten.map do |short_url|
+        short_url = clean_url(short_url)
+        domain    = identify_domain(short_url)
+        
+        @bitly_access.nil? ? error = "Not logged in to Bitly API" : error = nil
+        
+        begin
+          if @bitly_access && BITLY_DOM_ARRAY.include?(domain)
+            long_url = uncoil_bitly(short_url)
+          elsif @bitly_access && check_bitly_pro(domain)
+            long_url = uncoil_bitly(short_url)
+          elsif domain == "is.gd"
+            long_url = uncoil_isgd(short_url)
+          else
+            long_url = uncoil_other(short_url)
+          end
+        rescue => exception
+          long_url = nil
+          error = exception.message
+        end
+        
+        { :short_url => short_url , :long_url => long_url, :error => error }
+          
+      end
+      
+      out_arr.length == 1 ? out_arr[0] : out_arr
+
+    end
+
+    def check_bitly_pro url_domain
+      @bitly_instance.bitly_pro_domain(url_domain)
+    end
+
+    def uncoil_bitly short_url
+      @bitly_instance.expand(short_url).long_url
+    end
+
+    def uncoil_isgd short_url
+      JSON.parse(open(ISGD_ROOT_URL + "#{short_url}") { |file| file.read } )["url"]
+    end
+
+    def uncoil_other short_url, depth = 10
+      url = URI.encode(short_url)
+      response = Net::HTTP.get_response(URI.parse(url))
+      
+      case response
+        when Net::HTTPSuccess     then url
+        when Net::HTTPRedirection then uncoil_other(response['location'], depth - 1)
+      end
+    end
+end

data/spec/uncoil_spec.rb

@@ -0,0 +1,130 @@
+require 'uncoil'
+
+describe Uncoil do
+  
+  subject { Uncoil.new(:bitlyuser => "stim371", :bitlykey => "R_7a6f6d845668a8a7bb3e0c80ee3c28d6")}
+  
+  context "when cleaning up the url" do
+    
+    it "should add the prefix if none exists" do
+      subject.clean_url("cnn.com").should eq "http://cnn.com"
+      subject.clean_url("cnn.com/").should eq "http://cnn.com"
+    end
+    
+    it "should not add the prefix if one exists" do
+      subject.clean_url("http://cnn.com").should eq "http://cnn.com"
+      subject.clean_url("http://cnn.com/").should eq "http://cnn.com"
+    end
+    
+    it "should not add the prefix if a secure one exists" do
+      subject.clean_url("https://cnn.com").should eq "https://cnn.com"
+      subject.clean_url("https://cnn.com/").should eq "https://cnn.com"
+    end
+    
+    it "should remove the trailing slash" do
+      subject.clean_url("http://cnn.com/").should eq "http://cnn.com"
+      subject.clean_url("cnn.com/").should eq "http://cnn.com"
+    end
+    
+    it "should not remove characters on the end that aren't slashes" do
+      subject.clean_url("http://cnn.com").should eq "http://cnn.com"
+      subject.clean_url("cnn.com").should eq "http://cnn.com"
+    end
+    
+  end
+  
+  context "when extracting the domain" do
+  
+    it "should correctly extract the domain from a normal url" do
+      subject.identify_domain("http://bit.ly/2EEjBl").should eq "bit.ly"
+    end
+  
+  end
+  
+  context "when checking a domain" do
+    
+    it "should identify pro domains" do
+      subject.check_bitly_pro("cs.pn").should be_true
+      subject.check_bitly_pro("nyti.ms").should be_true
+    end
+    
+    it "should identify non-pro domains" do
+      subject.check_bitly_pro("bit.ly").should be_false #the bit.ly domain comes back false since its not a "pro" domain
+      subject.check_bitly_pro("tinyurl.com").should be_false
+    end
+    
+  end
+  
+  describe "when using the submethods" do
+    
+    context "when trying to undo a bit.ly link" do
+    
+      it "should bring back the correct long link" do
+        expected_result = "http://www.cnn.com/"
+        subject.uncoil_bitly("http://bit.ly/2EEjBl").should eq expected_result
+      end
+    
+    end
+  
+    context "when trying to undo a bit.ly pro link" do
+    
+      it "should bring back the correct long link" do
+        expected_result = "http://www.c-spanvideo.org/program/CainNew"
+        subject.uncoil_bitly("http://cs.pn/vsZpra").should eq expected_result
+      end
+    
+    end
+  
+    context "when trying to undo an is.gd link" do
+    
+      it "should bring back the correct long link" do
+        subject.uncoil_isgd("http://is.gd/gbKNRq").should eq "http://www.google.com"
+      end
+    
+    end
+  
+    context "when trying to undo from other services" do
+    
+      it "should bring back the correct long link" do
+         subject.uncoil_other("http://tinyurl.com/736swvl").should eq "http://www.chinadaily.com.cn/usa/business/2011-11/08/content_14057648.htm"
+      end
+    
+    end
+  end
+  
+  context "when using the main expand method" do
+    
+    it "should expand bitly correctly" do
+      expected_result = Hash[:long_url => "http://www.cnn.com/", :short_url => "http://bit.ly/2EEjBl", :error => nil]
+      subject.expand("http://bit.ly/2EEjBl").should eq expected_result
+    end
+    
+    it "should expand bitlypro domains correctly" do
+      subject.expand("http://cs.pn/vsZpra").should eq Hash[:long_url => "http://www.c-spanvideo.org/program/CainNew", :short_url => "http://cs.pn/vsZpra", :error => nil]
+    end
+    
+    it "should expand isgd domains correctly" do
+      subject.expand("http://is.gd/gbKNRq").should eq Hash[:long_url => "http://www.google.com", :short_url => "http://is.gd/gbKNRq", :error => nil]
+    end
+    
+    it "should expand other shortened urls correctly" do
+      short_url = "http://tinyurl.com/736swvl"
+      results_array = Hash[:long_url => "http://www.chinadaily.com.cn/usa/business/2011-11/08/content_14057648.htm", :short_url => "http://tinyurl.com/736swvl", :error => nil]
+      
+      subject.expand(short_url).should eq results_array
+    end
+    
+    it "should also take an array of quotes" do
+      arr_of_links = ["http://bit.ly/2EEjBl","http://is.gd/gbKNRq","http://cs.pn/vsZpra"]
+      results_array = [Hash[:long_url => "http://www.cnn.com/", :short_url => "http://bit.ly/2EEjBl", :error => nil], Hash[:long_url => "http://www.google.com", :short_url => "http://is.gd/gbKNRq", :error => nil],Hash[:long_url => "http://www.c-spanvideo.org/program/CainNew", :short_url => "http://cs.pn/vsZpra", :error => nil]]
+    
+      subject.expand(arr_of_links).should eq results_array
+    end
+    
+    it "should raise an error for non-urls" do
+      subject.expand("a")[:error].should_not be_nil
+    end
+    
+  end
+  
+end

data/uncoil.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "uncoil/version"
+
+Gem::Specification.new do |s|
+  s.name        = "uncoil"
+  s.version     = Uncoil::VERSION
+  s.authors     = ["Joel Stimson"]
+  s.email       = ["contact@cleanroomstudios.com"]
+  s.homepage    = "http://uncoil.me"
+  s.summary     = %q{Uncoil is a gem to unshorten urls so you know where obscured links really go.}
+  s.description = %q{Uncoil is a gem to unshorten urls so you know where obscured links really go. If you have bitly login credentials, initialize an instance of Uncoil to use the bitly API.}
+
+  s.rubyforge_project = "uncoil"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "guard-rspec"
+  
+  s.add_runtime_dependency "bitly"
+end

metadata

@@ -0,0 +1,92 @@
+--- !ruby/object:Gem::Specification
+name: uncoil
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Joel Stimson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-01-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2154321340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154321340
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &2154320920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2154320920
+- !ruby/object:Gem::Dependency
+  name: bitly
+  requirement: &2154320500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2154320500
+description: Uncoil is a gem to unshorten urls so you know where obscured links really
+  go. If you have bitly login credentials, initialize an instance of Uncoil to use
+  the bitly API.
+email:
+- contact@cleanroomstudios.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- Manifest
+- README.md
+- Rakefile
+- lib/uncoil.rb
+- lib/uncoil/version.rb
+- spec/uncoil_spec.rb
+- uncoil.gemspec
+homepage: http://uncoil.me
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: uncoil
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Uncoil is a gem to unshorten urls so you know where obscured links really
+  go.
+test_files:
+- spec/uncoil_spec.rb