oauth2 0.5.0 → 0.5.2

data/.travis.yml

@@ -1,5 +1,7 @@
 rvm:
   - 1.8.7
   - 1.9.2
+  - 1.9.3
+  - jruby
+  - rbx
   - ree
-  - ruby-head

data/Gemfile

@@ -1,3 +1,3 @@
-source 'http://rubygems.org'
+source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -1,24 +1,25 @@
-OAuth2
-======
-A Ruby wrapper for the OAuth 2.0 specification. This is a work in progress, being built first to solve the pragmatic process of connecting to existing OAuth 2.0 endpoints (a.k.a. Facebook) with the goal of building it up to meet the entire specification over time.
+# OAuth2 [![Build Status](https://secure.travis-ci.org/intridea/oauth2.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/intridea/oauth2.png?travis)][gemnasium]
+A Ruby wrapper for the OAuth 2.0 specification. This is a work in progress,
+being built first to solve the pragmatic process of connecting to existing
+OAuth 2.0 endpoints (a.k.a. Facebook) with the goal of building it up to meet
+the entire specification over time.
 
-Installation
-------------
-    gem install oauth2
+[travis]: http://travis-ci.org/intridea/oauth2
+[gemnasium]: https://gemnasium.com/intridea/oauth2
 
-Continuous Integration
-----------------------
-[![Build Status](https://secure.travis-ci.org/intridea/oauth2.png)](http://travis-ci.org/intridea/oauth2)
+## <a name="installation"></a>Installation
+    gem install oauth2
 
-Resources
----------
-* View Source on GitHub (https://github.com/intridea/oauth2)
-* Report Issues on GitHub (https://github.com/intridea/oauth2/issues)
-* Read More at the Wiki (https://wiki.github.com/intridea/oauth2)
+## <a name="resources"></a>Resources
+* [View Source on GitHub][code]
+* [Report Issues on GitHub][issues]
+* [Read More at the Wiki][wiki]
 
-Generic Client Example
-----------------------
+[code]: https://github.com/intridea/oauth2
+[issues]: https://github.com/intridea/oauth2/issues
+[wiki]: https://wiki.github.com/intridea/oauth2
 
+## <a name="examples"></a>Usage Examples
     require 'oauth2'
     client = OAuth2::Client.new('client_id', 'client_secret', :site => 'https://example.org')
 
@@ -30,55 +31,80 @@ Generic Client Example
     response.class.name
     # => OAuth2::Response
 
-OAuth2::Response
-----------------
-The AccessToken methods #get, #post, #put and #delete and the generic #request will return an instance of the #OAuth2::Response class.
-This instance contains a #parsed method that will parse the response body and return a Hash if the Content-Type is application/x-www-form-urlencoded or if the body is a JSON object.  It will return an Array if the body is a JSON array.  Otherwise, it will return the original body string.
-
-The original response body, headers, and status can be accessed via their respective methods.
-
-OAuth2::AccessToken
--------------------
-If you have an existing Access Token for a user, you can initialize an instance using various class methods including the standard new, from_hash (if you have a hash of the values), or from_kvform (if you have an application/x-www-form-urlencoded encoded string of the values).
-
-OAuth2::Error
--------------
-On 400+ status code responses, an OAuth2::Error will be raised.  If it is a standard OAuth2 error response, the body will be parsed and #code and #description will contain the values provided from the error and error_description parameters.  The #response property of OAuth2::Error will always contain the OAuth2::Response instance.
-
-If you do not want an error to be raised, you may use :raise_errors => false option on initialization of the client.  In this case the OAuth2::Response instance will be returned as usual and on 400+ status code responses, the Response instance will contain the OAuth2::Error instance.
-
-Authorization Grants
---------------------
-Currently the Authorization Code and Resource Owner Password Credentials authentication grant types have helper strategy classes that simplify client use.  They are available via the #auth_code and #password methods respectively.
-
-    auth_url = client.auth_code.authorization_url(:redirect_uri => 'http://localhost:8080/oauth/callback')
+## <a name="response"></a>OAuth2::Response
+The AccessToken methods #get, #post, #put and #delete and the generic #request
+will return an instance of the #OAuth2::Response class.
+
+This instance contains a #parsed method that will parse the response body and
+return a Hash if the Content-Type is application/x-www-form-urlencoded or if
+the body is a JSON object.  It will return an Array if the body is a JSON
+array.  Otherwise, it will return the original body string.
+
+The original response body, headers, and status can be accessed via their
+respective methods.
+
+## <a name="access_token"></a>OAuth2::AccessToken
+If you have an existing Access Token for a user, you can initialize an instance
+using various class methods including the standard new, from_hash (if you have
+a hash of the values), or from_kvform (if you have an
+application/x-www-form-urlencoded encoded string of the values).
+
+## <a name="error"></a>OAuth2::Error
+On 400+ status code responses, an OAuth2::Error will be raised.  If it is a
+standard OAuth2 error response, the body will be parsed and #code and
+#description will contain the values provided from the error and
+error_description parameters.  The #response property of OAuth2::Error will
+always contain the OAuth2::Response instance.
+
+If you do not want an error to be raised, you may use :raise_errors => false
+option on initialization of the client.  In this case the OAuth2::Response
+instance will be returned as usual and on 400+ status code responses, the
+Response instance will contain the OAuth2::Error instance.
+
+## <a name="authorization_grants"></a>Authorization Grants
+Currently the Authorization Code and Resource Owner Password Credentials
+authentication grant types have helper strategy classes that simplify client
+use.  They are available via the #auth_code and #password methods respectively.
+
+    auth_url = client.auth_code.authorize_url(:redirect_uri => 'http://localhost:8080/oauth/callback')
     token = client.auth_code.get_token('code_value', :redirect_uri => 'http://localhost:8080/oauth/callback')
 
     token = client.password.get_token('username', 'password')
 
-You can always use the #request method on the OAuth2::Client instance to make requests for tokens for any Authentication grant type.
-
+You can always use the #request method on the OAuth2::Client instance to make
+requests for tokens for any Authentication grant type.
 
-Note on Patches/Pull Requests
------------------------------
+## <a name="pulls"></a>Submitting a Pull Request
 1. Fork the project.
 2. Create a topic branch.
 3. Implement your feature or bug fix.
 4. Add documentation for your feature or bug fix.
 5. Add specs for your feature or bug fix.
-6. Run <tt>bundle exec rake spec</tt>. If your changes are not 100% covered, go back to step 5.
+6. Run `bundle exec rake spec`. If your changes are not 100% covered, go back
+   to step 5.
 7. Commit and push your changes.
-8. Submit a pull request. Please do not include changes to the [gemspec](https://github.com/intridea/oauth2/blob/master/oauth2.gemspec), [version](https://github.com/intridea/oauth2/blob/master/lib/oauth2/version.rb), or [changelog](https://github.com/intridea/oauth2/wiki/Changelg) . (If you want to create your own version for some reason, please do so in a separate commit.)
+8. Submit a pull request. Please do not include changes to the [gemspec][],
+   [version][], or [changelog][]. (If you want to create your own version for
+   some reason, please do so in a separate commit.)
 
-Supported Rubies
-----------------
-This library aims to support and is [tested
-against](http://travis-ci.org/intridea/oauth2) the following Ruby
+[gemspec]: https://github.com/intridea/oauth2/blob/master/oauth2.gemspec
+[version]: https://github.com/intridea/oauth2/blob/master/lib/oauth2/version.rb
+[changelog]: https://github.com/intridea/oauth2/wiki/Changelog
+
+## <a name="versions"></a>Supported Ruby Versions
+This library aims to support and is [tested against][travis] the following Ruby
 implementations:
 
 * Ruby 1.8.7
 * Ruby 1.9.2
-* Ruby Enterprise Edition 1.8.7
+* Ruby 1.9.3
+* [JRuby][]
+* [Rubinius][]
+* [Ruby Enterprise Edition][ree]
+
+[jruby]: http://www.jruby.org/
+[rubinius]: http://rubini.us/
+[ree]: http://www.rubyenterpriseedition.com/
 
 If something doesn't work on one of these interpreters, it should be considered
 a bug.
@@ -94,7 +120,7 @@ implementation, you will be personally responsible for providing patches in a
 timely fashion. If critical issues for a particular implementation exist at the
 time of a major release, support for that Ruby version may be dropped.
 
-Copyright
----------
+## <a name="copyright"></a>Copyright
 Copyright (c) 2011 Intridea, Inc. and Michael Bleigh.
-See [LICENSE](https://github.com/intridea/oauth2/blob/master/LICENSE.md) for details.
+See [LICENSE][] for details.
+[license]: https://github.com/intridea/oauth2/blob/master/LICENSE.md

data/Rakefile

@@ -9,10 +9,13 @@ RSpec::Core::RakeTask.new(:spec)
 task :default => :spec
 task :test => :spec
 
-require 'rdoc/task'
-Rake::RDocTask.new do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "oauth2 #{OAuth2::VERSION}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+namespace :doc do
+  require 'rdoc/task'
+  require File.expand_path('../lib/oauth2/version', __FILE__)
+  RDoc::Task.new do |rdoc|
+    rdoc.rdoc_dir = 'rdoc'
+    rdoc.title = "oauth2 #{OAuth2::VERSION}"
+    rdoc.main = 'README.md'
+    rdoc.rdoc_files.include('README.md', 'LICENSE.md', 'lib/**/*.rb')
+  end
 end

data/lib/oauth2/client.rb

@@ -115,9 +115,10 @@ module OAuth2
     # Initializes an AccessToken by making a request to the token endpoint
     #
     # @param [Hash] params a Hash of params for the token endpoint
+    # @param [Hash] access token options, to pass to the AccessToken object
     # @return [AccessToken] the initalized AccessToken
-    def get_token(params)
-      opts = {:raise_errors => true, :parse => params.delete(:parse)}
+    def get_token(params, access_token_opts={})
+      opts = {:raise_errors => options[:raise_errors], :parse => params.delete(:parse)}
       if options[:token_method] == :post
         opts[:body] = params
         opts[:headers] =  {'Content-Type' => 'application/x-www-form-urlencoded'}
@@ -125,8 +126,8 @@ module OAuth2
         opts[:params] = params
       end
       response = request(options[:token_method], token_url, opts)
-      raise Error.new(response) unless response.parsed.is_a?(Hash) && response.parsed['access_token']
-      AccessToken.from_hash(self, response.parsed)
+      raise Error.new(response) if options[:raise_errors] && !(response.parsed.is_a?(Hash) && response.parsed['access_token'])
+      AccessToken.from_hash(self, response.parsed.merge(access_token_opts))
     end
 
     # The Authorization Code strategy

data/lib/oauth2/response.rb

@@ -23,7 +23,7 @@ module OAuth2
     #
     # @param [Faraday::Response] response The Faraday response instance
     # @param [Hash] opts options in which to initialize the instance
-    # @option opts [Symbol] :parse (:automatic) how to parse the response body.  one of :url (for x-www-form-urlencoded),
+    # @option opts [Symbol] :parse (:automatic) how to parse the response body.  one of :query (for x-www-form-urlencoded),
     #   :json, or :automatic (determined by Content-Type response header)
     def initialize(response, opts={})
       @response = response

data/lib/oauth2/strategy/auth_code.rb

@@ -22,10 +22,11 @@ module OAuth2
       #
       # @param [String] code The Authorization Code value
       # @param [Hash] params additional params
+      # @param [Hash] opts options
       # @note that you must also provide a :redirect_uri with most OAuth 2.0 providers
-      def get_token(code, params={})
+      def get_token(code, params={}, opts={})
         params = {'grant_type' => 'authorization_code', 'code' => code}.merge(client_params).merge(params)
-        @client.get_token(params)
+        @client.get_token(params, opts)
       end
     end
   end

data/lib/oauth2/strategy/password.rb

@@ -16,11 +16,11 @@ module OAuth2
       # @param [String] username the End User username
       # @param [String] password the End User password
       # @param [Hash] params additional params
-      def get_token(username, password, params={})
+      def get_token(username, password, params={}, opts={})
         params = {'grant_type' => 'password',
                   'username'   => username,
                   'password'   => password}.merge(client_params).merge(params)
-        @client.get_token(params)
+        @client.get_token(params, opts)
       end
     end
   end

data/lib/oauth2/version.rb

@@ -1,3 +1,3 @@
 module OAuth2
-  VERSION = "0.5.0"
+  VERSION = "0.5.2"
 end

data/oauth2.gemspec

@@ -1,20 +1,18 @@
-# -*- encoding: utf-8 -*-
+# encoding: utf-8
 require File.expand_path('../lib/oauth2/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.add_development_dependency 'rake', '~> 0.9'
-  gem.add_development_dependency 'rdoc', '~> 3.6'
-  gem.add_development_dependency 'rspec', '~> 2.6'
-  gem.add_development_dependency 'simplecov', '~> 0.4'
-  gem.add_development_dependency 'yard', '~> 0.7'
-  gem.add_development_dependency 'ZenTest', '~> 4.5'
+  gem.add_dependency 'faraday', '~> 0.7'
+  gem.add_dependency 'multi_json', '~> 1.0'
   gem.add_development_dependency 'multi_xml'
-  gem.add_runtime_dependency 'faraday', ['>= 0.6.1', '< 0.8']
-  gem.add_runtime_dependency 'multi_json', '~> 1.0.0'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rdoc'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'simplecov'
+  gem.add_development_dependency 'yard'
   gem.authors = ["Michael Bleigh", "Erik Michaels-Ober"]
   gem.description = %q{A Ruby wrapper for the OAuth 2.0 protocol built with a similar style to the original OAuth gem.}
   gem.email = ['michael@intridea.com', 'sferik@gmail.com']
-  gem.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   gem.files = `git ls-files`.split("\n")
   gem.homepage = 'http://github.com/intridea/oauth2'
   gem.name = 'oauth2'

data/spec/helper.rb

@@ -1,5 +1,3 @@
-$:.unshift File.expand_path('..', __FILE__)
-$:.unshift File.expand_path('../../lib', __FILE__)
 require 'simplecov'
 SimpleCov.start
 require 'oauth2'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: oauth2
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,77 +10,77 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-07-29 00:00:00.000000000 Z
+date: 2012-01-04 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rake
-  requirement: &70092424464720 !ruby/object:Gem::Requirement
+  name: faraday
+  requirement: &70259907739420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '0.9'
-  type: :development
+        version: '0.7'
+  type: :runtime
   prerelease: false
-  version_requirements: *70092424464720
+  version_requirements: *70259907739420
 - !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: &70092424463940 !ruby/object:Gem::Requirement
+  name: multi_json
+  requirement: &70259907738920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '3.6'
-  type: :development
+        version: '1.0'
+  type: :runtime
   prerelease: false
-  version_requirements: *70092424463940
+  version_requirements: *70259907738920
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: &70092424463400 !ruby/object:Gem::Requirement
+  name: multi_xml
+  requirement: &70259907738540 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '2.6'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70092424463400
+  version_requirements: *70259907738540
 - !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: &70092424462900 !ruby/object:Gem::Requirement
+  name: rake
+  requirement: &70259907738080 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.4'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70092424462900
+  version_requirements: *70259907738080
 - !ruby/object:Gem::Dependency
-  name: yard
-  requirement: &70092424462440 !ruby/object:Gem::Requirement
+  name: rdoc
+  requirement: &70259907737660 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '0.7'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70092424462440
+  version_requirements: *70259907737660
 - !ruby/object:Gem::Dependency
-  name: ZenTest
-  requirement: &70092424461860 !ruby/object:Gem::Requirement
+  name: rspec
+  requirement: &70259907737240 !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - ~>
+    - - ! '>='
       - !ruby/object:Gem::Version
-        version: '4.5'
+        version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70092424461860
+  version_requirements: *70259907737240
 - !ruby/object:Gem::Dependency
-  name: multi_xml
-  requirement: &70092424461480 !ruby/object:Gem::Requirement
+  name: simplecov
+  requirement: &70259907767020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -88,32 +88,18 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70092424461480
+  version_requirements: *70259907767020
 - !ruby/object:Gem::Dependency
-  name: faraday
-  requirement: &70092424460880 !ruby/object:Gem::Requirement
+  name: yard
+  requirement: &70259907766600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
-        version: 0.6.1
-    - - <
-      - !ruby/object:Gem::Version
-        version: '0.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: *70092424460880
-- !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: &70092424460060 !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.0
-  type: :runtime
+        version: '0'
+  type: :development
   prerelease: false
-  version_requirements: *70092424460060
+  version_requirements: *70259907766600
 description: A Ruby wrapper for the OAuth 2.0 protocol built with a similar style
   to the original OAuth gem.
 email:
@@ -123,7 +109,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .autotest
 - .document
 - .gemtest
 - .gitignore
@@ -170,7 +155,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.5.1
+rubygems_version: 1.8.13
 signing_key: 
 specification_version: 3
 summary: A Ruby wrapper for the OAuth 2.0 protocol.
@@ -182,3 +167,4 @@ test_files:
 - spec/oauth2/strategy/auth_code_spec.rb
 - spec/oauth2/strategy/base_spec.rb
 - spec/oauth2/strategy/password_spec.rb
+has_rdoc: 

data/.autotest

@@ -1 +0,0 @@
-require 'autotest/bundler'