octokit 1.25.0 → 2.0.0.pre

data/lib/octokit/client/gitignore.rb

@@ -1,5 +1,9 @@
 module Octokit
   class Client
+
+    # Methods for the Gitignore API
+    #
+    # @see http://developer.github.com/v3/gitignore/
     module Gitignore
 
       # Listing available gitignore templates.
@@ -14,7 +18,7 @@ module Octokit
       # @example Git all the gitignore templates
       #   @client.gitignore_templates
       def gitignore_templates(options={})
-        get "/gitignore/templates", options
+        get "gitignore/templates", options
       end
 
       # Get a gitignore template.
@@ -28,12 +32,12 @@ module Octokit
       #
       # @see http://developer.github.com/v3/gitignore/#get-a-single-template
       #
-      # @return [Hash] Gitignore template
+      # @return [Sawyer::Resource] Gitignore template
       #
       # @example Get the Ruby gitignore template
       #   @client.gitignore_template('Ruby')
       def gitignore_template(template_name, options={})
-        get "/gitignore/templates/#{template_name}", options
+        get "gitignore/templates/#{template_name}", options
       end
 
     end

data/lib/octokit/client/issues.rb

@@ -1,23 +1,15 @@
 module Octokit
   class Client
-    module Issues
 
-      # Search issues within a repository
-      #
-      # @param repo [String, Repository, Hash] A GitHub repository
-      # @param search_term [String] The term to search for
-      # @param state [String] :state (open) <tt>open</tt> or <tt>closed</tt>.
-      # @return [Array] A list of issues matching the search term and state
-      # @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)['issues']
-      end
+    # Methods for the Issues API
+    #
+    # @see http://developer.github.com/v3/issues/
+    module Issues
 
       # List issues for a the authenticated user or repository
       #
       # @param repository [String, Repository, Hash] A GitHub repository.
-      # @param options [Hash] A customizable set of options.
+      # @param options [Sawyer::Resource] A customizable set of options.
       # @option options [Integer] :milestone Milestone number.
       # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
       # @option options [String] :assignee User login.
@@ -27,7 +19,7 @@ module Octokit
       # @option options [String] :sort (created) Sort: <tt>created</tt>, <tt>updated</tt>, or <tt>comments</tt>.
       # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
       # @option options [Integer] :page (1) Page number.
-      # @return [Array] A list of issues for a repository.
+      # @return [Array<Sawyer::Resource>] A list of issues for a repository.
       # @see http://developer.github.com/v3/issues/#list-issues-for-this-repository
       # @example List issues for a repository
       #   Octokit.list_issues("sferik/rails_admin")
@@ -38,13 +30,14 @@ module Octokit
         path = ''
         path = "repos/#{Repository.new(repository)}" if repository
         path += "/issues"
-        get(path, options)
+
+        paginate path, options
       end
       alias :issues :list_issues
 
       # List all issues across owned and member repositories for the authenticated user
       #
-      # @param options [Hash] A customizable set of options.
+      # @param options [Sawyer::Resource] A customizable set of options.
       # @option options [String] :filter (assigned) State: <tt>assigned</tt>, <tt>created</tt>, <tt>mentioned</tt>, <tt>subscribed</tt> or <tt>closed</tt>.
       # @option options [String] :state (open) State: <tt>open</tt> or <tt>all</tt>.
       # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
@@ -53,19 +46,19 @@ module Octokit
       # @option options [Integer] :page (1) Page number.
       # @option options [String] :since Timestamp in ISO 8601
       #   format: YYYY-MM-DDTHH:MM:SSZ
-      # @return [Array] A list of issues for a repository.
+      # @return [Array<Sawyer::Resource>] A list of issues for a repository.
       # @see http://developer.github.com/v3/issues/#list-issues
       # @example List issues for the authenticted user across owned and member repositories
       #   @client = Octokit::Client.new(:login => 'foo', :password => 'bar')
       #   @client.user_issues
       def user_issues(options={})
-        get('/user/issues', options)
+        paginate 'user/issues', options
       end
-      
+
       # List all issues for a given organization for the authenticated user
       #
       # @param org [String] Organization GitHub username.
-      # @param options [Hash] A customizable set of options.
+      # @param options [Sawyer::Resource] A customizable set of options.
       # @option options [String] :filter (assigned) State: <tt>assigned</tt>, <tt>created</tt>, <tt>mentioned</tt>, <tt>subscribed</tt> or <tt>closed</tt>.
       # @option options [String] :state (open) State: <tt>open</tt> or <tt>all</tt>.
       # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
