octokit 1.19.0 → 1.20.0

data/lib/octokit/client/issues.rb

@@ -113,6 +113,35 @@ module Octokit
         post("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:title => title, :body => body}))
       end
 
+      # Get all comments attached to issues for the repository
+      #
+      # By default, Issue Comments are ordered by ascending ID.
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param options [Hash] Optional parameters
+      # @option options [String] :sort created or updated
+      # @option options [String] :direction asc or desc. Ignored without sort
+      #   parameter.
+      # @option options [String] :since Timestamp in ISO 8601
+      #   format: YYYY-MM-DDTHH:MM:SSZ
+      #
+      # @return [Array] List of issues comments.
+      #
+      # @see http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
+      #
+      # @example Get the comments for issues in the octokit repository
+      #   @client.issues_comments("pengwynn/octokit")
+      #
+      # @example Get issues comments, sort by updated descending since a time
+      #   @client.issues_comments("pengwynn/octokit", {
+      #     :sort => 'desc',
+      #     :direction => 'down',
+      #     :since => '2010-05-04T23:45:02Z'
+      #   })
+      def issues_comments(repo, options={})
+        get "/repos/#{Repository.new repo}/issues/comments", options
+      end
+
       # Get all comments attached to an issue
       #
       # @param repo [String, Repository, Hash] A GitHub repository
@@ -172,7 +201,7 @@ module Octokit
       # @example Delete the comment "I've started this on my 25-issue-comments-v3 fork" on Issue #25 on pengwynn/octokit
       #   Octokit.delete_comment("pengwynn/octokit", 1194549)
       def delete_comment(repo, number, options={})
-        request(:delete, "repos/#{Repository.new(repo)}/issues/comments/#{number}", options).status == 204
+        boolean_from_response(:delete, "repos/#{Repository.new(repo)}/issues/comments/#{number}", options)
       end
 
 

data/lib/octokit/client/labels.rb

@@ -67,7 +67,7 @@ module Octokit
       # @example Delete the label "Version 1.0" from the repository.
       #   Octokit.delete_label!("pengwynn/octokit", "Version 1.0")
       def delete_label!(repo, label, options={})
-        request(:delete, "repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options).status == 204
+        boolean_from_response(:delete, "repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options)
       end
 
       # Remove a label from an Issue
@@ -97,7 +97,7 @@ module Octokit
       # @example Remove all labels from Issue #23
       #   Octokit.remove_all_labels("pengwynn/octokit", 23)
       def remove_all_labels(repo, number, options={})
-        request(:delete, "repos/#{Repository.new(repo)}/issues/#{number}/labels", options).status == 204
+        boolean_from_response(:delete, "repos/#{Repository.new(repo)}/issues/#{number}/labels", options)
       end
 
       # List labels for a given issue

data/lib/octokit/client/milestones.rb

@@ -79,7 +79,7 @@ module Octokit
       # @example Delete a single milestone from a repository
       #   Octokit.delete_milestone("pengwynn/octokit", 1)
       def delete_milestone(repository, number, options={})
-        request(:delete, "repos/#{Repository.new(repository)}/milestones/#{number}", options).status == 204
+        boolean_from_response(:delete, "repos/#{Repository.new(repository)}/milestones/#{number}", options)
       end
 
     end

data/lib/octokit/client/notifications.rb

@@ -210,11 +210,7 @@ module Octokit
       # @example
       #   @client.delete_thread_subscription(1)
       def delete_thread_subscription(thread_id, options={})
-        begin
-          request(:delete, "notifications/threads/#{thread_id}", options).status == 204
-        rescue
-          false
-        end
+        boolean_from_response(:delete, "notifications/threads/#{thread_id}", options)
       end
 
     end

data/lib/octokit/client/organizations.rb

@@ -89,7 +89,7 @@ module Octokit
       #
       # @param org [String] Organization handle for which to list repos
       # @option options [String] :type ('all') Filter by repository type.
-      #   `all`, `public`, `member` or `private`.
+      #   `all`, `public`, `member`, `sources`, `forks`, or `private`.
       #
       # @return [Array<Hashie::Mash>] List of repositories
       # @see Octokit::Client
@@ -146,9 +146,7 @@ module Octokit
       #   @client.organization_member?('your_organization', 'pengwynn')
       #   => false
       def organization_member?(org, user, options={})
-        request(:get, "orgs/#{org}/members/#{user}", options).status == 204
-      rescue Octokit::NotFound
-        false
+        boolean_from_response(:get, "orgs/#{org}/members/#{user}", options)
       end
       alias :org_member? :organization_member?
 
@@ -168,9 +166,7 @@ module Octokit
       #   @client.organization_public_member?('github', 'pengwynn')
       #   => true
       def organization_public_member?(org, user, options={})
-        request(:get, "orgs/#{org}/public_members/#{user}", options).status == 204
-      rescue Octokit::NotFound
-        false
+        boolean_from_response(:get, "orgs/#{org}/public_members/#{user}", options)
       end
       alias :org_public_member? :organization_public_member?
 
@@ -265,7 +261,7 @@ module Octokit
       # @example
       #   @client.delete_team(100000)
       def delete_team(team_id, options={})
-        request(:delete, "teams/#{team_id}", options).status == 204
+        boolean_from_response(:delete, "teams/#{team_id}", options)
       end
 
       # List team members
@@ -298,7 +294,7 @@ module Octokit
         # There's a bug in this API call. The docs say to leave the body blank,
         # but it fails if the body is both blank and the content-length header
         # is not 0.
-        request(:put, "teams/#{team_id}/members/#{user}", options.merge({:name => user})).status == 204
+        boolean_from_response(:put, "teams/#{team_id}/members/#{user}", options.merge({:name => user}))
       end
 
       # Remove team member
@@ -314,7 +310,7 @@ module Octokit
       # @example
       #   @client.remove_team_member(100000, 'pengwynn')
       def remove_team_member(team_id, user, options={})
-        request(:delete, "teams/#{team_id}/members/#{user}", options).status == 204
+        boolean_from_response(:delete, "teams/#{team_id}/members/#{user}", options)
       end
 
       # List team repositories
@@ -351,7 +347,7 @@ module Octokit
       # @example
       #   @client.add_team_repo(100000, 'github/developer.github.com')
       def add_team_repository(team_id, repo, options={})
-        request(:put, "teams/#{team_id}/repos/#{Repository.new(repo)}", options.merge(:name => Repository.new(repo))).status == 204
+        boolean_from_response(:put, "teams/#{team_id}/repos/#{Repository.new(repo)}", options.merge(:name => Repository.new(repo)))
       end
       alias :add_team_repo :add_team_repository
 
@@ -372,7 +368,7 @@ module Octokit
       # @example
       #   @client.remove_team_repo(100000, 'github/developer.github.com')
       def remove_team_repository(team_id, repo, options={})
-        request(:delete, "teams/#{team_id}/repos/#{Repository.new(repo)}").status == 204
+        boolean_from_response(:delete, "teams/#{team_id}/repos/#{Repository.new(repo)}")
       end
       alias :remove_team_repo :remove_team_repository
 
@@ -392,7 +388,7 @@ module Octokit
       def remove_organization_member(org, user, options={})
         # this is a synonym for: for team in org.teams: remove_team_member(team.id, user)
         # provided in the GH API v3
-        request(:delete, "orgs/#{org}/members/#{user}", options).status == 204
+        boolean_from_response(:delete, "orgs/#{org}/members/#{user}", options)
       end
       alias :remove_org_member :remove_organization_member
 
@@ -408,7 +404,7 @@ module Octokit
       # @example
       #   @client.publicize_membership('github', 'pengwynn')
       def publicize_membership(org, user, options={})
-        request(:put, "orgs/#{org}/public_members/#{user}", options).status == 204
+        boolean_from_response(:put, "orgs/#{org}/public_members/#{user}", options)
       end
 
       # Conceal a user's membership of an organization.
@@ -425,7 +421,7 @@ module Octokit
       # @example
       #   @client.conceal_membership('github', 'pengwynn')
       def unpublicize_membership(org, user, options={})
-        request(:delete, "orgs/#{org}/public_members/#{user}", options).status == 204
+        boolean_from_response(:delete, "orgs/#{org}/public_members/#{user}", options)
       end
       alias :conceal_membership :unpublicize_membership
 

data/lib/octokit/client/pulls.rb

@@ -105,6 +105,37 @@ module Octokit
       end
       alias :pull_commits :pull_request_commits
 
+      # List pull request comments for a repository
+      #
+      # By default, Review Comments are ordered by ascending ID.
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param options [Hash] Optional parameters
+      # @option options [String] :sort created or updated
+      # @option options [String] :direction asc or desc. Ignored without sort
+      #   parameter.
+      # @option options [String] :since Timestamp in ISO 8601
+      #   format: YYYY-MM-DDTHH:MM:SSZ
+      #
+      # @return [Array] List of pull request review comments.
+      #
+      # @see http://developer.github.com/v3/pulls/comments/#list-comments-in-a-repository
+      #
+      # @example Get the pull request review comments in the octokit repository
+      #   @client.issues_comments("pengwynn/octokit")
+      #
+      # @example Get review comments, sort by updated asc since a time
+      #   @client.pull_requests_comments("pengwynn/octokit", {
+      #     :sort => 'asc',
+      #     :direction => 'down',
+      #     :since => '2010-05-04T23:45:02Z'
+      #   })
+      def pull_requests_comments(repo, options={})
+        get("repos/#{Repository.new repo}/pulls/comments")
+      end
+      alias :pulls_comments   :pull_requests_comments
+      alias :reviews_comments :pull_requests_comments
+
       # List comments on a pull request
       #
       # @see http://developer.github.com/v3/pulls/#list-comments-on-a-pull-request
@@ -201,7 +232,7 @@ module Octokit
       # @example
       #   @client.delete_pull_request_comment("pengwynn/octokit", 1902707)
       def delete_pull_request_comment(repo, comment_id, options={})
-        request(:delete, "repos/#{Repository.new repo}/pulls/comments/#{comment_id}", options).status == 204
+        boolean_from_response(:delete, "repos/#{Repository.new repo}/pulls/comments/#{comment_id}", options)
       end
       alias :delete_pull_comment   :delete_pull_request_comment
       alias :delete_review_comment :delete_pull_request_comment
@@ -235,12 +266,7 @@ module Octokit
       # @param number [Integer] Number of pull request
       # @return [Boolean] True if the pull request has been merged
       def pull_merged?(repo, number, options={})
-        begin
-          get("repos/#{Repository.new(repo)}/pulls/#{number}/merge", options)
-          return true
-        rescue Octokit::NotFound
-          return false
-        end
+        boolean_from_response(:get, "repos/#{Repository.new(repo)}/pulls/#{number}/merge", options)
       end
       alias :pull_request_merged? :pull_merged?
 

data/lib/octokit/client/refs.rb

@@ -76,7 +76,7 @@ module Octokit
       # @example Delete tags/v0.0.3 for sferik/rails_admin
       #   Octokit.delete_ref("sferik/rails_admin","tags/v0.0.3")
       def delete_ref(repo, ref, options={})
-        request(:delete, "repos/#{Repository.new(repo)}/git/refs/#{ref}", options).status == 204
+        boolean_from_response(:delete, "repos/#{Repository.new(repo)}/git/refs/#{ref}", options)
       end
       alias :delete_reference :delete_ref
 

data/lib/octokit/client/repositories.rb

@@ -62,17 +62,28 @@ module Octokit
       alias :list_repos :repositories
       alias :repos :repositories
 
+      # List all repositories
+      #
+      # This provides a dump of every repository, in the order that they were
+      # created.
+      #
+      # @see http://developer.github.com/v3/repos/#list-all-repositories
+      #
+      # @param options [Hash] Optional options
+      # @option options [Integer] :since The integer ID of the last Repository
+      #   that you’ve seen.
+      #
+      # @return [Array] List of repositories.
+      def all_repositories(options={})
+        get '/repositories', options
+      end
+
       # Star a repository
       #
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Boolean] `true` if successfully starred
       def star(repo, options={})
-        begin
-          put "user/starred/#{Repository.new repo}", options
-          return true
-        rescue Octokit::NotFound
-          return false
-        end
+        boolean_from_response(:put, "user/starred/#{Repository.new repo}", options)
       end
 
       # Unstar a repository
@@ -80,12 +91,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Boolean] `true` if successfully unstarred
       def unstar(repo, options={})
-        begin
-          request :delete, "user/starred/#{Repository.new repo}", options
-          return true
-        rescue Octokit::NotFound
-          return false
-        end
+        boolean_from_response(:delete, "user/starred/#{Repository.new repo}", options)
       end
 
       # Watch a repository
@@ -94,12 +100,7 @@ module Octokit
       # @return [Boolean] `true` if successfully watched
       # @deprecated Use #star instead
       def watch(repo, options={})
-        begin
-          put "user/watched/#{Repository.new repo}", options
-          return true
-        rescue Octokit::NotFound
-          return false
-        end
+        boolean_from_response(:put, "user/watched/#{Repository.new repo}", options)
       end
 
       # Unwatch a repository
@@ -108,12 +109,7 @@ module Octokit
       # @return [Boolean] `true` if successfully unwatched
       # @deprecated Use #unstar instead
       def unwatch(repo, options={})
-        begin
-          request :delete, "user/watched/#{Repository.new repo}", options
-          return true
-        rescue Octokit::NotFound
-          return false
-        end
+        boolean_from_response(:delete, "user/watched/#{Repository.new repo}", options)
       end
 
       # Fork a repository
@@ -160,12 +156,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Boolean] `true` if repository was deleted
       def delete_repository(repo, options={})
