octokit 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db13043bdffc8bb386b79815c7fcaa147f70119a
-  data.tar.gz: a41b685e73c8c4b0e9034f2bab9f73ced1a9240a
+  metadata.gz: 42f87b8ae5be0908f5ebf3ea440b326dfeb90a67
+  data.tar.gz: c81981cf6ef79e3e12a1af37100ce931b3a5ecbe
 SHA512:
-  metadata.gz: b0db38b08765e340731f8707ca33df7ee8f4da773618f95fadde065bc12fe1bd5d9f30cd8be7a3001e6c4cef03ead63e572f5ef8cb6ca53416214ff877e9182f
-  data.tar.gz: a6cebf076f7faf4ae57e79bf3f3ef833dbdb3280a86df6d3af90d5fb877c0e8dd13a8fdab9da387db3fdcd2d931fbdfc4f4d988e118eb0c825a98370e87286ef
+  metadata.gz: 3b0c8b13dcad559baeaed2e3ffd5eeba73755baaeca30cc0b36514d9050fc3a6f7f6d8638465cb7b1e0bc3c6807c08cba6760eb3ff0bb8453781557ab9d7b42a
+  data.tar.gz: 4d3967580680dddd45f89fd64c327512ce90f64829070c82070e9dae2109308772f1879b8b5ea1c952b10b63313656b3d9a625aa156b7fec7c6c41354b1ab903

data/README.md

@@ -33,7 +33,7 @@ Install via Rubygems
 
 ... or add to your Gemfile
 
-    gem "octokit", "~> 3.0"
+    gem "octokit", "~> 4.0"
 
 ### Making requests
 

data/lib/octokit/client.rb

@@ -9,6 +9,7 @@ require 'octokit/rate_limit'
 require 'octokit/repository'
 require 'octokit/user'
 require 'octokit/organization'
+require 'octokit/preview'
 require 'octokit/client/authorizations'
 require 'octokit/client/commits'
 require 'octokit/client/commit_comments'
@@ -55,6 +56,7 @@ module Octokit
     include Octokit::Authentication
     include Octokit::Configurable
     include Octokit::Connection
+    include Octokit::Preview
     include Octokit::Warnable
     include Octokit::Client::Authorizations
     include Octokit::Client::Commits
@@ -188,5 +190,23 @@ module Octokit
       reset_agent
       @client_secret = value
     end
+
+    def client_without_redirects(options = {})
+      conn_opts = @connection_options
+      conn_opts[:url] = @api_endpoint
+      conn_opts[:builder] = @middleware.dup if @middleware
+      conn_opts[:proxy] = @proxy if @proxy
+      conn = Faraday.new(conn_opts) do |http|
+        if basic_authenticated?
+          http.basic_auth(@login, @password)
+        elsif token_authenticated?
+          http.authorization 'token', @access_token
+        end
+        http.headers['accept'] = options[:accept] if options.key?(:accept)
+      end
+      conn.builder.delete(Octokit::Middleware::FollowRedirects)
+
+      conn
+    end
   end
 end

data/lib/octokit/client/contents.rb

@@ -154,20 +154,7 @@ module Octokit
         format = (options.delete :format) || 'tarball'
         url = "#{Repository.path repo}/#{format}/#{repo_ref}"
 
-        conn_opts = @connection_options
-        conn_opts[:url] = @api_endpoint
-        conn_opts[:builder] = @middleware.dup if @middleware
-        conn_opts[:proxy] = @proxy if @proxy
-        conn = Faraday.new(conn_opts) do |http|
-          if basic_authenticated?
-            http.basic_auth(@login, @password)
-          elsif token_authenticated?
-            http.authorization 'token', @access_token
-          end
-        end
-        conn.builder.delete(Octokit::Middleware::FollowRedirects)
-        response = conn.head(url, options)
-
+        response = client_without_redirects.head(url, options)
         response.headers['Location']
       end
     end

data/lib/octokit/client/issues.rb

@@ -11,7 +11,7 @@ module Octokit
       # @param repository [Integer, String, Repository, Hash] A GitHub repository.
       # @param options [Sawyer::Resource] A customizable set of options.
       # @option options [Integer] :milestone Milestone number.
-      # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
+      # @option options [String] :state (open) State: <tt>open</tt>, <tt>closed</tt>, or <tt>all</tt>.
       # @option options [String] :assignee User login.
       # @option options [String] :creator User login.
       # @option options [String] :mentioned User login.
@@ -37,7 +37,7 @@ module Octokit
       #
       # @param options [Sawyer::Resource] A customizable set of options.
       # @option options [String] :filter (assigned) State: <tt>assigned</tt>, <tt>created</tt>, <tt>mentioned</tt>, <tt>subscribed</tt> or <tt>closed</tt>.
-      # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
+      # @option options [String] :state (open) State: <tt>open</tt>, <tt>closed</tt>, or <tt>all</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>.
@@ -58,7 +58,7 @@ module Octokit
       # @param org [String, Integer] Organization GitHub login or id.
       # @param options [Sawyer::Resource] A customizable set of options.
       # @option options [String] :filter (assigned) State: <tt>assigned</tt>, <tt>created</tt>, <tt>mentioned</tt>, <tt>subscribed</tt> or <tt>closed</tt>.
-      # @option options [String] :state (open) State: <tt>open</tt> or <tt>closed</tt>.
+      # @option options [String] :state (open) State: <tt>open</tt>, <tt>closed</tt>, or <tt>all</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>.

data/lib/octokit/client/licenses.rb

@@ -5,8 +5,6 @@ module Octokit
     #
     module Licenses
 
-      LICENSES_PREVIEW_MEDIA_TYPE = "application/vnd.github.drax-preview+json".freeze
-
       # List all licenses
       #
       # @see https://developer.github.com/v3/licenses/#list-all-licenses
@@ -14,7 +12,7 @@ module Octokit
       # @example
       #   Octokit.licenses
       def licenses(options = {})
-        options = ensure_license_api_media_type(options)
+        options = ensure_api_media_type(:licenses, options)
         paginate "licenses", options
       end
 
@@ -26,25 +24,9 @@ module Octokit
       # @example
       #   Octokit.license 'mit'
       def license(license_name, options = {})
-        options = ensure_license_api_media_type(options)
+        options = ensure_api_media_type(:licenses, options)
         get "licenses/#{license_name}", options
       end
-
-      def ensure_license_api_media_type(options = {})
-        if options[:accept].nil?
-          options[:accept] = LICENSES_PREVIEW_MEDIA_TYPE
-          warn_license_preview
-        end
-        options
-      end
-
-      def warn_license_preview
-        warn <<-EOS
-WARNING: The preview version of the License API is not yet suitable for production use.
-You can avoid this message by supplying an appropriate media type in the 'Accept' request
-header. 
-EOS
-      end  
     end
   end
 end

data/lib/octokit/client/milestones.rb

@@ -11,7 +11,7 @@ module Octokit
       # @param repository [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> or <tt>closed</tt>.
+      # @option options [String] :state (open) State: <tt>open</tt>, <tt>closed</tt>, or <tt>all</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>.
       # @return [Array<Sawyer::Resource>] A list of milestones for a repository.
@@ -28,9 +28,6 @@ module Octokit
       # @param repository [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> or <tt>closed</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>.
       # @return [Sawyer::Resource] A single milestone from a repository.
       # @see https://developer.github.com/v3/issues/milestones/#get-a-single-milestone
       # @example Get a single milestone for a repository

data/lib/octokit/client/organizations.rb

@@ -595,6 +595,87 @@ module Octokit
         user = options.delete(:user)
         user && boolean_from_response(:delete, "orgs/#{org}/memberships/#{user}", options)
       end
