github_api 0.10.1 → 0.10.2

data/README.md

@@ -26,7 +26,7 @@ Supports all the API methods(nearly 200). It's build in a modular way, that is,
 * Supports multithreaded environment.
 * Custom media types specification through 'media' parameter. [media](#media-types)
 * Request results caching (Status: TODO)
-* Fully tested with test coverage above 90% with over 1,500 specs and 800 features. [testing](#testing)
+* Fully tested with test coverage above 90% with over 1,600 specs and 900 features. [testing](#testing)
 
 ## Installation
 

data/features/cassettes/ratelimit/get.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<BASIC_AUTH>@api.github.com/rate_limit?access_token=<TOKEN>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.10.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Fri, 21 Jun 2013 21:31:45 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '5000'
+      X-Github-Media-Type:
+      - github.v3; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Etag:
+      - ! '"5d9e87bc7cbd54a123abd85f8d265f38"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Vary:
+      - Accept-Encoding
+      Content-Encoding:
+      - gzip
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA6tWKkosSVWyqlbKyczNLFGyMjUwMNBRKkrNTczMy8xLhwjU
+        1gIAWEFOoigAAAA=
+    http_version: !!null 
+  recorded_at: Fri, 21 Jun 2013 21:31:45 GMT
+recorded_with: VCR 2.4.0

data/features/cassettes/ratelimit/get_remaining.yml

@@ -0,0 +1,64 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://<BASIC_AUTH>@api.github.com/rate_limit?access_token=<TOKEN>
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.10.1
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Fri, 21 Jun 2013 21:37:35 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '5000'
+      X-Github-Media-Type:
+      - github.v3; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Etag:
+      - ! '"5d9e87bc7cbd54a123abd85f8d265f38"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Vary:
+      - Accept-Encoding
+      Content-Encoding:
+      - gzip
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        H4sIAAAAAAAAA6tWKkosSVWyqlbKyczNLFGyMjUwMNBRKkrNTczMy8xLhwjU
+        1gIAWEFOoigAAAA=
+    http_version: !!null 
+  recorded_at: Fri, 21 Jun 2013 21:37:35 GMT
+recorded_with: VCR 2.4.0

data/features/cassettes/repos/contents/create.yml

@@ -0,0 +1,60 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://<BASIC_AUTH>@api.github.com/repos/<USER>/github_api_test/contents/hello.rb?access_token=<TOKEN>
+    body:
+      encoding: UTF-8
+      string: ! '{"path":"hello.txt","content":"cHV0cyAncnVieSc=","message":"Initial
+        commit"}'
+    headers:
+      Accept:
+      - application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.10.1
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Sat, 22 Jun 2013 18:52:28 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 201 Created
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4996'
+      X-Github-Media-Type:
+      - github.v3; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '1591'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Etag:
+      - ! '"c2799bffff066a8a0426028d643e6ec3"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+    body:
+      encoding: US-ASCII
+      string: ! '{"content":{"name":"hello.rb","path":"hello.rb","sha":"25b0bef9e404bd2e3233de26b7ef8cbd86d0e913","size":11,"url":"https://api.github.com/repos/<USER>/github_api_test/contents/hello.rb?ref=master","html_url":"https://github.com/<USER>/github_api_test/blob/master/hello.rb","git_url":"https://api.github.com/repos/<USER>/github_api_test/git/blobs/25b0bef9e404bd2e3233de26b7ef8cbd86d0e913","type":"file","_links":{"self":"https://api.github.com/repos/<USER>/github_api_test/contents/hello.rb?ref=master","git":"https://api.github.com/repos/<USER>/github_api_test/git/blobs/25b0bef9e404bd2e3233de26b7ef8cbd86d0e913","html":"https://github.com/<USER>/github_api_test/blob/master/hello.rb"}},"commit":{"sha":"17944da9b9b1a143d141507480facd17263cf6d8","url":"https://api.github.com/repos/<USER>/github_api_test/git/commits/17944da9b9b1a143d141507480facd17263cf6d8","html_url":"https://github.com/<USER>/github_api_test/commits/17944da9b9b1a143d141507480facd17263cf6d8","author":{"name":"<USER>","email":"<EMAIL>","date":"2013-06-22T18:52:27Z"},"committer":{"name":"<USER>","email":"<EMAIL>","date":"2013-06-22T18:52:27Z"},"tree":{"sha":"68416c56385741b05dc93ffd00618b32a45b69e2","url":"https://api.github.com/repos/<USER>/github_api_test/git/trees/68416c56385741b05dc93ffd00618b32a45b69e2"},"message":"Initial
+        commit","parents":[{"sha":"8b1c1a560db750f0725f7a7778abfceda1c64103","url":"https://api.github.com/repos/<USER>/github_api_test/git/commits/8b1c1a560db750f0725f7a7778abfceda1c64103","html_url":"https://github.com/<USER>/github_api_test/commits/8b1c1a560db750f0725f7a7778abfceda1c64103"}]}}'
+    http_version: !!null 
+  recorded_at: Sat, 22 Jun 2013 18:52:28 GMT
+recorded_with: VCR 2.4.0

data/features/cassettes/repos/contents/delete.yml

@@ -0,0 +1,59 @@
+---
+http_interactions:
+- request:
+    method: delete
+    uri: https://<BASIC_AUTH>@api.github.com/repos/<USER>/github_api_test/contents/hello.rb?access_token=<TOKEN>&message=Delete%20hello.rb%20file&path=hello.txt&sha=25b0bef9e404bd2e3233de26b7ef8cbd86d0e913
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.10.1
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Sat, 22 Jun 2013 18:51:32 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4997'
+      X-Github-Media-Type:
+      - github.v3; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '933'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Etag:
+      - ! '"ab64a47801386e907c217a850d779f17"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: US-ASCII
+      string: ! '{"content":null,"commit":{"sha":"8b1c1a560db750f0725f7a7778abfceda1c64103","url":"https://api.github.com/repos/<USER>/github_api_test/git/commits/8b1c1a560db750f0725f7a7778abfceda1c64103","html_url":"https://github.com/<USER>/github_api_test/commits/8b1c1a560db750f0725f7a7778abfceda1c64103","author":{"name":"<USER>","email":"<EMAIL>","date":"2013-06-22T18:51:32Z"},"committer":{"name":"<USER>","email":"<EMAIL>","date":"2013-06-22T18:51:32Z"},"tree":{"sha":"f93e3a1a1525fb5b91020da86e44810c87a2d7bc","url":"https://api.github.com/repos/<USER>/github_api_test/git/trees/f93e3a1a1525fb5b91020da86e44810c87a2d7bc"},"message":"Delete
+        hello.rb file","parents":[{"sha":"4b3bda29b07b79de87042ab410c3a5794abbed7c","url":"https://api.github.com/repos/<USER>/github_api_test/git/commits/4b3bda29b07b79de87042ab410c3a5794abbed7c","html_url":"https://github.com/<USER>/github_api_test/commits/4b3bda29b07b79de87042ab410c3a5794abbed7c"}]}}'
+    http_version: !!null 
+  recorded_at: Sat, 22 Jun 2013 18:51:32 GMT
+recorded_with: VCR 2.4.0

data/features/cassettes/repos/contents/update.yml

@@ -0,0 +1,62 @@
+---
+http_interactions:
+- request:
+    method: put
+    uri: https://<BASIC_AUTH>@api.github.com/repos/<USER>/github_api_test/contents/hello.rb?access_token=<TOKEN>
+    body:
+      encoding: UTF-8
+      string: ! '{"path":"hello.rb","content":"cHV0cyAnaGVsbG8gcnVieSc=","message":"Update
+        commit","sha":"25b0bef9e404bd2e3233de26b7ef8cbd86d0e913"}'
+    headers:
+      Accept:
+      - application/vnd.github.v3+json,application/vnd.github.beta+json;q=0.5,application/json;q=0.1
+      Accept-Charset:
+      - utf-8
+      User-Agent:
+      - Github Ruby Gem 0.10.1
+      Content-Type:
+      - application/json
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Sat, 22 Jun 2013 19:02:17 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Connection:
+      - keep-alive
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4995'
+      X-Github-Media-Type:
+      - github.v3; format=json
+      X-Content-Type-Options:
+      - nosniff
+      Content-Length:
+      - '1590'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-RateLimit-Limit, X-RateLimit-Remaining, X-OAuth-Scopes, X-Accepted-OAuth-Scopes
+      Access-Control-Allow-Origin:
+      - ! '*'
+      Etag:
+      - ! '"e50acd6b435b2ea531988ed19aedc1b2"'
+      Cache-Control:
+      - max-age=0, private, must-revalidate
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: US-ASCII
+      string: ! '{"content":{"name":"hello.rb","path":"hello.rb","sha":"9ed559bc7c227577c734a1d71e84646058c28ab7","size":17,"url":"https://api.github.com/repos/<USER>/github_api_test/contents/hello.rb?ref=master","html_url":"https://github.com/<USER>/github_api_test/blob/master/hello.rb","git_url":"https://api.github.com/repos/<USER>/github_api_test/git/blobs/9ed559bc7c227577c734a1d71e84646058c28ab7","type":"file","_links":{"self":"https://api.github.com/repos/<USER>/github_api_test/contents/hello.rb?ref=master","git":"https://api.github.com/repos/<USER>/github_api_test/git/blobs/9ed559bc7c227577c734a1d71e84646058c28ab7","html":"https://github.com/<USER>/github_api_test/blob/master/hello.rb"}},"commit":{"sha":"a204cd99a174edb4ff8b7c561b7356959421f81c","url":"https://api.github.com/repos/<USER>/github_api_test/git/commits/a204cd99a174edb4ff8b7c561b7356959421f81c","html_url":"https://github.com/<USER>/github_api_test/commits/a204cd99a174edb4ff8b7c561b7356959421f81c","author":{"name":"<USER>","email":"<EMAIL>","date":"2013-06-22T19:02:17Z"},"committer":{"name":"<USER>","email":"<EMAIL>","date":"2013-06-22T19:02:17Z"},"tree":{"sha":"1c6d09bb0aaa44e285234d5e6572b54232079a58","url":"https://api.github.com/repos/<USER>/github_api_test/git/trees/1c6d09bb0aaa44e285234d5e6572b54232079a58"},"message":"Update
+        commit","parents":[{"sha":"17944da9b9b1a143d141507480facd17263cf6d8","url":"https://api.github.com/repos/<USER>/github_api_test/git/commits/17944da9b9b1a143d141507480facd17263cf6d8","html_url":"https://github.com/<USER>/github_api_test/commits/17944da9b9b1a143d141507480facd17263cf6d8"}]}}'
+    http_version: !!null 
+  recorded_at: Sat, 22 Jun 2013 19:02:17 GMT
+recorded_with: VCR 2.4.0

data/features/issues.feature

@@ -15,12 +15,12 @@ Feature: Issues API
 
   Scenario: List on repository
 
-    Given I want to list_repo resources with the following params:
+    Given I want to list resources with the following params:
       | user          | repo   |
       | peter-murach  | github |
     And I pass the following request options:
-      | state  | assignee | sort    | direction |
-      | closed | none     | created | asc       |
+      | state  | assignee | sort    | direction | user         | repo   |
+      | closed | none     | created | asc       | peter-murach | github |
     When I make request within a cassette named "issues/list/repo"
     Then the response status should be 200
       And the response type should be JSON

data/features/pagination.feature

@@ -83,12 +83,12 @@ Feature: Github API pagination
   Scenario: Navigating resource links with query parameters
 
     Given I have "Github::Issues" instance
-      And I want to list_repo resources with the following params:
+      And I want to list resources with the following params:
         | user   | repo |
         | wycats | thor |
       And I pass the following request options:
-        | state  | per_page |
-        | closed | 50       |
+        | state  | per_page | user   | repo |
+        | closed | 50       | wycats | thor |
     When I make request within a cassette named "pagination/issues/list/first"
     Then the response status should be 200
       And the response next link should contain:
@@ -100,12 +100,12 @@ Feature: Github API pagination
 
   Scenario: Navigate to Next page
     Given I have "Github::Issues" instance
-      And I want to list_repo resources with the following params:
+      And I want to list resources with the following params:
         | user   | repo |
         | wycats | thor |
       And I pass the following request options:
-        | state  | per_page |
-        | closed | 50       |
+        | state  | per_page | user   | repo |
+        | closed | 50       | wycats | thor |
     When I make request within a cassette named "pagination/issues/list/first"
       And I request next page within a cassette named "pagination/issues/list/next"
     Then the response status should be 200
@@ -125,12 +125,12 @@ Feature: Github API pagination
   Scenario: Navigate to Last page
 
     Given I have "Github::Issues" instance
-      And I want to list_repo resources with the following params:
+      And I want to list resources with the following params:
         | user   | repo |
         | wycats | thor |
       And I pass the following request options:
-        | state  | per_page |
-        | closed | 50       |
+        | state  | per_page | user   | repo |
+        | closed | 50       | wycats | thor |
     When I make request within a cassette named "pagination/issues/list/first"
       And I request last page within a cassette named "pagination/issues/list/last"
     Then the response status should be 200
@@ -144,12 +144,12 @@ Feature: Github API pagination
   Scenario: Navigate to Previous page
 
     Given I have "Github::Issues" instance
-      And I want to list_repo resources with the following params:
+      And I want to list resources with the following params:
         | user   | repo |
         | wycats | thor |
       And I pass the following request options:
-        | state  | per_page | page |
-        | closed | 50       | 4    |
+        | state  | per_page | page | user   | repo |
+        | closed | 50       | 4    | wycats | thor |
     When I make request within a cassette named "pagination/issues/list/last"
       And I request prev page within a cassette named "pagination/issues/list/prev"
     Then the response status should be 200

data/features/rate_limit.feature

@@ -0,0 +1,16 @@
+Feature: Ratelimit API
+
+  Background:
+    Given I have "Github::API" instance
+
+  Scenario: Get ratelimit
+
+    Given I want to ratelimit resource
+    When I make request within a cassette named "ratelimit/get"
+    Then the response should be 5000
+
+  Scenario: Get ratelimit remaining
+
+    Given I want to ratelimit_remaining resource
+    When I make request within a cassette named "ratelimit/get_remaining"
+    Then the response should be 5000

data/features/repos/contents.feature

@@ -23,6 +23,45 @@ Feature: Contents API
       And the response type should be JSON
       And the response should not be empty
 
+  Scenario: Create a file
+
+    Given I want create resource with the following params:
+      | user  | repo            | path     |
+      | murek | github_api_test | hello.rb |
+      And I pass the following request options:
+        | path      | content     | message        |
+        | hello.rb | puts 'ruby' | Initial commit |
+    When I make request within a cassette named "repos/contents/create"
+    Then the response status should be 201
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Update a file
+
+    Given I want create resource with the following params:
+      | user  | repo            | path     |
+      | murek | github_api_test | hello.rb |
+      And I pass the following request options:
+        | path     | content           | message       | sha                                      |
+        | hello.rb | puts 'hello ruby' | Update commit | 25b0bef9e404bd2e3233de26b7ef8cbd86d0e913 |
+    When I make request within a cassette named "repos/contents/update"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Delete a file
+
+    Given I want delete resource with the following params:
+      | user  | repo            | path     |
+      | murek | github_api_test | hello.rb |
+      And I pass the following request options:
+        | path      | message              | sha                                      |
+        | hello.txt | Delete hello.rb file | 25b0bef9e404bd2e3233de26b7ef8cbd86d0e913 |
+    When I make request within a cassette named "repos/contents/delete"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
   Scenario: Archive
 
     Given I want archive resource with the following params: