gitlab_support_readiness 1.0.41 → 1.0.43

data/lib/support_readiness/support_super_form_processor/usgov_ir_sm_trials_extension.rb

@@ -0,0 +1,219 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class USGovIRSMTrialsExtension within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class USGovIRSMTrialsExtension < Readiness::Client
+      ##
+      # Process a US Government Internal Request Self-Managed Trials Extension request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(gitlab_client, gitlab_admin_client, zendesk_client)
+        @gitlab_client = gitlab_client
+        @gitlab_admin_client = gitlab_admin_client
+        @zendesk_client = zendesk_client
+        requester
+        zd_user
+        ticket = Readiness::Zendesk::Tickets.new
+        ticket.requester_id = zd_user.id
+        ticket.submitter_id = zd_user.id
+        ticket.comment = { html_body: body }
+        ticket.subject = 'Internal Request - SM - Extend an existing trial'
+        ticket.tags = %w[lnr_internal_request lnr_valid_request lnr_sm_trial lnr_sm_trial_extension]
+        ticket.priority = 'normal'
+        ticket.status = 'new'
+        ticket.ticket_form_id = 360001803151
+        ticket.custom_fields = [
+          { id: 11717320292244, value: 'ir_extend_sm_trial' },
+          { id: 11717222771604,  value: zd_user.email }
+        ]
+        create = Readiness::Zendesk::Tickets.create!(@zendesk_client, ticket)
+        puts "Ticket created: https://gitlab-federal-support.zendesk.com/agent/tickets/#{create.id}"
+      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 zd_user
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.zd_user
+        @zd_user ||= Readiness::SupportSuperFormProcessor::Shared.zendesk_user_check(@zendesk_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 context
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.context
+        @context ||= ENV.fetch('INTERNAL_REQUEST_USFED_CONTEXT')
+      end
+
+      ##
+      # Sets the global variable contact_name
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.contact_name
+        @contact_name ||= ENV.fetch('INTERNAL_REQUEST_USFED_CONTACT_NAME')
+      end
+
+      ##
+      # Sets the global variable contact_email
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.contact_email
+        @contact_email ||= ENV.fetch('INTERNAL_REQUEST_USFED_EMAIL')
+      end
+
+      ##
+      # Sets the global variable company
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.company
+        @company ||= ENV.fetch('INTERNAL_REQUEST_USFED_COMPANY_NAME')
+      end
+
+      ##
+      # Sets the global variable license_link
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.license_link
+        @license_link ||= ENV.fetch('USFED_SM_TRIAL_EXTEND_LICENSE')
+      end
+
+      ##
+      # Sets the global variable current
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.current
+        @current ||= ENV.fetch('USFED_SM_TRIAL_EXTEND_USERS')
+      end
+
+      ##
+      # Sets the global variable plan
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.plan
+        @plan ||= ENV.fetch('USFED_SM_TRIAL_EXTEND_PLAN')
+      end
+
+      ##
+      # Sets the global variable expiration
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.expiration
+        @expiration ||= ENV.fetch('USFED_SM_TRIAL_EXTEND_CURRENT_EXPIRATION')
+      end
+
+      ##
+      # Sets the global variable extension_date
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.extension_date
+        @extension_date ||= ENV.fetch('USFED_SM_TRIAL_EXTEND_NEW_EXPIRATION')
+      end
+
+      ##
+      # Sets the global variable reason
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.reason
+        @reason ||= ENV.fetch('USFED_SM_TRIAL_EXTEND_REASON')
+      end
+
+      ##
+      # Sets the global variable sfdc_account
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.sfdc_account
+        @sfdc_account ||= ENV.fetch('INTERNAL_REQUEST_USFED_SFDC_ACCOUNT')
+      end
+
+      ##
+      # Sets the global variable version
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.version
+        @version ||= ENV.fetch('INTERNAL_REQUEST_USFED_VERSION')
+      end
+
+      ##
+      # Returns the ticket body
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.body
+        <<~STRING
+          <p>
+            Greetings
+          </p>
+          <p>
+            Please note that this is an <b>INTERNAL</b> ticket and should <b>NEVER</b> be shared with anyone. Please do not CC, BCC, forward, or anything else that can send the information from this ticket. <b>NEVER</b> add <i>anyone</i> outside of GitLab to this ticket or communications stemming from this ticket.
+          </p>
+          <p>
+            A request has been filed for Extend an existing Self-managed trial.
+          </p>
+          <p>
+            The information for this is as follows:
+          </p>
+          <ul>
+            <li>Contact's name: #{contact_name}</li>
+            <li>Contact's email: #{contact_email}</li>
+            <li>Company: #{company}</li>
+            <li>Current license: #{license_link}</li>
+            <li>Current license expiration date: #{expiration}</li>
+            <li>Desired expiration date: #{extension_date}</li>
+            <li>User count: #{current}</li>
+            <li>Plan: #{plan}</li>
+            <li>#{Readiness::SupportSuperFormProcessor::Shared.sfdc_account_string(sfdc_account)}</li>
+            <li>Reason for extension: #{reason}</li>
+            <li>GitLab Version: #{version}</li>
+          </ul>
+          <p>
+            Some additional context for this request is:
+          </p>
+          <pre>
+            #{context}
+          </pre>
+        STRING
+      end
+    end
+  end
+end

data/lib/support_readiness/support_super_form_processor/usgov_ir_sm_trials_new.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class USGovIRSMTrialsNew within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class USGovIRSMTrialsNew < Readiness::Client
+      ##
+      # Process a US Government Internal Request Self-Managed Trials New request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(gitlab_client, gitlab_admin_client, zendesk_client)
+        @gitlab_client = gitlab_client
+        @gitlab_admin_client = gitlab_admin_client
+        @zendesk_client = zendesk_client
+        requester
+        zd_user
+        ticket = Readiness::Zendesk::Tickets.new
+        ticket.requester_id = zd_user.id
+        ticket.submitter_id = zd_user.id
+        ticket.comment = { html_body: body }
+        ticket.subject = 'Internal Request - SM - Problems starting a new trial'
+        ticket.tags = %w[lnr_internal_request lnr_valid_request lnr_sm_trial lnr_sm_trial_new]
+        ticket.priority = 'normal'
+        ticket.status = 'new'
+        ticket.ticket_form_id = 360001803151
+        ticket.custom_fields = [
+          { id: 11717320292244, value: 'ir_issues_sm_trial' },
+          { id: 11717222771604,  value: zd_user.email }
+        ]
+        create = Readiness::Zendesk::Tickets.create!(@zendesk_client, ticket)
+        puts "Ticket created: https://gitlab-federal-support.zendesk.com/agent/tickets/#{create.id}"
+      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 zd_user
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.zd_user
+        @zd_user ||= Readiness::SupportSuperFormProcessor::Shared.zendesk_user_check(@zendesk_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 context
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.context
+        @context ||= ENV.fetch('INTERNAL_REQUEST_USFED_CONTEXT')
+      end
+
+      ##
+      # Sets the global variable contact_name
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.contact_name
+        @contact_name ||= ENV.fetch('INTERNAL_REQUEST_USFED_CONTACT_NAME')
+      end
+
+      ##
+      # Sets the global variable contact_email
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.contact_email
+        @contact_email ||= ENV.fetch('INTERNAL_REQUEST_USFED_EMAIL')
+      end
+
+      ##
+      # Sets the global variable company
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.company
+        @company ||= ENV.fetch('INTERNAL_REQUEST_USFED_COMPANY_NAME')
+      end
+
+      ##
+      # Sets the global variable start_date
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.start_date
+        @start_date ||= ENV.fetch('USFED_SM_TRIAL_NEW_START_DATE')
+      end
+
+      ##
+      # Sets the global variable end_date
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.end_date
+        @end_date ||= ENV.fetch('USFED_SM_TRIAL_NEW_END_DATE')
+      end
+
+      ##
+      # Sets the global variable current
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.current
+        @current ||= ENV.fetch('USFED_SM_TRIAL_NEW_USERS')
+      end
+
+      ##
+      # Sets the global variable plan
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.plan
+        @plan ||= ENV.fetch('USFED_SM_TRIAL_NEW_PLAN')
+      end
+
+      ##
+      # Sets the global variable reason
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.reason
+        @reason ||= ENV.fetch('USFED_SM_TRIAL_NEW_REASON')
+      end
+
+      ##
+      # Sets the global variable sfdc_account
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.sfdc_account
+        @sfdc_account ||= ENV.fetch('INTERNAL_REQUEST_USFED_SFDC_ACCOUNT')
+      end
+
+      ##
+      # Sets the global variable version
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.version
+        @version ||= ENV.fetch('INTERNAL_REQUEST_USFED_VERSION')
+      end
+
+      ##
+      # Returns the ticket body
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.body
+        <<~STRING
+          <p>
+            Greetings
+          </p>
+          <p>
+            Please note that this is an <b>INTERNAL</b> ticket and should <b>NEVER</b> be shared with anyone. Please do not CC, BCC, forward, or anything else that can send the information from this ticket. <b>NEVER</b> add <i>anyone</i> outside of GitLab to this ticket or communications stemming from this ticket.
+          </p>
+          <p>
+            A request has been filed for Problems starting a new Self-managed trial .
+          </p>
+          <p>
+            The information for this is as follows:
+          </p>
+          <ul>
+            <li>Contact's name: #{contact_name}</li>
+            <li>Contact's email: #{contact_email}</li>
+            <li>Company: #{company}</li>
+            <li>Trial start date: #{start_date}</li>
+            <li>Desired trial end date: #{end_date}</li>
+            <li>Trial seat count: #{current}</li>
+            <li>Trial plan: #{plan}</li>
+            <li>#{Readiness::SupportSuperFormProcessor::Shared.sfdc_account_string(sfdc_account)}</li>
+            <li>Reason user cannot start a trial: #{reason}</li>
+            <li>GitLab Version: #{version}</li>
+          </ul>
+          <p>
+            Some additional context for this request is:
+          </p>
+          <pre>
+            #{context}
+          </pre>
+        STRING
+      end
+    end
+  end
+end

data/lib/support_readiness/support_super_form_processor/usgov_set_collaboration_id.rb

@@ -0,0 +1,151 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class USGovSetCollaboriationID within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class USGovSetCollaboriationID < Readiness::Client
+      ##
+      # Process setting a collab ID on a US Government organization
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(gitlab_client, gitlab_admin_client, zendesk_client)
+        @gitlab_client = gitlab_client
+        @gitlab_admin_client = gitlab_admin_client
+        @zendesk_client = zendesk_client
+        requester
+        org_does_not_exist if org.is_a? Hash
+        new_org = Readiness::Zendesk::Organizations.new
+        new_org.id = org.id
+        new_org.custom_fields = {
+          "am_project_id" => collaboriation_project_id
+        }
+        Readiness::Zendesk::Organizations.update!(@zendesk_client, new_org)
+        issue = Readiness::GitLab::Issues.new
+        issue.title = "Set the collaboration project ID for a Zendesk US Government organization - #{org.id}"
+        issue.description = message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      ##
+      # Create issue when organization does not exist
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      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
+
+      ##
+      # 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 collaboriation_project_id
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.collaboriation_project_id
+        @collaboriation_project_id ||= ENV.fetch('ZENDESK_USGOV_ORGANIZATION_COLLAB_ID')
+      end
+
+      ##
+      # Returns the issue description
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.message
+        <<~STRING
+          ## Set the collaboration project ID for an Zendesk US Government organization - #{org.id}
+
+          Greetings @#{requester.username} !
+
+          We have set the collaboration project ID of the Zendesk US Government organization to that of #{collaboriation_project_id} at this time.
+
+          /label ~"AutomatedRequests::Set Org Collab ID"
+
+          /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 Government Organization ID. As such, we are not able to proceed.
+
+          Please review the Zendesk US Government 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 Government organization given"
+
+          /assign @#{requester.username}
+        STRING
+      end
+    end
+  end
+end