erkki-bitly 0.3.1

data/History.txt

@@ -0,0 +1,48 @@
+=== 0.3 / 2009-07-09
+
+* 1 major enhancement
+
+  * a full set of tests, properly mocked
+
+* 1 minor enhancement
+
+  * calling bitly.shorten(:history => 1) will add the url to the api user's history.
+  
+* 1 bug fix
+
+  * you can no longer call shorten with a keyword, this was unsupported in the API and consequently removed
+
+=== 0.2 / 2009-06-23
+
+* 1 enhancement
+
+  * Depends on Crack instead of JSON, so can run on Jruby
+  
+* 1 bug fix
+
+  * Does not choke when bit.ly chokes. Returns a BitlyError instead
+
+=== 0.1.4 / 2009-04-13
+
+* 1 bug fix
+
+	* Urls with parameters were choking, changed to using CGI.
+
+=== 0.1.2 / 2009-03-12
+
+* 1 minor enhancement
+
+	* Allows to add a keyword for shortening urls
+
+=== 0.1.1 / 2009-01-26
+
+* 1 bug fix
+
+  * Didn't include dependency on JSON
+
+=== 0.1.0 / 2009-01-26
+
+* 1 major enhancement
+
+  * First release
+

data/Manifest

@@ -0,0 +1,11 @@
+bitly.gemspec
+History.txt
+lib/bitly/client.rb
+lib/bitly/url.rb
+lib/bitly/utils.rb
+lib/bitly/version.rb
+lib/bitly.rb
+Manifest
+Rakefile
+README.txt
+test/test_bitly.rb

data/README.txt

@@ -0,0 +1,65 @@
+= bitly
+
+== DESCRIPTION:
+
+A Ruby API for bit.ly
+
+http://code.google.com/p/bitly-api/wiki/ApiDocumentation
+
+== INSTALLATION:
+
+gem install bitly
+
+== USAGE:
+
+Create a Bitly client using your username and api key as follows:
+
+bitly = Bitly.new(username, api_key)
+
+You can then use that client to shorten or expand urls or return more information or statistics as so:
+
+bitly.shorten('http://www.google.com')
+bitly.shorten('http://www.google.com', :history => 1) # adds the url to the api user's history
+bitly.expand('wQaT')
+bitly.info('http://bit.ly/wQaT')
+bitly.stats('http://bit.ly/wQaT')
+
+Each can be used in all the methods described in the API docs, the shorten function, for example, takes a url or an array of urls.
+
+All four functions return a Bitly::Url object (or an array of Bitly::Url objects if you supplied an array as the input). You can then get all the information required from that object.
+
+u = bitly.shorten('http://www.google.com') #=> Bitly::Url
+
+u.long_url #=> "http://www.google.com"
+u.short_url #=> "http://bit.ly/Ywd1"
+u.user_hash #=> "Ywd1"
+u.hash #=> "2V6CFi"
+u.info #=> a ruby hash of the JSON returned from the API
+u.stats #=> a ruby hash of the JSON returned from the API
+
+bitly.shorten('http://www.google.com', 'keyword')
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Phil Nash
+
+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/Rakefile

@@ -0,0 +1,19 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require './lib/bitly.rb'
+
+# modified by coryosborn to remove native JSON dependency
+
+Echoe.new('bitly', Bitly::VERSION) do |p|
+  p.description = "Use the bit.ly API to shorten or expand URLs"
+  p.url = "http://github.com/philnash/bitly"
+  p.author = "Phil Nash"
+  p.email = "philnash@gmail.com"
+  p.extra_deps      = [['crack', '>= 0.1.1']]
+  p.development_dependencies = []
+end
+
+# vim: syntax=Ruby

data/bitly.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{bitly}
+  s.version = "0.3.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Phil Nash"]
+  s.date = %q{2009-07-09}
+  s.description = %q{Use the bit.ly API to shorten or expand URLs}
+  s.email = %q{philnash@gmail.com}
+  s.extra_rdoc_files = ["lib/bitly/client.rb", "lib/bitly/url.rb", "lib/bitly/utils.rb", "lib/bitly/version.rb", "lib/bitly.rb", "README.txt"]
+  s.files = ["bitly.gemspec", "History.txt", "lib/bitly/client.rb", "lib/bitly/url.rb", "lib/bitly/utils.rb", "lib/bitly/version.rb", "lib/bitly.rb", "Manifest", "Rakefile", "README.txt", "test/test_bitly.rb", "test/bitly/test_client.rb", "test/bitly/test_url.rb", "test/bitly/test_utils.rb", "test/test_helper.rb"]
+  s.homepage = %q{http://github.com/philnash/bitly}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Bitly", "--main", "README.txt"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{bitly}
+  s.rubygems_version = %q{1.3.4}
+  s.summary = %q{Use the bit.ly API to shorten or expand URLs}
+  s.test_files = ["test/bitly/test_client.rb", "test/bitly/test_url.rb", "test/bitly/test_utils.rb", "test/test_bitly.rb", "test/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_runtime_dependency(%q<crack>, [">= 0.1.1"])
+    else
+      s.add_dependency(%q<crack>, [">= 0.1.1"])
+    end
+  else
+    s.add_dependency(%q<crack>, [">= 0.1.1"])
+  end
+end

data/lib/bitly.rb

@@ -0,0 +1,10 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+gem 'crack'
+require 'crack'
+
+require 'bitly/utils'
+require 'bitly/client'
+require 'bitly/url'
+require 'bitly/version'

data/lib/bitly/client.rb

@@ -0,0 +1,150 @@
+require 'rubygems'
+require 'net/http'
+require 'uri'
+
+module Bitly
+  API_URL     = 'http://api.bit.ly/'
+  API_VERSION = '2.0.1'
+
+  def self.new(login, api_key)
+    Bitly::Client.new(login,api_key)
+  end
+
+  class Client
+    
+    include Bitly::Utils
+    
+    def initialize(login,api_key)
+      @login = login
+      @api_key = api_key
+    end
+
+    def shorten(input, opts={})
+      if input.is_a? String
+        request = create_url("shorten", :longUrl => input, :history => (opts[:history] ? 1 : nil))
+        result = get_result(request)
+        result = {:long_url => input}.merge result[input]
+        Bitly::Url.new(@login,@api_key,result)
+      elsif input.is_a? Array
+        request = create_url("shorten", :history => (opts[:history] ? 1 : nil))
+        request.query << "&" + input.map { |long_url| "longUrl=#{CGI.escape(long_url)}" }.join("&") unless input.nil?
+        result = get_result(request)
+        input.map do |long_url|
+          new_url = {:long_url => long_url}.merge result[long_url]
+          long_url = Bitly::Url.new(@login,@api_key,new_url)
+        end
+      else
+        raise ArgumentError.new("Shorten requires either a url or an array of urls")
+      end
+    end
+    
+    def expand(input)
+      if input.is_a? String
+        if input.include? "bit.ly/"
+          hash = create_hash_from_url(input)
+          request = create_url "expand", :hash => hash
+          result = get_result(request)
+          result = { :short_url => input, :hash => hash }.merge result[hash]
+        else
+          request = create_url "expand", :hash => input
+          result = get_result(request)
+          result = { :hash => input, :short_url => "http://bit.ly/#{input}" }.merge result[input]
+        end
+        Bitly::Url.new(@login,@api_key,result)        
+      elsif input.is_a? Array
+        request = create_url "expand", :hash => input.join(',')
+        result = get_result(request)
+        input.map do |hsh|
+          new_url = {:hash => hsh, :short_url => "http://bit.ly/#{hsh}"}.merge result[hsh]
+          hsh = Bitly::Url.new(@login,@api_key,new_url)
+        end
+      else
+        raise ArgumentError('Expand requires either a short url, a hash or an array of hashes')
+      end
+    end
+    
+    def info(input)
+      if input.is_a? String
+        if input.include? "bit.ly/"
+          hash = create_hash_from_url(input)
+          request = create_url 'info', :hash => hash
+          result = get_result(request)
+          result = { :short_url => "http://bit.ly/#{hash}", :hash => hash }.merge result[hash]
+        else
+          request = create_url 'info', :hash => input
+          result = get_result(request)
+          result = { :short_url => "http://bit.ly/#{input}", :hash => input }.merge result[input]
+        end
+        Bitly::Url.new(@login,@api_key,result)
+      elsif input.is_a? Array
+        request = create_url "info", :hash => input.join(',')
+        result = get_result(request)
+        input.map do |hsh|
+          new_url = {:hash => hsh, :short_url => "http://bit.ly/#{hsh}"}.merge result[hsh]
+          hsh = Bitly::Url.new(@login,@api_key,:info => new_url)
+        end
+      else
+        raise ArgumentError.new('Info requires either a short url, a hash or an array of hashes')
+      end
+    end
+    
+    def stats(input)
+      if input.is_a? String
+        if input.include? "bit.ly/"
+          hash = create_hash_from_url(input)
+          request = create_url 'stats', :hash => hash
+          result = get_result(request)
+          result = { :short_url => "http://bit.ly/#{hash}", :hash => hash }.merge result
+        else
+          request = create_url 'stats', :hash => input
+          result = get_result(request)
+          result = { :short_url => "http://bit.ly/#{input}", :hash => input }.merge result
+        end
+        Bitly::Url.new(@login,@api_key,:stats => result)
+      else
+        raise ArgumentError.new("Stats requires either a short url or a hash")
+      end
+    end
+    
+  end
+  
+end
+
+class BitlyError < StandardError
+  attr_reader :code
+  alias :msg :message
+  def initialize(msg, code)
+    @code = code
+    super("#{msg} - '#{code}'")
+  end
+end
+
+
+# How it should work
+# ==================
+# bitly = Bitly::Base.new('philnash','R_7776acc394294b2b0ad2c261a91c483d')
+# bitly.shorten("http://www.google.com")
+# #=> Bitly::Url
+# bitly.shorten(["http://www.google.com","http://cnn.com"])
+# #=> [Bitly::Url,Bitly::Url]
+# 
+# bitly.expand("http://bit.ly/wIRm")
+# #=> Bitly::Url
+# bitly.expand("wIRm")
+# #=> Bitly::Url
+# bitly.expand(["wIRm","sdfsd"])
+# #=> [Bitly::Url,Bitly::Url]
+#
+# bitly.info("http://bit.ly/wIRm") || bitly.info("wIRm")
+# #=> b = Bitly::Url
+# #=> b.info #=> hash of data back from info
+# bitly.info(['wIRm','qsads'])
+# #=> [Bitly::Url, Bitly::Url]
+# also, with any url = Bitly::Url
+# url.info #=> hash of info data
+
+# bitly.stats("http://bit.ly/wIRm") || bitly.stats("wIRm")
+# #=> b = Bitly::Url
+# #=> b.stats #=> hash of stats
+# also, any url = Bitly::Url
+# url.stats #=> hash of stats

data/lib/bitly/url.rb

@@ -0,0 +1,97 @@
+module Bitly
+  
+  class Url
+    include Bitly::Utils
+    
+    attr_accessor :long_url, :short_url, :hash, :user_hash
+    attr_reader :info, :stats
+    VARIABLES = ['long_url', 'short_url', 'hash', 'user_hash']
+    
+    def initialize(login,api_key,obj=nil)
+      unless obj.nil?
+        raise BitlyError.new(result['errorMessage'],result['errorCode']) if obj['statusCode'] == "ERROR"
+        instance_variablise(obj, VARIABLES)
+        @info = obj[:info] if obj[:info]
+        @stats = obj[:stats] if obj[:stats]
+      end
+      @login = login
+      @api_key = api_key
+      raise ArgumentError.new("Please provide a login and api_key") if @login.nil? || @api_key.nil?
+    end
+    
+    def shorten(opts = {})
+      return @short_url if @short_url
+      unless @long_url.nil?
+        request = create_url("shorten", :longUrl => @long_url, :history => (opts[:history] ? 1 : nil))
+        result = get_result(request)[@long_url.gsub(/\/$/,'')]
+        if result['statusCode'] == "ERROR"
+          raise BitlyError.new(result['errorMessage'],result['errorCode'])
+        else
+          instance_variablise(result,VARIABLES)
+          return @short_url
+        end
+      else
+        raise ArgumentError.new("You need a long_url in order to shorten it")
+      end
+    end
+    
+    def expand
+      return @long_url if @long_url
+      unless !(@short_url || @hash)
+        unless @hash
+          @hash = create_hash_from_url(@short_url)
+        end
+        request = create_url("expand", :hash => @hash)
+        result = get_result(request)[@hash]
+        if result['statusCode'] == "ERROR"
+          raise BitlyError.new(result['errorMessage'],result['errorCode'])
+        else
+          instance_variablise(result,VARIABLES)
+          return @long_url
+        end
+      else
+        raise ArgumentError.new("You need a short_url or a hash in order to expand it")
+      end
+    end
+    
+    def info
+      if @info.nil?
+        if @hash
+          request = create_url "info", :hash => @hash
+          result = get_result(request)[@hash]
+          instance_variablise(result, VARIABLES)
+          @info = result
+        elsif @short_url
+          @hash = create_hash_from_url(@short_url)
+          request = create_url "info", :hash => hash
+          result = get_result(request)[hash]
+          instance_variablise(result, VARIABLES)
+          @info = result
+        else
+          raise ArgumentError.new("You need a hash or short_url in order to get info")
+        end
+        return @info
+      else
+        @info
+      end
+    end
+    
+    def stats
+      if @stats.nil?
+        if @hash
+          request = create_url "stats", :hash => @hash
+        elsif @short_url
+          @hash = create_hash_from_url(@short_url)
+          request = create_url "stats", :hash => @hash
+        else
+          raise ArgumentError.new("You need a hash or short_url in order to get stats")
+        end
+        @stats = get_result(request)
+      else
+        @stats
+      end
+    end
+    
+  end
+
+end

data/lib/bitly/utils.rb

@@ -0,0 +1,58 @@
+require 'cgi'
+
+module Bitly
+  module Utils
+    def underscore(camel_cased_word) # stolen from rails
+      camel_cased_word.to_s.gsub(/::/, '/').
+      gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+      gsub(/([a-z\d])([A-Z])/,'\1_\2').
+      tr("-", "_").
+      downcase
+    end
+    
+    def create_hash_from_url(url)
+      url.gsub(/^.*bit.ly\//,'')
+    end
+    
+    def attr_define(k,v)
+      instance_variable_set("@#{k}", v)
+      meta = class << self; self; end
+      meta.class_eval { attr_reader k.to_sym }
+    end
+
+    def instance_variablise(obj,variables)
+      if obj.is_a? Hash
+        obj.each do |k,v|
+          if v.is_a? Hash
+            instance_variablise(v,variables)
+          else
+            attr_define(underscore(k),v) if variables.include?(underscore(k))
+          end
+        end
+      end
+    end
+    
+    def create_url(resource="",args={})
+      args = args.merge({:login => @login, :apiKey => @api_key, :version => API_VERSION})
+      url = URI.join(API_URL,resource)
+      long_urls = args.delete(:long_urls)
+      url.query = args.map { |k,v| "%s=%s" % [CGI.escape(k.to_s), CGI.escape(v.to_s)] }.join("&")
+      url.query << "&" + long_urls.map { |long_url| "longUrl=#{CGI.escape(long_url)}" }.join("&") unless long_urls.nil?
+      url
+    end
+    
+    def get_result(request)
+      begin
+        result = Crack::JSON.parse(Net::HTTP.get(request))
+      rescue
+        result = {'errorMessage' => 'JSON Parse Error(Bit.ly messed up)', 'errorCode' => 69, 'statusCode' => 'ERROR'}
+      end
+      if result['statusCode'] == "OK"
+        result = result['results']
+      else
+        raise BitlyError.new(result['errorMessage'],result['errorCode'])
+      end
+    end
+    
+  end
+end

data/lib/bitly/version.rb

@@ -0,0 +1,3 @@
+module Bitly
+  VERSION = '0.3'
+end

data/test/bitly/test_client.rb

@@ -0,0 +1,187 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper.rb')
+
+class TestClient < Test::Unit::TestCase
+  context "bitly module" do
+    should "create a new bitly client" do
+      b = Bitly.new(login, api_key)
+      assert_equal Bitly::Client, b.class
+    end
+  end
+  context "using the bitly client" do
+    setup do
+      @bitly = Bitly.new(login, api_key)
+    end
+    
+    context "shortening" do
+      context "a single link" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/shorten\?.*longUrl=.*cnn.com.*$/,"cnn.json")
+          @url = @bitly.shorten('http://cnn.com')
+        end
+        should "return a Bitly::Url" do
+          assert_kind_of Bitly::Url, @url
+        end
+        should "return a short bitly url" do
+          assert_equal "http://bit.ly/15DlK", @url.short_url
+        end
+        should "save the long url" do
+          assert_equal "http://cnn.com", @url.long_url
+        end
+      end
+      context "multiple links" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/shorten\?.*longUrl=.*longUrl=.*$/,"cnn_and_google.json")
+          @urls = @bitly.shorten(['http://cnn.com', 'http://google.com'])
+        end
+        should "return an array of Bitly::Urls" do
+          assert_kind_of Array, @urls
+          assert_kind_of Bitly::Url, @urls[0]
+        end
+        should "shorten the urls in order" do
+          assert_equal "http://bit.ly/15DlK", @urls[0].short_url
+          assert_equal "http://bit.ly/11etr", @urls[1].short_url
+        end
+        should "save the long urls" do
+          assert_equal "http://cnn.com", @urls[0].long_url
+          assert_equal "http://google.com", @urls[1].long_url
+        end
+      end
+      context "no links" do
+        should "raise an ArgumentError" do
+          assert_raise ArgumentError do
+            @bitly.shorten
+          end
+        end
+      end
+    end
+    context "expanding" do
+      context "a hash" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/expand\?.*hash=31IqMl.*$/,"expand_cnn.json")
+          @url = @bitly.expand("31IqMl")
+        end
+        should "return a Bitly::Url" do
+          assert_kind_of Bitly::Url, @url
+        end
+        should "return the expanded url" do
+          assert_equal "http://cnn.com/", @url.long_url
+        end
+        should "save the hash" do
+          assert_equal "31IqMl", @url.hash
+        end
+        should "save the short url" do
+          assert_equal "http://bit.ly/31IqMl", @url.short_url
+        end
+      end
+      context "a short url" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/expand\?.*hash=31IqMl.*$/,"expand_cnn.json")
+          @url = @bitly.expand("http://bit.ly/31IqMl")
+        end
+        should "return a Bitly::Url" do
+          assert_kind_of Bitly::Url, @url
+        end
+        should "return the expanded url" do
+          assert_equal "http://cnn.com/", @url.long_url
+        end
+        should "save the hash" do
+          assert_equal "31IqMl", @url.hash
+        end
+        should "save the short url" do
+          assert_equal "http://bit.ly/31IqMl", @url.short_url
+        end
+      end
+      context "multiple hashes" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/expand\?.*hash=15DlK.*3j4ir4.*$/,"expand_cnn_and_google.json")
+          @urls = @bitly.expand(["15DlK","3j4ir4"])
+        end
+        should "return an array of Bitly::Urls" do
+          assert_kind_of Array, @urls
+          assert_kind_of Bitly::Url, @urls[0]
+          assert_kind_of Bitly::Url, @urls[1]
+        end
+        should "expand the hashes in order" do
+          assert_equal "http://cnn.com/", @urls[0].long_url
+          assert_equal "http://google.com/", @urls[1].long_url
+        end
+        should "save the hash to each url" do
+          assert_equal "15DlK", @urls[0].hash
+          assert_equal "3j4ir4", @urls[1].hash
+        end
+      end
+    end
+    context "to get info on" do
+      context "a single link" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/info\?.*hash=3j4ir4.*$/,"google_info.json")
+          @url = @bitly.info('http://bit.ly/3j4ir4')
+        end
+        should "return a Bitly::Url" do
+          assert_kind_of Bitly::Url, @url
+        end
+        should "return an info object with the url" do
+          assert_not_nil @url.info
+        end
+      end
+      context "a single hash" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/info\?.*hash=3j4ir4.*$/,"google_info.json")
+          @url = @bitly.info('3j4ir4')
+        end
+        should "return a Bitly::Url" do
+          assert_kind_of Bitly::Url, @url
+        end
+        should "return an info object with the url" do
+          assert_not_nil @url.info
+        end
+      end
+      context "a list of hashes" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/info\?.*hash=3j4ir4.*31IqMl.*$/,"google_and_cnn_info.json")
+          @urls = @bitly.info(['3j4ir4','31IqMl'])
+        end
+        should "return a Bitly::Url" do
+          assert_kind_of Array, @urls
+        end
+        should "return an info object with the url" do
+          assert_not_nil @urls[0].info
+          assert_not_nil @urls[1].info
+        end
+      end
+    end
+    context "to get stats on" do
+      context "a single link" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/stats\?.*hash=3j4ir4.*$/,"google_stats.json")
+          @url = @bitly.stats('http://bit.ly/3j4ir4')
+        end
+        should "return a Bitly::Url" do
+          assert_kind_of Bitly::Url, @url
+        end
+        should "return an stats object" do
+          assert_not_nil @url.stats
+        end
+      end
+      context "a single hash" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/stats\?.*hash=3j4ir4.*$/,"google_stats.json")
+          @url = @bitly.stats('3j4ir4')
+        end
+        should "return a Bitly::Url" do
+          assert_kind_of Bitly::Url, @url
+        end
+        should "return an stats object" do
+          assert_not_nil @url.stats
+        end
+      end
+      context "a list of hashes" do
+        should "return an argument error" do
+          assert_raise ArgumentError do
+            @bitly.stats(['3j4ir4','31IqMl'])
+          end
+        end
+      end
+    end
+  end
+end

data/test/bitly/test_url.rb

@@ -0,0 +1,168 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper.rb')
+
+class TestUrl < Test::Unit::TestCase
+  context "a new Bitly::Url" do
+    should "require a login and api_key" do
+      assert_raise ArgumentError do Bitly::Url.new end
+      assert_raise ArgumentError do Bitly::Url.new(login) end
+      assert_raise ArgumentError do Bitly::Url.new(nil, api_key) end
+      assert_nothing_raised do
+        Bitly::Url.new(login, api_key)
+        Bitly::Url.new(login, api_key, :hash => '3j4ir4')
+        Bitly::Url.new(login, api_key, :short_url => 'http://bit.ly/3j4ir4')
+        Bitly::Url.new(login, api_key, :long_url => 'http://google.com/')
+      end
+    end
+    context "shortening" do
+      context "with a long url" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/shorten\?.*longUrl=.*cnn.com.*$/,"cnn.json")
+          @url = Bitly::Url.new(login, api_key, :long_url => 'http://cnn.com/')
+        end
+        should "return a short url" do
+          assert_equal "http://bit.ly/15DlK", @url.shorten
+        end
+      end
+      context "with no long url" do
+        setup do
+          @url = Bitly::Url.new(login, api_key)
+        end
+        should "raise an error" do
+          assert_raise ArgumentError do
+            @url.shorten
+          end
+        end
+      end
+      context "with a short url already" do
+        setup do
+          @url = Bitly::Url.new(login, api_key, :short_url => 'http://bit.ly/31IqMl')
+          flexmock(@url).should_receive(:create_url).never
+        end
+        should "not need to call the api" do
+          assert_equal "http://bit.ly/31IqMl", @url.shorten
+        end
+      end
+    end
+    context "expanding" do
+      context "with a hash" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/expand\?.*hash=31IqMl.*$/,"expand_cnn.json")
+          @url = Bitly::Url.new(login, api_key, :hash => '31IqMl')
+        end
+        should "return an expanded url" do
+          assert_equal "http://cnn.com/", @url.expand
+        end
+      end
+      context "with a short url" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/expand\?.*hash=31IqMl.*$/,"expand_cnn.json")
+          @url = Bitly::Url.new(login, api_key, :short_url => 'http://bit.ly/31IqMl')
+        end
+        should "return an expanded url" do
+          assert_equal "http://cnn.com/", @url.expand
+        end
+      end
+      context "with no short url or hash" do
+        setup do
+          @url = Bitly::Url.new(login, api_key)
+        end
+        should "raise an error" do
+          assert_raise ArgumentError do
+            @url.expand
+          end
+        end
+      end
+      context "with a long url already" do
+        setup do
+          @url = Bitly::Url.new(login, api_key, :long_url => 'http://google.com')
+          flexmock(@url).should_receive(:create_url).never
+        end
+        should "not need to call the api" do
+          assert_equal "http://google.com", @url.expand
+        end
+      end
+    end
+    context "info" do
+      context "with a hash" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/info\?.*hash=3j4ir4.*$/,"google_info.json")
+          @url = Bitly::Url.new(login, api_key, :hash => '3j4ir4')
+        end
+        should "return info" do
+          assert_equal "Google", @url.info['htmlTitle']
+        end
+      end
+      context "with a short url" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/info\?.*hash=3j4ir4.*$/,"google_info.json")
+          @url = Bitly::Url.new(login, api_key, :short_url => 'http://bit.ly/3j4ir4')
+        end
+        should "return an expanded url" do
+          assert_equal "Google", @url.info['htmlTitle']
+        end
+      end
+      context "without a short url or hash" do
+        setup do
+          @url = Bitly::Url.new(login, api_key, :long_url => 'http://google.com')
+        end
+        should "raise an error" do
+          assert_raise ArgumentError do
+            @url.info
+          end
+        end
+      end
+      context "with info already" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/info\?.*hash=3j4ir4.*$/,"google_info.json")
+          @url = Bitly::Url.new(login, api_key, :short_url => 'http://bit.ly/3j4ir4')
+          @url.info
+        end
+        should "not call the api twice" do
+          flexmock(@url).should_receive(:create_url).never
+          @url.info
+        end
+      end
+    end
+    context "stats" do
+      context "with a hash" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/stats\?.*hash=3j4ir4.*$/,"google_stats.json")
+          @url = Bitly::Url.new(login, api_key, :hash => '3j4ir4')
+        end
+        should "return info" do
+          assert_equal 2644, @url.stats['clicks']
+        end
+      end
+      context "with a short url" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/stats\?.*hash=3j4ir4.*$/,"google_stats.json")
+          @url = Bitly::Url.new(login, api_key, :short_url => 'http://bit.ly/3j4ir4')
+        end
+        should "return an expanded url" do
+          assert_equal 2644, @url.stats['clicks']
+        end
+      end
+      context "without a short url or hash" do
+        setup do
+          @url = Bitly::Url.new(login, api_key, :long_url => 'http://google.com')
+        end
+        should "raise an error" do
+          assert_raise ArgumentError do
+            @url.stats
+          end
+        end
+      end
+      context "with info already" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/stats\?.*hash=3j4ir4.*$/,"google_stats.json")
+          @url = Bitly::Url.new(login, api_key, :short_url => 'http://bit.ly/3j4ir4')
+          @url.stats
+        end
+        should "not call the api twice" do
+          flexmock(@url).should_receive(:create_url).never
+          @url.stats
+        end
+      end
+    end
+  end
+end

data/test/bitly/test_utils.rb

@@ -0,0 +1,76 @@
+require File.join(File.dirname(__FILE__), '..', 'test_helper.rb')
+
+class TestUtils < Test::Unit::TestCase
+  include Bitly::Utils
+  API_VERSION = '2.0.1'
+  
+  context "text utils" do
+    should "underscore a word" do
+      assert_equal "hello_world", underscore("HelloWorld")
+    end
+    should "create a hash from a short url" do
+      assert_equal "hello", create_hash_from_url("http://bit.ly/hello")
+    end
+  end
+  
+  context "class utils" do
+    should "turn a key value pair into an instance variable" do
+      attr_define('hello','goodbye')
+      assert_equal @hello, "goodbye"
+    end
+    
+    should "turn a hash into instance variables" do
+      instance_variablise({'hello' => 'goodbye'}, ['hello'])
+      assert_equal @hello, "goodbye"
+    end
+    
+    should "not turn nonspecified variables into instance variables" do
+      instance_variablise({'hello' => 'goodbye'}, [])
+      assert_nil @hello
+    end
+  end
+  
+  context "creating a url" do
+    setup do
+      @api_key = api_key
+      @login = login
+    end
+    should "contain all the basic information" do
+      url = create_url.to_s
+      assert url.include?('http://api.bit.ly/')
+      assert url.include?("version=#{API_VERSION}")
+      assert url.include?("apiKey=#{api_key}")
+      assert url.include?("login=#{login}")
+    end
+    should "contain the right resource" do
+      url = create_url('shorten').to_s
+      assert url.include?('/shorten')
+    end
+    should "contain extra parameters" do
+      url = create_url('shorten', :longUrl => 'http://google.com').to_s
+      assert url.include?("longUrl=#{CGI.escape('http://google.com')}")
+    end
+  end
+  
+  context "fetching a url" do
+    context "successfully" do
+      setup do
+        stub_get("http://example.com","cnn.json")
+      end
+      should "return a json object successfully" do
+        result = get_result(URI.join("http://example.com"))
+        assert_equal Hash, result.class
+      end
+    end
+    context "unsuccessfully" do
+      setup do
+        stub_get("http://example.com", 'shorten_error.json')
+      end
+      should "raise BitlyError" do
+        assert_raise BitlyError do
+          result = get_result(URI.join("http://example.com"))
+        end
+      end
+    end
+  end
+end

