bitly 0.5.5 → 0.6.0

data/History.txt

@@ -1,3 +1,9 @@
+=== 0.6.0 / 2011-01-03
+
+* 1 major enhancement
+
+  * Added OAuth 2 and User calls for the version 3 API
+
 === 0.5.5 / 2010-12-22
 
 * 1 minor bug fix

data/Manifest

@@ -13,8 +13,11 @@ 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
 test/bitly/test_client.rb
 test/bitly/test_url.rb

data/README.txt

@@ -26,6 +26,8 @@ gem install bitly
 
 == USAGE:
 
+=== Version 2 API
+
 Create a Bitly client using your username and api key as follows:
 
 bitly = Bitly.new(username, api_key)
@@ -55,6 +57,10 @@ u.stats #=> a ruby hash of the JSON returned from the API
 
 bitly.shorten('http://www.google.com', 'keyword')
 
+=== Version 3 API
+
+Please see the Bit.ly API documentation http://api.bit.ly for details on the V3 API
+
 == LICENSE:
 
 (The MIT License)

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.5.2']]
+  p.extra_deps      = [['crack', '>= 0.1.4'], ['httparty', '>= 0.5.2'], ['oauth2', '>= 0']]
   p.development_dependencies = []
 end

data/bitly.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bitly}
-  s.version = "0.5.5"
+  s.version = "0.6.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Phil Nash"]
-  s.date = %q{2010-12-22}
+  s.date = %q{2011-01-03}
   s.description = %q{Use the bit.ly API to shorten or expand URLs}
   s.email = %q{philnash@gmail.com}
-  s.extra_rdoc_files = ["README.txt", "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/referrer.rb", "lib/bitly/v3/url.rb", "lib/bitly/version.rb"]
-  s.files = ["History.txt", "Manifest", "README.txt", "Rakefile", "bitly.gemspec", "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/referrer.rb", "lib/bitly/v3/url.rb", "lib/bitly/version.rb", "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.extra_rdoc_files = ["README.txt", "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"]
+  s.files = ["History.txt", "Manifest", "README.txt", "Rakefile", "bitly.gemspec", "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", "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"]
@@ -26,12 +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.5.2"])
+      s.add_runtime_dependency(%q<oauth2>, [">= 0"])
     else
       s.add_dependency(%q<crack>, [">= 0.1.4"])
       s.add_dependency(%q<httparty>, [">= 0.5.2"])
+      s.add_dependency(%q<oauth2>, [">= 0"])
     end
   else
     s.add_dependency(%q<crack>, [">= 0.1.4"])
     s.add_dependency(%q<httparty>, [">= 0.5.2"])
+    s.add_dependency(%q<oauth2>, [">= 0"])
   end
 end

data/lib/bitly/v3.rb

@@ -2,6 +2,7 @@ $:.unshift File.dirname(__FILE__)
 
 require 'httparty'
 require 'cgi'
+require 'oauth2'
 
 require 'v3/bitly'
 require 'v3/client'
@@ -9,4 +10,7 @@ require 'v3/url'
 require 'v3/referrer'
 require 'v3/day'
 require 'v3/country'
-require 'v3/missing_url'
+require 'v3/missing_url'
+require 'v3/realtime_link'
+require 'v3/oauth'
+require 'v3/user'

data/lib/bitly/v3/oauth.rb

@@ -0,0 +1,33 @@
+module Bitly
+  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')
+      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\./,'')
+      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)
+      end
+    
+      # If you already have a user token, this method gets the access token
+      def get_access_token_from_token(token)
+        @access_token ||= ::OAuth2::AccessToken.new(client, token)
+      end
+    end
+  end
+end

data/lib/bitly/v3/realtime_link.rb

@@ -0,0 +1,18 @@
+module Bitly
+  module V3
+    # Day objects are created by the realtime_links method of a user
+    class RealtimeLink
+      attr_reader :clicks, :user_hash
+    
+      def initialize(opts)
+        @clicks = opts['clicks']
+        @user_hash = opts['user_hash']
+      end
+    
+      # A convenience method to create a Bitly::Url from the data
+      def create_url(client)
+        Bitly::V3::Url.new(client, 'user_clicks' => clicks, 'user_hash' => user_hash)
+      end
+    end
+  end
+end

data/lib/bitly/v3/user.rb

@@ -0,0 +1,104 @@
+module Bitly
+  module V3
+    # A user requires an oauth access token. The flow is as follows:
+    #
+    #     o = Bitly::V3::OAuth.new(consumer_token, consumer_secret)
+    #     o.authorize_url(redirect_url)
+    #     #=> "https://bit.ly/oauth/authorize?client_id=#{consumer_token}&type=web_server&redirect_uri=http%3A%2F%2Ftest.local%2Fbitly%2Fauth"
+    # Redirect your users to this url, when they authorize your application
+    # they will be redirected to the url you provided with a code parameter.
+    # Use that parameter, and the exact same redirect url as follows:
+    #
+    #     o.get_access_token_from_code(params[:code], redirect_url)
+    #     #=> #<OAuth2::AccessToken ...>
+    #
+    # Then use that access token to create your user object.
+    #
+    #    u=Bitly::V3::User.new(o.access_token)
+    class User
+      def initialize(access_token)
+        @access_token = access_token
+      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. 
+      #
+      # http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/v3/user/referrers
+      def referrers(opts={})
+        if @referrers.nil? || opts.delete(:force)
+          @referrers = get_method(:referrers, Bitly::V3::Referrer, opts)
+        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. 
+      #
+      # http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/v3/user/countries
+      def countries(opts={})
+        if @countries.nil? || opts.delete(:force)
+          @countries = get_method(:countries, Bitly::V3::Country, opts)
+        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. 
+      #
+      # 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))
+          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'])
+          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
+      def clicks(opts={})
+        get_clicks(opts)
+        @clicks
+      end
+    
+      # Displays the total clicks returned from the clicks method.
+      def total_clicks(opts={})
+        get_clicks(opts)
+        @total_clicks
+      end
+    
+      private
+    
+      def get_method(method, klass, opts)
+        result = Crack::JSON.parse(@access_token.get("/v3/user/#{method.to_s}", opts))
+        if result['status_code'] == 200
+          results = result['data'][method.to_s].map do |rs|
+            rs.inject([]) do |results, obj|
+              results << klass.new(obj)
+            end
+          end
+          return results
+        else
+          raise BitlyError.new(results['status_txt'], results['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))
+          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'])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/bitly/version.rb

@@ -1,3 +1,3 @@
 module Bitly
-  VERSION = '0.5.5'
+  VERSION = '0.6.0'
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: bitly
 version: !ruby/object:Gem::Version 
-  hash: 1
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
-  - 5
-  version: 0.5.5
+  - 6
+  - 0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Phil Nash
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-12-22 00:00:00 +00:00
+date: 2011-01-03 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -50,6 +50,20 @@ dependencies:
         version: 0.5.2
   type: :runtime
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: oauth2
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id003
 description: Use the bit.ly API to shorten or expand URLs
 email: philnash@gmail.com
 executables: []
@@ -68,8 +82,11 @@ extra_rdoc_files:
 - 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
 files: 
 - History.txt
@@ -87,8 +104,11 @@ files:
 - 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
 - test/bitly/test_client.rb
 - test/bitly/test_url.rb