octokit 2.6.3 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c93fb54eadaba45488569de4fc7160ba8194bf9a
-  data.tar.gz: 992710f4fe8a85fbcc7e7e394fe58a8cb7cf4346
+  metadata.gz: 44e64ada68666da82947ca24101ba7211dc42719
+  data.tar.gz: 03696bbca61e9dbea82b41b972046997cc865d9e
 SHA512:
-  metadata.gz: 58d8dd778c6424ec1555e6ea289f9686af318666d13a8d879f2493cd66d740e16329fb02e6ca6bb2083673c21ca42a5d0c869c01bd783bf58a1cd9e02ce65cc5
-  data.tar.gz: 2804410d31065bba88f8ece234e34e41eb3da6ab5935f7312196502bf4304b0e8cf22006e8f2494a448d5f66f7096006c86466d197fce7d0a9dbe7c4f25076ba
+  metadata.gz: b0ad9385e3c93bc1caa5c0c5b08554f44ac4577dcc578898e1522a1aaf8d0e7a99dfa380a43015c091bfffcfc6c63f4ca73a44a4de2775c0e17a620753ff16b6
+  data.tar.gz: 3f6f16e93823cb57be96d2999c7a04b33d9cb078a73570276ec7eba6da944db0a46d96c6590e6e22a61601143bfdabcef5644a783ad4bdbb7ada318b4a973f9c

data/CONTRIBUTING.md

@@ -5,9 +5,9 @@
 1. [Fork the repository.][fork]
 2. [Create a topic branch.][branch]
 3. Add specs for your unimplemented feature or bug fix.
-4. Run `bundle exec rspec-queue spec`. If your specs pass, return to step 3.
+4. Run `script/test`. If your specs pass, return to step 3.
 5. Implement your feature or bug fix.
-6. Run `bundle exec rspec-queue spec`. If your specs fail, return to step 5.
+6. Run `script/test`. If your specs fail, return to step 5.
 7. Run `open coverage/index.html`. If your changes are not completely covered
    by your tests, return to step 3.
 8. Add documentation for your feature or bug fix.

data/lib/octokit/client.rb

@@ -13,6 +13,7 @@ require 'octokit/client/contents'
 require 'octokit/client/downloads'
 require 'octokit/client/emojis'
 require 'octokit/client/events'
+require 'octokit/client/feeds'
 require 'octokit/client/gists'
 require 'octokit/client/gitignore'
 require 'octokit/client/hooks'
@@ -54,6 +55,7 @@ module Octokit
     include Octokit::Client::Downloads
     include Octokit::Client::Emojis
     include Octokit::Client::Events
+    include Octokit::Client::Feeds
     include Octokit::Client::Gists
     include Octokit::Client::Gitignore
     include Octokit::Client::Hooks
@@ -178,8 +180,12 @@ module Octokit
     #
     # @param url [String] The path, relative to {#api_endpoint}
     # @param options [Hash] Query and header params for request
+    # @param block [Block] Block to perform the data concatination of the
+    #   multiple requests. The block is called with two parameters, the first
+    #   contains the contents of the requests so far and the second parameter
+    #   contains the latest response. 
     # @return [Sawyer::Resource]
-    def paginate(url, options = {})
+    def paginate(url, options = {}, &block)
       opts = parse_query_and_convenience_headers(options.dup)
       if @auto_paginate || @per_page
         opts[:query][:per_page] ||=  @per_page || (@auto_paginate ? 100 : nil)
@@ -187,10 +193,14 @@ module Octokit
 
       data = request(:get, url, opts)
 
-      if @auto_paginate && data.is_a?(Array)
+      if @auto_paginate
         while @last_response.rels[:next] && rate_limit.remaining > 0
           @last_response = @last_response.rels[:next].get
-          data.concat(@last_response.data) if @last_response.data.is_a?(Array)
+          if block_given?
+            yield(data, @last_response)
+          else
+            data.concat(@last_response.data) if @last_response.data.is_a?(Array)
+          end
         end
 
       end

data/lib/octokit/client/commit_comments.rb

@@ -10,7 +10,7 @@ module Octokit
       #
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Array] List of commit comments
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository
       def list_commit_comments(repo, options = {})
         get "repos/#{Repository.new(repo)}/comments", options
       end
@@ -20,7 +20,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param sha [String] The SHA of the commit whose comments will be fetched
       # @return [Array]  List of commit comments
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit
       def commit_comments(repo, sha, options = {})
         get "repos/#{Repository.new(repo)}/commits/#{sha}/comments", options
       end
@@ -30,7 +30,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param id [String] The ID of the comment to fetch
       # @return [Sawyer::Resource] Commit comment
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment
       def commit_comment(repo, id, options = {})
         get "repos/#{Repository.new(repo)}/comments/#{id}", options
       end
@@ -44,7 +44,7 @@ module Octokit
       # @param line [Integer] Line number in the file to comment on
       # @param position [Integer] Line index in the diff to comment on
       # @return [Sawyer::Resource] Commit comment
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#create-a-commit-comment
       # @example Create a commit comment
       #   commit = Octokit.create_commit_comment("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132", "My comment message", "README.md", 10, 1)
       #   commit.commit_id # => "827efc6d56897b048c772eb4087f854f46256132"
@@ -69,7 +69,7 @@ module Octokit
       # @param id [String] The ID of the comment to update
       # @param body [String] Message
       # @return [Sawyer::Resource] Updated commit comment
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#update-a-commit-comment
       # @example Update a commit comment
       #   commit = Octokit.update_commit_comment("octocat/Hello-World", "860296", "Updated commit comment")
       #   commit.id # => 860296
@@ -86,7 +86,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param id [String] The ID of the comment to delete
       # @return [Boolean] Success
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#delete-a-commit-comment
       def delete_commit_comment(repo, id, options = {})
         boolean_from_response :delete, "repos/#{Repository.new(repo)}/comments/#{id}", options
       end

data/lib/octokit/client/commits.rb

