octokit 4.6.2 → 4.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bb6b6020c5f0f6175df423d2bd14f34f8091e642
-  data.tar.gz: 5576bbff93ac6cf925da89829980ac80989d5486
+  metadata.gz: 24ad9c72b02054c430f10ff8614064cce38297b2
+  data.tar.gz: 11f0aebf4f5266212ebaa314702622f7fdf0d6be
 SHA512:
-  metadata.gz: 240718002a8e24560a0cc62177330efa7ab642e2950f2edfef17a909f3707165e6c0e476811255aca61fc3c335898c026448e823fc6f7a0fd3bec85b4b9c94d1
-  data.tar.gz: 751c63c2e58f4efb24f0399cfcb4fe3576bca867001510102d6dbf68a7f7a29922abbfee70d205dabc5b31914a3f32e0ff550ead9fd869f522eabdb63dd895df
+  metadata.gz: 0067cbdcbdd2bd217622159bc716c5f2ba50b7ae2a6bcff8234ba0ec8a0dcd1c4d7f009d6391d6f70c8f7fb5ff907ed27e56c0ba9204edb021e8d5ef6422df16
+  data.tar.gz: d1c6ee18fcdbbcd0c0d2115e3bdf24c832e57d03a8454d1a3ad7f474733854d9992f4323a504256117ccc7769120971bb1634417a5d710ff49ee635187716a48

data/README.md

@@ -2,8 +2,7 @@
 
 Ruby toolkit for the GitHub API.
 
