octokit 4.21.0 → 4.25.0

data/lib/octokit/client/feeds.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Feeds API
     #
     # @see https://developer.github.com/v3/activity/feeds/
     module Feeds
-
       # List Feeds
       #
       # The feeds returned depend on authentication, see the GitHub API docs
@@ -14,7 +14,7 @@ module Octokit
       # @return [Array<Sawyer::Resource>] list of feeds
       # @see https://developer.github.com/v3/activity/feeds/#list-feeds
       def feeds
-        get "feeds"
+        get 'feeds'
       end
 
       # Get a Feed by name
@@ -24,10 +24,9 @@ module Octokit
       #   parser.
       def feed(name, options = {})
         if rel = feeds._links[name]
-          get rel.href, :accept => rel.type, :options => options
+          get rel.href, accept: rel.type, options: options
         end
       end
-
     end
   end
 end

data/lib/octokit/client/gists.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Gists API
     #
     # @see https://developer.github.com/v3/gists/
     module Gists
-
       # List gists for a user or all public gists
       #
       # @param user [String] An optional user to filter listing
@@ -15,14 +15,14 @@ module Octokit
       # @example Fetch all public gists
       #   Octokit.gists
       # @see https://developer.github.com/v3/gists/#list-gists
-      def gists(user=nil, options = {})
+      def gists(user = nil, options = {})
         if user.nil?
           paginate 'gists', options
         else
           paginate "#{User.path user}/gists", options
         end
       end
-      alias :list_gists :gists
+      alias list_gists gists
 
       # List public gists
       #
@@ -196,7 +196,7 @@ module Octokit
       # @example
       #   @client.create_gist_comment('3528645', 'This is very helpful.')
       def create_gist_comment(gist_id, comment, options = {})
-        options = options.merge({:body => comment})
+        options = options.merge({ body: comment })
         post "gists/#{gist_id}/comments", options
       end
 
@@ -212,7 +212,7 @@ module Octokit
       # @example
       #   @client.update_gist_comment('208sdaz3', '3528645', ':heart:')
       def update_gist_comment(gist_id, gist_comment_id, comment, options = {})
-        options = options.merge({:body => comment})
+        options = options.merge({ body: comment })
         patch "gists/#{gist_id}/comments/#{gist_comment_id}", options
       end
 

data/lib/octokit/client/gitignore.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Gitignore API
     #
     # @see https://developer.github.com/v3/gitignore/
     module Gitignore
-
       # Listing available gitignore templates.
       #
       # These templates can be passed option when creating a repository.
@@ -17,7 +17,7 @@ module Octokit
       # @example Git all the gitignore templates
       #   @client.gitignore_templates
       def gitignore_templates(options = {})
-        get "gitignore/templates", options
+        get 'gitignore/templates', options
       end
 
       # Get a gitignore template.

data/lib/octokit/client/hooks.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Hooks API
     module Hooks
-
       # List all Service Hooks supported by GitHub
       #
       # @return [Sawyer::Resource] A list of all hooks on GitHub
@@ -11,7 +11,7 @@ module Octokit
       # @example List all hooks
       #   Octokit.available_hooks
       def available_hooks(options = {})
-        get "hooks", options
+        get 'hooks', options
       end
 
       # List repo hooks
@@ -73,7 +73,7 @@ module Octokit
       #     }
       #   )
       def create_hook(repo, name, config, options = {})
-        options = {:name => name, :config => config, :events => ["push"], :active => true}.merge(options)
+        options = { name: name, config: config, events: ['push'], active: true }.merge(options)
         post "#{Repository.path repo}/hooks", options
       end
 
@@ -116,7 +116,7 @@ module Octokit
       #     }
       #   )
       def edit_hook(repo, id, name, config, options = {})
-        options = {:name => name, :config => config}.merge(options)
+        options = { name: name, config: config }.merge(options)
         patch "#{Repository.path repo}/hooks/#{id}", options
       end
 
@@ -158,7 +158,7 @@ module Octokit
       # @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={})
+      def ping_hook(repo, id, options = {})
         boolean_from_response :post, "#{Repository.path repo}/hooks/#{id}/pings", options
       end
 
@@ -174,7 +174,7 @@ module Octokit
       def org_hooks(org, options = {})
         paginate "#{Organization.path org}/hooks", options
       end
-      alias :list_org_hooks :org_hooks
+      alias list_org_hooks org_hooks
 
       # Get an org hook
       #
@@ -217,7 +217,7 @@ module Octokit
       #     }
       #   )
       def create_org_hook(org, config, options = {})
-        options = { :name => "web", :config => config }.merge(options)
+        options = { name: 'web', config: config }.merge(options)
         post "#{Organization.path org}/hooks", options
       end
 
@@ -250,10 +250,10 @@ module Octokit
       #     }
       #   )
       def edit_org_hook(org, id, config, options = {})
-        options = { :config => config }.merge(options)
+        options = { config: config }.merge(options)
         patch "#{Organization.path org}/hooks/#{id}", options
       end
-      alias :update_org_hook :edit_org_hook
+      alias update_org_hook edit_org_hook
 
       # Ping org hook
       #

data/lib/octokit/client/issues.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Issues API
     #
     # @see https://developer.github.com/v3/issues/
     module Issues
-
       # List issues for the authenticated user or repository
       #
       # @param repository [Integer, String, Repository, Hash] A GitHub repository.
@@ -28,10 +28,10 @@ module Octokit
       #   @client = Octokit::Client.new(:login => 'foo', :password => 'bar')
       #   @client.list_issues
       def list_issues(repository = nil, options = {})
-        path = repository ? "#{Repository.new(repository).path}/issues" : "issues"
+        path = repository ? "#{Repository.new(repository).path}/issues" : 'issues'
         paginate path, options
       end
-      alias :issues :list_issues
+      alias issues list_issues
 
       # List all issues across owned and member repositories for the authenticated user
       #
@@ -91,17 +91,17 @@ module Octokit
       def create_issue(repo, title, body = nil, options = {})
         options[:labels] = case options[:labels]
                            when String
-                             options[:labels].split(",").map(&:strip)
+                             options[:labels].split(',').map(&:strip)
                            when Array
                              options[:labels]
                            else
                              []
                            end
-        parameters = { :title => title }
+        parameters = { title: title }
         parameters[:body] = body unless body.nil?
         post "#{Repository.path repo}/issues", options.merge(parameters)
       end
-      alias :open_issue :create_issue
+      alias open_issue create_issue
 
       # Get a single issue from a repository
       #
@@ -129,7 +129,7 @@ module Octokit
       # @example Close Issue #25 from octokit/octokit.rb
       #   Octokit.close_issue("octokit/octokit.rb", "25")
       def close_issue(repo, number, options = {})
-        patch "#{Repository.path repo}/issues/#{number}", options.merge({:state => "closed"})
+        patch "#{Repository.path repo}/issues/#{number}", options.merge({ state: 'closed' })
       end
 
       # Reopen an issue
@@ -146,7 +146,7 @@ module Octokit
       # @example Reopen Issue #25 from octokit/octokit.rb
       #   Octokit.reopen_issue("octokit/octokit.rb", "25")
       def reopen_issue(repo, number, options = {})
-        patch "#{Repository.path repo}/issues/#{number}", options.merge({:state => "open"})
+        patch "#{Repository.path repo}/issues/#{number}", options.merge({ state: 'open' })
       end
 
       # Lock an issue's conversation, limiting it to collaborators
@@ -210,7 +210,7 @@ module Octokit
         arguments = Arguments.new(args)
         opts = arguments.options
 
-        if arguments.length > 0
+        unless arguments.empty?
           opts[:title] = arguments.shift
           opts[:body] = arguments.shift
         end
@@ -281,7 +281,7 @@ module Octokit
       # @example Add the comment "Almost to v1" to Issue #23 on octokit/octokit.rb
       #   Octokit.add_comment("octokit/octokit.rb", 23, "Almost to v1")
       def add_comment(repo, number, comment, options = {})
-        post "#{Repository.path repo}/issues/#{number}/comments", options.merge({:body => comment})
+        post "#{Repository.path repo}/issues/#{number}/comments", options.merge({ body: comment })
       end
 
       # Update a single comment on an issue
@@ -294,7 +294,7 @@ module Octokit
       # @example Update the comment #1194549 with body "I've started this on my 25-issue-comments-v3 fork" on an issue on octokit/octokit.rb
       #   Octokit.update_comment("octokit/octokit.rb", 1194549, "Almost to v1, added this on my fork")
       def update_comment(repo, number, comment, options = {})
-        patch "#{Repository.path repo}/issues/comments/#{number}", options.merge({:body => comment})
+        patch "#{Repository.path repo}/issues/comments/#{number}", options.merge({ body: comment })
       end
 
       # Delete a single comment
@@ -343,7 +343,7 @@ module Octokit
       # @example Add assignees "pengwynn" and "joeyw" to Issue #23 on octokit/octokit.rb
       #   Octokit.add_assignees("octokit/octokit.rb", 23, ["pengwynn", "joeyw"])
       def add_assignees(repo, number, assignees, options = {})
-        post "#{Repository.path repo}/issues/#{number}/assignees", options.merge({:assignees => assignees})
+        post "#{Repository.path repo}/issues/#{number}/assignees", options.merge({ assignees: assignees })
       end
 
       # Remove assignees from an issue
@@ -361,7 +361,7 @@ module Octokit
       #   Octokit.remove_assignees("octokit/octokit.rb", 23, ["pengwynn"],
       #     :accept => "application/vnd.github.v3+json")
       def remove_assignees(repo, number, assignees, options = {})
-        delete "#{Repository.path repo}/issues/#{number}/assignees", options.merge({:assignees => assignees})
+        delete "#{Repository.path repo}/issues/#{number}/assignees", options.merge({ assignees: assignees })
       end
     end
   end

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
@@ -28,7 +28,7 @@ module Octokit
       # @example Get the "V3 Addition" label from octokit/octokit.rb
       #   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
@@ -85,7 +85,7 @@ module Octokit
       # @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
@@ -136,7 +136,7 @@ module Octokit
       # @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
 

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
@@ -13,7 +13,7 @@ module Octokit
       #   Octokit.licenses
       def licenses(options = {})
         options = ensure_api_media_type(:licenses, options)
-        paginate "licenses", options
+        paginate 'licenses', options
       end
 
       # List an individual license

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

@@ -1,11 +1,11 @@
+# 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
@@ -14,7 +14,7 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] A list of plans
       def list_plans(options = {})
-        paginate "/marketplace_listing/plans", options
+        paginate '/marketplace_listing/plans', options
       end
 
       # List all GitHub accounts on a specific plan
@@ -49,7 +49,7 @@ module Octokit
       #
       # @return [Array<Sawyer::Resource>] A list of Marketplace purchases
       def marketplace_purchases(options = {})
-        get "/user/marketplace_purchases", options
+        get '/user/marketplace_purchases', options
       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
       #

data/lib/octokit/client/oauth_applications.rb

@@ -2,12 +2,10 @@
 
 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.

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