bitly 0.9.0 → 0.10.0

data/History.txt

@@ -1,3 +1,10 @@
+=== 0.10.0 / 2014-2-23
+
+* 2 major updates
+
+  * Updates OAuth2 gem dependency to include version 0.9.x
+  * Adds support for generic OAuth2 access token in V3 API, thanks to fzagarzazu (issue #47)
+
 === 0.9.0 / 2013-4-28
 
 * 2 major updates

data/README.md

@@ -2,9 +2,9 @@
 
 ## DESCRIPTION:
 
-A Ruby API for [http://bit.ly](http://bit.ly)
+A Ruby API for [http://bitly.com](http://bitly.com)
 
-[http://code.google.com/p/bitly-api/wiki/ApiDocumentation](http://code.google.com/p/bitly-api/wiki/ApiDocumentation)
+[http://dev.bitly.com](http://dev.bitly.com)
 
 ## NOTE:
 
@@ -14,7 +14,7 @@ To move to using the version 3 API, call:
 
     Bitly.use_api_version_3
 
-Then, when you call ``Bitly.new(username, api_key)`` you will get a ``Bitly::V3::Client`` instead, which provides the version 3 api calls (``shorten``, ``expand``, ``clicks``, ``validate`` and ``bitly_pro_domain``). See [http://api.bit.ly](http://api.bit.ly) for details.
+Then, when you call ``Bitly.new(username, api_key)`` you will get a ``Bitly::V3::Client`` instead, which provides the version 3 api calls (``shorten``, ``expand``, ``clicks``, ``validate`` and ``bitly_pro_domain``). See [http://dev.bitly.com](http://dev.bitly.com) for details.
 
 Eventually, this will become the default version used and finally, the V3 module will disappear, with the version 3 classes replacing the version 2 classes.
 

data/Rakefile

@@ -11,7 +11,7 @@ Echoe.new('bitly', Bitly::VERSION) do |p|
   p.extra_deps = [
     ['multi_json', '~> 1.3'],
     ['httparty', '>= 0.7.6'],
-    ['oauth2', '>= 0.5.0', '< 0.9']
+    ['oauth2', '>= 0.5.0', '< 0.10']
   ]
   p.development_dependencies = [
     ['echoe'],

data/bitly.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = "bitly"
-  s.version = "0.9.0"
+  s.version = "0.10.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Phil Nash"]
-  s.date = "2013-04-28"
+  s.date = "2014-02-23"
   s.description = "Use the bit.ly API to shorten or expand URLs"
   s.email = "philnash@gmail.com"
   s.extra_rdoc_files = ["README.md", "lib/bitly.rb", "lib/bitly/client.rb", "lib/bitly/config.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"]
@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<multi_json>, ["~> 1.3"])
       s.add_runtime_dependency(%q<httparty>, [">= 0.7.6"])
-      s.add_runtime_dependency(%q<oauth2>, ["< 0.9", ">= 0.5.0"])
+      s.add_runtime_dependency(%q<oauth2>, ["< 0.10", ">= 0.5.0"])
       s.add_development_dependency(%q<echoe>, [">= 0"])
       s.add_development_dependency(%q<rake>, [">= 0"])
       s.add_development_dependency(%q<shoulda>, [">= 0"])
@@ -34,7 +34,7 @@ Gem::Specification.new do |s|
     else
       s.add_dependency(%q<multi_json>, ["~> 1.3"])
       s.add_dependency(%q<httparty>, [">= 0.7.6"])
-      s.add_dependency(%q<oauth2>, ["< 0.9", ">= 0.5.0"])
+      s.add_dependency(%q<oauth2>, ["< 0.10", ">= 0.5.0"])
       s.add_dependency(%q<echoe>, [">= 0"])
       s.add_dependency(%q<rake>, [">= 0"])
       s.add_dependency(%q<shoulda>, [">= 0"])
@@ -44,7 +44,7 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<multi_json>, ["~> 1.3"])
     s.add_dependency(%q<httparty>, [">= 0.7.6"])
-    s.add_dependency(%q<oauth2>, ["< 0.9", ">= 0.5.0"])
+    s.add_dependency(%q<oauth2>, ["< 0.10", ">= 0.5.0"])
     s.add_dependency(%q<echoe>, [">= 0"])
     s.add_dependency(%q<rake>, [">= 0"])
     s.add_dependency(%q<shoulda>, [">= 0"])

data/lib/bitly/client.rb

@@ -7,7 +7,7 @@ module Bitly
   API_URL     = 'http://api.bit.ly/'
   API_VERSION = '2.0.1'
 
-  def self.new(login, api_key, timeout=nil)
+  def self.new(login, api_key = nil, timeout=nil)
     if @version == 3
       Bitly::V3::Client.new(login, api_key, timeout)
     else

data/lib/bitly/config.rb

@@ -11,6 +11,9 @@ module Bitly
 
     attr_accessor *OPTION_KEYS
 
+    alias_method :access_token, :login
+    alias_method :access_token=, :login=
+
     def configure
       yield self
       self

data/lib/bitly/v3/client.rb

@@ -4,14 +4,29 @@ module Bitly
     # 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
+      API_URL_SSL = 'https://api-ssl.bitly.com/v3/'
       include HTTParty
-      base_uri 'http://api.bit.ly/v3/'
+      base_uri 'http://api.bitly.com/v3/'
 
-      # Requires a login and api key. Get yours from your account page at https://bitly.com/a/your_api_key
+      # 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(login, api_key, timeout=nil)
-        @default_query_opts = { :login => login, :apiKey => api_key }
-        self.timeout = timeout
+      def initialize(*args)
+        args.compact!
+        self.timeout = args.last.is_a?(Fixnum) ? args.pop : nil
+        if args.count == 1
+          # Set generic OAuth2 access token and change base URI (use SSL)
+          @default_query_opts = { :access_token => args.first }
+          self.class.base_uri API_URL_SSL
+        else
+          # Deprecated ApiKey authentication
+          @default_query_opts = {
+            :login => args[0],
+            :apiKey => args[1]
+          }
+        end
       end
 
       # Validates a login and api key

data/lib/bitly/v3/oauth.rb

@@ -12,7 +12,7 @@ module Bitly
         @client ||= ::OAuth2::Client.new(
           @consumer_token,
           @consumer_secret,
-          :site => 'https://api-ssl.bit.ly',
+          :site => 'https://api-ssl.bitly.com',
           :token_url => '/oauth/access_token'
         )
       end
@@ -36,4 +36,4 @@ module Bitly
       end
     end
   end
-end
+end

data/lib/bitly/v3/url.rb

@@ -114,6 +114,10 @@ module Bitly
         @clicks_by_day
       end
 
+      def jmp_url
+        @short_url.nil? ? nil : @short_url.gsub(/bit\.ly/,'j.mp')
+      end
+
       # QR code is automatically created and can be incorporated
       # into mobile applications.
       def qrcode_url(opts={})

data/lib/bitly/version.rb

@@ -1,3 +1,3 @@
 module Bitly
-  VERSION = '0.9.0'
+  VERSION = '0.10.0'
 end

data/test/bitly/test_client.rb

@@ -7,6 +7,11 @@ class TestClient < Test::Unit::TestCase
       assert_equal Bitly::Client, b.class
     end
 
+    should "create a new bitly client with generic OAuth2 access token" do
+      b = Bitly.new(access_token)
+      assert_equal Bitly::Client, b.class
+    end
+
     should "create a new bitly client and configure with a block" do
       Bitly.configure do |config|
         config.api_key = api_key

data/test/test_helper.rb

@@ -27,6 +27,9 @@ end
 def login
   'test_account'
 end
+def access_token
+  'test_access_token'
+end
 
 class Test::Unit::TestCase
   def teardown

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitly
 version: !ruby/object:Gem::Version
-  version: 0.9.0
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-28 00:00:00.000000000 Z
+date: 2014-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70227825351380 !ruby/object:Gem::Requirement
+  requirement: &70201536191400 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70227825351380
+  version_requirements: *70201536191400
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &70227825350880 !ruby/object:Gem::Requirement
+  requirement: &70201536190980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: 0.7.6
   type: :runtime
   prerelease: false
-  version_requirements: *70227825350880
+  version_requirements: *70201536190980
 - !ruby/object:Gem::Dependency
   name: oauth2
-  requirement: &70227825350180 !ruby/object:Gem::Requirement
+  requirement: &70201536190560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,13 +43,13 @@ dependencies:
         version: 0.5.0
     - - <
       - !ruby/object:Gem::Version
-        version: '0.9'
+        version: '0.10'
   type: :runtime
   prerelease: false
-  version_requirements: *70227825350180
+  version_requirements: *70201536190560
 - !ruby/object:Gem::Dependency
   name: echoe
-  requirement: &70227825349200 !ruby/object:Gem::Requirement
+  requirement: &70201536189920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -57,10 +57,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70227825349200
+  version_requirements: *70201536189920
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70227825348580 !ruby/object:Gem::Requirement
+  requirement: &70201536189520 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -68,10 +68,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70227825348580
+  version_requirements: *70201536189520
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70227825347860 !ruby/object:Gem::Requirement
+  requirement: &70201536189120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -79,10 +79,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70227825347860
+  version_requirements: *70201536189120
 - !ruby/object:Gem::Dependency
   name: flexmock
-  requirement: &70227825347240 !ruby/object:Gem::Requirement
+  requirement: &70201536188700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -90,10 +90,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70227825347240
+  version_requirements: *70201536188700
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &70227825346600 !ruby/object:Gem::Requirement
+  requirement: &70201536188300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,7 +101,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70227825346600
+  version_requirements: *70201536188300
 description: Use the bit.ly API to shorten or expand URLs
 email: philnash@gmail.com
 executables: []