octokit 4.24.0 → 5.0.0

data/lib/octokit/client/contents.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 require 'base64'
 
 module Octokit
   class Client
-
     # Methods for the Repo Contents API
     #
     # @see https://developer.github.com/v3/repos/contents/
     module Contents
-
       # Receive the default Readme for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -18,7 +18,7 @@ module Octokit
       #   Octokit.readme("octokit/octokit.rb")
       # @example Get the readme file for a particular branch of the repo
       #   Octokit.readme("octokit/octokit.rb", :query => {:ref => 'some-other-branch'})
-      def readme(repo, options={})
+      def readme(repo, options = {})
         get "#{Repository.path repo}/readme", options
       end
 
@@ -33,13 +33,13 @@ module Octokit
       #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb')
       # @example Lists the contents of lib /octokit.rb on a particular branch
       #   Octokit.contents("octokit/octokit.rb", :path => 'lib/octokit.rb', :query => {:ref => 'some-other-branch'})
-      def contents(repo, options={})
+      def contents(repo, options = {})
         options = options.dup
         repo_path = options.delete :path
         url = "#{Repository.path repo}/contents/#{repo_path}"
         get url, options
       end
-      alias :content :contents
+      alias content contents
 
       # Add content to a repository
       #
@@ -59,7 +59,7 @@ module Octokit
       #                    "File content",
       #                    :branch => "my-new-feature")
       def create_contents(*args)
-        args    = args.map { |item| item && item.dup }
+        args    = args.map { |item| item&.dup }
         options = args.last.is_a?(Hash) ? args.pop : {}
         repo    = args.shift
         path    = args.shift
@@ -69,7 +69,7 @@ module Octokit
           case file
           when String
             if File.exist?(file)
-              file = File.open(file, "r")
+              file = File.open(file, 'r')
               content = file.read
               file.close
             end
@@ -78,17 +78,16 @@ module Octokit
             file.close
           end
         end
-        raise ArgumentError.new("content or :file option required") if content.nil?
-        options[:content] = Base64.respond_to?(:strict_encode64) ?
-          Base64.strict_encode64(content) :
-          Base64.encode64(content).delete("\n") # Ruby 1.9.2
+        raise ArgumentError, 'content or :file option required' if content.nil?
+
+        options[:content] = Base64.strict_encode64(content)
         options[:message] = message
         url = "#{Repository.path repo}/contents/#{path}"
         put url, options
       end
-      alias :create_content :create_contents
-      alias :add_content :create_contents
-      alias :add_contents :create_contents
+      alias create_content create_contents
+      alias add_content create_contents
+      alias add_contents create_contents
 
       # Update content in a repository
       #
@@ -116,10 +115,10 @@ module Octokit
         message = args.shift
         sha     = args.shift
         content = args.shift
-        options.merge!(:sha => sha)
+        options.merge!(sha: sha)
         create_contents(repo, path, message, content, options)
       end
-      alias :update_content :update_contents
+      alias update_content update_contents
 
       # Delete content in a repository
       #
@@ -142,9 +141,9 @@ module Octokit
         url = "#{Repository.path repo}/contents/#{path}"
         delete url, options
       end
-      alias :delete_content :delete_contents
-      alias :remove_content :delete_contents
-      alias :remove_contents :delete_contents
+      alias delete_content delete_contents
+      alias remove_content delete_contents
+      alias remove_contents delete_contents
 
       # This method will provide a URL to download a tarball or zipball archive for a repository.
       #
@@ -155,8 +154,8 @@ module Octokit
       # @see https://developer.github.com/v3/repos/contents/#get-archive-link
       # @example Get archive link for octokit/octokit.rb
       #   Octokit.archive_link("octokit/octokit.rb")
-      def archive_link(repo, options={})
-        repo_ref = ERB::Util.url_encode(options.delete :ref)
+      def archive_link(repo, options = {})
+        repo_ref = ERB::Util.url_encode(options.delete(:ref))
         format = (options.delete :format) || 'tarball'
         url = "#{Repository.path repo}/#{format}/#{repo_ref}"
 

data/lib/octokit/client/deployments.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Deployments API
     #
     # @see https://developer.github.com/v3/repos/commits/deployments/
     module Deployments
-
       # Fetch a single deployment for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A GitHub repository
@@ -24,7 +24,7 @@ module Octokit
       def deployments(repo, options = {})
         get("#{Repository.path repo}/deployments", options)
       end
-      alias :list_deployments :deployments
+      alias list_deployments deployments
 
       # Create a deployment for a ref
       #
@@ -59,10 +59,10 @@ module Octokit
       # @return [Array<Sawyer::Resource>] A list of deployment statuses
       # @see https://developer.github.com/v3/repos/deployments/#list-deployment-statuses
       def deployment_statuses(deployment_url, options = {})
-        deployment = get(deployment_url, :accept => options[:accept])
+        deployment = get(deployment_url, accept: options[:accept])
         get(deployment.rels[:statuses].href, options)
       end
-      alias :list_deployment_statuses :deployment_statuses
+      alias list_deployment_statuses deployment_statuses
 
       # Create a deployment status for a Deployment
       #
@@ -73,7 +73,7 @@ module Octokit
       # @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 = {})
-        deployment = get(deployment_url, :accept => options[:accept])
+        deployment = get(deployment_url, accept: options[:accept])
         options[:state] = state.to_s.downcase
         post(deployment.rels[:statuses].href, options)
       end

data/lib/octokit/client/downloads.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Repo Downloads API
     #
     # @see https://developer.github.com/v3/repos/downloads/
     module Downloads
-
       # List available downloads for a repository
       #
       # @param repo [Integer, String, Repository, Hash] A Github Repository
@@ -14,10 +14,10 @@ module Octokit
       # @see https://developer.github.com/v3/repos/downloads/#list-downloads-for-a-repository
       # @example List all downloads for Github/Hubot
       #   Octokit.downloads("github/hubot")
-      def downloads(repo, options={})
+      def downloads(repo, options = {})
         paginate "#{Repository.path repo}/downloads", options
       end
-      alias :list_downloads :downloads
+      alias list_downloads downloads
 
       # Get single download for a repository
       #
@@ -28,7 +28,7 @@ module Octokit
       # @see https://developer.github.com/v3/repos/downloads/#get-a-single-download
       # @example Get the "Robawt" download from Github/Hubot
       #   Octokit.download("github/hubot")
-      def download(repo, id, options={})
+      def download(repo, id, options = {})
         get "#{Repository.path repo}/downloads/#{id}", options
       end
 
@@ -44,7 +44,6 @@ module Octokit
       def delete_download(repo, id, options = {})
         boolean_from_response :delete, "#{Repository.path repo}/downloads/#{id}", options
       end
-
     end
   end
 end

data/lib/octokit/client/emojis.rb

@@ -1,9 +1,9 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Emojis API
     module Emojis
-
       # List all emojis used on GitHub
       #
       # @return [Sawyer::Resource] A list of all emojis on GitHub
@@ -11,7 +11,7 @@ module Octokit
       # @example List all emojis
       #   Octokit.emojis
       def emojis(options = {})
-        get "emojis", options
+        get 'emojis', options
       end
     end
   end

data/lib/octokit/client/events.rb

@@ -1,12 +1,12 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Method for the Events API
     #
     # @see https://developer.github.com/v3/activity/events/
     # @see https://developer.github.com/v3/issues/events/
     module Events
-
       # List all public events for GitHub
       #
       # @return [Array<Sawyer::Resource>] A list of all public events from GitHub
@@ -14,7 +14,7 @@ module Octokit
       # @example List all pubilc events
       #   Octokit.public_events
       def public_events(options = {})
-        paginate "events", options
+        paginate 'events', options
       end
 
       # List all user events
@@ -119,7 +119,7 @@ module Octokit
       def repository_issue_events(repo, options = {})
         paginate "#{Repository.path repo}/issues/events", options
       end
-      alias :repo_issue_events :repository_issue_events
+      alias repo_issue_events repository_issue_events
 
       # List events for an Issue
       #

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 "erb"
+# 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
@@ -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
@@ -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