oauth2 0.0.10 → 0.0.11

data/README.rdoc

@@ -46,7 +46,24 @@ Below is a fully functional example of a Sinatra application that would authenti
       uri.to_s
     end
     
-That's all there is to it! You can use the access token like you would with the OAuth gem, calling HTTP verbs on it etc. You can view more examples on the OAuth2 Wiki (http://wiki.github.com/intridea/oauth2/examples)
+That's all there is to it! You can use the access token like you would with the 
+OAuth gem, calling HTTP verbs on it etc. You can view more examples on the OAuth2 
+Wiki (http://wiki.github.com/intridea/oauth2/examples)
+    
+== JSON Parsing
+
+Because JSON has become the standard format of the OAuth 2.0 specification,
+the <tt>oauth2</tt> gem contains a mode that will perform automatic parsing
+of JSON response bodies, returning a hash instead of a string. To enable this
+mode, simply add the <tt>:parse_json</tt> option to your client initialization:
+
+    client = OAuth2::Client.new('app_id', 'app_secret', 
+      :site => 'https://example.com', 
+      :parse_json => true
+    )
+    
+    # Obtain an access token using the client
+    token.get('/some/url.json') # {"some" => "hash"}
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -11,6 +11,7 @@ begin
     gem.homepage = "http://github.com/intridea/oauth2"
     gem.authors = ["Michael Bleigh"]
     gem.add_dependency 'faraday', '~> 0.4.1'
+    gem.add_dependency 'faraday-middleware'
     gem.add_dependency 'multi_json', '>= 0.0.4'
     gem.add_development_dependency "rspec", ">= 1.2.9"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings

data/VERSION

@@ -1 +1 @@
-0.0.10
+0.0.11

data/lib/oauth2.rb

@@ -8,4 +8,5 @@ require 'oauth2/client'
 require 'oauth2/strategy/base'
 require 'oauth2/strategy/web_server'
 require 'oauth2/access_token'
-require 'oauth2/response_string'
+require 'oauth2/response_string'
+require 'oauth2/response_hash'

data/lib/oauth2/client.rb

@@ -15,6 +15,7 @@ module OAuth2
     end
 
     attr_accessor :id, :secret, :site, :connection, :options
+    attr_writer :json
 
     # Instantiate a new OAuth 2.0 client using the
     # client ID and client secret registered to your
@@ -34,6 +35,8 @@ module OAuth2
       self.site       = opts.delete(:site) if opts[:site]
       self.options    = opts
       self.connection = Faraday::Connection.new(site)
+      self.json       = opts.delete(:parse_json)
+      
       if adapter && adapter != :test
         connection.build { |b| b.adapter(adapter) }
       end
@@ -59,7 +62,12 @@ module OAuth2
         resp = connection.run_request(verb, url, params, headers)
       end
       case resp.status
-        when 200...201 then ResponseString.new(resp)
+        when 200...201 
+          if json? && resp.headers['Content-Type'] == 'application/json'
+            ResponseHash.new(resp)
+          else
+            ResponseString.new(resp)
+          end
         when 401
           e = OAuth2::AccessDenied.new("Received HTTP 401 during request.")
           e.response = resp
@@ -70,6 +78,8 @@ module OAuth2
           raise e
       end
     end
+    
+    def json?; !!@json end
 
     def web_server; OAuth2::Strategy::WebServer.new(self) end
   end

data/lib/oauth2/response_hash.rb

@@ -0,0 +1,13 @@
+class ResponseHash < Hash
+  def initialize(response)
+    self.response = response
+    
+    body = MultiJson.decode(response.body)
+    body.keys.each{|k| self[k] = body[k]}
+  end
+  
+  attr_accessor :response
+  
+  def status; response.status end
+  def headers; response.headers end
+end

data/lib/oauth2/response_string.rb

@@ -10,11 +10,6 @@ class ResponseString < String
     
   attr_accessor :response
   
-  def status
-    response.status
-  end
-  
-  def headers
-    response.headers
-  end
+  def status; response.status end
+  def headers; response.headers end
 end

data/oauth2.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{oauth2}
-  s.version = "0.0.10"
+  s.version = "0.0.11"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Bleigh"]
-  s.date = %q{2010-06-19}
+  s.date = %q{2010-08-17}
   s.description = %q{A Ruby wrapper for the OAuth 2.0 protocol built with a similar style to the original OAuth gem.}
   s.email = %q{michael@intridea.com}
   s.extra_rdoc_files = [
@@ -27,6 +27,7 @@ Gem::Specification.new do |s|
      "lib/oauth2.rb",
      "lib/oauth2/access_token.rb",
      "lib/oauth2/client.rb",
+     "lib/oauth2/response_hash.rb",
      "lib/oauth2/response_string.rb",
      "lib/oauth2/strategy/base.rb",
      "lib/oauth2/strategy/web_server.rb",
@@ -42,7 +43,7 @@ Gem::Specification.new do |s|
   s.homepage = %q{http://github.com/intridea/oauth2}
   s.rdoc_options = ["--charset=UTF-8"]
   s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.6}
+  s.rubygems_version = %q{1.3.7}
   s.summary = %q{A Ruby wrapper for the OAuth 2.0 protocol.}
   s.test_files = [
     "spec/oauth2/access_token_spec.rb",
@@ -56,17 +57,20 @@ Gem::Specification.new do |s|
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<faraday>, ["~> 0.4.1"])
+      s.add_runtime_dependency(%q<faraday-middleware>, [">= 0"])
       s.add_runtime_dependency(%q<multi_json>, [">= 0.0.4"])
       s.add_development_dependency(%q<rspec>, [">= 1.2.9"])
     else
       s.add_dependency(%q<faraday>, ["~> 0.4.1"])
+      s.add_dependency(%q<faraday-middleware>, [">= 0"])
       s.add_dependency(%q<multi_json>, [">= 0.0.4"])
       s.add_dependency(%q<rspec>, [">= 1.2.9"])
     end
   else
     s.add_dependency(%q<faraday>, ["~> 0.4.1"])
+    s.add_dependency(%q<faraday-middleware>, [">= 0"])
     s.add_dependency(%q<multi_json>, [">= 0.0.4"])
     s.add_dependency(%q<rspec>, [">= 1.2.9"])
   end

data/spec/oauth2/client_spec.rb

@@ -8,6 +8,7 @@ describe OAuth2::Client do
         stub.get('/success')      { |env| [200, {'Content-Type' => 'text/awesome'}, 'yay'] }
         stub.get('/unauthorized') { |env| [401, {}, '']    }
         stub.get('/error')        { |env| [500, {}, '']    }
+        stub.get('/json')         { |env| [200, {'Content-Type' => 'application/json'}, '{"abc":"def"}']}
       end
     end
     cli
@@ -66,4 +67,31 @@ describe OAuth2::Client do
   it '#web_server should instantiate a WebServer strategy with this client' do
     subject.web_server.should be_kind_of(OAuth2::Strategy::WebServer)
   end
+  
+  context 'with JSON parsing' do
+    before do
+      subject.json = true
+    end
+    
+    describe '#request' do
+      it 'should return a response hash' do
+        response = subject.request(:get, '/json', {}, {})
+        response.should be_kind_of(ResponseHash)
+        response['abc'].should == 'def'
+      end
+      
+      it 'should only try to decode application/json' do
+        subject.request(:get, '/success').should == 'yay'
+      end
+    end
+    
+    it 'should set json? based on the :parse_json option' do
+      OAuth2::Client.new('abc','def', :site => 'http://example.com', :parse_json => true).should be_json
+      OAuth2::Client.new('abc','def', :site => 'http://example.com', :parse_json => false).should_not be_json
+    end
+    
+    after do
+      subject.json = false
+    end
+  end
 end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: oauth2
 version: !ruby/object:Gem::Version 
+  hash: 9
   prerelease: false
   segments: 
   - 0
   - 0
-  - 10
-  version: 0.0.10
+  - 11
+  version: 0.0.11
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-06-19 00:00:00 -04:00
+date: 2010-08-17 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: faraday
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 0
         - 4
@@ -32,33 +35,51 @@ dependencies:
   type: :runtime
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: multi_json
+  name: faraday-middleware
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: multi_json
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 23
         segments: 
         - 0
         - 0
         - 4
         version: 0.0.4
   type: :runtime
-  version_requirements: *id002
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 13
         segments: 
         - 1
         - 2
         - 9
         version: 1.2.9
   type: :development
-  version_requirements: *id003
+  version_requirements: *id004
 description: A Ruby wrapper for the OAuth 2.0 protocol built with a similar style to the original OAuth gem.
 email: michael@intridea.com
 executables: []
@@ -79,6 +100,7 @@ files:
 - lib/oauth2.rb
 - lib/oauth2/access_token.rb
 - lib/oauth2/client.rb
+- lib/oauth2/response_hash.rb
 - lib/oauth2/response_string.rb
 - lib/oauth2/strategy/base.rb
 - lib/oauth2/strategy/web_server.rb
@@ -100,23 +122,27 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: A Ruby wrapper for the OAuth 2.0 protocol.