@@ -19,7 +19,7 @@ module Octokit
       #   @param repo [String, Hash, Repository] A GitHub repository
       #   @param options [String] :sha Commit SHA or branch name from which to start the list
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/
+      # @see http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
       def commits(*args)
         arguments = Octokit::RepoArguments.new(args)
         sha_or_branch = arguments.pop
@@ -43,7 +43,7 @@ module Octokit
       #   @param sha_or_branch [String] A commit SHA or branch name
       #   @param options [String] :sha Commit SHA or branch name from which to start the list
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/
+      # @see http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
       # @example
       #   Octokit.commits_since('octokit/octokit.rb', '2012-10-01')
       def commits_since(*args)
@@ -70,7 +70,7 @@ module Octokit
       #   @param date [String] Date on which we want to compare
       #   @param sha_or_branch [String] Commit SHA or branch name from which to start the list
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/
+      # @see http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
       # @example
       #   Octokit.commits_before('octokit/octokit.rb', '2012-10-01')
       def commits_before(*args)
@@ -97,7 +97,7 @@ module Octokit
       #   @param date [String] Date on which we want to compare
       #   @param sha_or_branch [String] Commit SHA or branch name from which to start the list
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/
+      # @see http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
       # @example
       #   Octokit.commits_on('octokit/octokit.rb', '2012-10-01')
       def commits_on(*args)
@@ -126,7 +126,7 @@ module Octokit
       #   @param end_date [String] End Date on which we want to compare
       #   @param sha_or_branch [String] Commit SHA or branch name from which to start the list
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
-      # @see http://developer.github.com/v3/repos/commits/
+      # @see http://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
       # @example
       #   Octokit.commits_on('octokit/octokit.rb', '2012-10-01', '2012-11-01')
       def commits_between(*args)
@@ -149,11 +149,21 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param sha [String] The SHA of the commit to fetch
       # @return [Sawyer::Resource] A hash representing the commit
-      # @see http://developer.github.com/v3/repos/commits/
+      # @see http://developer.github.com/v3/repos/commits/#get-a-single-commit
       def commit(repo, sha, options = {})
         get "repos/#{Repository.new(repo)}/commits/#{sha}", options
       end
 
+      # Get a detailed git commit
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository
+      # @param sha [String] The SHA of the commit to fetch
+      # @return [Sawyer::Resource] A hash representing the commit
+      # @see http://developer.github.com/v3/git/commits/#get-a-commit
+      def git_commit(repo, sha, options = {})
+        get "repos/#{Repository.new(repo)}/git/commits/#{sha}", options
+      end
+
       # Create a commit
       #
       # Optionally pass <tt>author</tt> and <tt>committer</tt> hashes in <tt>options</tt>
@@ -166,7 +176,7 @@ module Octokit
       # @param tree [String] The SHA of the tree object the new commit will point to
       # @param parents [String, Array] One SHA (for a normal commit) or an array of SHAs (for a merge) of the new commit's parent commits. If ommitted or empty, a root commit will be created
       # @return [Sawyer::Resource] A hash representing the new commit
-      # @see http://developer.github.com/v3/git/commits/
+      # @see http://developer.github.com/v3/git/commits/#create-a-commit
       # @example Create a commit
       #   commit = Octokit.create_commit("octocat/Hello-World", "My commit message", "827efc6d56897b048c772eb4087f854f46256132", "7d1b31e74ee336d15cbd21741bc88a537ed063a0")
       #   commit.sha # => "7638417db6d59f3c431d3e1f261cc637155684cd"
@@ -183,7 +193,7 @@ module Octokit
       #
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Array] An array of hashes representing comments
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#list-commit-comments-for-a-repository
       def list_commit_comments(repo, options = {})
         get "repos/#{Repository.new(repo)}/comments", options
       end
@@ -193,7 +203,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param sha [String] The SHA of the commit whose comments will be fetched
       # @return [Array] An array of hashes representing comments
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#list-comments-for-a-single-commit
       def commit_comments(repo, sha, options = {})
         get "repos/#{Repository.new(repo)}/commits/#{sha}/comments", options
       end
@@ -203,7 +213,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param id [String] The ID of the comment to fetch
       # @return [Sawyer::Resource] A hash representing the comment
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#get-a-single-commit-comment
       def commit_comment(repo, id, options = {})
         get "repos/#{Repository.new(repo)}/comments/#{id}", options
       end
@@ -217,7 +227,7 @@ module Octokit
       # @param line [Integer] Line number in the file to comment on
       # @param position [Integer] Line index in the diff to comment on
       # @return [Sawyer::Resource] A hash representing the new commit comment
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#create-a-commit-comment
       # @example Create a commit comment
       #   commit = Octokit.create_commit_comment("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132", "My comment message", "README.md", 10, 1)
       #   commit.commit_id # => "827efc6d56897b048c772eb4087f854f46256132"
@@ -242,7 +252,7 @@ module Octokit
       # @param id [String] The ID of the comment to update
       # @param body [String] Message
       # @return [Sawyer::Resource] A hash representing the updated commit comment
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#update-a-commit-comment
       # @example Update a commit comment
       #   commit = Octokit.update_commit_comment("octocat/Hello-World", "860296", "Updated commit comment")
       #   commit.id # => 860296
@@ -259,7 +269,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param id [String] The ID of the comment to delete
       # @return [nil] nil
-      # @see http://developer.github.com/v3/repos/comments/
+      # @see http://developer.github.com/v3/repos/comments/#delete-a-commit-comment
       def delete_commit_comment(repo, id, options = {})
         boolean_from_response :delete, "repos/#{Repository.new(repo)}/comments/#{id}", options
       end
@@ -270,7 +280,7 @@ module Octokit
       # @param start [String] The sha of the starting commit
       # @param endd [String] The sha of the ending commit
       # @return [Sawyer::Resource] A hash representing the comparison
-      # @see http://developer.github.com/v3/repos/commits/
+      # @see http://developer.github.com/v3/repos/commits/#compare-two-commits
       def compare(repo, start, endd, options = {})
         get "repos/#{Repository.new(repo)}/compare/#{start}...#{endd}", options
       end
@@ -282,7 +292,7 @@ module Octokit
       # @param head [String] The branch or SHA1 to merge
       # @option options [String] :commit_message The commit message for the merge
       # @return [Sawyer::Resource] A hash representing the comparison
-      # @see http://developer.github.com/v3/repos/merging/
+      # @see http://developer.github.com/v3/repos/merging/#perform-a-merge
       def merge(repo, base, head, options = {})
         params = {
           :base => base,

data/lib/octokit/client/contents.rb

@@ -13,7 +13,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to “master”.
       # @return [Sawyer::Resource] The detail of the readme
-      # @see http://developer.github.com/v3/repos/contents/
+      # @see http://developer.github.com/v3/repos/contents/#get-the-readme
       # @example Get the readme file for a repo
       #   Octokit.readme("octokit/octokit.rb")
       def readme(repo, options={})
@@ -26,7 +26,7 @@ module Octokit
       # @option options [String] :path A folder or file path
       # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to “master”.
       # @return [Sawyer::Resource] The contents of a file or list of the files in the folder
-      # @see http://developer.github.com/v3/repos/contents/
+      # @see http://developer.github.com/v3/repos/contents/#get-contents
       # @example List the contents of lib/octokit.rb
       #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb')
       def contents(repo, options={})
@@ -146,7 +146,7 @@ module Octokit
       # @option options format [String] Either tarball (default) or zipball.
       # @option options [String] :ref Optional valid Git reference, defaults to master.
       # @return [String] Location of the download
-      # @see http://developer.github.com/v3/repos/contents/
+      # @see http://developer.github.com/v3/repos/contents/#get-archive-link
       # @example Get archive link for octokit/octokit.rb
       #   Octokit.archive_link("octokit/octokit.rb")
       def archive_link(repo, options={})

data/lib/octokit/client/downloads.rb

@@ -75,7 +75,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param id [Integer] ID of the download
       # @deprecated As of December 11th, 2012: https://github.com/blog/1302-goodbye-uploads
-      # @see http://developer.github.com/v3/repos/downloads/#delete-a-single-download
+      # @see http://developer.github.com/v3/repos/downloads/#delete-a-download
       # @return [Boolean] Status
       # @example Get the "Robawt" download from Github/Hubot
       #   Octokit.delete_download("github/hubot", 1234)

data/lib/octokit/client/emojis.rb

@@ -7,6 +7,7 @@ module Octokit
       # List all emojis used on GitHub
       #
       # @return [Sawyer::Resource] A list of all emojis on GitHub
+      # @see http://developer.github.com/v3/emojis/#emojis
       # @example List all emojis
       #   Octokit.emojis
       def emojis(options = {})

data/lib/octokit/client/events.rb

@@ -110,6 +110,7 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] Array of all Issue Events for this Repository
       # @see http://developer.github.com/v3/issues/events/#list-events-for-a-repository
+      # @see http://developer.github.com/v3/activity/events/#list-issue-events-for-a-repository
       # @example Get all Issue Events for Octokit
       #   Octokit.repository_issue_events("octokit/octokit.rb")
       def repository_issue_events(repo, options = {})

data/lib/octokit/client/feeds.rb

@@ -0,0 +1,33 @@
+module Octokit
+  class Client
+
+    # Methods for the Feeds API
+    #
+    # @see http://developer.github.com/v3/activity/feeds/
+    module Feeds
+
+      # List Feeds
+      #
+      # The feeds returned depend on authentication, see the GitHub API docs
+      # for more information.
+      #
+      # @return [Array<Sawyer::Resource>] list of feeds
+      # @see http://developer.github.com/v3/activity/feeds/#list-feeds
+      def feeds
+        get "feeds"
+      end
+
+      # Get a Feed by name
+      #
+      # @param [Symbol, String] Name of feed to retrieve.
+      # @return [Feed] Parsed feed in the format returned by the configured
+      #   parser.
+      def feed(name, options = {})
+        if rel = feeds._links[name]
+          get rel.href, :accept => rel.type, :options => options
+        end
+      end
+
+    end
+  end
+end

data/lib/octokit/client/gists.rb

@@ -37,6 +37,7 @@ module Octokit
       # List the authenticated user’s starred gists
       #
       # @return [Array<Sawyer::Resource>] A list of gists
+      # @see http://developer.github.com/v3/gists/#list-gists
       def starred_gists(options = {})
         paginate 'gists/starred', options
       end

data/lib/octokit/client/gitignore.rb

@@ -11,7 +11,6 @@ module Octokit
       # These templates can be passed option when creating a repository.
       #
       # @see http://developer.github.com/v3/gitignore/#listing-available-templates
-      # @see http://developer.github.com/v3/repos/#create
       #
       # @return [Array<String>] List of templates.
       #

data/lib/octokit/client/hooks.rb

@@ -7,6 +7,7 @@ module Octokit
       # List all Service Hooks supported by GitHub
       #
       # @return [Sawyer::Resource] A list of all hooks on GitHub
+      # @see http://developer.github.com/v3/repos/hooks/#services
       # @example List all hooks
       #   Octokit.available_hooks
       def available_hooks(options = {})

data/lib/octokit/client/issues.rb

@@ -20,7 +20,8 @@ module Octokit
       # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
       # @option options [Integer] :page (1) Page number.
       # @return [Array<Sawyer::Resource>] A list of issues for a repository.
-      # @see http://developer.github.com/v3/issues/#list-issues-for-this-repository
+      # @see http://developer.github.com/v3/issues/#list-issues-for-a-repository
+      # @see http://developer.github.com/v3/issues/#list-issues
       # @example List issues for a repository
       #   Octokit.list_issues("sferik/rails_admin")
       # @example List issues for the authenticted user across repositories
@@ -103,7 +104,7 @@ module Octokit
       # Get a single issue from a repository
       #
       # @param repo [String, Repository, Hash] A GitHub repository
-      # @param number [String] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @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 octokit/octokit.rb
@@ -115,7 +116,7 @@ module Octokit
       # Close an issue
       #
       # @param repo [String, Repository, Hash] A GitHub repository
-      # @param number [String] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @param options [Hash] A customizable set of options.
       # @option options [String] :assignee User login.
       # @option options [Integer] :milestone Milestone number.
@@ -131,7 +132,7 @@ module Octokit
       # Reopen an issue
       #
       # @param repo [String, Repository, Hash] A GitHub repository
-      # @param number [String] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @param options [Hash] A customizable set of options.
       # @option options [String] :assignee User login.
       # @option options [Integer] :milestone Milestone number.
@@ -147,7 +148,7 @@ module Octokit
       # Update an issue
       #
       # @param repo [String, Repository, Hash] A GitHub repository
-      # @param number [String] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @param title [String] Updated title for the issue
       # @param body [String] Updated body of the issue
       # @param options [Hash] A customizable set of options.
@@ -195,9 +196,9 @@ module Octokit
       # Get all comments attached to an issue
       #
       # @param repo [String, Repository, Hash] A GitHub repository
-      # @param number [String] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @return [Array<Sawyer::Resource>] Array of comments that belong to an issue
-      # @see http://developer.github.com/v3/issues/comments
+      # @see http://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
       # @example Get comments for issue #25 from octokit/octokit.rb
       #   Octokit.issue_comments("octokit/octokit.rb", "25")
       def issue_comments(repo, number, options = {})
@@ -207,7 +208,7 @@ module Octokit
       # Get a single comment attached to an issue
       #
       # @param repo [String, Repository, Hash] A GitHub repository
-      # @param number [String] Number ID of the comment
+      # @param number [Integer] Number ID of the comment
       # @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 octokit/octokit.rb

data/lib/octokit/client/labels.rb

@@ -12,7 +12,7 @@ module Octokit
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @return [Array<Sawyer::Resource>] A list of the labels across the repository
-      # @see http://developer.github.com/v3/issues/labels/
+      # @see http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository
       # @example List labels for octokit/octokit.rb
       #   Octokit.labels("octokit/octokit.rb")
       def labels(repo, options = {})
@@ -37,7 +37,7 @@ module Octokit
       # @param label [String] A new label
       # @param color [String] A color, in hex, without the leading #
       # @return [Sawyer::Resource] The new label
-      # @see http://developer.github.com/v3/issues/labels/
+      # @see http://developer.github.com/v3/issues/labels/#create-a-label
       # @example Add a new label "Version 1.0" with color "#cccccc"
       #   Octokit.add_label("octokit/octokit.rb", "Version 1.0", "cccccc")
       def add_label(repo, label, color="ffffff", options = {})
@@ -49,7 +49,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param label [String] The name of the label which will be updated
       # @param options [Hash] A customizable set of options.
-      # @option options [String] :title An updated label name
+      # @option options [String] :name An updated label name
       # @option options [String] :color An updated color value, in hex, without leading #
       # @return [Sawyer::Resource] The updated label
       # @see http://developer.github.com/v3/issues/labels/#update-a-label

data/lib/octokit/client/markdown.rb

@@ -12,7 +12,7 @@ module Octokit
       # @option options [String] (optional) :mode (`markdown` or `gfm`)
       # @option options [String] (optional) :context Repo context
       # @return [String] HTML renderization
-      # @see http://developer.github.com/v3/repos/markdown/
+      # @see http://developer.github.com/v3/markdown/#render-an-arbitrary-markdown-document
       # @example Render some GFM
       #   Octokit.markdown('Fixed in #111', :mode => "gfm", :context => "octokit/octokit.rb")
       def markdown(text, options = {})

data/lib/octokit/client/meta.rb

@@ -7,7 +7,7 @@ module Octokit
     module Meta
 
       # Get meta information about GitHub.com, the service.
-      # @see http://developer.github.com/v3/meta/
+      # @see http://developer.github.com/v3/meta/#meta
       # @return [Sawyer::Resource] Hash with meta information.
       # @example Get GitHub meta information
       #   @client.github_meta

data/lib/octokit/client/milestones.rb

@@ -15,7 +15,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>.
       # @return [Array<Sawyer::Resource>] A list of milestones for a repository.
-      # @see http://developer.github.com/v3/issues/milestones/#List-Milestones-for-an-Issue
+      # @see http://developer.github.com/v3/issues/milestones/#list-milestones-for-a-repository
       # @example List milestones for a repository
       #   Octokit.list_milestones("octokit/octokit.rb")
       def list_milestones(repository, options = {})

data/lib/octokit/client/objects.rb

@@ -13,12 +13,13 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param tree_sha [String] The SHA of the tree to fetch
       # @return [Sawyer::Resource] A hash representing the fetched tree
-      # @see http://developer.github.com/v3/git/trees/
+      # @see http://developer.github.com/v3/git/trees/#get-a-tree
+      # @see http://developer.github.com/v3/git/trees/#get-a-tree-recursively
       # @example Fetch a tree and inspect the path of one of its files
       #   tree = Octokit.tree("octocat/Hello-World", "9fb037999f264ba9a7fc6274d15fa3ae2ab98312")
       #   tree.tree.first.path # => "file.rb"
       # @example Fetch a tree recursively
-      #   tree = Octokit.tree("octocat/Hello-World", "fc6274d15fa3ae2ab983129fb037999f264ba9a7")
+      #   tree = Octokit.tree("octocat/Hello-World", "fc6274d15fa3ae2ab983129fb037999f264ba9a7", :recursive => true)
       #   tree.tree.first.path # => "subdir/file.txt"
       def tree(repo, tree_sha, options = {})
         get "repos/#{Repository.new(repo)}/git/trees/#{tree_sha}", options
@@ -31,7 +32,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param tree [Array] An array of hashes representing a tree structure
       # @return [Sawyer::Resource] A hash representing the new tree
-      # @see http://developer.github.com/v3/git/trees/
+      # @see http://developer.github.com/v3/git/trees/#create-a-tree
       # @example Create a tree containing one file
       #   tree = Octokit.create_tree("octocat/Hello-World", [ { :path => "file.rb", :mode => "100644", :type => "blob", :sha => "44b4fc6d56897b048c772eb4087f854f46256132" } ])
       #   tree.sha # => "cd8274d15fa3ae2ab983129fb037999f264ba9a7"
@@ -46,7 +47,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param blob_sha [String] The SHA of the blob to fetch
       # @return [Sawyer::Resource] A hash representing the fetched blob
-      # @see http://developer.github.com/v3/git/blobs/
+      # @see http://developer.github.com/v3/git/blobs/#get-a-blob
       # @example Fetch a blob and inspect its contents
       #   blob = Octokit.blob("octocat/Hello-World", "827efc6d56897b048c772eb4087f854f46256132")
       #   blob.encoding # => "utf-8"
@@ -67,7 +68,7 @@ module Octokit
       # @param content [String] Content of the blob
       # @param encoding [String] The content's encoding. <tt>utf-8</tt> and <tt>base64</tt> are accepted. If your data cannot be losslessly sent as a UTF-8 string, you can base64 encode it
       # @return [String] The new blob's SHA, e.g. <tt>827efc6d56897b048c772eb4087f854f46256132</tt>
-      # @see http://developer.github.com/v3/git/blobs/
+      # @see http://developer.github.com/v3/git/blobs/#create-a-blob
       # @example Create a blob containing <tt>foo bar baz</tt>
       #   Octokit.create_blob("octocat/Hello-World", "foo bar baz")
       # @example Create a blob containing <tt>foo bar baz</tt>, encoded using base64

data/lib/octokit/client/organizations.rb

@@ -118,18 +118,33 @@ module Octokit
       #
       # @param org [String] Organization GitHub username.
       # @return [Array<Sawyer::Resource>] Array of hashes representing users.
-      # @see http://developer.github.com/v3/orgs/members/#list-members
+      # @see http://developer.github.com/v3/orgs/members/#members-list
       # @example
       #   Octokit.organization_members('github')
       # @example
-      #   @client.organization_members('github')
-      # @example
       #   Octokit.org_members('github')
       def organization_members(org, options = {})
-        paginate "orgs/#{org}/members", options
+        path = "public_" if options.delete(:public)
+        paginate "orgs/#{org}/#{path}members", options
       end
       alias :org_members :organization_members
 
+      # Get organization public members
+      #
+      # Lists the public members of an organization
+      #
+      # @param org [String] Organization GitHub username.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing users.
+      # @see http://developer.github.com/v3/orgs/members/#public-members-list
+      # @example
+      #   Octokit.organization_public_members('github')
+      # @example
+      #   Octokit.org_public_members('github')
+      def organization_public_members(org, options = {})
+        organization_members org, options.merge(:public => true)
+      end
+      alias :org_public_members :organization_public_members
+
       # Check if a user is a member of an organization.
       #
       # Use this to check if another user is a member of an organization that
@@ -346,6 +361,23 @@ module Octokit
       end
       alias :team_repos :team_repositories
 
+      # Check if a repo is managed by a specific team
+      #
+      # @param team_id [Integer] Team ID.
+      # @param repo [String, Hash, Repository] A GitHub repository.
+      # @return [Boolean] True if managed by a team. False if not managed by
+      #   the team OR the requesting user does not have authorization to access
+      #   the team information.
+      # @see http://developer.github.com/v3/orgs/teams/#get-team-repo
+      # @example
+      #   @client.team_repository?(8675309, 'octokit/octokit.rb')
+      # @example
+      #   @client.team_repo?(8675309, 'octokit/octokit.rb')
+      def team_repository?(team_id, repo, options = {})
+        boolean_from_response :get, "teams/#{team_id}/repos/#{Repository.new repo}"
+      end
+      alias :team_repo? :team_repository?
+
       # Add team repository
       #
       # Requires authenticated user to be an owner of the organization that the
@@ -393,7 +425,7 @@ module Octokit
       # @param org [String] Organization GitHub username.
       # @param user [String] GitHub username of user to remove.
       # @return [Boolean] True if removal is successful, false otherwise.
-      # @see http://developer.github.com/v3/orgs/teams/#remove-team-member
+      # @see http://developer.github.com/v3/orgs/members/#remove-a-member
       # @example
       #   @client.remove_organization_member('github', 'pengwynn')
       # @example

data/lib/octokit/client/pub_sub_hubbub.rb

@@ -18,6 +18,7 @@ module Octokit
       # @param topic [String] A recoginized and supported pubsub topic
       # @param callback [String] A callback url to be posted to when the topic event is fired
       # @return [Boolean] true if the subscribe was successful, otherwise an error is raised
+      # @see http://developer.github.com/v3/repos/hooks/#subscribing
       # @example Subscribe to push events from one of your repositories, having an email sent when fired
       #   client = Octokit::Client.new(:oauth_token = "token")
       #   client.subscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
@@ -37,6 +38,7 @@ module Octokit
       # @param topic [String] A recoginized pubsub topic
       # @param callback [String] A callback url to be unsubscribed from
       # @return [Boolean] true if the unsubscribe was successful, otherwise an error is raised
+      # @see http://developer.github.com/v3/repos/hooks/#subscribing
       # @example Unsubscribe to push events from one of your repositories, no longer having an email sent when fired
       #   client = Octokit::Client.new(:oauth_token = "token")
       #   client.unsubscribe("https://github.com/joshk/devise_imapable/events/push", "github://Email?address=josh.kalderimis@gmail.com")
@@ -58,6 +60,7 @@ module Octokit
       # @param service_arguments [Hash] params that will be passed by subscribed hook.
       #    List of services is available @ https://github.com/github/github-services/tree/master/docs.
       #    Please refer Data node for complete list of arguments.
+      # @see http://developer.github.com/v3/repos/hooks/#subscribing
       # @example Subscribe to push events to one of your repositories to Travis-CI
       #    client = Octokit::Client.new(:oauth_token = "token")
       #    client.subscribe_service_hook('joshk/device_imapable', 'Travis', { :token => "test", :domain => "domain", :user => "user" })
@@ -72,6 +75,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param service_name [String] service name owner
       #    List of services is available @ https://github.com/github/github-services/tree/master/docs.
+      # @see http://developer.github.com/v3/repos/hooks/#subscribing
       # @example Subscribe to push events to one of your repositories to Travis-CI
       #    client = Octokit::Client.new(:oauth_token = "token")
       #    client.unsubscribe_service_hook('joshk/device_imapable', 'Travis')

data/lib/octokit/client/pull_requests.rb

@@ -254,6 +254,7 @@ module Octokit
       # @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
+      # @see http://developer.github.com/v3/pulls/comments/#delete-a-comment
       # @example
       #   @client.delete_pull_request_comment("octokit/octokit.rb", 1902707)
       def delete_pull_request_comment(repo, comment_id, options = {})
@@ -264,7 +265,7 @@ module Octokit
 
       # List files on a pull request
       #
-      # @see http://developer.github.com/v3/pulls/#list-files-on-a-pull-request
+      # @see http://developer.github.com/v3/pulls/#list-pull-requests-files
       # @param repo [String, Hash, Repository] A GitHub repository
       # @param number [Integer] Number of pull request
       # @return [Array<Sawyer::Resource>] List of files

data/lib/octokit/client/rate_limit.rb

@@ -9,7 +9,7 @@ module Octokit
       # Get rate limit info from last response if available
       # or make a new request to fetch rate limit
       #
-      # @see http://developer.github.com/v3/#rate-limiting
+      # @see http://developer.github.com/v3/rate_limit/#rate-limit
       # @return [Octokit::RateLimit] Rate limit info
       def rate_limit(options = {})
         return rate_limit! if last_response.nil?
@@ -20,7 +20,7 @@ module Octokit
 
       # Get number of rate limted requests remaining
       #
-      # @see http://developer.github.com/v3/#rate-limiting
+      # @see http://developer.github.com/v3/rate_limit/#rate-limit
       # @return [Fixnum] Number of requests remaining in this period
       def rate_limit_remaining(options = {})
         puts "Deprecated: Please use .rate_limit.remaining"
@@ -30,7 +30,7 @@ module Octokit
 
       # Refresh rate limit info by making a new request
       #
-      # @see http://developer.github.com/v3/#rate-limiting
+      # @see http://developer.github.com/v3/rate_limit/#rate-limit
       # @return [Octokit::RateLimit] Rate limit info
       def rate_limit!(options = {})
         get "rate_limit"
@@ -40,7 +40,7 @@ module Octokit
 
       # Refresh rate limit info and get number of rate limted requests remaining
       #
-      # @see http://developer.github.com/v3/#rate-limiting
+      # @see http://developer.github.com/v3/rate_limit/#rate-limit
       # @return [Fixnum] Number of requests remaining in this period
       def rate_limit_remaining!(options = {})
         puts "Deprecated: Please use .rate_limit!.remaining"

data/lib/octokit/client/refs.rb

@@ -11,7 +11,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param namespace [String] The ref namespace, e.g. <tt>tag</tt> or <tt>heads</tt>
       # @return [Array<Sawyer::Resource>] A list of references matching the repo and the namespace
-      # @see http://developer.github.com/v3/git/refs/
+      # @see http://developer.github.com/v3/git/refs/#get-all-references
       # @example Fetch all refs for sferik/rails_admin
       #   Octokit.refs("sferik/rails_admin")
       def refs(repo, namespace = nil, options = {})
@@ -28,7 +28,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param ref [String] The ref, e.g. <tt>tags/v0.0.3</tt>
       # @return [Sawyer::Resource] The reference matching the given repo and the ref id
-      # @see http://developer.github.com/v3/git/refs/
+      # @see http://developer.github.com/v3/git/refs/#get-a-reference
       # @example Fetch tags/v0.0.3 for sferik/rails_admin
       #   Octokit.ref("sferik/rails_admin","tags/v0.0.3")
       def ref(repo, ref, options = {})
@@ -42,7 +42,7 @@ module Octokit
       # @param ref [String] The ref, e.g. <tt>tags/v0.0.3</tt>
       # @param sha [String] A SHA, e.g. <tt>827efc6d56897b048c772eb4087f854f46256132</tt>
       # @return [Array<Sawyer::Resource>] The list of references, already containing the new one
-      # @see http://developer.github.com/v3/git/refs/
+      # @see http://developer.github.com/v3/git/refs/#create-a-reference
       # @example Create refs/heads/master for octocat/Hello-World with sha 827efc6d56897b048c772eb4087f854f46256132
       #   Octokit.create_ref("octocat/Hello-World","heads/master", "827efc6d56897b048c772eb4087f854f46256132")
       def create_ref(repo, ref, sha, options = {})
@@ -61,7 +61,7 @@ module Octokit
       # @param sha [String] A SHA, e.g. <tt>827efc6d56897b048c772eb4087f854f46256132</tt>
       # @param force [Boolean] A flag indicating one wants to force the update to make sure the update is a fast-forward update.
       # @return [Array<Sawyer::Resource>] The list of references updated
-      # @see http://developer.github.com/v3/git/refs/
+      # @see http://developer.github.com/v3/git/refs/#update-a-reference
       # @example Force update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
       #   Octokit.update_ref("octocat/Hello-World","heads/sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
       def update_ref(repo, ref, sha, force = true, options = {})
@@ -73,12 +73,38 @@ module Octokit
       end
       alias :update_reference :update_ref
 
+      # Update a branch
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param branch [String] The ref, e.g. <tt>feature/new-shiny</tt>
+      # @param sha [String] A SHA, e.g. <tt>827efc6d56897b048c772eb4087f854f46256132</tt>
+      # @param force [Boolean] A flag indicating one wants to force the update to make sure the update is a fast-forward update.
+      # @return [Array<Sawyer::Resource>] The list of references updated
+      # @see http://developer.github.com/v3/git/refs/#update-a-reference
+      # @example Force update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
+      #   Octokit.update_ref("octocat/Hello-World","sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
+      def update_branch(repo, branch, sha, force = true, options = {})
+        update_ref repo, "heads/#{branch}", sha, force, options
+      end
+
+      # Delete a single branch
+      #
+      # @param repo [String, Repository, Hash] A GitHub repository
+      # @param branch [String] The branch, e.g. <tt>fix-refs</tt>
+      # @return [Boolean] Success
+      # @see http://developer.github.com/v3/git/refs/#delete-a-reference
+      # @example Delete uritemplate for sigmavirus24/github3.py
+      #   Octokit.delete_branch("sigmavirus24/github3.py", "uritemplate")
+      def delete_branch(repo, branch, options = {})
+        delete_ref repo, "heads/#{branch}", options
+      end
+
       # Delete a single reference
       #
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param ref [String] The ref, e.g. <tt>tags/v0.0.3</tt>
       # @return [Boolean] Success
