github_api 0.6.5 → 0.7.0

data/features/cassettes/repos/watching/watching.yml

@@ -0,0 +1,56 @@
+--- 
+http_interactions: 
+- request: 
+    method: get
+    uri: https://<BASIC_AUTH>@api.github.com/user/subscriptions/peter-murach/github?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.6.5
+      Content-Type: 
+      - application/json
+      Accept-Encoding: 
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response: 
+    status: 
+      code: 404
+      message: Not Found
+    headers: 
+      Server: 
+      - nginx
+      Date: 
+      - Sun, 09 Sep 2012 16:42:42 GMT
+      Content-Type: 
+      - application/json; charset=utf-8
+      Transfer-Encoding: 
+      - chunked
+      Connection: 
+      - keep-alive
+      Status: 
+      - 404 Not Found
+      X-Github-Media-Type: 
+      - github.beta
+      X-Content-Type-Options: 
+      - nosniff
+      X-Ratelimit-Limit: 
+      - "5000"
+      X-Ratelimit-Remaining: 
+      - "4997"
+      Cache-Control: 
+      - ""
+      Content-Encoding: 
+      - gzip
+    body: 
+      encoding: ASCII-8BIT
+      string: !binary |
+        H4sIAAAAAAAAA6tWyk0tLk5MT1WyUvLLL1Fwyy/NS1GqBQB8+Ys1FwAAAA==
+
+    http_version: 
+  recorded_at: Sun, 09 Sep 2012 16:42:42 GMT
+recorded_with: VCR 2.2.0

data/features/{repos → issues}/assignees.feature

@@ -1,14 +1,14 @@
-Feature: Contents API
+Feature: Assignees API
 
   Background:
-    Given I have "Github::Repos::Assignees" instance
+    Given I have "Github::Issues::Assignees" instance
 
   Scenario: List
 
     Given I want to list resources with the following params:
       | user         | repo   |
       | peter-murach | github |
-    When I make request within a cassette named "repos/assignees/list"
+    When I make request within a cassette named "issues/assignees/list"
     Then the response status should be 200
       And the response type should be JSON
       And the response should not be empty
@@ -18,7 +18,7 @@ Feature: Contents API
     Given I want to check resource with the following params:
       | user         | repo   | assignee |
       | peter-murach | github | wycats   |
-    When I make request within a cassette named "repos/assignees/ckeck_not"
+    When I make request within a cassette named "issues/assignees/ckeck_not"
     Then the response should be false
 
   Scenario: Check assignee belongs to repository
@@ -26,5 +26,5 @@ Feature: Contents API
     Given I want to check resource with the following params:
       | user         | repo   | assignee     |
       | peter-murach | github | peter-murach |
-    When I make request within a cassette named "repos/assignees/ckeck"
+    When I make request within a cassette named "issues/assignees/ckeck"
     Then the response should be true

data/features/repos/starring.feature

@@ -0,0 +1,50 @@
+Feature: Starring API
+
+  Background:
+    Given I have "Github::Repos::Starring" instance
+
+  Scenario: List
+
+    Given I want to list resources with the following params:
+      | user         | repo   |
+      | peter-murach | github |
+    When I make request within a cassette named "repos/starring/list"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Starred
+
+    Given I want to starred resources
+      And I pass the following request options:
+      | user   |
+      | wycats |
+    When I make request within a cassette named "repos/starring/starred"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Starring
+
+    Given I want to starring? resource with the following params:
+      | user         | repo   |
+      | peter-murach | github |
+    When I make request within a cassette named "repos/starring/starring"
+    Then the response should be false
+
+  Scenario: Star
+
+    Given I want to star resource with the following params:
+      | user         | repo   |
+      | peter-murach | github |
+    When I make request within a cassette named "repos/starring/star"
+    Then the response status should be 204
+
+  Scenario: Unstar
+
+    Given I want to unstar resource with the following params:
+      | user         | repo   |
+      | peter-murach | github |
+    When I make request within a cassette named "repos/starring/unstar"
+    Then the response status should be 204
+

data/features/repos/statuses.feature

@@ -0,0 +1,27 @@
+Feature: Statuses API
+
+  Background:
+    Given I have "Github::Repos::Statuses" instance
+
+  Scenario: List
+
+    Given I want to list resources with the following params:
+      | user         | repo   | sha                                      |
+      | peter-murach | github | cbdc6a5b133bf460d9c18292dda8fc54adf7e1b1 |
+    When I make request within a cassette named "repos/statuses/list"
+    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            | sha                                      |
+      | murek | github_api_test | 0106b45311ab15bf837c2830391b01cd17b33b61 |
+      And I pass the following request options:
+      | state   | target_url                         | description        |
+      | success | http://ci.example.com/peter-murach | Test by github_api |
+    When I make request within a cassette named "repos/statuses/create"
+    Then the response status should be 201
+      And the response type should be JSON
+      And the response should not be empty

