cotweet-bitly 0.5.2

data/History.txt

@@ -0,0 +1,91 @@
+=== 0.5.3 / 2010-07-30
+
+* 1 minor enhancement
+
+  * Added the info call to the version 3 API
+
+=== 0.5.2 / 2010-07-18
+
+* 1 minor enhancement
+
+  * Added the lookup call to the version 3 API.
+
+=== 0.5.1 / 2010-05-26
+
+* 1 bug fix
+
+  * When expanding a short url with the v3 module, user hash and short url weren't being set properly
+  
+=== 0.5.0 / 2010-05-12
+
+* Loads of major enhancements
+
+  * Support for version 3 of the bit.ly API
+  * deprecation for version 2 client object
+
+=== 0.4.0 / 2009-12-19
+
+* 1 major enhancement
+
+  * support for j.mp urls
+
+=== 0.3.2 / 2009-11-15
+
+* 1 bug fix
+
+  * called the wrong variable in case of error in the creation of a Url object
+
+=== 0.3.1 / 2009-07-29
+
+* 1 minor enhancement
+
+  * removed require 'rubygems' from library (http://gist.github.com/54177)
+
+=== 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,27 @@
+bitly.gemspec
+History.txt
+lib/bitly/client.rb
+lib/bitly/url.rb
+lib/bitly/utils.rb
+lib/bitly/v3/bitly.rb
+lib/bitly/v3/client.rb
+lib/bitly/v3/missing_url.rb
+lib/bitly/v3/url.rb
+lib/bitly/v3.rb
+lib/bitly/version.rb
+lib/bitly.rb
+Manifest
+Rakefile
+README.txt
+test/bitly/test_client.rb
+test/bitly/test_url.rb
+test/bitly/test_utils.rb
+test/fixtures/cnn.json
+test/fixtures/cnn_and_google.json
+test/fixtures/expand_cnn.json
+test/fixtures/expand_cnn_and_google.json
+test/fixtures/google_and_cnn_info.json
+test/fixtures/google_info.json
+test/fixtures/google_stats.json
+test/fixtures/shorten_error.json
+test/test_helper.rb

data/README.txt

@@ -0,0 +1,81 @@
+= bitly
+
+== DESCRIPTION:
+
+A Ruby API for http://bit.ly (and now http://j.mp)
+
+http://code.google.com/p/bitly-api/wiki/ApiDocumentation
+
+== NOTE:
+
+Bitly recently released their version 3 API. From this 0.5.0 release, the gem will continue to work the same but also provide a V3 module, using the version 3 API. The standard module will become deprecated, as Bitly do not plan to keep the version 2 API around forever.
+
+To move to using the version 3 API, call:
+
+Bitly.use_api_version_3
+
+Then, when you call Bitly.new(username, api_key) you will get a Bitly::V3::Client instead, which provides the version 3 api calls (shorten, expand, clicks, validate and bitly_pro_domain). See http://api.bit.ly for details.
+
+Eventually, this will become the default version used and finally, the V3 module will disappear, with the version 3 classes replacing the version 2 classes.
+
+(Please excuse the lack of tests for the v3 classes, they are fully tested and ready to replace this whole codebase in the v3 branch of the github repo, until I realised it would break everything.)
+
+== 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.bitly_url #=> "http://bit.ly/Ywd1"
+u.jmp_url #=> "http://j.mp/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,13 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+require './lib/bitly.rb'
+
+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.4'], ['httparty', '>= 0.5.2']]
+  p.development_dependencies = []
+end

data/bitly.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{cotweet-bitly}
+  s.version = "0.5.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Phil Nash"]
+  s.date = %q{2010-07-18}
+  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/v3/bitly.rb", "lib/bitly/v3/client.rb", "lib/bitly/v3/missing_url.rb", "lib/bitly/v3/url.rb", "lib/bitly/v3.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/v3/bitly.rb", "lib/bitly/v3/client.rb", "lib/bitly/v3/missing_url.rb", "lib/bitly/v3/url.rb", "lib/bitly/v3.rb", "lib/bitly/version.rb", "lib/bitly.rb", "Manifest", "Rakefile", "README.txt", "test/bitly/test_client.rb", "test/bitly/test_url.rb", "test/bitly/test_utils.rb", "test/fixtures/cnn.json", "test/fixtures/cnn_and_google.json", "test/fixtures/expand_cnn.json", "test/fixtures/expand_cnn_and_google.json", "test/fixtures/google_and_cnn_info.json", "test/fixtures/google_info.json", "test/fixtures/google_stats.json", "test/fixtures/shorten_error.json", "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.6}
+  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_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.4"])
+      s.add_runtime_dependency(%q<httparty>, [">= 0.5.2"])
+    else
+      s.add_dependency(%q<crack>, [">= 0.1.4"])
+      s.add_dependency(%q<httparty>, [">= 0.5.2"])
+    end
+  else
+    s.add_dependency(%q<crack>, [">= 0.1.4"])
+    s.add_dependency(%q<httparty>, [">= 0.5.2"])
+  end
+end

data/lib/bitly.rb

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

data/lib/bitly/client.rb

@@ -0,0 +1,133 @@
+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)
+    if @version == 3
+      Bitly::V3::Client.new(login, api_key)
+    else
+      Bitly::Client.new(login,api_key)
+    end
+  end
+  
+  def self.use_api_version_3
+    @version = 3
+  end
+  
+  def self.use_api_version_2
+    @version = 2
+  end
+
+  class Client
+    
+    include Bitly::Utils
+    
+    def initialize(login,api_key)
+      warn "[DEPRECATION] The bit.ly version 2 API has been superceded by version 3 and will be removed. See the README for details"
+      @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/') || input.include?('j.mp/')
+          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

data/lib/bitly/url.rb

@@ -0,0 +1,104 @@
+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(obj['errorMessage'],obj['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
+    
+    def bitly_url
+      @short_url.nil? ? nil : @short_url.gsub(/j\.mp/,'bit.ly')
+    end
+    
+    def jmp_url
+      @short_url.nil? ? nil : @short_url.gsub(/bit\.ly/,'j.mp')
+    end
+  end
+
+end