octokit 1.18.0 → 1.19.0

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -15,7 +15,7 @@ module Octokit
           :"hub.topic" => topic,
           :"hub.callback" => callback,
         }
-        post("hub", options, 3, true, true, true)
+        post("hub", options)
         true
       end
 
@@ -33,7 +33,7 @@ module Octokit
           :"hub.topic" => topic,
           :"hub.callback" => callback,
         }
-        post("hub", options, 3, true, true, true)
+        post("hub", options)
         true
       end
     end

data/lib/octokit/client/pulls.rb

@@ -11,7 +11,7 @@ module Octokit
       # @example
       #   Octokit.pull_requests('rails/rails')
       def pull_requests(repo, state='open', options={})
-        get("repos/#{Repository.new(repo)}/pulls", options.merge({:state => state}), 3)
+        get("repos/#{Repository.new(repo)}/pulls", options.merge({:state => state}))
       end
       alias :pulls :pull_requests
 
@@ -90,7 +90,7 @@ module Octokit
           :state => state
         })
         options.reject! { |_, value| value.nil? }
-        post("repos/#{Repository.new repo}/pulls/#{id}", options, 3)
+        post("repos/#{Repository.new repo}/pulls/#{id}", options)
       end
 
 
@@ -118,6 +118,94 @@ module Octokit
       alias :pull_comments   :pull_request_comments
       alias :review_comments :pull_request_comments
 
+      # Get a pull request comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param comment_id [Integer] Id of comment to get
+      # @return [Hashie::Mash] Hash representing the comment
+      # @see http://developer.github.com/v3/pulls/comments/#get-a-single-comment
+      # @example
+      #   @client.pull_request_comment("pengwynn/octkit", 1903950)
+      def pull_request_comment(repo, comment_id, options={})
+        get("repos/#{Repository.new repo}/pulls/comments/#{comment_id}", options)
+      end
+      alias :pull_comment   :pull_request_comment
+      alias :review_comment :pull_request_comment
+
+      # Create a pull request comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param pull_id [Integer] Pull request id
+      # @param body [String] Comment content
+      # @param commit_id [String] Sha of the commit to comment on.
+      # @param path [String] Relative path of the file to comment on.
+      # @param position [Integer] Line index in the diff to comment on.
+      # @return [Hashie::Mash] Hash representing the new comment
+      # @see http://developer.github.com/v3/pulls/comments/#create-a-comment
+      # @example
+      #   @client.create_pull_request_comment("pengwynn/octokit", 163, ":shipit:",
+      #     "2d3201e4440903d8b04a5487842053ca4883e5f0", "lib/octokit/request.rb", 47)
+      def create_pull_request_comment(repo, pull_id, body, commit_id, path, position, options={})
+        options.merge!({
+          :body => body,
+          :commit_id => commit_id,
+          :path => path,
+          :position => position
+        })
+        post("repos/#{Repository.new repo}/pulls/#{pull_id}/comments", options)
+      end
+      alias :create_pull_comment :create_pull_request_comment
+      alias :create_view_comment :create_pull_request_comment
+
+      # Create reply to a pull request comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param pull_id [Integer] Pull request id
+      # @param body [String] Comment contents
+      # @param comment_id [Integer] Comment id to reply to
+      # @return [Hashie::Mash] Hash representing new comment
+      # @see http://developer.github.com/v3/pulls/comments/#create-a-comment
+      # @example
+      #   @client.create_pull_request_comment_reply("pengwynn/octokit", 1903950, "done.")
+      def create_pull_request_comment_reply(repo, pull_id, body, comment_id, options={})
+        options.merge!({
+          :body => body,
+          :in_reply_to => comment_id
+        })
+        post("repos/#{Repository.new repo}/pulls/#{pull_id}/comments", options)
+      end
+      alias :create_pull_reply   :create_pull_request_comment_reply
+      alias :create_review_reply :create_pull_request_comment_reply
+
+      # Update pull request comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param comment_id [Integer] Id of the comment to update
+      # @param body [String] Updated comment content
+      # @return [Hashie::Mash] Hash representing the updated comment
+      # @see http://developer.github.com/v3/pulls/comments/#edit-a-comment
+      # @example
+      #   @client.update_pull_request_comment("pengwynn/octokit", 1903950, ":shipit:")
+      def update_pull_request_comment(repo, comment_id, body, options={})
+        options.merge! :body => body
+        patch("repos/#{Repository.new repo}/pulls/comments/#{comment_id}", options)
+      end
+      alias :update_pull_comment   :update_pull_request_comment
+      alias :update_review_comment :update_pull_request_comment
+
+      # Delete pull request comment
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param comment_id [Integer] Id of the comment to delete
+      # @return [Boolean] True if deleted, false otherwise
+      # @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
+      end
+      alias :delete_pull_comment   :delete_pull_request_comment
+      alias :delete_review_comment :delete_pull_request_comment
+
       # List files on a pull request
       #
       # @see http://developer.github.com/v3/pulls/#list-files-on-a-pull-request
