uncoil 0.0.1 → 1.0.0

data/.gitignore

@@ -2,3 +2,4 @@
 .bundle
 Gemfile.lock
 pkg/*
+coverage/

data/README.md

@@ -36,4 +36,3 @@ Here are a few ideas I have for the future:
 * 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/lib/uncoil.rb

@@ -7,75 +7,84 @@ 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
+  def initialize options = {}
+    Bitly.use_api_version_3
+    @bitly_access = false
+    
+    # create bitly instance if the auth criteria are all entered by user
+    if options.has_key?(:bitlyuser) && options.has_key?(:bitlykey)
+      @bitly_instance = Bitly.new("#{options[:bitlyuser]}", "#{options[:bitlykey]}")
+      @bitly_access = true
     end
+  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)
+  def expand url_arr
+    output_array = Array(url_arr).flatten.map do |short_url|
+      short_url = clean_url(short_url)
+      domain    = identify_domain(short_url)
+      
+      begin
+        long_url = 
+          if @bitly_access && ( BITLY_DOM_ARRAY.include?(domain) || check_bitly_pro(domain) )
+            uncoil_bitly(short_url)
           elsif domain == "is.gd"
-            long_url = uncoil_isgd(short_url)
+            uncoil_isgd(short_url)
           else
-            long_url = uncoil_other(short_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 }
-          
+      rescue => exception
+        long_url = nil
+        error = exception.message
       end
-      
-      out_arr.length == 1 ? out_arr[0] : out_arr
-
+      # return a response object for each time through the loop
+      Response.new(long_url, short_url, error)
     end
+    # here's the return
+    output_array.length == 1 ? output_array[0] : output_array
+  end
 
-    def check_bitly_pro url_domain
-      @bitly_instance.bitly_pro_domain(url_domain)
-    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_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_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
+  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
+  
+  # helper methods to clean up the code above
+  
+  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
+  
+end
+
+class Uncoil::Response
+  attr_reader :long_url, :short_url, :error
+  
+  def initialize(long_url, short_url, error)
+    @long_url = long_url
+    @short_url = short_url
+    @error = error
+  end
 end

data/lib/uncoil/version.rb

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

data/spec/helper_method_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+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
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'simplecov'
+SimpleCov.start

data/spec/uncoil_spec.rb

@@ -1,130 +1,101 @@
+require 'spec_helper'
 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
+  describe "the main expand method" do
     
-    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]
+    it "should return a response object" do
+      subject.expand("http://is.gd/gbKNRq").class.should eq Uncoil::Response
     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]
+    it "should raise an error for non-urls" do
+      subject.expand("a").error.should_not be_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]
+    context "and when expanding a link" do
       
-      subject.expand(short_url).should eq results_array
-    end
+      def check_response response, expected_result
+        response.long_url.should eq expected_result[:long_url]
+        response.short_url.should eq expected_result[:short_url]
+        response.error.should eq expected_result[:error]
+      end
+      
+      it "should expand bitly correctly" do
+        expected_result = Hash[:long_url => "http://www.cnn.com/", :short_url => "http://bit.ly/2EEjBl", :error => nil]
+        response = subject.expand("http://bit.ly/2EEjBl")
+        check_response response, expected_result
+      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]]
+      it "should expand bitlypro domains correctly" do
+        expected_result = Hash[:long_url => "http://www.c-spanvideo.org/program/CainNew", :short_url => "http://cs.pn/vsZpra", :error => nil]
+        response = subject.expand("http://cs.pn/vsZpra")
+        check_response response, expected_result
+      end
     
-      subject.expand(arr_of_links).should eq results_array
-    end
+      it "should expand isgd domains correctly" do
+        expected_result = Hash[:long_url => "http://www.google.com", :short_url => "http://is.gd/gbKNRq", :error => nil]
+        response = subject.expand("http://is.gd/gbKNRq")
+        check_response response, expected_result
+      end
     
-    it "should raise an error for non-urls" do
-      subject.expand("a")[:error].should_not be_nil
-    end
+      it "should expand other shortened urls correctly" do
+        expected_result = Hash[:long_url => "http://www.chinadaily.com.cn/usa/business/2011-11/08/content_14057648.htm", :short_url => "http://tinyurl.com/736swvl", :error => nil]
+        response = subject.expand("http://tinyurl.com/736swvl")
+        check_response response, expected_result
+      end
     
+      context "with an array input" do
+        
+        before(:all) {
+          arr_of_links = ["http://bit.ly/2EEjBl","http://is.gd/gbKNRq","http://cs.pn/vsZpra"]
+          @response = subject.expand(arr_of_links)
+          }
+        
+        it "should return an array" do
+          @response.class.should eq Array
+        end
+        
+        it "should return an array of response objects" do
+          @response.each { |r| r.class.should eq Uncoil::Response }
+        end
+        
+        it "should successfully expand all links" do
+          @expected_result = [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]]
+          @response.each_with_index { |response_array, index| check_response response_array, @expected_result[index] }
+        end
+      end
+    end
   end
-  
-end
+end

data/uncoil.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Uncoil::VERSION
   s.authors     = ["Joel Stimson"]
   s.email       = ["contact@cleanroomstudios.com"]
-  s.homepage    = "http://uncoil.me"
+  s.homepage    = "https://github.com/stim371/uncoil"
   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.}
 
@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   s.add_development_dependency "rspec"
   s.add_development_dependency "guard-rspec"
+  s.add_development_dependency "simplecov"
   
   s.add_runtime_dependency "bitly"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uncoil
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-20 00:00:00.000000000 Z
+date: 2012-01-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2154321340 !ruby/object:Gem::Requirement
+  requirement: &2157463580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154321340
+  version_requirements: *2157463580
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &2154320920 !ruby/object:Gem::Requirement
+  requirement: &2157463160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2154320920
+  version_requirements: *2157463160
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &2157462740 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *2157462740
 - !ruby/object:Gem::Dependency
   name: bitly
-  requirement: &2154320500 !ruby/object:Gem::Requirement
+  requirement: &2157462320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2154320500
+  version_requirements: *2157462320
 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.
@@ -61,9 +72,11 @@ files:
 - Rakefile
 - lib/uncoil.rb
 - lib/uncoil/version.rb
+- spec/helper_method_spec.rb
+- spec/spec_helper.rb
 - spec/uncoil_spec.rb
 - uncoil.gemspec
-homepage: http://uncoil.me
+homepage: https://github.com/stim371/uncoil
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -89,4 +102,6 @@ specification_version: 3
 summary: Uncoil is a gem to unshorten urls so you know where obscured links really
   go.
 test_files:
+- spec/helper_method_spec.rb
+- spec/spec_helper.rb
 - spec/uncoil_spec.rb