octokit 4.22.0 → 9.2.0

data/lib/octokit/client/code_scanning.rb

@@ -0,0 +1,190 @@
+# frozen_string_literal: true
+
+require 'tempfile'
+require 'zlib'
+
+module Octokit
+  class Client
+    # Methods for the code scanning alerts API
+    #
+    # @see https://docs.github.com/rest/code-scanning
+    module CodeScanning
+      # Updates a code scanning default setup configuration
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param state [String] The desired state of code scanning default setup
+      # @param query_suite [String] CodeQL query suite to be used
+      # @param languages [Array] List of CodeQL languages to be analyzed
+      #
+      # @return [Sawyer::Resource] Action Run information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
+      def update_code_scanning_default_config(repo, state, query_suite = nil, languages = nil, options = {})
+        options[:state] = state
+        options[:query_suite] = query_suite if query_suite
+        options[:languages] = languages if languages
+
+        patch "#{Repository.path repo}/code-scanning/default-setup", options
+      end
+
+      # Get Code Scanning Default Configuration
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #
+      # @return [Sawyer::Resource] CodeQl Default Setup Configuration Information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-default-setup-configuration
+      def get_code_scanning_default_config(repo, options = {})
+        get "#{Repository.path repo}/code-scanning/default-setup", options
+      end
+
+      # Gets a CodeQL database for a language in a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param language [String]
+      #
+      # @return [Sawyer::Resource] CodeQl Default Setup Configuration Information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-codeql-database-for-a-repository
+      def get_codeql_database_for_repo(repo, language, options = {})
+        get "#{Repository.path repo}/code-scanning/codeql/databases/#{language}", options
+      end
+
+      # Lists the CodeQL databases that are available in a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #
+      # @return [Array] List of CodeQL Databases
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-codeql-databases-for-a-repository
+      def list_codeql_database_for_repo(repo, options = {})
+        get "#{Repository.path repo}/code-scanning/codeql/databases", options
+      end
+
+      # Delete a specified code scanning analysis from a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param analysis_id [Integer] ID of the code scanning analysis
+      #
+      # @return [Sawyer::Resource] Next Code Scanning Analysis Information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#delete-a-code-scanning-analysis-from-a-repository
+      def delete_code_scanning_analysis(repo, analysis_id, options = {})
+        delete "#{Repository.path repo}/code-scanning/analyses/#{analysis_id}", options
+      end
+
+      # Get a code scanning analysis for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param analysis_id [Integer] ID of the code scanning analysis
+      #
+      # @return [Sawyer::Resource] Code Scanning Analysis
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-analysis-for-a-repository
+      def get_code_scanning_analysis(repo, analysis_id, options = {})
+        get "#{Repository.path repo}/code-scanning/analyses/#{analysis_id}", options
+      end
+
+      # List code scanning analyses for a repository
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      #
+      # @return [Array] List of Code Scanning Analyses
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-analyses-for-a-repository
+      def list_code_scanning_analysis(repo, options = {})
+        paginate "#{Repository.path repo}/code-scanning/analyses", options
+      end
+
+      # List instances of a code scanning alert
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param alert_number [Integer] The number that identifies an alert
+      #
+      # @return [Array] List of Code Scanning Alerts
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-instances-of-a-code-scanning-alert
+      def list_instances_of_code_scanning_alert(repo, alert_number, options = {})
+        paginate "#{Repository.path repo}/code-scanning/alerts/#{alert_number}/instances", options
+      end
+
+      # Update a code scanning alert
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param alert_number [Integer] The number that identifies an alert
+      # @param state [String] The reason for dismissing or closing the alert. Required when the state is dismissed
+      #
+      # @return [Sawyer::Resource] Code Scanning Alert information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#update-a-code-scanning-alert
+      def update_code_scanning_alert(repo, alert_number, state, reason, comment = nil, options = {})
+        options[:state] = state
+        options[:dismissed_reason] = reason
+        options[:dismissed_comment] = comment if comment
+
+        patch "#{Repository.path repo}/code-scanning/alerts/#{alert_number}", options
+      end
+
+      # Gets a single code scanning alert
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param alert_number [Integer] The number that identifies an alert
+      #
+      # @return [Sawyer::Resource] Code Scanning Alert
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#get-a-code-scanning-alert
+      def get_code_scanning_alert(repo, alert_number, options = {})
+        get "#{Repository.path repo}/code-scanning/alerts/#{alert_number}", options
+      end
+
+      # List code scanning alerts for a repository
+      #
+      # @param org [String] A GitHub organization
+      #
+      # @return [Array] Code Scanning Alert information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-a-repository
+      def list_code_scanning_alerts_for_repo(repo, options = {})
+        paginate "#{Repository.path repo}/code-scanning/alerts", options
+      end
+
+      # List code scanning alerts for an organization
+      #
+      # @param org [String] A GitHub organization
+      #
+      # @return [Array] Code Scanning Alert information
+      # @see https://docs.github.com/en/rest/code-scanning/code-scanning#list-code-scanning-alerts-for-an-organization
+      def list_code_scanning_alerts_for_org(org, options = {})
+        paginate "orgs/#{org}/code-scanning/alerts", options
+      end
+
+      # Uploads SARIF data containing the results of a code scanning analysis
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param file [String] Path to the SARIF file to upload
+      # @param sha [String] The SHA of the commit to which the analysis you are uploading relates
+      # @param ref [String] The full Git reference, formatted as `refs/heads/<branch name>`, `refs/pull/<number>/merge`, or `refs/pull/<number>/head`
+      #
+      # @return [Sawyer::Resource] SARIF upload information
+      # @see https://docs.github.com/rest/code-scanning#upload-an-analysis-as-sarif-data
+      def upload_sarif_data(repo, file, sha, ref, options = {})
+        options[:sarif] = compress_sarif_data(file)
+        options[:commit_sha] = sha
+        options[:ref] = ref
+
+        post "#{Repository.path repo}/code-scanning/sarifs", options
+      end
+
+      # Gets information about a SARIF upload
+      #
+      # @param repo [Integer, String, Repository, Hash] A GitHub repository
+      # @param sarif_id [String] The SARIF ID obtained after uploading
+      #
+      # @return [Sawyer::Resource] SARIF upload information
+      # @see https://docs.github.com/rest/code-scanning#get-information-about-a-sarif-upload
+      def get_sarif_upload_information(repo, sarif_id, options = {})
+        get "#{Repository.path repo}/code-scanning/sarifs/#{sarif_id}", options
+      end
+
+      private
+
+      def compress_sarif_data(file)
+        Tempfile.create('sarif.gz') do |tempfile|
+          Zlib::GzipWriter.open(tempfile) do |gz_file|
+            gz_file.write File.binread(file)
+          end
+          [tempfile.read].pack('m0') # Base64.strict_encode64
+        end
+      end
+    end
+  end
+end

data/lib/octokit/client/codespaces_secrets.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Octokit
+  class Client
+    # Methods for the Codespaces Secrets API
+    #
+    # @see https://docs.github.com/en/rest/codespaces/
+    module CodespacesSecrets
+      # 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/codespaces/repository-secrets#get-a-repository-public-key
+      def get_codespaces_public_key(repo)
+        get "#{Repository.path repo}/codespaces/secrets/public-key"
+      end
+
+      # Get public key for secrets encryption
+      #
+      # @param org [String] A GitHub organization
+      # @return [Hash] key_id and key
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#get-an-organization-public-key
+      def get_org_codespaces_public_key(org)
+        get "#{Organization.path org}/codespaces/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/codespaces/repository-secrets?apiVersion=2022-11-28#list-repository-secrets
+      def list_codespaces_secrets(repo)
+        paginate "#{Repository.path repo}/codespaces/secrets" do |data, last_response|
+          data.secrets.concat last_response.data.secrets
+        end
+      end
+
+      # List org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @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/codespaces/organization-secrets?apiVersion=2022-11-28#list-organization-secrets
+      def list_org_codespaces_secrets(org)
+        paginate "#{Organization.path org}/codespaces/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/codespaces/repository-secrets?apiVersion=2022-11-28#get-a-repository-secret
+      def get_codespaces_secret(repo, name)
+        get "#{Repository.path repo}/codespaces/secrets/#{name}"
+      end
+
+      # Get an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @return [Hash] name, created_at, updated_at, and visibility
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#get-an-organization-secret
+      def get_org_codespaces_secret(org, name)
+        get "#{Organization.path org}/codespaces/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/codespaces/repository-secrets?apiVersion=2022-11-28#create-or-update-a-repository-secret
+      def create_or_update_codespaces_secret(repo, name, options)
+        put "#{Repository.path repo}/codespaces/secrets/#{name}", options
+      end
+
+      # Create or update org secrets
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @param options [Hash] encrypted_value and key_id
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#create-or-update-an-organization-secret
+      def create_or_update_org_codespaces_secret(org, name, options)
+        put "#{Organization.path org}/codespaces/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/codespaces/repository-secrets?apiVersion=2022-11-28#delete-a-repository-secret
+      def delete_codespaces_secret(repo, name)
+        boolean_from_response :delete, "#{Repository.path repo}/codespaces/secrets/#{name}"
+      end
+
+      # Delete an org secret
+      #
+      # @param org [String] A GitHub organization
+      # @param name [String] Name of secret
+      # @see https://docs.github.com/en/rest/codespaces/organization-secrets?apiVersion=2022-11-28#delete-an-organization-secret
+      def delete_org_codespaces_secret(org, name)
+        boolean_from_response :delete, "#{Organization.path org}/codespaces/secrets/#{name}"
+      end
+    end
+  end
+end

data/lib/octokit/client/commit_branches.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Branches for HEAD API
     #
     # @see https://developer.github.com/v3/repos/commits/
     module CommitBranches
-
       # List branches for a single HEAD commit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository

data/lib/octokit/client/commit_comments.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Commit Comments API
     #
     # @see https://developer.github.com/v3/repos/comments/
     module CommitComments
-
       # List all commit comments
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository
@@ -53,12 +53,12 @@ module Octokit
       #   comment.path # => "README.md"
       #   comment.line # => 10
       #   comment.position # => 1
-      def create_commit_comment(repo, sha, body, path=nil, line=nil, position=nil, options = {})
+      def create_commit_comment(repo, sha, body, path = nil, line = nil, position = nil, options = {})
         params = {
-          :body => body,
-          :path => path,
-          :line => line,
-          :position => position
+          body: body,
+          path: path,
+          line: line,
+          position: position
         }
         post "#{Repository.path repo}/commits/#{sha}/comments", options.merge(params)
       end
@@ -76,7 +76,7 @@ module Octokit
       #   comment.body # => "Updated commit comment"
       def update_commit_comment(repo, id, body, options = {})
         params = {
-          :body => body
+          body: body
         }
         patch "#{Repository.path repo}/comments/#{id}", options.merge(params)
       end

data/lib/octokit/client/commit_pulls.rb

@@ -1,11 +1,11 @@
+# frozen_string_literal: true
+
 module Octokit
   class Client
-
     # Methods for the Commit Pulls API
     #
     # @see https://developer.github.com/v3/repos/comments/
     module CommitPulls
-
       # List pulls for a single commit
       #
       # @param repo [Integer, String, Hash, Repository] A GitHub repository

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,11 @@
-require 'base64'
+# frozen_string_literal: true
 
 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 +16,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 +31,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 +57,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 +67,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 +76,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] = [content].pack('m0') # Base64.strict_encode64
         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 +113,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 +139,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 +152,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}"