gitlab_support_readiness 1.0.41 → 1.0.42

data/lib/support_readiness/support_super_form_processor/global_ir_sm_trials_new.rb

@@ -0,0 +1,223 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class GlobalIRSMTrialsNew within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class GlobalIRSMTrialsNew < Readiness::Client
+      ##
+      # Process a Global 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.email_cc_ids = [zd_user.id]
+        ticket.requester_id = 379855863520
+        ticket.submitter_id = 379855863520
+        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 = request_priority
+        ticket.status = 'new'
+        ticket.ticket_form_id = 360000071293
+        ticket.custom_fields = [
+          { id: 4414446722578, value: 'ticket_group_not_applicable' },
+          { id: 360020614420,  value: 'aof_lnr' },
+          { id: 360020735259,  value: 'stage-frt' },
+          { id: 360018253094,  value: 'all_regions' },
+          { id: 360004394559,  value: 'free_plan' },
+          { id: 360005183820,  value: zd_user.name },
+          { id: 360005248219,  value: zd_user.email },
+          { id: 360020735319,  value: 'sev3' },
+          { id: 360020288373,  value: '0' },
+          { id: 360014776453,  value: 'medium' },
+          { id: 6978426204828, value: 'ir_issues_sm_trial' },
+          { id: 6978366086428, value: zd_user.email },
+          { id: 45195248,      value: 'created_by_agent' }
+        ]
+        create = Readiness::Zendesk::Tickets.create!(@zendesk_client, ticket)
+        puts "Ticket created: https://gitlab.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 request_priority
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.request_priority
+        @request_priority ||= ENV.fetch('INTERNAL_REQUEST_GLOBAL_PRIORITY')
+      end
+
+      ##
+      # Sets the global variable context
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.context
+        @context ||= ENV.fetch('INTERNAL_REQUEST_GLOBAL_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_GLOBAL_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_GLOBAL_EMAIL')
+      end
+
+      ##
+      # Sets the global variable company
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.company
+        @company ||= ENV.fetch('INTERNAL_REQUEST_GLOBAL_COMPANY_NAME')
+      end
+
+      ##
+      # Sets the global variable start_date
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.start_date
+        @start_date ||= ENV.fetch('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('SM_TRIAL_NEW_EXPIRATION')
+      end
+
+      ##
+      # Sets the global variable current
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.current
+        @current ||= ENV.fetch('SM_TRIAL_NEW_SEATS')
+      end
+
+      ##
+      # Sets the global variable plan
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.plan
+        @plan ||= ENV.fetch('SM_TRIAL_NEW_PLAN')
+      end
+
+      ##
+      # Sets the global variable sfdc_account_link
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.sfdc_account_link
+        @sfdc_account_link ||= ENV.fetch('SM_TRIAL_NEW_SFDC_ACCOUNT')
+      end
+
+      ##
+      # Sets the global variable reason
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.reason
+        @reason ||= ENV.fetch('SM_TRIAL_NEW_REASON')
+      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}
+              <a href="https://www.zuora.com/platform/apps/search?searchTerm=#{contact_email}" target='_blank'>(Zuora Search)</a>
+              <a href="https://customers.gitlab.com/admin/customer?model_name=customer&query=#{contact_email}" target='_blank'>(Portal Search)</a>
+            </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>Reason user cannot start a trial: #{reason}</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/global_ir_wider_community_license.rb

@@ -0,0 +1,247 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class GlobalIRWiderCommunityLicense within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class GlobalIRWiderCommunityLicense < Readiness::Client
+      ##
+      # Process a Global Internal Request Provision Failure 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
+        if Date.parse(expiration) > (Date.today + 3.months) && requester_email == approver
+          Readiness::SupportSuperFormProcessor::Shared.cannot_self_approve((requester_email))
+        end
+        ticket = Readiness::Zendesk::Tickets.new
+        ticket.email_cc_ids = [zd_user.id]
+        ticket.requester_id = 379855863520
+        ticket.submitter_id = 379855863520
+        ticket.comment = { html_body: body }
+        ticket.subject = 'Internal Request - SM - Wider Community License'
+        ticket.tags = %w[lnr_internal_request lnr_valid_request lnr_community_license]
+        ticket.priority = request_priority
+        ticket.status = 'new'
+        ticket.ticket_form_id = 360000071293
+        ticket.custom_fields = [
+          { id: 4414446722578, value: 'ticket_group_not_applicable' },
+          { id: 360020614420,  value: 'aof_lnr' },
+          { id: 360020735259,  value: 'stage-frt' },
+          { id: 360018253094,  value: 'all_regions' },
+          { id: 360004394559,  value: 'free_plan' },
+          { id: 360005183820,  value: zd_user.name },
+          { id: 360005248219,  value: zd_user.email },
+          { id: 360020735319,  value: 'sev3' },
+          { id: 360020288373,  value: '0' },
+          { id: 360014776453,  value: 'medium' },
+          { id: 6978426204828, value: 'ir_wcl' },
+          { id: 6978366086428, value: zd_user.email },
+          { id: 45195248,      value: 'created_by_agent' }
+        ]
+        create = Readiness::Zendesk::Tickets.create!(@zendesk_client, ticket)
+        puts "Ticket created: https://gitlab.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 request_priority
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.request_priority
+        @request_priority ||= ENV.fetch('INTERNAL_REQUEST_GLOBAL_PRIORITY')
+      end
+
+      ##
+      # Sets the global variable context
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.context
+        @context ||= ENV.fetch('INTERNAL_REQUEST_GLOBAL_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_GLOBAL_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_GLOBAL_EMAIL')
+      end
+
+      ##
+      # Sets the global variable company
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.company
+        @company ||= ENV.fetch('INTERNAL_REQUEST_GLOBAL_COMPANY_NAME')
+      end
+
+      ##
+      # Sets the global variable current
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.current
+        @current ||= ENV.fetch('WIDER_COMMUNITY_LICENSE_SEATS')
+      end
+
+      ##
+      # Sets the global variable previous
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.previous
+        @previous ||= ENV.fetch('WIDER_COMMUNITY_LICENSE_PREVIOUS')
+      end
+
+      ##
+      # Sets the global variable trueup
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.trueup
+        @trueup ||= ENV.fetch('WIDER_COMMUNITY_LICENSE_TRUEUPS')
+      end
+
+      ##
+      # Sets the global variable plan
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.plan
+        @plan ||= ENV.fetch('WIDER_COMMUNITY_LICENSE_PLAN')
+      end
+
+      ##
+      # Sets the global variable approver
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.approver
+        @approver ||= ENV.fetch('WIDER_COMMUNITY_LICENSE_APPROVER')
+      end
+
+      ##
+      # Sets the global variable expiration
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.expiration
+        @expiration ||= ENV.fetch('WIDER_COMMUNITY_LICENSE_EXPIRATION')
+      end
+
+      ##
+      # Sets the global variable reason
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.reason
+        @reason ||= ENV.fetch('WIDER_COMMUNITY_LICENSE_REASON')
+      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 Wider Community License.
+          </p>
+          <p>
+            The information for this is as follows:
+          </p>
+          <ul>
+            <li>Contact's name: #{contact_name}</li>
+            <li>
+              Contact's email: #{contact_email}
+              <a href="https://www.zuora.com/platform/apps/search?searchTerm=#{contact_email}" target='_blank'>(Zuora Search)</a>
+              <a href="https://customers.gitlab.com/admin/customer?model_name=customer&query=#{contact_email}" target='_blank'>(Portal Search)</a>
+            </li>
+            <li>Contact's company: #{company}</li>
+            <li>User count: #{current}</li>
+            <li>Previous user count: #{previous}</li>
+            <li>True-up count: #{trueup}</li>
+            <li>Plan: #{plan}</li>
+            <li>Expiration date: #{expiration}</li>
+            <li>Approving manager email: #{approver}</li>
+            <li>Trial: Yes</li>
+          </ul>
+          <p>
+            The reason for the license being issued is:
+          </p>
+          <pre>
+            #{reason}
+          </pre>
+          <p>
+            Some additional context for this request is:
+          </p>
+          <pre>
+            #{context}
+          </pre>
+          <p>
+            You can find the workflow for this ticket
+            <a href='https://handbook.gitlab.com/handbook/support/license-and-renewals/workflows/self-managed/creating-wider-community-license/' target='_blank'>here</a>
+          </p>
+        STRING
+      end
+    end
+  end
+end

data/lib/support_readiness/support_super_form_processor/global_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 GlobalSetCollaboriationID within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class GlobalSetCollaboriationID < Readiness::Client
+      ##
+      # Process setting a collab ID on a Global 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" => collaboration_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 Global 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_ORGANIZATION_ID')
+      end
+
+      ##
+      # Sets the global variable collaboration_project_id
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.collaboration_project_id
+        @collaboration_project_id ||= ENV.fetch('ZENDESK_ORG_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 Global organization - #{org.id}
+
+          Greetings @#{requester.username} !
+
+          We have set the collaboration project ID of the Zendesk Global organization to that of #{collaboration_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 Global Organization ID. As such, we are not able to proceed.
+
+          Please review the Zendesk Global 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 Global organization given"
+
+          /assign @#{requester.username}
+        STRING
+      end
+    end
+  end
+end