@@ -74,13 +67,13 @@ module Octokit
       # @option options [Integer] :page (1) Page number.
       # @option options [String] :since Timestamp in ISO 8601
       #   format: YYYY-MM-DDTHH:MM:SSZ
-      # @return [Array] A list of issues for a repository.
+      # @return [Array<Sawyer::Resource>] A list of issues for a repository.
       # @see http://developer.github.com/v3/issues/#list-issues
       # @example List issues for the authenticted user across owned and member repositories
       #   @client = Octokit::Client.new(:login => 'foo', :password => 'bar')
       #   @client.user_issues
       def org_issues(org, options={})
-        get("/orgs/#{org}/issues", options)
+        paginate "orgs/#{org}/issues", options
       end
 
       # Create an issue for a repository
@@ -92,12 +85,18 @@ module Octokit
       # @option options [String] :assignee User login.
       # @option options [Integer] :milestone Milestone number.
       # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
-      # @return [Issue] Your newly created issue
+      # @return [Sawyer::Resource] Your newly created issue
       # @see http://developer.github.com/v3/issues/#create-an-issue
       # @example Create a new Issues for a repository
       #   Octokit.create_issue("sferik/rails_admin", 'Updated Docs', 'Added some extra links')
       def create_issue(repo, title, body, options={})
-        post("repos/#{Repository.new(repo)}/issues", options.merge({:title => title, :body => body}))
+        options[:labels] = case options[:labels]
+                           when String
+                             options[:labels].split(",").map(&:strip)
+                           when Array
+                             options[:labels]
+                           end
+        post "repos/#{Repository.new(repo)}/issues", options.merge({:title => title, :body => body})
       end
       alias :open_issue :create_issue
 
@@ -105,12 +104,12 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the issue
-      # @return [Issue] The issue you requested, if it exists
+      # @return [Sawyer::Resource] The issue you requested, if it exists
       # @see http://developer.github.com/v3/issues/#get-a-single-issue
       # @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)
+        get "repos/#{Repository.new(repo)}/issues/#{number}", options
       end
 
       # Close an issue
@@ -121,12 +120,12 @@ module Octokit
       # @option options [String] :assignee User login.
       # @option options [Integer] :milestone Milestone number.
       # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
-      # @return [Issue] The updated Issue
+      # @return [Sawyer::Resource] The updated Issue
       # @see http://developer.github.com/v3/issues/#edit-an-issue
       # @example Close Issue #25 from pengwynn/octokit
       #   Octokit.close_issue("pengwynn/octokit", "25")
       def close_issue(repo, number, options={})
