url_shortener 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-11-08
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,17 @@
+History.txt
+Manifest.txt
+README.rdoc
+lib/url_shortener.rb
+lib/url_shortener/authorize.rb
+lib/url_shortener/client.rb
+lib/url_shortener/error.rb
+lib/url_shortener/interface.rb
+spec/spec_helper.rb
+spec/url_shortener/authorize_spec.rb
+spec/url_shortener/client_spec.rb
+spec/url_shortener/interface_spec.rb
+features/connect_to_bitly.feature
+features/short_url.feature
+features/support/env.rb
+features/step_definitions/connection_error_steps.rb
+features/step_definitions/short_url_steps.rb

data/README.rdoc

@@ -0,0 +1,54 @@
+==Description
+
+Url Shortener is a Ruby library / gem and API wrapper for bit.ly to shorten the urls.
+
+To use the url_shortener gem you need a bit.ly login and Api key.
+
+* If you are registered at bit.ly then you already have it.
+* If you are not registered then you can get it easily by registering at bit.ly as they give an api key to every registered user
+
+==USAGE
+
+* authorize = UrlShortener::Authorize.new 'bitlyapidemo', 'R_0da49e0a9118ff35f52f629d2d71bf07'
+
+* client = UrlShortener::Client.new authorize
+
+* results = client.shorten('http://www.yahoo.com')
+
+* results['shortUrl']
+
+OR 
+
+* results = client.shorten('http://www.yahoo.com', 'http://www.google.com', 'http://github.com')
+
+* results.each {|result| puts result['shortUrl']}
+
+
+==Tests
+
+Tests are written using RSpec and Cucumber. Integration tests use bit.ly demo login and api key credentials.
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Nasir Jamal
+
+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/features/connect_to_bitly.feature

@@ -0,0 +1,18 @@
+Feature: Get informative messages
+	In order to take appropriate measures
+	As a user
+	I want to be able to get meaningful and appropriate messages when I am not able to connect to bit.ly
+
+	Scenario: Return authorization failure when correct login is present and api key is wrong
+		Given I use "correct" "bit.ly" login name as "bitlyapidemo"
+		And I use "incorrect" "bit.ly" api key as "123123"
+		And I use "incorrect" credentials
+		When I submit a request to "bit.ly"
+		Then I should get the "UrlShortener::AuthorizationFailure" error
+		
+	Scenario: Return authorization failure when correct api key is present with wrong login name
+		Given I use "incorrect" "bit.ly" login name as "123123"
+		And I use "correct" "bit.ly" api key as "R_0da49e0a9118ff35f52f629d2d71bf07"
+		And I use "incorrect" credentials
+		When I submit a request to "bit.ly"
+		Then I should get the "UrlShortener::AuthorizationFailure" error

data/features/short_url.feature

@@ -0,0 +1,14 @@
+Feature: Shorten the url
+	In order to write less characters
+	As a user
+	I want to shorten the long urls
+
+	Scenario: Create a short url when correct login and api key is present
+		Given I use "correct" "bit.ly" login name as "bitlyapidemo"
+		And I use "correct" "bit.ly" api key as "R_0da49e0a9118ff35f52f629d2d71bf07"
+		And I use "correct" credentials
+		And "bit.ly" is online
+		When I submit a request to shorten the url "http://www.github.com/nas"
+		Then I should get the response from "bit.ly"
+		And the shorten url should be "http://bit.ly/6NaDb"
+		And the hash should be "2oV4lu"

data/features/step_definitions/connection_error_steps.rb

@@ -0,0 +1,41 @@
+# ===============
+# = Given Steps =
+# ===============
+Given /^I use "([^\"]*)" "([^\"]*)" login name as "([^\"]*)"$/ do |info_type, service, login|
+  @login = login
+end
+
+Given /^I use "([^\"]*)" "([^\"]*)" api key as "([^\"]*)"$/ do |info_type, service, api_key|
+  @api_key = api_key
+end
+
+Given /^I use "([^\"]*)" credentials$/ do |info_type|
+  @authorize = UrlShortener::Authorize.new(@login, @api_key)
+end
+
+Given /^"([^\"]*)" is online$/ do |site|
+  check_url=Net::HTTP.get_response(URI.parse('http://'+site))
+  check_url.code.should eql '200'
+end
+
+# ==============
+# = When Steps =
+# ==============
+
+When /^I submit a request to "([^\"]*)"$/ do |arg1|
+  begin
+    @client = UrlShortener::Client.new(@authorize)
+    @client.shorten('http://cnn.com')
+  rescue => e
+    @error = e
+  end
+end
+
+# ==============
+# = Then steps =
+# ==============
+
+
+Then /^I should get the "([^\"]*)" error$/ do |error_class|
+  @error.class.to_s.should eql(error_class)
+end

