bitly 1.1.1 → 2.0.1

data/lib/bitly/client.rb

@@ -1,145 +0,0 @@
-require 'rubygems'
-require 'net/http'
-require 'uri'
-
-module Bitly
-  extend Config
-  API_URL     = 'https://api-ssl.bitly.com/'
-  API_VERSION = '2.0.1'
-
-  def self.new(login, api_key = nil, timeout=nil)
-    if api_version == 3
-      Bitly::V3::Client.new(login, api_key, timeout)
-    else
-      Bitly::Client.new(login,api_key)
-    end
-  end
-
-  def self.use_api_version_3
-    self.api_version = 3
-  end
-
-  def self.use_api_version_2
-    self.api_version = 2
-  end
-
-  # get and initialize a client if configured using Config
-  def self.client
-    # api_verison, login, and api_key are set in Config
-    if api_version == 3
-      Bitly::V3::Client.new(login, api_key, timeout)
-    else
-      Bitly::Client.new(login, api_key)
-    end
-  end
-
-  class Client
-
-    include Bitly::Utils
-    attr_accessor *Config::OPTION_KEYS
-
-    def initialize(login,api_key)
-      warn "[DEPRECATION] The bit.ly version 2 API has been superseded 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/config.rb

@@ -1,29 +0,0 @@
-module Bitly
-  module Config
-
-    # bitly client options
-    OPTION_KEYS = [
-      :login,
-      :api_key,
-      :api_version,
-      :timeout
-    ]
-
-    attr_accessor *OPTION_KEYS
-
-    alias_method :access_token, :login
-    alias_method :access_token=, :login=
-
-    def configure
-      yield self
-      self
-    end
-
-    def options
-      options = {}
-      OPTION_KEYS.each{|key| options[key] = send(key)}
-      options
-    end
-
-  end
-end

data/lib/bitly/url.rb

@@ -1,103 +0,0 @@
-module Bitly
-
-  class Url
-    include Bitly::Utils
-
-    attr_accessor :long_url, :short_url, :hash, :user_hash
-    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.fetch(:info, nil)
-        @stats = obj.fetch(:stats, nil)
-      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 defined? @short_url
-      if defined? @long_url
-        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 defined? @long_url
-      unless !(short_url || hash)
-        unless defined? @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 defined? @hash
-          request = create_url "info", :hash => @hash
-          result = get_result(request)[@hash]
-          instance_variablise(result, VARIABLES)
-          @info = result
-        elsif defined? @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 defined? @hash
-          request = create_url "stats", :hash => @hash
-        elsif defined? @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

data/lib/bitly/utils.rb

@@ -1,57 +0,0 @@
-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)
-    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)
-        result = MultiJson.load(json)
-      rescue MultiJson::DecodeError
-        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

@@ -1,14 +0,0 @@
-require 'httparty'
-require 'cgi'
-require 'oauth2'
-
-require 'bitly/v3/bitly'
-require 'bitly/v3/client'
-require 'bitly/v3/url'
-require 'bitly/v3/referrer'
-require 'bitly/v3/day'
-require 'bitly/v3/country'
-require 'bitly/v3/missing_url'
-require 'bitly/v3/realtime_link'
-require 'bitly/v3/oauth'
-require 'bitly/v3/user'

data/lib/bitly/v3/bitly.rb

@@ -1,7 +0,0 @@
-module Bitly
-  module V3
-    def self.new(login, api_key)
-      Bitly::V3::Client.new(login, api_key)
-    end
-  end
-end

data/lib/bitly/v3/client.rb

@@ -1,207 +0,0 @@
-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 'https://api-ssl.bitly.com/v3/'
-
-      # Requires a generic OAuth2 access token or -deprecated- login and api key.
-      # http://dev.bitly.com/authentication.html#apikey
-      # Generic OAuth2 access token: https://bitly.com/a/oauth_apps
-      # ApiKey: Get yours from your account page at https://bitly.com/a/your_api_key
-      # Visit your account at http://bit.ly/a/account
-      def initialize(*args)
-        args.compact!
-        self.timeout = args.last.is_a?(0.class) ? args.pop : nil
-        if args.count == 1
-          # Set generic OAuth2 access token
-          @default_query_opts = { :access_token => args.first }
-        else
-          # Deprecated ApiKey authentication
-          @default_query_opts = {
-            :login => args[0],
-            :apiKey => args[1]
-          }
-        end
-      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
-
-      # 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 = arrayize(input)
-        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
-
-      # Expands either a short link or hash and gets the referrer data for that link
-      #
-      # This method does not take an array as an input
-      def referrers(input)
-        get_single_method('referrers', input)
-      end
-
-      # Expands either a short link or hash and gets the country data for that link
-      #
-      # This method does not take an array as an input
-      def countries(input)
-        get_single_method('countries', input)
-      end
-
-      # Takes a short url, hash or array of either and gets the clicks by minute of each of the last hour
-      def clicks_by_minute(input)
-        get_method(:clicks_by_minute, input)
-      end
-
-      # Takes a short url, hash or array of either and gets the clicks by day
-      def clicks_by_day(input, opts={})
-        opts.reject! { |k, v| k.to_s != 'days' }
-        get_method(:clicks_by_day, input, opts)
-      end
-
-      def timeout=(timeout=nil)
-        self.class.default_timeout(timeout) if timeout
-      end
-
-      private
-
-      def arrayize(arg)
-        if arg.is_a?(String)
-          [arg]
-        else
-          arg.dup
-        end
-      end
-
-      def get(method, opts={})
-        opts[:query] ||= {}
-        opts[:query].merge!(@default_query_opts)
-
-        begin
-          response = self.class.get(method, opts)
-        rescue Timeout::Error
-          raise BitlyTimeout.new("Bitly didn't respond in time", "504")
-        end
-
-        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_single_method(method, input)
-        raise ArgumentError.new("This method only takes a hash or url input") unless input.is_a? String
-        if is_a_short_url?(input)
-          query = "shortUrl=#{CGI.escape(input)}"
-        else
-          query = "hash=#{CGI.escape(input)}"
-        end
-        query = "/#{method}?" + query
-        response = get(query)
-        return Bitly::V3::Url.new(self,response['data'])
-      end
-
-      def get_method(method, input, opts={})
-        input = arrayize(input)
-        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 = opts.inject(query) do |query, (k,v)|
-          query << "#{k}=#{v}"
-        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
-
-class BitlyTimeout < BitlyError; end