@@ -148,7 +236,7 @@ module Octokit
       # @return [Boolean] True if the pull request has been merged
       def pull_merged?(repo, number, options={})
         begin
-          get("repos/#{Repository.new(repo)}/pulls/#{number}/merged", options)
+          get("repos/#{Repository.new(repo)}/pulls/#{number}/merge", options)
           return true
         rescue Octokit::NotFound
           return false

data/lib/octokit/client/rate_limit.rb

@@ -0,0 +1,20 @@
+module Octokit
+  class Client
+    module RateLimit
+
+      def ratelimit(options={})
+        headers = request(:get, "rate_limit", options).headers
+        return headers["X-RateLimit-Limit"].to_i
+      end
+      alias rate_limit ratelimit
+
+      def ratelimit_remaining(options={})
+        headers = request(:get, "rate_limit", options).headers
+        return headers["X-RateLimit-Remaining"].to_i
+      end
+      alias rate_limit_remaining ratelimit_remaining
+
+    end
+  end
+end
+

data/lib/octokit/client/refs.rb

@@ -11,7 +11,7 @@ module Octokit
       # @example Fetch all refs for sferik/rails_admin
       #   Octokit.refs("sferik/rails_admin")
       def refs(repo, namespace="", options={})
-        get("repos/#{Repository.new(repo)}/git/refs/#{namespace}", options, 3)
+        get("repos/#{Repository.new(repo)}/git/refs/#{namespace}", options)
       end
       alias :list_refs :refs
       alias :references :refs
@@ -26,7 +26,7 @@ module Octokit
       # @example Fetch tags/v0.0.3 for sferik/rails_admin
       #   Octokit.ref("sferik/rails_admin","tags/v0.0.3")
       def ref(repo, ref, options={})
-        get("repos/#{Repository.new(repo)}/git/refs/#{ref}", options, 3)
+        get("repos/#{Repository.new(repo)}/git/refs/#{ref}", options)
       end
       alias :reference :ref
 
@@ -71,12 +71,12 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param ref [String] The ref, e.g. <tt>tags/v0.0.3</tt>
-      # @return [Response] A response object with status
+      # @return [Boolean] Success
       # @see http://developer.github.com/v3/git/refs/
       # @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={})
-        delete("repos/#{Repository.new(repo)}/git/refs/#{ref}", options, 3, true, true)
+        request(:delete, "repos/#{Repository.new(repo)}/git/refs/#{ref}", options).status == 204
       end
       alias :delete_reference :delete_ref
 

data/lib/octokit/client/repositories.rb

@@ -8,7 +8,7 @@ module Octokit
       # @param q [String] Search keyword
       # @return [Array<Hashie::Mash>] List of repositories found
       def search_repositories(q, options={})
-        get("legacy/repos/search/#{q}", options, 3)['repositories']
+        get("legacy/repos/search/#{q}", options)['repositories']
       end
       alias :search_repos :search_repositories
 
@@ -18,7 +18,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Hashie::Mash] Repository information
       def repository(repo, options={})
-        get "repos/#{Repository.new repo}", options, 3
+        get "repos/#{Repository.new repo}", options
       end
       alias :repo :repository
 
@@ -34,9 +34,10 @@ module Octokit
       # @option options [String] :has_issues `true` enables issues for this repo, `false` disables issues.
       # @option options [String] :has_wiki `true` enables wiki for this repo, `false` disables wiki.
       # @option options [String] :has_downloads `true` enables downloads for this repo, `false` disables downloads.
+      # @option options [String] :default_branch Update the default branch for this repository.
       # @return [Hashie::Mash] Repository information
       def edit_repository(repo, options={})
-        patch "repos/#{Repository.new repo}", options, 3
+        patch "repos/#{Repository.new repo}", options
       end
       alias :edit :edit_repository
       alias :update_repository :edit_repository
