octokit 4.2.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 73f0bf2bde2a97e167a1fa41e45d4d5a71fb655c
-  data.tar.gz: 30568c40a8b5f36a3856e68887d350156a52b99b
+  metadata.gz: 433f670467c277e091d184af708f336f2a019b5a
+  data.tar.gz: 4c29fdcfe9e156bec1a58b83c809ced9ff628748
 SHA512:
-  metadata.gz: 2f35e8d8ea32a30434c9906744b15248905eda5cda4b53152d85ee3543673e1e6a96a64651168123506a1de6e247018e699396aac43cc6b65d646687b53bd4e8
-  data.tar.gz: ccbc3c6e9392ca6ecccec7548d0e2653480cf792403916d1d56e083915bb302166e4def32f02c98e47d87786b6e427d18afbbf3d8713abeb297f08fa5a239a8c
+  metadata.gz: db2aa2a80a84de1d91da8b0414145e1f7adb28a01b957cc14dfe075208a110aeaf85886fb2a6af45ee2fb5688cc51847ff698aa7731da656d7519e40776d764c
+  data.tar.gz: d6bc2a4e82cef39bde7daf9c2149e2b58dc6c75e09c5ce1f41936725937f90f58f54449f676b1ac0098c412027e4974016d2f7b415fbaf5f361ad97c697b9db2

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2009-2014 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober
+Copyright (c) 2009-2016 Wynn Netherland, Adam Stacoviak, Erik Michaels-Ober
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -267,7 +267,7 @@ To interact with the "regular" GitHub.com APIs in GitHub Enterprise, simply conf
 
 ``` ruby
 Octokit.configure do |c|
-  c.api_endpoint = "<hostname>/api/v3/"
+  c.api_endpoint = "https://<hostname>/api/v3/"
 end
 client = Octokit::Client.new(:access_token => "<your 40 char token>")
 ```
@@ -283,7 +283,7 @@ admin_client = Octokit::EnterpriseAdminClient.new \
 
 # or
 Octokit.configure do |c|
-  c.api_endpoint = "https://hostname/api/v3/"
+  c.api_endpoint = "https://<hostname>/api/v3/"
   c.access_token = "<your 40 char token>"
 end
 admin_client = Octokit.enterprise_admin_client
@@ -320,7 +320,9 @@ Do remember to turn `:verify` back to `true`, as it's important for secure commu
 While `Octokit::Client` accepts a range of options when creating a new client
 instance, Octokit's configuration API allows you to set your configuration
 options at the module level. This is particularly handy if you're creating a
-number of client instances based on some shared defaults.
+number of client instances based on some shared defaults. Changing options
+affects new instances only and will not modify existing `Octokit::Client`
+instances created with previous options.
 
 ### Configuring module defaults
 
@@ -408,6 +410,8 @@ the API root and follow link relations from there:
 ```ruby
 root = Octokit.root
 root.rels[:repository].get :uri => {:owner => "octokit", :repo => "octokit.rb" }
+root.rels[:user_repositories].get :uri => { :user => "octokit" },
+                                  :query => { :type => "owner" }
 ```
 
 Octokit 3.0 aims to be hypermedia-driven, removing the internal URL

data/lib/octokit/client.rb

@@ -42,6 +42,7 @@ require 'octokit/client/repositories'
 require 'octokit/client/say'
 require 'octokit/client/search'
 require 'octokit/client/service_status'
+require 'octokit/client/source_import'
 require 'octokit/client/stats'
 require 'octokit/client/statuses'
 require 'octokit/client/users'
@@ -90,6 +91,7 @@ module Octokit
     include Octokit::Client::Say
     include Octokit::Client::Search
     include Octokit::Client::ServiceStatus
+    include Octokit::Client::SourceImport
     include Octokit::Client::Stats
     include Octokit::Client::Statuses
     include Octokit::Client::Users

data/lib/octokit/client/authorizations.rb

@@ -54,7 +54,7 @@ module Octokit
       # @see https://developer.github.com/v3/oauth_authorizations/#get-or-create-an-authorization-for-a-specific-app
       # @example Create a new authorization for user ctshryock's project Zoidberg
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
-      #  client.create_authorization({:scopes => ["public_repo","gist"], :note => "Why not Zoidberg?", :note_url=> "https://en.wikipedia.org/wiki/Zoidberg"})
+      #  client.create_authorization({:scopes => ["public_repo", "gist"], :note => "Why not Zoidberg?", :note_url=> "https://en.wikipedia.org/wiki/Zoidberg"})
       # @example Create a new OR return an existing authorization to be used by a specific client for user ctshryock's project Zoidberg
       #  client = Octokit::Client.new(:login => 'ctshryock', :password => 'secret')
       #  client.create_authorization({:idempotent => true, :client_id => 'xxxx', :client_secret => 'yyyy', :scopes => ["user"]})
@@ -207,25 +207,12 @@ module Octokit
       #
       # Applications can revoke all of their tokens in a single request
       #
-      # @return [Boolean] Result
-      # @see https://developer.github.com/v3/oauth_authorizations/#revoke-all-authorizations-for-an-application
-      # @example
-      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
-      #  client.revoke_all_application_authorizations
+      # @deprecated As of January 25th, 2016: https://developer.github.com/changes/2014-04-08-reset-api-tokens/
+      # @return [Boolean] false
       def revoke_all_application_authorizations(options = {})
-        opts = options.dup
-        key    = opts.delete(:client_id)     || client_id
-        secret = opts.delete(:client_secret) || client_secret
-
-        as_app(key, secret) do |app_client|
-          app_client.delete "/applications/#{client_id}/tokens", opts
-
-          app_client.last_response.status == 204
-        end
-      rescue Octokit::NotFound
+        octokit_warn("Deprecated: If you need to revoke all tokens for your application, you can do so via the settings page for your application.")
         false
       end
-      alias :delete_application_authorization :revoke_application_authorization
 
       # Get the URL to authorize a user for an application via the web flow
       #

data/lib/octokit/client/deployments.rb

@@ -48,6 +48,8 @@ module Octokit
       #
       # @param deployment_url [String] A URL for a deployment resource
       # @param state [String] The state: pending, success, failure, error
+      # @option options [String] :target_url The target URL to associate with this status. Default: ""
+      # @option options [String] :description A short description of the status. Maximum length of 140 characters. Default: ""
       # @return [Sawyer::Resource] A deployment status
       # @see https://developer.github.com/v3/repos/deployments/#create-a-deployment-status
       def create_deployment_status(deployment_url, state, options = {})

data/lib/octokit/client/gists.rb

@@ -45,10 +45,16 @@ module Octokit
       # Get a single gist
       #
       # @param gist [String] ID of gist to fetch
+      # @option options [String] :sha Specific gist revision SHA
       # @return [Sawyer::Resource] Gist information
       # @see https://developer.github.com/v3/gists/#get-a-single-gist
+      # @see https://developer.github.com/v3/gists/#get-a-specific-revision-of-a-gist
       def gist(gist, options = {})
-        get "gists/#{Gist.new(gist)}", options
+        if sha = options.delete(:sha)
+          get "gists/#{Gist.new(gist)}/#{sha}", options
+        else
+          get "gists/#{Gist.new(gist)}", options
+        end
       end
 
       # Create a gist
@@ -88,6 +94,17 @@ module Octokit
         patch "gists/#{Gist.new(gist)}", options
       end
 
+      # List gist commits
+      #
+      # @param gist [String] Gist ID
+      # @return [Array] List of commits to the gist
+      # @see https://developer.github.com/v3/gists/#list-gist-commits
+      # @example List commits for a gist
+      #   @client.gist_commits('some_id')
+      def gist_commits(gist, options = {})
+        paginate "gists/#{Gist.new(gist)}/commits", options
+      end
+
       #
       # Star a gist
       #
@@ -125,6 +142,17 @@ module Octokit
         post "gists/#{Gist.new(gist)}/forks", options
       end
 
+      # List gist forks
+      #
+      # @param gist [String] Gist ID
+      # @return [Array] List of gist forks
+      # @see https://developer.github.com/v3/gists/#list-gist-forks
+      # @example List gist forks
+      #   @client.gist_forks('some-id')
+      def gist_forks(gist, options = {})
+        paginate "gists/#{Gist.new(gist)}/forks", options
+      end
+
       # Delete a gist
       #
       # @param gist [String] Gist ID

data/lib/octokit/client/hooks.rb

