octokit 1.18.0 → 1.19.0

data/lib/octokit/client/downloads.rb

@@ -10,7 +10,7 @@ module Octokit
       # @example List all downloads for Github/Hubot
       #   Octokit.downloads("github/hubot")
       def downloads(repo, options={})
-        get("repos/#{Repository.new(repo)}/downloads", options, 3)
+        get("repos/#{Repository.new(repo)}/downloads", options)
       end
       alias :list_downloads :downloads
 
@@ -23,7 +23,7 @@ module Octokit
       # @example Get the "Robawt" download from Github/Hubot
       #   Octokit.download("github/hubot")
       def download(repo, id, options={})
-        get("repos/#{Repository.new(repo)}/downloads/#{id}", options, 3)
+        get("repos/#{Repository.new(repo)}/downloads/#{id}", options)
       end
 
       # Create a download in a repository
@@ -68,10 +68,11 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param id [Integer] ID of the download
       # @see http://developer.github.com/v3/repos/downloads/#delete-a-single-download
+      # @return [Boolean] Status
       # @example Get the "Robawt" download from Github/Hubot
       #   Octokit.delete_download("github/hubot", 1234)
       def delete_download(repo, id)
-        delete("repos/#{Repository.new(repo)}/downloads/#{id}", {}, 3, true, true, true)
+        request(:delete, "repos/#{Repository.new(repo)}/downloads/#{id}").status == 204
       end
 
       private

data/lib/octokit/client/emojis.rb

@@ -7,7 +7,7 @@ module Octokit
       # @example List all emojis
       #   Octokit.emojis
       def emojis
-        get("emojis", {}, 3)
+        get "emojis"
       end
     end
   end

data/lib/octokit/client/events.rb

@@ -8,7 +8,7 @@ module Octokit
       # @example List all pubilc events
       #   Octokit.public_events
       def public_events(options={})
-        get("events", options, 3)
+        get("events", options)
       end
 
       # List all user events
@@ -18,7 +18,7 @@ module Octokit
       # @example List all user events
       #   Octokit.user_events("sferik")
       def user_events(user, options={})
-        get("users/#{user}/events", options, 3)
+        get("users/#{user}/events", options)
       end
 
       # List events that a user has received
@@ -28,7 +28,7 @@ module Octokit
       # @example List all user received events
       #   Octokit.received_events("sferik")
       def received_events(user, options={})
-        get("users/#{user}/received_events", options, 3)
+        get("users/#{user}/received_events", options)
       end
 
       # List events for a repository
@@ -39,7 +39,7 @@ module Octokit
       # @example List events for a repository
       #   Octokit.repository_events("sferik/rails_admin")
       def repository_events(repo, options={})
-        get("repos/#{Repository.new(repo)}/events", options, 3)
+        get("repos/#{Repository.new(repo)}/events", options)
       end
     end
   end

data/lib/octokit/client/gists.rb

@@ -13,9 +13,9 @@ module Octokit
       # @see http://developer.github.com/v3/gists/#list-gists
       def gists(username=nil, options={})
         if username.nil?
-          get 'gists', options, 3
+          get 'gists', options
         else
-          get "users/#{username}/gists", options, 3
+          get "users/#{username}/gists", options
         end
       end
       alias :list_gists :gists
@@ -27,14 +27,14 @@ module Octokit
       #   Octokit.public_gists
       # @see http://developer.github.com/v3/gists/#list-gists
       def public_gists(options={})
-        get 'gists/public', options, 3
+        get 'gists/public', options
       end
 
       # List the authenticated user’s starred gists
       #
       # @return [Array<Hashie::Mash>] A list of gists
       def starred_gists(options={})
-        get 'gists/starred', options, 3
+        get 'gists/starred', options
       end
 
       # Get a single gist
@@ -43,7 +43,7 @@ module Octokit
       # @return [Hash::Mash] Gist information
       # @see http://developer.github.com/v3/gists/#get-a-single-gist
       def gist(gist, options={})
-        get "gists/#{Gist.new gist}", options, 3
+        get "gists/#{Gist.new gist}", options
       end
 
       # Create a gist
@@ -53,11 +53,11 @@ module Octokit
       # @option options [Boolean] :public Sets gist visibility
       # @option options [Array<Hash>] :files Files that make up this gist. Keys
       #   should be the filename, the value a Hash with a :content key with text
-      #   conent of the Gist.
+      #   content of the Gist.
       # @return [Hashie::Mash] Newly created gist info
       # @see http://developer.github.com/v3/gists/#create-a-gist
       def create_gist(options={})
