bitly 0.2

data/History.txt

@@ -0,0 +1,34 @@
+=== 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,63 @@
+= bitly
+
+== DESCRIPTION:
+
+A Ruby API for bit.ly
+
+http://code.google.com/p/bitly-api/wiki/ApiDocumentation
+
+== 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', 'keyword') # returns a shortened url using the given keyword
+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
+
+You should be able to specify a keyword when shortening (though at last test, this didn't seem to be working http://code.google.com/p/bitly-api/issues/detail?id=5). To do so, just add a keyword parameter:
+
+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.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Phil Nash"]
+  s.date = %q{2009-06-23}
+  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"]
+  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/test_bitly.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,148 @@
+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, keyword=nil)
+      if input.is_a? String
+        request = create_url "shorten", :longUrl => input, :keyword => keyword
+        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"
+        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
+      end
+    end
+    
+    def expand(input)
+      if input.is_a? String
+        if input.include? "bit.ly/"
+          hash = input.gsub(/^.*bit.ly\//,'')
+          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
+      end
+    end
+    
+    def info(input)
+      if input.is_a? String
+        if input.include? "bit.ly/"
+          hash = input.gsub(/^.*bit.ly\//,'')
+          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
+      end
+    end
+    
+    def stats(input)
+      if input.is_a? String
+        if input.include? "bit.ly/"
+          hash = input.gsub(/^.*bit.ly\//,'')
+          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
+      end
+    end
+    
+  end
+  
+end
+
+class BitlyError < StandardError
+  attr_reader :code
+  alias :msg :message
+  def initialize(msg, code, req)
+    @code = code
+    super("'#{req}' - #{msg}")
+  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,57 @@
+module Bitly
+  
+  class Url
+    include Bitly::Utils
+    
+    VARIABLES = ['long_url', 'short_url', 'hash', 'user_hash', 'short_keyword_url']
+    
+    def initialize(login,api_key,obj=nil)
+      unless obj.nil?
+        
+        raise BitlyError.new(obj['errorMessage'],obj['errorCode'],'expand') 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
+    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 = @short_url.gsub(/^.*bit.ly\//,'')
+          request = create_url "info", :hash => hash
+          result = get_result(request)[hash]
+          instance_variablise(result, VARIABLES)
+          @info = result
+        else
+          nil
+        end
+      else
+        @info
+      end
+    end
+    
+    def stats
+      if @stats.nil?
+        if @hash
+          request = create_url "stats", :hash => @hash
+        elsif @short_url
+          request = create_url "stats", :shortUrl => @short_url
+        end
+        @stats = get_result(request)
+      else
+        @stats
+      end
+    end
+    
+  end
+
+end

data/lib/bitly/utils.rb

@@ -0,0 +1,55 @@
+require 'cgi'
+
+module Bitly
+  module Utils
+    private
+    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 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 = {'statusCode' => 'JSON Parse Error(Bit.ly messed up)', 'errorCode' => 69}
+      end
+      if result['statusCode'] == "OK"
+        result = result['results']
+      else
+        raise BitlyError.new(result['errorMessage'],result['errorCode'],'expand')
+      end
+    end
+    
+  end
+end

data/lib/bitly/version.rb

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

data/test/test_bitly.rb

@@ -0,0 +1,65 @@
+require 'test/unit'
+require 'rubygems'
+require 'bitly'
+
+class TestBitly < Test::Unit::TestCase
+  
+  def setup
+    @api_key = 'R_7776acc394294b2b0ad2c261a91c483d'
+    @login = 'philnash'
+    @bitly = Bitly.new(@login,@api_key)
+  end
+  
+  # not a good test, but it makes sure things are working for now.
+  def test_returns_short_url
+    url = @bitly.shorten("http://google.com")
+    assert_kind_of Bitly::Url, url
+    assert_equal "http://google.com", url.long_url
+    assert_equal "http://bit.ly/wQaT", url.short_url
+    urls = @bitly.shorten(["http://google.com","http://cnn.com"])
+    assert_equal "http://google.com", urls[0].long_url
+    assert_equal "http://bit.ly/wQaT", urls[0].short_url
+		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)
+    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)
+    end
+  end
+
+  
+  
+end

metadata

@@ -0,0 +1,84 @@
+--- !ruby/object:Gem::Specification 
+name: bitly
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Phil Nash
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-06-23 00:00:00 +01: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
+has_rdoc: true
+homepage: http://github.com/philnash/bitly
+licenses: []
+
+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.3.4
+signing_key: 
+specification_version: 3
+summary: Use the bit.ly API to shorten or expand URLs
+test_files: 
+- test/test_bitly.rb