gitlab_support_readiness 1.0.41 → 1.0.43

data/lib/support_readiness/support_super_form_processor/two_fa_exemption.rb

@@ -0,0 +1,260 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class TwoFAExemption within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class TwoFAExemption < Readiness::Client
+      ##
+      # Process a 2FA Exemption 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
+        org_does_not_exist if org.is_a? Hash
+        new_org = Readiness::Zendesk::Organizations.new
+        new_org.id = org.id
+        new_org.tags = org.tags + ['skip_2fa_automation']
+        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 = "Enable 2FA Exemption for a large 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 slack_link
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.slack_link
+        @slack_link ||= ENV.fetch('ZENDESK_ORG_2FA_SLACK_LINK', nil)
+      end
+
+      ##
+      # Sets the global variable mfa_slack_user
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.mfa_slack_user
+        @mfa_slack_user ||= ENV.fetch('ZENDESK_ORG_2FA_SLACK_USER')
+      end
+
+      ##
+      # Sets the global variable mfa_gitlab_user
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.mfa_gitlab_user
+        @mfa_gitlab_user ||= ENV.fetch('ZENDESK_ORG_2FA_GITLAB_USER')
+      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_2FA_COLLAB_ID')
+      end
+
+      ##
+      # Returns the issue description
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.message
+        <<~STRING
+          ## Enable 2FA Exemption for a large organization - #{org.id}
+
+          Greetings @#{requester.username} !
+          
+          We have set the required tag and collaboration project ID on the organization at this time.
+          
+          Please note the required next steps that you will need to work on:
+          
+          - [ ] You'll want to get assistance from support managers via the slack channel [#support_leadership](https://gitlab.enterprise.slack.com/archives/C01F9S37AKT) for adding the organization notes needed.
+            - For reference, the organization ID is #{org.id}, making the target note file https://gitlab.com/gitlab-com/support/zendesk-global/organizations/-/blob/master/organizations/#{org.id}.yaml?ref_type=heads
+            - Example org-note:
+              ```
+              This organization has access to the "Large Customer 2FA Workflow" (see [documentation](https://handbook.gitlab.com/handbook/support/workflows/account_verification/#large-customers))
+          
+              [2FA Reset Template](link to template)
+              ```
+          - [ ] You'll want to ensure you've setup the issue template required in the collaboration project
+            - Ensure the filename is `2FA Verification.md`
+            - Ensure the file's location is within path `.gitlab/issue_templates`
+            - Ensure the file contents use the following template:
+          
+          #{slack_link.nil? ? template_without_slack : template_with_slack}
+          
+          /assign @#{requester.username}
+        STRING
+      end
+
+      ##
+      # Returns the template to use when no slack link is present
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.template_without_slack
+        <<~STRING
+          ```
+          A user in your organization is requesting to have [GitLab two-factor authentication](https://docs.gitlab.com/ee/user/profile/account/two_factor_authentication.html) removed from their account. Please review and complete the highlighted sections below.
+
+          **Support Engineer Instructions**
+
+          - Fill out the `Request Details` section below.
+
+          **Request Details**
+
+          - User Requesting Reset: USERS_GITLAB_USERNAME
+          - Support Ticket: TICKET_NUMBER
+
+          **Customer Instructions**
+
+          - Review the request and get in contact with the user requesting the reset to verify its authenticity.
+          - Comment on this issue indicating your approval.
+          - Unassign yourself and any others from this issue.
+          - Assign to the Support Engineer who opened this issue.
+
+          /assign @#{mfa_gitlab_user}
+
+          /label ~"2FA Reset" ~"Awaiting confirmation"
+          ```
+        STRING
+      end
+
+      ##
+      # Returns the template to use when a slack link is present
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.template_with_slack
+        <<~STRING
+          ```
+          A user in your organization is requesting to have [GitLab two-factor authentication](https://docs.gitlab.com/ee/user/profile/account/two_factor_authentication.html) removed from their account. Please review and complete the highlighted sections below.
+
+          **Support Engineer Instructions**
+
+          - Ping the customer’s organization owners in #{slack_link} using the [Notify Customer - Slack ](https://handbook.gitlab.com/handbook/support/workflows/account_verification#2-contact-through-slack) template. For this organization the owners are #{mfa_slack_user}.
+          - Fill out the `Request Details` section below.
+
+          **Request Details**
+
+          - User Requesting Reset: USERS_GITLAB_USERNAME
+          - Support Ticket: TICKET_NUMBER
+
+          **Customer Instructions**
+
+          - Review the request and get in contact with the user requesting the reset to verify its authenticity.
+          - Comment on this issue indicating your approval.
+          - Unassign yourself and any others from this issue.
+          - Assign to the Support Engineer who opened this issue.
+
+          /assign @#{mfa_gitlab_user}
+
+          /label ~"2FA Reset" ~"Awaiting confirmation"
+          ```
+        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