data/features/step_definitions/short_url_steps.rb

@@ -0,0 +1,23 @@
+# ==============
+# = When Steps =
+# ==============
+When /^I submit a request to shorten the url "([^\"]*)"$/ do |url|
+  authorize = UrlShortener::Authorize.new('bitlyapidemo', 'R_0da49e0a9118ff35f52f629d2d71bf07')
+  client = UrlShortener::Client.new(authorize)
+  @result = client.shorten(url)
+end
+
+# ==============
+# = Then Steps =
+# ==============
+Then /^I should get the response from "([^\"]*)"$/ do |arg1|
+  @result.should_not be_nil
+end
+
+Then /^the shorten url should be "([^\"]*)"$/ do |short_url|
+  @result['shortUrl'].should eql(short_url)
+end
+
+Then /^the hash should be "([^\"]*)"$/ do |hash|
+  @result['hash'].should eql(hash)
+end

data/features/support/env.rb

@@ -0,0 +1,3 @@
+$: << File.join(File.dirname(__FILE__), "/../../lib") 
+
+require 'url_shortener'

data/lib/url_shortener/authorize.rb

@@ -0,0 +1,12 @@
+module UrlShortener
+  class Authorize
+    
+    attr_accessor :login, :api_key, :base_url
+    
+    def initialize(login, api_key)
+      @login = login
+      @api_key = api_key
+      @base_url = 'http://api.bit.ly'
+    end
+  end
+end

data/lib/url_shortener/client.rb

@@ -0,0 +1,47 @@
+module UrlShortener
+  class Client
+    
+    attr_accessor :authorize
+    
+    def initialize(authorize)
+      @authorize = authorize
+      validated?
+    end
+    
+    def shorten(*url)
+      # 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=')}"
+      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)
+    end
+    
+    def common_query_parameters
+      {:login => authorize.login, 
+       :apiKey => authorize.api_key, 
+       :version => '2.0.1', 
+       :format => 'xml'
+       }
+    end
+    
+    def end_point(resource)
+      "#{authorize.base_url}/#{resource}"
+    end
+    
+    private
+    
+    def validated?
+      valid_authorize_attribute?
+    end
+    
+    def valid_authorize_attribute?
+     return true if authorize.is_a?(UrlShortener::Authorize)
+     raise UrlShortener::AuthorizationFailure, "Authorization type failure\n Received: #{authorize.class} \n Expected: UrlShortener::Authorize"
+    end
+    
+  end
+end

data/lib/url_shortener/error.rb

@@ -0,0 +1,18 @@
+module UrlShortener
+  class Error < StandardError
+    
+    def initialize(data)
+      @data = data
+      super
+    end
+  end
+  
+  class AuthorizationFailure < Error
+  end
+  
+  class ResponseFailure < Error
+  end
+  
+  class NoResult < Error
+  end
+end

data/lib/url_shortener/interface.rb

@@ -0,0 +1,50 @@
+module UrlShortener
+  require 'timeout'
+  
+  class Interface
+    include HTTParty
+    
+    attr_reader :rest_url
+    
+    def initialize(rest_url, options={})
+      @rest_url = rest_url
+      @options = options
+      @result = nil
+      validate?
+    end
+    
+    def get
+      @result ||= UrlShortener::Interface.get(rest_url, @options)
+      timeout(10) do
+        unless result?(@result)
+          raise UrlShortener::NoResult, "No result returned from bit.ly"
+        end
+        if @result['bitly']['errorCode'] == '203'
+          raise UrlShortener::AuthorizationFailure, @result['bitly']['errorMessage']
+        end
+        if @result['bitly']['statusCode'] != 'OK' && @result['bitly']['errorCode'] != '0'
+          raise UrlShortener::ResponseFailure, @result['bitly']['errorMessage']
+        end
+      end
+      return @result['bitly']['results']
+    rescue Timeout::Error => e
+      raise UrlShortener::ResponseFailure, "Connection timed out"
+    end
+    
+    def result?(result)
+      return false unless result
+      return false unless (result.is_a?(Hash) && result['bitly'])
+      return false if result['bitly'].empty?
+      true
+    end
+    
+    private
+    
+    # To prevent calling UrlShortener::Interface.new(nil)
+    def validate?
+      return true if rest_url
+      raise "Interface Url cannot be nil"
+    end
+    
+  end
+end

data/lib/url_shortener.rb

@@ -0,0 +1,9 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require 'rubygems'
+require 'httparty'
+require 'url_shortener/error.rb'
+require 'url_shortener/authorize.rb'
+require 'url_shortener/client.rb'
+require 'url_shortener/interface.rb'

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+$: << File.join(File.dirname(__FILE__), "/../lib") 
+require 'spec' 
+require 'url_shortener'

data/spec/url_shortener/authorize_spec.rb

@@ -0,0 +1,23 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe UrlShortener::Authorize do
+  
+  describe ".new" do
+    before(:each) do
+      @url_shortener = UrlShortener::Authorize.new('login', 'key')
+    end
+    
+    it "should have the login attribute" do
+      @url_shortener.login.should eql('login')
+    end
+    
+    it "should have the api key attribute" do
+      @url_shortener.api_key.should eql('key')
+    end
+
+    it "should have the base url attribute set to bitly api" do
+      @url_shortener.base_url.should eql('http://api.bit.ly')
+    end
+
+  end
+end

data/spec/url_shortener/client_spec.rb

@@ -0,0 +1,129 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe UrlShortener::Client do
+  describe ".new" do
+    before(:each) do
+      @authorize = UrlShortener::Authorize.new 'login', 'key'
+    end
+    
+    it "should recieve the authorize object" do
+      client = UrlShortener::Client.new(@authorize)
+      client.authorize.should eql(@authorize)
+    end
+    
+    it "should raise an error if the authorize attribute is not a UrlShortener::Authorize object" do
+      lambda{ UrlShortener::Client.new(nil) }.should raise_error(UrlShortener::AuthorizationFailure)
+    end
+    
+  end
+  
+  describe "#end_point" do
+    before(:each) do
+      @authorize = UrlShortener::Authorize.new 'login', 'key'
+      @client = UrlShortener::Client.new(@authorize)
+      @resource = 'any'
+    end
+    
+    it "should get the base url from authorization" do
+      @authorize.should_receive(:base_url)
+      @client.end_point(@resource)
+    end
+    
+    it "should return the combination of base url and resource" do
+      @client.end_point(@resource).should eql('http://api.bit.ly/any')
+    end
+  end
+  
+  describe "#common_query_parameters" do
+    before(:each) do
+      @authorize = UrlShortener::Authorize.new 'login', 'key'
+      @client = UrlShortener::Client.new(@authorize)
+    end
+    
+    it "should return a hash of comman parameters" do
+      @client.common_query_parameters.should be_instance_of(Hash)
+    end
+    
+    it "should include the login key" do
+      @client.common_query_parameters.keys.should include(:login)
+    end
+    
+    it "should include the apiKey key" do
+      @client.common_query_parameters.keys.should include(:apiKey)
+    end
+    
+    it "should include the version key" do
+      @client.common_query_parameters.keys.should include(:version)
+    end
+    
+    it "should include the format key" do
+      @client.common_query_parameters.keys.should include(:format)
+    end
+    
+    it "should get login attribute of authorize object" do
+      @authorize.should_receive(:login)
+      @client.common_query_parameters
+    end
+    
+    it "should have the login key value from the login attribute of authorize object" do
+      @client.common_query_parameters[:login].should eql('login')
+    end
+    
+    it "should get api key attribute of authorize object" do
+      @authorize.should_receive(:api_key)
+      @client.common_query_parameters
+    end
+    
+    it "should have the apikey value from the api_key attribute of authorize object" do
+      @client.common_query_parameters[:apiKey].should eql('key')
+    end
+    
+    it "should have the value of xml for the format key" do
+      @client.common_query_parameters[:format].should eql('xml')
+    end
+  end
+  
+  describe "#shorten" 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')
+    end
+    
+    it "should get the data using interface" do
+      @interface.should_receive(:get)
+      @client.shorten('a url')
+    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({})
+    end
+    
+    it "should initialize the interface object" do
+      UrlShortener::Interface.should_receive(:new).with('/some/uri', :query => {})
+      @client.interface('/some/uri')
+    end
+    
+    it "should get the common query parameters" do
+      @client.should_receive(:common_query_parameters)
+      @client.interface('/some/uri')
+    end
+  end
+  
+end

