oauth2-client 1.0.0 → 1.1.0

data/lib/oauth2/client.rb

@@ -32,6 +32,18 @@ module OAuth2
       @connection_options = options
     end
 
+    # Token scope definitions vary by service e.g Google uses space delimited scopes,
+    # while Github uses comma seperated scopes. This method allows us to normalize
+    # the token scopes
+    #
+    # @see http://developer.github.com/v3/oauth/#scopes, https://developers.google.com/accounts/docs/OAuth2WebServer#formingtheurl
+    def normalize_scope(scope, sep=' ')
+      unless (scope.is_a?(String) || scope.is_a?(Array))
+        raise ArgumentError.new("Expected scope of type String or Array but was: #{scope.class.name}")
+      end
+      (scope.is_a?(Array) && scope.join(sep)) || scope
+    end
+
     def implicit
       OAuth2::Grant::Implicit.new(self)
     end

data/lib/oauth2/connection.rb

@@ -100,25 +100,21 @@ module OAuth2
       headers         = @headers.merge(opts.fetch(:headers, {}))
       params          = opts[:params] || {}
       query           = Addressable::URI.form_encode(params)
-      method          = method.to_s.downcase
+      method          = method.to_sym
       normalized_path = query.empty? ? path : [path, query].join("?")
       client          = http_connection(opts.fetch(:connection_options, {}))
 
-      if (method == 'post' || method == 'put')
+      if (method == :post || method == :put)
         headers['Content-Type'] ||= 'application/x-www-form-urlencoded'
       end
 
       case method
-      when 'get'
-        response = client.get(normalized_path, headers)
-      when 'post'
-        response = client.post(path, query, headers)
-      when 'put'
-        response = client.put(path, query, headers)
-      when 'delete'
-        response = client.delete(normalized_path, headers)
+      when :get, :delete
+        response = client.send(method, normalized_path, headers)
+      when :post, :put
+        response = client.send(method, path, query, headers)
       else
-        raise UnhandledHTTPMethodError.new("Unsupported HTTP method, #{method.inspect}")
+        raise UnhandledHTTPMethodError.new("Unsupported HTTP method, #{method}")
       end
 
       status = response.code.to_i
@@ -129,7 +125,7 @@ module OAuth2
           if status == 303
             method = :get
             params = nil
