bitly 0.6.2 → 0.7.0

data/History.txt

@@ -1,7 +1,17 @@
+=== 0.7.0 / 2011-1-8
+
+* 1 major bug fix
+
+  * Updates OAuth2 gem and fixes OAuth class
+
+* 1 minor enhancement
+
+  Adds link_history to user model
+
 === 0.6.2 / 2011-11-10
 
 * 2 minor enhancements
-  
+
   * Adds days parameter to clicks_by_minute v3 API call
   * Converts Readme to markdown
 
@@ -51,7 +61,7 @@
 * 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
@@ -86,7 +96,7 @@
 * 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
@@ -96,7 +106,7 @@
 * 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

data/README.md

@@ -2,7 +2,7 @@
 
 ## DESCRIPTION:
 
-A Ruby API for [http://bit.ly](http://bit.ly) (and now (http://j.mp)[http://j.mp])
+A Ruby API for [http://bit.ly](http://bit.ly)
 
 [http://code.google.com/p/bitly-api/wiki/ApiDocumentation](http://code.google.com/p/bitly-api/wiki/ApiDocumentation)
 
@@ -45,7 +45,7 @@ Each can be used in all the methods described in the API docs, the shorten funct
 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"
@@ -54,7 +54,7 @@ All four functions return a ``Bitly::Url`` object (or an array of ``Bitly::Url``
     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')
 
 ### Version 3 API
@@ -74,10 +74,10 @@ Please see the Bit.ly API documentation [http://api.bit.ly](http://api.bit.ly) f
 > 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.

data/Rakefile

@@ -8,6 +8,6 @@ Echoe.new('bitly', Bitly::VERSION) do |p|
   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.7.6'], ['oauth2', '>= 0.1.1']]
+  p.extra_deps      = [['crack', '>= 0.1.4'], ['httparty', '>= 0.7.6'], ['oauth2', '~> 0.5.0']]
   p.development_dependencies = []
 end

data/bitly.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bitly}
-  s.version = "0.6.2"
+  s.version = "0.7.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Phil Nash"]
-  s.date = %q{2011-11-10}
+  s.date = %q{2012-01-08}
   s.description = %q{Use the bit.ly API to shorten or expand URLs}
   s.email = %q{philnash@gmail.com}
   s.extra_rdoc_files = ["README.md", "lib/bitly.rb", "lib/bitly/client.rb", "lib/bitly/url.rb", "lib/bitly/utils.rb", "lib/bitly/v3.rb", "lib/bitly/v3/bitly.rb", "lib/bitly/v3/client.rb", "lib/bitly/v3/country.rb", "lib/bitly/v3/day.rb", "lib/bitly/v3/missing_url.rb", "lib/bitly/v3/oauth.rb", "lib/bitly/v3/realtime_link.rb", "lib/bitly/v3/referrer.rb", "lib/bitly/v3/url.rb", "lib/bitly/v3/user.rb", "lib/bitly/version.rb"]
@@ -26,15 +26,15 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<crack>, [">= 0.1.4"])
       s.add_runtime_dependency(%q<httparty>, [">= 0.7.6"])
-      s.add_runtime_dependency(%q<oauth2>, [">= 0.1.1"])
+      s.add_runtime_dependency(%q<oauth2>, ["~> 0.5.0"])
     else
       s.add_dependency(%q<crack>, [">= 0.1.4"])
       s.add_dependency(%q<httparty>, [">= 0.7.6"])
-      s.add_dependency(%q<oauth2>, [">= 0.1.1"])
+      s.add_dependency(%q<oauth2>, ["~> 0.5.0"])
     end
   else
     s.add_dependency(%q<crack>, [">= 0.1.4"])
     s.add_dependency(%q<httparty>, [">= 0.7.6"])
-    s.add_dependency(%q<oauth2>, [">= 0.1.1"])
+    s.add_dependency(%q<oauth2>, ["~> 0.5.0"])
   end
 end

data/lib/bitly/v3/client.rb

@@ -11,21 +11,21 @@ module Bitly
       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:
@@ -39,26 +39,26 @@ module Bitly
         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)      
+        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
@@ -83,7 +83,7 @@ module Bitly
         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
@@ -108,17 +108,17 @@ module Bitly
         opts.reject! { |k, v| k.to_s != 'days' }
         get_method(:clicks_by_day, input, opts)
       end
-        
+
       private
 
       def arrayize(arg)
         if arg.is_a?(String)
-          [arg] 
+          [arg]
         else
           arg.dup
         end
       end
-    
+
       def get(method, opts={})
         opts[:query] ||= {}
         opts[:query].merge!(@default_query_opts)
@@ -129,11 +129,11 @@ module Bitly
           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)
@@ -145,7 +145,7 @@ module Bitly
         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|

data/lib/bitly/v3/oauth.rb

