bitly 0.10.3 → 0.10.4

data/History.txt

@@ -1,3 +1,16 @@
+=== 0.10.4 / 2015-01-08
+
+* 1 minor update
+
+  * You can now pass a state parameter to the OAuth authorize url.
+
+=== 0.10.3 / 2014-09-22
+
+* 1 minor update
+
+  * Due to a tooling mishap, the previous gem version didn't update the OAuth2
+    gem versions. This has been updated now.
+
 === 0.10.2 / 2014-09-20
 
 * 1 minor update

data/Manifest

@@ -3,6 +3,7 @@ History.txt
 Manifest
 README.md
 Rakefile
+bitly.gemspec
 lib/bitly.rb
 lib/bitly/client.rb
 lib/bitly/config.rb

data/README.md

@@ -12,7 +12,9 @@ Bitly recently released their version 3 API. From this 0.5.0 release, the gem wi
 
 To move to using the version 3 API, call:
 
-    Bitly.use_api_version_3
+```ruby
+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://dev.bitly.com](http://dev.bitly.com) for details.
 
@@ -30,50 +32,63 @@ Eventually, this will become the default version used and finally, the V3 module
 
 Create a Bitly client using your username and api key as follows:
 
-    bitly = Bitly.new(username, api_key)
+```ruby
+bitly = Bitly.new(username, api_key)
+```
 
 You can then use that client to shorten or expand urls or return more information or statistics as so:
 
-    bitly.shorten('http://www.google.com')
-    bitly.shorten('http://www.google.com', :history => 1) # adds the url to the api user's history
-    bitly.expand('wQaT')
-    bitly.info('http://bit.ly/wQaT')
-    bitly.stats('http://bit.ly/wQaT')
+```ruby
+bitly.shorten('http://www.google.com')
+bitly.shorten('http://www.google.com', :history => 1) # adds the url to the api user's history
+bitly.expand('wQaT')
+bitly.info('http://bit.ly/wQaT')
+bitly.stats('http://bit.ly/wQaT')
+```
 
 Each can be used in all the methods described in the API docs, the shorten function, for example, takes a url or an array of urls.
 
 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
+```ruby
+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"
-    u.jmp_url #=> "http://j.mp/Ywd1"
-    u.user_hash #=> "Ywd1"
-    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
+u.long_url #=> "http://www.google.com"
+u.short_url #=> "http://bit.ly/Ywd1"
+u.bitly_url #=> "http://bit.ly/Ywd1"
+u.jmp_url #=> "http://j.mp/Ywd1"
+u.user_hash #=> "Ywd1"
+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')
+bitly.shorten('http://www.google.com', 'keyword')
+```
 
 ### Version 3 API
 
 Please see the Bit.ly API documentation [http://api.bit.ly](http://api.bit.ly) for details on the V3 API.
 
+Get your access token here: [https://bitly.com/a/oauth_apps](https://bitly.com/a/oauth_apps).
+
 ### Configure bitly through initializer
 
 If you want to configure bitly through an initializer (e.g. `config/initializers/bitly.rb`), do the following:
 
-    Bitly.configure do |config|
-      config.api_version = 3
-      config.login = "Bitly_Username"
-      config.api_key = "API_KEY"
-    end
+```ruby
+Bitly.use_api_version_3
+    
+Bitly.configure do |config|
+  config.api_version = 3
+  config.access_token = "API_KEY"
+end
+```
 
 Instead of using `Bitly.new(username, api_key)` to get the client, use `Bitly.client`:
 
-    client = Bitly.client
+```ruby
+Bitly.client.shorten('http://www.google.com')
+```
 
 ## LICENSE:
 

data/Rakefile

@@ -18,6 +18,7 @@ Echoe.new('bitly', Bitly::VERSION) do |p|
     ['rake'],
     ['shoulda'],
     ['flexmock'],
-    ['fakeweb']
+    ['fakeweb'],
+    ['activesupport', '~> 3.2']
   ]
 end

data/bitly.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = "bitly"
-  s.version = "0.10.3"
+  s.version = "0.10.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Phil Nash"]
-  s.date = "2014-09-22"
+  s.date = "2015-01-09"
   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"]
-  s.files = ["Gemfile", "History.txt", "Manifest", "README.md", "Rakefile", "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", "test/bitly/test_client.rb", "test/bitly/test_config.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", "bitly.gemspec"]
+  s.files = ["Gemfile", "History.txt", "Manifest", "README.md", "Rakefile", "bitly.gemspec", "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", "test/bitly/test_client.rb", "test/bitly/test_config.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 = "http://github.com/philnash/bitly"
   s.rdoc_options = ["--line-numbers", "--title", "Bitly", "--main", "README.md"]
   s.require_paths = ["lib"]
@@ -31,6 +31,7 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<shoulda>, [">= 0"])
       s.add_development_dependency(%q<flexmock>, [">= 0"])
       s.add_development_dependency(%q<fakeweb>, [">= 0"])
+      s.add_development_dependency(%q<activesupport>, ["~> 3.2"])
     else
       s.add_dependency(%q<multi_json>, ["~> 1.3"])
       s.add_dependency(%q<httparty>, [">= 0.7.6"])
@@ -40,6 +41,7 @@ Gem::Specification.new do |s|
       s.add_dependency(%q<shoulda>, [">= 0"])
       s.add_dependency(%q<flexmock>, [">= 0"])
       s.add_dependency(%q<fakeweb>, [">= 0"])
+      s.add_dependency(%q<activesupport>, ["~> 3.2"])
     end
   else
     s.add_dependency(%q<multi_json>, ["~> 1.3"])
@@ -50,5 +52,6 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<shoulda>, [">= 0"])
     s.add_dependency(%q<flexmock>, [">= 0"])
     s.add_dependency(%q<fakeweb>, [">= 0"])
+    s.add_dependency(%q<activesupport>, ["~> 3.2"])
   end
 end

data/lib/bitly/v3/oauth.rb

@@ -19,8 +19,10 @@ module Bitly
 
       # 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.auth_code.authorize_url(:redirect_uri => redirect_url).gsub(/api-ssl\./,'')
+      def authorize_url(redirect_url, state=nil)
+        params = {:redirect_uri => redirect_url}
+        params[:state] = state if state
+        client.auth_code.authorize_url(params).gsub(/api-ssl\./,'')
       end
 
       # Get the access token. You must pass the exact same redirect_url passed

data/lib/bitly/version.rb

@@ -1,3 +1,3 @@
 module Bitly
-  VERSION = '0.10.3'
+  VERSION = '0.10.4'
 end

data/test/bitly/test_client.rb

@@ -22,6 +22,18 @@ class TestClient < Test::Unit::TestCase
       assert_equal api_key, b.api_key
       assert_equal login, b.login
     end
+
+    should "create a proper OAuth2 authorization url" do
+      client = Bitly::V3::OAuth.new('CLIENT_ID', 'CLIENT_SECRET')
+      url = client.authorize_url('http://www.example.com/oauth_callback')
+      assert_equal "https://bitly.com/oauth/authorize?client_id=CLIENT_ID&redirect_uri=http%3A%2F%2Fwww.example.com%2Foauth_callback&response_type=code", url
+    end
+
+    should "create a proper OAuth2 authorization url with a state parameter" do
+      client = Bitly::V3::OAuth.new('CLIENT_ID', 'CLIENT_SECRET')
+      url = client.authorize_url('http://www.example.com/oauth_callback', 'some_state')
+      assert_equal "https://bitly.com/oauth/authorize?client_id=CLIENT_ID&redirect_uri=http%3A%2F%2Fwww.example.com%2Foauth_callback&response_type=code&state=some_state", url
+    end
   end
   context "using the bitly client" do
     setup do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitly
 version: !ruby/object:Gem::Version
-  version: 0.10.3
+  version: 0.10.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-09-22 00:00:00.000000000 Z
+date: 2015-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
@@ -145,6 +145,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 description: Use the bit.ly API to shorten or expand URLs
 email: philnash@gmail.com
 executables: []
@@ -174,6 +190,7 @@ files:
 - Manifest
 - README.md
 - Rakefile
+- bitly.gemspec
 - lib/bitly.rb
 - lib/bitly/client.rb
 - lib/bitly/config.rb
@@ -204,7 +221,6 @@ files:
 - test/fixtures/google_stats.json
 - test/fixtures/shorten_error.json
 - test/test_helper.rb
-- bitly.gemspec
 homepage: http://github.com/philnash/bitly
 licenses: []
 post_install_message: