gitlab_support_readiness 1.0.41 → 1.0.42

data/lib/support_readiness/support_super_form_processor/gratis_support_other.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class GratisSupportOther within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class GratisSupportOther < Readiness::Client
+      ##
+      # Process a Gratis Support Other request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(gitlab_client, gitlab_admin_client, sfdc_client)
+        @gitlab_client = gitlab_client
+        @gitlab_admin_client = gitlab_admin_client
+        @sfdc_client = sfdc_client
+        requester
+        checks
+        issue = Readiness::GitLab::Issues.new
+        issue.title = 'Gratis Support Request for a Support Leadership approved situation'
+        issue.description = message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      ##
+      # Sets the global variable errors
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.errors
+        @errors ||= []
+      end
+
+      ##
+      # Perform the checks for this request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.checks
+        if sfdc_account.nil?
+          errors.push('Invalid SFDC account given')
+        end
+        errors.push('Invalid manager handle given') if manager.nil?
+      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 sfdc_account_id
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.sfdc_account_id
+        @sfdc_account_id ||= determine_sfdc_account_id
+      end
+
+      ##
+      # Determines the SFDC Account ID based off of the link given
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.determine_sfdc_account_id
+        link = ENV.fetch('GRATUS_SUPPORT_SFDC_ACCOUNT')
+        return link.split('/')[-2] if link =~ /lightning/
+
+        link.split('/').last
+      end
+
+      ##
+      # Sets the global variable sfdc_account
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.sfdc_account
+        @sfdc_account ||= fetch_sfdc_account
+      end
+
+      ##
+      # Gets the SFDC Account information
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.fetch_sfdc_account
+        query = Readiness::Salesforce::Queries.new(account_query)
+        results = Readiness::Salesforce::Queries.run!(@sfdc_client, query)
+        results.first
+      end
+
+      ##
+      # Sets the global variable justification
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.justification
+        @justification ||= ENV.fetch('GRATUS_SUPPORT_JUSTIFICATION')
+      end
+
+      def self.slack_link
+        @slack_link ||= ENV.fetch('GRATIS_SUPPORT_SLACK_URL')
+      end
+
+      ##
+      # Returns a SOQL query string to get Account info
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.account_query
+        <<~STRING
+          SELECT
+            Account.Account_ID_18__c,
+            Account.Name,
+            Account.Type
+          FROM Account
+          WHERE
+            Account.Account_ID_18__c = '#{sfdc_account_id}'
+        STRING
+      end
+
+      ##
+      # Returns a string for the errors block
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.errors_block
+        return '' if errors.count.zero?
+
+        <<~STRING
+          ## Attention @jcolyer and @#{requester.username}
+
+          The following problems were detected in the form submission:
+
+          #{errors.map { |e| "- #{e}" }.join("\n")}
+
+          These will need to be corrected to proceed. Please communicate via issue comments to work this out.
+        STRING
+      end
+
+      ##
+      # Returns a string for the issue body
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.message
+        <<~STRING
+          ## Gratis Support Request for a Support Leadership approved situation
+
+          - Requester: @#{requester.username}
+          - Approver: @#{manager.nil? ? manager_handle : manager.username}
+          - SFDC Account: #{sfdc_account.nil? ? sfdc_account_id : sfdc_account.Account_ID_18__c}
+          - Slack link containing support leadership approval: #{slack_link}
+          - Justification:
+          
+          ```
+          #{justification}
+          ```
+          
+          #{errors_block}
+
+          ## @#{requester.username} TODO
+
+          - [ ] Look over the issue and confirm all data is correct
+          - [ ] Work with the approver on their TODO section
+
+          ## @#{manager.nil? ? manager_handle : manager.username} TODO
+
+          - [ ] Review the request and check this box to approve the request
+            - If you are not approving it, please add a comment explaining why and close the issue.
+          - [ ] Add a comment signaling your approval (this let's the assignees know the issue is ready to proceed).
+            - Please note your comment must explicitly say that you approve this request. If that is not explict, you may be asked to state the approval explicitly.
+
+          ## Support Readiness TODO
+
+          - [ ] Review the above information for accuracy
+          - [ ] Review [our documentation](https://handbook.gitlab.com/handbook/support/readiness/operations/docs/policies/gratis_support/#extensions) for this and ensure it passes all required checks/validations
+          - [ ] Ensure the approver has checked the above box to signal approval
+          - [ ] Implement this as per [our documentation](https://handbook.gitlab.com/handbook/support/readiness/operations/docs/policies/gratis_support/#extensions)
+
+          /assign @jcolyer
+
+          /cc @#{requester.username} @#{manager.nil? ? manager_handle : manager.username}
+
+          /label ~"Readiness Priority::Current Quarter" ~"Readiness::Consulting" ~"Zendesk::Global" ~"Support-Ops-Category::Orgs and Users" ~"Gratis Support Request::Other"
+
+          /due in 72 hours
+        STRING
+      end
+    end
+  end
+end

data/lib/support_readiness/support_super_form_processor/gratis_support_prospect.rb

@@ -0,0 +1,288 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class GratisSupportProspect within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class GratisSupportProspect < Readiness::Client
+      ##
+      # Process a Gratis Support Prospect request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(gitlab_client, gitlab_admin_client, sfdc_client)
+        @gitlab_client = gitlab_client
+        @gitlab_admin_client = gitlab_admin_client
+        @sfdc_client = sfdc_client
+        requester
+        checks
+        issue = Readiness::GitLab::Issues.new
+        issue.title = 'Gratis Support Request for a Prospect'
+        issue.description = message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      ##
+      # Sets the global variable errors
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.errors
+        @errors ||= []
+      end
+
+      ##
+      # Perform the checks for this request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.checks
+        if sfdc_account.nil?
+          errors.push('Invalid SFDC account given')
+        else
+          errors.push('Incorrect SFDC account type') if sfdc_account.Type != 'Prospect'
+        end
+        errors.push('Invalid SFDC opportunity given') if sfdc_opportunity.nil?
+        errors.push('Invalid manager handle given') if manager.nil?
+      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 sfdc_account_id
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.sfdc_account_id
+        @sfdc_account_id ||= determine_sfdc_account_id
+      end
+
+      ##
+      # Determines the SFDC Account ID based off of the link given
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.determine_sfdc_account_id
+        link = ENV.fetch('GRATUS_SUPPORT_SFDC_ACCOUNT')
+        return link.split('/')[-2] if link =~ /lightning/
+
+        link.split('/').last
+      end
+
+      ##
+      # Sets the global variable sfdc_opportunity_id
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.sfdc_opportunity_id
+        @sfdc_account_id ||= determine_sfdc_opportunity_id
+      end
+
+      ##
+      # Determines the SFDC Opportunity ID based off of the link given
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.determine_sfdc_opportunity_id
+        link = ENV.fetch('GRATIS_SUPPORT_SFDC_OPPORTUNITY')
+        return link.split('/')[-2] if link =~ /lightning/
+
+        link.split('/').last
+      end
+
+      ##
+      # Sets the global variable sfdc_account
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.sfdc_account
+        @sfdc_account ||= fetch_sfdc_account
+      end
+
+      ##
+      # Gets the SFDC Account information
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.fetch_sfdc_account
+        query = Readiness::Salesforce::Queries.new(account_query)
+        results = Readiness::Salesforce::Queries.run!(@sfdc_client, query)
+        results.first
+      end
+
+      ##
+      # Sets the global variable sfdc_opportunity
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.sfdc_opportunity
+        @sfdc_opportunity ||= fetch_sfdc_opportunity
+      end
+
+      ##
+      # Gets the SFDC Opportunity information
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.fetch_sfdc_opportunity
+        query = Readiness::Salesforce::Queries.new(opportunity_query)
+        results = Readiness::Salesforce::Queries.run!(@sfdc_client, query)
+        results.first
+      end
+
+      ##
+      # Sets the global variable justification
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.justification
+        @justification ||= ENV.fetch('GRATUS_SUPPORT_JUSTIFICATION')
+      end
+
+      ##
+      # Sets the global variable customer_email
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.customer_email
+        @customer_email ||= ENV.fetch('GRATIS_SUPPORT_CUSTOMER_EMAIL')
+      end
+
+      ##
+      # Returns a SOQL query string to get Account info
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.account_query
+        <<~STRING
+          SELECT
+            Account.Account_ID_18__c,
+            Account.Name,
+            Account.Type
+          FROM Account
+          WHERE
+            Account.Account_ID_18__c = '#{sfdc_account_id}'
+        STRING
+      end
+
+      ##
+      # Returns a SOQL query string to get Opportunity info
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.opportunity_query
+        <<~STRING
+          SELECT
+            Opportunity.Id,
+            Opportunity.ARR__c
+          FROM Opportunity
+          WHERE
+            Opportunity.Id = '#{sfdc_opportunity_id}'
+        STRING
+      end
+
+      ##
+      # Returns a string for the errors block
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.errors_block
+        return '' if errors.count.zero?
+
+        <<~STRING
+          ## Attention @jcolyer and @#{requester.username}
+
+          The following problems were detected in the form submission:
+
+          #{errors.map { |e| "- #{e}" }.join("\n")}
+
+          These will need to be corrected to proceed. Please communicate via issue comments to work this out.
+        STRING
+      end
+
+      ##
+      # Returns a string for the issue body
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.message
+        <<~STRING
+          ## Gratis Support Request for a Prospect
+
+          - Requester: @#{requester.username}
+          - Approver: @#{manager.nil? ? manager_handle : manager.username}
+          - SFDC Account: #{sfdc_account.nil? ? sfdc_account_id : sfdc_account.Account_ID_18__c}
+          - SFDC Opportunity: #{sfdc_opportunity.nil? ? sfdc_opportunity_id : sfdc_opportunity.Id}
+          - ARR: #{sfdc_opportunity.nil? ? 'Unknown' : sfdc_opportunity.ARR__c}
+          - Email of customer who will be filing tickets: #{customer_email}
+          - Justification:
+          
+          ```
+          #{justification}
+          ```
+          
+          #{errors_block}
+
+          ## @#{requester.username} TODO
+
+          - [ ] Look over the issue and confirm all data is correct
+          - [ ] Work with the approver on their TODO section
+
+          ## @#{manager.nil? ? manager_handle : manager.username} TODO
+
+          - [ ] Review the request and check this box to approve the request
+            - If you are not approving it, please add a comment explaining why and close the issue.
+          - [ ] Add a comment signaling your approval (this let's the assignees know the issue is ready to proceed).
+            - Please note your comment must explicitly say that you approve this request. If that is not explict, you may be asked to state the approval explicitly.
+
+          ## Support Readiness TODO
+
+          - [ ] Review the above information for accuracy
+          - [ ] Review [our documentation](https://handbook.gitlab.com/handbook/support/readiness/operations/docs/policies/gratis_support/#extensions) for this and ensure it passes all required checks/validations
+          - [ ] Ensure the approver has checked the above box to signal approval
+          - [ ] Implement this as per [our documentation](https://handbook.gitlab.com/handbook/support/readiness/operations/docs/policies/gratis_support/#extensions)
+
+          /assign @jcolyer
+
+          /cc @#{requester.username} @#{manager.nil? ? manager_handle : manager.username}
+
+          /label ~"Readiness Priority::Current Quarter" ~"Readiness::Consulting" ~"Zendesk::Global" ~"Support-Ops-Category::Orgs and Users" ~"Gratis Support Request::Priority Prospects"
+
+          /due in 72 hours
+        STRING
+      end
+    end
+  end
+end