@@ -1,33 +1,38 @@
 module Bitly
-  module V3  
+  module V3
     # OAuth consumer for authentication
     class OAuth
       attr_reader :access_token
       def initialize(consumer_token, consumer_secret)
         @consumer_token, @consumer_secret = consumer_token, consumer_secret
       end
-    
+
       # Get the OAuth 2 client
       def client
-        @client ||= ::OAuth2::Client.new(@consumer_token, @consumer_secret, :site => 'https://api-ssl.bit.ly')
+        @client ||= ::OAuth2::Client.new(
+          @consumer_token,
+          @consumer_secret,
+          :site => 'https://api-ssl.bit.ly',
+          :token_url => '/oauth/access_token'
+        )
       end
-    
+
       # Get the url to redirect a user to, pass the url you want the user
       # to be redirected back to.
       def authorize_url(redirect_url)
-        client.web_server.authorize_url(:redirect_uri => redirect_url).gsub(/api-ssl\./,'')
+        client.auth_code.authorize_url(:redirect_uri => redirect_url).gsub(/api-ssl\./,'')
       end
-    
+
       # Get the access token. You must pass the exact same redirect_url passed
       # to the authorize_url method
       def get_access_token_from_code(code,redirect_url)
-        @access_token ||= client.web_server.get_access_token(code, :redirect_uri => redirect_url)
+        @access_token ||= client.auth_code.get_token(code, :redirect_uri => redirect_url, :parse => :query)
       end
-    
+
       # If you already have a user token, this method gets the access token
       def get_access_token_from_token(token, params={})
         params = params.inject({}) { |options, (key, value)| options[key.to_s] = value; options }
-        @access_token ||= ::OAuth2::AccessToken.new(client, token, nil, nil, params)
+        @access_token ||= ::OAuth2::AccessToken.new(client, token, params)
       end
     end
   end

data/lib/bitly/v3/url.rb

@@ -3,8 +3,8 @@ module Bitly
     # 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
-    
+      attr_reader :short_url, :long_url, :user_hash, :global_hash, :aggregate_link
+
       # Initialize with a bitly client and optional hash to fill in the details for the url.
       def initialize(client, opts={})
         @client = client
@@ -18,6 +18,8 @@ module Bitly
           @global_clicks = opts['global_clicks']
           @title = opts['title']
           @created_by = opts['created_by']
+          @created_at = Time.at opts['created_at'] if opts['created_at']
+          @aggregate_link = opts['aggregate_link']
           @referrers = opts['referrers'].inject([]) do |results, referrer|
             results << Bitly::V3::Referrer.new(referrer)
           end if opts['referrers']
@@ -34,12 +36,12 @@ module Bitly
         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
@@ -47,7 +49,7 @@ module Bitly
         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
@@ -55,7 +57,7 @@ module Bitly
         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
@@ -63,7 +65,7 @@ module Bitly
         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
@@ -71,7 +73,7 @@ module Bitly
         update_info if @created_by.nil? || opts[:force]
         @created_by
       end
-    
+
       # If the url already has referrer data, return it.
       # IF there is no referrer or <tt>:force => true</tt> is passed,
       # updates the referrers and returns them
@@ -88,6 +90,14 @@ module Bitly
         @countries
       end
 
+      # If the url already has created at data, return it.
+      # If there is no created at data or <tt>:force => true</tt> is passed,
+      # updates the info and returns it
+      def created_at(opts={})
+        update_info if @created_at.nil? || opts[:force]
+        @created_at
+      end
+
       def clicks_by_minute(opts={})
         if @clicks_by_minute.nil? || opts[:force]
           full_url = @client.clicks_by_minute(@user_hash || @short_url)
@@ -103,21 +113,22 @@ module Bitly
         end
         @clicks_by_day
       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
+        @created_at = full_url.created_at
       end
-      
+
       def update_referrers
         full_url = @client.referrers(@user_hash || @short_url)
         @referrers = full_url.referrers

data/lib/bitly/v3/user.rb

@@ -16,16 +16,18 @@ module Bitly
     #
     #    u=Bitly::V3::User.new(o.access_token)
     class User
+      include HTTParty
+      base_uri 'https://api-ssl.bit.ly/v3/'
       attr_accessor :login, :api_key
-      
+
       def initialize(access_token)
         @access_token = access_token
         @login = access_token['login'] || access_token['username']
         @api_key = access_token['apiKey'] || access_token['api_key']
       end
-    
+
       # OAuth 2 endpoint that provides a list of top referrers (up to 500 per
-      # day) for a given user’s bit.ly links, and the number of clicks per referrer. 
+      # day) for a given user’s bit.ly links, and the number of clicks per referrer.
       #
       # http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/v3/user/referrers
       def referrers(opts={})
@@ -34,9 +36,9 @@ module Bitly
         end
         @referrers
       end
