Merge branch 'master' of git://github.com/jeffrwells/github into jeffrwells-master

piotrmurach · piotrmurach · commit 765d28624fad · 2014-06-29T17:29:35.000+01:00
diff --git a/lib/github_api/client/authorizations/app.rb b/lib/github_api/client/authorizations/app.rb
@@ -65,6 +65,28 @@ def delete(*args)
     alias :remove :delete
     alias :revoke :delete
 
+    # Check if an access token is a valid authorization for an application
+    # 
+    # @example
+    #   github - Github.new basic_auth: "client_id:client_secret"
+    #   github.oauth.app.check 'client_id', 'access-token'
+    # @api public
+
+    def check(*args)
+      raise_authentication_error unless authenticated?
+      params = arguments(args, required: [:client_id, :access_token]).params
+      
+      if client_id
+        begin
+          get_request("/applications/#{client_id}/tokens/#{access_token}", params)
+        rescue Github::Error::NotFound => e
+          nil
+        end
+      else
+        raise raise_app_authentication_error
+      end
+    end
+
     protected
 
     def raise_app_authentication_error
diff --git a/spec/fixtures/auths/check.json b/spec/fixtures/auths/check.json
@@ -0,0 +1,36 @@
+{
+  "id": 1,
+  "url": "https://api.github.com/authorizations/1",
+  "scopes": [
+    "public_repo"
+  ],
+  "token": "abc123",
+  "app": {
+    "url": "http://my-github-app.com",
+    "name": "my github app",
+    "client_id": "abcde12345fghij67890"
+  },
+  "note": "optional note",
+  "note_url": "http://optional/note/url",
+  "updated_at": "2011-09-06T20:39:23Z",
+  "created_at": "2011-09-06T17:26:27Z",
+  "user": {
+    "login": "octocat",
+    "id": 1,
+    "avatar_url": "https://github.com/images/error/octocat_happy.gif",
+    "gravatar_id": "somehexcode",
+    "url": "https://api.github.com/users/octocat",
+    "html_url": "https://github.com/octocat",
+    "followers_url": "https://api.github.com/users/octocat/followers",
+    "following_url": "https://api.github.com/users/octocat/following{/other_user}",
+    "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/octocat/subscriptions",
+    "organizations_url": "https://api.github.com/users/octocat/orgs",
+    "repos_url": "https://api.github.com/users/octocat/repos",
+    "events_url": "https://api.github.com/users/octocat/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/octocat/received_events",
+    "type": "User",
+    "site_admin": false
+  }
+}
diff --git a/spec/github/authorizations/app/check_spec.rb b/spec/github/authorizations/app/check_spec.rb
@@ -0,0 +1,70 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Authorizations::App, '#check' do
+  let(:basic_auth) { 'login:password' }
+  let(:host)       { "https://#{basic_auth}@api.github.com" }
+  let(:request_path) { "/applications/#{client_id}/tokens/#{access_token}" }
+  let(:client_id) { 1 }
+  let(:access_token) { 'abc123' }
+
+  before {
+    subject.basic_auth = basic_auth
+
+    stub_get(request_path, host).to_return(body: body, status: status,
+      headers: {content_type: 'application/json; charset=utf-8'})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  context 'when app makes a request' do
+    let(:body)      { "" }
+    let(:status)    { 200 }
+
+    it "checks resource successfully" do
+      subject.check client_id, access_token
+      a_get(request_path, host).should have_been_made
+    end
+
+    it "fails without client_id" do
+      expect { subject.check }.to raise_error(ArgumentError)
+    end
+
+    it "fails without access_token" do
+      expect {subject.check(client_id)}.to raise_error(ArgumentError)
+    end
+
+  end
+
+  context 'when app checks a token that is valid' do
+    let(:body)      { fixture('auths/check.json') }
+    let(:status)    { 200 }
+
+
+    it "returns the resource" do
+      authorization = subject.check client_id, access_token
+      authorization.should be_a Github::ResponseWrapper
+    end
+
+    it "gets the authorization information" do
+      authorization = subject.check client_id, access_token
+      authorization.token.should == 'abc123'
+    end
+  end
+
+  context 'when app checks a token that is not valid' do
+    let(:body)      { '' }
+    let(:status)    { 404 }
+    
+    it "does not raise error for expected 404" do
+      expect { subject.check client_id, access_token }.to_not raise_error
+    end
+
+    it "returns nil" do
+      authorization = subject.check client_id, access_token
+      authorization.should be_nil
+    end
+
+  end
+end # check
