github_api 0.8.1 → 0.8.2

data/features/gitignore.feature

@@ -0,0 +1,37 @@
+Feature: Markdown API
+
+  Background:
+    Given I have "Github::Gitignore" instance
+
+  Scenario: List available templates
+
+    Given I want to list resources
+    When I make request within a cassette named "gitignore/list"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should have 76 items
+      And the response should contain Ruby
+      And the response should contain Rails
+
+  Scenario: Get a single template
+
+    Given I want to get resource with the following params:
+      | template_name |
+      | Ruby |
+    When I make request within a cassette named "gitignore/get"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should have 2 items
+
+  Scenario: Get a raw contents
+
+    Given I want to get resource with the following params:
+      | template_name |
+      | Ruby          |
+    And I pass the following request options:
+      | mime                       |
+      | application/vnd.github.raw |
+    When I make request within a cassette named "gitignore/get_raw"
+    Then the response status should be 200
+      And the response type should be RAW
+      And the response should contain InstalledFiles

data/features/issues/comments.feature

@@ -0,0 +1,37 @@
+Feature: Issues Comments API
+
+  Background:
+    Given I have "Github::Issues::Comments" instance
+
+  Scenario: List in a repository
+
+    Given I want to list resources with the following params:
+      | user         | repo   |
+      | peter-murach | github |
+    When I make request within a cassette named "issues/comments/list_repo"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: List on an issue
+
+    Given I want to list resources with the following params:
+      | user         | repo   |
+      | peter-murach | github |
+      And I pass the following request options:
+        | issue_id |
+        | 61       |
+    When I make request within a cassette named "issues/comments/list_issue"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
+  Scenario: Get a single comment
+
+    Given I want to get resource with the following params:
+      | user         | repo   | comment_id |
+      | peter-murach | github | 10321836   |
+    When I make request within a cassette named "issues/comments/get"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty

data/features/pull_requests/comments.feature

@@ -0,0 +1,27 @@
+Feature: Pull Requests Comments API
+
+  Background:
+    Given I have "Github::PullRequests::Comments" instance
+
+  Scenario: List in a repository
+
+    Given I want to list resources with the following params:
+      | user          | repo   |
+      | peter-murach  | github |
+    When I make request within a cassette named "pull_requests/comments/list_repo"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should have 0 items
+
+  Scenario: List on a pull request
+
+    Given I want to list resources with the following params:
+      | user          | repo   |
+      | peter-murach  | github |
+      And I pass the following request options:
+        | request_id |
+        | 62         |
+    When I make request within a cassette named "pull_requests/comments/list_pull"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should have 0 items

data/features/repos.feature

@@ -44,6 +44,14 @@ Feature: Repositories API
       And the response type should be JSON
       And the response should not be empty
 
+  Scenario: All repositories
+
+    Given I want to list resources
+    When I make request within a cassette named "repos/list_repos"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
   Scenario: Get a repository
 
     Given I want to get resource with the following params:

data/features/step_definitions/common_steps.rb

@@ -42,6 +42,8 @@ Then /^the response type should be (.*)$/ do |type|
     @response.content_type.should =~ /application\/json/
   when 'html'
     @response.content_type.should =~ /text\/html/
+  when 'raw'
+    @response.content_type.should =~ /raw/
   end
 end
 

data/features/users.feature

@@ -3,6 +3,14 @@ Feature: Users API
   Background:
     Given I have "Github::Users" instance
 
+  Scenario: List all users
+
+    Given I want to list resources
+    When I make request within a cassette named "users/all"
+    Then the response status should be 200
+      And the response type should be JSON
+      And the response should not be empty
+
   Scenario: Get authenticated user
 
     Given I want to get resource

data/lib/github_api.rb

@@ -71,6 +71,7 @@ module Github
     :Issues          => 'issues',
     :Gists           => 'gists',
     :GitData         => 'git_data',
+    :Gitignore       => 'gitignore',
     :Orgs            => 'orgs',
     :PullRequests    => 'pull_requests',
     :Users           => 'users',

data/lib/github_api/client.rb

@@ -18,6 +18,11 @@ module Github
       @gists ||= ApiFactory.new 'Gists', options
     end
 
+    def gitignore(options = {})
+      @gitignore ||= ApiFactory.new 'Gitignore', options
+    end
+    alias :git_ignore :gitignore
+
     # The Git Database API gives you access to read and write raw Git objects
     # to your Git database on GitHub and to list and update your references
     # (branch heads and tags).

data/lib/github_api/git_data/tags.rb

@@ -60,12 +60,12 @@ module Github
     # = Examples
     #  github = Github.new
     #  github.git_data.tags.create 'user-name', 'repo-name',
-    #    "tag" =>  "v0.0.1",
+    #    "tag" => "v0.0.1",
     #    "message" => "initial version\n",
