oauth2 0.0.5 → 0.0.6

data/CHANGELOG.rdoc

@@ -0,0 +1,4 @@
+== 0.0.6 (April 25)
+
+* Added ResponseString so as not to throw away response information when making requests.
+* Deprecated #access_token on WebServer strategy in favor of #get_access_token

data/README.rdoc

@@ -5,6 +5,12 @@ A Ruby wrapper for the OAuth 2.0 specification. This is a work in progress, bein
 == Installation
 
     gem install oauth2
+    
+== Resources
+
+* View Source on GitHub (http://github.com/intridea/oauth2)
+* Report Issues on GitHub (http://github.com/intridea/oauth2/issues)
+* Read More at the Wiki (http://wiki.github.com/intridea/oauth2/)
    
 == Web Server Example (Sinatra)
 
@@ -18,7 +24,7 @@ Below is a fully functional example of a Sinatra application that would authenti
     def client
       OAuth2::Client.new('api_key', 'api_secret', :site => 'https://graph.facebook.com')
     end
-    
+
     get '/auth/facebook' do
       redirect client.web_server.authorize_url(
         :redirect_uri => redirect_uri, 
@@ -27,7 +33,7 @@ Below is a fully functional example of a Sinatra application that would authenti
     end
 
     get '/auth/facebook/callback' do
-      access_token = client.web_server.access_token(params[:code], :redirect_uri => redirect_uri)
+      access_token = client.web_server.get_access_token(params[:code], :redirect_uri => redirect_uri)
       user = JSON.parse(access_token.get('/me'))
 
       user.inspect
@@ -40,7 +46,7 @@ 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.
+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)
 
 == Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.0.5
+0.0.6

data/lib/oauth2.rb

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

data/lib/oauth2/client.rb

@@ -42,6 +42,7 @@ module OAuth2
       connection.build_url(path, params).to_s
     end
 
+    # Makes a request relative to the specified site root.
     def request(verb, url, params = {}, headers = {})
       if verb == :get
         resp = connection.run_request(verb, url, nil, headers) do |req|
@@ -51,13 +52,13 @@ module OAuth2
         resp = connection.run_request(verb, url, params, headers)
       end
       case resp.status
-        when 200...201 then resp.body
+        when 200...201 then ResponseString.new(resp)
         when 401
-          e = OAuth2::AccessDenied.new("Received HTTP 401 when retrieving access token.")
+          e = OAuth2::AccessDenied.new("Received HTTP 401 during request.")
           e.response = resp
           raise e
         else
-          e = OAuth2::HTTPError.new("Received HTTP #{resp.status} when retrieving access token.")
+          e = OAuth2::HTTPError.new("Received HTTP #{resp.status} during request.")
           e.response = resp
           raise e
       end

data/lib/oauth2/response_string.rb

@@ -0,0 +1,20 @@
+# This special String class is returned from HTTP requests
+# and contains the original full response along with convenience
+# methods for accessing the HTTP status code and headers. It
+# is returned from all access token requests.
+class ResponseString < String
+  def initialize(response)
+    super(response.body)
+    self.response = response
+  end
+    
+  attr_accessor :response
+  
+  def status
+    response.status
+  end
+  
+  def headers
+    response.headers
+  end
+end

data/lib/oauth2/strategy/web_server.rb

@@ -5,14 +5,24 @@ module OAuth2
         super(options).merge('type' => 'web_server')
       end
       
-      def access_token(code, options = {})
+      # Retrieve an access token given the specified validation code.
+      # Note that you must also provide a <tt>:redirect_uri</tt> option
+      # in order to successfully verify your request for most OAuth 2.0
+      # endpoints.
+      def get_access_token(code, options = {})
         response = @client.request(:get, @client.access_token_url, access_token_params(code, options))
         params   = Rack::Utils.parse_query(response)
         token    = params['access_token']
         OAuth2::AccessToken.new(@client, token)
       end
       
-      def access_token_params(code, options = {})
+      # <b>DEPRECATED:</b> Use #get_access_token instead.
+      def access_token(*args)
+        warn '[DEPRECATED] OAuth2::Strategy::WebServer#access_token is deprecated, use #get_access_token instead. Will be removed in 0.1.0'
+        get_access_token(*args)
+      end
+      
+      def access_token_params(code, options = {}) #:nodoc:
         super(options).merge({
           'type' => 'web_server',
           'code' => code

data/oauth2.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{oauth2}
-  s.version = "0.0.5"
+  s.version = "0.0.6"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Michael Bleigh"]
-  s.date = %q{2010-04-23}
+  s.date = %q{2010-04-25}
   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 = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG.rdoc",
      "LICENSE",
      "README.rdoc",
      "Rakefile",
@@ -26,6 +27,7 @@ Gem::Specification.new do |s|
      "lib/oauth2.rb",
      "lib/oauth2/access_token.rb",
      "lib/oauth2/client.rb",
+     "lib/oauth2/response_string.rb",
      "lib/oauth2/strategy/base.rb",
      "lib/oauth2/strategy/web_server.rb",
      "oauth2.gemspec",

data/spec/oauth2/client_spec.rb

@@ -5,7 +5,7 @@ describe OAuth2::Client do
     cli = OAuth2::Client.new('abc','def', :site => 'https://api.example.com')
     cli.connection.build do |b|
       b.adapter :test do |stub|
-        stub.get('/success')      { |env| [200, {}, 'yay'] }
+        stub.get('/success')      { |env| [200, {'Content-Type' => 'text/awesome'}, 'yay'] }
         stub.get('/unauthorized') { |env| [401, {}, '']    }
         stub.get('/error')        { |env| [500, {}, '']    }
       end
@@ -47,8 +47,11 @@ describe OAuth2::Client do
   end
 
   describe "#request" do
-    it "returns response body on successful response" do
-      subject.request(:get, '/success', {}, {}).should == 'yay'
+    it "returns ResponseString on successful response" do
+      response = subject.request(:get, '/success', {}, {})
+      response.should == 'yay'
+      response.status.should == 200
+      response.headers.should == {'Content-Type' => 'text/awesome'}
     end
 
     it "raises OAuth2::AccessDenied on 401 response" do

data/spec/oauth2/strategy/web_server_spec.rb

@@ -29,9 +29,9 @@ describe OAuth2::Strategy::WebServer do
     end
   end
 
-  describe "#access_token" do
+  describe "#get_access_token" do
     before do
-      @access = subject.access_token('sushi')
+      @access = subject.get_access_token('sushi')
     end
 
     it 'returns AccessToken with same Client' do

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 5
-  version: 0.0.5
+  - 6
+  version: 0.0.6
 platform: ruby
 authors: 
 - Michael Bleigh
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-23 00:00:00 -04:00
+date: 2010-04-25 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +57,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG.rdoc
 - LICENSE
 - README.rdoc
 - Rakefile
@@ -64,6 +65,7 @@ files:
 - lib/oauth2.rb
 - lib/oauth2/access_token.rb
 - lib/oauth2/client.rb
+- lib/oauth2/response_string.rb
 - lib/oauth2/strategy/base.rb
 - lib/oauth2/strategy/web_server.rb
 - oauth2.gemspec