@@ -148,17 +148,31 @@ module Octokit
         boolean_from_response :post, "#{Repository.path repo}/hooks/#{id}/tests", options
       end
 
+      # Ping hook
+      #
+      # Requires authenticated client.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param id [Integer] Id of the hook to send a ping.
+      # @return [Boolean] Ping requested?
+      # @see https://developer.github.com/v3/repos/hooks/#ping-a-hook
+      # @example
+      #   @client.ping_hook('octokit/octokit.rb', 1000000)
+      def ping_hook(repo, id, options={})
+        boolean_from_response :post, "#{Repository.path repo}/hooks/#{id}/pings", options
+      end
+
       # List org hooks
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @return [Array<Sawyer::Resource>] Array of hashes representing hooks.
       # @see https://developer.github.com/v3/orgs/hooks/#list-hooks
       # @example
       #   @client.org_hooks('octokit')
       def org_hooks(org, options = {})
-        paginate "orgs/#{org}/hooks", options
+        paginate "#{Organization.path org}/hooks", options
       end
       alias :list_org_hooks :org_hooks
 
@@ -166,21 +180,21 @@ module Octokit
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] Id of the hook to get.
       # @return [Sawyer::Resource] Hash representing hook.
       # @see https://developer.github.com/v3/orgs/hooks/#get-single-hook
       # @example
       #   @client.org_hook('octokit', 123)
       def org_hook(org, id, options = {})
-        get "orgs/#{org}/hooks/#{id}", options
+        get "#{Organization.path org}/hooks/#{id}", options
       end
 
       # Create an org hook
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param config [Hash] A Hash containing key/value pairs to provide
       #   settings for this hook.
       # @option options [Array<String>] :events ('["push"]') Determines what
@@ -204,14 +218,14 @@ module Octokit
       #   )
       def create_org_hook(org, config, options = {})
         options = { :name => "web", :config => config }.merge(options)
-        post "orgs/#{org}/hooks", options
+        post "#{Organization.path org}/hooks", options
       end
 
       # Update an org hook
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] Id of the hook to update.
       # @param config [Hash] A Hash containing key/value pairs to provide
       #   settings for this hook.
@@ -237,7 +251,7 @@ module Octokit
       #   )
       def edit_org_hook(org, id, config, options = {})
         options = { :config => config }.merge(options)
-        patch "orgs/#{org}/hooks/#{id}", options
+        patch "#{Organization.path org}/hooks/#{id}", options
       end
       alias :update_org_hook :edit_org_hook
 
@@ -245,28 +259,28 @@ module Octokit
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] Id of the hook to update.
       # @return [Boolean] Success
       # @see https://developer.github.com/v3/orgs/hooks/#ping-a-hook
       # @example
       #   @client.ping_org_hook('octokit', 1000000)
       def ping_org_hook(org, id, options = {})
-        boolean_from_response :post, "orgs/#{org}/hooks/#{id}/pings", options
+        boolean_from_response :post, "#{Organization.path org}/hooks/#{id}/pings", options
       end
 
       # Remove org hook
       #
       # Requires client authenticated as admin for the org.
       #
-      # @param org [String] A GitHub organization login.
+      # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] Id of the hook to update.
       # @return [Boolean] True if hook removed, false otherwise.
       # @see https://developer.github.com/v3/orgs/hooks/#delete-a-hook
       # @example
       #   @client.remove_org_hook('octokit', 1000000)
       def remove_org_hook(org, id, options = {})
-        boolean_from_response :delete, "orgs/#{org}/hooks/#{id}", options
+        boolean_from_response :delete, "#{Organization.path org}/hooks/#{id}", options
       end
 
       # Parse payload string

data/lib/octokit/client/issues.rb

@@ -15,7 +15,7 @@ module Octokit
       # @option options [String] :assignee User login.
       # @option options [String] :creator User login.
       # @option options [String] :mentioned User login.
-      # @option options [Array<String>] :labels List of Label names. Example: <tt>['bug', 'ui', '@high']</tt>.
+      # @option options [String] :labels List of comma separated Label names. Example: <tt>bug,ui,@high</tt>.
       # @option options [String] :sort (created) Sort: <tt>created</tt>, <tt>updated</tt>, or <tt>comments</tt>.
       # @option options [String] :direction (desc) Direction: <tt>asc</tt> or <tt>desc</tt>.
       # @option options [Integer] :page (1) Page number.

data/lib/octokit/client/licenses.rb

@@ -30,7 +30,7 @@ module Octokit
 
       # Returns the contents of the repository’s license file, if one is detected.
       #
-      # @see https://developer.github.com/v3/licenses/#get-a-repositorys-license
+      # @see https://developer.github.com/v3/licenses/#get-the-contents-of-a-repositorys-license
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to 'master'.
       # @return [Sawyer::Resource] The detail of the license file

data/lib/octokit/client/notifications.rb

@@ -115,7 +115,7 @@ module Octokit
       # @return [Boolean] True if updated, false otherwise.
       # @see https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read
       # @example
-      #   @client.mark_thread_as_ready(1, :read => false)
+      #   @client.mark_thread_as_read(1, :read => false)
       def mark_thread_as_read(thread_id, options = {})
         request :patch, "notifications/threads/#{thread_id}", options
 

data/lib/octokit/client/organizations.rb

@@ -62,6 +62,7 @@ module Octokit
       # @param user [Integer, String] GitHub user login or id of the user to get
       #   list of organizations.
       # @return [Array<Sawyer::Resource>] Array of hashes representing organizations.
+      # @see https://developer.github.com/v3/orgs/#list-your-organizations
       # @see https://developer.github.com/v3/orgs/#list-user-organizations
       # @example
       #   Octokit.organizations('pengwynn')
@@ -393,7 +394,7 @@ module Octokit
       # @return [Boolean] True if managed by a team. False if not managed by
       #   the team OR the requesting user does not have authorization to access
       #   the team information.
-      # @see https://developer.github.com/v3/orgs/teams/#get-team-repo
+      # @see https://developer.github.com/v3/orgs/teams/#check-if-a-team-manages-a-repository
       # @example
       #   @client.team_repository?(8675309, 'octokit/octokit.rb')
       # @example
@@ -413,7 +414,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository.
       # @return [Boolean] True if successful, false otherwise.
       # @see Octokit::Repository
-      # @see https://developer.github.com/v3/orgs/teams/#add-team-repo
+      # @see https://developer.github.com/v3/orgs/teams/#add-team-repository
       # @example
       #   @client.add_team_repository(100000, 'github/developer.github.com')
       # @example
@@ -433,7 +434,7 @@ module Octokit
       # @param repo [String, Hash, Repository] A GitHub repository.
       # @return [Boolean] Return true if repo removed from team, false otherwise.
       # @see Octokit::Repository
-      # @see https://developer.github.com/v3/orgs/teams/#remove-team-repo
+      # @see https://developer.github.com/v3/orgs/teams/#remove-team-repository
       # @example
       #   @client.remove_team_repository(100000, 'github/developer.github.com')
       # @example
@@ -604,12 +605,12 @@ module Octokit
       # @param repositories [Array<String>] :repositories Repositories for the organization.
       # @option options [Boolean, optional] :lock_repositories Indicates whether repositories should be locked during migration
       # @return [Sawyer::Resource] Hash representing the new migration.
-      # @see https://developer.github.com/v3/orgs/teams/#create-team
       # @example
       #   @client.start_migration('github', ['github/dotfiles'])
       # @see https://developer.github.com/v3/orgs/migrations/#start-a-migration
       def start_migration(org, repositories, options = {})
         options = ensure_api_media_type(:migrations, options)
+        options[:repositories] = repositories
         post "orgs/#{org}/migrations", options
       end
 
@@ -631,7 +632,7 @@ module Octokit
       #
       # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] ID number of the migration.
-      # @see https://developer.github.com/v3/orgs/migrations/#get-a-list-of-migrations
+      # @see https://developer.github.com/v3/orgs/migrations/#get-the-status-of-a-migration
       def migration_status(org, id, options = {})
         options = ensure_api_media_type(:migrations, options)
         get "orgs/#{org}/migrations/#{id}", options
@@ -658,7 +659,7 @@ module Octokit
       #
       # @param org [String, Integer] Organization GitHub login or id.
       # @param id [Integer] ID number of the migration.
-      # @see https://developer.github.com/v3/orgs/migrations/#get-a-list-of-migrations
+      # @see https://developer.github.com/v3/orgs/migrations/#delete-a-migration-archive
       def delete_migration_archive(org, id, options = {})
         options = ensure_api_media_type(:migrations, options)
         delete "orgs/#{org}/migrations/#{id}/archive", options

data/lib/octokit/client/pull_requests.rb

@@ -276,7 +276,7 @@ module Octokit
 
       # Merge a pull request
       #
-      # @see https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-buttontrade
+      # @see https://developer.github.com/v3/pulls/#merge-a-pull-request-merge-button
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param number [Integer] Number of pull request
       # @param commit_message [String] Optional commit message for the merge commit

data/lib/octokit/client/refs.rb

@@ -44,10 +44,11 @@ module Octokit
       # @return [Array<Sawyer::Resource>] The list of references, already containing the new one
       # @see https://developer.github.com/v3/git/refs/#create-a-reference
       # @example Create refs/heads/master for octocat/Hello-World with sha 827efc6d56897b048c772eb4087f854f46256132
-      #   Octokit.create_ref("octocat/Hello-World","heads/master", "827efc6d56897b048c772eb4087f854f46256132")
+      #   Octokit.create_ref("octocat/Hello-World", "heads/master", "827efc6d56897b048c772eb4087f854f46256132")
       def create_ref(repo, ref, sha, options = {})
+        ref = "refs/#{ref}" unless ref =~ %r{refs/}
         parameters = {
-          :ref  => "refs/#{ref}",
+          :ref  => ref,
           :sha  => sha
         }
         post "#{Repository.path repo}/git/refs", options.merge(parameters)
@@ -63,7 +64,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] The list of references updated
       # @see https://developer.github.com/v3/git/refs/#update-a-reference
       # @example Force update heads/sc/featureA for octocat/Hello-World with sha aa218f56b14c9653891f9e74264a383fa43fefbd
-      #   Octokit.update_ref("octocat/Hello-World","heads/sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
+      #   Octokit.update_ref("octocat/Hello-World", "heads/sc/featureA", "aa218f56b14c9653891f9e74264a383fa43fefbd")
       def update_ref(repo, ref, sha, force = true, options = {})
         parameters = {
           :sha  => sha,

data/lib/octokit/client/releases.rb

@@ -132,6 +132,7 @@ module Octokit
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @param tag_name [String] the name for a tag
       # @return [Sawyer::Resource] The release
+      # @see https://developer.github.com/v3/repos/releases/#get-a-release-by-tag-name
       def release_for_tag(repo, tag_name, options = {})
         get "#{Repository.path repo}/releases/tags/#{tag_name}", options
       end
@@ -140,6 +141,7 @@ module Octokit
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
       # @return [Sawyer::Resource] The release
+      # @see https://developer.github.com/v3/repos/releases/#get-the-latest-release
       def latest_release(repo, options = {})
         get "#{Repository.path repo}/releases/latest", options
       end

data/lib/octokit/client/repositories.rb

@@ -22,6 +22,7 @@ module Octokit
       # Get a single repository
       #
       # @see https://developer.github.com/v3/repos/#get
+      # @see https://developer.github.com/v3/licenses/#get-a-repositorys-license
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @return [Sawyer::Resource] Repository information
       def repository(repo, options = {})
@@ -199,7 +200,7 @@ module Octokit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @return [Array<Sawyer::Resource>] Array of hashes representing deploy keys.
-      # @see https://developer.github.com/v3/repos/keys/#list
+      # @see https://developer.github.com/v3/repos/keys/#list-deploy-keys
       # @example
       #   @client.deploy_keys('octokit/octokit.rb')
       # @example
@@ -214,7 +215,7 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
       # @param id [Integer] Deploy key ID.
       # @return [Sawyer::Resource] Deploy key.
-      # @see https://developer.github.com/v3/repos/keys/#get
+      # @see https://developer.github.com/v3/repos/keys/#get-a-deploy-key
       # @example
       #   @client.deploy_key('octokit/octokit.rb', 8675309)
       def deploy_key(repo, id, options={})
@@ -229,7 +230,7 @@ module Octokit
       # @param title [String] Title reference for the deploy key.
       # @param key [String] Public key.
       # @return [Sawyer::Resource] Hash representing newly added key.
-      # @see https://developer.github.com/v3/repos/keys/#create
+      # @see https://developer.github.com/v3/repos/keys/#add-a-new-deploy-key
       # @example
       #    @client.add_deploy_key('octokit/octokit.rb', 'Staging server', 'ssh-rsa AAA...')
       def add_deploy_key(repo, title, key, options = {})
@@ -246,7 +247,7 @@ module Octokit
       # @return [Sawyer::Resource] Updated deploy key.
       # @deprecated This method is no longer supported in the API
       # @see https://developer.github.com/changes/2014-02-24-finer-grained-scopes-for-ssh-keys/
-      # @see https://developer.github.com/v3/repos/keys/#edit
+      # @see https://developer.github.com/v3/repos/keys/#edit-a-deploy-key
       # @example Update the key for a deploy key.
       #   @client.edit_deploy_key('octokit/octokit.rb', 8675309, :key => 'ssh-rsa BBB...')
       # @example
@@ -263,7 +264,7 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
       # @param id [Integer] Id of the deploy key to remove.
       # @return [Boolean] True if key removed, false otherwise.
-      # @see https://developer.github.com/v3/repos/keys/#delete
+      # @see https://developer.github.com/v3/repos/keys/#remove-a-deploy-key
       # @example
       #   @client.remove_deploy_key('octokit/octokit.rb', 100000)
       def remove_deploy_key(repo, id, options = {})
@@ -276,7 +277,7 @@ module Octokit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
       # @return [Array<Sawyer::Resource>] Array of hashes representing collaborating users.
-      # @see https://developer.github.com/v3/repos/collaborators/#list
+      # @see https://developer.github.com/v3/repos/collaborators/#list-collaborators
       # @example
       #   Octokit.collaborators('octokit/octokit.rb')
       # @example
@@ -295,7 +296,7 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
       # @param collaborator [String] Collaborator GitHub username to add.
       # @return [Boolean] True if collaborator added, false otherwise.
-      # @see https://developer.github.com/v3/repos/collaborators/#add-collaborator
+      # @see https://developer.github.com/v3/repos/collaborators/#add-user-as-a-collaborator
       # @example
       #   @client.add_collaborator('octokit/octokit.rb', 'holman')
       # @example
@@ -312,7 +313,7 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
       # @param collaborator [String] Collaborator GitHub username to remove.
       # @return [Boolean] True if collaborator removed, false otherwise.
-      # @see https://developer.github.com/v3/repos/collaborators/#remove-collaborator
+      # @see https://developer.github.com/v3/repos/collaborators/#remove-user-as-a-collaborator
       # @example
       #   @client.remove_collaborator('octokit/octokit.rb', 'holman')
       # @example
@@ -329,7 +330,7 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository.
       # @param collaborator [String] Collaborator GitHub username to check.
       # @return [Boolean] True if user is a collaborator, false otherwise.
-      # @see https://developer.github.com/v3/repos/collaborators/#get
+      # @see https://developer.github.com/v3/repos/collaborators/#check-if-a-user-is-a-collaborator
       # @example
       #   @client.collaborator?('octokit/octokit.rb', 'holman')
       def collaborator?(repo, collaborator, options={})

data/lib/octokit/client/source_import.rb

@@ -0,0 +1,93 @@
+module Octokit
+  class Client
+
+    # Methods for the Source Import API
+    #
+    # @see https://developer.github.com/v3/repos/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.
+      # @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" {
+      #    :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
+      end
+
+      # View the progress of an import.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @return [Sawyer::Resource] Hash representing the progress of the import
+      # @see https://developer.github.com/v3/migration/source_imports/#get-import-progress
+      #
+      # @example
+      #   @client.source_import_progress("octokit/octokit.rb")
+      def source_import_progress(repo, options = {})
+        options = ensure_api_media_type(:source_imports, options)
+        get "#{Repository.path repo}/import", options
+      end
+
+      # List source import commit authors
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @param options [Hash]
+      # @option options [String] :since Only authors found after this id are returned.
+      # @return [Array<Sawyer::Resource>] Array of hashes representing commit_authors.
+      # @see https://developer.github.com/v3/migration/source_imports/#get-commit-authors
+      #
+      # @example
+      #   @client.source_import_commit_authors("octokit/octokit.rb")
+      def source_import_commit_authors(repo, options = {})
+        options = ensure_api_media_type(:source_imports, options)
+        get "#{Repository.path repo}/import/authors", options
+      end
+
+      # Update an author's identity for the import.
+      #
+      # @param author_url [String] The source import API url for the commit author
+      # @param values [Hash] The updated author attributes
+      # @option values [String] :email The new Git author email.
+      # @option values [String] :name The new Git author name.
+      # @return [Sawyer::Resource] Hash representing the updated commit author
+      # @see https://developer.github.com/v3/migration/source_imports/#map-a-commit-author
+      #
+      # @example
+      #   author_url = "https://api.github.com/repos/octokit/octokit.rb/import/authors/1"
+      #   @client.map_source_import_commit_author(author_url, {
+      #     :email => "hubot@github.com",
+      #     :name => "Hubot the Robot"
+      #   })
+      def map_source_import_commit_author(author_url, values, options = {})
+        options = ensure_api_media_type(:source_imports, options.merge(values))
+        patch author_url, options
+      end
+
+      # Stop an import for a repository.
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository.
+      # @return [Boolean] True if the import has been cancelled, false otherwise.
+      # @see https://developer.github.com/v3/migration/source_imports/#cancel-an-import
+      #
+      # @example
+      #   @client.cancel_source_import("octokit/octokit.rb")
+      def cancel_source_import(repo, options = {})
+        options = ensure_api_media_type(:source_imports, options)
+        boolean_from_response :delete, "#{Repository.path repo}/import", options
+      end
+    end
+  end
+end

data/lib/octokit/client/stats.rb

@@ -9,8 +9,10 @@ module Octokit
       # Get contributors list with additions, deletions, and commit counts
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @option retry_timeout [Number] How long Octokit should keep trying to get stats (in seconds)
+      # @option retry_wait [Number] How long Octokit should wait between retries.
       # @return [Array<Sawyer::Resource>] Array of contributor stats
-      # @see https://developer.github.com/v3/repos/statistics/#contributors
+      # @see https://developer.github.com/v3/repos/statistics/#get-contributors-list-with-additions-deletions-and-commit-counts
       # @example Get contributor stats for octokit
       #   @client.contributors_stats('octokit/octokit.rb')
       def contributors_stats(repo, options = {})
@@ -21,9 +23,11 @@ module Octokit
       # Get the last year of commit activity data
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @option retry_timeout [Number] How long Octokit should keep trying to get stats (in seconds)
+      # @option retry_wait [Number] How long Octokit should wait between retries.
       # @return [Array<Sawyer::Resource>] The last year of commit activity grouped by
       #   week. The days array is a group of commits per day, starting on Sunday.
-      # @see https://developer.github.com/v3/repos/statistics/#commit-activity
+      # @see https://developer.github.com/v3/repos/statistics/#get-the-last-year-of-commit-activity-data
       # @example Get commit activity for octokit
       #   @client.commit_activity_stats('octokit/octokit.rb')
       def commit_activity_stats(repo, options = {})
@@ -33,9 +37,11 @@ module Octokit
       # Get the number of additions and deletions per week
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @option retry_timeout [Number] How long Octokit should keep trying to get stats (in seconds)
+      # @option retry_wait [Number] How long Octokit should wait between retries.
       # @return [Array<Sawyer::Resource>] Weekly aggregate of the number of additions
       #   and deletions pushed to a repository.
-      # @see https://developer.github.com/v3/repos/statistics/#code-frequency
+      # @see https://developer.github.com/v3/repos/statistics/#get-the-number-of-additions-and-deletions-per-week
       # @example Get code frequency stats for octokit
       #   @client.code_frequency_stats('octokit/octokit.rb')
       def code_frequency_stats(repo, options = {})
@@ -45,11 +51,13 @@ module Octokit
       # Get the weekly commit count for the repo owner and everyone else
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @option retry_timeout [Number] How long Octokit should keep trying to get stats (in seconds)
+      # @option retry_wait [Number] How long Octokit should wait between retries.
       # @return [Sawyer::Resource] Total commit counts for the owner and total commit
       #   counts in all. all is everyone combined, including the owner in the last
       #   52 weeks. If you’d like to get the commit counts for non-owners, you can
       #   subtract all from owner.
-      # @see https://developer.github.com/v3/repos/statistics/#participation
+      # @see https://developer.github.com/v3/repos/statistics/#get-the-weekly-commit-count-for-the-repository-owner-and-everyone-else
       # @example Get weekly commit counts for octokit
       #   @client.participation_stats("octokit/octokit.rb")
       def participation_stats(repo, options = {})
@@ -59,9 +67,11 @@ module Octokit
       # Get the number of commits per hour in each day
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @option retry_timeout [Number] How long Octokit should keep trying to get stats (in seconds)
+      # @option retry_wait [Number] How long Octokit should wait between retries.
       # @return [Array<Array>] Arrays containing the day number, hour number, and
       #   number of commits
-      # @see https://developer.github.com/v3/repos/statistics/#punch-card
+      # @see https://developer.github.com/v3/repos/statistics/#get-the-number-of-commits-per-hour-in-each-day
       # @example Get octokit punch card
       #   @octokit.punch_card_stats
       def punch_card_stats(repo, options = {})
@@ -75,11 +85,20 @@ module Octokit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @param metric [String] The metrics you are looking for
-      # @return [Array<Sawyer::Resource>] Magical unicorn stats
+      # @return [Array<Sawyer::Resource> or nil] Stats in metric-specific format, or nil if not yet calculated.
+      # @see https://developer.github.com/v3/repos/statistics/
       def get_stats(repo, metric, options = {})
-        data = get("#{Repository.path repo}/stats/#{metric}", options)
-
-        last_response.status == 202 ? nil : data
+        if retry_timeout = options.delete(:retry_timeout)
+          retry_wait = options.delete(:retry_wait) || 0.5
+          timeout = Time.now + retry_timeout
+        end
+        loop do
+          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
+          sleep retry_wait if retry_wait
+        end
       end
     end
   end

data/lib/octokit/configurable.rb

@@ -49,10 +49,10 @@ module Octokit
 
     attr_accessor :access_token, :auto_paginate, :client_id,
                   :client_secret, :default_media_type, :connection_options,
-                  :management_console_endpoint, :management_console_password,
                   :middleware, :netrc, :netrc_file,
                   :per_page, :proxy, :user_agent
-    attr_writer :password, :web_endpoint, :api_endpoint, :login
+    attr_writer :password, :web_endpoint, :api_endpoint, :login,
+                :management_console_endpoint, :management_console_password
 
     class << self
 

data/lib/octokit/enterprise_admin_client/orgs.rb

@@ -17,6 +17,8 @@ module Octokit
       # @example
       #   @admin_client.create_organization('SuchAGreatOrg', 'gjtorikian')
       def create_organization(login, admin, options = {})
+        options[:login] = login
+        options[:admin] = admin
         post "admin/organizations", options
       end
 

data/lib/octokit/enterprise_admin_client/users.rb

@@ -58,8 +58,8 @@ module Octokit
       # @see https://developer.github.com/v3/users/administration/#delete-a-user
       # @example
       #   @admin_client.delete_key(1)
-      def delete_user(id, options = {})
-        boolean_from_response :delete,  "admin/users/#{id}", options
+      def delete_user(username, options = {})
+        boolean_from_response :delete,  "admin/users/#{username}", options
       end
 
       # Suspend a user.

data/lib/octokit/preview.rb

@@ -6,7 +6,8 @@ module Octokit
     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
+      :licenses          => 'application/vnd.github.drax-preview+json'.freeze,
+      :source_imports    => 'application/vnd.github.barred-rock-preview'.freeze,
     }
 
     def ensure_api_media_type(type, options)

data/lib/octokit/version.rb

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

data/octokit.gemspec

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octokit
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-17 00:00:00.000000000 Z
+date: 2016-03-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -35,7 +35,7 @@ dependencies:
         version: 0.5.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -45,7 +45,7 @@ dependencies:
         version: 0.5.3
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.7.0
 description: Simple wrapper for the GitHub API
 email:
 - wynn.netherland@gmail.com
@@ -96,6 +96,7 @@ files:
 - lib/octokit/client/say.rb
 - lib/octokit/client/search.rb
 - lib/octokit/client/service_status.rb
+- lib/octokit/client/source_import.rb
 - lib/octokit/client/stats.rb
 - lib/octokit/client/statuses.rb
 - lib/octokit/client/users.rb