data/features/repos/watching.feature

@@ -0,0 +1,50 @@
+Feature: Watching API
+
+  Background:
+    Given I have "Github::Repos::Watching" instance
+
+  Scenario: List
+
+    Given I want to list resources with the following params:
+      | user         | repo   |
+      | peter-murach | github |
+    When I make request within a cassette named "repos/watching/list"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Watched
+
+    Given I want to watched resources
+      And I pass the following request options:
+      | user   |
+      | wycats |
+    When I make request within a cassette named "repos/watching/watched"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Watching
+
+    Given I want to watching? resource with the following params:
+      | user         | repo   |
+      | peter-murach | github |
+    When I make request within a cassette named "repos/watching/watching"
+    Then the response should be false
+
+  Scenario: Watch
+
+    Given I want to watch resource with the following params:
+      | user         | repo   |
+      | peter-murach | github |
+    When I make request within a cassette named "repos/watching/watch"
+    Then the response status should be 204
+
+  Scenario: Unwatch
+
+    Given I want to unwatch resource with the following params:
+      | user         | repo   |
+      | peter-murach | github |
+    When I make request within a cassette named "repos/watching/unwatch"
+    Then the response status should be 204
+

data/lib/github_api/error/service_error.rb

@@ -1,10 +1,13 @@
 # encoding: utf-8
-require 'multi_json'
+# require 'multi_json'
+require 'github_api/jsonable'
 
 module Github
   # Raised when GitHub returns any of the HTTP status codes
   module Error
     class ServiceError < GithubError
+      include ::Github::Jsonable
+
       attr_reader :http_headers
 
       def initialize(response)
@@ -20,7 +23,7 @@ module Github
 
       def decode_body(body)
         if body.respond_to?(:to_str) && body.length >= 2
-           MultiJson.load(body, :symbolize_keys => true)
+           decode body, :symbolize_keys => true
         else
           body
         end

data/lib/github_api/issues.rb

@@ -5,6 +5,7 @@ module Github
     extend AutoloadHelper
 
     autoload_all 'github_api/issues',
+      :Assignees  => 'assignees',
       :Comments   => 'comments',
       :Events     => 'events',
       :Labels     => 'labels',
@@ -39,6 +40,11 @@ module Github
       super(options)
     end
 
+    # Access to Issues::Assignees API
+    def assignees
+      @assignees ||= ApiFactory.new 'Issues::Assignees'
+    end
+
     # Access to Issues::Comments API
     def comments
       @comments ||= ApiFactory.new 'Issues::Comments'

data/lib/github_api/{repos → issues}/assignees.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module Github
-  class Repos::Assignees < API
+  class Issues::Assignees < API
 
     # lists all the available assignees (owner + collaborators) 
     # to which issues may be assigned.
@@ -35,5 +35,5 @@ module Github
       false
     end
 
-  end # Repos::Assignees
+  end # Issues::Assignees
 end # Github

data/lib/github_api/jsonable.rb

@@ -0,0 +1,17 @@
+# encoding: utf-8
+
+require 'multi_json'
+
+module Github
+  module Jsonable
+    extend self
+
+    def decode(*args)
+      if MultiJson.respond_to?(:load)
+        MultiJson.load *args
+      else
+        MultiJson.decode *args
+      end
+    end
+  end
+end

data/lib/github_api/orgs/teams.rb

@@ -31,13 +31,13 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.get 'team-name'
+    #  github.orgs.teams.get 'team-id'
     #
-    def get(team_name, params={})
-      _validate_presence_of team_name
+    def get(team_id, params={})
+      _validate_presence_of team_id
       normalize! params
 
-      get_request("/teams/#{team_name}", params)
+      get_request("/teams/#{team_id}", params)
     end
     alias :find :get
 
@@ -83,18 +83,18 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.edit 'team-name',
+    #  github.orgs.teams.edit 'team-id',
     #    "name" => "new team name",
     #    "permission" => "push"
     #
-    def edit(team_name, params={})
-      _validate_presence_of team_name
+    def edit(team_id, params={})
+      _validate_presence_of team_id
       normalize! params
       filter! VALID_TEAM_PARAM_NAMES, params
       assert_valid_values(VALID_TEAM_PARAM_VALUES, params)
       assert_required_keys(%w[ name ], params)
 
-      patch_request("/teams/#{team_name}", params)
+      patch_request("/teams/#{team_id}", params)
     end
 
     # Delete a team
@@ -102,12 +102,12 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.delete 'team-name'
+    #  github.orgs.teams.delete 'team-id'
     #
-    def delete(team_name, params={})
-      _validate_presence_of team_name
+    def delete(team_id, params={})
+      _validate_presence_of team_id
       normalize! params
-      delete_request("/teams/#{team_name}", params)
+      delete_request("/teams/#{team_id}", params)
     end
     alias :remove :delete
 
