octokit 4.6.2 → 5.2.0

data/lib/octokit/client/labels.rb

@@ -1,13 +1,13 @@
-require 'cgi'
+# frozen_string_literal: true
+
+require 'erb'
 
 module Octokit
   class Client
-
     # Methods for the Issue Labels API
     #
     # @see https://developer.github.com/v3/issues/labels/
     module Labels
-
       # List available labels for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -26,9 +26,9 @@ module Octokit
       # @return [Sawyer::Resource] A single label from the repository
       # @see https://developer.github.com/v3/issues/labels/#get-a-single-label
       # @example Get the "V3 Addition" label from octokit/octokit.rb
-      #   Octokit.labels("octokit/octokit.rb", "V3 Addition")
+      #   Octokit.label("octokit/octokit.rb", "V3 Addition")
       def label(repo, name, options = {})
-        get "#{Repository.path repo}/labels/#{name}", options
+        get "#{Repository.path repo}/labels/#{ERB::Util.url_encode(name)}", options
       end
 
       # Add a label to a repository
@@ -40,8 +40,8 @@ module Octokit
       # @see https://developer.github.com/v3/issues/labels/#create-a-label
       # @example Add a new label "Version 1.0" with color "#cccccc"
       #   Octokit.add_label("octokit/octokit.rb", "Version 1.0", "cccccc")
-      def add_label(repo, label, color="ffffff", options = {})
-        post "#{Repository.path repo}/labels", options.merge({:name => label, :color => color})
+      def add_label(repo, label, color = 'ffffff', options = {})
+        post "#{Repository.path repo}/labels", options.merge({ name: label, color: color })
       end
 
       # Update a label
@@ -56,7 +56,7 @@ module Octokit
       # @example Update the label "Version 1.0" with new color "#cceeaa"
       #   Octokit.update_label("octokit/octokit.rb", "Version 1.0", {:color => "cceeaa"})
       def update_label(repo, label, options = {})
-        patch "#{Repository.path repo}/labels/#{label}", options
+        patch "#{Repository.path repo}/labels/#{ERB::Util.url_encode(label)}", options
       end
 
       # Delete a label from a repository.
@@ -70,7 +70,7 @@ module Octokit
       # @example Delete the label "Version 1.0" from the repository.
       #   Octokit.delete_label!("octokit/octokit.rb", "Version 1.0")
       def delete_label!(repo, label, options = {})
-        boolean_from_response :delete, "#{Repository.path repo}/labels/#{label}", options
+        boolean_from_response :delete, "#{Repository.path repo}/labels/#{ERB::Util.url_encode(label)}", options
       end
 
       # Remove a label from an Issue
@@ -78,14 +78,14 @@ 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
       # @example Remove the label "Version 1.0" from the repository.
       #   Octokit.remove_label("octokit/octokit.rb", 23, "Version 1.0")
       def remove_label(repo, number, label, options = {})
-        delete "#{Repository.path repo}/issues/#{number}/labels/#{label}", options
+        delete "#{Repository.path repo}/issues/#{number}/labels/#{ERB::Util.url_encode(label)}", options
       end
 
       # Remove all 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,20 +130,20 @@ 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
       # @example Replace labels for octokit/octokit.rb Issue #10
       #   Octokit.replace_all_labels("octokit/octokit.rb", 10, ['V3 Transition', 'Improvement'])
-      def replace_all_labels(repo, number, labels, options = {})
+      def replace_all_labels(repo, number, labels, _options = {})
         put "#{Repository.path repo}/issues/#{number}/labels", labels
       end
 
       # 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/legacy_search.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Legacy Search API
     #
     # @see https://developer.github.com/v3/search/
     module LegacySearch
-
       # Legacy repository search
       #
       # @see https://developer.github.com/v3/search/#search-repositories
@@ -23,7 +23,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] A list of issues matching the search term and state
       # @example Search for 'test' in the open issues for sferik/rails_admin
       #   Octokit.search_issues("sferik/rails_admin", 'test', 'open')
-      def legacy_search_issues(repo, search_term, state='open', options = {})
+      def legacy_search_issues(repo, search_term, state = 'open', options = {})
         get("legacy/issues/search/#{Repository.new(repo)}/#{state}/#{search_term}", options)['issues']
       end
 

