github_api 0.8.4 → 0.8.5

data/README.md

@@ -21,7 +21,8 @@ Supports all the API methods(nearly 200). It's build in a modular way, that is,
 * Easy error handling.
 * Custom mime types specification (Status: TODO)
 * Flexible arguments parsing (Status: In progress).
-* Fully tested with test coverage above 90% with over 1,200 specs and 500 features.
+* Request results caching (Status: TODO)
+* Fully tested with test coverage above 90% with over 1,300 specs and 700 features.
 
 ## Installation
 

data/features/cassettes/issues/comments/create.yml

@@ -0,0 +1,55 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://<BASIC_AUTH>@api.github.com/repos/<USER>/github_api_test/issues/1/comments?access_token=<TOKEN>
+    body:
+      encoding: UTF-8
+      string: ! '{"body":"No worries this should be fixed now."}'
+    headers:
+      Accept:
+      - application/jsonapplication/vnd.github+json;q=0.7application/vnd.github.v3.raw+json;q=0.5application/vnd.github.beta.raw+json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.8.4
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 25 Dec 2012 20:25:10 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 201 Created
+      Content-Length:
+      - '1210'
+      X-Content-Type-Options:
+      - nosniff
+      Location:
+      - https://api.github.com/repos/<USER>/github_api_test/issues/comments/11675857
+      X-Github-Media-Type:
+      - github.beta
+      Etag:
+      - ! '"13bdd542c6974f25226ac2c7f03207d8"'
+      X-Ratelimit-Limit:
+      - '5000'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      X-Ratelimit-Remaining:
+      - '4999'
+    body:
+      encoding: US-ASCII
+      string: ! '{"issue_url":"https://api.github.com/repos/<USER>/github_api_test/issues/5020363","body":"No
+        worries this should be fixed now.","updated_at":"2012-12-25T20:25:10Z","url":"https://api.github.com/repos/<USER>/github_api_test/issues/comments/11675857","created_at":"2012-12-25T20:25:10Z","user":{"type":"User","starred_url":"https://api.github.com/users/<USER>/starred{/owner}{/repo}","gists_url":"https://api.github.com/users/<USER>/gists{/gist_id}","repos_url":"https://api.github.com/users/<USER>/repos","followers_url":"https://api.github.com/users/<USER>/followers","following_url":"https://api.github.com/users/<USER>/following","received_events_url":"https://api.github.com/users/<USER>/received_events","organizations_url":"https://api.github.com/users/<USER>/orgs","url":"https://api.github.com/users/<USER>","gravatar_id":"80cbc0fc6c03d43f495b2342b31fe4fa","avatar_url":"https://secure.gravatar.com/avatar/80cbc0fc6c03d43f495b2342b31fe4fa?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png","login":"<USER>","subscriptions_url":"https://api.github.com/users/<USER>/subscriptions","id":1223156,"events_url":"https://api.github.com/users/<USER>/events{/privacy}"},"id":11675857}'
+    http_version: !!null 
+  recorded_at: Tue, 25 Dec 2012 20:25:10 GMT
+recorded_with: VCR 2.3.0

data/features/cassettes/issues/comments/delete.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://<BASIC_AUTH>@api.github.com/repos/<USER>/github_api_test/issues/comments/11675857?access_token=<TOKEN>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/jsonapplication/vnd.github+json;q=0.7application/vnd.github.v3.raw+json;q=0.5application/vnd.github.beta.raw+json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.8.4
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 25 Dec 2012 20:33:40 GMT
+      Connection:
+      - keep-alive
+      Status:
+      - 204 No Content
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Content-Type-Options:
+      - nosniff
+      Cache-Control:
+      - ''
+      X-Github-Media-Type:
+      - github.beta
+      X-Ratelimit-Remaining:
+      - '4996'
+    body:
+      encoding: US-ASCII
+      string: ''
+    http_version: !!null 
+  recorded_at: Tue, 25 Dec 2012 20:33:40 GMT
+recorded_with: VCR 2.3.0

data/features/cassettes/issues/comments/edit.yml

