gitlab_support_readiness 1.0.41 → 1.0.42

data/lib/support_readiness/support_super_form_processor/usgov_set_org_ase.rb

@@ -0,0 +1,295 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class USGovSetOrgASE within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class USGovSetOrgASE < Readiness::Client
+      ##
+      # Process setting an ASE on a US Government organization
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(gitlab_client, gitlab_admin_client, zendesk_client, redis_client)
+        @gitlab_client = gitlab_client
+        @gitlab_admin_client = gitlab_admin_client
+        @zendesk_client = zendesk_client
+        @redis_client = redis_client
+        requester
+        bad_requester unless approved_requester?
+        org_does_not_exist if org.is_a? Hash
+        invalid_agent unless agent_valid?
+        new_org = Readiness::Zendesk::Organizations.new
+        new_org.id = org.id
+        new_org.custom_fields = {
+          "assigned_se" => agent_info
+        }
+        Readiness::Zendesk::Organizations.update!(@zendesk_client, new_org)
+        issue = Readiness::GitLab::Issues.new
+        issue.title = "Set an Assigned Support Engineer for a Zendesk US Goverment organization - #{org.id}"
+        issue.description = message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      def self.bad_requester
+        issue = Readiness::GitLab::Issues.new
+        issue.title = 'Invalid Request - Not approved to make this request'
+        issue.description = bad_requester_message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      def self.org_does_not_exist
+        issue = Readiness::GitLab::Issues.new
+        issue.title = 'Invalid Request - Organization Not Found'
+        issue.description = org_does_not_exist_message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      def self.invalid_agent
+        issue = Readiness::GitLab::Issues.new
+        issue.title = 'Invalid Request - Invalid agent provided'
+        issue.description = invalid_user_message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      ##
+      # Determines if the requester is authorized to make the request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.approved_requester?
+        return true if approved_requester_list.map { |t| t['email'] }.include? requester_email
+
+        false
+      end
+
+      ##
+      # Sets the global variable approved_requester_list
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.approved_requester_list
+        @approved_requester_list ||= determine_approved_requesters
+      end
+
+      ##
+      # Determines the list of approved requesters
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.determine_approved_requesters
+        members = []
+        directors = team.select { |t| t['title'] =~ /Director/ }
+        members += directors.select { |t| t['region'] =~ /AMER/ }
+        managers = team.select { |t| t['title'] =~ /Manager/ }
+        members += managers.select { |t| t['zendesk']['us-federal']['role'] == 'Administrator' }
+        members
+      end
+
+      ##
+      # Determines if the agent to use is valid
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.agent_valid?
+        return true if agent_id == 'None'
+        return false if agent.is_a? Hash
+        return false if agent.role == 'end-user'
+        return false if agent.suspended
+        return false if agent.custom_role_id == 360008074111
+
+        true
+      end
+
+      ##
+      # Returns the value to set the organization field to
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.agent_info
+        return '' if agent_id == 'None'
+
+        agent.id
+      end
+
+      ##
+      # Sets the global variable team
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.team
+        @team ||= Readiness::Redis.get(@redis_client, 'support_team')
+      end
+
+      ##
+      # Sets the global variable requester
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.requester
+        @requester ||= Readiness::SupportSuperFormProcessor::Shared.gitlab_user_check(@gitlab_admin_client, requester_email)
+      end
+
+      ##
+      # Sets the global variable requester_email
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.requester_email
+        @requester_email ||= ENV.fetch('REQUESTER_EMAIL')
+      end
+
+      ##
+      # Sets the global variable project
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.project
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+      end
+
+      ##
+      # Sets the global variable org
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.org
+        @org ||= Readiness::Zendesk::Organizations.find(@zendesk_client, org_id)
+      end
+
+      ##
+      # Sets the global variable org_id
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.org_id
+        @org_id ||= ENV.fetch('ZENDESK_USGOV_ORGANIZATION_ID')
+      end
+
+      ##
+      # Sets the global variable agent
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.agent
+        @agent ||= Readiness::Zendesk::Users.find(@zendesk_client, agent_id)
+      end
+
+      ##
+      # Sets the global variable agent_id
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.agent_id
+        @agent_id ||= ENV.fetch('ZENDESK_USGOV_ORGANIZATION_ASE_ID')
+      end
+
+      ##
+      # Returns the issue description
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.message
+        <<~STRING
+          ## Set an Assigned Support Engineer for a Zendesk US Goverment organization - #{org.id}
+
+          Greetings @#{requester.username} !
+
+          We have set the Assigned Support Engineer of the Zendesk US Goverment organization to that of #{agent_id} at this time.
+
+          If that is not the ID of the agent you were intending to use, please review the Zendesk agent you were wanting to use once more and file a new submission.
+
+          If you need assistance in locating the agent's ID, please ask in the Slack channel [#support_operations](https://gitlab.slack.com/archives/C018ZGZAMPD)
+
+          /label ~"AutomatedRequests::Set Org ASE"
+
+          /assign @#{requester.username}
+        STRING
+      end
+
+      ##
+      # Returns the issue description
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.org_does_not_exist_message
+        <<~STRING
+          ## Invalid Request Organization Not Found
+
+          Greetings @#{requester.username} !
+
+          We received a request from you recently, however the organization ID given #{org_id} is not a valid Zendesk US Goverment Organization ID. As such, we are not able to proceed.
+
+          Please review the Zendesk US Goverment organization you were wanting to use once more and file a new submission.
+
+          If you need assistance in locating the organization's ID, please ask in the Slack channel [#support_operations](https://gitlab.slack.com/archives/C018ZGZAMPD)
+
+          /label ~"AutomatedRequests::Invalid Organization"
+
+          /label ~"Invalid Zendesk US Goverment organization given"
+
+          /assign @#{requester.username}
+        STRING
+      end
+
+      def self.bad_requester_message
+        <<~STRING
+          ## Invalid Request - Not approved to make this request
+
+          Greetings @#{requester.username} !
+
+          We received a request from you recently to set an ASE on a Zendesk US Goverment organization, however this type of request can only be made by specifc approved persons.
+
+          Please contact one fo the following via [#support_leadership](https://gitlab.enterprise.slack.com/archives/C01F9S37AKT) to discuss this request:
+
+          #{approved_requester_list.map { |a| "- #{a['email']}" }.join("\n")}
+
+          /label ~"AutomatedRequests::Invalid Permissions"
+
+          /assign @#{requester.username}
+        STRING
+      end
+
+      ##
+      # Returns the issue description for an invalid user
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.invalid_user_message
+        <<~STRING
+          ## Set an Assigned Support Engineer for a Zendesk US Goverment organization - #{org.id}
+
+          Greetings @#{requester.username} !
+
+          We were unable to set the ASE on the Zendesk US Goverment organization at this time, as we were encountered one of the following issues with the Zendesk US Government agent with the ID of #{agent_id}:
+
+          - The agent does not exist
+          - The agent does not have write permissions on tickets
+          - The agent is suspended
+          - The agent is an end-user
+
+          Please review the Zendesk agent you were wanting to use once more and file a new submission.
+
+          If you need assistance in locating the agent's ID, please ask in the Slack channel [#support_operations](https://gitlab.slack.com/archives/C018ZGZAMPD)
+
+          /label ~"AutomatedRequests::Set Org ASE" ~"SupportOps::Blocked"
+
+          /assign @#{requester.username}
+        STRING
+      end
+    end
+  end
+end

data/lib/support_readiness/support_super_form_processor.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  ##
+  # Defines the module SupportSuperFormProcessor
+  # @author Jason Colyer
+  # @since 1.0.42
+  module SupportSuperFormProcessor
+    # Needs to be first
+    require "#{__dir__}/support_super_form_processor/shared"
+    
+    require "#{__dir__}/support_super_form_processor/create_article"
+    require "#{__dir__}/support_super_form_processor/create_macro"
+    require "#{__dir__}/support_super_form_processor/edit_macro"
+    require "#{__dir__}/support_super_form_processor/enable_us_government"
+    require "#{__dir__}/support_super_form_processor/global_ir_dotcom_subscriptions_billing_entity_change"
+    require "#{__dir__}/support_super_form_processor/global_ir_dotcom_subscriptions_extension"
+    require "#{__dir__}/support_super_form_processor/global_ir_dotcom_subscriptions_investigate"
+    require "#{__dir__}/support_super_form_processor/global_ir_dotcom_subscriptions_link"
+    require "#{__dir__}/support_super_form_processor/global_ir_dotcom_subscriptions_nfr"
+    require "#{__dir__}/support_super_form_processor/global_ir_dotcom_subscriptions_reset_seat_qsr"
+    require "#{__dir__}/support_super_form_processor/global_ir_dotcom_trials_edit"
+    require "#{__dir__}/support_super_form_processor/global_ir_dotcom_trials_extension"
+    require "#{__dir__}/support_super_form_processor/global_ir_dotcom_trials_over_plan"
+    require "#{__dir__}/support_super_form_processor/global_ir_hackerone_license"
+    require "#{__dir__}/support_super_form_processor/global_ir_oem_license"
+    require "#{__dir__}/support_super_form_processor/global_ir_order_management"
+    require "#{__dir__}/support_super_form_processor/global_ir_other"
+    require "#{__dir__}/support_super_form_processor/global_ir_provison_failure"
+    require "#{__dir__}/support_super_form_processor/global_ir_sm_subscriptions_did_not_receive"
+    require "#{__dir__}/support_super_form_processor/global_ir_sm_subscriptions_multiyear"
+    require "#{__dir__}/support_super_form_processor/global_ir_sm_subscriptions_nfr"
+    require "#{__dir__}/support_super_form_processor/global_ir_sm_subscriptions_resend"
+    require "#{__dir__}/support_super_form_processor/global_ir_sm_subscriptions_scl"
+    require "#{__dir__}/support_super_form_processor/global_ir_sm_subscriptions_temp"
+    require "#{__dir__}/support_super_form_processor/global_ir_sm_trials_edit"
+    require "#{__dir__}/support_super_form_processor/global_ir_sm_trials_extension"
+    require "#{__dir__}/support_super_form_processor/global_ir_sm_trials_new"
+    require "#{__dir__}/support_super_form_processor/global_ir_wider_community_license"
+    require "#{__dir__}/support_super_form_processor/global_set_collaboration_id"
+    require "#{__dir__}/support_super_form_processor/global_toggle_escalation"
+    require "#{__dir__}/support_super_form_processor/gratis_support_extension"
+    require "#{__dir__}/support_super_form_processor/gratis_support_former_customer"
+    require "#{__dir__}/support_super_form_processor/gratis_support_migration"
+    require "#{__dir__}/support_super_form_processor/gratis_support_other"
+    require "#{__dir__}/support_super_form_processor/gratis_support_prospect"
+    require "#{__dir__}/support_super_form_processor/gratis_support_upgrade"
+    require "#{__dir__}/support_super_form_processor/namespace_availability"
+    require "#{__dir__}/support_super_form_processor/pd_shadow_modification"
+    require "#{__dir__}/support_super_form_processor/team_member_license"
+    require "#{__dir__}/support_super_form_processor/two_fa_exemption"
+    require "#{__dir__}/support_super_form_processor/usgov_ir_order_management"
+    require "#{__dir__}/support_super_form_processor/usgov_ir_other"
+    require "#{__dir__}/support_super_form_processor/usgov_ir_sm_subs_did_not_receive"
+    require "#{__dir__}/support_super_form_processor/usgov_ir_sm_subs_multiyear"
+    require "#{__dir__}/support_super_form_processor/usgov_ir_sm_subs_nfr"
+    require "#{__dir__}/support_super_form_processor/usgov_ir_sm_subs_resend"
+    require "#{__dir__}/support_super_form_processor/usgov_ir_sm_subs_scl"
+    require "#{__dir__}/support_super_form_processor/usgov_ir_sm_subs_temp"
+    require "#{__dir__}/support_super_form_processor/usgov_ir_sm_trials_edit"
+    require "#{__dir__}/support_super_form_processor/usgov_ir_sm_trials_extension"
+    require "#{__dir__}/support_super_form_processor/usgov_ir_sm_trials_new"
+    require "#{__dir__}/support_super_form_processor/usgov_set_collaboration_id"
+    require "#{__dir__}/support_super_form_processor/usgov_set_org_ase"
+  end
+end

data/lib/support_readiness.rb

@@ -42,4 +42,5 @@ require "#{__dir__}/support_readiness/redis"
 require "#{__dir__}/support_readiness/repos"
 require "#{__dir__}/support_readiness/salesforce"
 require "#{__dir__}/support_readiness/slack"
+require "#{__dir__}/support_readiness/support_super_form_processor"
 require "#{__dir__}/support_readiness/zendesk"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.41
+  version: 1.0.42
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-11-13 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -315,6 +315,63 @@ files:
 - lib/support_readiness/slack/client.rb
 - lib/support_readiness/slack/configuration.rb
 - lib/support_readiness/slack/messages.rb
+- lib/support_readiness/support_super_form_processor.rb
+- lib/support_readiness/support_super_form_processor/create_article.rb
+- lib/support_readiness/support_super_form_processor/create_macro.rb
+- lib/support_readiness/support_super_form_processor/edit_macro.rb
+- lib/support_readiness/support_super_form_processor/enable_us_government.rb
+- lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_billing_entity_change.rb
+- lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb
+- lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_investigate.rb
+- lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_link.rb
+- lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_nfr.rb
+- lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_reset_seat_qsr.rb
+- lib/support_readiness/support_super_form_processor/global_ir_dotcom_trials_edit.rb
+- lib/support_readiness/support_super_form_processor/global_ir_dotcom_trials_extension.rb
+- lib/support_readiness/support_super_form_processor/global_ir_dotcom_trials_over_plan.rb
+- lib/support_readiness/support_super_form_processor/global_ir_hackerone_license.rb
+- lib/support_readiness/support_super_form_processor/global_ir_oem_license.rb
+- lib/support_readiness/support_super_form_processor/global_ir_order_management.rb
+- lib/support_readiness/support_super_form_processor/global_ir_other.rb
+- lib/support_readiness/support_super_form_processor/global_ir_provison_failure.rb
+- lib/support_readiness/support_super_form_processor/global_ir_sm_subscriptions_did_not_receive.rb
+- lib/support_readiness/support_super_form_processor/global_ir_sm_subscriptions_multiyear.rb
+- lib/support_readiness/support_super_form_processor/global_ir_sm_subscriptions_nfr.rb
+- lib/support_readiness/support_super_form_processor/global_ir_sm_subscriptions_resend.rb
+- lib/support_readiness/support_super_form_processor/global_ir_sm_subscriptions_scl.rb
+- lib/support_readiness/support_super_form_processor/global_ir_sm_subscriptions_temp.rb
+- lib/support_readiness/support_super_form_processor/global_ir_sm_trials_edit.rb
+- lib/support_readiness/support_super_form_processor/global_ir_sm_trials_extension.rb
+- lib/support_readiness/support_super_form_processor/global_ir_sm_trials_new.rb
+- lib/support_readiness/support_super_form_processor/global_ir_wider_community_license.rb
+- lib/support_readiness/support_super_form_processor/global_set_collaboration_id.rb
+- lib/support_readiness/support_super_form_processor/global_set_org_ase.rb
+- lib/support_readiness/support_super_form_processor/global_toggle_escalation.rb
+- lib/support_readiness/support_super_form_processor/gratis_support_extension.rb
+- lib/support_readiness/support_super_form_processor/gratis_support_former_customer.rb
+- lib/support_readiness/support_super_form_processor/gratis_support_migration.rb
+- lib/support_readiness/support_super_form_processor/gratis_support_other.rb
+- lib/support_readiness/support_super_form_processor/gratis_support_prospect.rb
+- lib/support_readiness/support_super_form_processor/gratis_support_upgrade.rb
+- lib/support_readiness/support_super_form_processor/namespace_availability.rb
+- lib/support_readiness/support_super_form_processor/pd_shadow_modification.rb
+- lib/support_readiness/support_super_form_processor/sa_request_for_support.rb
+- lib/support_readiness/support_super_form_processor/shared.rb
+- lib/support_readiness/support_super_form_processor/team_member_license.rb
+- lib/support_readiness/support_super_form_processor/two_fa_exemption.rb
+- lib/support_readiness/support_super_form_processor/usgov_ir_order_management.rb
+- lib/support_readiness/support_super_form_processor/usgov_ir_other.rb
+- lib/support_readiness/support_super_form_processor/usgov_ir_sm_subs_did_not_receive.rb
+- lib/support_readiness/support_super_form_processor/usgov_ir_sm_subs_multiyear.rb
+- lib/support_readiness/support_super_form_processor/usgov_ir_sm_subs_nfr.rb
+- lib/support_readiness/support_super_form_processor/usgov_ir_sm_subs_resend.rb
+- lib/support_readiness/support_super_form_processor/usgov_ir_sm_subs_scl.rb
+- lib/support_readiness/support_super_form_processor/usgov_ir_sm_subs_temp.rb
+- lib/support_readiness/support_super_form_processor/usgov_ir_sm_trials_edit.rb
+- lib/support_readiness/support_super_form_processor/usgov_ir_sm_trials_extension.rb
+- lib/support_readiness/support_super_form_processor/usgov_ir_sm_trials_new.rb
+- lib/support_readiness/support_super_form_processor/usgov_set_collaboration_id.rb
+- lib/support_readiness/support_super_form_processor/usgov_set_org_ase.rb
 - lib/support_readiness/zendesk.rb
 - lib/support_readiness/zendesk/app_job_statuses.rb
 - lib/support_readiness/zendesk/apps.rb