-        begin
-          request :delete, "repos/#{Repository.new repo}", options
-          return true
-        rescue Octokit::NotFound
-          return false
-        end
+        boolean_from_response(:delete, "repos/#{Repository.new repo}", options)
       end
       alias :delete_repo :delete_repository
 
@@ -232,7 +223,7 @@ module Octokit
       # @example
       #   @client.remove_deploy_key('pengwynn/octokit', 100000)
       def remove_deploy_key(repo, id, options={})
-        request(:delete, "repos/#{Repository.new repo}/keys/#{id}", options).status == 204
+        boolean_from_response(:delete, "repos/#{Repository.new repo}/keys/#{id}", options)
       end
 
       # List collaborators
@@ -268,7 +259,7 @@ module Octokit
       # @example
       #   @client.add_collab('pengwynn/octokit', 'holman')
       def add_collaborator(repo, collaborator, options={})
-        request(:put, "repos/#{Repository.new repo}/collaborators/#{collaborator}", options).status == 204
+        boolean_from_response(:put, "repos/#{Repository.new repo}/collaborators/#{collaborator}", options)
       end
       alias :add_collab :add_collaborator
 
@@ -286,7 +277,7 @@ module Octokit
       # @example
       #   @client.remove_collab('pengwynn/octokit', 'holman')
       def remove_collaborator(repo, collaborator, options={})