-    #    "type": "commit",
-    #    "object": "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
+    #    "type" => "commit",
+    #    "object" => "c3d0be41ecbe669545ee3e94d31ed9a4bc91ee3c",
     #    "tagger" => {
-    #      "name" =>  "Scott Chacon",
+    #      "name" => "Scott Chacon",
     #      "email" => "schacon@gmail.com",
     #      "date" => "2011-06-17T14:53:3"
     #    }

data/lib/github_api/gitignore.rb

@@ -0,0 +1,56 @@
+# encoding: utf-8
+
+module Github
+
+  # When you create a new GitHub repository via the API, you can specify a
+  # .gitignore template to apply to the repository upon creation.
+  class Gitignore < API
+
+    # Creates new Gitignore API
+    def initialize(options = {})
+      super(options)
+    end
+
+    # List all templates available to pass as an option when creating a repository.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.gitignore.list
+    #  github.gitignore.list { |template| ... }
+    #
+    def list(*args)
+      params = args.extract_options!
+      normalize! params
+
+      response = get_request("/gitignore/templates", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Get a single template
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.gitignore.get "template-name"
+    #
+    # Use the raw media type to get the raw contents.
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.gitignore.get "template-name", mime: 'applicatin/vnd.github.raw'
+    #
+    def get(name, params={})
+      normalize! params
+      assert_presence_of name
+
+      if (mime_type = params.delete('mime'))
+        options = { :raw => true, :headers => {'Accept' => mime_type} }
+      end
+
+      get_request("/gitignore/templates/#{name}", params, options || {})
+    end
+    alias :find :get
+
+  end # Gitignore
+end # Github

data/lib/github_api/issues/comments.rb

@@ -18,17 +18,33 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.issues.comments.all 'user-name', 'repo-name', 'issue-id'
-    #  github.issues.comments.all 'user-name', 'repo-name', 'issue-id' {|com| .. }
+    #  github.issues.comments.all 'user-name', 'repo-name', issue_id: 'id'
+    #  github.issues.comments.all 'user-name', 'repo-name', issue_id: 'id' {|com| .. }
     #
-    def list(user_name, repo_name, issue_id, params={})
+    # List comments in a repository
+    #
+    # = Parameters
+    # * <tt>:sort</tt>      - Optional string, <tt>created</tt> or <tt>updated</tt>
+    # * <tt>:direction</tt> - Optional string, <tt>asc</tt> or <tt>desc</tt>.
+    #                         Ignored with sort parameter.
+    # * <tt>:since</tt>     - Optional string of a timestamp in ISO 8601
+    #                         format: YYYY-MM-DDTHH:MM:SSZ
+    #
+    # = Examples
+    #  github = Github.new
+    #  github.issues.comments.all 'user-name', 'repo-name'
+    #  github.issues.comments.all 'user-name', 'repo-name' {|com| .. }
+    #
+    def list(user_name, repo_name, params={})
       set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, issue_id
-
+      assert_presence_of user, repo
       normalize! params
-      # _merge_mime_type(:issue_comment, params)
 
-      response = get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
+      response = if (issue_id = params.delete('issue_id'))
+        get_request("/repos/#{user}/#{repo}/issues/#{issue_id}/comments", params)
+      else
+        get_request("/repos/#{user}/#{repo}/issues/comments", params)
+      end
       return response unless block_given?
       response.each { |el| yield el }
     end
@@ -43,9 +59,7 @@ module Github
     def get(user_name, repo_name, comment_id, params={})
       set :user => user_name, :repo => repo_name
       assert_presence_of user, repo, comment_id
-
       normalize! params
-      # _merge_mime_type(:issue_comment, params)
 
       get_request("/repos/#{user}/#{repo}/issues/comments/#{comment_id}", params)
     end

data/lib/github_api/pull_requests/comments.rb

@@ -17,16 +17,34 @@ module Github
     #
     # = Examples
     #  github = Github.new
-    #  github.pull_requests.comments.list 'user-name', 'repo-name', 'request-id'
+    #  github.pull_requests.comments.list 'user-name', 'repo-name', request_id: 'id'
     #
-    def list(user_name, repo_name, request_id, params={})
+    # List comments in a repository
+    #
+    # By default, Review Comments are ordered by ascending ID.
+    #
+    # = Parameters
+    #
+    # * <tt>:sort</tt>      - Optional string, <tt>created</tt> or <tt>updated</tt>
+    # * <tt>:direction</tt> - Optional string, <tt>asc</tt> or <tt>desc</tt>.
+    #                         Ignored with sort parameter.
+    # * <tt>:since</tt>     - Optional string of a timestamp in ISO 8601
+    #                         format: YYYY-MM-DDTHH:MM:SSZ
+    # = Examples
+    #  github = Github.new
+    #  github.pull_requests.comments.list 'user-name', 'repo-name'
+    #  github.pull_requests.comments.list 'user-name', 'repo-name' { |comm| ... }
+    #
+    def list(user_name, repo_name, params={})
       set :user => user_name, :repo => repo_name
-      assert_presence_of user, repo, request_id
-
+      assert_presence_of user, repo
       normalize! params
-      # _merge_mime_type(:pull_comment, params)
 
-      response = get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
+      response = if (request_id = params.delete('request_id'))
+        get_request("/repos/#{user}/#{repo}/pulls/#{request_id}/comments", params)
+      else
+        get_request("/repos/#{user}/#{repo}/pulls/comments", params)
+      end
       return response unless block_given?
       response.each { |el| yield el }
     end

data/lib/github_api/repos.rb

@@ -294,6 +294,17 @@ module Github
     #   github.repos.list
     #   github.repos.list { |repo| ... }
     #
+    # List all repositories
+    #
+    # This provides a dump of every repository, in the order that they were created.
+    # = Parameters
+    # * <tt>:since</tt> - the integer ID of the last Repository that you've seen.
+    #
+    # = Examples
+    #   github = Github.new
+    #   github.repos.list
+    #   github.repos.list { |repo| ... }
+    #
     # List public repositories for the specified user.
     #
     # = Examples
@@ -317,9 +328,11 @@ module Github
         get_request("/users/#{user_name}/repos", params)
       elsif (org_name = params.delete("org"))
         get_request("/orgs/#{org_name}/repos", params)
-      else
+      elsif authenticated?
         # For authenticated user
         get_request("/user/repos", params)
+      else
+        get_request("/repositories", params)
       end
       return response unless block_given?
       response.each { |el| yield el }

data/lib/github_api/repos/keys.rb

@@ -3,7 +3,7 @@
 module Github
   class Repos::Keys < API
 
-    VALID_KEY_PARAM_NAMES = %w[ title key ].freeze
+    VALID_KEY_OPTIONS = %w[ title key ].freeze
 
     # List deploy keys
     #
@@ -54,8 +54,8 @@ module Github
       set :user => user_name, :repo => repo_name
       assert_presence_of user, repo
       normalize! params
-      filter! VALID_KEY_PARAM_NAMES, params
-      assert_required_keys(VALID_KEY_PARAM_NAMES, params)
+      filter! VALID_KEY_OPTIONS, params
+      assert_required_keys(VALID_KEY_OPTIONS, params)
 
       post_request("/repos/#{user}/#{repo}/keys", params)
     end
@@ -77,7 +77,7 @@ module Github
       assert_presence_of user, repo, key_id
 
       normalize! params
-      filter! VALID_KEY_PARAM_NAMES, params
+      filter! VALID_KEY_OPTIONS, params
 
       patch_request("/repos/#{user}/#{repo}/keys/#{key_id}", params)
     end

data/lib/github_api/users.rb

@@ -40,6 +40,27 @@ module Github
       @keys ||= ApiFactory.new 'Users::Keys'
     end
 
+    # List all users.
+    #
+    # This provides a dump of every user, in the order that they signed up
+    # for GitHub.
+    #
+    # = Parameters
+    # * <tt>:since</tt> - The integer ID of the last User that you’ve seen.
+    #
+    # = Examples
+    #  users = Github::Users.new
+    #  users.list
+    #
+    def list(params={})
+      normalize! params
+
+      response = get_request("/users", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
     # Get a single unauthenticated user
     #
     # = Examples

data/lib/github_api/users/keys.rb

@@ -9,8 +9,8 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.users.followers.list
-    #  github.users.followers.list { |key| ... }
+    #  github.users.keys.list
+    #  github.users.keys.list { |key| ... }
     #
     def list(params={})
       normalize! params
@@ -24,7 +24,7 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.users.followers.get 'key-id'
+    #  github.users.keys.get 'key-id'
     #
     def get(key_id, params={})
       assert_presence_of key_id
@@ -41,7 +41,7 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.users.followers.create "title" => "octocat@octomac",
+    #  github.users.keys.create "title" => "octocat@octomac",
     #    "key" => "ssh-rsa AAA..."
     #
     def create(params={})
@@ -58,7 +58,7 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.users.followers.update 'key-id', "title" => "octocat@octomac",
+    #  github.users.keys.update 'key-id', "title" => "octocat@octomac",
     #    "key" => "ssh-rsa AAA..."
     #
     def update(key_id, params={})
@@ -72,7 +72,7 @@ module Github
     #
     # = Examples
     #  github = Github.new :oauth_token => '...'
-    #  github.users.followers.delete 'key-id'
+    #  github.users.keys.delete 'key-id'
     #
     def delete(key_id, params={})
       assert_presence_of key_id