-      # @see http://developer.github.com/v3/git/refs/
+      # @see http://developer.github.com/v3/git/refs/#delete-a-reference
       # @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 = {})

data/lib/octokit/client/releases.rb

@@ -112,7 +112,7 @@ module Octokit
       # @option options [String] :name The name for the file
       # @option options [String] :label The download text for the file
       # @return [Sawyer::Resource] The release asset
-      # @see http://developer.github.com/v3/repos/releases/#get-a-single-release-asset
+      # @see http://developer.github.com/v3/repos/releases/#edit-a-release-asset
       def update_release_asset(asset_url, options = {})
         patch(asset_url, options)
       end

data/lib/octokit/client/repositories.rb

@@ -74,7 +74,7 @@ module Octokit
       # This provides a dump of every repository, in the order that they were
       # created.
       #
-      # @see http://developer.github.com/v3/repos/#list-all-repositories
+      # @see http://developer.github.com/v3/repos/#list-all-public-repositories
       #
       # @param options [Hash] Optional options
       # @option options [Integer] :since The integer ID of the last Repository
@@ -195,7 +195,7 @@ module Octokit
       #
       # @param repo [String, Hash, Repository] A GitHub repository
       # @return [Array<Sawyer::Resource>] Array of hashes representing deploy keys.
-      # @see http://developer.github.com/v3/repos/keys/#get
+      # @see http://developer.github.com/v3/repos/keys/#list
       # @example
       #   @client.deploy_keys('octokit/octokit.rb')
       # @example
@@ -205,6 +205,18 @@ module Octokit
       end
       alias :list_deploy_keys :deploy_keys
 
+      # Get a single deploy key for a repo
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository.
+      # @param id [Integer] Deploy key ID.
+      # @return [Sawyer::Resource] Deploy key.
+      # @see http://developer.github.com/v3/repos/keys/#get
+      # @example
+      #   @client.deploy_key('octokit/octokit.rb', 8675309)
+      def deploy_key(repo, id, options={})
+        get "repos/#{Repository.new repo}/keys/#{id}", options
+      end
+
       # Add deploy key to a repo
       #
       # Requires authenticated client.
@@ -220,6 +232,24 @@ module Octokit
         post "repos/#{Repository.new repo}/keys", options.merge(:title => title, :key => key)
       end
 
+      # Edit a deploy key
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository.
+      # @param id [Integer] Deploy key ID.
+      # @param options [Hash] Attributes to edit.
+      # @option title [String] Key title.
+      # @option key [String] Public key.
+      # @return [Sawyer::Resource] Updated deploy key.
+      # @see http://developer.github.com/v3/repos/keys/#edit
+      # @example Update the key for a deploy key.
+      #   @client.edit_deploy_key('octokit/octokit.rb', 8675309, :key => 'ssh-rsa BBB...')
+      # @example
+      #   @client.update_deploy_key('octokit/octokit.rb', 8675309, :title => 'Uber', :key => 'ssh-rsa BBB...'))
+      def edit_deploy_key(repo, id, options)
+        patch "repos/#{Repository.new repo}/keys/#{id}", options
+      end
+      alias :update_deploy_key :edit_deploy_key
+
       # Remove deploy key from a repo
       #
       # Requires authenticated client.
@@ -286,6 +316,20 @@ module Octokit
       end
       alias :remove_collab :remove_collaborator
 
+      # Checks if a user is a collaborator for a repo.
+      #
+      # Requires authenticated client.
+      #
+      # @param repo [String, Hash, Repository] A GitHub repository.
+      # @param collaborator [String] Collaborator GitHub username to check.
+      # @return [Boolean] True if user is a collaborator, false otherwise.
+      # @see http://developer.github.com/v3/repos/collaborators/#get
+      # @example
+      #   @client.collaborator?('octokit/octokit.rb', 'holman')
+      def collaborator?(repo, collaborator, options={})
+        boolean_from_response :get, "repos/#{Repository.new repo}/collaborators/#{collaborator}", options
+      end
+
       # List teams for a repo
       #
       # Requires authenticated client that is an owner or collaborator of the repo.
@@ -331,7 +375,7 @@ module Octokit
       #
       # @param repo [String, Hash, Repository] A GitHub repository.
       # @return [Array<Sawyer::Resource>] Array of hashes representing users.
-      # @see http://developer.github.com/v3/repos/starring/#list-stargazers
+      # @see http://developer.github.com/v3/activity/starring/#list-stargazers
       # @example
       #   Octokit.stargazers('octokit/octokit.rb')
       # @example
@@ -560,7 +604,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository.
       # @param id [Integer] Id of the hook to test.
       # @return [Boolean] Success
-      # @see http://developer.github.com/v3/repos/hooks/#test-a-hook
+      # @see http://developer.github.com/v3/repos/hooks/#test-a-push-hook
       # @example
       #   @client.test_hook('octokit/octokit.rb', 1000000)
       def test_hook(repo, id, options = {})

data/lib/octokit/client/search.rb

@@ -67,7 +67,9 @@ module Octokit
 
       def search(path, query, options = {})
         opts = options.merge(:q => query)
-        paginate path, opts
+        paginate(path, opts) do |data, last_response|
+          data.items.concat last_response.data.items
+        end
       end
     end
   end

data/lib/octokit/client/statuses.rb

@@ -11,7 +11,7 @@ module Octokit
       # @param repo [String, Repository, Hash] A GitHub repository
       # @param sha [String] The SHA1 for the commit
       # @return [Array<Sawyer::Resource>] A list of statuses
