yam 2.0.2 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97a990374c59ee764163a8526ad5fb97c658394b
-  data.tar.gz: 22f4a2584a6d6ce7893d96fb5fa16e3280a64201
+  metadata.gz: e0e5efea2af8ae9081156643e602122768245e7f
+  data.tar.gz: ad3067915dda2084e593b184a2e32fa56bed1b18
 SHA512:
-  metadata.gz: d85bd34783b152be23fdb86598616adac60bae9fbc301d811d7208e4456effc628f6e6a4ddc0fd7b5e7613583c86289879e660db1ec140b84b929d8812496134
-  data.tar.gz: 40c1d1664b2e1883b9d977125672bec96d8fa4fddf2006bd6fe88b66b6bed745a92a9547d93a4231d5bd89e671922abae3c42b53995bfbb010f2764e8512e110
+  metadata.gz: 6d6562a49ee934050eafbcbac4c99ca98fc7f712574eff6582d8c4cc27b45db832155eef8777c290cefdd4e984785a51ab63c6212d7868082257f83913e4b269
+  data.tar.gz: b0c26a07fec043005483b21072bcb36c19ff6c8e6c3e1bbeada98289ae59c01999c1add376545c2eafc91e0d895c6251a5e6a14b100e0e2ffb931e6308e008db

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+2.1.0
+====================================
+- Bundled Yammer OAuth2 Client into gem
 
 2.0.1
 ====================================

data/CONTRIBUTORS

@@ -0,0 +1,4 @@
+Jessie A. Young
+Jason Nochlin
+Sandeep Sharma
+Scott Balentine

data/Gemfile

@@ -20,7 +20,6 @@
 source 'https://rubygems.org'
 
 group :test do
-  # gem 'json', :platforms => :ruby_18
   gem 'rspec', '>= 2.11'
   gem 'simplecov', :require => false
   gem 'coveralls', :require => false

data/README.md

@@ -83,6 +83,53 @@ Setup a Yammer client application as described on the [Yammer Developer site](ht
 }
 ```
 
+## Using bundled Yammer OAuth2 Client
+This gem comes bundled with an OAuth2 wrapper that makes provides convenience methods for getting through the OAuth2 flow
+
+```ruby
+
+require 'yammer-oauth2/client'
+
+yammer_client = Yammmer::OAuth2Client.new('PRbTcg9qjgKsp4jjpm1pw', 'Xn7kp7Ly0TCY4GtZWkmSsqGEPg10DmMADyjWkf2U')
+
+```
+
+## Authorization Grants
+The client wraps around the creation of any given grant and passing in the parameters defined in the configuration
+file. The supported grants include Authorization Code and Implicit. They are available via the `authorization_code` and `implicit` methods on a client object.
+
+# Authorization Code grant (Server-side authorization)
+
+```ruby
+
+# generate authorization url
+auth_url = yammer_client.webserver_authorization_url
+# => https://www.yammer.com/dialog/oauth/authorize?client_id=PRbTcg9qjgKsp4jjpm1pw&response_type=code
+
+# exchange authorization code for access token. we will get back a Net::HTTPResponse
+response = yammer_client.exchange_auth_code_for_token({
+    :code => '11a0b0b64db56c30e2ef',
+    :redirect_uri => 'https://localhost/callback',
+  })
+
+response.inspect 
+# => #<Net::HTTPOK:0x007ff8bc7c1200>
+
+response.body
+# => {
+#      "access_token" : {
+#                          "token": "e409f4272fe539166a77c42479de030e7660812a",
+#                          "token_type" : "bearer"
+#                       }
+#    }"
+```
+
+# Implicit Grant (Client-side authorization)
+```ruby
+authorization_url = yammer_client.clientside_authorization_url(:redirect_uri => 'http://localhost/oauth2/callback')
+# => "https://www.yammer.com/dialog/oauth/?client_id=PRbTcg9qjgKsp4jjpm1pw&redirect_uri=http%3A%2F%2Flocalhost%2Foauth%2Fcallback&response_type=token"
+```
+
 ### Configuring yammer-client
 
 To view the current state of the client use the `options` method

data/lib/yammer.rb

@@ -17,6 +17,7 @@ require 'yammer/error'
 require 'yammer/configurable'
 require 'yammer/api'
 require 'yammer/http_adapter'
+require 'yammer/oauth2_client'
 require 'yammer/client'
 require 'yammer/api_handler'
 require 'yammer/api_response'

data/lib/yammer/oauth2_client.rb

@@ -0,0 +1,122 @@
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+# Licensed under the Apache License, Version 2.0 (the "License"); 
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR 
+# CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING 
+# WITHOUT LIMITATION ANY IMPLIED WARRANTIES OR CONDITIONS OF TITLE,
+# FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT. 
+
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+require 'oauth2'
+
+module Yammer
+  class OAuth2Client < OAuth2::Client
+
+    SITE_URL       = 'https://www.yammer.com'
+    TOKEN_PATH     = '/oauth2/token'
+    AUTHORIZE_PATH = '/dialog/oauth'
+
+    def initialize(client_id, client_secret, opts={})
+      site_url = opts.delete(:site_url) || SITE_URL
+      opts[:token_path]     ||= TOKEN_PATH
+      opts[:authorize_path] ||= AUTHORIZE_PATH
+      super(site_url, client_id, client_secret, opts)
+      yield self if block_given?
+      self
+    end
+
+    # Generates the Yammer URL that the user will be redirected to in order to
+    # authorize your application
+    #
+    # @see https://developer.yammer.com/api/oauth2.html#client-side
+    #
+    # @opts [Hash] additional parameters to be include in URL eg. scope, state, etc
+    #
+    # client = YammerClient.new(config)
+    # client.clientside_authorization_url({
+    #      :redirect_uri => 'https://localhost/oauth/cb',
+    #    })
+    # >> https://www.yammer.com/dialog/oauth/?client_id={client_id}&
+    #    redirect_uri=http%3A%2F%2Flocalhost%2Foauth%2Fcb&response_type=token
+    #
+    def webclient_authorization_url(opts={})
+      implicit.token_url(opts)
+    end
+
+    # Generates the Yammer URL that the user will be redirected to in order to
+    # authorize your application
+    #
+    # @see https://developer.yammer.com/api/oauth2.html#server-side
+    #
+    # @opts [Hash] additional parameters to be include in URL eg. scope, state, etc
+    #
+    # >> client = YammerClient.new(config)
+    # >> client.webserver_authorization_url({
+    #      :redirect_uri => 'https://localhost/oauth/cb',
+    #    })
+    # >> https://www.yammer.com/dialog/oauth/?client_id={client_id}&
+    #    redirect_uri=http%3A%2F%2Flocalhost%2Foauth%2Fcb&response_type=code
+    #
+    def webserver_authorization_url(opts={})
+      opts[:scope] = normalize_scope(opts[:scope]) if opts[:scope]
+      authorization_code.authorization_url(opts)
+    end
+
+    # Makes a request to Yammer server that will swap your authorization code for an access
+    # token
+    #
+    # @see https://developer.yammer.com/api/oauth2.html#server-side
+    #
+    # @opts [Hash] may include redirect uri and other query parameters
+    #
+    # >> client = YammerClient.new(config)
+    # >> client.exchange_auth_code_for_token({
+    #      :redirect_uri => 'https://localhost:3000/oauth/v2/callback',
+    #      :code => 'G3Y6jU3a',
+    #    })
+    #
+    # POST /oauth2/access_token HTTP/1.1
+    # Host: www.yammer.com
+    # Content-Type: application/x-www-form-urlencoded
+
+    #  client_id={client_id}&code=G3Y6jU3a&grant_type=authorization_code&
+    #  redirect_uri=http%3A%2F%2Flocalhost%2Foauth%2Fcb&client_secret={client_secret}
+    def access_token_from_authorization_code(code, opts={})
+      opts[:authenticate] ||= :body
+      authorization_code.get_token(code, opts)
+    end
+
+    # Makes a request to Yammer server that will swap client credential for an access token
+    #
+    # @opts [Hash] parameters that will be added to URL query string
+    #
+    # POST /oauth2/access_token HTTP/1.1
+    # Host: www.yammer.com
+    # Content-Type: application/x-www-form-urlencoded
+    #
+    # client_id={client_id}&client_secret={client_secret}
+    def access_token_from_client_credentials(opts={})
+      opts[:authenticate] ||= :body
+      client_credentials.get_token(opts)
+    end
+
+    # Makes a request to Yammer server that will swap resource owner credentials for an access token
+    #
+    # @opts [Hash] parameters that will be added to URL query string
+    #
+    # POST /oauth2/access_token HTTP/1.1
+    # Host: www.yammer.com
+    # Content-Type: application/x-www-form-urlencoded
+    #
+    # client_id={client_id}&client_secret={client_secret}&username={username}&password={passwort}
+    def access_token_from_resource_owner_credentials(username, password, opts={})
+      opts[:authenticate] ||= :body
+      self.password.get_token(username, password, opts)
+    end
+  end
+end

data/lib/yammer/version.rb

@@ -15,8 +15,8 @@
 module Yammer
   class Version
     MAJOR = 2 unless defined? Yammer::MAJOR
-    MINOR = 0 unless defined? Yammer::MINOR
-    PATCH = 2 unless defined? Yammer::PATCH
+    MINOR = 1 unless defined? Yammer::MINOR
+    PATCH = 0 unless defined? Yammer::PATCH
     PRE = nil unless defined? Yammer::PRE
 
     class << self

data/spec/oauth2_client_spec.rb

@@ -0,0 +1,123 @@
+# -*- encoding: utf-8 -*-
+
+# Copyright (c) Microsoft Corporation
+# All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# THIS CODE IS PROVIDED *AS IS* BASIS, WITHOUT WARRANTIES OR CONDITIONS OF
+# ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION ANY
+# IMPLIED WARRANTIES OR CONDITIONS OF TITLE, FITNESS FOR A PARTICULAR
+# PURPOSE, MERCHANTABLITY OR NON-INFRINGEMENT.
+#
+# See the Apache Version 2.0 License for specific language governing
+# permissions and limitations under the License.
+
+require File.expand_path('../spec_helper', __FILE__)
+
+describe Yammer::OAuth2Client do
+
+  subject do
+    Yammer::OAuth2Client.new('PRbTcg9qjgKsp4jjpm1pw', 'a2nQpcUm2Dgq1chWdAvbXGTk', {
+      :connection_options => {
+        :headers => {
+          'User-Agent' => "Yammer OAuth2 Client #{Yammer::Version}",
+          "Accept"     => "application/json"
+        }
+      }
+    })
+  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'
+      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 "#access_token_from_authorization_code" do
+    it "makes a POST request to exchange authorization code for access token" 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',
+          'Content-Type'   =>'application/x-www-form-urlencoded', 
+          'User-Agent'     =>"Yammer OAuth2 Client #{Yammer::Version}"
+      })
+
+      subject.access_token_from_authorization_code(
+        'MmOGL795LbIZuJJVnL49Cc',
+        :params => {
+          :redirect_uri => 'https://localhost'
+        }
+      )
+    end
+  end
+
+  describe "#access_token_from_client_credentials" do
+    it "makes a POST request to exchange client credentiaks for access token" do
+
+      stub_request(:post, "https://www.yammer.com/oauth2/token").with(
+        :body => {
+          :grant_type    => 'client_credentials',
+          :client_id     => 'PRbTcg9qjgKsp4jjpm1pw',
+          :client_secret => 'a2nQpcUm2Dgq1chWdAvbXGTk'
+        },
+        :headers => {
+          'Accept'         =>'application/json',
+          'Content-Type'   =>'application/x-www-form-urlencoded', 
+          'User-Agent'     =>"Yammer OAuth2 Client #{Yammer::Version}"
+      })
+
+      subject.access_token_from_client_credentials
+    end
+  end
+
+  describe "#access_token_from_resource_owner_credentials" do
+    it "makes a POST request to exchange client credentiaks for access token" do
+
+      stub_request(:post, "https://www.yammer.com/oauth2/token").with(
+        :body => {
+          :grant_type    => 'password',
+          :username      => 'thekev',
+          :password      => 'h4x0r',
+          :client_id     => 'PRbTcg9qjgKsp4jjpm1pw',
+          :client_secret => 'a2nQpcUm2Dgq1chWdAvbXGTk'
+        },
+        :headers => {
+          'Accept'         =>'application/json',
+          'Content-Type'   =>'application/x-www-form-urlencoded', 
+          'User-Agent'     =>"Yammer OAuth2 Client #{Yammer::Version}"
+      })
+
+      subject.access_token_from_resource_owner_credentials('thekev', 'h4x0r')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -70,4 +70,4 @@ end
 
 def upload(file)
   File.new("#{mock_path}/#{file}")
-end
+end

data/yam.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |s|
   s.name             = 'yam'
   s.version          = Yammer::Version
 
-  s.date             = %q{2013-12-12}
+  s.date             = %q{2013-12-16}
   s.summary          = "Yammer API Client"
 
   s.description      = "A Ruby wrapper for accessing Yammer's REST API"
@@ -43,7 +43,7 @@ Gem::Specification.new do |s|
   s.signing_key      = File.expand_path("~/.gem/certs/private_key.pem") if $0 =~ /gem\z/
 
   s.add_dependency 'oj', '~> 2.0.10'
-  s.add_dependency 'multi_json', '~> 1.3'
+  s.add_dependency 'multi_json', '~> 1.8.2'
   s.add_dependency 'rest-client', '~> 1.6.7'
   s.add_dependency 'addressable', '~> 2.3.3'
   s.add_dependency 'oauth2-client', '~> 1.1.2'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yam
 version: !ruby/object:Gem::Version
-  version: 2.0.2
+  version: 2.1.0
 platform: ruby
 authors:
 - Kevin Mutyaba
@@ -29,7 +29,7 @@ cert_chain:
   B+kZ9/4dAvmKkr2NPSoxBQtO7Rz0HDNLtjMxkXbQUWMDsGnB6Kk1WUBb/w3kQ9Ah
   JgIHF4cG
   -----END CERTIFICATE-----
-date: 2013-12-12 00:00:00.000000000 Z
+date: 2013-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: oj
@@ -51,14 +51,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
@@ -183,6 +183,7 @@ files:
 - AUTHORS
 - CHANGELOG.md
 - CONTRIBUTING.md
+- CONTRIBUTORS
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -212,6 +213,7 @@ files:
 - lib/yammer/configurable.rb
 - lib/yammer/error.rb
 - lib/yammer/http_adapter.rb
+- lib/yammer/oauth2_client.rb
 - lib/yammer/resources.rb
 - lib/yammer/resources/base.rb
 - lib/yammer/resources/group.rb
@@ -253,6 +255,7 @@ files:
 - spec/fixtures/users_following.json
 - spec/http_adapter_spec.rb
 - spec/mocks/attachment.txt
+- spec/oauth2_client_spec.rb
 - spec/resources/base_spec.rb
 - spec/resources/group_membership_spec.rb
 - spec/resources/group_spec.rb
@@ -317,6 +320,7 @@ test_files:
 - spec/fixtures/users_following.json
 - spec/http_adapter_spec.rb
 - spec/mocks/attachment.txt
+- spec/oauth2_client_spec.rb
 - spec/resources/base_spec.rb
 - spec/resources/group_membership_spec.rb
 - spec/resources/group_spec.rb