gitlab_support_readiness 1.0.122 → 1.0.124

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c150b6e67f4b31af57feb7a85e4cb7752c61145027c9b195417bee449d86dfb
-  data.tar.gz: c47e718aadeaa60dc62778902bf01adf7e570e1f8a66415db44ea4c3f81f5469
+  metadata.gz: dc950bed810fd3f7ae72f252bae3cc7808d703ccf13474991be560b90b76e486
+  data.tar.gz: 571fc409b7cb717295d9b7edc986735b238dcb1dcdbe5929915b15b5a078c059
 SHA512:
-  metadata.gz: 4ed28ace23f5506939188a4f22f16b0cd037c2a00741c9ebb23d370ce477419c25f9f61758ab66aee8a09e27c1896bf3a621c01b2c0be327b0e646fc6637d7d8
-  data.tar.gz: a3029cd87747b8cdb7629ff3eb133a13d817530ceff021d57602d9cf68b6b367eace6bbf3b2081afa69fc5e095aa806131fc04245e073cb3ac6de502336a7612
+  metadata.gz: eba8f245731ff253cd0517cf6ef09cb81bc3d4d5e9c683b75b6a5b3537ce26810f058e507e6266cf469215026b3c5b5da28bb452b867f281bdf45214320812db
+  data.tar.gz: d1ebd58aee4dae34bb3c32eddd43ec4f162d1f668989086cf5fa2610785c5dc77be8c8f7cc50e16b6de6201682aadbdbf0af1b9d0005bb545a7dc47d529d0385

data/lib/support_readiness/gitlab/project_webhooks.rb

