gitlab_support_readiness 1.0.0

data/lib/support_readiness/gitlab/projects.rb

@@ -0,0 +1,510 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class Projects within the module {Readiness::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @todo Anything listed on https://docs.gitlab.com/ee/api/projects.html not currently here
+    class Projects < Readiness::Client
+      attr_accessor :allow_merge_on_skipped_pipeline, :allow_pipeline_trigger_approve_deployment, :analytics_access_level, :approvals_before_merge, :archived, :auto_cancel_pending_pipelines, :autoclose_referenced_issues, :auto_devops_deploy_strategy, :auto_devops_enabled, :avatar_url, :build_git_strategy, :builds_access_level, :build_timeout, :can_create_merge_request_in, :ci_allow_fork_pipelines_to_run_in_parent_project, :ci_config_path, :ci_default_git_depth, :ci_forward_deployment_enabled, :ci_forward_deployment_rollback_allowed, :ci_id_token_sub_claim_components, :ci_job_token_scope_enabled, :ci_pipeline_variables_minimum_override_role, :ci_push_repository_for_job_token_allowed, :ci_restrict_pipeline_cancellation_role, :ci_separated_caches, :compliance_frameworks, :container_registry_access_level, :container_registry_enabled, :container_registry_image_prefix, :created_at, :creator_id, :custom_attributes, :default_branch, :description, :description_html, :emails_disabled, :emails_enabled, :empty_repo, :enforce_auth_checks_on_uploads, :environments_access_level, :external_authorization_classification_label, :feature_flags_access_level, :forked_from_project, :forking_access_level, :forks_count, :group_runners_enabled, :http_url_to_repo, :id, :import_error, :import_status, :import_type, :import_url, :infrastructure_access_level, :issue_branch_template, :issues_access_level, :issues_enabled, :issues_template, :jobs_enabled, :keep_latest_artifact, :last_activity_at, :lfs_enabled, :license, :license_url, :_links, :marked_for_deletion_at, :marked_for_deletion_on, :merge_commit_template, :merge_method, :merge_pipelines_enabled, :merge_requests_access_level, :merge_requests_enabled, :merge_requests_template, :merge_trains_enabled, :merge_trains_skip_train_allowed, :mirror, :model_experiments_access_level, :model_registry_access_level, :monitor_access_level, :mr_default_target_self, :name, :namespace, :name_with_namespace, :only_allow_merge_if_all_discussions_are_resolved, :only_allow_merge_if_all_status_checks_passed, :only_allow_merge_if_pipeline_succeeds, :open_issues_count, :packages_enabled, :pages_access_level, :path, :path_with_namespace, :permissions, :pre_receive_secret_detection_enabled, :prevent_merge_without_jira_issue, :printing_merge_request_link_enabled, :public_jobs, :readme_url, :releases_access_level, :remove_source_branch_after_merge, :repository_access_level, :repository_object_format, :repository_storage, :request_access_enabled, :requirements_access_level, :requirements_enabled, :resolve_outdated_diff_discussions, :restrict_user_defined_variables, :runners_token, :runner_token_expiration_interval, :security_and_compliance_access_level, :security_and_compliance_enabled, :service_desk_address, :service_desk_enabled, :shared_runners_enabled, :shared_with_groups, :snippets_access_level, :snippets_enabled, :squash_commit_template, :squash_option, :ssh_url_to_repo, :star_count, :statistics, :suggestion_commit_message, :tag_list, :topics, :updated_at, :visibility, :warn_about_potentially_unwanted_characters, :web_url, :wiki_access_level, :wiki_enabled
+
+      ##
+      # Creates a new {Readiness::GitLab::Projects} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::GitLab::Projects}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::GitLab::Projects.new
+      def initialize(object = {})
+        @allow_merge_on_skipped_pipeline = object['allow_merge_on_skipped_pipeline']
+        @allow_pipeline_trigger_approve_deployment = object['allow_pipeline_trigger_approve_deployment']
+        @analytics_access_level = object['analytics_access_level']
+        @approvals_before_merge = object['approvals_before_merge']
+        @archived = object['archived']
+        @auto_cancel_pending_pipelines = object['auto_cancel_pending_pipelines']
+        @autoclose_referenced_issues = object['autoclose_referenced_issues']
+        @auto_devops_deploy_strategy = object['auto_devops_deploy_strategy']
+        @auto_devops_enabled = object['auto_devops_enabled']
+        @avatar_url = object['avatar_url']
+        @build_git_strategy = object['build_git_strategy']
+        @builds_access_level = object['builds_access_level']
+        @build_timeout = object['build_timeout']
+        @can_create_merge_request_in = object['can_create_merge_request_in']
+        @ci_allow_fork_pipelines_to_run_in_parent_project = object['ci_allow_fork_pipelines_to_run_in_parent_project']
+        @ci_config_path = object['ci_config_path']
+        @ci_default_git_depth = object['ci_default_git_depth']
+        @ci_forward_deployment_enabled = object['ci_forward_deployment_enabled']
+        @ci_forward_deployment_rollback_allowed = object['ci_forward_deployment_rollback_allowed']
+        @ci_id_token_sub_claim_components = object['ci_id_token_sub_claim_components']
+        @ci_job_token_scope_enabled = object['ci_job_token_scope_enabled']
+        @ci_pipeline_variables_minimum_override_role = object['ci_pipeline_variables_minimum_override_role']
+        @ci_push_repository_for_job_token_allowed = object['ci_push_repository_for_job_token_allowed']
+        @ci_restrict_pipeline_cancellation_role = object['ci_restrict_pipeline_cancellation_role']
+        @ci_separated_caches = object['ci_separated_caches']
+        @compliance_frameworks = object['compliance_frameworks']
+        @container_registry_access_level = object['container_registry_access_level']
+        @container_registry_enabled = object['container_registry_enabled']
+        @container_registry_image_prefix = object['container_registry_image_prefix']
+        @created_at = object['created_at']
+        @creator_id = object['creator_id']
+        @custom_attributes = object['custom_attributes']
+        @default_branch = object['default_branch']
+        @description = object['description']
+        @description_html = object['description_html']
+        @emails_disabled = object['emails_disabled']
+        @emails_enabled = object['emails_enabled']
+        @empty_repo = object['empty_repo']
+        @enforce_auth_checks_on_uploads = object['enforce_auth_checks_on_uploads']
+        @environments_access_level = object['environments_access_level']
+        @external_authorization_classification_label = object['external_authorization_classification_label']
+        @feature_flags_access_level = object['feature_flags_access_level']
+        @forked_from_project = object['forked_from_project']
+        @forking_access_level = object['forking_access_level']
+        @forks_count = object['forks_count']
+        @group_runners_enabled = object['group_runners_enabled']
+        @http_url_to_repo = object['http_url_to_repo']
+        @id = object['id']
+        @import_error = object['import_error']
+        @import_status = object['import_status']
+        @import_type = object['import_type']
+        @import_url = object['import_url']
+        @infrastructure_access_level = object['infrastructure_access_level']
+        @issue_branch_template = object['issue_branch_template']
+        @issues_access_level = object['issues_access_level']
+        @issues_enabled = object['issues_enabled']
+        @issues_template = object['issues_template']
+        @jobs_enabled = object['jobs_enabled']
+        @keep_latest_artifact = object['keep_latest_artifact']
+        @last_activity_at = object['last_activity_at']
+        @lfs_enabled = object['lfs_enabled']
+        @license = object['license']
+        @license_url = object['license_url']
+        @_links = object['_links']
+        @marked_for_deletion_at = object['marked_for_deletion_at']
+        @marked_for_deletion_on = object['marked_for_deletion_on']
+        @merge_commit_template = object['merge_commit_template']
+        @merge_method = object['merge_method']
+        @merge_pipelines_enabled = object['merge_pipelines_enabled']
+        @merge_requests_access_level = object['merge_requests_access_level']
+        @merge_requests_enabled = object['merge_requests_enabled']
+        @merge_requests_template = object['merge_requests_template']
+        @merge_trains_enabled = object['merge_trains_enabled']
+        @merge_trains_skip_train_allowed = object['merge_trains_skip_train_allowed']
+        @mirror = object['mirror']
+        @model_experiments_access_level = object['model_experiments_access_level']
+        @model_registry_access_level = object['model_registry_access_level']
+        @monitor_access_level = object['monitor_access_level']
+        @mr_default_target_self = object['mr_default_target_self']
+        @name = object['name']
+        @namespace = object['namespace']
+        @name_with_namespace = object['name_with_namespace']
+        @only_allow_merge_if_all_discussions_are_resolved = object['only_allow_merge_if_all_discussions_are_resolved']
+        @only_allow_merge_if_all_status_checks_passed = object['only_allow_merge_if_all_status_checks_passed']
+        @only_allow_merge_if_pipeline_succeeds = object['only_allow_merge_if_pipeline_succeeds']
+        @open_issues_count = object['open_issues_count']
+        @packages_enabled = object['packages_enabled']
+        @pages_access_level = object['pages_access_level']
+        @path = object['path']
+        @path_with_namespace = object['path_with_namespace']
+        @permissions = object['permissions']
+        @pre_receive_secret_detection_enabled = object['pre_receive_secret_detection_enabled']
+        @prevent_merge_without_jira_issue = object['prevent_merge_without_jira_issue']
+        @printing_merge_request_link_enabled = object['printing_merge_request_link_enabled']
+        @public_jobs = object['public_jobs']
+        @readme_url = object['readme_url']
+        @releases_access_level = object['releases_access_level']
+        @remove_source_branch_after_merge = object['remove_source_branch_after_merge']
+        @repository_access_level = object['repository_access_level']
+        @repository_object_format = object['repository_object_format']
+        @repository_storage = object['repository_storage']
+        @request_access_enabled = object['request_access_enabled']
+        @requirements_access_level = object['requirements_access_level']
+        @requirements_enabled = object['requirements_enabled']
+        @resolve_outdated_diff_discussions = object['resolve_outdated_diff_discussions']
+        @restrict_user_defined_variables = object['restrict_user_defined_variables']
+        @runners_token = object['runners_token']
+        @runner_token_expiration_interval = object['runner_token_expiration_interval']
+        @security_and_compliance_access_level = object['security_and_compliance_access_level']
+        @security_and_compliance_enabled = object['security_and_compliance_enabled']
+        @service_desk_address = object['service_desk_address']
+        @service_desk_enabled = object['service_desk_enabled']
+        @shared_runners_enabled = object['shared_runners_enabled']
+        @shared_with_groups = object['shared_with_groups']
+        @snippets_access_level = object['snippets_access_level']
+        @snippets_enabled = object['snippets_enabled']
+        @squash_commit_template = object['squash_commit_template']
+        @squash_option = object['squash_option']
+        @ssh_url_to_repo = object['ssh_url_to_repo']
+        @star_count = object['star_count']
+        @statistics = object['statistics']
+        @suggestion_commit_message = object['suggestion_commit_message']
+        @tag_list = object['tag_list']
+        @topics = object['topics']
+        @updated_at = object['updated_at']
+        @visibility = object['visibility']
+        @warn_about_potentially_unwanted_characters = object['warn_about_potentially_unwanted_characters']
+        @web_url = object['web_url']
+        @wiki_access_level = object['wiki_access_level']
+        @wiki_enabled = object['wiki_enabled']
+      end
+
+      ##
+      # Lists projects. Does not stop until it ends or the page limit is hit.
+      # 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 limit [Integer] The number of pages to stop at. Using 0 means to list all.
+      # @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/projects.html#list-all-projects GitLab API > Projects > List all projects
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   projects = Readiness::GitLab::Projects.list(client, 1)
+      #   pp projects.count
+      #   # => 100
+      def self.list(client, limit = 0, filters = [])
+        array = []
+        url = "projects?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.map { |p| Projects.new(p) }
+          break if body.count < 100
+          break if limit != 0 && array.count >= (limit * 100)
+
+          url = "projects?per_page=100&pagination=keyset&order_by=id&sort=asc&id_after=#{body.last['id']}&#{to_param_string(filters)}"
+        end
+        array
+      end
+
+      ##
+      # Locates a project within GitLab. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param pid [Integer] The project ID to find
+      # @param attributes [Array] An array of attribute Strings to use. Should be in the format of key=value
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/projects.html#get-single-project GitLab API > Projects > Get single project
+      # @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)
+      #   pp project.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta"
+      def self.find(client, pid,  attributes = [])
+        response = client.connection.get("projects/#{pid}?#{to_param_string(attributes)}")
+        handle_request_error(0, 'GitLab', response.status,  { action: 'get', id: pid }) unless response.status == 200
+        return Projects.new(Oj.load(response.body)) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a project within GitLab. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param pid [Integer] The project ID to find
+      # @param attributes [Array] An array of attribute Strings to use. Should be in the format of key=value
+      # @return [Object] An instance of {Readiness::GitLab::Projects}
+      # @see https://docs.gitlab.com/ee/api/projects.html#get-single-project GitLab API > Projects > Get single project
+      # @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)
+      #   pp project.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta"
+      def self.find!(client, pid, attributes = [])
+        response = client.connection.get("projects/#{pid}?#{to_param_string(attributes)}")
+        handle_request_error(1, 'GitLab', response.status, { action: 'Find project', id: pid }) unless response.status == 200
+        Projects.new(Oj.load(response.body))
+      end
+
+      ##
+      # Search for a project by name.
+      # This method can take a long time to run depending on the number of results found.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param query [String] The name to search for
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/projects.html#search-for-projects-by-name GitLab API > Projects > Search for projects by name
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   projects = Readiness::GitLab::Projects.search(client, "support-team-meta")
+      #   pp projects.first.web_url
+      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta"
+      def self.search(client, query)
+        array = []
+        url = "projects?per_page=100&pagination=keyset&order_by=id&sort=asc&id_after=0&search=#{query}"
+        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.map { |p| Projects.new(p) }
+          break if body.count < 100
+
+          url = "projects?per_page=100&pagination=keyset&order_by=id&sort=asc&id_after=#{body.last['id']}&search=#{query}"
+        end
+        array
+      end
+
+      ##
+      # Lists all access tokens for a project
+      #
+      # @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}
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/project_access_tokens.html#list-project-access-tokens GitLab API > Projects > Access tokens > List project access tokens
+      # @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)
+      #   tokens = Readiness::GitLab::Projects.access_tokens(client, project)
+      #   pp tokens.first['active']
+      #   # => false
+      def self.access_tokens(client, project)
+        response = client.connection.get "projects/#{project.id}/access_tokens"
+        handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Rotates an access token for a project (revokes it and makes a new one with the same user)
+      #
+      # @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 tid [Integer] The access token ID to rotate
+      # @param expiration [String] The expiration date to use (must be in ISO format)
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/project_access_tokens.html#rotate-a-project-access-token GitLab API > Projects > Access tokens > Rotate a project access token
+      # @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)
+      #   tokens = Readiness::GitLab::Projects.access_tokens(client, project)
+      #   tokens.select { |t| Date.parse(t['expires_at']) <= (Date.today + 5.days) }.each do |token|
+      #     new_token = Readiness::GitLab::Projects.rotate_token!(client, project, token['id'])
+      #     pp new_token['token']
+      #   end
+      #   # => "s3cr3t1"
+      #   # => "s3cr3t2"
+      #   # => "s3cr3t3"
+      def self.rotate_token!(client, project, tid, expiration = (Date.today + 1.year).iso8601)
+        response = client.connection.post "projects/#{project.id}/access_tokens/#{tid}/rotate", { expires_at: expiration }.to_json
+        handle_request_error(1, 'GitLab', response.status, { action: 'Rotate access token', id: project.id }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Lists direct members in a project.
+      # 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/members.html#list-all-members-of-a-group-or-project GitLab API > Members > List all members of a group or project
+      # @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)
+      #   members = Readiness::GitLab::Projects.members(client, project)
+      #   pp members.first['username']
+      #   # => "jsmith"
+      def self.members(client, project, filters = [])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "projects/#{project.id}/members?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Lists all members in a project.
+      # 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/members.html#list-all-members-of-a-group-or-project-including-inherited-and-invited-members GitLab API > Members > List all members of a group or project including inherited and invited members
+      # @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)
+      #   members = Readiness::GitLab::Projects.all_members(client, project)
+      #   pp members.first['username']
+      #   # => "alice_one"
+      def self.all_members(client, project, filters = [])
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "projects/#{project.id}/members/all?per_page=100&page=#{page}&#{to_param_string(filters)}"
+          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body
+          break if body.count < 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Lists badges in a project.
+      #
+      # @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}
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/project_badges.html#list-all-badges-of-a-project GitLab API > Projects > Badges > List all badges of a project
+      # @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)
+      #   badges = Readiness::GitLab::Projects.list_badges(client, project)
+      #   pp badges.first['name']
+      #   # => "Coverage"
+      def self.list_badges(client, project)
+        response = client.connection.get "projects/#{project.id}/badges"
+        handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Creates a badge in a project.
+      #
+      # @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 to create the badge
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/project_badges.html#add-a-badge-to-a-project GitLab API > Projects > Badges > Add a badge to a project
+      # @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)
+      #   bdge_params = {
+      #     link_url: 'https://gitlab.com/gitlab-org/gitlab-foss/commits/main',
+      #     image_url: 'https://shields.io/my/badge1',
+      #     name: 'mybadge'
+      #   }
+      #   badge = Readiness::GitLab::Projects.create_badge!(client, project, bdge_params)
+      #   pp badge['id']
+      #   # => 7
+      def self.create_badge!(client, project, params)
+        response = client.connection.post "projects/#{project.id}/badges", to_clean_json(params)
+        handle_request_error(1, 'GitLab', response.status, { action: 'Create badge', id: project.id }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Updates a badge in a project.
+      #
+      # @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 bid [Integer] The badge ID to update
+      # @param params [Hash] The parameters to use to update the badge
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/project_badges.html#edit-a-badge-of-a-project GitLab API > Projects > Badges > Edit a badge to a project
+      # @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)
+      #   bdge_params = {
+      #     image_url: 'https://shields.io/my/badge'
+      #   }
+      #   badge = Readiness::GitLab::Projects.create_badge!(client, project, 7, bdge_params)
+      #   pp badge['name']
+      #   # => "mybadge"
+      def self.update_badge!(client, project, bid, params)
+        response = client.connection.put "projects/#{project.id}/badges/#{bid}", to_clean_json(params)
+        handle_request_error(1, 'GitLab', response.status, { action: 'Update badge', id: project.id }) unless response.status == 200
+        Oj.load(response.body)
+      end
+
+      ##
+      # Deletes a badge in a project.
+      #
+      # @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 bid [Integer] The badge ID to update
+      # @return [Boolean]
+      # @see https://docs.gitlab.com/ee/api/project_badges.html#remove-a-badge-from-a-project GitLab API > Projects > Badges > Remove a badge from a project
+      # @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)
+      #   badge = Readiness::GitLab::Projects.create_badge!(client, project, 7)
+      #   pp badge
+      #   # => true
+      def self.delete_badge!(client, project, bid)
+        response = client.connection.delete "projects/#{project.id}/badges/#{bid}"
+        handle_request_error(1, 'GitLab', response.status, { action: 'Delete badge', id: project.id }) unless response.status == 200
+        true
+      end
+    end
+  end
+end