-            headers.delete('Content-Type') 
+            headers.delete('Content-Type')
           end
           redirect_uri = Addressable::URI.parse(response.header['Location'])
           conn = {

data/lib/oauth2/grant/authorization_code.rb

@@ -37,9 +37,7 @@ module OAuth2
       #
       # @param [Hash] opts options
       def fetch_authorization_url(opts={})
-        opts[:method] ||= :get
-        opts[:params] ||= {}
-        opts[:params].merge!(authorization_params)
+        opts[:params] = opts.fetch(:params, {}).merge(authorization_params)
         method = opts.delete(:method) || :get
         make_request(method, @authorize_path, opts)
       end
@@ -50,15 +48,16 @@ module OAuth2
       # @param [Hash]   params additional params
       # @param [Hash]   opts options
       def get_token(code, opts={})
-        opts[:params] ||= {}
-        opts[:params][:code] = code
+        opts[:params] = {
+          :grant_type => grant_type,
+          :code       => code
+        }.merge(opts.fetch(:params, {}))
+
         opts[:authenticate] ||= :headers
         method = opts.delete(:method) || :post
         make_request(method, token_path, opts)
       end
-
-    private
-
+      
       # Default authorization request parameters
       def authorization_params
         {

data/lib/oauth2/version.rb

@@ -1,7 +1,7 @@
 module OAuth2
   class Version
     MAJOR = 1 unless defined? OAuth2::Version::MAJOR
-    MINOR = 0 unless defined? OAuth2::Version::MINOR
+    MINOR = 1 unless defined? OAuth2::Version::MINOR
     PATCH = 0 unless defined? OAuth2::Version::PATCH
 
     def self.to_s

data/oauth2-client.gemspec

@@ -1,13 +1,23 @@
-Gem::Specification.new do |s|
-  s.name             = 'oauth2-client'
-  s.version          = '1.0.0'
-  s.date             = %q{2013-01-22}
-  s.summary          = "OAuth2 Ruby Client"
-  s.description      = "Create quick and dirty OAuth2 clients for many services. Google OAuth2 client included"
-  s.authors          = ["Kevin Mutyaba"]
-  s.email            = %q{tiabasnk@gmail.com}
-  s.homepage         = ''
-  s.rubygems_version = %q{1.0.0}
-  s.files            = `git ls-files`.split("\n")
-  s.require_paths    = ['lib']
-end
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'oauth2/version'
+
+Gem::Specification.new do |spec|
+  spec.add_dependency 'json'
+  spec.add_dependency 'bcrypt-ruby', '~> 3.0.0'
+  spec.add_dependency 'addressable'
+  spec.add_development_dependency 'bundler', '~> 1.0'
+
+  spec.name             = 'oauth2-client'
+  spec.version          = OAuth2::Version
+  spec.date             = %q{2013-03-03}
+  spec.summary          = "OAuth2 client wrapper in Ruby"
+  spec.description      = "Create quick and dirty OAuth2 clients"
+  spec.authors          = ["Kevin Mutyaba"]
+  spec.email            = %q{tiabasnk@gmail.com}
+  spec.homepage         = 'http://tiabas.github.com/oauth2-client/'
+  spec.files            = `git ls-files`.split("\n")
+  spec.require_paths    = ['lib']
+  spec.licenses         = ['MIT']
+  spec.required_rubygems_version = '>= 1.3.6'
+end

data/spec/examples/github_client_spec.rb

@@ -0,0 +1,59 @@
+require File.expand_path('../../spec_helper', __FILE__)
+require 'github_client'
+
+describe GithubClient do
+
+  subject do
+    GithubClient.new('https://github.com', '2945e6425da3d5d17ffc', '0a8f686f2835a70a79dbcece2ec63bc5079f40a8')
+
+    # GithubClient.new('https://github.com', '82f971d013e8d637a7e1', '1a1d59e1f8b8afa5f73e9dc9f17e25f7876e64ac')
+  end
+
+  describe "#webserver_authorization_url" do
+    it "returns the authorization url" do
+        auth_url = subject.webserver_authorization_url(
+          :scope => 'repo, user',
+          :state => '1kd84ur7q0c9rbtnd',
+          :redirect_uri => 'https://localhost/callback'
+        )
+
+        parsed_url = Addressable::URI.parse(auth_url)
+        expect(parsed_url.path).to eq '/login/oauth/authorize'
+        expect(parsed_url.query_values).to eq({
+          "client_id"     => '2945e6425da3d5d17ffc',
+          "redirect_uri"  => 'https://localhost/callback',
+          "response_type" => 'code',
+          "scope"         => 'repo, user',
+          "state"         => '1kd84ur7q0c9rbtnd'
+        })
+        expect(parsed_url.scheme).to eq 'https'
+        expect(parsed_url.host).to eq 'github.com'
+    end
+  end
+
+  describe "#exchange_auth_code_for_token" do
+    it "makes a request to google oauth2 server" do
+
+      stub_request(:post, "https://github.com/login/oauth/access_token").with(
+        :body => {
+          :grant_type    => 'authorization_code',
+          :code          => 'IZuJJVnL49Cc',
+          :redirect_uri  => 'https://localhost/callback',
+          :client_id     => '2945e6425da3d5d17ffc',
+          :client_secret => '0a8f686f2835a70a79dbcece2ec63bc5079f40a8'
+        },
+        :headers => {
+          'Accept'       => "application/json", 
+          'User-Agent'   => "OAuth2 Ruby Gem #{OAuth2::Version}",
+          'Content-Type' => "application/x-www-form-urlencoded"
+        }
+      )
+      response = subject.exchange_auth_code_for_token(
+        :params => {
+          :code => 'IZuJJVnL49Cc',
+          :redirect_uri => 'https://localhost/callback'
+        }
+      )
+    end
+  end
+end

data/spec/examples/google_client_spec.rb

@@ -4,18 +4,7 @@ require 'google_client'
 describe GoogleClient do
 
   subject do
-
-    GoogleClient.new('https://accounts.google.com', '827502413694.apps.googleusercontent.com', 'a2nQpcUm2Dgq1chWdAvbXGTk',{
-      :token_path     => '/o/oauth2/token',
-      :authorize_path => '/o/oauth2/auth',
-      :device_path    => '/o/oauth2/device/code',
-      :connection_options => {
-        :headers => {
-          "User-Agent" => "GoOAuth2 0.1",
-          "Accept"     => "application/json"
-        }
-      }
-    })
+    GoogleClient.new('https://accounts.google.com', '827502413694.apps.googleusercontent.com', 'a2nQpcUm2Dgq1chWdAvbXGTk')
   end
   #
   # https://developers.google.com/accounts/docs/OAuth2WebServer#formingtheurl
@@ -25,7 +14,7 @@ describe GoogleClient do
         params = {
           "approval_prompt" => "force",
           "client_id" => "827502413694.apps.googleusercontent.com",
-          "redirect_uri" => "http://localhost",
+          "redirect_uri" => "https://localhost",
           "response_type" =>"code",
           "scope" => "https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile",
           "state" => "/profile",
@@ -35,7 +24,7 @@ describe GoogleClient do
         auth_url = subject.webserver_authorization_url(
           :scope => 'https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile',
           :state => '/profile',
-          :redirect_uri => 'http://localhost',
+          :redirect_uri => 'https://localhost',
           :approval_prompt => 'force',
           :access_type => 'offline'
         )
@@ -53,7 +42,7 @@ describe GoogleClient do
         params = {
           "approval_prompt"=>"force",
           "client_id"=>"827502413694.apps.googleusercontent.com",
-          "redirect_uri"=>"http://localhost",
+          "redirect_uri"=>"https://localhost",
           "response_type"=>"code",
           "scope"=>"https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile",
           "state"=>"/profile"
@@ -65,7 +54,7 @@ describe GoogleClient do
             'https://www.googleapis.com/auth/userinfo.profile'
           ],
           :state => '/profile',
-          :redirect_uri => 'http://localhost',
+          :redirect_uri => 'https://localhost',
           :approval_prompt => 'force'
         )
 
@@ -91,25 +80,23 @@ describe GoogleClient do
   describe "#exchange_auth_code_for_token" do
     it "makes a request to google oauth2 server" do
 
-      fake_response = double(
-        :code => '200',
-        :body => ''
-      )
-
-      Net::HTTP.any_instance.should_receive(:post).with(
-        "/o/oauth2/token", 
-        "redirect_uri=https%3A%2F%2Flocalhost&code=4%2FdbB0-UD1cvrQg2EuEFtRtHwPEmvR.IrScsjgB5M4VuJJVnL49Cc8QdUjRdAI",
-        {
-          "Accept"=>"application/json", 
-          "User-Agent"=>"GoOAuth2 0.1",
-          "Authorization"=>"Basic ODI3NTAyNDEzNjk0LmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tOmEyblFwY1VtMkRncTFjaFdkQXZiWEdUaw==",
-          "Content-Type"=>"application/x-www-form-urlencoded"
+      stub_request(:post, "https://accounts.google.com/o/oauth2/token").with(
+        :body => {
+          :grant_type    => 'authorization_code',
+          :code          => '4/o3xJkRT6SM_TpohrxC7T-4o3kqu6.MmOGL795LbIZuJJVnL49Cc-uiE7LeAI',
+          :redirect_uri  => 'https://localhost',
+          :client_id     => '827502413694.apps.googleusercontent.com',
+          :client_secret => 'a2nQpcUm2Dgq1chWdAvbXGTk'
+        },
+        :headers => {
+          'Accept'       => "application/json", 
+          'User-Agent'   => "OAuth2 Ruby Gem #{OAuth2::Version}",
+          'Content-Type' => "application/x-www-form-urlencoded"
         }
-      ).and_return(fake_response)
-
-      subject.exchange_auth_code_for_token(
+      )
+      response = subject.exchange_auth_code_for_token(
         :params => {
-          :code => '4/dbB0-UD1cvrQg2EuEFtRtHwPEmvR.IrScsjgB5M4VuJJVnL49Cc8QdUjRdAI',
+          :code => '4/o3xJkRT6SM_TpohrxC7T-4o3kqu6.MmOGL795LbIZuJJVnL49Cc-uiE7LeAI',
           :redirect_uri => 'https://localhost'
         }
       )
@@ -144,26 +131,23 @@ describe GoogleClient do
 
   describe "#refresh_token" do
     it "makes a request to google to obtain new token" do
-      fake_response = double(
-        :code => '200',
-        :body => ''
-      )
 
-      Net::HTTP.any_instance.should_receive(:post).with(
-        "/o/oauth2/token",
-        "state=%2Fprofile&grant_type=refresh_token&refresh_token=2YotnFZFEjr1zCsicMWpAA",
-        {
-          "Accept" => "application/json",
-          "User-Agent" => "GoOAuth2 0.1",
-          "Authorization" => "Basic ODI3NTAyNDEzNjk0LmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tOmEyblFwY1VtMkRncTFjaFdkQXZiWEdUaw==",
-          "Content-Type" => "application/x-www-form-urlencoded"
+      stub_request(:post, "https://accounts.google.com/o/oauth2/token").with(
+        :body => {
+          :grant_type    => 'refresh_token',
+          :refresh_token => '1/6BMfW9j53gdGImsiyUH5kU5RsR4zwI9lUVX-tqf8JXQ',
+          :client_id     => '827502413694.apps.googleusercontent.com',
+          :client_secret => 'a2nQpcUm2Dgq1chWdAvbXGTk'
+        },
+        :headers => {
+          'Accept'       => 'application/json', 
+          'User-Agent'   => 'OAuth2 Ruby Gem 1.1.0',
+          'Content-Type' => 'application/x-www-form-urlencoded'
         }
-      ).and_return(fake_response)
-
+      )
       subject.refresh_access_token(
         :params => {
-          :state => '/profile',
-          :refresh_token => '2YotnFZFEjr1zCsicMWpAA'
+          :refresh_token => '1/6BMfW9j53gdGImsiyUH5kU5RsR4zwI9lUVX-tqf8JXQ'
         }
       )
     end
@@ -171,21 +155,17 @@ describe GoogleClient do
 
   describe "#get_device_code" do
     it "makes a request to google to obtain a device code" do
-      fake_response = double(
-        :code => '200',
-        :body => ''
-      )
-
-      Net::HTTP.any_instance.should_receive(:post).with(
-        "/o/oauth2/device/code",
-        "scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.email+https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fuserinfo.profile&client_id=827502413694.apps.googleusercontent.com",
-        {
-          "Accept"=>"application/json",
-          "User-Agent"=>"GoOAuth2 0.1",
-          "Content-Type"=>"application/x-www-form-urlencoded"
+      stub_request(:post, "https://accounts.google.com/o/oauth2/device/code").with(
+        :body => {
+          :scope         => 'https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile',
+          :client_id     => '827502413694.apps.googleusercontent.com'
+        },
+        :headers => {
+          'Accept'       => 'application/json', 
+          'User-Agent'   => 'OAuth2 Ruby Gem 1.1.0',
+          'Content-Type' => 'application/x-www-form-urlencoded'
         }
-      ).and_return(fake_response)
-
+      )
       subject.get_device_code(
         :params => {
           :scope => 'https://www.googleapis.com/auth/userinfo.email https://www.googleapis.com/auth/userinfo.profile'
@@ -196,22 +176,18 @@ describe GoogleClient do
 
   describe "#exchange_device_code_for_token" do
     it "makes request to google to obtain an access token" do
-      fake_response = double(
-        :code => '200',
-        :body => ''
-      )
-
-      Net::HTTP.any_instance.should_receive(:post).with(
-        "/o/oauth2/token",
-        "state=%2Fprofile&code=G3Y6jU3a&grant_type=http%3A%2F%2Foauth.net%2Fgrant_type%2Fdevice%2F1.0",
-        {
-          "Accept"=>"application/json",
-          "User-Agent" => "GoOAuth2 0.1",
-          "Authorization"=>"Basic ODI3NTAyNDEzNjk0LmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tOmEyblFwY1VtMkRncTFjaFdkQXZiWEdUaw==",
-          "Content-Type"=>"application/x-www-form-urlencoded"
+      stub_request(:post, "https://827502413694.apps.googleusercontent.com:a2nQpcUm2Dgq1chWdAvbXGTk@accounts.google.com/o/oauth2/token").with(
+        :body => {
+          :grant_type    => 'http://oauth.net/grant_type/device/1.0',
+          :state         => '/profile',
+          :code          => 'G3Y6jU3a'
+        },
+        :headers => {
+          'Accept'       => 'application/json', 
+          'User-Agent'   => 'OAuth2 Ruby Gem 1.1.0',
+          'Content-Type' => 'application/x-www-form-urlencoded'
         }
-      ).and_return(fake_response)
-
+      )
       subject.exchange_device_code_for_token(
         :params => {
           :state => '/profile',

data/spec/examples/yammer_client_spec.rb

@@ -0,0 +1,75 @@
+require File.expand_path('../../spec_helper', __FILE__)
+require 'yammer_client'
+
+describe YammerClient do
+
+  subject do
+    YammerClient.new('https://www.yammer.com', 'PRbTcg9qjgKsp4jjpm1pw', 'a2nQpcUm2Dgq1chWdAvbXGTk')
+  end
+
+  describe "#clientside_authorization_url" do
+    it "returns url string for obtaining authorization" do
+      params = {
+        'client_id'     => 'PRbTcg9qjgKsp4jjpm1pw',
+        'response_type' => 'token'
+      }
+
+      auth_url = subject.clientside_authorization_url
+
+      parsed_url = Addressable::URI.parse(auth_url)
+      expect(parsed_url.path).to eq '/dialog/oauth/authorize'
+      expect(parsed_url.query_values).to eq params
+      expect(parsed_url.scheme).to eq 'https'
+      expect(parsed_url.host).to eq 'www.yammer.com'
+    end
+  end
+
+  describe "#webserver_authorization_url" do
+    it "returns the authorization url" do
+      params = {
+        "client_id" => "PRbTcg9qjgKsp4jjpm1pw",
+        "redirect_uri" => "https://localhost/callback",
+        "response_type" =>"code",
+        "state" => "12345"
+      }
+
+      auth_url = subject.webserver_authorization_url(
+        :client_id => 'PRbTcg9qjgKsp4jjpm1pw',
+        :state => '12345',
+        :redirect_uri => 'https://localhost/callback'
+      )
+
+      parsed_url = Addressable::URI.parse(auth_url)
+      expect(parsed_url.path).to eq '/dialog/oauth/authorize'
+      expect(parsed_url.query_values).to eq params
+      expect(parsed_url.scheme).to eq 'https'
+      expect(parsed_url.host).to eq 'www.yammer.com'
+    end
+  end
+
+  describe "#exchange_auth_code_for_token" do
+    it "makes a request to google oauth2 server" do
+
+      stub_request(:post, "https://www.yammer.com/oauth2/token").with(
+        :body => {
+          :grant_type    => 'authorization_code',
+          :code          => 'MmOGL795LbIZuJJVnL49Cc',
+          :redirect_uri  => 'https://localhost',
+          :client_id     => 'PRbTcg9qjgKsp4jjpm1pw',
+          :client_secret => 'a2nQpcUm2Dgq1chWdAvbXGTk'
+        },
+        :headers => {
+          'Accept'       => "application/json", 
+          'User-Agent'   => "OAuth2 Ruby Gem #{OAuth2::Version}",
+          'Content-Type' => "application/x-www-form-urlencoded"
+        }
+      )
+      response = subject.exchange_auth_code_for_token(
+        :params => {
+          :code => 'MmOGL795LbIZuJJVnL49Cc',
+          :redirect_uri => 'https://localhost'
+        }
+      )
+    end
+  end
+end