@@ -52,9 +53,9 @@ module Octokit
       # @return [Array<Hashie::Mash>] List of repositories
       def repositories(username=nil, options={})
         if username.nil?
-          get 'user/repos', options, 3
+          get 'user/repos', options
         else
-          get "users/#{username}/repos", options, 3
+          get "users/#{username}/repos", options
         end
       end
       alias :list_repositories :repositories
@@ -67,7 +68,7 @@ module Octokit
       # @return [Boolean] `true` if successfully starred
       def star(repo, options={})
         begin
-          put "user/starred/#{Repository.new repo}", options, 3
+          put "user/starred/#{Repository.new repo}", options
           return true
         rescue Octokit::NotFound
           return false
@@ -80,7 +81,7 @@ module Octokit
       # @return [Boolean] `true` if successfully unstarred
       def unstar(repo, options={})
         begin
-          delete "user/starred/#{Repository.new repo}", options, 3
+          request :delete, "user/starred/#{Repository.new repo}", options
           return true
         rescue Octokit::NotFound
           return false
@@ -94,7 +95,7 @@ module Octokit
       # @deprecated Use #star instead
       def watch(repo, options={})
         begin
-          put "user/watched/#{Repository.new repo}", options, 3
+          put "user/watched/#{Repository.new repo}", options
           return true
         rescue Octokit::NotFound
           return false
@@ -108,7 +109,7 @@ module Octokit
       # @deprecated Use #unstar instead
       def unwatch(repo, options={})
         begin
-          delete "user/watched/#{Repository.new repo}", options, 3
+          request :delete, "user/watched/#{Repository.new repo}", options
           return true
         rescue Octokit::NotFound
           return false
@@ -120,7 +121,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Hashie::Mash] Repository info for the new fork
       def fork(repo, options={})
-        post "repos/#{Repository.new repo}/forks", options, 3
+        post "repos/#{Repository.new repo}/forks", options
       end
 
       # Create a repository for a user or organization
@@ -143,9 +144,9 @@ module Octokit
         options.merge! :name => name
 
         if organization.nil?
-          post 'user/repos', options, 3
+          post 'user/repos', options
         else
-          post "orgs/#{organization}/repos", options, 3
+          post "orgs/#{organization}/repos", options
         end
       end
       alias :create_repo :create_repository
@@ -160,7 +161,7 @@ module Octokit
       # @return [Boolean] `true` if repository was deleted
       def delete_repository(repo, options={})
         begin
-          delete "repos/#{Repository.new repo}", options, 3
+          request :delete, "repos/#{Repository.new repo}", options
           return true
         rescue Octokit::NotFound
           return false
@@ -199,7 +200,7 @@ module Octokit
       # @example
       #   @client.list_deploy_keys('pengwynn/octokit')
       def deploy_keys(repo, options={})
-        get "repos/#{Repository.new repo}/keys", options, 3
+        get "repos/#{Repository.new repo}/keys", options
       end
       alias :list_deploy_keys :deploy_keys
 
@@ -216,7 +217,7 @@ module Octokit
       # @example
       #    @client.add_deploy_key('pengwynn/octokit', 'Staging server', 'ssh-rsa AAA...')
       def add_deploy_key(repo, title, key, options={})
-        post "repos/#{Repository.new repo}/keys", options.merge(:title => title, :key => key), 3
+        post "repos/#{Repository.new repo}/keys", options.merge(:title => title, :key => key)
       end
 
       # Remove deploy key from a repo
@@ -231,7 +232,7 @@ module Octokit
       # @example
       #   @client.remove_deploy_key('pengwynn/octokit', 100000)
       def remove_deploy_key(repo, id, options={})
-        delete "repos/#{Repository.new repo}/keys/#{id}", options, 3
+        request(:delete, "repos/#{Repository.new repo}/keys/#{id}", options).status == 204
       end
 
       # List collaborators
@@ -249,7 +250,7 @@ module Octokit
       # @example
       #   @client.collabs('pengwynn/octokit')
       def collaborators(repo, options={})
-        get "repos/#{Repository.new repo}/collaborators", options, 3
+        get "repos/#{Repository.new repo}/collaborators", options
       end
       alias :collabs :collaborators
 
@@ -267,7 +268,7 @@ module Octokit
       # @example
       #   @client.add_collab('pengwynn/octokit', 'holman')
       def add_collaborator(repo, collaborator, options={})
-        put "repos/#{Repository.new repo}/collaborators/#{collaborator}", options, 3
+        request(:put, "repos/#{Repository.new repo}/collaborators/#{collaborator}", options).status == 204
       end
       alias :add_collab :add_collaborator
 
@@ -285,7 +286,7 @@ module Octokit
       # @example
       #   @client.remove_collab('pengwynn/octokit', 'holman')
       def remove_collaborator(repo, collaborator, options={})
-        delete "repos/#{Repository.new repo}/collaborators/#{collaborator}", options, 3
+        request :delete, "repos/#{Repository.new repo}/collaborators/#{collaborator}", options
       end
       alias :remove_collab :remove_collaborator
 
@@ -304,7 +305,7 @@ module Octokit
       # @example
       #   @client.teams('octokit/pengwynn')
       def repository_teams(repo, options={})
-        get "repos/#{Repository.new repo}/teams", options, 3
+        get "repos/#{Repository.new repo}/teams", options
       end
       alias :repo_teams :repository_teams
       alias :teams :repository_teams
@@ -325,7 +326,7 @@ module Octokit
       # @example
       #   @client.contribs('pengwynn/octokit') 
       def contributors(repo, anon=false, options={})
-        get "repos/#{Repository.new repo}/contributors", options.merge(:anon => anon), 3
+        get "repos/#{Repository.new repo}/contributors", options.merge(:anon => anon)
       end
       alias :contribs :contributors
 
@@ -342,7 +343,7 @@ module Octokit
       # @example
       #   @client.stargazers('pengwynn/octokit')
       def stargazers(repo, options={})
-        get "repos/#{Repository.new repo}/stargazers", options, 3
+        get "repos/#{Repository.new repo}/stargazers", options
       end
 
       # @deprecated Use #stargazers instead
@@ -361,7 +362,7 @@ module Octokit
       # @example
       #   @client.watchers('pengwynn/octokit')
       def watchers(repo, options={})
-        get "repos/#{Repository.new repo}/watchers", options, 3
+        get "repos/#{Repository.new repo}/watchers", options
       end
 
       # List forks
@@ -379,7 +380,7 @@ module Octokit
       # @example
       #   @client.forks('pengwynn/octokit')
       def forks(repo, options={})
-        get "repos/#{Repository.new repo}/forks", options, 3
+        get "repos/#{Repository.new repo}/forks", options
       end
       alias :network :forks
 
@@ -396,7 +397,7 @@ module Octokit
       # @example
       #   @client.languages('pengwynn/octokit')
       def languages(repo, options={})
-        get "repos/#{Repository.new repo}/languages", options, 3
+        get "repos/#{Repository.new repo}/languages", options
       end
 
       # List tags
@@ -412,7 +413,7 @@ module Octokit
       # @example
       #   @client.tags('pengwynn/octokit')
       def tags(repo, options={})
-        get "repos/#{Repository.new repo}/tags", options, 3
+        get "repos/#{Repository.new repo}/tags", options
       end
 
       # List branches
@@ -428,7 +429,7 @@ module Octokit
       # @example
       #   @client.branches('pengwynn/octokit')
       def branches(repo, options={})
-        get "repos/#{Repository.new repo}/branches", options, 3
+        get "repos/#{Repository.new repo}/branches", options
       end
 
       # Get a single branch from a repository
@@ -440,7 +441,7 @@ module Octokit
       # @example Get branch 'master` from pengwynn/octokit
       #   Octokit.issue("pengwynn/octokit", "master")
       def branch(repo, branch, options={})
-        get "repos/#{Repository.new repo}/branches/#{branch}", options, 3
+        get "repos/#{Repository.new repo}/branches/#{branch}", options
       end
       alias :get_branch :branch
 
@@ -455,7 +456,7 @@ module Octokit
       # @example
       #   @client.hooks('pengwynn/octokit')
       def hooks(repo, options={})
-        get "repos/#{Repository.new repo}/hooks", options, 3
+        get "repos/#{Repository.new repo}/hooks", options
       end
 
       # Get single hook
@@ -470,7 +471,7 @@ module Octokit
       # @example
       #   @client.hook('pengwynn/octokit', 100000)
       def hook(repo, id, options={})
-        get "repos/#{Repository.new repo}/hooks/#{id}", options, 3
+        get "repos/#{Repository.new repo}/hooks/#{id}", options
       end
 
       # Create a hook
@@ -506,7 +507,7 @@ module Octokit
       #   )
       def create_hook(repo, name, config, options={})
         options = {:name => name, :config => config, :events => ["push"], :active => true}.merge(options)