-      # @see http://developer.github.com/v3/repos/statuses
+      # @see http://developer.github.com/v3/repos/statuses/#list-statuses-for-a-specific-ref
       def statuses(repo, sha, options = {})
         get "repos/#{Repository.new(repo)}/statuses/#{sha}", options
       end
@@ -23,7 +23,7 @@ module Octokit
       # @param sha [String] The SHA1 for the commit
       # @param state [String] The state: pending, success, failure, error
       # @return [Sawyer::Resource] A status
-      # @see http://developer.github.com/v3/repos/statuses
+      # @see http://developer.github.com/v3/repos/statuses/#create-a-status
       def create_status(repo, sha, state, options = {})
         options.merge!(:state => state)
         post "repos/#{Repository.new(repo)}/statuses/#{sha}", options

data/lib/octokit/client/users.rb

@@ -27,6 +27,7 @@ module Octokit
       # @param user [String] A GitHub user name.
       # @return [Sawyer::Resource]
       # @see http://developer.github.com/v3/users/#get-a-single-user
+      # @see http://developer.github.com/v3/users/#get-the-authenticated-user
       # @example
       #   Octokit.user("sferik")
       def user(user=nil, options = {})
@@ -82,8 +83,9 @@ module Octokit
       # @option options [Boolean] :hireable
       # @option options [String] :bio
       # @return [Sawyer::Resource]
+      # @see http://developer.github.com/v3/users/#update-the-authenticated-user
       # @example
-      #   Octokit.user(:name => "Erik Michaels-Ober", :email => "sferik@gmail.com", :company => "Code for America", :location => "San Francisco", :hireable => false)
+      #   Octokit.update_user(:name => "Erik Michaels-Ober", :email => "sferik@gmail.com", :company => "Code for America", :location => "San Francisco", :hireable => false)
       def update_user(options)
         patch "user", options
       end
@@ -122,6 +124,7 @@ module Octokit
       #   @param target [String] Username of the target user
       # @return [Boolean] True following target user, false otherwise.
       # @see http://developer.github.com/v3/users/followers/#check-if-you-are-following-a-user
+      # @see http://developer.github.com/v3/users/followers/#check-if-one-user-follows-another
       # @example
       #   @client.follows?('pengwynn')
       # @example
@@ -170,7 +173,7 @@ module Octokit
       # @option options [String] :sort (created) Sort: <tt>created</tt> or <tt>updated</tt>.
       # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
       # @return [Array<Sawyer::Resource>] Array of hashes representing repositories starred by user.
-      # @see http://developer.github.com/v3/repos/starring/#list-repositories-being-starred
+      # @see http://developer.github.com/v3/activity/starring/#list-repositories-being-starred
       # @example
       #   Octokit.starred('pengwynn')
       def starred(user=login, options = {})
@@ -184,7 +187,7 @@ module Octokit
       #
       # @param args [String, Hash, Repository] A GitHub repository
       # @return [Boolean] True if you are following the repo, false otherwise.
-      # @see http://developer.github.com/v3/repos/starring/#check-if-you-are-starring-a-repository
+      # @see http://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository
       # @example
       #   @client.starred?('pengwynn/octokit')
       #   @client.starred?('pengwynn', 'octokit') # deprecated

data/lib/octokit/default.rb

@@ -1,4 +1,5 @@
 require 'octokit/response/raise_error'
+require 'octokit/response/feed_parser'
 require 'octokit/version'
 
 module Octokit
@@ -21,6 +22,7 @@ module Octokit
     # Default Faraday middleware stack
     MIDDLEWARE = Faraday::Builder.new do |builder|
       builder.use Octokit::Response::RaiseError
+      builder.use Octokit::Response::FeedParser
       builder.adapter Faraday.default_adapter
     end
 

data/lib/octokit/response/feed_parser.rb

@@ -0,0 +1,24 @@
+require 'faraday'
+
+module Octokit
+
+  module Response
+
+    # Parses RSS and Atom feed responses.
+    class FeedParser < Faraday::Response::Middleware
+
+      dependency do
+        require 'rss'
+      end
+
+      private
+
+      def on_complete(env)
+        if env[:response_headers]["content-type"] =~ /(\batom|\brss)/
+          env[:body] = RSS::Parser.parse env[:body]
+        end
+      end
+
+    end
+  end
+end

data/lib/octokit/version.rb

@@ -2,6 +2,6 @@ module Octokit
 
   # Current version
   # @return [String]
-  VERSION = "2.6.3".freeze
+  VERSION = "2.7.0".freeze
 
 end

data/octokit.gemspec

@@ -5,7 +5,7 @@ require 'octokit/version'
 
 Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.0'
-  spec.add_dependency 'sawyer', '~> 0.5.1'
+  spec.add_dependency 'sawyer', '~> 0.5.2'
   spec.authors = ["Wynn Netherland", "Erik Michaels-Ober", "Clint Shryock"]
   spec.description = %q{Simple wrapper for the GitHub API}
   spec.email = ['wynn.netherland@gmail.com', 'sferik@gmail.com', 'clint@ctshryock.com']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 2.6.3
+  version: 2.7.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-07 00:00:00.000000000 Z
+date: 2013-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -32,14 +32,14 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.5.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: 0.5.2
 description: Simple wrapper for the GitHub API
 email:
 - wynn.netherland@gmail.com
@@ -65,6 +65,7 @@ files:
 - lib/octokit/client/downloads.rb
 - lib/octokit/client/emojis.rb
 - lib/octokit/client/events.rb
+- lib/octokit/client/feeds.rb
 - lib/octokit/client/gists.rb
 - lib/octokit/client/gitignore.rb
 - lib/octokit/client/hooks.rb
@@ -97,6 +98,7 @@ files:
 - lib/octokit/rate_limit.rb
 - lib/octokit/repo_arguments.rb
 - lib/octokit/repository.rb
+- lib/octokit/response/feed_parser.rb
 - lib/octokit/response/raise_error.rb
 - lib/octokit/version.rb
 - lib/octokit.rb