octokit 4.22.0 → 7.0.0

data/lib/octokit/client/commits.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 require 'date'
 
 module Octokit
   class Client
-
     # Methods for the Commits API
     #
     # @see https://developer.github.com/v3/repos/commits/
     module Commits
-
       # List commits
       #
       # @overload commits(repo, sha_or_branch, options = {})
@@ -23,12 +23,10 @@ module Octokit
       def commits(*args)
         arguments = Octokit::RepoArguments.new(args)
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          arguments.options[:sha] = sha_or_branch
-        end
+        arguments.options[:sha] = sha_or_branch if sha_or_branch
         paginate "#{Repository.new(arguments.repo).path}/commits", arguments.options
       end
-      alias :list_commits :commits
+      alias list_commits commits
 
       # Get commits after a specified date
       #
@@ -48,13 +46,11 @@ module Octokit
       #   Octokit.commits_since('octokit/octokit.rb', '2012-10-01')
       def commits_since(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date   = parse_date(arguments.shift)
+        date = parse_date(arguments.shift)
         params = arguments.options
-        params.merge!(:since => iso8601(date))
+        params.merge!(since: iso8601(date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -74,13 +70,11 @@ module Octokit
       #   Octokit.commits_before('octokit/octokit.rb', '2012-10-01')
       def commits_before(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date   = parse_date(arguments.shift)
+        date = parse_date(arguments.shift)
         params = arguments.options
-        params.merge!(:until => iso8601(date))
+        params.merge!(until: iso8601(date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -100,14 +94,12 @@ module Octokit
       #   Octokit.commits_on('octokit/octokit.rb', '2012-10-01')
       def commits_on(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date   = parse_date(arguments.shift)
+        date = parse_date(arguments.shift)
         params = arguments.options
         end_date = date + 1
-        params.merge!(:since => iso8601(date), :until => iso8601(end_date))
+        params.merge!(since: iso8601(date), until: iso8601(end_date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -129,16 +121,16 @@ module Octokit
       #   Octokit.commits_between('octokit/octokit.rb', '2012-10-01', '2012-11-01')
       def commits_between(*args)
         arguments = Octokit::RepoArguments.new(args)
-        date       = parse_date(arguments.shift)
-        end_date   = parse_date(arguments.shift)
-        raise ArgumentError, "Start date #{date} does not precede #{end_date}" if date > end_date
+        date = parse_date(arguments.shift)
+        end_date = parse_date(arguments.shift)
+        if date > end_date
+          raise ArgumentError, "Start date #{date} does not precede #{end_date}"
+        end
 
         params = arguments.options
-        params.merge!(:since => iso8601(date), :until => iso8601(end_date))
+        params.merge!(since: iso8601(date), until: iso8601(end_date))
         sha_or_branch = arguments.pop
-        if sha_or_branch
-          params[:sha] = sha_or_branch
-        end
+        params[:sha] = sha_or_branch if sha_or_branch
         commits(arguments.repo, params)
       end
 
@@ -181,8 +173,8 @@ module Octokit
       #   commit.tree.sha # => "827efc6d56897b048c772eb4087f854f46256132"
       #   commit.message # => "My commit message"
       #   commit.committer # => { "name" => "Wynn Netherland", "email" => "wynn@github.com", ... }
-      def create_commit(repo, message, tree, parents=nil, options = {})
-        params = { :message => message, :tree => tree }
+      def create_commit(repo, message, tree, parents = nil, options = {})
+        params = { message: message, tree: tree }
         params[:parents] = [parents].flatten if parents
         post "#{Repository.path repo}/git/commits", options.merge(params)
       end
@@ -213,8 +205,8 @@ module Octokit
       # @see https://developer.github.com/v3/repos/merging/#perform-a-merge
       def merge(repo, base, head, options = {})
         params = {
-          :base => base,
-          :head => head
+          base: base,
+          head: head
         }.merge(options)
         post "#{Repository.path repo}/merges", params
       end
@@ -225,7 +217,7 @@ module Octokit
         if date.respond_to?(:iso8601)
           date.iso8601
         else
-          date.strftime("%Y-%m-%dT%H:%M:%S%Z")
+          date.strftime('%Y-%m-%dT%H:%M:%S%Z')
         end
       end
 

data/lib/octokit/client/community_profile.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Community Profile API
     #
     # @see https://developer.github.com/v3/repos/community/
     module CommunityProfile
-
       # Get community profile metrics for a repository
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -14,7 +14,6 @@ module Octokit
       # @example Get community profile metrics for octokit/octokit.rb
       #   @client.community_profile('octokit/octokit.rb')
       def community_profile(repo, options = {})
-        options = ensure_api_media_type(:community_profile, options)
         get "#{Repository.path repo}/community/profile", options
       end
     end

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 = 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/dependabot_secrets.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the dependabot Secrets API
+    #
+    # @see https://docs.github.com/en/rest/dependabot/
+    module DependabotSecrets
+      # Get public key for secrets encryption
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets#get-a-repository-public-key
+      def get_dependabot_public_key(repo)
+        get "#{Repository.path repo}/dependabot/secrets/public-key"
+      end
+
+      # List secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @return [Hash] total_count and list of secrets (each item is hash with name, created_at and updated_at)
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#list-repository-secrets
+      def list_dependabot_secrets(repo)
+        paginate "#{Repository.path repo}/dependabot/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
+      # Get a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#get-a-repository-secret
+      def get_dependabot_secret(repo, name)
+        get "#{Repository.path repo}/dependabot/secrets/#{name}"
+      end
+
+      # Create or update secrets
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#create-or-update-a-repository-secret
+      def create_or_update_dependabot_secret(repo, name, options)
+        put "#{Repository.path repo}/dependabot/secrets/#{name}", options
+      end
+
+      # Delete a secret
+      #
+      # @param repo [Integer, String, Hash, Repository] A GitHub repository
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/dependabot/repository-secrets?apiVersion=2022-11-28#delete-a-repository-secret
+      def delete_dependabot_secret(repo, name)
+        boolean_from_response :delete, "#{Repository.path repo}/dependabot/secrets/#{name}"
+      end
+    end
+  end
+end

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/environments.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Environments API
+    #
+    # @see https://docs.github.com/en/rest/deployments/environments
+    module Environments
+      # Fetch a single environment for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @return <Sawyer::Resource> A single environment
+      # @see https://docs.github.com/en/rest/deployments/environments#get-an-environment
+      def environment(repo, environment_name, options = {})
+        get("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+
+      # Lists the environments for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @option options [Integer] :per_page The number of results per page (max 100). Default: 30
+      # @option options [Integer] :page Page number of the results to fetch. Default: 1
+      # @return [Sawyer::Resource] Total count of environments and list of environments
+      # @see https://docs.github.com/en/rest/deployments/environments#list-environments
+      def environments(repo, options = {})
+        get("#{Repository.path repo}/environments", options)
+      end
+      alias list_environments environments
+
+      # Create or update an environment with protection rules, such as required reviewers
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @option options [Integer] :wait_timer The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
+      # @option options [Array] :reviewers The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers.
+      # @option options [Object] :deployment_branch_policy The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
+      # @return [Sawyer::Resource] An environment
+      # @see https://docs.github.com/en/rest/deployments/environments#create-or-update-an-environment
+      def create_or_update_environment(repo, environment_name, options = {})
+        put("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+
+      # Delete an Environment
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param environment_name [String] The name of the environment
+      # @return [No Content]
+      # @see https://docs.github.com/en/rest/deployments/environments#delete-an-environment
+      def delete_environment(repo, environment_name, options = {})
+        delete("#{Repository.path repo}/environments/#{environment_name}", options)
+      end
+    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
       #
@@ -131,7 +131,6 @@ module Octokit
       # @example List all issues events for issue #38 on octokit/octokit.rb
       #   Octokit.issue_events("octokit/octokit.rb", 38)
       def issue_events(repo, number, options = {})
-        options = ensure_api_media_type(:project_card_events, options)
         paginate "#{Repository.path repo}/issues/#{number}/events", options
       end
 

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.