-        post "repos/#{Repository.new repo}/hooks", options, 3
+        post "repos/#{Repository.new repo}/hooks", options
       end
 
       # Edit a hook
@@ -548,7 +549,7 @@ module Octokit
       #   )
       def edit_hook(repo, id, name, config, options={})
         options = {:name => name, :config => config, :events => ["push"], :active => true}.merge(options)
-        patch "repos/#{Repository.new repo}/hooks/#{id}", options, 3
+        patch "repos/#{Repository.new repo}/hooks/#{id}", options
       end
 
       # Delete hook
@@ -563,7 +564,7 @@ module Octokit
       # @example
       #   @client.remove_hook('pengwynn/octokit', 1000000)
       def remove_hook(repo, id, options={})
-        delete "repos/#{Repository.new repo}/hooks/#{id}", options, 3
+        request(:delete, "repos/#{Repository.new repo}/hooks/#{id}", options).status == 204
       end
 
       # Test hook
@@ -578,7 +579,7 @@ module Octokit
       # @example
       #   @client.test_hook('pengwynn/octokit', 1000000)
       def test_hook(repo, id, options={})
-        post "repos/#{Repository.new repo}/hooks/#{id}/test", options, 3
+        request(:post, "repos/#{Repository.new repo}/hooks/#{id}/test", options).status == 204
       end
 
       # Get all Issue Events for a given Repository
@@ -590,7 +591,7 @@ module Octokit
       # @example Get all Issue Events for Octokit
       #   Octokit.repository_issue_events("pengwynn/octokit")
       def repository_issue_events(repo, options={})
-        get "repos/#{Repository.new repo}/issues/events", options, 3
+        get "repos/#{Repository.new repo}/issues/events", options
       end
       alias :repo_issue_events :repository_issue_events
 
@@ -599,7 +600,7 @@ module Octokit
       # Requires authenticated client for private repos.
       #
       # @param repo [String, Hash, Repository] A GitHub repository.
-      # @returns [Array<Hashie::Mash>] Array of hashes representing users.
+      # @return [Array<Hashie::Mash>] Array of hashes representing users.
       # @see Octokit::Client
       # @see http://developer.github.com/v3/issues/assignees/#list-assignees
       # @example
@@ -609,9 +610,77 @@ module Octokit
       # @example
       #   @client.repository_assignees('pengwynn/octokit')
       def repository_assignees(repo, options={})
-        get "repos/#{Repository.new repo}/assignees", options, 3
+        get "repos/#{Repository.new repo}/assignees", options
       end
       alias :repo_assignees :repository_assignees
+
+      # List watchers subscribing to notifications for a repo
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository.
+      #
+      # @return [Array] Array of users watching.
+      #
+      # @see http://developer.github.com/v3/activity/watching/#list-watchers
+      #
+      # @example
+      #   @client.subscribers("pengwynn/octokit")
+      def subscribers(repo, options={})
+        get("repos/#{Repository.new repo}/subscribers", options)
+      end
+
+      # Get a repository subscription
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository.
+      #
+      # @return [Hashie::Mash] Repository subscription.
+      #
+      # @see http://developer.github.com/v3/activity/watching/#get-a-repository-subscription
+      #
+      # @example
+      #   @client.subscription("pengwynn/octokit")
+      def subscription(repo, options={})
+        get("repos/#{Repository.new repo}/subscription", options)
+      end
+
+      # Update repository subscription
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository.
+      # @param options [Hash]
+      #
+      # @option options [Boolean] :subscribed Determines if notifications
+      #   should be received from this repository.
+      #
+      # @option options [Boolean] :ignored Deterimines if all notifications
+      #   should be blocked from this repository.
+      #
+      # @return [Hashie::Mash] Updated repository subscription.
+      #
+      # @see http://developer.github.com/v3/activity/watching/#set-a-repository-subscription
+      #
+      # @example Subscribe to notifications for a repository
+      #   @client.update_subscription("pengwynn/octokit", {subscribed: true})
+      def update_subscription(repo, options={})
+        put("repos/#{Repository.new repo}/subscription", options)
+      end
+
+      # Delete a repository subscription
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository.
+      #
+      # @return [Boolean] True if subscription deleted, false otherwise.
+      #
+      # @see http://developer.github.com/v3/activity/watching/#delete-a-repository-subscription
+      #
+      # @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
+      end
+
     end
   end
 end