data/test/test_bitly.rb

@@ -0,0 +1,81 @@
+# require 'test/unit'
+# require 'rubygems'
+# require 'shoulda'
+# require 'flexmock'
+# require 'bitly'
+# 
+# class TestBitly < Test::Unit::TestCase
+#   
+#   context "with a bitly client" do
+#     setup do
+#       @api_key = 'test_key'
+#       @login = 'test_account'
+#       @bitly = Bitly.new(@login,@api_key)
+#     end
+#   
+#     context "shortening" do
+#       
+#       context "a single url" do
+#         setup do
+#           
+#         end
+#       def test_returns_single_short_url
+#         url = @bitly.shorten("http://cnn.com")
+#         assert_kind_of Bitly::Url, url
+#         assert_equal "http://cnn.com", url.long_url
+#         assert_equal "http://bit.ly/15DlK", url.short_url
+#       end
+#   
+#   def test_shortens_multiple_urls
+#     urls = @bitly.shorten(["http://cnn.com","http://google.com"])
+#     assert_equal "http://cnn.com", urls[0].long_url
+#     assert_equal "http://bit.ly/15DlK", urls[0].short_url
+#     assert_equal "http://google.com", urls[1].long_url
+#     assert_equal "http://bit.ly/11etr", urls[1].short_url
+#   end
+#   
+#   def test_can_shorten_a_url_with_parameters
+#     url = @bitly.shorten("http://www.google.com/search?hl=en&q=url&btnG=Google+Search&aq=f&oq=")
+#     assert_kind_of Bitly::Url, url
+#     assert_equal "http://www.google.com/search?hl=en&q=url&btnG=Google+Search&aq=f&oq=", url.long_url
+#     assert_equal "http://bit.ly/NqK6i", url.short_url
+#   end
+#   
+#   def test_returns_a_long_url
+#     urls = @bitly.expand(["2bYgqR","1RmnUT"])
+#     assert_kind_of Bitly::Url, urls[0]
+#     assert_equal "http://cnn.com", urls[0].long_url
+#     assert_equal "2bYgqR", urls[0].hash
+#     assert_equal "http://google.com", urls[1].long_url
+#     assert_equal "1RmnUT", urls[1].hash
+#     url = @bitly.expand("http://bit.ly/wQaT")
+#     assert_kind_of Bitly::Url, url
+#     assert_equal "http://bit.ly/wQaT", url.short_url
+#     assert_equal "http://google.com/", url.long_url
+#     assert_equal "wQaT", url.hash
+#     url2 = @bitly.expand("wQaT")
+#     assert_kind_of Bitly::Url, url2
+#     assert_equal "wQaT", url2.hash
+#     assert_equal "http://bit.ly/wQaT", url2.short_url
+#     assert_equal "http://google.com/", url2.long_url
+#   end
+#   
+#   # def test_returns_keyword_url
+#   #   #kind of ghetto test but we need it to be different every time
+#   #   require 'digest/sha1'
+#   #   keyword = Digest::SHA1.hexdigest(DateTime.now.to_s)
+#   # 
+#   #   url = @bitly.shorten("http://google.com", :keyword => keyword)
+#   #   assert_equal url.short_keyword_url, "http://bit.ly/#{keyword}"
+#   # end
+# 
+#   def test_returns_error_on_existing_keyword
+#     keyword = 'apple'
+#     assert_raise BitlyError do
+#       @bitly.shorten("http://apple.com/itunes", :keyword => keyword)
+#     end
+#   end
+# 
+#   
+#   
+# end