-        post 'gists', options, 3
+        post 'gists', options
       end
 
       # Edit a gist
@@ -67,7 +67,7 @@ module Octokit
       # @option options [Boolean] :public Sets gist visibility
       # @option options [Array<Hash>] :files Files that make up this gist. Keys
       #   should be the filename, the value a Hash with a :content key with text
-      #   conent of the Gist. 
+      #   content of the Gist. 
       #
       #   NOTE: All files from the previous version of the
       #   gist are carried over by default if not included in the hash. Deletes
@@ -76,8 +76,9 @@ module Octokit
       #   [Hashie::Mash] Newly created gist info
       # @see http://developer.github.com/v3/gists/#edit-a-gist
       def edit_gist(gist, options={})
-        patch "gists/#{Gist.new gist}", options, 3
+        patch "gists/#{Gist.new gist}", options
       end
+
       #
       # Star a gist
       #
@@ -85,8 +86,7 @@ module Octokit
       # @return [Boolean] Indicates if gist is starred successfully
       # @see http://developer.github.com/v3/gists/#star-a-gist
       def star_gist(gist, options={})
-        response = put("gists/#{Gist.new gist}/star", options, 3, true, true)
-        response.status == 204
+        request(:put, "gists/#{Gist.new gist}/star", options).status == 204
       end
 
       # Unstar a gist
@@ -95,8 +95,7 @@ module Octokit
       # @return [Boolean] Indicates if gist is unstarred successfully
       # @see http://developer.github.com/v3/gists/#unstar-a-gist
       def unstar_gist(gist, options={})
-        response = delete("gists/#{Gist.new gist}/star", options, 3, true, true)
-        response.status == 204
+        request(:delete, "gists/#{Gist.new gist}/star", options).status == 204
       end
 
       # Check if a gist is starred
@@ -106,7 +105,7 @@ module Octokit
       # @see http://developer.github.com/v3/gists/#check-if-a-gist-is-starred
       def gist_starred?(gist, options={})
         begin
-          get("gists/#{Gist.new gist}/star", options, 3, true, true)
+          get("gists/#{Gist.new gist}/star", options)
           return true
         rescue Octokit::NotFound
           return false
@@ -119,7 +118,7 @@ module Octokit
       # @return [Hashie::Mash] Data for the new gist
       # @see http://developer.github.com/v3/gists/#fork-a-gist
       def fork_gist(gist, options={})
-        post "gists/#{Gist.new gist}/fork", options, 3
+        post "gists/#{Gist.new gist}/fork", options
       end
 
       # Delete a gist
@@ -128,76 +127,79 @@ module Octokit
       # @return [Boolean] Indicating success of deletion
       # @see http://developer.github.com/v3/gists/#delete-a-gist
       def delete_gist(gist, options={})
-        response = delete("gists/#{Gist.new gist}", options, 3, true, true)
+        response = request(:delete, "gists/#{Gist.new gist}", options)
         response.status == 204
       end
 
       # List gist comments
       #
-      # @param gist_id [Integer] Gist Id.
+      # @param gist_id [String] Gist Id.
       # @return [Array<Hashie::Mash>] Array of hashes representing comments.
       # @see http://developer.github.com/v3/gists/comments/#list-comments-on-a-gist
       # @example
-      #   Octokit.gist_comments(3528645)
+      #   Octokit.gist_comments('3528ae645')
       def gist_comments(gist_id, options={})
-        get "gists/#{gist_id}/comments", options, 3
+        get "gists/#{gist_id}/comments", options
       end
 
       # Get gist comment
       #
+      # @param gist_id [String] Id of the gist.
       # @param gist_comment_id [Integer] Id of the gist comment.
       # @return [Hashie::Mash] Hash representing gist comment.
       # @see http://developer.github.com/v3/gists/comments/#get-a-single-comment
       # @example
-      #   Octokit.gist_comment(451398)
-      def gist_comment(gist_comment_id, options={})
-        get "gists/comments/#{gist_comment_id}", options, 3
+      #   Octokit.gist_comment('208sdaz3', 1451398)
+      def gist_comment(gist_id, gist_comment_id, options={})
+        get "gists/#{gist_id}/comments/#{gist_comment_id}", options
       end
 
       # Create gist comment
       #
       # Requires authenticated client.
       #
-      # @param gist_id [Integer] Id of the gist.
+      # @param gist_id [String] Id of the gist.
       # @param comment [String] Comment contents.
       # @return [Hashie::Mash] Hash representing the new comment.
       # @see Octokit::Client
       # @see http://developer.github.com/v3/gists/comments/#create-a-comment
       # @example