@@ -116,14 +116,14 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.list_members 'team-name'
-    #  github.orgs.teams.list_members 'team-name' { |member| ... }
+    #  github.orgs.teams.list_members 'team-id'
+    #  github.orgs.teams.list_members 'team-id' { |member| ... }
     #
-    def list_members(team_name, params={})
-      _validate_presence_of team_name
+    def list_members(team_id, params={})
+      _validate_presence_of team_id
       normalize! params
 
-      response = get_request("/teams/#{team_name}/members", params)
+      response = get_request("/teams/#{team_id}/members", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -133,12 +133,12 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.team_member? 'team-name', 'user-name'
+    #  github.orgs.teams.team_member? 'team-id', 'user-name'
     #
-    def team_member?(team_name, member_name, params={})
-      _validate_presence_of team_name, member_name
+    def team_member?(team_id, member_name, params={})
+      _validate_presence_of team_id, member_name
       normalize! params
-      get_request("/teams/#{team_name}/members/#{member_name}", params)
+      get_request("/teams/#{team_id}/members/#{member_name}", params)
       true
     rescue Github::Error::NotFound
       false
@@ -149,12 +149,12 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.add_member 'team-name', 'user-name'
+    #  github.orgs.teams.add_member 'team-id', 'user-name'
     #
-    def add_member(team_name, member_name, params={})
-      _validate_presence_of team_name, member_name
+    def add_member(team_id, member_name, params={})
+      _validate_presence_of team_id, member_name
       normalize! params
-      put_request("/teams/#{team_name}/members/#{member_name}", params)
+      put_request("/teams/#{team_id}/members/#{member_name}", params)
     end
     alias :add_team_member :add_member
 
@@ -166,12 +166,12 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.remove_member 'team-name', 'member-name'
+    #  github.orgs.teams.remove_member 'team-id', 'member-name'
     #
-    def remove_member(team_name, member_name, params={})
-      _validate_presence_of team_name, member_name
+    def remove_member(team_id, member_name, params={})
+      _validate_presence_of team_id, member_name
       normalize! params
-      delete_request("/teams/#{team_name}/members/#{member_name}", params)
+      delete_request("/teams/#{team_id}/members/#{member_name}", params)
     end
     alias :remove_team_member :remove_member
 
@@ -179,13 +179,13 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.list_repos 'team-name'
+    #  github.orgs.teams.list_repos 'team-id'
     #
-    def list_repos(team_name, params={})
-      _validate_presence_of team_name
+    def list_repos(team_id, params={})
+      _validate_presence_of team_id
       normalize! params
 
-      response = get_request("/teams/#{team_name}/repos", params)
+      response = get_request("/teams/#{team_id}/repos", params)
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -195,12 +195,12 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.team_repo? 'team-name', 'user-name', 'repo-name'
+    #  github.orgs.teams.team_repo? 'team-id', 'user-name', 'repo-name'
     #
-    def team_repo?(team_name, user_name, repo_name, params={})
-      _validate_presence_of team_name, user_name, repo_name
+    def team_repo?(team_id, user_name, repo_name, params={})
+      _validate_presence_of team_id, user_name, repo_name
       normalize! params
-      get_request("/teams/#{team_name}/repos/#{user_name}/#{repo_name}", params)
+      get_request("/teams/#{team_id}/repos/#{user_name}/#{repo_name}", params)
       true
     rescue Github::Error::NotFound
       false
@@ -216,12 +216,12 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.add_repo 'team-name', 'user-name', 'repo-name'
+    #  github.orgs.teams.add_repo 'team-id', 'user-name', 'repo-name'
     #
-    def add_repo(team_name, user_name, repo_name, params={})
-      _validate_presence_of team_name, user_name, repo_name
+    def add_repo(team_id, user_name, repo_name, params={})
+      _validate_presence_of team_id, user_name, repo_name
       normalize! params
-      put_request("/teams/#{team_name}/repos/#{user_name}/#{repo_name}", params)
+      put_request("/teams/#{team_id}/repos/#{user_name}/#{repo_name}", params)
     end
     alias :add_repository :add_repo
 
@@ -233,12 +233,12 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.orgs.teams.remove_repo 'team-name', 'user-name', 'repo-name'
+    #  github.orgs.teams.remove_repo 'team-id', 'user-name', 'repo-name'
     #
-    def remove_repo(team_name, user_name, repo_name, params={})
-      _validate_presence_of team_name, user_name, repo_name
+    def remove_repo(team_id, user_name, repo_name, params={})
+      _validate_presence_of team_id, user_name, repo_name
       normalize! params
-      delete_request("/teams/#{team_name}/repos/#{user_name}/#{repo_name}", params)
+      delete_request("/teams/#{team_id}/repos/#{user_name}/#{repo_name}", params)
     end
     alias :remove_repository :remove_repo