@@ -0,0 +1,275 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module GitLab
+  module GitLab
+    ##
+    # Defines the class ProjectWebhooks within the module {Readiness::GitLab}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.124
+    # @todo resend_event! https://docs.gitlab.com/ee/api/project_webhooks.html#resend-a-project-webhook-event
+    # @todo trigger! https://docs.gitlab.com/ee/api/project_webhooks.html#trigger-a-test-project-webhook
+    # @todo set_custom_header! https://docs.gitlab.com/ee/api/project_webhooks.html#set-a-custom-header
+    # @todo delete_custom_header! https://docs.gitlab.com/ee/api/project_webhooks.html#delete-a-custom-header
+    # @todo set_url_variable! https://docs.gitlab.com/ee/api/project_webhooks.html#set-a-url-variable
+    # @todo delete_url_variable! https://docs.gitlab.com/ee/api/project_webhooks.html#delete-a-url-variable
+    class ProjectWebhooks < Readiness::Client
+      attr_accessor :alert_status, :branch_filter_strategy, :confidential_issues_events, :confidential_note_events, :created_at, :custom_headers, :custom_webhook_template, :deployment_events, :description, :disabled_until, :enable_ssl_verification, :feature_flag_events, :id, :issues_events, :job_events, :merge_requests_events, :name, :note_events, :pipeline_events, :project_id, :push_events, :push_events_branch_filter, :releases_events, :repository_update_events, :resource_access_token_events, :tag_push_events, :token, :url, :url_variables, :wiki_page_events
+
+      ##
+      # Creates a new {Readiness::GitLab::ProjectWebhooks} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      # @param object [Object] An instance of {Readiness::GitLab::ProjectWebhooks}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::GitLab::ProjectWebhooks.new
+      def initialize(object = {})
+        @alert_status = object['alert_status']
+        @branch_filter_strategy = object['branch_filter_strategy']
+        @confidential_issues_events = object['confidential_issues_events']
+        @confidential_note_events = object['confidential_note_events']
+        @created_at = object['created_at']
+        @custom_headers = object['custom_headers']
+        @custom_webhook_template = object['custom_webhook_template']
+        @deployment_events = object['deployment_events']
+        @description = object['description']
+        @disabled_until = object['disabled_until']
+        @enable_ssl_verification = object['enable_ssl_verification']
+        @feature_flag_events = object['feature_flag_events']
+        @id = object['id']
+        @issues_events = object['issues_events']
+        @job_events = object['job_events']
+        @merge_requests_events = object['merge_requests_events']
+        @name = object['name']
+        @note_events = object['note_events']
+        @pipeline_events = object['pipeline_events']
+        @project_id = object['project_id']
+        @push_events = object['push_events']
+        @push_events_branch_filter = object['push_events_branch_filter']
+        @releases_events = object['releases_events']
+        @repository_update_events = object['repository_update_events']
+        @resource_access_token_events = object['resource_access_token_events']
+        @tag_push_events = object['tag_push_events']
+        @token = object['token']
+        @url = object['url']
+        @url_variables = object['url_variables']
+        @wiki_page_events = object['wiki_page_events']
+      end
+
+      ##
+      # Lists webhooks for a project.
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      # @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_webhooks.html#list-webhooks-for-a-project GitLab API > Projects > Webhooks > List webhooks for 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)
+      #   hooks = Readiness::GitLab::ProjectWebhooks.list(client, project)
+      #   pp hooks.first.url
+      #   # => "Hook name"
+      def self.list(client, project)
+        response = client.connection.get "projects/#{project.id}/hooks"
+        handle_request_error(0, 'GitLab', response.status) unless response.status == 200
+        body = Oj.load(response.body)
+        body.map { |p| ProjectWebhooks.new(p) }
+      end
+
+      ##
+      # Locates a project webhook within GitLab. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param hook_id [Integer] The project webhook ID to find
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/project_webhooks.html#get-a-project-webhook GitLab API > Projects > Webhooks > Get a project webhook
+      # @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)
+      #   hook = Readiness::GitLab::Issues.find(client, project, 1)
+      #   pp hook.name
+      #   # => "Hook name"
+      def self.find(client, project, hook_id)
+        response = client.connection.get ""
+        handle_request_error(0, 'GitLab', response.status,  { action: 'get', id: hook_id }) unless response.status == 200
+        return ProjectWebhooks.new(Oj.load(response.body)) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a project webhook within GitLab. This will exit on error
+      #
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param hook_id [Integer] The project webhook ID to find
+      # @return [Hash]
+      # @see https://docs.gitlab.com/ee/api/project_webhooks.html#get-a-project-webhook GitLab API > Projects > Webhooks > Get a project webhook
+      # @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)
+      #   hook = Readiness::GitLab::Issues.find!(client, project, 1)
+      #   pp hook.name
+      #   # => "Hook name"
+      def self.find!(client, project, hook_id)
+        response = client.connection.get ""
+        handle_request_error(1, 'GitLab', response.status, { action: 'Find webhook', id: "#{project.id}##{hook_id}" }) unless response.status == 200
+        ProjectWebhooks.new(Oj.load(response.body))
+      end
+
+      ##
+      # Lists project webhook events. 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.124
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param status [Various] Response status code of the events (see docs for more info). Omit to get all events
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/project_webhooks.html#get-a-list-of-project-webhook-events GitLab API > Projects > Webhooks > Get a list of project webhook events
+      # @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)
+      #   hooks = Readiness::GitLab::ProjectWebhooks.find!(client, project, 1)
+      #   events = Readiness::GitLab::ProjectWebhooks.events(client, hook)
+      #   pp events.first['trigger']
+      #   # => "push_hooks"
+      # @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)
+      #   hooks = Readiness::GitLab::ProjectWebhooks.find!(client, project, 1)
+      #   events = Readiness::GitLab::ProjectWebhooks.events(client, hook, 200)
+      #   pp events.first['trigger']
+      #   # => "push_hooks"
+      def self.events(client, hook, status = false)
+        root_url = if status
+                     "projects/#{hook.project_id}/hooks/#{hood.id}/events?status=#{status}"
+                   else
+                     "projects/#{hook.project_id}/hooks/#{hood.id}/events?"
+                   end
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get "#{root_url}&per_page=100&page=#{page}"
+          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
+
+      ##
+      # Creates a project webhook within GitLab. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param hook [Object] An instance of {Readiness::GitLab::ProjectWebhooks}
+      # @return [Object] An instance of {Readiness::GitLab::ProjectWebhooks}
+      # @see https://docs.gitlab.com/ee/api/project_webhooks.html#add-a-webhook-to-a-project > Project > Webhooks > Add a webhook to a project
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   hook = Readiness::GitLab::ProjectWebhooks.new
+      #   hook.url = 'http://example.com/hook'
+      #   hook.name = 'Hook name'
+      #   hook.description = 'Hook description'
+      #   hook.project_id = 1083469
+      #   hook.push_events = true
+      #   hook.custom_webhook_template = '{ "event": "{{object_kind}}" }'
+      #   hook.custom_headers = [
+      #     'Authorization'
+      #   ]
+      #   new_hook = Readiness::GitLab::ProjectWebhooks.create!(client, hook)
+      #   pp new_hook.id
+      #   # => 1
+      def self.create!(client, hook)
+        response = client.connection.post "projects/#{hook.project_id}/hooks", to_clean_json(hook)
+        handle_request_error(1, 'GitLab', response.status, { action: 'Create webhook', id: hook.project_id }) unless response.status == 200
+        ProjectWebhooks.new(Oj.load(response.body))
+      end
+
+      ##
+      # Updates a project webhook within GitLab. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param hook [Object] An instance of {Readiness::GitLab::ProjectWebhooks}
+      # @return [Object] An instance of {Readiness::GitLab::ProjectWebhooks}
+      # @see https://docs.gitlab.com/ee/api/project_webhooks.html#edit-a-project-webhook > Project > Webhooks > Edit a project webhook
+      # @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)
+      #   hook = Readiness::GitLab::ProjectWebhooks.find(client, project, 1)
+      #   hook.url = 'http://example.com/hook2'
+      #   hook.name = 'Hook name v2'
+      #   update = Readiness::GitLab::ProjectWebhooks.update!(client, hook)
+      #   pp update.name
+      #   # => "Hook name v2"
+      def self.update!(client, hook)
+        response = client.connection.put "project/#{hook.project_id}/hooks/#{hook.id}", to_clean_json(hook)
+        handle_request_error(1, 'GitLab', response.status, { action: 'Update webhook', id: "#{hook.project_id}##{hook.id}" }) unless response.status == 200
+        ProjectWebhooks.new(Oj.load(response.body))
+      end
+
+      ##
+      # Deletes a project webhook within GitLab. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param hook [Object] An instance of {Readiness::GitLab::ProjectWebhooks}
+      # @return [Boolean]
+      # @see https://docs.gitlab.com/ee/api/project_webhooks.html#delete-project-webhook > Project > Webhooks > Delete project webhook
+      # @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)
+      #   hook = Readiness::GitLab::ProjectWebhooks.find(client, project, 1)
+      #   delete = Readiness::GitLab::ProjectWebhooks.delete!(client, hook)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, hook)
+        response = client.connection.delete "projects/#{hook.project_id}/hooks/#{hook.id}"
+        handle_request_error(1, 'GitLab', response.status, { action: 'Delete webhook', id: "#{hook.project_id}##{hook.id}" }) unless response.status == 2204
+        true
+      end
+    end
+  end
+end