-      #   @client.create_gist_comment(3528645, 'This is very helpful.')
+      #   @client.create_gist_comment('3528645', 'This is very helpful.')
       def create_gist_comment(gist_id, comment, options={})
         options.merge!({:body => comment})
-        post "gists/#{gist_id}/comments", options, 3
+        post "gists/#{gist_id}/comments", options
       end
 
       # Update gist comment
       #
       # Requires authenticated client
       #
+      # @param gist_id [String] Id of the gist.
       # @param gist_comment_id [Integer] Id of the gist comment to update.
       # @param comment [String] Updated comment contents.
       # @return [Hashie::Mash] Hash representing the updated comment.
       # @see Octokit::Client
       # @see http://developer.github.com/v3/gists/comments/#edit-a-comment
       # @example
-      #   @client.update_gist_comment(3528645, ':heart:')
-      def update_gist_comment(gist_comment_id, comment, options={})
+      #   @client.update_gist_comment('208sdaz3', '3528645', ':heart:')
+      def update_gist_comment(gist_id, gist_comment_id, comment, options={})
         options.merge!({:body => comment})
-        patch "gists/comments/#{gist_comment_id}", options, 3
+        patch "gists/#{gist_id}/comments/#{gist_comment_id}", options
       end
 
       # Delete gist comment
       #
       # Requires authenticated client.
       #
+      # @param gist_id [String] Id of the gist.
       # @param gist_comment_id [Integer] Id of the gist comment to delete.
       # @return [Boolean] True if comment deleted, false otherwise.
       # @see Octokit::Client
       # @see http://developer.github.com/v3/gists/comments/#delete-a-comment
       # @example
-      #   @client.delete_gist_comment(586399)
-      def delete_gist_comment(gist_comment_id, options={})
-        delete("gists/comments/#{gist_comment_id}", options, 3, true, true).status == 204
+      #   @client.delete_gist_comment('208sdaz3', '586399')
+      def delete_gist_comment(gist_id, gist_comment_id, options={})
+        request(:delete, "gists/#{gist_id}/comments/#{gist_comment_id}", options).status == 204
       end
 
     end

data/lib/octokit/client/issues.rb

@@ -12,7 +12,7 @@ module Octokit
       # @example Search for 'test' in the open issues for sferik/rails_admin
       #   Octokit.search_issues("sferik/rails_admin", 'test', 'open')
       def search_issues(repo, search_term, state='open', options={})
-        get("legacy/issues/search/#{Repository.new(repo)}/#{state}/#{search_term}", options, 3)['issues']
+        get("legacy/issues/search/#{Repository.new(repo)}/#{state}/#{search_term}", options)['issues']
       end
 
       # List issues for a the authenticated user or repository
@@ -39,7 +39,7 @@ module Octokit
         path = ''
         path = "repos/#{Repository.new(repository)}" if repository
         path += "/issues"
-        get(path, options, 3)
+        get(path, options)
       end
       alias :issues :list_issues
 
@@ -53,7 +53,7 @@ module Octokit
       # @example Create a new Issues for a repository
       #   Octokit.create_issue("sferik/rails_admin")
       def create_issue(repo, title, body, options={})
-        post("repos/#{Repository.new(repo)}/issues", options.merge({:title => title, :body => body}), 3)
+        post("repos/#{Repository.new(repo)}/issues", options.merge({:title => title, :body => body}))
       end
       alias :open_issue :create_issue
 
@@ -66,7 +66,7 @@ module Octokit
       # @example Get issue #25 from pengwynn/octokit
       #   Octokit.issue("pengwynn/octokit", "25")
       def issue(repo, number, options={})
-        get("repos/#{Repository.new(repo)}/issues/#{number}", options, 3)
+        get("repos/#{Repository.new(repo)}/issues/#{number}", options)
       end
 
       # Close an issue
@@ -80,7 +80,7 @@ module Octokit
       # @example Close Issue #25 from pengwynn/octokit
       #   Octokit.close_issue("pengwynn/octokit", "25")
       def close_issue(repo, number, options={})
