url_shortener 0.0.1 → 0.0.2

data/History.txt

@@ -1,4 +1,10 @@
 === 0.0.1 2009-11-08
 
 * 1 major enhancement:
-  * Initial release
+  * Initial release
+
+=== 0.0.2 2009-11-09
+
+* 1 addition:
+  * adds url expander functionality
+ 

data/README.rdoc

@@ -9,7 +9,11 @@ To use the url_shortener gem you need a bit.ly login and Api key.
 
 ==USAGE
 
-* authorize = UrlShortener::Authorize.new 'bitlyapidemo', 'R_0da49e0a9118ff35f52f629d2d71bf07'
+===To Shorten Urls
+
+* authorize = UrlShortener::Authorize.new 'your_bitly_login', 'your_bitly_api_key'
+
+* For example; authorize = UrlShortener::Authorize.new 'bitlyapidemo', 'R_0da49e0a9118ff35f52f629d2d71bf07'
 
 * client = UrlShortener::Client.new authorize
 
@@ -23,6 +27,26 @@ OR
 
 * results.each {|result| puts result['shortUrl']}
 
+==To Expand Urls
+
+* authorize = UrlShortener::Authorize.new 'your_bitly_login', 'your_bitly_api_key'
+
+* client = UrlShortener::Client.new authorize
+
+* result = client.expand(:shortUrl => 'http://bit.ly/1RmnUT')
+
+OR
+
+* result = client.expand(:hash => '2bYgqR')
+
+* result['longUrl']
+
+OR 
+
+* results = client.shorten('http://www.yahoo.com', 'http://www.google.com', 'http://github.com')
+
+* results.each {|result| puts result['shortUrl']}
+
 
 ==Tests
 

data/lib/url_shortener/client.rb

@@ -8,16 +8,39 @@ module UrlShortener
       validated?
     end
     
-    def shorten(*url)
+    # To shorten multiple URLs in a single API call, pass multiple urls
+    # e.g. shorten('http://www.google.com', 'http://www.bit.ly')
+    def shorten(*urls)
       # HTTParty accepts a hash for url parameters but if more than one parameters are passed
       # to bitly then the url needs to have longUrl parameter multiple times but we cant have
       # duplicate keys in a hash hence this solution
-      end_point_with_params = "#{end_point('shorten')}?longUrl=#{url.join('&longUrl=')}"
+      urls.collect!{|url| CGI.escape(url)}
+      end_point_with_params = "#{end_point('shorten')}?longUrl=#{urls.join('&longUrl=')}"
       interface(end_point_with_params).get['nodeKeyVal']
     end
     
-    def interface(end_point_with_params)
-      UrlShortener::Interface.new(end_point_with_params, :query => common_query_parameters)
+    # Provide parameter as a key value pair of existing short url or its hash
+    # e.g. expand :shortUrl => 'http://bit.ly/15DlK' OR :hash => '31IqMl'
+    def expand(option)
+      check_request_parameters(option)
+      /^.*\/(.*)$/.match option[:shortUrl] if option[:shortUrl]
+      request_param = option[:hash] ? option[:hash] : $1
+      result = interface(nil, {:rest_url => end_point('expand')}.merge(option)).get[request_param]
+      return result['longUrl'] if result
+    end
+    
+    # If a complex url need to be passed then use end_point_with_params else
+    # set first parameter to nil while invoking this method and
+    # pass rest_url option e.g.
+    #  interface(nil, {:rest_url => end_point('expand'), :another_key => 'value'})
+    def interface(end_point_with_params, options={})
+      if end_point_with_params.nil? && options[:rest_url].nil?
+        raise "You must provide either the endpoint as the first parameter or set the :rest_url options"
+      end
+      rest_url = end_point_with_params ? end_point_with_params : options[:rest_url]
+      options.delete(:rest_url)
+      params = common_query_parameters.merge!(options)
+      UrlShortener::Interface.new(rest_url, :query => params)
     end
     
     def common_query_parameters
@@ -34,6 +57,13 @@ module UrlShortener
     
     private
     
+    def check_request_parameters(option)
+      unless (option[:hash] || option[:shortUrl])
+        raise UrlShortener::IncompleteRequestParameter, "Either hash or the shorUrl is required to complete the operation."
+      end
+      true
+    end
+    
     def validated?
       valid_authorize_attribute?
     end

data/lib/url_shortener/error.rb

@@ -15,4 +15,8 @@ module UrlShortener
   
   class NoResult < Error
   end
+  
+  class UrlShortener::IncompleteRequestParameter < Error
+    
+  end
 end

data/lib/url_shortener.rb

@@ -3,6 +3,7 @@ $:.unshift(File.dirname(__FILE__)) unless
 
 require 'rubygems'
 require 'httparty'
+require 'cgi'
 require 'url_shortener/error.rb'
 require 'url_shortener/authorize.rb'
 require 'url_shortener/client.rb'

data/spec/url_shortener/client_spec.rb

@@ -83,46 +83,135 @@ describe UrlShortener::Client do
     end
   end
   
-  describe "#shorten" do
+  describe "API actions" do
     before(:each) do
       authorize = UrlShortener::Authorize.new 'login', 'key'
       @client = UrlShortener::Client.new(authorize)
       @interface = stub('UrlShortener::Interface', :get => {})
       @client.stub!(:interface).and_return(@interface)
     end