@@ -0,0 +1,53 @@
+---
+http_interactions:
+- request:
+    method: patch
+    uri: https://<BASIC_AUTH>@api.github.com/repos/<USER>/github_api_test/issues/comments/11675857?access_token=<TOKEN>
+    body:
+      encoding: UTF-8
+      string: ! '{"body":"No worries this should be fixed now."}'
+    headers:
+      Accept:
+      - application/jsonapplication/vnd.github+json;q=0.7application/vnd.github.v3.raw+json;q=0.5application/vnd.github.beta.raw+json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.8.4
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 25 Dec 2012 20:29:42 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Github-Media-Type:
+      - github.beta
+      Etag:
+      - ! '"2f5b3d8fd30ad241cdf8be89ea191a54"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Content-Length:
+      - '1210'
+      X-Content-Type-Options:
+      - nosniff
+      X-Ratelimit-Remaining:
+      - '4997'
+      X-Ratelimit-Limit:
+      - '5000'
+    body:
+      encoding: US-ASCII
+      string: ! '{"issue_url":"https://api.github.com/repos/<USER>/github_api_test/issues/5020363","body":"No
+        worries this should be fixed now.","updated_at":"2012-12-25T20:25:10Z","url":"https://api.github.com/repos/<USER>/github_api_test/issues/comments/11675857","created_at":"2012-12-25T20:25:10Z","user":{"type":"User","received_events_url":"https://api.github.com/users/<USER>/received_events","avatar_url":"https://secure.gravatar.com/avatar/80cbc0fc6c03d43f495b2342b31fe4fa?d=https://a248.e.akamai.net/assets.github.com%2Fimages%2Fgravatars%2Fgravatar-user-420.png","gists_url":"https://api.github.com/users/<USER>/gists{/gist_id}","followers_url":"https://api.github.com/users/<USER>/followers","following_url":"https://api.github.com/users/<USER>/following","organizations_url":"https://api.github.com/users/<USER>/orgs","starred_url":"https://api.github.com/users/<USER>/starred{/owner}{/repo}","url":"https://api.github.com/users/<USER>","gravatar_id":"80cbc0fc6c03d43f495b2342b31fe4fa","repos_url":"https://api.github.com/users/<USER>/repos","login":"<USER>","events_url":"https://api.github.com/users/<USER>/events{/privacy}","subscriptions_url":"https://api.github.com/users/<USER>/subscriptions","id":1223156},"id":11675857}'
+    http_version: !!null 
+  recorded_at: Tue, 25 Dec 2012 20:29:42 GMT
+recorded_with: VCR 2.3.0

data/features/issues/comments.feature

@@ -35,3 +35,38 @@ Feature: Issues Comments API
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
+
+  Scenario: Create
+
+    Given I want to create resource with the following params:
+      | user  | repo            | issue_id |
+      | murek | github_api_test | 1        |
+    And I pass the following request options:
+      | body                                 |
+      | No worries this should be fixed now. |
+    When I make request within a cassette named "issues/comments/create" and match on method
+    Then the response status should be 201
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Edit
+
+    Given I want to edit resource with the following params:
+      | user  | repo            | comment_id |
+      | murek | github_api_test | 11675857   |
+    And I pass the following request options:
+      | body                                 |
+      | No worries this should be fixed now. |
+    When I make request within a cassette named "issues/comments/edit" and match on method
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Delete
+
+    Given I want to delete resource with the following params:
+      | user  | repo            | comment_id |
+      | murek | github_api_test | 11675857   |
+    When I make request within a cassette named "issues/comments/delete" and match on method
+    Then the response status should be 204
+

data/features/issues/labels.feature

@@ -57,7 +57,7 @@ Feature: Labels API
     And I pass the following request options:
       | name | color  |
       | api  | FFFFFF |
-    When I make request within a cassette named "issues/labels/create" and match on method, host, path
+    When I make request within a cassette named "issues/labels/create" and match on method
     Then the response status should be 201
       And the response type should be JSON
       And the response should not be empty
@@ -70,7 +70,7 @@ Feature: Labels API
     And I pass the following request options:
       | name | color  |
       | api  | 000000 |
-    When I make request within a cassette named "issues/labels/update" and match on method, host, path
+    When I make request within a cassette named "issues/labels/update" and match on method
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -80,6 +80,6 @@ Feature: Labels API
     Given I want to delete resource with the following params:
       | user  | repo            | label_name |
       | murek | github_api_test | api        |
-    When I make request within a cassette named "issues/labels/delete" and match on method, host, path
+    When I make request within a cassette named "issues/labels/delete" and match on method
     Then the response status should be 204
 

data/features/issues/milestones.feature

@@ -34,7 +34,7 @@ Feature: Milestones API
     And I pass the following request options:
       | title   | state | description       |
       | fix-all | open  | fixing all issues |
-    When I make request within a cassette named "issues/milestones/create" and match on method, host, path
+    When I make request within a cassette named "issues/milestones/create" and match on method
     Then the response status should be 201
       And the response type should be JSON
       And the response should not be empty
@@ -47,7 +47,7 @@ Feature: Milestones API
     And I pass the following request options:
       | state  |
       | closed |
-    When I make request within a cassette named "issues/milestones/update" and match on method, host, path
+    When I make request within a cassette named "issues/milestones/update" and match on method
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -57,6 +57,6 @@ Feature: Milestones API
     Given I want to delete resource with the following params:
       | user  | repo            | milestone_id |
       | murek | github_api_test | 1            |
-    When I make request within a cassette named "issues/milestones/delete" and match on method, host, path
+    When I make request within a cassette named "issues/milestones/delete" and match on method
     Then the response status should be 204
 

data/lib/github_api/authorizations.rb

@@ -7,6 +7,10 @@ module Github
       scopes
       add_scopes
       remove_scopes
+      note
+      note_url
+      client_id
+      client_secret
     ].freeze
 
     # Creates new OAuth Authorizations API
@@ -82,12 +86,12 @@ module Github
     def update(authorization_id, params={})
       _check_if_authenticated
       assert_presence_of authorization_id