+
+      # Initiates the generation of a migration archive.
+      #
+      # Requires authenticated organization owner.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @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)
+        post "orgs/#{org}/migrations", options
+      end
+
+      # Lists the most recent migrations.
+      #
+      # Requires authenticated organization owner.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @return [Array<Sawyer::Resource>] Array of migration resources.
+      # @see https://developer.github.com/v3/orgs/migrations/#get-a-list-of-migrations
+      def migrations(org, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        paginate "orgs/#{org}/migrations", options
+      end
+
+      # Fetches the status of a migration.
+      #
+      # Requires authenticated organization owner.
+      #
+      # @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
+      def migration_status(org, id, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        get "orgs/#{org}/migrations/#{id}", options
+      end
+
+      # Fetches the URL to a migration archive.
+      #
+      # Requires authenticated organization owner.
+      #
+      # @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/#download-a-migration-archive
+      def migration_archive_url(org, id, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        url = "orgs/#{org}/migrations/#{id}/archive"
+
+        response = client_without_redirects(options).get(url)
+        response.headers['location']
+      end
+
+      # Deletes a previous migration archive.
+      #
+      # Requires authenticated organization owner.
+      #
+      # @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
+      def delete_migration_archive(org, id, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        delete "orgs/#{org}/migrations/#{id}/archive", options
+      end
+
+      # Unlock a previous migration archive.
+      #
+      # Requires authenticated organization owner.
+      #
+      # @param org [String, Integer] Organization GitHub login or id.
+      # @param id [Integer] ID number of the migration.
+      # @param repo [String] Name of the repository.
+      # @see https://developer.github.com/v3/orgs/migrations/#unlock-a-repository
+      def unlock_repository(org, id, repo, options = {})
+        options = ensure_api_media_type(:migrations, options)
+        delete "orgs/#{org}/migrations/#{id}/repos/#{repo}/lock", options
+      end
     end
   end
 end

data/lib/octokit/client/stats.rb

@@ -23,7 +23,7 @@ module Octokit
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
       # @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/#get-the-last-year-of-commit-activity-data
+      # @see https://developer.github.com/v3/repos/statistics/#commit-activity
       # @example Get commit activity for octokit
       #   @client.commit_activity_stats('octokit/octokit.rb')
       def commit_activity_stats(repo, options = {})

data/lib/octokit/enterprise_admin_client.rb

@@ -3,6 +3,7 @@ require 'octokit/configurable'
 require 'octokit/warnable'
 require 'octokit/enterprise_admin_client/admin_stats'
 require 'octokit/enterprise_admin_client/license'
+require 'octokit/enterprise_admin_client/orgs'
 require 'octokit/enterprise_admin_client/search_indexing'
 require 'octokit/enterprise_admin_client/users'
 
@@ -22,6 +23,7 @@ module Octokit
     include Octokit::Warnable
     include Octokit::EnterpriseAdminClient::AdminStats
     include Octokit::EnterpriseAdminClient::License
+    include Octokit::EnterpriseAdminClient::Orgs
     include Octokit::EnterpriseAdminClient::SearchIndexing
     include Octokit::EnterpriseAdminClient::Users
 

data/lib/octokit/enterprise_admin_client/orgs.rb

@@ -0,0 +1,25 @@
+module Octokit
+  class EnterpriseAdminClient
+
+    # Methods for the Enterprise Orgs API
+    #
+    # @see https://developer.github.com/v3/enterprise/orgs/
+    module Orgs
+
+      # Create a new organization on the instance.
+      #
+      # @param login [String] The organization's username.
+      # @param admin [String] The login of the user who will manage this organization.
+      # @param options [Hash] A set of options.
+      # @option options [String] :profile_name The organization's display name.
+      # @return [nil]
+      # @see https://developer.github.com/v3/enterprise/orgs/#create-an-organization
+      # @example
+      #   @admin_client.create_organization('SuchAGreatOrg', 'gjtorikian')
+      def create_organization(login, admin, options = {})
+        post "admin/organizations", options
+      end
+
+    end
+  end
+end

data/lib/octokit/enterprise_admin_client/users.rb

@@ -5,6 +5,19 @@ module Octokit
     #
     # @see https://developer.github.com/v3/users/administration/
     module Users
+      # Create a new user.
+      #
+      # @param login [String] The user's username.
+      # @param email [String] The user's email address.
+      # @see https://developer.github.com/v3/users/administration/#create-a-new-user
+      # @example
+      #   @admin_client.create_user('foobar', 'notreal@foo.bar')
+      def create_user(login, email, options = {})
+        options[:login] = login
+        options[:email] = email
+        post "admin/users", options
+      end
+
       # Promote an ordinary user to a site administrator
       #
       # @param user [String] Username of the user to promote.
@@ -27,6 +40,18 @@ module Octokit
         boolean_from_response :delete, "users/#{user}/site_admin", options
       end
 
+      # Rename a user.
+      #
+      # @param old_login [String] The user's old username.
+      # @param new_login [String] The user's new username.
+      # @see https://developer.github.com/v3/users/administration/#rename-an-existing-user
+      # @example
+      #   @admin_client.rename_user('foobar', 'foofoobar')
+      def rename_user(old_login, new_login, options = {})
+        options[:login] = new_login
+        patch "admin/users/#{old_login}", options
+      end
+
       # Suspend a user.
       #
       # @param user [String] Username of the user to suspend.
@@ -48,6 +73,46 @@ module Octokit
       def unsuspend(user, options = {})
         boolean_from_response :delete, "users/#{user}/suspended", options
       end
+
+      # Creates an impersonation OAuth token.
+      #
+      # @param login [String] The user to create a token for.
+      # @param options [Array<String>] :scopes The scopes to apply.
+      # @see https://developer.github.com/v3/users/administration/#create-an-impersonation-oauth-token
+      # @example
+      #   @admin_client.create_impersonation_token('foobar', {:scopes => ['repo:write']})
+      def create_impersonation_token(login, options = {})
+        post "admin/users/#{login}/authorizations", options
+      end
+
+      # Deletes an impersonation OAuth token.
+      #
+      # @param login [String] The user whose token should be deleted.
+      # @see https://developer.github.com/v3/users/administration/#delete-an-impersonation-oauth-token
+      # @example
+      #   @admin_client.delete_impersonation_token('foobar')
+      def delete_impersonation_token(login, options = {})
+        boolean_from_response :delete, "admin/users/#{login}/authorizations", options
+      end
+
+      # Lists all the public SSH keys.
+      #
+      # @see https://developer.github.com/v3/users/administration/#list-all-public-keys
+      # @example
+      #   @admin_client.list_all_keys
+      def list_all_keys(options = {})
+        get "admin/keys", options
+      end
+
+      # Deletes a public SSH keys.
+      #
+      # @param [id] Number The ID of the key to delete.
+      # @see https://developer.github.com/v3/users/administration/#delete-a-public-key
+      # @example
+      #   @admin_client.delete_key(1)
+      def delete_key(id, options = {})
+        boolean_from_response :delete,  "admin/keys/#{id}", options
+      end
     end
   end
 end

data/lib/octokit/preview.rb

@@ -0,0 +1,27 @@
+module Octokit
+
+  # Default setup options for preview features
+  module Preview
+
+    PREVIEW_TYPES = {
+      :migrations    => 'application/vnd.github.wyandotte-preview+json'.freeze,
+      :licenses      => 'application/vnd.github.drax-preview+json'.freeze
+    }
+
+    def ensure_api_media_type(type, options)
+      if options[:accept].nil?
+        options[:accept] = PREVIEW_TYPES[type]
+        warn_preview(:migrations)
+      end
+      options
+    end
+
+    def warn_preview(type)
+      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.
+EOS
+    end
+  end
+end

data/lib/octokit/version.rb

@@ -5,11 +5,11 @@ module Octokit
 
   # Current minor release.
   # @return [Integer]
-  MINOR = 0
+  MINOR = 1
 
   # Current patch level.
   # @return [Integer]
-  PATCH = 1
+  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.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Wynn Netherland
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-29 00:00:00.000000000 Z
+date: 2015-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -105,6 +105,7 @@ files:
 - lib/octokit/enterprise_admin_client.rb
 - lib/octokit/enterprise_admin_client/admin_stats.rb
 - lib/octokit/enterprise_admin_client/license.rb
+- lib/octokit/enterprise_admin_client/orgs.rb
 - lib/octokit/enterprise_admin_client/search_indexing.rb
 - lib/octokit/enterprise_admin_client/users.rb
 - lib/octokit/enterprise_management_console_client.rb
@@ -113,6 +114,7 @@ files:
 - lib/octokit/gist.rb
 - lib/octokit/middleware/follow_redirects.rb
 - lib/octokit/organization.rb
+- lib/octokit/preview.rb
 - lib/octokit/rate_limit.rb
 - lib/octokit/repo_arguments.rb
 - lib/octokit/repository.rb