-        request :delete, "repos/#{Repository.new repo}/collaborators/#{collaborator}", options
+        boolean_from_response(:delete, "repos/#{Repository.new repo}/collaborators/#{collaborator}", options)
       end
       alias :remove_collab :remove_collaborator
 
@@ -564,7 +555,7 @@ module Octokit
       # @example
       #   @client.remove_hook('pengwynn/octokit', 1000000)
       def remove_hook(repo, id, options={})
-        request(:delete, "repos/#{Repository.new repo}/hooks/#{id}", options).status == 204
+        boolean_from_response(:delete, "repos/#{Repository.new repo}/hooks/#{id}", options)
       end
 
       # Test hook
@@ -579,7 +570,7 @@ module Octokit
       # @example
       #   @client.test_hook('pengwynn/octokit', 1000000)
       def test_hook(repo, id, options={})
-        request(:post, "repos/#{Repository.new repo}/hooks/#{id}/test", options).status == 204
+        boolean_from_response(:post, "repos/#{Repository.new repo}/hooks/#{id}/tests", options)
       end
 
       # Get all Issue Events for a given Repository
@@ -674,11 +665,7 @@ module Octokit
       # @example
       #   @client.delete_subscription("pengwynn/octokit")
       def delete_subscription(repo, options={})
-        begin
-          request(:delete, "repos/#{Repository.new repo}/subscription", options).status == 204
-        rescue
-          false
-        end
+        boolean_from_response(:delete, "repos/#{Repository.new repo}/subscription", options)
       end
 
     end

data/lib/octokit/client/users.rb

@@ -13,6 +13,22 @@ module Octokit
         get("legacy/user/search/#{search}", options)['users']
       end
 
+      # List all GitHub users
+      #
+      # This provides a dump of every user, in the order that they signed up
+      # for GitHub.
+      #
+      # @param options [Hash] Optional options.
+      # @option options [Integer] :since The integer ID of the last User that
+      #   you’ve seen.
+      #
+      # @see http://developer.github.com/v3/users/#get-all-users
+      #
+      # @return [Array] List of GitHub users.
+      def all_users(options={})
+        get "users", options
+      end
+
       # Get a single user
       #
       # @param user [String] A GitHub user name.
@@ -22,9 +38,9 @@ module Octokit
       #   Octokit.user("sferik")
       def user(user=nil)
         if user
-          get "users/#{user}", {}
+          get "users/#{user}"
         else
-          get "user", {}
+          get "user"
         end
       end
 
@@ -96,9 +112,7 @@ module Octokit
         user = args.first
         user ||= login
         return if user.nil?
-        request(:get, "user/following/#{target}").status == 204
-      rescue Octokit::NotFound
-        false
+        boolean_from_response(:get, "user/following/#{target}")
       end
 
       # Follow a user.
@@ -112,7 +126,7 @@ module Octokit
       # @example
       #   @client.follow('holman')
       def follow(user, options={})
-        request(:put, "user/following/#{user}", options).status == 204
+        boolean_from_response(:put, "user/following/#{user}", options)
       end
 
       # Unfollow a user.
@@ -126,7 +140,7 @@ module Octokit
       # @example
       #   @client.unfollow('holman')
       def unfollow(user, options={})
-        request(:delete, "user/following/#{user}", options).status == 204
+        boolean_from_response(:delete, "user/following/#{user}", options)
       end
 
       # Get list of repos starred by a user.
@@ -152,9 +166,7 @@ module Octokit
       # @example
       #   @client.starred?('pengwynn', 'octokit')
       def starred?(user, repo, options={})
-        request(:get, "user/starred/#{user}/#{repo}", options).status == 204
-      rescue Octokit::NotFound
-        false
+        boolean_from_response(:get, "user/starred/#{user}/#{repo}", options)
       end
 
       # Get list of repos watched by a user.
@@ -180,7 +192,7 @@ module Octokit
       # Requires authenticated client.
       #
       # @param key_id [Integer] Key to retreive.
-      # @param [Hashie::Mash] Hash representing the key.
+      # @return [Hashie::Mash] Hash representing the key.
       # @see http://developer.github.com/v3/users/keys/#get-a-single-public-key
       # @example
       #   @client.key(1)
@@ -253,7 +265,7 @@ module Octokit
       # @example
       #   @client.remove_key(1)
       def remove_key(id, options={})
-        request(:delete, "user/keys/#{id}", options).status == 204
+        boolean_from_response(:delete, "user/keys/#{id}", options)
       end
 
       # List email addresses for a user.
@@ -294,7 +306,7 @@ module Octokit
       # @example
       #   @client.remove_email('old_email@user.com')
       def remove_email(email, options={})
-        request(:delete, "user/emails", options.merge({:email => email})).status == 204
+        boolean_from_response(:delete, "user/emails", options.merge({:email => email}))
       end
 
       # List repositories being watched by a user.