-
       normalize! params
       filter! VALID_AUTH_PARAM_NAMES, params
 
       patch_request("/authorizations/#{authorization_id}", params)
     end
+    alias :edit :update
 
     # Delete an authorization
     #
@@ -97,9 +101,7 @@ module Github
     def delete(authorization_id, params={})
       _check_if_authenticated
       assert_presence_of authorization_id
-
       normalize! params
-      filter! VALID_AUTH_PARAM_NAMES, params
 
       delete_request("/authorizations/#{authorization_id}", params)
     end

data/lib/github_api/repos.rb

@@ -134,7 +134,7 @@ module Github
       assert_presence_of user_name, repo_name, branch
       normalize! params
 
-      get_request("repos/#{user_name}/#{repo_name}/branches/#{branch}", params)
+      get_request("/repos/#{user_name}/#{repo_name}/branches/#{branch}", params)
     end
 
     # Create a new repository for the autheticated user.

data/lib/github_api/version.rb

@@ -4,7 +4,7 @@ module Github
   module VERSION
     MAJOR = 0
     MINOR = 8
-    PATCH = 4
+    PATCH = 5
     BUILD = nil
 
     STRING = [MAJOR, MINOR, PATCH, BUILD].compact.join('.');

data/spec/github/issues/comments/create_spec.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Issues::Comments, '#create' do
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+  let(:issue_id) { 1 }
+  let(:inputs) { { 'body' => 'a new comment' } }
+  let(:request_path) { "/repos/#{user}/#{repo}/issues/#{issue_id}/comments" }
+
+  before {
+    stub_post(request_path).with(:body => inputs).
+      to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  context "resouce created" do
+    let(:body) { fixture('issues/comment.json') }
+    let(:status) { 201 }
+
+    it "should fail to create resource if 'body' input is missing" do
+      expect {
+        subject.create user, repo, issue_id, inputs.except('body')
+      }.to raise_error(Github::Error::RequiredParams)
+    end
+
+    it "should create resource successfully" do
+      subject.create user, repo, issue_id, inputs
+      a_post(request_path).with(inputs).should have_been_made
+    end
+
+    it "should return the resource" do
+      comment = subject.create user, repo, issue_id, inputs
+      comment.should be_a Hashie::Mash
+    end
+
+    it "should get the comment information" do
+      comment = subject.create user, repo, issue_id, inputs
+      comment.user.login.should == 'octocat'
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.create user, repo, issue_id, inputs }
+  end
+
+end # create

data/spec/github/issues/comments/delete_spec.rb

@@ -0,0 +1,36 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Issues::Comments, '#delete' do
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+  let(:comment_id) { '1' }
+  let(:request_path) { "/repos/#{user}/#{repo}/issues/comments/#{comment_id}" }
+
+  before {
+    stub_delete(request_path).to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  context "resouce deleted" do
+    let(:body) { fixture('issues/comment.json') }
+    let(:status) { 204 }
+
+    it "should fail to delete resource if comment_id is missing" do
+      expect { subject.delete user, repo, nil }.to raise_error(ArgumentError)
+    end
+
+    it "should create resource successfully" do
+      subject.delete user, repo, comment_id
+      a_delete(request_path).should have_been_made
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.delete user, repo, comment_id }
+  end
+
+end # delete

data/spec/github/issues/comments/edit_spec.rb

@@ -0,0 +1,50 @@
+# encoding: utf-8
+
+require 'spec_helper'
+
+describe Github::Issues::Comments, '#edit' do
+  let(:user)   { 'peter-murach' }
+  let(:repo)   { 'github' }
+  let(:comment_id) { 1 }
+  let(:inputs) { { 'body' => 'a new comment' } }
+  let(:request_path) { "/repos/#{user}/#{repo}/issues/comments/#{comment_id}" }
+
+  before {
+    stub_patch(request_path).with(:body => inputs).
+      to_return(:body => body, :status => status,
+      :headers => {:content_type => "application/json; charset=utf-8"})
+  }
+
+  after { reset_authentication_for(subject) }
+
+  context "resouce edited" do
+    let(:body) { fixture('issues/comment.json') }
+    let(:status) { 201 }
+
+    it "should fail to create resource if 'body' input is missing" do
+      expect {
+        subject.edit user, repo, comment_id, inputs.except('body')
+      }.to raise_error(Github::Error::RequiredParams)
+    end
+
+    it "should create resource successfully" do
+      subject.edit user, repo, comment_id, inputs
+      a_patch(request_path).with(inputs).should have_been_made
+    end
+
+    it "should return the resource" do
+      comment = subject.edit user, repo, comment_id, inputs
+      comment.should be_a Hashie::Mash
+    end
+
+    it "should get the comment information" do
+      comment = subject.edit user, repo, comment_id, inputs
+      comment.user.login.should == 'octocat'
+    end
+  end
+
+  it_should_behave_like 'request failure' do
+    let(:requestable) { subject.edit user, repo, comment_id, inputs }
+  end
+
+end # edit