octokit 4.3.0 → 4.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 433f670467c277e091d184af708f336f2a019b5a
-  data.tar.gz: 4c29fdcfe9e156bec1a58b83c809ced9ff628748
+  metadata.gz: ca949068002176e1c5b3d59da31f46febae73fe5
+  data.tar.gz: 6b58185158a0115d1c2ce3e66ec01899684fb09a
 SHA512:
-  metadata.gz: db2aa2a80a84de1d91da8b0414145e1f7adb28a01b957cc14dfe075208a110aeaf85886fb2a6af45ee2fb5688cc51847ff698aa7731da656d7519e40776d764c
-  data.tar.gz: d6bc2a4e82cef39bde7daf9c2149e2b58dc6c75e09c5ce1f41936725937f90f58f54449f676b1ac0098c412027e4974016d2f7b415fbaf5f361ad97c697b9db2
+  metadata.gz: 64e36285a18bb0abeebfa514d6edce2fe1045c05e41bff62c96a2d94157e854f1d4cda4d32fd0a666f4cbef5dbcd60eeaf4e1af7b1fb0fb179ae82e4e2577dbf
+  data.tar.gz: 8c5c77fbe09bb78b3f1406e82e3f8e46d8f1cc5b57ad95975ce0d0d2f9dd139cd05f54a71f108ab734010e16e4606ab98bc7db2672c27096ce214597465156d9

data/README.md

@@ -8,6 +8,44 @@ Ruby toolkit for the GitHub API.
 Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
 [major version][semver].
 