data/lib/support_readiness/support_super_form_processor/usgov_ir_order_management.rb

@@ -0,0 +1,252 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class USGovIRORderManagement within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class USGovIRORderManagement < Readiness::Client
+      ##
+      # Process a US Government Internal Request Order Management 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
+        unless zd_user.tags.include? 'order_management_team'
+          Readiness::SupportSuperFormProcessor::Shared.not_order_management_member(requester_email)
+        end
+        ticket = Readiness::Zendesk::Tickets.new
+        ticket.requester_id = zd_user.id
+        ticket.submitter_id = zd_user.id
+        ticket.comment = { html_body: body }
+        ticket.subject = 'xxxxx'
+        ticket.tags = %w[lnr_internal_request lnr_valid_request lnr_order_management]
+        ticket.priority = 'normal'
+        ticket.status = 'new'
+        ticket.ticket_form_id = 360001803151
+        ticket.custom_fields = [
+          { id: 11717320292244, value: 'xxxxxxxxxxxxxxxxxxx' },
+          { 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 opp_link
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.opp_link
+        @opp_link ||= ENV.fetch('USFED_ORDER_MANAGEMENT_SFDC_OPPORTUNITY')
+      end
+
+      ##
+      # Sets the global variable sub_name
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.sub_name
+        @sub_name ||= ENV.fetch('USFED_ORDER_MANAGEMENT_SUB_NAME')
+      end
+
+      ##
+      # Sets the global variable sub_id
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.sub_id
+        @sub_id ||= ENV.fetch('USFED_ORDER_MANAGEMENT_ZUORA_ID')
+      end
+
+      ##
+      # Sets the global variable start_date
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.start_date
+        @start_date ||= ENV.fetch('USFED_ORDER_MANAGEMENT_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_ORDER_MANAGEMENT_END_DATE')
+      end
+
+      ##
+      # Sets the global variable current
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.current
+        @current ||= ENV.fetch('USFED_ORDER_MANAGEMENT_USERS')
+      end
+
+      ##
+      # Sets the global variable previous
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.previous
+        @previous ||= ENV.fetch('USFED_ORDER_MANAGEMENT_PREVIOUS')
+      end
+
+      ##
+      # Sets the global variable trueup
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.trueup
+        @trueup ||= ENV.fetch('USFED_ORDER_MANAGEMENT_TRUEUPS')
+      end
+
+      ##
+      # Sets the global variable plan
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.plan
+        @plan ||= ENV.fetch('USFED_ORDER_MANAGEMENT_PLAN')
+      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 Order Management.
+          </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>Contact's company: #{company}</li>
+            <li>#{Readiness::SupportSuperFormProcessor::Shared.sfdc_opportunity_string(opp_link)}</li>
+            <li>Subscription name: #{sub_name}</li>
+            <li>Subscription ID: #{sub_id}</li>
+            <li>Start date: #{start_date}</li>
+            <li>End date: #{end_date}</li>
+            <li>User count: #{current}</li>
+            <li>Previous user count: #{previous}</li>
+            <li>True-up count: #{trueup}</li>
+            <li>Plan: #{plan}</li>
+            <li>#{Readiness::SupportSuperFormProcessor::Shared.sfdc_account_string(sfdc_account)}</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_other.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class USGovIROther within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class USGovIROther < Readiness::Client
+      ##
+      # Process a US Government Internal Request Other 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 = 'xxxxx'
+        ticket.tags = %w[lnr_internal_request lnr_valid_request lnr_internal_request_other]
+        ticket.priority = 'normal'
+        ticket.status = 'new'
+        ticket.ticket_form_id = 360001803151
+        ticket.custom_fields = [
+          { id: 11717320292244, value: 'ir_other' },
+          { 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_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 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 Other (nothing else fits the request).
+          </p>
+          <ul>
+            <li>GitLab Version: #{version}</li>
+            <li>#{Readiness::SupportSuperFormProcessor::Shared.sfdc_account_string(sfdc_account)}</li>
+            <li>Contact email: #{contact_email}</li>
+          </ul>
+          <p>
+            Some additional context for this request is:
+          </p>
+          <pre>
+            #{context}
+          </pre>
+        STRING
+      end
+    end
+  end
+end