-        post("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "closed"}), 3)
+        post("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "closed"}))
       end
 
       # Reopen an issue
@@ -94,7 +94,7 @@ module Octokit
       # @example Reopen Issue #25 from pengwynn/octokit
       #   Octokit.reopen_issue("pengwynn/octokit", "25")
       def reopen_issue(repo, number, options={})
-        post("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "open"}), 3)
+        post("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "open"}))
       end
 
       # Update an issue
@@ -110,7 +110,7 @@ module Octokit
       # @example Change the title of Issue #25
       #   Octokit.update_issue("pengwynn/octokit", "25", "A new title", "the same body"")
       def update_issue(repo, number, title, body, options={})
-        post("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:title => title, :body => body}), 3)
+        post("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:title => title, :body => body}))
       end
 
       # Get all comments attached to an issue
@@ -122,7 +122,7 @@ module Octokit
       # @example Get comments for issue #25 from pengwynn/octokit
       #   Octokit.issue_comments("pengwynn/octokit", "25")
       def issue_comments(repo, number, options={})
-        get("repos/#{Repository.new(repo)}/issues/#{number}/comments", options, 3)
+        get("repos/#{Repository.new(repo)}/issues/#{number}/comments", options)
       end
 
       # Get a single comment attached to an issue
@@ -134,7 +134,7 @@ module Octokit
       # @example Get comments for issue #25 from pengwynn/octokit
       #   Octokit.issue_comments("pengwynn/octokit", "25")
       def issue_comment(repo, number, options={})
-        get("repos/#{Repository.new(repo)}/issues/comments/#{number}", options, 3)
+        get("repos/#{Repository.new(repo)}/issues/comments/#{number}", options)
       end
 
       # Add a comment to an issue
@@ -147,7 +147,7 @@ module Octokit
       # @example Add the comment "Almost to v1" to Issue #23 on pengwynn/octokit
       #   Octokit.add_comment("pengwynn/octokit", 23, "Almost to v1")
       def add_comment(repo, number, comment, options={})
-        post("repos/#{Repository.new(repo)}/issues/#{number}/comments", options.merge({:body => comment}), 3)
+        post("repos/#{Repository.new(repo)}/issues/#{number}/comments", options.merge({:body => comment}))
       end
 
       # Update a single comment on an issue
@@ -160,19 +160,19 @@ module Octokit
       # @example Update the comment "I've started this on my 25-issue-comments-v3 fork" on Issue #25 on pengwynn/octokit
       #   Octokit.update_comment("pengwynn/octokit", 25, "Almost to v1, added this on my fork")
       def update_comment(repo, number, comment, options={})
-        post("repos/#{Repository.new(repo)}/issues/comments/#{number}", options.merge({:body => comment}), 3)
+        post("repos/#{Repository.new(repo)}/issues/comments/#{number}", options.merge({:body => comment}))
       end
 
       # Delete a single comment
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [Integer] Comment number
-      # @return [Response] A response object with status
+      # @return [Boolean] Success
       # @see http://developer.github.com/v3/issues/comments/#delete-a-comment
       # @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={})
-        delete("repos/#{Repository.new(repo)}/issues/comments/#{number}", options, 3, true, true)
+        request(:delete, "repos/#{Repository.new(repo)}/issues/comments/#{number}", options).status == 204
       end
 
 
@@ -186,7 +186,7 @@ module Octokit
       # @example List all issues events for issue #38 on pengwynn/octokit
       #   Octokit.issue_events("pengwynn/octokit", 38)
       def issue_events(repo, number, options={})
-        get("repos/#{Repository.new(repo)}/issues/#{number}/events", options, 3)
+        get("repos/#{Repository.new(repo)}/issues/#{number}/events", options)
       end
 
       # Get information on a single Issue Event
@@ -199,7 +199,7 @@ module Octokit
       # @example Get Event information for ID 3094334 (a pull request was closed)
       #   Octokit.issue_event("pengwynn/octokit", 3094334)
       def issue_event(repo, number, options={})
-        get("repos/#{Repository.new(repo)}/issues/events/#{number}", options, 3)
+        get("repos/#{Repository.new(repo)}/issues/events/#{number}", options)
       end
 
     end

data/lib/octokit/client/labels.rb

@@ -12,7 +12,7 @@ module Octokit
       # @example List labels for pengwynn/octokit
       #   Octokit.labels("pengwynn/octokit")
       def labels(repo, options={})
-        get("repos/#{Repository.new(repo)}/labels", options, 3)
+        get("repos/#{Repository.new(repo)}/labels", options)
       end
 
       # Get single label for a repository
@@ -24,7 +24,7 @@ module Octokit
       # @example Get the "V3 Addition" label from pengwynn/octokit
       #   Octokit.labels("pengwynn/octokit")
       def label(repo, name, options={})
-        get("repos/#{Repository.new(repo)}/labels/#{CGI.escape(name)}", options, 3)
+        get("repos/#{Repository.new(repo)}/labels/#{CGI.escape(name)}", options)
       end
 
       # Add a label to a repository
@@ -37,7 +37,7 @@ module Octokit
       # @example Add a new label "Version 1.0" with color "#cccccc"
       #   Octokit.add_label("pengwynn/octokit", "Version 1.0", "cccccc")
       def add_label(repo, label, color="ffffff", options={})
-        post("repos/#{Repository.new(repo)}/labels", options.merge({:name => label, :color => color}), 3)
+        post("repos/#{Repository.new(repo)}/labels", options.merge({:name => label, :color => color}))
       end
 
       # Update a label
@@ -52,7 +52,7 @@ module Octokit
       # @example Update the label "Version 1.0" with new color "#cceeaa"
       #   Octokit.update_label("pengwynn/octokit", "Version 1.0", {:color => "cceeaa"})
       def update_label(repo, label, options={})
-        post("repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options, 3)
+        post("repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options)
       end
 
       # Delete a label from a repository.
@@ -61,13 +61,13 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param label [String] String name of the label
-      # @return [Response] A Faraday Response object
+      # @return [Boolean] Success
       # @see http://developer.github.com/v3/issues/labels/#delete-a-label
       # @see http://rubydoc.info/gems/faraday/0.5.3/Faraday/Response
       # @example Delete the label "Version 1.0" from the repository.
       #   Octokit.delete_label!("pengwynn/octokit", "Version 1.0")
       def delete_label!(repo, label, options={})
-        delete("repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options, 3, true, true)
+        request(:delete, "repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options).status == 204
       end
 
       # Remove a label from an Issue
@@ -83,7 +83,7 @@ module Octokit
       # @example Remove the label "Version 1.0" from the repository.
       #   Octokit.remove_label("pengwynn/octokit", 23, "Version 1.0")
       def remove_label(repo, number, label, options={})
-        delete("repos/#{Repository.new(repo)}/issues/#{number}/labels/#{CGI.escape(label)}", options, 3, true)
+        delete("repos/#{Repository.new(repo)}/issues/#{number}/labels/#{CGI.escape(label)}", options)
       end
 
       # Remove all label from an Issue
@@ -92,12 +92,12 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the issue
-      # @return [Array] A list of the labels currently on the issue
+      # @return [Boolean] Success of operation
       # @see http://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue
       # @example Remove all labels from Issue #23
       #   Octokit.remove_all_labels("pengwynn/octokit", 23)
       def remove_all_labels(repo, number, options={})
-        delete("repos/#{Repository.new(repo)}/issues/#{number}/labels", options, 3, true, true)
+        request(:delete, "repos/#{Repository.new(repo)}/issues/#{number}/labels", options).status == 204
       end
 
       # List labels for a given issue
@@ -109,7 +109,7 @@ module Octokit
       # @example List labels for pengwynn/octokit
       #   Octokit.labels("pengwynn/octokit")
       def labels_for_issue(repo, number, options={})
-        get("repos/#{Repository.new(repo)}/issues/#{number}/labels", options, 3)
+        get("repos/#{Repository.new(repo)}/issues/#{number}/labels", options)
       end
 
       # Add label(s) to an Issue
@@ -122,7 +122,7 @@ module Octokit
       # @example Add two labels for pengwynn/octokit
       #   Octokit.add_labels_to_an_issue("pengwynn/octokit", 10, ['V3 Transition', 'Improvement'])
       def add_labels_to_an_issue(repo, number, labels)
-        post("repos/#{Repository.new(repo)}/issues/#{number}/labels", labels, 3)
+        post("repos/#{Repository.new(repo)}/issues/#{number}/labels", labels)
       end
 
       # Replace all labels on an Issue
@@ -135,7 +135,7 @@ module Octokit
       # @example Replace labels for pengwynn/octokit Issue #10
       #   Octokit.replace_all_labels("pengwynn/octokit", 10, ['V3 Transition', 'Improvement'])
       def replace_all_labels(repo, number, labels, options={})
-        put("repos/#{Repository.new(repo)}/issues/#{number}/labels", labels, 3)
+        put("repos/#{Repository.new(repo)}/issues/#{number}/labels", labels)
       end
 
       # Get labels for every issue in a milestone
@@ -147,7 +147,7 @@ module Octokit
       # @example List all labels for milestone #2 on pengwynn/octokit
       #   Octokit.labels_for_milestone("pengwynn/octokit", 2)
       def labels_for_milestone(repo, number, options={})
-        get("repos/#{Repository.new(repo)}/milestones/#{number}/labels", options, 3)
+        get("repos/#{Repository.new(repo)}/milestones/#{number}/labels", options)
       end
 
     end