-    
-    it "should get the end point" do
-      @client.should_receive(:end_point)
-      @client.shorten('a url')
-    end
-    
-    it "should use the interface to connect to bitly" do
-      @client.should_receive(:interface).and_return(@interface)
-      @client.shorten('a url')
+    describe "#shorten" do
+      before(:each) do
+        @url = 'http://www.domain.com/path?params=value'
+      end
+
+      it "should do the url escaping" do
+        CGI.should_receive(:escape).with(@url)
+        @client.shorten(@url)
+      end
+
+      it "should get the end point" do
+        @client.should_receive(:end_point)
+        @client.shorten(@url)
+      end
+
+      it "should use the interface to connect to bitly" do
+        @client.should_receive(:interface).and_return(@interface)
+        @client.shorten(@url)
+      end
+
+      it "should get the data using interface" do
+        @interface.should_receive(:get)
+        @client.shorten(@url)
+      end
+
     end
-    
-    it "should get the data using interface" do
-      @interface.should_receive(:get)
-      @client.shorten('a url')
+
+    describe "#expand" do
+     before(:each) do
+        @hash = 'qweWE' 
+        @short_url = 'http://bit.ly/wesSD'
+        @end_point = 'http://api.bit.ly/expand'
+        @client.stub!(:end_point).and_return(@end_point)
+      end
+
+      it "should raise IncompleteRequestParameter when key value pair for neither hash nor shortUrl is not present" do
+        lambda {@client.expand(:invalid => 'anyvalue')}.should raise_error(UrlShortener::IncompleteRequestParameter)
+      end
+
+      it "should get the end point" do
+        @client.should_receive(:end_point)
+        @client.expand(:hash => @hash)
+      end
+
+      it "should use the interface to connect to bitly and pass the hash when url hash is used" do
+        @client.should_receive(:interface).with(nil, {:rest_url => @end_point, :hash => 'qweWE'}).and_return(@interface)
+        @client.expand(:hash => @hash)
+      end
+
+      it "should use the interface to connect to bitly and pass the shortUrl when shortUrl is used" do
+        @client.should_receive(:interface).with(nil, {:rest_url => @end_point, :shortUrl => 'http://bit.ly/wesSD'}).and_return(@interface)
+        @client.expand(:shortUrl => @short_url)
+      end
+
+      it "should get the data using interface" do
+        @interface.should_receive(:get)
+        @client.expand(:hash => @hash)
+      end
+      
+      it "should return the long url of the hash provided" do
+        @interface.should_receive(:get).and_return('qweWE' => {'longUrl' => 'http://www.goog.com'})
+        @client.expand(:hash => @hash).should eql('http://www.goog.com')
+      end
+      
+      it "should return the long url for the shortUrl provided" do
+        @interface.should_receive(:get).and_return('wesSD' => {'longUrl' => 'http://www.goog.com'})
+        @client.expand(:shortUrl => @short_url).should eql('http://www.goog.com')
+      end
+      
     end
-    
   end
   
   describe "#interface" do
     before(:each) do
       authorize = UrlShortener::Authorize.new 'login', 'key'
       @client = UrlShortener::Client.new(authorize)
-      @client.stub!(:common_query_parameters).and_return({})
+      @common_query_parameters = {}
+      @client.stub!(:common_query_parameters).and_return(@common_query_parameters)
+      @first_parameter = '/some/uri'
+      @url = '/a/url'
     end
     
     it "should initialize the interface object" do
       UrlShortener::Interface.should_receive(:new).with('/some/uri', :query => {})
-      @client.interface('/some/uri')
+      @client.interface(@first_parameter)
     end
     
     it "should get the common query parameters" do
       @client.should_receive(:common_query_parameters)
-      @client.interface('/some/uri')
+      @client.interface(@first_parameter)
+    end
+    
+    it "should use the rest_url key from the options if first_parameter is set to nil" do
+      UrlShortener::Interface.should_receive(:new).with('/a/url', :query => {})
+      @client.interface(nil, {:rest_url => @url})
+    end
+    
+    it "should use the first parameter if rest_url option as well as the first parameter is provided" do
+      UrlShortener::Interface.should_receive(:new).with('/some/uri', :query => {})
+      @client.interface(@first_parameter, {:rest_url => @url})
+    end
+    
+    it "should raise an error when neither the first parameter is set nor the rest_url options" do
+      lambda { @client.interface(nil, {}) }.should raise_error("You must provide either the endpoint as the first parameter or set the :rest_url options")
+    end
+    
+    it "should remove the rest_url key value from the options" do
+      options = {:rest_url => @url}
+      options.should_receive(:delete).with(:rest_url)
+      @client.interface(@first_parameter, options)
+    end
+    
+    it "should merge the rest of the options passed to the common_query_parameters" do
+      options = {:rest_url => @url, :tt => 'val'}
+      @common_query_parameters.should_receive(:merge!).with(options)
+      @client.interface(@first_parameter, options)
+    end
+    
+    it "should keys for the parameters that are passed in the options" do
+      options = {:rest_url => @url, :tt => 'val'}
+      UrlShortener::Interface.should_receive(:new).with('/a/url', :query => {:tt => 'val'})
+      @client.interface(nil, options)
     end
   end
   

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: url_shortener
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Nasir Jamal
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-11-08 00:00:00 +00:00
+date: 2009-11-09 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency