gitlab_support_readiness 1.0.0

data/lib/support_readiness/gitlab/repositories.rb

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Repositories within the module {Readiness::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @todo Anything listed on https://docs.gitlab.com/ee/api/repositories.html not currently here
+    class Repositories < Readiness::Client
+      ##
+      # Lists a repository's file tree.
+      # This method can take a long time to run depending on the parameters used.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/repositories.html#list-repository-tree GitLab API > Repositories > List repository tree
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   tree = Readiness::GitLab::Repositories.tree(client, project)
+      #   pp tree.first['path']
+      #   # => ".gitlab/CODEOWNERS"
+      def self.tree(client, project, filters = [])
+        array = []
+        url = "projects/#{project.id}/repository/tree?per_page=100&pagination=keyset&order_by=id&sort=asc&id_after=0&#{to_param_string(filters)}"
+        loop do
+          response = client.connection.get url
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          url = "projects/#{project.id}/repository/tree?per_page=100&pagination=keyset&order_by=id&sort=asc&id_after=0&#{to_param_string(filters)}"
+        end
+        array
+      end
+
+      ##
+      # Get information about a file in a repository.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param path [String] The full file path. Ex: lib/support_readiness/gitlab/repositories.rb
+      # @param ref [String] The name of branch, tag or commit
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/repository_files.html GitLab API > Repository files > Get file from repository
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   file = Readiness::GitLab::Repositories.file(client, project, ".gitlab/CODEOWNERS", "main")
+      #   pp file['size']
+      #   # => 88
+      def self.file(client, project, path, ref)
+        response = client.connection.get "projects/#{project.id}/repository/files/#{CGI.escape(path)}?ref=#{ref}"
+        handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Get raw information about a file in a repository.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param path [String] The full file path. Ex: lib/support_readiness/gitlab/repositories.rb
+      # @param ref [String] The name of branch, tag or commit
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/repository_files.html#get-raw-file-from-repository GitLab API > Repository files > Get raw file from repository
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   file = Readiness::GitLab::Repositories.raw_file(client, project, ".gitlab/CODEOWNERS", "main")
+      #   pp file['size']
+      #   # => 88
+      def self.raw_file(client, project, path, ref)
+        response = client.connection.get "projects/#{project.id}/repository/files/#{CGI.escape(path)}/raw?ref=#{ref}"
+        handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Create a single file in a repository. This will exit on error.
+      # You might want to instead use {create_commit!}
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param path [String] The full file path. Ex: lib/support_readiness/gitlab/repositories.rb
+      # @param params [Hash] The parameters to use for the request
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/repository_files.html#update-existing-file-in-repository GitLab API > Repository files > Create new file in repository
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   file_params = {
+      #     branch: 'master',
+      #     commit_message: 'Created test.file',
+      #     content: 'This is a test fi',
+      #     execute_filemode: false
+      #   }
+      #   file = Readiness::GitLab::Repositories.create_file!(client, project, "spec/test.file", file_params)
+      #   pp file['path']
+      #   # => "spec/test.file"
+      def self.create_file!(client, project, path, params)
+        response = client.connection.post "projects/#{project.id}/repository/files/#{CGI.escape(path)}", to_clean_json(params)
+        handle_request_error(1, 'GitLab', response.status, { action: 'Create file in repo', id: "#{project.id}" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Updates a single file in a repository. This will exit on error.
+      # You might want to instead use {create_commit!}
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param path [String] The full file path. Ex: lib/support_readiness/gitlab/repositories.rb
+      # @param params [Hash] The parameters to use for the request
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/repository_files.html#update-existing-file-in-repository GitLab API > Repository files > Update existing file in repository
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   file_params = {
+      #     branch: 'master',
+      #     commit_message: 'Fixing typo within test.file',
+      #     content: 'This is a test file',
+      #     execute_filemode: false
+      #   }
+      #   file = Readiness::GitLab::Repositories.update_file!(client, project, "spec/test.file", file_params)
+      #   pp file['path']
+      #   # => "spec/test.file"
+      def self.update_file!(client, project, path, params)
+        response = client.connection.put "projects/#{project.id}/repository/files/#{CGI.escape(path)}", to_clean_json(params)
+        handle_request_error(1, 'GitLab', response.status, { action: 'Update file in repo', id: "#{project.id}" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Deletes a single file in a repository. This will exit on error.
+      # You might want to instead use {create_commit!}
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param path [String] The full file path. Ex: lib/support_readiness/gitlab/repositories.rb
+      # @param params [Hash] The parameters to use for the request
+      # @return [Boolean]
+      # @see https://docs.gitlab.com/ee/api/repository_files.html#delete-existing-file-in-repository GitLab API > Repository files > Delete existing file in repository
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   file_params = {
+      #     branch: 'master',
+      #     commit_message: 'Deleting test.file'
+      #   }
+      #   file = Readiness::GitLab::Repositories.delete_file!(client, project, "spec/test.file", file_params)
+      #   pp file
+      #   # => true
+      def self.delete_file!(client, project, path, params)
+        response = client.connection.delete "projects/#{project.id}/repository/files/#{CGI.escape(path)}", to_clean_json(params)
+        handle_request_error(1, 'GitLab', response.status, { action: 'Delete file in repo', id: "#{project.id}" }) unless response.status == 204
+        true
+      end
+
+      ##
+      # Create a commit on a repository within GitLab. This will exit on error.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param params [Hash] The parameters to use for the request
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/commits.html#create-a-commit-with-multiple-files-and-actions GitLab API > Commits > Create a commit with multiple files and actions
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 1083469)
+      #   commit_params = {
+      #     branch: 'master',
+      #     commit_message: 'Notify via slack for failed pipelines',
+      #     actions: [
+      #       {
+      #         execute_filemode: true,
+      #         file_path: 'bin/post_to_slack.sh',
+      #         content: 'curl -ss -X POST $SLACK_URL -H "Content-Type=application/json" --data...',
+      #         action: 'create'
+      #       }
+      #     ]
+      #   }
+      #   commit = Readiness::GitLab::Repositories.create_commit!(client, project, commit_params)
+      #   pp commit['title']
+      #   # => "Notify via slack for failed pipelines"
+      def self.create_commit!(client, project, params)
+        response = client.connection.post "projects/#{project.id}/repository/commits", to_clean_json(params)
+        handle_request_error(1, 'GitLab', response.status, { action: 'Create commit', id: "#{project.id}" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Updates a submodule's reference in a project. This will exit on error.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param path [String] The full file path. Ex: lib/support_readiness/gitlab/repositories.rb
+      # @param params [Hash] The parameters to use for the request
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/repository_submodules.html#update-existing-submodule-reference-in-repository GitLab API > Repository submodules > Update existing submodule reference in repository
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.find!(client, 5)
+      #   update_params = {
+      #     branch: 'main',
+      #     commit_sha: '3ddec28ea23acc5caa5d8331a6ecb2a65fc03e88',
+      #     commit_message: 'Update submodule reference'
+      #   }
+      #   update = Readiness::GitLab::Repositories.update_submodule!(client, project, "lib/modules/example", update_params)
+      #   pp update['parent_ids']
+      #   # => ["ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"]
+      def self.update_submodule!(client, project, path, params)
+        response = clinet.connection.put "projects/#{project.id}/repository/submodules/#{CGI.escape(path)}", to_clean_json(params)
+        handle_request_error(1, 'GitLab', response.status, { action: 'Update submodule in repo', id: "#{project.id}" }) unless response.status == 200
+        Oj.load(response.body)
+      end
+    end
+  end
+end