data/test/test_helper.rb

@@ -0,0 +1,29 @@
+require 'test/unit'
+require 'rubygems'
+require 'shoulda'
+require 'flexmock/test_unit'
+require 'fakeweb'
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'bitly')
+
+FakeWeb.allow_net_connect = false
+
+def fixture_file(filename)
+  return '' if filename == ''
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  File.read(file_path)
+end
+
+def stub_get(url, filename, status=nil)
+  options = {:body => fixture_file(filename)}
+  options.merge!({:status => status}) unless status.nil?
+  
+  FakeWeb.register_uri(:get, url, options)
+end
+
+def api_key
+  'test_key'
+end
+def login
+  'test_account'
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: erkki-bitly
+version: !ruby/object:Gem::Version 
+  version: 0.3.1
+platform: ruby
+authors: 
+- Phil Nash
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-09 00:00:00 -07:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: crack
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.1
+    version: 
+description: Use the bit.ly API to shorten or expand URLs
+email: philnash@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- lib/bitly/client.rb
+- lib/bitly/url.rb
+- lib/bitly/utils.rb
+- lib/bitly/version.rb
+- lib/bitly.rb
+- README.txt
+files: 
+- bitly.gemspec
+- History.txt
+- lib/bitly/client.rb
+- lib/bitly/url.rb
+- lib/bitly/utils.rb
+- lib/bitly/version.rb
+- lib/bitly.rb
+- Manifest
+- Rakefile
+- README.txt
+- test/test_bitly.rb
+- test/bitly/test_client.rb
+- test/bitly/test_url.rb
+- test/bitly/test_utils.rb
+- test/test_helper.rb
+has_rdoc: false
+homepage: http://github.com/philnash/bitly
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Bitly
+- --main
+- README.txt
+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: "1.2"
+  version: 
+requirements: []
+
+rubyforge_project: bitly
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 3
+summary: Use the bit.ly API to shorten or expand URLs
+test_files: 
+- test/bitly/test_client.rb
+- test/bitly/test_url.rb
+- test/bitly/test_utils.rb
+- test/test_bitly.rb
+- test/test_helper.rb