+## Table of Contents
+
+1. [Philosophy](#philosophy)
+2. [Quick start](#quick-start)
+3. [Making requests](#making-requests)
+4. [Consuming resources](#consuming-resources)
+5. [Accessing HTTP responses](#accessing-http-responses)
+6. [Authentication](#authentication)
+   1. [Basic Authentication](#basic-authentication)
+   2. [OAuth access tokens](#oauth-access-tokens)
+   3. [Two-Factor Authentication](#two-factor-authentication)
+   4. [Using a .netrc file](#using-a-netrc-file)
+   5. [Application authentication](#application-authentication)
+7. [Pagination](#pagination)
+   1. [Auto pagination](#auto-pagination)
+8. [Working with GitHub Enterprise](#working-with-github-enterprise)
+   1. [Interacting with the GitHub.com APIs in GitHub Enterprise](#interacting-with-the-githubcom-apis-in-github-enterprise)
+   2. [Interacting with the GitHub Enterprise Admin APIs](#interacting-with-the-github-enterprise-admin-apis)
+   3. [Interacting with the GitHub Enterprise Management Console APIs](#interacting-with-the-github-enterprise-management-console-apis)
+9. [SSL Connection Errors](#ssl-connection-errors)
+10. [Configuration and defaults](#configuration-and-defaults)
+    1. [Configuring module defaults](#configuring-module-defaults)
+    2. [Using ENV variables](#using-env-variables)
+11. [Hypermedia agent](#hypermedia-agent)
+    1. [Hypermedia in Octokit](#hypermedia-in-octokit)
+    2. [URI templates](#uri-templates)
+    3. [The Full Hypermedia Experience™](#the-full-hypermedia-experience)
+12. [Upgrading guide](#upgrading-guide)
+    1. [Upgrading from 1.x.x](#upgrading-from-1xx)
+13. [Advanced usage](#advanced-usage)
+    1. [Debugging](#debugging)
+    2. [Caching](#caching)
+14. [Hacking on Octokit.rb](#hacking-on-octokitrb)
+    1. [Running and writing new tests](#running-and-writing-new-tests)
+15. [Supported Ruby Versions](#supported-ruby-versions)
+16. [Versioning](#versioning)
+17. [License](#license)
+
 ## Philosophy
 
 API wrappers [should reflect the idioms of the language in which they were
@@ -279,7 +317,7 @@ The GitHub Enterprise Admin APIs are under a different client: `EnterpriseAdminC
 ``` ruby
 admin_client = Octokit::EnterpriseAdminClient.new \
                           :access_token => "<your 40 char token>",
-                          :api_endpoint = "https://<hostname>/api/v3/"
+                          :api_endpoint => "https://<hostname>/api/v3/"
 
 # or
 Octokit.configure do |c|
@@ -433,7 +471,7 @@ pass `state` in the method options.
 - adds support for new [Enterprise-only APIs](#working-with-github-enterprise).
 - adds support for [Repository redirects][redirects].
 
-[list-pulls]: https://github.com/octokit/octokit.rb/commit/e48e91f736d5fce51e3bf74d7c9022aaa52f5c5c 
+[list-pulls]: https://github.com/octokit/octokit.rb/commit/e48e91f736d5fce51e3bf74d7c9022aaa52f5c5c
 [redirects]: https://developer.github.com/changes/2015-05-26-repository-redirects-are-coming/
 
 Version 3.0 includes a couple breaking changes when upgrading from v2.x.x:
@@ -528,7 +566,7 @@ Next, construct your own Faraday middleware:
 
 ```ruby
 stack = Faraday::RackBuilder.new do |builder|
-  builder.use Faraday::HttpCache
+  builder.use Faraday::HttpCache, serializer: Marshal, shared_cache: false
   builder.use Octokit::Response::RaiseError
   builder.adapter Faraday.default_adapter
 end
@@ -614,6 +652,7 @@ implementations:
 * Ruby 2.0
 * Ruby 2.1
 * Ruby 2.2
+* Ruby 2.3
 
 If something doesn't work on one of these Ruby versions, it's a bug.
 

data/lib/octokit/client.rb

@@ -36,9 +36,11 @@ require 'octokit/client/pages'
 require 'octokit/client/pub_sub_hubbub'
 require 'octokit/client/pull_requests'
 require 'octokit/client/rate_limit'
+require 'octokit/client/reactions'
 require 'octokit/client/refs'
 require 'octokit/client/releases'
 require 'octokit/client/repositories'
+require 'octokit/client/repository_invitations'
 require 'octokit/client/say'
 require 'octokit/client/search'
 require 'octokit/client/service_status'
@@ -85,9 +87,11 @@ module Octokit
     include Octokit::Client::PubSubHubbub
     include Octokit::Client::PullRequests
     include Octokit::Client::RateLimit
+    include Octokit::Client::Reactions
     include Octokit::Client::Refs
     include Octokit::Client::Releases
     include Octokit::Client::Repositories
+    include Octokit::Client::RepositoryInvitations
     include Octokit::Client::Say
     include Octokit::Client::Search
     include Octokit::Client::ServiceStatus

data/lib/octokit/client/authorizations.rb

@@ -230,10 +230,11 @@ module Octokit
           raise Octokit::ApplicationCredentialsRequired.new "client_id required"
         end
         authorize_url = options.delete(:endpoint) || Octokit.web_endpoint
-        authorize_url += "login/oauth/authorize?client_id=" + app_id
+        authorize_url << "login/oauth/authorize?client_id=#{app_id}"
 
+        require 'cgi'
         options.each do |key, value|
-          authorize_url += "&" + key.to_s + "=" + value
+          authorize_url << "&#{key}=#{CGI.escape value}"
         end
 
         authorize_url

data/lib/octokit/client/commits.rb

@@ -126,7 +126,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] An array of hashes representing commits
       # @see https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository
       # @example
-      #   Octokit.commits_on('octokit/octokit.rb', '2012-10-01', '2012-11-01')
+      #   Octokit.commits_between('octokit/octokit.rb', '2012-10-01', '2012-11-01')
       def commits_between(*args)
         arguments = Octokit::RepoArguments.new(args)
         date       = parse_date(arguments.shift)

data/lib/octokit/client/gists.rb

@@ -75,7 +75,6 @@ module Octokit
       #
       # @param options [Hash] Gist information.
       # @option options [String] :description
-      # @option options [Boolean] :public Sets gist visibility
       # @option options [Hash] :files Files that make up this gist. Keys
       #   should be the filename, the value a Hash with a :content key with text
       #   content of the Gist.

data/lib/octokit/client/issues.rb

@@ -146,6 +146,30 @@ module Octokit
         patch "#{Repository.path repo}/issues/#{number}", options.merge({:state => "open"})
       end
 
+      # Lock an issue's conversation, limiting it to collaborators
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the issue
+      # @return [Boolean] Success
+      # @see https://developer.github.com/v3/issues/#lock-an-issue
+      # @example Lock Issue #25 from octokit/octokit.rb
+      #   Octokit.lock_issue("octokit/octokit.rb", "25")
+      def lock_issue(repo, number, options = {})
+        boolean_from_response :put, "#{Repository.path repo}/issues/#{number}/lock", options
+      end
+
+      # Unlock an issue's conversation, opening it to all viewers
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the issue
+      # @return [Boolean] Success
+      # @see https://developer.github.com/v3/issues/#unlock-an-issue
+      # @example Unlock Issue #25 from octokit/octokit.rb
+      #   Octokit.close_issue("octokit/octokit.rb", "25")
+      def unlock_issue(repo, number, options = {})
+        boolean_from_response :delete, "#{Repository.path repo}/issues/#{number}/lock", options
+      end
+
       # Update an issue
       #
       # @overload update_issue(repo, number, title, body, options)
@@ -279,6 +303,19 @@ module Octokit
       def delete_comment(repo, number, options = {})
         boolean_from_response :delete, "#{Repository.path repo}/issues/comments/#{number}", options
       end
+
+      # Get the timeline for an issue
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param number [Integer] Number ID of the comment
+      # @return [Sawyer::Resource] The timeline for this issue
+      # @see https://developer.github.com/v3/issues/timeline/
+      # @example Get timeline for issue #1435 on octokit/octokit.rb
+      #   Octokit.issue_timeline("octokit/octokit.rb", 1435)
+      def issue_timeline(repo, number, options = {})
+        options = ensure_api_media_type(:issue_timelines, options)
+        paginate "#{Repository.path repo}/issues/#{number}/timeline", options
+      end
     end
   end
 end

data/lib/octokit/client/milestones.rb

@@ -8,7 +8,7 @@ module Octokit
 
       # List milestones for a repository
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repository [Integer, String, Repository, Hash] A GitHub repository
       # @param options [Hash] A customizable set of options.
       # @option options [Integer] :milestone Milestone number.
       # @option options [String] :state (open) State: <tt>open</tt>, <tt>closed</tt>, or <tt>all</tt>.
@@ -19,13 +19,13 @@ module Octokit
       # @example List milestones for a repository
       #   Octokit.list_milestones("octokit/octokit.rb")
       def list_milestones(repository, options = {})
-        paginate "repos/#{Repository.new(repository)}/milestones", options
+        paginate "#{Repository.path repository}/milestones", options
       end
       alias :milestones :list_milestones
 
       # Get a single milestone for a repository
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repository [Integer, String, Repository, Hash] A GitHub repository
       # @param options [Hash] A customizable set of options.
       # @option options [Integer] :milestone Milestone number.
       # @return [Sawyer::Resource] A single milestone from a repository.
@@ -33,12 +33,12 @@ module Octokit
       # @example Get a single milestone for a repository
       #   Octokit.milestone("octokit/octokit.rb", 1)
       def milestone(repository, number, options = {})
-        get "repos/#{Repository.new(repository)}/milestones/#{number}", options
+        get "#{Repository.path repository}/milestones/#{number}", options
       end
 
       # Create a milestone for a repository
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repository [Integer, String, Repository, Hash] A GitHub repository
       # @param title [String] A unique title.
       # @param options [Hash] A customizable set of options.
       # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
@@ -49,12 +49,12 @@ module Octokit
       # @example Create a milestone for a repository
       #   Octokit.create_milestone("octokit/octokit.rb", "0.7.0", {:description => 'Add support for v3 of Github API'})
       def create_milestone(repository, title, options = {})
-        post "repos/#{Repository.new(repository)}/milestones", options.merge({:title => title})
+        post "#{Repository.path repository}/milestones", options.merge({:title => title})
       end
 
       # Update a milestone for a repository
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repository [Integer, String, Repository, Hash] A GitHub repository
       # @param number [String, Integer] ID of the milestone
       # @param options [Hash] A customizable set of options.
       # @option options [String] :title A unique title.
@@ -66,13 +66,13 @@ module Octokit
       # @example Update a milestone for a repository
       #   Octokit.update_milestone("octokit/octokit.rb", 1, {:description => 'Add support for v3 of Github API'})
       def update_milestone(repository, number, options = {})
-        patch "repos/#{Repository.new(repository)}/milestones/#{number}", options
+        patch "#{Repository.path repository}/milestones/#{number}", options
       end
       alias :edit_milestone :update_milestone
 
       # Delete a single milestone for a repository
       #
-      # @param repository [String, Repository, Hash] A GitHub repository.
+      # @param repository [Integer, String, Repository, Hash] A GitHub repository
       # @param options [Hash] A customizable set of options.
       # @option options [Integer] :milestone Milestone number.
       # @return [Boolean] Success
@@ -80,7 +80,7 @@ module Octokit
       # @example Delete a single milestone from a repository
       #   Octokit.delete_milestone("octokit/octokit.rb", 1)
       def delete_milestone(repository, number, options = {})
-        boolean_from_response :delete, "repos/#{Repository.new(repository)}/milestones/#{number}", options
+        boolean_from_response :delete, "#{Repository.path repository}/milestones/#{number}", options
       end
     end
   end

data/lib/octokit/client/organizations.rb

@@ -230,21 +230,17 @@ module Octokit
       # @param org [String, Integer] Organization GitHub login or id.
       # @option options [String] :name Team name.
       # @option options [Array<String>] :repo_names Repositories for the team.
-      # @option options [String, optional] :permission ('pull') Permissions the
-      #   team has for team repositories.
-      #
-      #   `pull` - team members can pull, but not push to or administer these repositories.
-      #   `push` - team members can pull and push, but not administer these repositories.
-      #   `admin` - team members can pull, push and administer these repositories.
       # @return [Sawyer::Resource] Hash representing new team.
       # @see https://developer.github.com/v3/orgs/teams/#create-team
       # @example
       #   @client.create_team('github', {
       #     :name => 'Designers',
-      #     :repo_names => ['github/dotfiles'],
-      #     :permission => 'push'
+      #     :repo_names => ['github/dotfiles']
       #   })
       def create_team(org, options = {})
+        if options.key?(:permission)
+          octokit_warn "Deprecated: Passing :permission option to #create_team. Assign team repository permission by passing :permission to #add_team_repository instead."
+        end
         post "#{Organization.path org}/teams", options
       end
 
@@ -406,19 +402,28 @@ module Octokit
 
       # Add team repository
       #
+      # This can also be used to update the permission of an existing team
+      #
       # Requires authenticated user to be an owner of the organization that the
       # team is associated with. Also, the repo must be owned by the
       # organization, or a direct form of a repo owned by the organization.
       #
       # @param team_id [Integer] Team id.
       # @param repo [String, Hash, Repository] A GitHub repository.
+      # @option options [String] :permission The permission to grant the team.
+      #   Only valid on organization-owned repositories.
+      #   Can be one of: <tt>pull</tt>, <tt>push</tt>, or <tt>admin</tt>.
+      #   If not specified, the team's <tt>permission</tt> attribute will be
+      #   used to determine what permission to grant the team on this repository.
       # @return [Boolean] True if successful, false otherwise.
       # @see Octokit::Repository
-      # @see https://developer.github.com/v3/orgs/teams/#add-team-repository
+      # @see https://developer.github.com/v3/orgs/teams/#add-or-update-team-repository
       # @example
       #   @client.add_team_repository(100000, 'github/developer.github.com')
       # @example
       #   @client.add_team_repo(100000, 'github/developer.github.com')
+      # @example Add a team with admin permissions
+      #   @client.add_team_repository(100000, 'github/developer.github.com', permission: 'admin')
       def add_team_repository(team_id, repo, options = {})
         boolean_from_response :put, "teams/#{team_id}/repos/#{Repository.new(repo)}", options.merge(:name => Repository.new(repo))
       end

data/lib/octokit/client/pages.rb

@@ -12,7 +12,21 @@ module Octokit
       # @return Sawyer::Resource A GitHub Pages resource
       # @see https://developer.github.com/v3/repos/pages/#get-information-about-a-pages-site
       def pages(repo, options = {})
-        get "#{Repository.path repo}/pages", options
+        opts = ensure_api_media_type(:pages, options)
+        get "#{Repository.path repo}/pages", opts
+      end
+
+      # Get a specific Pages build by ID
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param id [Integer, String] Build ID
+      # @return [Sawyer::Resource] Pages build information
+      # @see https://developer.github.com/v3/repos/pages/#list-a-specific-pages-build
+      # @example
+      #   Octokit.pages_build("github/developer.github.com", 5472601)
+      def pages_build(repo, id, options = {})
+        opts = ensure_api_media_type(:pages, options)
+        get "#{Repository.path repo}/pages/builds/#{id}", opts
       end
 
       # List Pages builds for a repository
@@ -33,6 +47,18 @@ module Octokit
       def latest_pages_build(repo, options = {})
         get "#{Repository.path repo}/pages/builds/latest", options
       end
+
+      # Request a page build for the latest revision of the default branch
+      #
+      # You can only request builds for your repositories
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @return [Sawyer::Resource] Request result
+      # @see https://developer.github.com/v3/repos/pages/#request-a-page-build
+      def request_page_build(repo, options = {})
+        opts = ensure_api_media_type(:pages, options)
+        post "#{Repository.path repo}/pages/builds", opts
+      end
     end
   end
 end

data/lib/octokit/client/pull_requests.rb

@@ -222,7 +222,7 @@ module Octokit
       # @return [Sawyer::Resource] Hash representing new comment
       # @see https://developer.github.com/v3/pulls/comments/#create-a-comment
       # @example
-      #   @client.create_pull_request_comment_reply("octokit/octokit.rb", 1903950, "done.")
+      #   @client.create_pull_request_comment_reply("octokit/octokit.rb", 163, "done.", 1903950)
       def create_pull_request_comment_reply(repo, pull_id, body, comment_id, options = {})
         options.merge!({
           :body => body,

data/lib/octokit/client/reactions.rb

@@ -0,0 +1,158 @@
+module Octokit
+  class Client
+
+    # Methods for the Reacions API
+    #
+    # @see https://developer.github.com/v3/reactions/
+    module Reactions
+
+      # List reactions for a commit comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the commit comment
+      # @see https://developer.github.com/v3/reactions/#list-reactions-for-a-commit-comment
+      #
+      # @example
+      #   @client.commit_comment_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reactions.
+      def commit_comment_reactions(repo, id, options = {})
+        options = ensure_api_media_type(:reactions, options)
+        get "#{Repository.path repo}/comments/#{id}/reactions", options
+      end
+
+      # Create a reaction for a commit comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the commit comment
+      # @param reaction [String] The Reaction
+      # @see https://developer.github.com/v3/reactions/#create-reaction-for-a-commit-comment
+      # @see https://developer.github.com/v3/reactions/#reaction-types
+      #
+      # @example
+      #   @client.create_commit_comment_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [<Sawyer::Resource>] Hash representing the reaction
+      def create_commit_comment_reaction(repo, id, reaction, options = {})
+        options = ensure_api_media_type(:reactions, options.merge(:content => reaction))
+        post "#{Repository.path repo}/comments/#{id}/reactions", options
+      end
+
+      # List reactions for an issue
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The Issue number
+      # @see https://developer.github.com/v3/reactions/#list-reactions-for-an-issue
+      #
+      # @example
+      #   @client.issue_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reactions.
+      def issue_reactions(repo, number, options = {})
+        options = ensure_api_media_type(:reactions, options)
+        get "#{Repository.path repo}/issues/#{number}/reactions", options
+      end
+
+      # Create reaction for an issue
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The Issue number
+      # @param reaction [String] The Reaction
+      #
+      # @see https://developer.github.com/v3/reactions/#create-reaction-for-an-issue
+      # @see https://developer.github.com/v3/reactions/#reaction-types
+      #
+      # @example
+      #   @client.create_issue_reaction("octokit/octokit.rb", 1)
+      #
+      # @return [<Sawyer::Resource>] Hash representing the reaction.
+      def create_issue_reaction(repo, number, reaction, options = {})
+        options = ensure_api_media_type(:reactions, options.merge(:content => reaction))
+        post "#{Repository.path repo}/issues/#{number}/reactions", options
+      end
+
+      # List reactions for an issue comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Issue comment id
+      #
+      # @see https://developer.github.com/v3/reactions/#list-reactions-for-an-issue-comment
+      #
+      # @example
+      #   @client.issue_comment_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reactions.
+      def issue_comment_reactions(repo, id, options = {})
+        options = ensure_api_media_type(:reactions, options)
+        get "#{Repository.path repo}/issues/comments/#{id}/reactions", options
+      end
+
+      # Create reaction for an issue comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Issue comment id
+      # @param reaction [String] The Reaction
+      #
+      # @see https://developer.github.com/v3/reactions/#create-reaction-for-an-issue-comment
+      # @see https://developer.github.com/v3/reactions/#reaction-types
+      #
+      # @example
+      #   @client.create_issue_comment_reaction("octokit/octokit.rb", 1)
+      #
+      # @return [<Sawyer::Resource>] Hashes representing the reaction.
+      def create_issue_comment_reaction(repo, id, reaction, options = {})
+        options = ensure_api_media_type(:reactions, options.merge(:content => reaction))
+        post "#{Repository.path repo}/issues/comments/#{id}/reactions", options
+      end
+
+      # List reactions for a pull request review comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Issue comment id
+      #
+      # @see https://developer.github.com/v3/reactions/#list-reactions-for-a-pull-request-review-comment
+      #
+      # @example
+      #   @client.pull_request_review_comment_reactions("octokit/octokit.rb", 1)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reactions.
+      def pull_request_review_comment_reactions(repo, id, options = {})
+        options = ensure_api_media_type(:reactions, options)
+        get "#{Repository.path repo}/pulls/comments/#{id}/reactions", options
+      end
+
+      # Create reaction for a pull request review comment
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The Issue comment id
+      # @param reaction [String] The Reaction
+      #
+      # @see https://developer.github.com/v3/reactions/#create-reaction-for-a-pull-request-review-comment
+      # @see https://developer.github.com/v3/reactions/#reaction-types
+      #
+      # @example
+      #   @client.create_pull_request_reiew_comment_reaction("octokit/octokit.rb", 1)
+      #
+      # @return [<Sawyer::Resource>] Hash representing the reaction.
+      def create_pull_request_review_comment_reaction(repo, id, reaction, options = {})
+        options = ensure_api_media_type(:reactions, options.merge(:content => reaction))
+        post "#{Repository.path repo}/pulls/comments/#{id}/reactions", options
+      end
+
+      # Delete a reaction
+      #
+      # @param id [Integer] Reaction id
+      #
+      # @see https://developer.github.com/v3/reactions/#delete-a-reaction
+      #
+      # @example
+      #   @client.delete_reaction(1)
+      #
+      # @return [Boolean] Return true if reaction was deleted, false otherwise.
+      def delete_reaction(id, options = {})
+        options = ensure_api_media_type(:reactions, options)
+        boolean_from_response :delete, "reactions/#{id}", options
+      end
+    end
+  end
+end

data/lib/octokit/client/releases.rb

@@ -83,7 +83,7 @@ module Octokit
       # @return [Sawyer::Resource] The release asset
       # @see https://developer.github.com/v3/repos/releases/#upload-a-release-asset
       def upload_asset(release_url, path_or_file, options = {})
-        file = path_or_file.respond_to?(:read) ? path_or_file : File.new(path_or_file, "r+b")
+        file = path_or_file.respond_to?(:read) ? path_or_file : File.new(path_or_file, "rb")
         options[:content_type] ||= content_type_from_file(file)
         raise Octokit::MissingContentType.new if options[:content_type].nil?
         unless name = options[:name]

data/lib/octokit/client/repositories.rb

@@ -152,13 +152,14 @@ module Octokit
       # @return [Sawyer::Resource] Repository info for the new repository
       # @see https://developer.github.com/v3/repos/#create
       def create_repository(name, options = {})
-        organization = options.delete :organization
-        options.merge! :name => name
+        opts = options.dup
+        organization = opts.delete :organization
+        opts.merge! :name => name
 
         if organization.nil?
-          post 'user/repos', options
+          post 'user/repos', opts
         else
-          post "#{Organization.path organization}/repos", options
+          post "#{Organization.path organization}/repos", opts
         end
       end
       alias :create_repo :create_repository
@@ -291,16 +292,24 @@ module Octokit
 
       # Add collaborator to repo
       #
+      # This can also be used to update the permission of an existing collaborator
+      #
       # Requires authenticated client.
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
       # @param collaborator [String] Collaborator GitHub username to add.
+      # @option options [String] :permission The permission to grant the collaborator.
+      #   Only valid on organization-owned repositories.
+      #   Can be one of: <tt>pull</tt>, <tt>push</tt>, or <tt>admin</tt>.
+      #   If not specified, defaults to <tt>push</tt>
       # @return [Boolean] True if collaborator added, false otherwise.
       # @see https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator
       # @example
       #   @client.add_collaborator('octokit/octokit.rb', 'holman')
       # @example
       #   @client.add_collab('octokit/octokit.rb', 'holman')
+      # @example Add a collaborator with admin permissions
+      #   @client.add_collaborator('octokit/octokit.rb', 'holman', permission: 'admin')
       def add_collaborator(repo, collaborator, options = {})
         boolean_from_response :put, "#{Repository.path repo}/collaborators/#{collaborator}", options
       end
@@ -496,14 +505,29 @@ module Octokit
       # @example
       #   @client.protect_branch('octokit/octokit.rb', 'master', foo)
       def protect_branch(repo, branch, required_status_checks = {}, options = {})
-        if !required_status_checks.empty?
-          required_status_checks = { :required_status_checks => required_status_checks }
-        end
+        required_status_checks[:restrictions] ||= nil
+        required_status_checks[:required_status_checks] ||= nil
 
-        protection = { :protection => { :enabled => true }.merge(required_status_checks) }
-        options    = ensure_api_media_type(:branch_protection, options.merge(protection))
+        options = ensure_api_media_type(:branch_protection, options.merge(required_status_checks))
+        put "#{Repository.path repo}/branches/#{branch}/protection", options
+      end
 
-        patch "#{Repository.path repo}/branches/#{branch}", options
+      # Get branch protection summary
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param branch [String] Branch name
+      # @return [Sawyer::Resource, nil] Branch protection summary or nil if the branch
+      #   is not protected
+      # @see https://developer.github.com/v3/repos/branches/#get-branch-protection
+      # @example
+      #   @client.branch_protection('octokit/octokit.rb', 'master')
+      def branch_protection(repo, branch, options = {})
+        opts = ensure_api_media_type(:branch_protection, options)
+        begin
+          get "#{Repository.path repo}/branches/#{branch}/protection", opts
+        rescue Octokit::BranchNotProtected
+          nil
+        end
       end
 
       # Unlock a single branch from a repository
@@ -517,9 +541,8 @@ module Octokit
       # @example
       #   @client.unprotect_branch('octokit/octokit.rb', 'master')
       def unprotect_branch(repo, branch, options = {})
-        protection = { :protection => { :enabled => false } }
-        options = ensure_api_media_type(:branch_protection, options.merge(protection))
-        patch "#{Repository.path repo}/branches/#{branch}", options
+        options = ensure_api_media_type(:branch_protection, options)
+        delete "#{Repository.path repo}/branches/#{branch}/protection", options
       end
 
       # List users available for assigning to issues.

data/lib/octokit/client/repository_invitations.rb

@@ -0,0 +1,103 @@
+module Octokit
+  class Client
+
+    # Methods for the Repository Invitations API
+    #
+    # @see https://developer.github.com/v3/repos/invitations/
+    module RepositoryInvitations
+
+      # Invite a user to a repository
+      #
+      # Requires authenticated client
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param user [String] User GitHub username to add
+      # @return [Sawyer::Resource] The repository invitation
+      # @see https://developer.github.com/v3/repos/invitations/#invite-a-user-to-a-repository
+      def invite_user_to_repository(repo, user, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        put "#{Repository.path repo}/collaborators/#{user}", options
+      end
+      alias invite_user_to_repo invite_user_to_repository
+
+      # List all invitations for a repository
+      #
+      # Requires authenticated client
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @return [Array<Sawyer::Resource>] A list of invitations
+      # @see https://developer.github.com/v3/repos/invitations/#list-invitations-for-a-repository
+      def repository_invitations(repo, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        paginate "#{Repository.path repo}/invitations", options
+      end
+      alias repo_invitations repository_invitations
+
+      # Delete an invitation for a repository
+      #
+      # Requires authenticated client
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param invitation_id [Integer] The id of the invitation
+      # @return [Boolean] True if the invitation was successfully deleted
+      # @see https://developer.github.com/v3/repos/invitations/#delete-a-repository-invitation
+      def delete_repository_invitation(repo, invitation_id, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        boolean_from_response :delete, "#{Repository.path repo}/invitations/#{invitation_id}", options
+      end
+      alias delete_repo_invitation delete_repository_invitation
+
+      # Update an invitation for a repository
+      #
+      # Requires authenticated client
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param invitation_id [Integer] The id of the invitation
+      # @return [Sawyer::Resource] The updated repository invitation
+      # @see https://developer.github.com/v3/repos/invitations/#update-a-repository-invitation
+      def update_repository_invitation(repo, invitation_id, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        patch "#{Repository.path repo}/invitations/#{invitation_id}", options
+      end
+      alias update_repo_invitation update_repository_invitation
+
+      # List all repository invitations for the user
+      #
+      # Requires authenticated client
+      #
+      # @return [Array<Sawyer::Resource>] The users repository invitations
+      # @see https://developer.github.com/v3/repos/invitations/#list-a-users-repository-invitations
+      def user_repository_invitations(options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        paginate "/user/repository_invitations", options
+      end
+      alias user_repo_invitations user_repository_invitations
+
+      # Accept a repository invitation
+      #
+      # Requires authenticated client
+      #
+      # @param invitation_id [Integer] The id of the invitation
+      # @return [Boolean] True if the acceptance of the invitation was successful
+      # @see https://developer.github.com/v3/repos/invitations/#accept-a-repository-invitation
+      def accept_repository_invitation(invitation_id, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        patch "/user/repository_invitations/#{invitation_id}", options
+      end
+      alias accept_repo_invitation accept_repository_invitation
+
+      # Decline a repository invitation
+      #
+      # Requires authenticated client
+      #
+      # @param invitation_id [Integer] The id of the invitation
+      # @return [Boolean] True if the acceptance of the invitation was successful
+      # @see https://developer.github.com/v3/repos/invitations/#decline-a-repository-invitation
+      def decline_repository_invitation(invitation_id, options = {})
+        options = ensure_api_media_type(:repository_invitations, options)
+        boolean_from_response :delete, "/user/repository_invitations/#{invitation_id}", options
+      end
+      alias decline_invitation decline_repository_invitation
+    end
+  end
+end

data/lib/octokit/client/source_import.rb

@@ -3,29 +3,47 @@ module Octokit
 
     # Methods for the Source Import API
     #
-    # @see https://developer.github.com/v3/repos/source_imports
+    # @see https://developer.github.com/v3/migration/source_imports
     module SourceImport
 
       # Start a source import to a GitHub repository using GitHub Importer.
       #
-      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
-      # @param vcs [String] The originating VCS type. Can be one of "subversion", "git", "mercurial", or "tfvc".
-      # @param vcs_url [String] The URL of the originating repository.
-      # @param options [Hash]
-      # @option options [String] :vcs_username If authentication is required, the username to provide to vcs_url.
-      # @option options [String] :vcs_password If authentication is required, the password to provide to vcs_url.
-      # @option options [String] :tfvc_project For a tfvc import, the name of the project that is being imported.
+      # @overload start_source_import(repo, vcs, vcs_url, options = {})
+      #   @deprecated
+      #   @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      #   @param vcs [String] The originating VCS type. Can be one of "subversion", "git", "mercurial", or "tfvc".
+      #   @param vcs_url [String] The URL of the originating repository.
+      #   @param options [Hash]
+      #   @option options [String] :vcs_username If authentication is required, the username to provide to vcs_url.
+      #   @option options [String] :vcs_password If authentication is required, the password to provide to vcs_url.
+      #   @option options [String] :tfvc_project For a tfvc import, the name of the project that is being imported.
+      # @overload start_source_import(repo, vcs_url, options = {})
+      #   @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      #   @param vcs_url [String] The URL of the originating repository.
+      #   @param options [Hash]
+      #   @param options [String] :vcs The originating VCS type. Can be one of "subversion", "git", "mercurial", or "tfvc".
+      #   @option options [String] :vcs_username If authentication is required, the username to provide to vcs_url.
+      #   @option options [String] :vcs_password If authentication is required, the password to provide to vcs_url.
+      #   @option options [String] :tfvc_project For a tfvc import, the name of the project that is being imported.
       # @return [Sawyer::Resource] Hash representing the repository import
       # @see https://developer.github.com/v3/migration/source_imports/#start-an-import
       #
       # @example
-      #   @client.import("octokit/octokit.rb", "subversion", "http://svn.mycompany.com/svn/myproject" {
+      #   @client.start_source_import("octokit/octokit.rb", "http://svn.mycompany.com/svn/myproject", {
+      #    :vcs           => "subversion",
       #    :vcs_username" => "octocat",
       #    :vcs_password  => "secret"
       #   })
-      def start_source_import(repo, vcs, vcs_url, options = {})
-        options = ensure_api_media_type(:source_imports, options.merge(:vcs => vcs, :vcs_url => vcs_url))
-        put "#{Repository.path repo}/import", options
+      def start_source_import(*args)
+        arguments = Octokit::RepoArguments.new(args)
+        vcs_url = arguments.pop
+        vcs = arguments.pop
+        if vcs
+          octokit_warn "Octokit#start_source_import vcs parameter is now an option, please update your call before the next major Octokit version update."
+          arguments.options.merge!(:vcs => vcs)
+        end
+        options = ensure_api_media_type(:source_imports, arguments.options.merge(:vcs_url => vcs_url))
+        put "#{Repository.path arguments.repo}/import", options
       end
 
       # View the progress of an import.
@@ -41,6 +59,27 @@ module Octokit
         get "#{Repository.path repo}/import", options
       end
 
+      # Update source import with authentication or project choice
+      # Restart source import if no options are passed
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @return [Sawyer::Resource] Hash representing the repository import
+      # @see https://developer.github.com/v3/migration/source_imports/#update-existing-import
+      # @option options [String] :vcs_username If authentication is required, the username to provide to vcs_url.
+      # @option options [String] :vcs_password If authentication is required, the password to provide to vcs_url.
+      # @option options [String] To update project choice, please refer to the project_choice array from the progress return hash for the exact attributes.
+      # https://developer.github.com/v3/migration/source_imports/#update-existing-import
+      #
+      # @example
+      #   @client.update_source_import("octokit/octokit.rb", {
+      #    :vcs_username" => "octocat",
+      #    :vcs_password  => "secret"
+      #   })
+      def update_source_import(repo, options = {})
+        options = ensure_api_media_type(:source_imports, options)
+        patch "#{Repository.path repo}/import", options
+      end
+
       # List source import commit authors
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
@@ -88,6 +127,35 @@ module Octokit
         options = ensure_api_media_type(:source_imports, options)
         boolean_from_response :delete, "#{Repository.path repo}/import", options
       end
+
+      # List source import large files
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param options [Hash]
+      # @option options [Fixnum] :page Page of paginated results
+      # @return [Array<Sawyer::Resource>] Array of hashes representing files over 100MB.
+      # @see https://developer.github.com/v3/migration/source_imports/#get-large-files
+      #
+      # @example
+      #   @client.source_import_large_files("octokit/octokit.rb")
+      def source_import_large_files(repo, options = {})
+        options = ensure_api_media_type(:source_imports, options)
+        get "#{Repository.path repo}/import/large_files", options
+      end
+
+      # Set preference for using Git LFS to import files over 100MB
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param use_lfs [String] Preference for using Git LFS to import large files. Can be one of "opt_in" or "opt_out"
+      # @return [Sawyer::Resource] Hash representing the repository import
+      # @see https://developer.github.com/v3/migration/source_imports/#set-git-lfs-preference
+      #
+      # @example
+      #   @client.opt_in_source_import_lfs("octokit/octokit.rb", "opt_in")
+      def set_source_import_lfs_preference(repo, use_lfs, options = {})
+        options = ensure_api_media_type(:source_imports, options.merge(:use_lfs => use_lfs))
+        patch "#{Repository.path repo}/import/lfs", options
+      end
     end
   end
 end

data/lib/octokit/client/stats.rb

@@ -96,7 +96,7 @@ module Octokit
           data = get("#{Repository.path repo}/stats/#{metric}", options)
           return data if last_response.status == 200
           return nil unless retry_timeout
-          return data if Time.now >= timeout
+          return nil if Time.now >= timeout
           sleep retry_wait if retry_wait
         end
       end

data/lib/octokit/default.rb

@@ -106,7 +106,7 @@ module Octokit
 
       # Default middleware stack for Faraday::Connection
       # from {MIDDLEWARE}
-      # @return [String]
+      # @return [Faraday::RackBuilder or Faraday::Builder]
       def middleware
         MIDDLEWARE
       end

data/lib/octokit/enterprise_admin_client.rb

@@ -32,6 +32,8 @@ module Octokit
       Octokit::Configurable.keys.each do |key|
         instance_variable_set(:"@#{key}", options[key] || Octokit.instance_variable_get(:"@#{key}"))
       end
+
+      login_from_netrc unless user_authenticated? || application_authenticated?
     end
 
   end

data/lib/octokit/error.rb

@@ -16,12 +16,13 @@ module Octokit
                   when 400      then Octokit::BadRequest
                   when 401      then error_for_401(headers)
                   when 403      then error_for_403(body)
-                  when 404      then Octokit::NotFound
+                  when 404      then error_for_404(body)
                   when 405      then Octokit::MethodNotAllowed
                   when 406      then Octokit::NotAcceptable
                   when 409      then Octokit::Conflict
                   when 415      then Octokit::UnsupportedMediaType
                   when 422      then Octokit::UnprocessableEntity
+                  when 451      then Octokit::UnavailableForLegalReasons
                   when 400..499 then Octokit::ClientError
                   when 500      then Octokit::InternalServerError
                   when 501      then Octokit::NotImplemented
@@ -68,11 +69,23 @@ module Octokit
         Octokit::RepositoryUnavailable
       elsif body =~ /email address must be verified/i
         Octokit::UnverifiedEmail
+      elsif body =~ /account was suspended/i
+        Octokit::AccountSuspended
       else
         Octokit::Forbidden
       end
     end
 
+    # Return most appropriate error for 404 HTTP status code
+    # @private
+    def self.error_for_404(body)
+      if body =~ /Branch not protected/i
+        Octokit::BranchNotProtected
+      else
+        Octokit::NotFound
+      end
+    end
+
     # Array of validation errors
     # @return [Array<Hash>] Error info
     def errors
@@ -83,6 +96,13 @@ module Octokit
       end
     end
 
+    # Status code returned by the GitHub server.
+    #
+    # @return [Integer]
+    def response_status
+      @response[:status]
+    end
+
     private
 
     def data
@@ -205,9 +225,17 @@ module Octokit
   # and body matches 'email address must be verified'
   class UnverifiedEmail < Forbidden; end
 
+  # Raised when GitHub returns a 403 HTTP status code
+  # and body matches 'account was suspended'
+  class AccountSuspended < Forbidden; end
+
   # Raised when GitHub returns a 404 HTTP status code
   class NotFound < ClientError; end
 
+  # Raised when GitHub returns a 404 HTTP status code
+  # and body matches 'Branch not protected'
+  class BranchNotProtected < ClientError; end
+
   # Raised when GitHub returns a 405 HTTP status code
   class MethodNotAllowed < ClientError; end
 
@@ -223,6 +251,9 @@ module Octokit
   # Raised when GitHub returns a 422 HTTP status code
   class UnprocessableEntity < ClientError; end
 
+  # Raised when GitHub returns a 451 HTTP status code
+  class UnavailableForLegalReasons < ClientError; end
+
   # Raised on errors in the 500-599 range
   class ServerError < Error; end
 

data/lib/octokit/preview.rb

@@ -4,10 +4,14 @@ module Octokit
   module Preview
 
     PREVIEW_TYPES = {
-      :branch_protection => 'application/vnd.github.loki-preview+json'.freeze,
-      :migrations        => 'application/vnd.github.wyandotte-preview+json'.freeze,
-      :licenses          => 'application/vnd.github.drax-preview+json'.freeze,
-      :source_imports    => 'application/vnd.github.barred-rock-preview'.freeze,
+      :branch_protection      => 'application/vnd.github.loki-preview+json'.freeze,
+      :migrations             => 'application/vnd.github.wyandotte-preview+json'.freeze,
+      :licenses               => 'application/vnd.github.drax-preview+json'.freeze,
+      :source_imports         => 'application/vnd.github.barred-rock-preview'.freeze,
+      :reactions              => 'application/vnd.github.squirrel-girl-preview'.freeze,
+      :repository_invitations => 'application/vnd.github.swamp-thing-preview+json'.freeze,
+      :issue_timelines        => 'application/vnd.github.mockingbird-preview+json'.freeze,
+      :pages                  => 'application/vnd.github.mister-fantastic-preview+json'.freeze
     }
 
     def ensure_api_media_type(type, options)
@@ -19,7 +23,7 @@ module Octokit
     end
 
     def warn_preview(type)
-      warn <<-EOS
+      octokit_warn <<-EOS
 WARNING: The preview version of the #{type.to_s.capitalize} API is not yet suitable for production use.
 You can avoid this message by supplying an appropriate media type in the 'Accept' request
 header.

data/lib/octokit/repository.rb

@@ -10,7 +10,10 @@ module Octokit
     #
     # @return [Repository]
     def self.from_url(url)
-      Repository.new(URI.parse(url).path[1..-1])
+      new URI.parse(url).path[1..-1].
+        gsub(/^repos\//,'').
+        split('/', 3)[0..1].
+        join('/')
     end
 
     # @raise [Octokit::InvalidRepository] if the repository
@@ -78,7 +81,7 @@ module Octokit
     private
 
       def validate_owner_and_name!
-        if @owner.include?('/') || @name.include?('/') || !url.match(/\A#{URI.regexp}\z/)
+        if @owner.include?('/') || @name.include?('/') || !url.match(URI::ABS_URI)
           raise_invalid_repository!
         end
       end

data/lib/octokit/version.rb

@@ -5,7 +5,7 @@ module Octokit
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 3
+  MINOR = 4
 
   # Current patch level.
   # @return [Integer]

data/octokit.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |spec|
   spec.licenses = ['MIT']
   spec.name = 'octokit'
   spec.require_paths = ['lib']
-  spec.required_ruby_version = '>= 1.9.2'
+  spec.required_ruby_version = '>= 2.0.0'
   spec.required_rubygems_version = '>= 1.3.5'
   spec.summary = "Ruby toolkit for working with the GitHub API"
   spec.version = Octokit::VERSION.dup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.3.0
+  version: 4.4.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-05 00:00:00.000000000 Z
+date: 2016-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -90,9 +90,11 @@ files:
 - lib/octokit/client/pub_sub_hubbub.rb
 - lib/octokit/client/pull_requests.rb
 - lib/octokit/client/rate_limit.rb
+- lib/octokit/client/reactions.rb
 - lib/octokit/client/refs.rb
 - lib/octokit/client/releases.rb
 - lib/octokit/client/repositories.rb
+- lib/octokit/client/repository_invitations.rb
 - lib/octokit/client/say.rb
 - lib/octokit/client/search.rb
 - lib/octokit/client/service_status.rb
@@ -137,7 +139,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.2
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="