data/spec/url_shortener/interface_spec.rb

@@ -0,0 +1,86 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe UrlShortener::Interface do
+  
+  describe ".new" do
+    it "should have the rest url" do
+      @interface = UrlShortener::Interface.new('some/url')
+      @interface.rest_url.should eql('some/url')
+    end
+    
+    it "should raise error when nil parameter is provided" do
+      lambda { UrlShortener::Interface.new(nil) }.should raise_error('Interface Url cannot be nil')
+    end
+  end
+  
+  describe "#get" do
+    before(:each) do
+      @rest_url = 'http://some/url'
+      @interface = UrlShortener::Interface.new(@rest_url)
+      @interface.stub!(:result?).and_return(true)
+      @result = {'bitly' => {'errorCode' => '0', 'statusCode' => 'OK', 'results' => 'return result'}}
+      UrlShortener::Interface.stub!(:get).and_return(@result)
+    end
+    
+    it "should call the get class method provided by httparty" do
+      UrlShortener::Interface.should_receive(:get).with(@rest_url,{}).and_return(@result)
+      @interface.get
+    end
+    
+    it "should have a 10 second timeout set" do
+      @interface.should_receive(:timeout).with(10)
+      @interface.get
+    end
+    
+    it "should raise NoResult error whern there is no result" do
+      @interface.stub!(:result?)
+      lambda { @interface.get }.should raise_error(UrlShortener::NoResult, "No result returned from bit.ly")
+    end
+    
+    it "should raise AuthorizationFailure error when not authorised and error code in 203" do
+      result = {'bitly' => {'errorCode' => '203', 'errorMessage' => 'Any message returned'}}
+      UrlShortener::Interface.stub!(:get).and_return(result)
+      lambda { @interface.get }.should raise_error(UrlShortener::AuthorizationFailure, "Any message returned")
+    end
+    
+    it "should raise response failure when returned status code is not OK and error code is not 0" do
+      result = {'bitly' => {'errorCode' => 'not 0', 'statusCode' => 'not OK', 'errorMessage' => 'Any message returned'}}
+      UrlShortener::Interface.stub!(:get).and_return(result)
+      lambda { @interface.get }.should raise_error(UrlShortener::ResponseFailure, "Any message returned")
+    end
+    
+    it "should return the results hash from the returned results if status code is OK and errorCode is 0" do
+      @interface.get.should eql('return result')
+    end
+  end
+  
+  describe "#result?" do
+    before(:each) do
+      @rest_url = 'http://some/url'
+      @interface = UrlShortener::Interface.new(@rest_url)
+    end
+    it "should return false if result is not present" do
+      @interface.result?(nil).should eql(false)
+    end
+    
+    it "should return false if result is not a hash" do
+      @interface.result?('d').should eql(false)
+    end
+    
+    it "should return false if there is no 'bitly' key in the result" do
+      @interface.result?({}).should eql(false)
+    end
+    
+    it "should return nil if the value for 'bitly' key is nil" do
+      @interface.result?({'bitly' => nil}).should eql(false)
+    end
+    
+    it "should return false if the value for 'bitly' key is an empty hash" do
+      @interface.result?({'bitly' => {}}).should eql(false)
+    end
+    
+    it "should return true if the value for 'bitly' key is a hash with some key values" do
+      @interface.result?({'bitly' => {'otherkeys' => 'othervalues'}}).should eql(true)
+    end
+  end
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: url_shortener
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Nasir Jamal
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-11-08 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.4.5
+    version: 
+description: Url Shortener is a Ruby library /gem and API wrapper for bit.ly
+email: nas35_in@yahoo.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- lib/url_shortener.rb
+- lib/url_shortener/authorize.rb
+- lib/url_shortener/client.rb
+- lib/url_shortener/error.rb
+- lib/url_shortener/interface.rb
+has_rdoc: true
+homepage: http://github.com/nas/url_shortener
+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: "1.8"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 2
+summary: Url Shortener is a Ruby library /gem and API wrapper for bit.ly
+test_files: 
+- spec/spec_helper.rb
+- spec/url_shortener/authorize_spec.rb
+- spec/url_shortener/client_spec.rb
+- spec/url_shortener/interface_spec.rb
+- features/connect_to_bitly.feature
+- features/short_url.feature
+- features/support/env.rb
+- features/step_definitions/connection_error_steps.rb
+- features/step_definitions/short_url_steps.rb