data/lib/support_readiness/gitlab/projects.rb

@@ -11,7 +11,7 @@ module Readiness
     # @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
+      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_expiration_policy, :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, :namespace_id, :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
@@ -49,6 +49,7 @@ module Readiness
         @ci_restrict_pipeline_cancellation_role = object['ci_restrict_pipeline_cancellation_role']
         @ci_separated_caches = object['ci_separated_caches']
         @compliance_frameworks = object['compliance_frameworks']
+        @container_expiration_policy = object['container_expiration_policy']
         @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']
@@ -103,6 +104,7 @@ module Readiness
         @monitor_access_level = object['monitor_access_level']
         @mr_default_target_self = object['mr_default_target_self']
         @name = object['name']
+        @namespace_id = object['namespace_id']
         @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']
@@ -279,6 +281,32 @@ module Readiness
         array
       end
 
+      ##
+      # Creates a project within GitLab. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @return [Object] An instance of {Readiness::GitLab::Projects}
+      # @see https://docs.gitlab.com/ee/api/projects.html#create-a-project GitLab API > Projects > Create a project
+      # @example
+      #   require 'support_readiness'
+      #   config = Readiness::GitLab::Configuration.new
+      #   config.token = 'test123abc'
+      #   client = Readiness::GitLab::Client.new(config)
+      #   project = Readiness::GitLab::Projects.new
+      #   project.name = 'Test project'
+      #   project.path = 'jason-test-project
+      #   new_project = Readiness::GitLab::Projects.create!(client, project)
+      #   puts new_project.web_url
+      #   # => "https://gitlab.com/jason/jason-test-project"
+      def self.create!(client, project)
+        response = client.connection.post 'projects', to_clean_json(project)
+        handle_request_error(1, 'GitLab', response.status, { action: 'Create project', id: '' }) unless response.status == 200
+        Projects.new(Oj.load(response.body))
+      end      
+
       ##
       # Lists all access tokens for a project
       #
@@ -595,6 +623,70 @@ module Readiness
       def self.jobs(client, project, limit = 0, filters = [])
         Jobs.list_project(client, project, limit, filters)
       end
+
+      ##
+      # Lists all project webhooks. This is a wrapper of {ProjectWebhooks#list}
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      # @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_webhooks.html#list-webhooks-for-a-project GitLab API > Projects > Webhooks > List webhooks for 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)
+      #   hooks = Readiness::GitLab::Projects.webhooks(client, project)
+      #   puts hooks.count
+      #   # => 2
+      def self.webhooks(client, project)
+        ProjectWebhooks.list(client, project)
+      end
+ 
+      ##
+      # Create a membership invitation for a project. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param project [Object] An instance of {Readiness::GitLab::Projects}
+      # @param data [Hash] The invite information
+      # @return [Array]
+      # @see https://docs.gitlab.com/ee/api/invitations.html#add-a-member-to-a-group-or-project GitLab API > Invitations > Add a member to 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)
+      #   data = {
+      #     email: 'bob@example.com',
+      #     access_level: 50
+      #   }
+      #   invite = Readiness::GitLab::Projects.create_invitation!(client, project, data)
+      #   pp invite
+      #   # => {"status"=>"success"}
+      # @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)
+      #   data = {
+      #     user_id: 123456,
+      #     access_level: 40
+      #   }
+      #   invite = Readiness::GitLab::Projects.create_invitation!(client, project, data)
+      #   pp invite
+      #   # => {"status"=>"success"}
+      def self.create_invitation!(client, project, data)
+        response = client.connection.post "projects/#{project.id}/invitations", data.to_json
+        handle_request_error(1, 'GitLab', response.status, { action: 'Invite people', id: project.id }) unless response.status == 200
+        Oj.load(response.body)
+      end      
     end
   end
 end

data/lib/support_readiness/gitlab.rb

@@ -17,6 +17,7 @@ module Readiness
     require "#{__dir__}/gitlab/merge_requests"
     require "#{__dir__}/gitlab/namespaces"
     require "#{__dir__}/gitlab/pipelines"
+    require "#{__dir__}/gitlab/project_webhooks"
     require "#{__dir__}/gitlab/projects"
     require "#{__dir__}/gitlab/repositories"
     require "#{__dir__}/gitlab/users"

data/lib/support_readiness/salesforce/subscription_definitions.rb

@@ -671,10 +671,18 @@ module Readiness
       # @return [Array]
       def self.ss_success_signature
         [
-          'Success Signature - 1 Year',
-          'Success Signature - 2 Year',
-          'Success Signature - 3 Year',
-          'Success Signature - Monthly'
+          'Dedicated - Success Signature - 1 Year',
+          'Dedicated - Success Signature - 2 Year',
+          'Dedicated - Success Signature - 3 Year',
+          'Dedicated - Success Signature - Monthly',
+          'SaaS - Success Signature - 1 Year',
+          'SaaS - Success Signature - 3 Year',
+          'SaaS - Success Signature - Monthly',
+          'SaaS - Success Signature - 2 Year',
+          'Self-Managed - Success Signature - 1 Year',
+          'Self-Managed - Success Signature - 2 Year',
+          'Self-Managed - Success Signature - 3 Year',
+          'Self-Managed - Success Signature - Monthly'
         ]
       end
     end

data/lib/support_readiness/ticket_processor/cmp_creation.rb