-        patch("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "closed"}))
+        patch "repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "closed"})
       end
 
       # Reopen an issue
@@ -137,12 +136,12 @@ module Octokit
       # @option options [String] :assignee User login.
       # @option options [Integer] :milestone Milestone number.
       # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
-      # @return [Issue] The updated Issue
+      # @return [Sawyer::Resource] The updated Issue
       # @see http://developer.github.com/v3/issues/#edit-an-issue
       # @example Reopen Issue #25 from pengwynn/octokit
       #   Octokit.reopen_issue("pengwynn/octokit", "25")
       def reopen_issue(repo, number, options={})
-        patch("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "open"}))
+        patch "repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:state => "open"})
       end
 
       # Update an issue
@@ -156,12 +155,12 @@ module Octokit
       # @option options [Integer] :milestone Milestone number.
       # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       # @option options [String] :state State of the issue. <tt>open</tt> or <tt>closed</tt>
-      # @return [Issue] The updated Issue
+      # @return [Sawyer::Resource] The updated Issue
       # @see http://developer.github.com/v3/issues/#edit-an-issue
       # @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={})
-        patch("repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:title => title, :body => body}))
+        patch "repos/#{Repository.new(repo)}/issues/#{number}", options.merge({:title => title, :body => body})
       end
 
       # Get all comments attached to issues for the repository
@@ -176,7 +175,7 @@ module Octokit
       # @option options [String] :since Timestamp in ISO 8601
       #   format: YYYY-MM-DDTHH:MM:SSZ
       #
-      # @return [Array] List of issues comments.
+      # @return [Array<Sawyer::Resource>] List of issues comments.
       #
       # @see http://developer.github.com/v3/issues/comments/#list-comments-in-a-repository
       #
@@ -186,35 +185,35 @@ module Octokit
       # @example Get issues comments, sort by updated descending since a time
       #   @client.issues_comments("pengwynn/octokit", {
       #     :sort => 'desc',
-      #     :direction => 'down',
+      #     :direction => 'asc',
       #     :since => '2010-05-04T23:45:02Z'
       #   })
       def issues_comments(repo, options={})
-        get "/repos/#{Repository.new repo}/issues/comments", options
+        paginate "repos/#{Repository.new repo}/issues/comments", options
       end
 
       # Get all comments attached to an issue
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the issue
-      # @return [Array] Array of comments that belong to an issue
+      # @return [Array<Sawyer::Resource>] Array of comments that belong to an issue
       # @see http://developer.github.com/v3/issues/comments
       # @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)
+        paginate "repos/#{Repository.new(repo)}/issues/#{number}/comments", options
       end
 
       # Get a single comment attached to an issue
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the comment
-      # @return [Comment] The specific comment in question
+      # @return [Sawyer::Resource] The specific comment in question
       # @see http://developer.github.com/v3/issues/comments/#get-a-single-comment
       # @example Get comment #1194549 from an issue on pengwynn/octokit
       #   Octokit.issue_comments("pengwynn/octokit", 1194549)
       def issue_comment(repo, number, options={})
-        get("repos/#{Repository.new(repo)}/issues/comments/#{number}", options)
+        paginate "repos/#{Repository.new(repo)}/issues/comments/#{number}", options
       end
 
       # Add a comment to an issue
@@ -222,12 +221,12 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [Integer] Issue number
       # @param comment [String] Comment to be added
-      # @return [Comment] A JSON encoded Comment
+      # @return [Sawyer::Resource] Comment
       # @see http://developer.github.com/v3/issues/comments/#create-a-comment
       # @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}))
+        post "repos/#{Repository.new(repo)}/issues/#{number}/comments", options.merge({:body => comment})
       end
 
       # Update a single comment on an issue
@@ -235,12 +234,12 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [Integer] Comment number
       # @param comment [String] Body of the comment which will replace the existing body.
-      # @return [Comment] A JSON encoded Comment
+      # @return [Sawyer::Resource] Comment
       # @see http://developer.github.com/v3/issues/comments/#edit-a-comment
       # @example Update the comment #1194549 with body "I've started this on my 25-issue-comments-v3 fork" on an issue on pengwynn/octokit
       #   Octokit.update_comment("pengwynn/octokit", 1194549, "Almost to v1, added this on my fork")
       def update_comment(repo, number, comment, options={})
-        patch("repos/#{Repository.new(repo)}/issues/comments/#{number}", options.merge({:body => comment}))
+        patch "repos/#{Repository.new(repo)}/issues/comments/#{number}", options.merge({:body => comment})
       end
 
       # Delete a single comment
@@ -252,35 +251,8 @@ module Octokit
       # @example Delete the comment #1194549 on an issue on pengwynn/octokit
       #   Octokit.delete_comment("pengwynn/octokit", 1194549)
       def delete_comment(repo, number, options={})
-        boolean_from_response(:delete, "repos/#{Repository.new(repo)}/issues/comments/#{number}", options)
-      end
-
-      # List events for an Issue
-      #
-      # @param repo [String, Repository, Hash] A GitHub repository
-      # @param number [Integer] Issue number
-      #
-      # @return [Array] Array of events for that issue
-      # @see http://developer.github.com/v3/issues/events/#list-events-for-an-issue
-      # @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)
+        boolean_from_response :delete, "repos/#{Repository.new(repo)}/issues/comments/#{number}", options
       end
-
-      # Get information on a single Issue Event
-      #
-      # @param repo [String, Repository, Hash] A GitHub repository
-      # @param number [Integer] Event number
-      #
-      # @return [Event] A single Event for an Issue
-      # @see http://developer.github.com/v3/issues/events/#get-a-single-event
-      # @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)
-      end
-
     end
   end
 end

data/lib/octokit/client/labels.rb

@@ -2,29 +2,33 @@ require 'cgi'
 
 module Octokit
   class Client
+
+    # Methods for the Issue Labels API
+    #
+    # @see http://developer.github.com/v3/issues/labels/
     module Labels
 
       # List available labels for a repository
       #
       # @param repo [String, Repository, Hash] A GitHub repository
-      # @return [Array] A list of the labels across the repository
+      # @return [Array<Sawyer::Resource>] A list of the labels across the repository
       # @see http://developer.github.com/v3/issues/labels/
       # @example List labels for pengwynn/octokit
       #   Octokit.labels("pengwynn/octokit")
       def labels(repo, options={})
-        get("repos/#{Repository.new(repo)}/labels", options)
+        get "repos/#{Repository.new(repo)}/labels", options
       end
 
       # Get single label for a repository
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param name [String] Name of the label
-      # @return [Label] A single label from the repository
+      # @return [Sawyer::Resource] A single label from the repository
       # @see http://developer.github.com/v3/issues/labels/#get-a-single-label
       # @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)
+        get "repos/#{Repository.new(repo)}/labels/#{CGI.escape(name)}", options
       end
 
       # Add a label to a repository
@@ -32,12 +36,12 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param label [String] A new label
       # @param color [String] A color, in hex, without the leading #
-      # @return [Label] A Hashie of the new label
+      # @return [Sawyer::Resource] The new label
       # @see http://developer.github.com/v3/issues/labels/
       # @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}))
+        post "repos/#{Repository.new(repo)}/labels", options.merge({:name => label, :color => color})
       end
 
       # Update a label
@@ -47,12 +51,12 @@ module Octokit
       # @param options [Hash] A customizable set of options.
       # @option options [String] :title An updated label name
       # @option options [String] :color An updated color value, in hex, without leading #
-      # @return [Label] A Hashie of the updated label
+      # @return [Sawyer::Resource] The updated label
       # @see http://developer.github.com/v3/issues/labels/#update-a-label
       # @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={})
-        patch("repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options)
+        patch "repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options
       end
 
       # Delete a label from a repository.
@@ -67,7 +71,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={})
-        boolean_from_response(:delete, "repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options)
+        boolean_from_response :delete, "repos/#{Repository.new(repo)}/labels/#{CGI.escape(label)}", options
       end
 
       # Remove a label from an Issue
@@ -77,13 +81,13 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the issue
       # @param label [String] String name of the label
-      # @return [Array] A list of the labels currently on the issue
+      # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see http://rubydoc.info/gems/faraday/0.5.3/Faraday/Response
       # @see http://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
       # @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)
+        delete "repos/#{Repository.new(repo)}/issues/#{number}/labels/#{CGI.escape(label)}", options
       end
 
       # Remove all label from an Issue
@@ -97,19 +101,19 @@ module Octokit
       # @example Remove all labels from Issue #23
       #   Octokit.remove_all_labels("pengwynn/octokit", 23)
       def remove_all_labels(repo, number, options={})
-        boolean_from_response(:delete, "repos/#{Repository.new(repo)}/issues/#{number}/labels", options)
+        boolean_from_response :delete, "repos/#{Repository.new(repo)}/issues/#{number}/labels", options
       end
 
       # List labels for a given issue
       #
       # @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 [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see http://developer.github.com/v3/issues/labels/#list-labels-on-an-issue
       # @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)
+        get "repos/#{Repository.new(repo)}/issues/#{number}/labels", options
       end
 
       # Add label(s) to an Issue
@@ -117,12 +121,12 @@ module Octokit
       # @param repo [String, Repository, Hash] A Github repository
       # @param number [String] Number ID of the issue
       # @param labels [Array] An array of labels to apply to this Issue
-      # @return [Array] A list of the labels currently on the issue
+      # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see http://developer.github.com/v3/issues/labels/#add-labels-to-an-issue
       # @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)
+        post "repos/#{Repository.new(repo)}/issues/#{number}/labels", labels
       end
 
       # Replace all labels on an Issue
@@ -130,24 +134,24 @@ module Octokit
       # @param repo [String, Repository, Hash] A Github repository
       # @param number [String] Number ID of the issue
       # @param labels [Array] An array of labels to use as replacement
-      # @return [Array] A list of the labels currently on the issue
+      # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see http://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue
       # @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)
+        put "repos/#{Repository.new(repo)}/issues/#{number}/labels", labels
       end
 
       # Get labels for every issue in a milestone
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param number [String] Number ID of the milestone
-      # @return [Array] A list of the labels across the milestone
+      # @return [Array<Sawyer::Resource>] A list of the labels across the milestone
       # @see  http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone
       # @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)
+        get "repos/#{Repository.new(repo)}/milestones/#{number}/labels", options
       end
 
     end