data/lib/octokit/client/licenses.rb

@@ -1,10 +1,10 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for licenses API
     #
     module Licenses
-
       # List all licenses
       #
       # @see https://developer.github.com/v3/licenses/#list-all-licenses
@@ -12,8 +12,7 @@ module Octokit
       # @example
       #   Octokit.licenses
       def licenses(options = {})
-        options = ensure_api_media_type(:licenses, options)
-        paginate "licenses", options
+        paginate 'licenses', options
       end
 
       # List an individual license
@@ -24,7 +23,6 @@ module Octokit
       # @example
       #   Octokit.license 'mit'
       def license(license_name, options = {})
-        options = ensure_api_media_type(:licenses, options)
         get "licenses/#{license_name}", options
       end
 
@@ -35,9 +33,8 @@ module Octokit
       # @option options [String] :ref name of the Commit/Branch/Tag. Defaults to 'master'.
       # @return [Sawyer::Resource] The detail of the license file
       # @example
-      #   Octokit.license_contents 'benbalter/licensee'
+      #   Octokit.repository_license_contents 'benbalter/licensee'
       def repository_license_contents(repo, options = {})
-        options = ensure_api_media_type(:licenses, options)
         get "#{Repository.path repo}/license", options
       end
     end

data/lib/octokit/client/markdown.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Markdown API
     #
     # @see https://developer.github.com/v3/markdown/
     module Markdown
-
       # Render an arbitrary Markdown document
       #
       # @param text [String] Markdown source
@@ -20,7 +20,7 @@ module Octokit
         options[:repo] = Repository.new(options[:repo]) if options[:repo]
         options[:accept] = 'application/vnd.github.raw'
 
-        post "markdown", options
+        post 'markdown', options
       end
     end
   end

data/lib/octokit/client/marketplace.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Marketplace Listing API
+    #
+    # @see https://developer.github.com/v3/apps/marketplace/
+    module Marketplace
+      # List all plans for an app's marketplace listing
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/marketplace/#list-all-plans-for-your-marketplace-listing
+      #
+      # @return [Array<Sawyer::Resource>] A list of plans
+      def list_plans(options = {})
+        paginate '/marketplace_listing/plans', options
+      end
+
+      # List all GitHub accounts on a specific plan
+      #
+      # @param plan_id [Integer] The id of the GitHub plan
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/marketplace/#list-all-github-accounts-user-or-organization-on-a-specific-plan
+      #
+      # @return [Array<Sawyer::Resource>] A list of accounts
+      def list_accounts_for_plan(plan_id, options = {})
+        paginate "/marketplace_listing/plans/#{plan_id}/accounts", options
+      end
+
+      # Get the plan associated with a given GitHub account
+      #
+      # @param account_id [Integer] The id of the GitHub account
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/marketplace/#check-if-a-github-account-is-associated-with-any-marketplace-listing
+      #
+      # @return <Sawyer::Resource> Account with plan details, or nil
+      def plan_for_account(account_id, options = {})
+        get "/marketplace_listing/accounts/#{account_id}", options
+      end
+
+      # Get user's Marketplace purchases
+      #
+      # @param options [Hash] A customizable set of options
+      #
+      # @see https://developer.github.com/v3/apps/marketplace/#get-a-users-marketplace-purchases
+      #
+      # @return [Array<Sawyer::Resource>] A list of Marketplace purchases
+      def marketplace_purchases(options = {})
+        get '/user/marketplace_purchases', options
+      end
+    end
+  end
+end

data/lib/octokit/client/meta.rb

@@ -1,21 +1,20 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Meta API
     #
     # @see https://developer.github.com/v3/meta/
     module Meta
-
       # Get meta information about GitHub.com, the service.
       # @see https://developer.github.com/v3/meta/#meta
       # @return [Sawyer::Resource] Hash with meta information.
       # @example Get GitHub meta information
       #   @client.github_meta
       def meta(options = {})
-        get "meta", options
+        get 'meta', options
       end
-      alias :github_meta :meta
-
+      alias github_meta meta
     end
   end
 end

data/lib/octokit/client/milestones.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Issues Milestones API
     #
     # @see https://developer.github.com/v3/issues/milestones/
     module Milestones
-
       # List milestones for a repository
       #
       # @param repository [Integer, String, Repository, Hash] A GitHub repository
@@ -21,7 +21,7 @@ module Octokit
       def list_milestones(repository, options = {})
         paginate "#{Repository.path repository}/milestones", options
       end
-      alias :milestones :list_milestones
+      alias milestones list_milestones
 
       # Get a single milestone for a repository
       #
@@ -49,7 +49,7 @@ module Octokit
       # @example Create a milestone for a repository
       #   Octokit.create_milestone("octokit/octokit.rb", "0.7.0", {:description => 'Add support for v3 of Github API'})
       def create_milestone(repository, title, options = {})
-        post "#{Repository.path repository}/milestones", options.merge({:title => title})
+        post "#{Repository.path repository}/milestones", options.merge({ title: title })
       end
 
       # Update a milestone for a repository
@@ -68,7 +68,7 @@ module Octokit
       def update_milestone(repository, number, options = {})
         patch "#{Repository.path repository}/milestones/#{number}", options
       end
-      alias :edit_milestone :update_milestone
+      alias edit_milestone update_milestone
 
       # Delete a single milestone for a repository
       #

data/lib/octokit/client/notifications.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Notifications API
     #
     # @see https://developer.github.com/v3/activity/notifications/
     module Notifications
-
       # List your notifications
       #
       # @param options [Hash] Optional parameters
@@ -24,7 +24,7 @@ module Octokit
       # @example Get all notifications since a certain time.
       #   @client.notifications({all: true, since: '2012-10-09T23:39:01Z'})
       def notifications(options = {})
-        paginate "notifications", options
+        paginate 'notifications', options
       end
 
       # List your notifications in a repository
@@ -48,7 +48,7 @@ module Octokit
       def repository_notifications(repo, options = {})
         paginate "#{Repository.path repo}/notifications", options
       end
-      alias :repo_notifications :repository_notifications
+      alias repo_notifications repository_notifications
 
       # Mark notifications as read
       #
@@ -66,7 +66,7 @@ module Octokit
       # @example
       #   @client.mark_notifications_as_read
       def mark_notifications_as_read(options = {})
-        request :put, "notifications", options
+        request :put, 'notifications', options
 
         last_response.status == 205
       end
@@ -91,7 +91,7 @@ module Octokit
 
         last_response.status == 205
       end
-      alias :mark_repo_notifications_as_read :mark_repository_notifications_as_read
+      alias mark_repo_notifications_as_read mark_repository_notifications_as_read
 
       # List notifications for a specific thread
       #
@@ -108,10 +108,6 @@ module Octokit
       # Mark thread as read
       #
       # @param thread_id [Integer] Id of the thread to update.
-      # @param options [Hash] Optional parameters.
-      # @option options [Boolean] :unread Changes the unread status of the
-      #   threads.
-      # @option options [Boolean] :read Inverse of 'unread'.
       # @return [Boolean] True if updated, false otherwise.
       # @see https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read
       # @example

data/lib/octokit/client/oauth_applications.rb

@@ -0,0 +1,116 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the OauthApplications API
+    #
+    # @see https://developer.github.com/v3/apps/oauth_applications
+    module OauthApplications
+      # Check if a token is valid.
+      #
+      # Applications can check if a token is valid without rate limits.
+      #
+      # @param access_token [String] 40 character GitHub OAuth access token
+      #
+      # @return [Sawyer::Resource] A single authorization for the authenticated user
+      # @see https://developer.github.com/v3/apps/oauth_applications/#check-a-token
+      #
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.check_token('deadbeef1234567890deadbeef987654321')
+      def check_token(access_token, options = {})
+        options[:access_token] = access_token
+
+        key    = options.delete(:client_id)     || client_id
+        secret = options.delete(:client_secret) || client_secret
+
+        as_app(key, secret) do |app_client|
+          app_client.post "applications/#{client_id}/token", options
+        end
+      end
+      alias check_application_authorization check_token
+
+      # Reset a token
+      #
+      # Applications can reset a token without requiring a user to re-authorize.
+      #
+      # @param access_token [String] 40 character GitHub OAuth access token
+      #
+      # @return [Sawyer::Resource] A single authorization for the authenticated user
+      # @see https://developer.github.com/v3/apps/oauth_applications/#reset-a-token
+      #
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.reset_token('deadbeef1234567890deadbeef987654321')
+      def reset_token(access_token, options = {})
+        options[:access_token] = access_token
+
+        key    = options.delete(:client_id)     || client_id
+        secret = options.delete(:client_secret) || client_secret
+
+        as_app(key, secret) do |app_client|
+          app_client.patch "applications/#{client_id}/token", options
+        end
+      end
+      alias reset_application_authorization reset_token
+
+      # Delete an app token
+      #
+      # Applications can revoke (delete) a token
+      #
+      # @param access_token [String] 40 character GitHub OAuth access token
+      #
+      # @return [Boolean] Result
+      # @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-token
+      #
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.delete_token('deadbeef1234567890deadbeef987654321')
+      def delete_app_token(access_token, options = {})
+        options[:access_token] = access_token
+
+        key    = options.delete(:client_id)     || client_id
+        secret = options.delete(:client_secret) || client_secret
+
+        begin
+          as_app(key, secret) do |app_client|
+            app_client.delete "applications/#{client_id}/token", options
+            app_client.last_response.status == 204
+          end
+        rescue Octokit::NotFound
+          false
+        end
+      end
+      alias delete_application_authorization delete_app_token
+      alias revoke_application_authorization delete_app_token
+
+      # Delete an app authorization
+      #
+      # OAuth application owners can revoke a grant for their OAuth application and a specific user.
+      #
+      # @param access_token [String] 40 character GitHub OAuth access token
+      #
+      # @return [Boolean] Result
+      # @see https://developer.github.com/v3/apps/oauth_applications/#delete-an-app-token
+      #
+      # @example
+      #  client = Octokit::Client.new(:client_id => 'abcdefg12345', :client_secret => 'secret')
+      #  client.delete_app_authorization('deadbeef1234567890deadbeef987654321')
+      def delete_app_authorization(access_token, options = {})
+        options[:access_token] = access_token
+
+        key    = options.delete(:client_id)     || client_id
+        secret = options.delete(:client_secret) || client_secret
+
+        begin
+          as_app(key, secret) do |app_client|
+            app_client.delete "applications/#{client_id}/grant", options
+            app_client.last_response.status == 204
+          end
+        rescue Octokit::NotFound
+          false
+        end
+      end
+    end
+  end
+end

data/lib/octokit/client/objects.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Git Data API
     #
     # @see https://developer.github.com/v3/git/
     module Objects
-
       # Get a single tree, fetching information about its root-level objects
       #
       # Pass <tt>:recursive => true</tt> in <tt>options</tt> to fetch information about all of the tree's objects, including those in subdirectories.
@@ -38,7 +38,7 @@ module Octokit
       #   tree.sha # => "cd8274d15fa3ae2ab983129fb037999f264ba9a7"
       #   tree.tree.first.path # => "file.rb"
       def create_tree(repo, tree, options = {})
-        parameters = { :tree => tree }
+        parameters = { tree: tree }
         post "#{Repository.path repo}/git/trees", options.merge(parameters)
       end
 
@@ -74,10 +74,10 @@ module Octokit
       # @example Create a blob containing <tt>foo bar baz</tt>, encoded using base64
       #   require "base64"
       #   Octokit.create_blob("octocat/Hello-World", Base64.encode64("foo bar baz"), "base64")
-      def create_blob(repo, content, encoding="utf-8", options = {})
+      def create_blob(repo, content, encoding = 'utf-8', options = {})
         parameters = {
-          :content => content,
-          :encoding => encoding
+          content: content,
+          encoding: encoding
         }
         blob = post "#{Repository.path repo}/git/blobs", options.merge(parameters)
 
@@ -124,14 +124,14 @@ module Octokit
       #   )
       def create_tag(repo, tag, message, object_sha, type, tagger_name, tagger_email, tagger_date, options = {})
         options.merge!(
-          :tag => tag,
-          :message => message,
-          :object => object_sha,
-          :type => type,
-          :tagger => {
-            :name => tagger_name,
-            :email => tagger_email,
-            :date => tagger_date
+          tag: tag,
+          message: message,
+          object: object_sha,
+          type: type,
+          tagger: {
+            name: tagger_name,
+            email: tagger_email,
+            date: tagger_date
           }
         )
         post "#{Repository.path repo}/git/tags", options