-![Logo][logo]
-[logo]: http://cl.ly/image/3Y013H0A2z3z/gundam-ruby.png
+![logo](http://cl.ly/image/3Y013H0A2z3z/gundam-ruby.png)
 
 Upgrading? Check the [Upgrade Guide](#upgrading-guide) before bumping to a new
 [major version][semver].
@@ -622,11 +621,14 @@ ENV Variable | Description |
 `OCTOKIT_TEST_GITHUB_CLIENT_SECRET` | Test OAuth application client secret.
 `OCTOKIT_TEST_GITHUB_REPOSITORY` | Test repository to perform destructive actions against, this should not be set to any repository of importance. **Automatically created by the test suite if nonexistent** Default: `api-sandbox`
 `OCTOKIT_TEST_GITHUB_ORGANIZATION` | Test organization.
-`OCTOKIT_TEST_GITHUB_ENTERPRISE_LOGIN` | GitHub Enterprise login name
-`OCTOKIT_TEST_GITHUB_ENTERPRISE_TOKEN` | GitHub Enterprise token
-`OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD` | GitHub Enterprise management console password
-`OCTOKIT_TEST_GITHUB_ENTERPRISE_ENDPOINT` | GitHub Enterprise hostname
-`OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT` | GitHub Enterprise Management Console endpoint
+`OCTOKIT_TEST_GITHUB_ENTERPRISE_LOGIN` | GitHub Enterprise login name.
+`OCTOKIT_TEST_GITHUB_ENTERPRISE_TOKEN` | GitHub Enterprise token.
+`OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_PASSWORD` | GitHub Enterprise management console password.
+`OCTOKIT_TEST_GITHUB_ENTERPRISE_ENDPOINT` | GitHub Enterprise hostname.
+`OCTOKIT_TEST_GITHUB_ENTERPRISE_MANAGEMENT_CONSOLE_ENDPOINT` | GitHub Enterprise Management Console endpoint.
+`OCTOKIT_TEST_GITHUB_INTEGRATION` | [GitHub Integration](https://developer.github.com/early-access/integrations/) owned by your test organization.
+`OCTOKIT_TEST_GITHUB_INTEGRATION_INSTALLATION` | Installation of the GitHub Integration specified above.
+`OCTOKIT_TEST_INTEGRATION_PEM_KEY` | File path to the private key generated from your integration.
 
 Since we periodically refresh our cassettes, please keep some points in mind
 when writing new specs.

data/lib/octokit/authentication.rb

@@ -21,6 +21,14 @@ module Octokit
       !!@access_token
     end
 
+    # Indicates if the client was supplied a bearer token
+    #
+    # @see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
+    # @return [Boolean]
+    def bearer_authenticated?
+      !!@bearer_token
+    end
+
     # Indicates if the client was supplied an OAuth
     # access token or Basic Auth username and password
     #

data/lib/octokit/client.rb

@@ -22,6 +22,7 @@ require 'octokit/client/feeds'
 require 'octokit/client/gists'
 require 'octokit/client/gitignore'
 require 'octokit/client/hooks'
+require 'octokit/client/integrations'
 require 'octokit/client/issues'
 require 'octokit/client/labels'
 require 'octokit/client/legacy_search'
@@ -42,6 +43,7 @@ require 'octokit/client/refs'
 require 'octokit/client/releases'
 require 'octokit/client/repositories'
 require 'octokit/client/repository_invitations'
+require 'octokit/client/reviews'
 require 'octokit/client/say'
 require 'octokit/client/search'
 require 'octokit/client/service_status'
@@ -76,6 +78,7 @@ module Octokit
     include Octokit::Client::Gists
     include Octokit::Client::Gitignore
     include Octokit::Client::Hooks
+    include Octokit::Client::Integrations
     include Octokit::Client::Issues
     include Octokit::Client::Labels
     include Octokit::Client::LegacySearch
@@ -96,6 +99,7 @@ module Octokit
     include Octokit::Client::Releases
     include Octokit::Client::Repositories
     include Octokit::Client::RepositoryInvitations
+    include Octokit::Client::Reviews
     include Octokit::Client::Say
     include Octokit::Client::Search
     include Octokit::Client::ServiceStatus
@@ -126,6 +130,7 @@ module Octokit
       # mask password
       inspected = inspected.gsub! @password, "*******" if @password
       inspected = inspected.gsub! @management_console_password, "*******" if @management_console_password
+      inspected = inspected.gsub! @bearer_token, '********' if @bearer_token
       # Only show last 4 of token, secret
       if @access_token
         inspected = inspected.gsub! @access_token, "#{'*'*36}#{@access_token[36..-1]}"
@@ -186,6 +191,14 @@ module Octokit
       @access_token = value
     end
 
+    # Set Bearer Token for authentication
+    #
+    # @param value [String] JWT
+    def bearer_token=(value)
+      reset_agent
+      @bearer_token = value
+    end
+
     # Set OAuth app client_id
     #
     # @param value [String] 20 character GitHub OAuth app client_id
@@ -212,6 +225,8 @@ module Octokit
           http.basic_auth(@login, @password)
         elsif token_authenticated?
           http.authorization 'token', @access_token
+        elsif bearer_authenticated?
+          http.authorization 'Bearer', @bearer_token
         end
         http.headers['accept'] = options[:accept] if options.key?(:accept)
       end

data/lib/octokit/client/authorizations.rb

@@ -152,7 +152,7 @@ module Octokit
         secret = opts.delete(:client_secret) || client_secret
 
         as_app(key, secret) do |app_client|
-          app_client.get "/applications/#{client_id}/tokens/#{token}", opts
+          app_client.get "applications/#{client_id}/tokens/#{token}", opts
         end
       end
 
@@ -173,7 +173,7 @@ module Octokit
         secret = opts.delete(:client_secret) || client_secret
 
         as_app(key, secret) do |app_client|
-          app_client.post "/applications/#{client_id}/tokens/#{token}", opts
+          app_client.post "applications/#{client_id}/tokens/#{token}", opts
         end
       end
 
@@ -194,7 +194,7 @@ module Octokit
         secret = opts.delete(:client_secret) || client_secret
 
         as_app(key, secret) do |app_client|
-          app_client.delete "/applications/#{client_id}/tokens/#{token}", opts
+          app_client.delete "applications/#{client_id}/tokens/#{token}", opts
 
           app_client.last_response.status == 204
         end

data/lib/octokit/client/gists.rb

@@ -195,7 +195,7 @@ module Octokit
       # @example
       #   @client.create_gist_comment('3528645', 'This is very helpful.')
       def create_gist_comment(gist_id, comment, options = {})
-        options.merge!({:body => comment})
+        options = options.merge({:body => comment})
         post "gists/#{gist_id}/comments", options
       end
 
@@ -211,7 +211,7 @@ module Octokit
       # @example
       #   @client.update_gist_comment('208sdaz3', '3528645', ':heart:')
       def update_gist_comment(gist_id, gist_comment_id, comment, options = {})
-        options.merge!({:body => comment})
+        options = options.merge({:body => comment})
         patch "gists/#{gist_id}/comments/#{gist_comment_id}", options
       end
 

data/lib/octokit/client/integrations.rb

@@ -0,0 +1,77 @@
+module Octokit
+  class Client
+
+    # Methods for the Integrations API
+    module Integrations
+
+      # Find all installations that belong to an Integration
+      #
+      # @param options [Hash] An customizable set of options
+      #
+      # @see https://developer.github.com/v3/integrations/#find-installations
+      #
+      # @return [Array<Sawyer::Resource>] A list of installations
+      def find_integration_installations(options = {})
+        opts = ensure_api_media_type(:integrations, options)
+        paginate "/integration/installations", opts
+      end
+      alias find_installations find_integration_installations
+
+      # Create a new installation token
+      #
+      # @param installation [Integer] The id of a a GitHub Integration Installation
+      # @param options [Hash] An customizable set of options
+      #
+      # @see https://developer.github.com/v3/integrations/#find-installations
+      #
+      # @return [<Sawyer::Resource>] An installation token
+      def create_integration_installation_access_token(installation, options = {})
+        opts = ensure_api_media_type(:integrations, options)
+        post "/installations/#{installation}/access_tokens", opts
+      end
+      alias create_installation_access_token create_integration_installation_access_token
+
+      # List repositories that are accessible to the authenticated installation
+      #
+      # @param options [Hash] An customizable set of options
+      # @see https://developer.github.com/v3/integrations/installations/#list-repositories
+      #
+      # @return [Array<Sawyer::Resource>] A list of repositories
+      def list_integration_installation_repositories(options = {})
+        opts = ensure_api_media_type(:integrations, options)
+        paginate "/installation/repositories", opts
+      end
+      alias list_installation_repos list_integration_installation_repositories
+
+      # Add a single repository to an installation
+      #
+      # @param installation [Integer] The id of a a GitHub Integration Installation
+      # @param repo [Integer] The id of the GitHub repository
+      # @param options [Hash] An customizable set of options
+      #
+      # @see https://developer.github.com/v3/integrations/installations/#add-repository-to-installation
+      #
+      # @return [Boolean] Success
+      def add_repository_to_integration_installation(installation, repo, options = {})
+        opts = ensure_api_media_type(:integrations, options)
+        boolean_from_response :put, "/installations/#{installation}/repositories/#{repo}", opts
+      end
+      alias add_repo_to_installation add_repository_to_integration_installation
+
+      # Remove a single repository to an installation
+      #
+      # @param installation [Integer] The id of a a GitHub Integration Installation
+      # @param repo [Integer] The id of the GitHub repository
+      # @param options [Hash] An customizable set of options
+      #
+      # @see https://developer.github.com/v3/integrations/installations/#remove-repository-from-installation
+      #
+      # @return [Boolean] Success
+      def remove_repository_from_integration_installation(installation, repo, options = {})
+        opts = ensure_api_media_type(:integrations, options)
+        boolean_from_response :delete, "/installations/#{installation}/repositories/#{repo}", opts
+      end
+      alias remove_repo_from_installation remove_repository_from_integration_installation
+    end
+  end
+end

data/lib/octokit/client/labels.rb

@@ -78,7 +78,7 @@ module Octokit
       # This removes the label from the Issue
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
-      # @param number [Fixnum] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @param label [String] String name of the label
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see https://developer.github.com/v3/issues/labels/#remove-a-label-from-an-issue
@@ -93,7 +93,7 @@ module Octokit
       # This removes the label from the Issue
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
-      # @param number [Fixnum] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @return [Boolean] Success of operation
       # @see https://developer.github.com/v3/issues/labels/#remove-all-labels-from-an-issue
       # @example Remove all labels from Issue #23
@@ -105,7 +105,7 @@ module Octokit
       # List labels for a given issue
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
-      # @param number [Fixnum] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see https://developer.github.com/v3/issues/labels/#list-labels-on-an-issue
       # @example List labels for octokit/octokit.rb, issue # 1
@@ -117,7 +117,7 @@ module Octokit
       # Add label(s) to an Issue
       #
       # @param repo [Integer, String, Repository, Hash] A Github repository
-      # @param number [Fixnum] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @param labels [Array] An array of labels to apply to this Issue
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see https://developer.github.com/v3/issues/labels/#add-labels-to-an-issue
@@ -130,7 +130,7 @@ module Octokit
       # Replace all labels on an Issue
       #
       # @param repo [Integer, String, Repository, Hash] A Github repository
-      # @param number [Fixnum] Number ID of the issue
+      # @param number [Integer] Number ID of the issue
       # @param labels [Array] An array of labels to use as replacement
       # @return [Array<Sawyer::Resource>] A list of the labels currently on the issue
       # @see https://developer.github.com/v3/issues/labels/#replace-all-labels-for-an-issue
@@ -143,7 +143,7 @@ module Octokit
       # Get labels for every issue in a milestone
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
-      # @param number [Fixnum] Number ID of the milestone
+      # @param number [Integer] Number ID of the milestone
       # @return [Array<Sawyer::Resource>] A list of the labels across the milestone
       # @see  http://developer.github.com/v3/issues/labels/#get-labels-for-every-issue-in-a-milestone
       # @example List all labels for milestone #2 on octokit/octokit.rb

data/lib/octokit/client/organizations.rb

@@ -31,6 +31,8 @@ module Octokit
       # @option values [String] :email Publicly visible email address.
       # @option values [String] :location Location of organization.
       # @option values [String] :name GitHub username for organization.
+      # @option values [String] :default_repository_permission The default permission members have on organization repositories.
+      # @option values [Boolean] :members_can_create_repositories Set true to allow members to create repositories on the organization.
       # @return [Sawyer::Resource] Hash representing GitHub organization.
       # @see https://developer.github.com/v3/orgs/#edit-an-organization
       # @example
@@ -96,7 +98,7 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] List of GitHub organizations.
       def all_organizations(options = {})
-        paginate "organizations"
+        paginate "organizations", options
       end
       alias :all_orgs :all_organizations
 
@@ -207,6 +209,69 @@ module Octokit
       end
       alias :org_public_member? :organization_public_member?
 
+      # List pending organization invitations
+      #
+      # Requires authenticated organization member.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing invitations.
+      # @see https://developer.github.com/v3/orgs/members/#list-pending-organization-invitations
+      #
+      # @example
+      #   @client.organization_invitations('github')
+      def organization_invitations(org, options = {})
+        options = ensure_api_media_type(:org_memberships, options)
+        get "#{Organization.path org}/invitations", options
+      end
+      alias :org_invitations :organization_invitations
+
+      # List outside collaborators for an organization
+      #
+      # Requires authenticated organization members.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing users.
+      # @see https://developer.github.com/v3/orgs/outside-collaborators/#list-outside-collaborators
+      #
+      # @example
+      #   @client.outside_collaborators('github')
+      def outside_collaborators(org, options={})
+        options = ensure_api_media_type(:org_memberships, options)
+        get "#{Organization.path org}/outside_collaborators", options
+      end
+
+      # Remove outside collaborator from an organization
+      #
+      # Requires authenticated organization members.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @param user [String] GitHub username to be removed as outside collaborator
+      # @return [Boolean] Return true if outside collaborator removed from organization, false otherwise.
+      # @see https://developer.github.com/v3/orgs/outside-collaborators/#remove-outside-collaborator
+      #
+      # @example
+      #   @client.remove_outside_collaborator('github', 'lizzhale')
+      def remove_outside_collaborator(org, user, options={})
+        options = ensure_api_media_type(:org_memberships, options)
+        boolean_from_response :delete, "#{Organization.path org}/outside_collaborators/#{user}", options
+      end
+
+      # Converts an organization member to an outside collaborator
+      #
+      # Requires authenticated organization members.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @param user [String] GitHub username to be removed as outside collaborator
+      # @return [Boolean] Return true if outside collaborator removed from organization, false otherwise.
+      # @see https://developer.github.com/v3/orgs/outside-collaborators/#convert-member-to-outside-collaborator
+      #
+      # @example
+      #   @client.convert_to_outside_collaborator('github', 'lizzhale')
+      def convert_to_outside_collaborator(org, user, options={})
+        options = ensure_api_media_type(:org_memberships, options)
+        boolean_from_response :put, "#{Organization.path org}/outside_collaborators/#{user}", options
+      end
+
       # List teams
       #
       # Requires authenticated organization member.
@@ -230,6 +295,7 @@ 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 [Array<String>] :maintainers Maintainers for the team.
       # @return [Sawyer::Resource] Hash representing new team.
       # @see https://developer.github.com/v3/orgs/teams/#create-team
       # @example
@@ -361,12 +427,27 @@ module Octokit
       # @see https://developer.github.com/v3/orgs/teams/#get-team-member
       #
       # @example Check if a user is in your team
-      #   @client.team_member?('your_team', 'pengwynn')
+      #   @client.team_member?(100000, 'pengwynn')
       #   => false
       def team_member?(team_id, user, options = {})
         boolean_from_response :get, "teams/#{team_id}/members/#{user}", options
       end
 
+      # List pending team invitations
+      #
+      # Requires authenticated organization member.
+      #
+      # @param team_id [Integer] Team id.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing invitations.
+      # @see https://developer.github.com/v3/orgs/teams/#list-pending-team-invitations
+      #
+      # @example
+      #   @client.team_invitations('github')
+      def team_invitations(team_id, options = {})
+        options = ensure_api_media_type(:org_memberships, options)
+        get "teams/#{team_id}/invitations", options
+      end
+
       # List team repositories
       #
       # Requires authenticated organization member.
@@ -560,14 +641,14 @@ module Octokit
 
       # Get an organization membership
       #
-      # @param org [String] Organization GitHub login.
+      # @param org [Integer, String] The GitHub Organization.
       # @option options [String] :user  The login of the user, otherwise authenticated user.
       # @return [Sawyer::Resource] Hash representing the organization membership.
       # @see https://developer.github.com/v3/orgs/members/#get-your-organization-membership
       # @see https://developer.github.com/v3/orgs/members/#get-organization-membership
       def organization_membership(org, options = {})
         if user = options.delete(:user)
-          get "orgs/#{org}/memberships/#{user}", options
+          get "#{Organization.path(org)}/memberships/#{user}", options
         else
           get "user/memberships/orgs/#{org}", options
         end

data/lib/octokit/client/projects.rb

@@ -81,7 +81,7 @@ module Octokit
       # @return [Sawyer::Resource] Project
       # @see https://developer.github.com/v3/projects/#get-a-project 
       # @example
-      #   Octokit.project("octokit/octokit.rb", 1)
+      #   Octokit.project(123942)
       def project(id, options = {})
         opts = ensure_api_media_type(:projects, options)
         get "projects/#{id}", opts
@@ -123,7 +123,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] List of project columns
       # @see https://developer.github.com/v3/projects/columns/#list-project-columns 
       # @example
-      #   @client.project_columns("octokit/octokit.rb", 1)
+      #   @client.project_columns(123942)
       def project_columns(id, options = {})
         opts = ensure_api_media_type(:projects, options)
         paginate "projects/#{id}/columns", opts
@@ -138,7 +138,7 @@ module Octokit
       # @return [Sawyer::Resource] Newly created column
       # @see https://developer.github.com/v3/projects/columns/#create-a-project-column 
       # @example
-      #   @client.create_project_column("octokit/octokit.rb", 1, "To Dones")
+      #   @client.create_project_column(123942, "To Dones")
       def create_project_column(id, name, options = {})
         opts = ensure_api_media_type(:projects, options)
         opts[:name] = name
@@ -151,7 +151,7 @@ module Octokit
       # @return [Sawyer::Resource] Project column
       # @see https://developer.github.com/v3/projects/columns/#get-a-project-column 
       # @example
-      #   Octokit.project_column(123940, 30)
+      #   Octokit.project_column(30294)
       def project_column(id, options = {})
         opts = ensure_api_media_type(:projects, options)
         get "projects/columns/#{id}", opts
@@ -198,7 +198,7 @@ module Octokit
       # @return [Sawyer::Resource] Result
       # @see https://developer.github.com/v3/projects/columns/#move-a-project-column
       # @example
-      #   @client.move_project_column(3049, "last")
+      #   @client.move_project_column(30294, "last")
       def move_project_column(id, position, options = {})
         opts = ensure_api_media_type(:projects, options)
         opts[:position] = position
@@ -213,7 +213,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] Cards in the column
       # @see https://developer.github.com/v3/projects/cards/#list-project-cards
       # @example
-      #   @client.column_cards(123847)
+      #   @client.column_cards(30294)
       def column_cards(id, options = {})
         opts = ensure_api_media_type(:projects, options)
         paginate "projects/columns/#{id}/cards", opts

data/lib/octokit/client/pull_requests.rb

@@ -78,14 +78,14 @@ module Octokit
       end
 
       # Update a pull request
-      # @overload update_pull_request(repo, id, title=nil, body=nil, state=nil, options = {})
+      # @overload update_pull_request(repo, number, title=nil, body=nil, state=nil, options = {})
       #   @deprecated
       #   @param repo [Integer, String, Hash, Repository] A GitHub repository.
       #   @param number [Integer] Number of pull request to update.
       #   @param title [String] Title for the pull request.
       #   @param body [String] Body content for pull request. Supports GFM.
       #   @param state [String] State of the pull request. `open` or `closed`.
-      # @overload update_pull_request(repo, id,  options = {})
+      # @overload update_pull_request(repo, number,  options = {})
       #   @param repo [Integer, String, Hash, Repository] A GitHub repository.
       #   @param number [Integer] Number of pull request to update.
       #   @option options [String] :title Title for the pull request.

data/lib/octokit/client/rate_limit.rb

@@ -21,7 +21,7 @@ module Octokit
       # Get number of rate limted requests remaining
       #
       # @see https://developer.github.com/v3/rate_limit/#rate-limit
-      # @return [Fixnum] Number of requests remaining in this period
+      # @return [Integer] Number of requests remaining in this period
       def rate_limit_remaining(options = {})
         octokit_warn "Deprecated: Please use .rate_limit.remaining"
         rate_limit.remaining
@@ -41,7 +41,7 @@ module Octokit
       # Refresh rate limit info and get number of rate limted requests remaining
       #
       # @see https://developer.github.com/v3/rate_limit/#rate-limit
-      # @return [Fixnum] Number of requests remaining in this period
+      # @return [Integer] Number of requests remaining in this period
       def rate_limit_remaining!(options = {})
         octokit_warn "Deprecated: Please use .rate_limit!.remaining"
         rate_limit!.remaining

data/lib/octokit/client/repositories.rb

@@ -277,6 +277,9 @@ module Octokit
       # Requires authenticated client for private repos.
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @option options [String] :affiliation Filters the return array by affiliation.
+      #   Can be one of: <tt>outside</tt> or <tt>all</tt>.
+      #   If not specified, defaults to <tt>all</tt>
       # @return [Array<Sawyer::Resource>] Array of hashes representing collaborating users.
       # @see https://developer.github.com/v3/repos/collaborators/#list-collaborators
       # @example
@@ -346,6 +349,19 @@ module Octokit
         boolean_from_response :get, "#{Repository.path repo}/collaborators/#{collaborator}", options
       end
 
+      # Get a user's permission level for a repo.
+      #
+      # Requires authenticated client
+      #
+      # @return [Sawyer::Resource] Hash representing the user's permission level for the given repository
+      # @see https://developer.github.com/v3/repos/collaborators/#review-a-users-permission-level
+      # @example
+      #   @client.permission_level('octokit/octokit.rb', 'lizzhale')
+      def permission_level(repo, collaborator, options={})
+        options = ensure_api_media_type(:org_memberships, options)
+        get "#{Repository.path repo}/collaborators/#{collaborator}/permission", options
+      end
+
       # List teams for a repo
       #
       # Requires authenticated client that is an owner or collaborator of the repo.

data/lib/octokit/client/reviews.rb

@@ -0,0 +1,174 @@
+module Octokit
+  class Client
+
+    # Methods for the Reviews API
+    #
+    # @see https://developer.github.com/v3/reviews/
+    module Reviews
+
+      # List reviews on a pull request
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the pull request
+      # @see https://developer.github.com/v3/pulls/reviews/#list-reviews-on-a-pull-request
+      #
+      # @example
+      #   @client.pull_request_reviews('octokit/octokit.rb', 2)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the reviews
+      def pull_request_reviews(repo, id, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        get "#{Repository.path repo}/pulls/#{id}/reviews", options
+      end
+
+      # Get a single review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The id of the pull request
+      # @param review [Integer] The id of the review
+      # @see https://developer.github.com/v3/pulls/reviews/#get-a-single-review
+      #
+      # @example
+      #   @client.pull_request_review('octokit/octokit.rb', 825, 6505518)
+      #
+      # @return [Sawyer::Resource] Hash representing the review
+      def pull_request_review(repo, number, review, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        get "#{Repository.path repo}/pulls/#{number}/reviews/#{review}", options
+      end
+
+      # Delete a pending review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The id of the pull request
+      # @param review [Integer] The id of the review
+      # @see https://developer.github.com/v3/pulls/reviews/#delete-a-pending-review
+      #
+      # @example
+      #   @client.delete_pull_request_review('octokit/octokit.rb', 825, 6505518)
+      #
+      # @return [Sawyer::Resource] Hash representing the deleted review
+      def delete_pull_request_review(repo, number, review, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        delete "#{Repository.path repo}/pulls/#{number}/reviews/#{review}", options
+      end
+
+      # Get comments for a single review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The id of the pull request
+      # @param review [Integer] The id of the review
+      # @see https://developer.github.com/v3/pulls/reviews/#get-comments-for-a-single-review
+      #
+      # @example
+      #   @client.pull_request_review_comments('octokit/octokit.rb', 825, 6505518)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the review comments
+      def pull_request_review_comments(repo, number, review, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        get "#{Repository.path repo}/pulls/#{number}/reviews/#{review}/comments", options
+      end
+
+      # Create a pull request review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the pull request
+      # @param options [Hash] Method options
+      # @option options [String] :event The review action (event) to perform;
+      #   can be one of APPROVE, REQUEST_CHANGES, or COMMENT.
+      #   If left blank, the review is left PENDING.
+      # @option options [String] :body The body text of the pull request review
+      # @option options [Array<Hash>] :comments Comments part of the review
+      # @option comments [String] :path The path to the file being commented on
+      # @option comments [Integer] :position The position in the file to be commented on
+      # @option comments [String] :body Body of the comment
+      # @see https://developer.github.com/v3/pulls/reviews/#create-a-pull-request-review
+      #
+      # @example
+      #   comments = [
+      #     { path: '.travis.yml', position: 10, body: 'ruby-head is under development that is not stable.' },
+      #     { path: '.travis.yml', position: 32, body: 'ruby-head is also required in thervm section.' },
+      #   ]
+      #   options = { event: 'REQUEST_CHANGES', comments: comments }
+      #   @client.create_pull_request_review('octokit/octokit.rb', 844, options)
+      #
+      # @return [Sawyer::Resource>] Hash respresenting the review
+      def create_pull_request_review(repo, id, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        post "#{Repository.path repo}/pulls/#{id}/reviews", options
+      end
+
+      # Submit a pull request review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The id of the pull request
+      # @param review [Integer] The id of the review
+      # @param event [String] The review action (event) to perform; can be one of
+      #                       APPROVE, REQUEST_CHANGES, or COMMENT.
+      # @param options [Hash] Method options
+      # @option options [String] :body The body text of the pull request review
+      # @see https://developer.github.com/v3/pulls/reviews/#submit-a-pull-request-review
+      #
+      # @example
+      #   @client.submit_pull_request_review('octokit/octokit.rb', 825, 6505518,
+      #                                      'APPROVE', body: 'LGTM!')
+      #
+      # @return [Sawyer::Resource] Hash respresenting the review
+      def submit_pull_request_review(repo, number, review, event, options = {})
+        options = options.merge(event: event)
+        options = ensure_api_media_type(:reviews, options)
+        post "#{Repository.path repo}/pulls/#{number}/reviews/#{review}/events", options
+      end
+
+      # Dismiss a pull request review
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param number [Integer] The id of the pull request
+      # @param review [Integer] The id of the review
+      # @param message [String] The message for the pull request review dismissal
+      # @see https://developer.github.com/v3/pulls/reviews/#dismiss-a-pull-request-review
+      #
+      # @example
+      #   @client.dismiss_pull_request_review('octokit/octokit.rb', 825, 6505518)
+      #
+      # @return [Sawyer::Resource] Hash representing the dismissed review
+      def dismiss_pull_request_review(repo, number, review, message, options = {})
+        options = options.merge(message: message)
+        options = ensure_api_media_type(:reviews, options)
+        put "#{Repository.path repo}/pulls/#{number}/reviews/#{review}/dismissals", options
+      end
+
+      # List review requests
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the pull request
+      # @see https://developer.github.com/v3/pulls/review_requests/#list-review-requests
+      #
+      # @example
+      #   @client.pull_request_review_requests('octokit/octokit.rb', 2)
+      #
+      # @return [Array<Sawyer::Resource>] Array of Hashes representing the review requests
+      def pull_request_review_requests(repo, id, options = {})
+        options = ensure_api_media_type(:reviews, options)
+        get "#{Repository.path repo}/pulls/#{id}/requested_reviewers", options
+      end
+
+      # Create a review request
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param id [Integer] The id of the pull request
+      # @param reviewers [Array<String>] An array of user logins that will be requested
+      # @see https://developer.github.com/v3/pulls/review_requests/#create-a-review-request
+      #
+      # @example
+      #   @client.request_pull_request_review('octokit/octokit.rb', 2, ['soudy'])
+      #
+      # @return [Sawyer::Resource>] Hash respresenting the pull request
+      def request_pull_request_review(repo, id, reviewers, options = {})
+        options = options.merge(reviewers: reviewers)
+        options = ensure_api_media_type(:reviews, options)
+        post "#{Repository.path repo}/pulls/#{id}/requested_reviewers", options
+      end
+    end
+  end
+end

data/lib/octokit/client/search.rb

@@ -12,8 +12,8 @@ module Octokit
       # @param options [Hash] Sort and pagination options
       # @option options [String] :sort Sort field
       # @option options [String] :order Sort order (asc or desc)
-      # @option options [Fixnum] :page Page of paginated results
-      # @option options [Fixnum] :per_page Number of items per page
+      # @option options [Integer] :page Page of paginated results
+      # @option options [Integer] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-code
       def search_code(query, options = {})
@@ -26,8 +26,8 @@ module Octokit
       # @param options [Hash] Sort and pagination options
       # @option options [String] :sort Sort field
       # @option options [String] :order Sort order (asc or desc)
-      # @option options [Fixnum] :page Page of paginated results
-      # @option options [Fixnum] :per_page Number of items per page
+      # @option options [Integer] :page Page of paginated results
+      # @option options [Integer] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-issues
       def search_issues(query, options = {})
@@ -40,8 +40,8 @@ module Octokit
       # @param options [Hash] Sort and pagination options
       # @option options [String] :sort Sort field
       # @option options [String] :order Sort order (asc or desc)
-      # @option options [Fixnum] :page Page of paginated results
-      # @option options [Fixnum] :per_page Number of items per page
+      # @option options [Integer] :page Page of paginated results
+      # @option options [Integer] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-repositories
       def search_repositories(query, options = {})
@@ -55,8 +55,8 @@ module Octokit
       # @param options [Hash] Sort and pagination options
       # @option options [String] :sort Sort field
       # @option options [String] :order Sort order (asc or desc)
-      # @option options [Fixnum] :page Page of paginated results
-      # @option options [Fixnum] :per_page Number of items per page
+      # @option options [Integer] :page Page of paginated results
+      # @option options [Integer] :per_page Number of items per page
       # @return [Sawyer::Resource] Search results object
       # @see https://developer.github.com/v3/search/#search-users
       def search_users(query, options = {})

data/lib/octokit/client/source_import.rb

@@ -132,7 +132,7 @@ module Octokit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
       # @param options [Hash]
-      # @option options [Fixnum] :page Page of paginated results
+      # @option options [Integer] :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
       #

data/lib/octokit/client/statuses.rb

@@ -39,7 +39,7 @@ module Octokit
       # @return [Sawyer::Resource] A status
       # @see https://developer.github.com/v3/repos/statuses/#create-a-status
       def create_status(repo, sha, state, options = {})
-        options.merge!(:state => state)
+        options = options.merge(:state => state)
         post "#{Repository.path repo}/statuses/#{sha}", options
       end
     end

data/lib/octokit/client/users.rb

@@ -44,7 +44,7 @@ module Octokit
       # @example
       #   Octokit.exchange_code_for_token('aaaa', 'xxxx', 'yyyy', {:accept => 'application/json'})
       def exchange_code_for_token(code, app_id = client_id, app_secret = client_secret, options = {})
-        options.merge!({
+        options = options.merge({
           :code => code,
           :client_id => app_id,
           :client_secret => app_secret,
@@ -53,6 +53,7 @@ module Octokit
             :accept       => 'application/json'
           }
         })
+
         post "#{web_endpoint}login/oauth/access_token", options
       end
 

data/lib/octokit/configurable.rb

@@ -10,6 +10,9 @@ module Octokit
     #   @return [String] Base URL for API requests. default: https://api.github.com/
     # @!attribute auto_paginate
     #   @return [Boolean] Auto fetch next page of results until rate limit reached
+    # @!attribute [w] bearer_token
+    #   @see https://developer.github.com/early-access/integrations/authentication/#as-an-integration
+    #   @return [String] JWT bearer token for authentication
     # @!attribute client_id
     #   @see https://developer.github.com/v3/oauth/
     #   @return [String] Configure OAuth app key
@@ -47,7 +50,7 @@ module Octokit
     # @!attribute web_endpoint
     #   @return [String] Base URL for web URLs. default: https://github.com/
 
-    attr_accessor :access_token, :auto_paginate, :client_id,
+    attr_accessor :access_token, :auto_paginate, :bearer_token, :client_id,
                   :client_secret, :default_media_type, :connection_options,
                   :middleware, :netrc, :netrc_file,
                   :per_page, :proxy, :user_agent
@@ -63,6 +66,7 @@ module Octokit
           :access_token,
           :api_endpoint,
           :auto_paginate,
+          :bearer_token,
           :client_id,
           :client_secret,
           :connection_options,

data/lib/octokit/connection.rb

@@ -76,7 +76,7 @@ module Octokit
     #   contains the latest response.
     # @return [Sawyer::Resource]
     def paginate(url, options = {}, &block)
-      opts = parse_query_and_convenience_headers(options.dup)
+      opts = parse_query_and_convenience_headers(options)
       if @auto_paginate || @per_page
         opts[:query][:per_page] ||=  @per_page || (@auto_paginate ? 100 : nil)
       end
@@ -110,6 +110,8 @@ module Octokit
           http.basic_auth(@login, @password)
         elsif token_authenticated?
           http.authorization 'token', @access_token
+        elsif bearer_authenticated?
+          http.authorization 'Bearer', @bearer_token
         elsif application_authenticated?
           http.params = http.params.merge application_authentication
         end
@@ -179,6 +181,7 @@ module Octokit
     end
 
     def parse_query_and_convenience_headers(options)
+      options = options.dup
       headers = options.delete(:headers) { Hash.new }
       CONVENIENCE_HEADERS.each do |h|
         if header = options.delete(h)

data/lib/octokit/default.rb

@@ -57,6 +57,12 @@ module Octokit
         ENV['OCTOKIT_AUTO_PAGINATE']
       end
 
+      # Default bearer token from ENV
+      # @return [String]
+      def bearer_token
+        ENV['OCTOKIT_BEARER_TOKEN']
+      end
+
       # Default OAuth app key from ENV
       # @return [String]
       def client_id
@@ -118,7 +124,7 @@ module Octokit
       end
 
       # Default pagination page size from ENV
-      # @return [Fixnum] Page size
+      # @return [Integer] Page size
       def per_page
         page_size = ENV['OCTOKIT_PER_PAGE']
 

data/lib/octokit/error.rb

@@ -138,8 +138,12 @@ module Octokit
       return nil unless data.is_a?(Hash) && !Array(data[:errors]).empty?
 
       summary = "\nError summary:\n"
-      summary << data[:errors].map do |hash|
-        hash.map { |k,v| "  #{k}: #{v}" }
+      summary << data[:errors].map do |error|
+        if error.is_a? Hash
+          error.map { |k,v| "  #{k}: #{v}" }
+        else
+          "  #{error}"
+        end
       end.join("\n")
 
       summary

data/lib/octokit/gist.rb

@@ -15,7 +15,7 @@ module Octokit
 
     def initialize(gist)
       case gist
-      when Fixnum, String
+      when Integer, String
         @id = gist.to_s
       end
     end

data/lib/octokit/middleware/follow_redirects.rb

@@ -49,7 +49,7 @@ module Octokit
       # Public: Initialize the middleware.
       #
       # options - An options Hash (default: {}):
-      #           :limit               - A Fixnum redirect limit (default: 3).
+      #           :limit               - A Integer redirect limit (default: 3).
       def initialize(app, options = {})
         super(app)
         @options = options

data/lib/octokit/preview.rb

@@ -13,7 +13,10 @@ module Octokit
       :issue_timelines        => 'application/vnd.github.mockingbird-preview+json'.freeze,
       :pages                  => 'application/vnd.github.mister-fantastic-preview+json'.freeze,
       :projects               => 'application/vnd.github.inertia-preview+json'.freeze,
-      :traffic                => 'application/vnd.github.spiderman-preview'.freeze
+      :traffic                => 'application/vnd.github.spiderman-preview'.freeze,
+      :org_membership         => 'application/vnd.github.korra-preview'.freeze,
+      :reviews                => 'application/vnd.github.black-cat-preview'.freeze,
+      :integrations           => 'application/vnd.github.machine-man-preview+json'.freeze
     }
 
     def ensure_api_media_type(type, options)

data/lib/octokit/rate_limit.rb

@@ -3,13 +3,13 @@ module Octokit
   # Class for API Rate Limit info
   #
   # @!attribute [w] limit
-  #   @return [Fixnum] Max tries per rate limit period
+  #   @return [Integer] Max tries per rate limit period
   # @!attribute [w] remaining
-  #   @return [Fixnum] Remaining tries per rate limit period
+  #   @return [Integer] Remaining tries per rate limit period
   # @!attribute [w] resets_at
   #   @return [Time] Indicates when rate limit resets
   # @!attribute [w] resets_in
-  #   @return [Fixnum] Number of seconds when rate limit resets
+  #   @return [Integer] Number of seconds when rate limit resets
   #
   # @see https://developer.github.com/v3/#rate-limiting
   class RateLimit < Struct.new(:limit, :remaining, :resets_at, :resets_in)

data/lib/octokit/version.rb

@@ -5,11 +5,11 @@ module Octokit
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 6
+  MINOR = 7
 
   # Current patch level.
   # @return [Integer]
-  PATCH = 2
+  PATCH = 0
 
   # Full release version.
   # @return [String]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.6.2
+  version: 4.7.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-11-22 00:00:00.000000000 Z
+date: 2017-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -77,6 +77,7 @@ files:
 - lib/octokit/client/gists.rb
 - lib/octokit/client/gitignore.rb
 - lib/octokit/client/hooks.rb
+- lib/octokit/client/integrations.rb
 - lib/octokit/client/issues.rb
 - lib/octokit/client/labels.rb
 - lib/octokit/client/legacy_search.rb
@@ -97,6 +98,7 @@ files:
 - lib/octokit/client/releases.rb
 - lib/octokit/client/repositories.rb
 - lib/octokit/client/repository_invitations.rb
+- lib/octokit/client/reviews.rb
 - lib/octokit/client/say.rb
 - lib/octokit/client/search.rb
 - lib/octokit/client/service_status.rb