-    
+
       # OAuth 2 endpoint that provides a list of countries from which clicks
-      # on a given user’s bit.ly links are originating, and the number of clicks per country. 
+      # on a given user’s bit.ly links are originating, and the number of clicks per country.
       #
       # http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/v3/user/countries
       def countries(opts={})
@@ -45,23 +47,24 @@ module Bitly
         end
         @countries
       end
-    
+
       # OAuth 2 endpoint that provides a given user’s 100 most popular links
-      # based on click traffic in the past hour, and the number of clicks per link. 
+      # based on click traffic in the past hour, and the number of clicks per link.
       #
       # http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/v3/user/realtime_links
       def realtime_links(opts={})
         if @realtime_links.nil? || opts.delete(:force)
-          result = Crack::JSON.parse(@access_token.get("/v3/user/realtime_links", opts))
+          opts.merge!(:access_token => @access_token.token)
+          result = self.class.get("/user/realtime_links", :query => opts)
           if result['status_code'] == 200
             @realtime_links = result['data']['realtime_links'].map { |rs| Bitly::V3::RealtimeLink.new(rs) }
           else
-            raise BitlyError.new(results['status_txt'], results['status_code'])
+            raise BitlyError.new(result['status_txt'], result['status_code'])
           end
         end
         @realtime_links
       end
-    
+
       # OAuth 2 endpoint that provides the total clicks per day on a user’s bit.ly links.
       #
       # http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/v3/user/clicks
@@ -69,22 +72,41 @@ module Bitly
         get_clicks(opts)
         @clicks
       end
-    
+
       # Displays the total clicks returned from the clicks method.
       def total_clicks(opts={})
         get_clicks(opts)
         @total_clicks
       end
-      
+
       # Returns a Bitly Client using the credentials of the user.
       def client
         @client ||= Bitly::V3::Client.new(login, api_key)
       end
-    
+
+      # OAuth 2 endpoint that OAuth 2 endpoint that provides a given user’s link
+      # shortening history, in reverse chronological order (most recent to least
+      # recent).
+      def link_history(opts={})
+        opts.merge!(:access_token => @access_token.token)
+        result = self.class.get("/user/link_history", :query => opts)
+        if result['status_code'] == 200
+          results = result['data']['link_history'].inject([]) do |rs, obj|
+            obj['short_url'] = obj['link']
+            obj['hash'] = obj['link'].split('/').last
+            rs << Url.new(client, obj)
+          end
+          return results
+        else
+          raise BitlyError.new(result['status_txt'], result['status_code'])
+        end
+      end
+
       private
-    
+
       def get_method(method, klass, opts)
-        result = Crack::JSON.parse(@access_token.get("/v3/user/#{method.to_s}", opts))
+        opts.merge!(:access_token => @access_token.token)
+        result = self.class.get("/user/#{method.to_s}", :query => opts)
         if result['status_code'] == 200
           results = result['data'][method.to_s].map do |rs|
             rs.inject([]) do |results, obj|
@@ -93,18 +115,19 @@ module Bitly
           end
           return results
         else
-          raise BitlyError.new(results['status_txt'], results['status_code'])
+          raise BitlyError.new(result['status_txt'], result['status_code'])
         end
       end
-    
+
       def get_clicks(opts={})
         if @clicks.nil? || opts.delete(:force)
-          result = Crack::JSON.parse(@access_token.get("/v3/user/clicks", opts))
+          opts.merge!(:access_token => @access_token.token)
+          result = self.class.get("/user/clicks", :query => opts)
           if result['status_code'] == 200
             @clicks = result['data']['clicks'].map { |rs| Bitly::V3::Day.new(rs) }
             @total_clicks = result['data']['total_clicks']
           else
-            raise BitlyError.new(results['status_txt'], results['status_code'])
+            raise BitlyError.new(result['status_txt'], result['status_code'])
           end
         end
       end

data/lib/bitly/version.rb

@@ -1,3 +1,3 @@
 module Bitly
-  VERSION = '0.6.2'
+  VERSION = '0.7.0'
 end

metadata

@@ -5,9 +5,9 @@ version: !ruby/object:Gem::Version
   prerelease: false
   segments: 
   - 0
-  - 6
-  - 2
-  version: 0.6.2
+  - 7
+  - 0
+  version: 0.7.0
 platform: ruby
 authors: 
 - Phil Nash
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-11-10 00:00:00 +00:00
+date: 2012-01-08 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -56,14 +56,14 @@ dependencies:
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
-    - - ">="
+    - - ~>
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 11
         segments: 
         - 0
-        - 1
-        - 1
-        version: 0.1.1
+        - 5
+        - 0
+        version: 0.5.0
   type: :runtime
   version_requirements: *id003
 description: Use the bit.ly API to shorten or expand URLs