cotweet-bitly 0.5.2

data/lib/bitly/utils.rb

@@ -0,0 +1,60 @@
+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|j\.mp)\//,'')
+    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
+        json = Net::HTTP.get(request)
+        # puts json.inspect
+        result = Crack::JSON.parse(json)
+      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/v3.rb

@@ -0,0 +1,9 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'httparty'
+require 'cgi'
+
+require 'v3/bitly'
+require 'v3/client'
+require 'v3/url'
+require 'v3/missing_url'

data/lib/bitly/v3/bitly.rb

@@ -0,0 +1,16 @@
+module Bitly
+  module V3
+    def self.new(login, api_key)
+      Bitly::V3::Client.new(login, api_key)
+    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/v3/client.rb

@@ -0,0 +1,143 @@
+module Bitly
+  module V3
+    # The client is the main part of this gem. You need to initialize the client with your
+    # username and API key and then you will be able to use the client to perform
+    # all the rest of the actions available through the API.
+    class Client
+      include HTTParty
+      base_uri 'http://api.bit.ly/v3/'
+
+      # Requires a login and api key. Get yours from your account page at http://bit.ly/a/account
+      def initialize(login, api_key)
+        @default_query_opts = { :login => login, :apiKey => api_key }
+      end
+    
+      # Validates a login and api key
+      def validate(x_login, x_api_key)
+        response = get('/validate', :query => { :x_login => x_login, :x_apiKey => x_api_key })
+        return response['data']['valid'] == 1
+      end
+      alias :valid? :validate
+    
+      # Checks whether a domain is a bitly.Pro domain
+      def bitly_pro_domain(domain)
+        response = get('/bitly_pro_domain', :query => { :domain => domain })
+        return response['data']['bitly_pro_domain']
+      end
+      alias :pro? :bitly_pro_domain
+    
+      # Shortens a long url
+      #
+      # Options can be:
+      #
+      # [domain]                choose bit.ly or j.mp (bit.ly is default)
+      #
+      # [x_login and x_apiKey]  add this link to another user's history (both required)
+      #
+      def shorten(long_url, opts={})
+        query = { :longUrl => long_url }.merge(opts)
+        response = get('/shorten', :query => query)
+        return Bitly::V3::Url.new(self, response['data'])
+      end
+    
+      # Expands either a hash, short url or array of either.
+      #
+      # Returns the results in the order they were entered
+      def expand(input)
+        get_method(:expand, input)
+      end
+    
+      # Expands either a hash, short url or array of either and gets click data too.
+      #
+      # Returns the results in the order they were entered
+      def clicks(input)
+        get_method(:clicks, input)
+      end
+      
+      # Like expand, but gets the title of the page and who created it
+      def info(input)
+        get_method(:info, input)      
+      end
+      
+      # Provides a list of referring sites for a specified bit.ly short link, and the number of clicks per referrer.
+      def referrers(input)
+        if is_a_short_url?(input)
+          query = { :shortUrl => CGI.escape(input) }
+        else
+          query = { :hash => CGI.escape(input) }
+        end
+        get("/referrers", :query => query)["data"]
+      end
+      
+      # Looks up the short url and global hash of a url or array of urls
+      #
+      # Returns the results in the order they were entered
+      def lookup(input)
+        input = [input] if input.is_a?(String)
+        query = input.inject([]) { |query, i| query << "url=#{CGI.escape(i)}" }
+        query = "/lookup?" + query.join('&')
+        response = get(query)
+        results = response['data']['lookup'].inject([]) do |results, url|
+          url['long_url'] = url['url']
+          url['url'] = nil
+          if url['error'].nil?
+            # builds the results array in the same order as the input
+            results[input.index(url['long_url'])] = Bitly::V3::Url.new(self, url)
+            # remove the key from the original array, in case the same hash/url was entered twice
+            input[input.index(url['long_url'])] = nil
+          else
+            results[input.index(url['long_url'])] = Bitly::V3::MissingUrl.new(url)
+            input[input.index(url['long_url'])] = nil
+          end
+          results
+        end
+        return results.length > 1 ? results : results[0]
+      end
+        
+      private
+    
+      def get(method, opts={})
+        opts[:query] ||= {}
+        opts[:query].merge!(@default_query_opts)
+        response = self.class.get(method, opts)
+        if response['status_code'] == 200
+          return response
+        else
+          raise BitlyError.new(response['status_txt'], response['status_code'])
+        end
+      end
+    
+      def is_a_short_url?(input)
+        input.match(/^http:\/\//)
+      end
+    
+      def get_method(method, input)
+        input = [input] if input.is_a? String
+        query = input.inject([]) do |query,i|
+          if is_a_short_url?(i)
+            query << "shortUrl=#{CGI.escape(i)}"
+          else
+            query << "hash=#{CGI.escape(i)}"
+          end
+        end
+        query = "/#{method}?" + query.join('&')
+        response = get(query)
+        results = response['data'][method.to_s].inject([]) do |results, url|
+          result_index = input.index(url['short_url'] || url['hash']) || input.index(url['global_hash'])
+          if url['error'].nil?
+            # builds the results array in the same order as the input
+            results[result_index] = Bitly::V3::Url.new(self, url)
+            # remove the key from the original array, in case the same hash/url was entered twice
+            input[result_index] = nil
+          else
+            results[result_index] = Bitly::V3::MissingUrl.new(url)
+            input[result_index] = nil
+          end
+          results
+        end
+        return results.length > 1 ? results : results[0]
+      end
+    
+    end
+  end
+end

data/lib/bitly/v3/missing_url.rb

@@ -0,0 +1,15 @@
+module Bitly
+  module V3
+    class MissingUrl
+      attr_accessor :short_url, :user_hash, :long_url, :error
+      def initialize(opts={})
+        if opts
+          @short_url = opts['short_url']
+          @user_hash = opts['hash']
+          @long_url = opts['long_url']
+          @error = opts['error']
+        end
+      end
+    end
+  end
+end

data/lib/bitly/v3/url.rb

@@ -0,0 +1,77 @@
+module Bitly
+  module V3
+    # Url objects should only be created by the client object as it collects the correct information
+    # from the API.
+    class Url
+      attr_reader :short_url, :long_url, :user_hash, :global_hash
+    
+      # Initialize with a bitly client and optional hash to fill in the details for the url.
+      def initialize(client, opts={})
+        @client = client
+        if opts
+          @short_url = opts['url'] || opts['short_url']
+          @long_url = opts['long_url']
+          @user_hash = opts['hash'] || opts['user_hash']
+          @global_hash = opts['global_hash']
+          @new_hash = (opts['new_hash'] == 1)
+          @user_clicks = opts['user_clicks']
+          @global_clicks = opts['global_clicks']
+          @title = opts['title']
+          @created_by = opts['created_by']
+        end
+        @short_url = "http://bit.ly/#{@user_hash}" unless @short_url
+      end
+    
+      # Returns true if the user hash was created first for this call
+      def new_hash?
+        @new_hash
+      end
+    
+      # If the url already has click statistics, returns the user clicks.
+      # IF there are no click statistics or <tt>:force => true</tt> is passed,
+      # updates the stats and returns the user clicks
+      def user_clicks(opts={})
+        update_clicks_data if @global_clicks.nil? || opts[:force]
+        @user_clicks
+      end
+    
+      # If the url already has click statistics, returns the global clicks.
+      # IF there are no click statistics or <tt>:force => true</tt> is passed,
+      # updates the stats and returns the global clicks
+      def global_clicks(opts={})
+        update_clicks_data if @global_clicks.nil? || opts[:force]
+        @global_clicks
+      end
+      
+      # If the url already has the title, return it.
+      # IF there is no title or <tt>:force => true</tt> is passed,
+      # updates the info and returns the title
+      def title(opts={})
+        update_info if @title.nil? || opts[:force]
+        @title
+      end
+      
+      # If the url already has the creator, return it.
+      # IF there is no creator or <tt>:force => true</tt> is passed,
+      # updates the info and returns the creator
+      def created_by(opts={})
+        update_info if @created_by.nil? || opts[:force]
+        @created_by
+      end
+    
+      private
+    
+      def update_clicks_data
+        full_url = @client.clicks(@user_hash || @short_url)
+        @global_clicks = full_url.global_clicks
+        @user_clicks = full_url.user_clicks
+      end
+      
+      def update_info
+        full_url = @client.info(@user_hash || @short_url)
+        @created_by = full_url.created_by
+        @title = full_url.title
+      end
+    end
+  end
+end

data/lib/bitly/version.rb

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

data/test/bitly/test_client.rb

@@ -0,0 +1,215 @@
+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
+          assert_equal "http://bit.ly/15DlK", @url.bitly_url
+        end
+        should "return a short jmp url" do
+          assert_equal "http://j.mp/15DlK", @url.jmp_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 bitly 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 bitly url" do
+          assert_equal "http://bit.ly/31IqMl", @url.bitly_url
+        end
+        should "save a jmp url" do
+          assert_equal "http://j.mp/31IqMl", @url.jmp_url
+        end
+      end
+      context "a short jmp url" do
+        setup do
+          stub_get(/^http:\/\/api.bit.ly\/expand\?.*hash=31IqMl.*$/,"expand_cnn.json")
+          @url = @bitly.expand("http://j.mp/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 bitly url" do
+          assert_equal "http://bit.ly/31IqMl", @url.bitly_url
+        end
+        should "save a jmp url" do
+          assert_equal "http://j.mp/31IqMl", @url.jmp_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