@@ -0,0 +1,282 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module TicketProcessor
+  module TicketProcessor
+    ##
+    # Defines the class CMPCreation within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.124
+    class CMPCreation < Readiness::Client
+      ##
+      # Process a CMP Creation request
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.process!(zendesk_client, gitlab_client, email_list)
+        @zendesk_client = zendesk_client
+        @gitlab_client = gitlab_client
+        @email_list = email_list
+        @project = create_project
+        create_readme_file
+        create_webhook
+        populate_contacts_file
+        send_invitations
+        update_organization
+        update_ticket
+      end
+
+      ##
+      # Fetches the ticket
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.ticket
+        @ticket ||= Readiness::Zendesk::Tickets.find!(@zendesk_client, ENV.fetch('TICKET_ID'))
+      end
+
+      ##
+      # Fetches the organization
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.organization
+        @organization ||= Readiness::Zendesk::Organizations.find!(@zendesk_client, ticket.organization_id)
+      end
+
+      ##
+      # Fetches the organization users
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.organization_users
+        @organization_users ||= Readiness::Zendesk::Organizations.users(@zendesk_client, organization)
+      end
+
+      ##
+      # Creates the actual CMP project
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.create_project
+        new_project = Readiness::GitLab::Projects.new
+        new_project.name = "Organization #{organization.id}"
+        new_project.path = "organization-#{organization.id}"
+        new_project.namespace_id = ENV.fetch('GROUP_ID')
+        new_project.analytics_access_level = 'disabled'
+        new_project.approvals_before_merge = 0
+        new_project.auto_cancel_pending_pipelines = 'enabled'
+        new_project.auto_devops_deploy_strategy = 'continuous'
+        new_project.auto_devops_enabled = false
+        new_project.autoclose_referenced_issues = true
+        new_project.build_timeout = 3600
+        new_project.ci_config_path = ''
+        new_project.ci_forward_deployment_enabled = false
+        new_project.container_expiration_policy = {
+          "cadence" => 'id',
+          "enabled" => false,
+          "keep_n" => 10,
+          "older_than" => '90d',
+          "name_regex" => '.*',
+          "name_regex_keep" => nil
+        }
+        new_project.container_registry_access_level = 'disabled'
+        new_project.container_registry_enabled = false
+        new_project.emails_disabled = false
+        new_project.emails_enabled = true
+        new_project.environments_access_level = 'disabled'
+        new_project.external_authorization_classification_label = ''
+        new_project.feature_flags_access_level = 'disabled'
+        new_project.forking_access_level = 'disabled'
+        new_project.group_runners_enabled = false
+        new_project.infrastructure_access_level = 'disabled'
+        new_project.issues_enabled = false
+        new_project.jobs_enabled = false
+        new_project.lfs_enabled = false
+        new_project.merge_method = 'merge'
+        new_project.merge_pipelines_enabled = false
+        new_project.merge_requests_enabled = true
+        new_project.merge_trains_enabled = false
+        new_project.merge_trains_skip_train_allowed = false
+        new_project.mirror = false
+        new_project.model_experiments_access_level = 'disabled'
+        new_project.model_registry_access_level = 'disabled'
+        new_project.monitor_access_level = 'disabled'
+        new_project.only_allow_merge_if_all_discussions_are_resolved = false
+        new_project.only_allow_merge_if_pipeline_succeeds = false
+        new_project.packages_enabled = false
+        new_project.pages_access_level = 'disabled'
+        new_project.printing_merge_request_link_enabled = true
+        new_project.public_jobs = true
+        new_project.releases_access_level = 'disabled'
+        new_project.remove_source_branch_after_merge = true
+        new_project.request_access_enabled = false
+        new_project.requirements_access_level = 'disabled'
+        new_project.requirements_enabled = false
+        new_project.resolve_outdated_diff_discussions = false
+        new_project.security_and_compliance_access_level = 'disabled'
+        new_project.service_desk_enabled = false
+        new_project.shared_runners_enabled = false
+        new_project.snippets_enabled = false
+        new_project.squash_option = 'default_off'
+        new_project.visibility = private
+        new_project.warn_about_potentially_unwanted_characters = true
+        new_project.wiki_enabled = false
+        Readiness::GitLab::Projects.create!(@gitlab_client, new_project)
+      end
+
+      ##
+      # Creates the CMP project's webhook
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.create_webhook
+        token = ENV.fetch('CMP_TOKEN')
+        new_hook = Readiness::GitLab::ProjectWebhooks.new
+        new_hook.url = "https://gitlab.com/api/v4/projects/39250741/ref/master/trigger/pipeline?token=#{token}&variables[PROJECT_ID]=#{@project.id}"
+        new_hook.push_events = true
+        new_hook.alert_status = 'executable'
+        new_hook.push_events_branch_filter = 'master'
+        new_hook.branch_filter_strategy = 'wildcard'
+        new_hook.project_id = @project.id
+        Readiness::GitLab::ProjectWebhooks.create!(@gitlab_client, new_hook)
+      end
+
+      ##
+      # Makes a commit to populate contacts.yaml
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.populate_contacts_file
+        commit_params = {
+          branch: 'master',
+          commit_message: 'Populating initial contacts',
+          actions: [
+            {
+              file_path: 'contacts.yaml',
+              content: yaml_contents,
+              action: 'create'
+            }
+          ]
+        }
+        Readiness::GitLab::Repositories.create_commit!(@gitlab_client, @project, commit_params)
+      end
+  
+      ##
+      # Makes a commit to populate README.md
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.create_readme_file
+        commit_params = {
+          branch: 'master',
+          commit_message: 'Creating CONTACTS.md file',
+          actions: [
+            {
+              file_path: 'CONTACTS.md',
+              content: readme_contents,
+              action: 'create'
+            }
+          ]
+        }
+        Readiness::GitLab::Repositories.create_commit!(@gitlab_client, @project, commit_params)
+      end
+
+      ##
+      # Returns the contents for the contacts.yaml file
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.yaml_contents
+        {
+          'org_id' => organization.id,
+          'contacts' => organization_users.map { |a| { "name" => a.name, "email" => a.email } }
+        }.to_yaml
+      end
+
+      ##
+      # Returns the contents for the README.md file
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.readme_contents
+        <<~STRING
+          # Zendesk Global Organization Contact Syncing
+
+          For more information, please see [our documentation](https://support.gitlab.com/hc/en-us/articles/14142703050396-Contact-Management-Projects)
+
+          ## What should I do if it didn’t work?
+
+          Please open a ticket with ops:
+
+          https://support.gitlab.com/hc/en-us/requests/new?ticket_form_id=360001801419        
+        STRING
+      end
+
+      ##
+      # Creates project invitations
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.send_invitations
+        @email_list.each do |e|
+          data = {
+            email: e,
+            access_level: 30
+          }
+          Readiness::GitLab::Projects.create_invitation!(@gitlab_client, @project, data)
+        end
+      end
+
+      ##
+      # Adds the CMP ID to the organization
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.update_organization
+        new_org = Readiness::Zendesk::Organizations.new
+        new_org.id = organization.id
+        new_org.organization_fields = {
+          cmp_id: @project.id
+        }
+        Readiness::Zendesk::Organizations.update!(@zendesk_client, new_org)
+      end
+
+      ##
+      # Updates the ticket
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.update_ticket
+        new_ticket = Readiness::Zendesk::Tickets.new
+        new_ticket.id = ticket.id
+        new_ticket.status = 'pending'
+        new_ticket.comment = {
+          body: ticket_comment
+        }
+        Readiness::Zendesk::Tickets.update!(@zendesk_client, new_ticket)
+      end
+
+      ##
+      # Returns the contents for the ticket comment
+      #
+      # @author Jason Colyer
+      # @since 1.0.124
+      def self.ticket_comment
+        <<~STRING
+          Greetings,
+
+          We have setup your contact management project at this time. You can find it at #{@project.web_url}
+
+          Any developer without a gitlab.com account should receive an email for the invitation to the project. Any developer with a gitlab.com should be auto-added.
+
+          We have seeded the contacts.yaml file with your organization's current contact list to help get you started.
+
+          Please let us know if you encounter any issues in the use of the contacts management project.
+        STRING
+      end
+    end
+  end
+end

data/lib/support_readiness/ticket_processor.rb

@@ -9,6 +9,7 @@ module Readiness
   module TicketProcessor
     require "#{__dir__}/ticket_processor/2fa_removal"
     require "#{__dir__}/ticket_processor/account_blocked"
+    require "#{__dir__}/ticket_processor/cmp_creation"
     require "#{__dir__}/ticket_processor/code_request_advanced_sast"
     require "#{__dir__}/ticket_processor/email_suppressions"
     require "#{__dir__}/ticket_processor/link_tagger"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.122
+  version: 1.0.124
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-17 00:00:00.000000000 Z
+date: 2025-02-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -280,6 +280,7 @@ files:
 - lib/support_readiness/gitlab/merge_requests.rb
 - lib/support_readiness/gitlab/namespaces.rb
 - lib/support_readiness/gitlab/pipelines.rb
+- lib/support_readiness/gitlab/project_webhooks.rb
 - lib/support_readiness/gitlab/projects.rb
 - lib/support_readiness/gitlab/repositories.rb
 - lib/support_readiness/gitlab/users.rb
@@ -393,6 +394,7 @@ files:
 - lib/support_readiness/ticket_processor.rb
 - lib/support_readiness/ticket_processor/2fa_removal.rb
 - lib/support_readiness/ticket_processor/account_blocked.rb
+- lib/support_readiness/ticket_processor/cmp_creation.rb
 - lib/support_readiness/ticket_processor/code_request_advanced_sast.rb
 - lib/support_readiness/ticket_processor/email_suppressions.rb
 - lib/support_readiness/ticket_processor/link_tagger.rb