gitlab_support_readiness 1.0.41 → 1.0.43

data/lib/support_readiness/support_super_form_processor/edit_macro.rb

@@ -0,0 +1,161 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class EditMacro within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class EditMacro < Readiness::Client
+      ##
+      # Process a Edit Macro request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(gitlab_client, gitlab_admin_client)
+        @gitlab_client = gitlab_client
+        @gitlab_admin_client = gitlab_admin_client
+        requester
+        file_path = create_macro_file_if_needed
+        issue = Readiness::GitLab::Issues.new
+        issue.title = 'Edit an existing macro'
+        issue.description = message(file_path)
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      def self.create_macro_file_if_needed
+        return nil if comment == 'none'
+
+        macro_project_id = if instance == 'Zendesk Global'
+                             53382456
+                             else
+                               53561363
+                             end
+        macro_project = Readiness::GitLab::Projects.find!(@gitlab_client, macro_project_id)
+        path =  "active/#{name.split('::').join('/')}.md"
+        file = Readiness::GitLab::Repositories.file(@gitlab_client, macro_project, path, 'master')
+        unless file.key? 'file_name'
+          commit_params = {
+            branch: 'master',
+            commit_message: 'Creating placeholder file for macro',
+            actions: [
+              {
+                file_path: path,
+                content: 'PLACEHOLDER',
+                action: 'create'
+              }
+            ]
+          }
+          Readiness::GitLab::Repositories.create_commit!(@gitlab_client, macro_project, commit_params)
+        end
+        path
+      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 comment
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.comment
+        @comment ||= ENV.fetch('EDIT_MACRO_COMMENT')
+      end
+
+      ##
+      # Sets the global variable instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.instance
+        @instance ||= ENV.fetch('EDIT_MACRO_INSTANCE')
+      end
+
+      ##
+      # Sets the global variable name
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.name
+        @name ||= ENV.fetch('EDIT_MACRO_CURRENT_NAME')
+      end
+
+      ##
+      # Sets the global variable description
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.description
+        @tag ||= ENV.fetch('EDIT_MACRO_DESCRIPTION')
+      end
+
+      def self.issue_assignees
+        return '@jcolyer @secole' if instance == 'Zendesk US Government'
+
+        '@jcolyer @nabeel.bilgrami @avilla4 @dtragjasi @secole @rverschoor'
+      end
+
+      ##
+      # Return the string for the issue body
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.message(file_path)
+        <<~STRING
+          ## Edit an existing macro
+
+          Greetings @#{requester.username} !
+
+          This is a request to edit an existing macro within a Zendesk instance. The details are as follows:
+
+          - Name of Macro: #{name}
+          - Zendesk Instance: #{instance}
+          - Type of comment: #{comment}
+          - Description of changes:
+
+          ```
+
+          #{description}
+
+          ```
+
+          /label ~"Readiness Priority::Current Quarter"
+
+          /label ~"Readiness::Triage"
+
+          /assign #{issue_assignees}
+        STRING
+      end
+    end
+  end
+end

data/lib/support_readiness/support_super_form_processor/enable_us_government.rb

@@ -0,0 +1,236 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class EnableUSGov within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class EnableUSGov < Readiness::Client
+      ##
+      # Process a Enable US Government request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(gitlab_client, gitlab_admin_client, zendesk_client, sfdc_client)
+        @gitlab_client = gitlab_client
+        @gitlab_admin_client = gitlab_admin_client
+        @zendesk_client = zendesk_client
+        @sfdc_client = sfdc_client
+        requester
+        zd_user
+        checks
+        unless errors.count.zero?
+          Readiness::SupportSuperFormProcessor::Shared.invalid_enable_usgov(requester, errors)
+        end
+        issue = Readiness::GitLab::Issues.new
+        issue.title = 'Enable US Government Support'
+        issue.description = message(file_path)
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      ##
+      # Peform validity checks for this request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.checks
+        errors.push("Invalid SFDC account given: #{account_id}") if account.nil?
+        errors.push("Invalid SFDC opportunity given: #{opportunity_id}") if opportunity.nil?
+        return unless errors.count.zero?
+
+        errors.push("SFDC account #{account_id} is already entitled") if Readiness::Salesforce::Client.us_gover_enabled?(@sfdc_client, account_id)
+        errors.push("Missing US Government SKU on #{account_id}") unless correct_sku?
+      end
+
+      ##
+      # Check the SFDC account for a US Gov SKU
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.correct_sku?
+        account.Zuora__R00N40000001lGjTEAU__r.map { |r| r.Name }.each do |name|
+          return true if Readiness::Salesforce::SubscriptionDefinitions.usgov_12x5.include? name
+          return true if Readiness::Salesforce::SubscriptionDefinitions.usgov_24x7.include? name
+        end
+        false
+      end
+
+      ##
+      # Sets the global variable errors
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.errors
+        @errors ||= []
+      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 account
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.account
+        @account ||= fetch_account
+      end
+
+      ##
+      # Sets the global variable opportunity
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.opportunity
+        @opportunity ||= fetch_opportunity
+      end
+
+      ##
+      # Run a SQOL query to get account information
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.fetch_account
+        query = Readiness::Salesforce::Queries.new(account_query)
+        results = Readiness::Salesforce::Queries.run!(@sfdc_client, query)
+        results.first
+      end
+
+      ##
+      # Run a SQOL query to get opportunity information
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.fetch_opportunity
+        query = Readiness::Salesforce::Queries.new(opportunity_query)
+        results = Readiness::Salesforce::Queries.run!(@sfdc_client, query)
+        results.first
+      end
+
+      ##
+      # Sets the global variable account_id
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.account_id
+        @account_id ||= ENV.fetch('ENABLE_US_GOV_SUPPORT_SFDC_ACCOUNT')
+      end
+
+      ##
+      # Sets the global variable opportunity_id
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.opportunity_id
+        @opportunity_id ||= ENV.fetchh('ENABLE_US_GOV_SUPPORT_SFDC_OPP')
+      end
+
+      ##
+      # Returns a String to get account information
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.account_query
+        <<~STRING
+          SELECT
+            Account_ID_18__c,
+            Name,
+            Ultimate_Parent_Sales_Segment_Employees__c,
+            Account_Owner_Calc__c,
+            Technical_Account_Manager_Name__c,
+            GS_Health_Score_Color__c,
+            Restricted_Account__c,
+            Solutions_Architect_Lookup__r.Name,
+            Support_Hold__c,
+            (
+              SELECT
+                Id,
+                Name,
+                Zuora__ProductName__c,
+                Zuora__EffectiveEndDate__c,
+                Zuora__Quantity__c,
+                Zuora__TotalContractValue__c,
+                Subscription_Status__c
+              FROM Zuora__R00N40000001lGjTEAU__r
+            )
+          FROM Account
+          WHERE
+            Id = '#{account_id}'
+        STRING
+      end
+
+      ##
+      # Returns a String to get opportunity information
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.opportunity_query
+        <<~STRING
+          SELECT
+            Id
+          FROM Opportunity
+          WHERE
+            Id = '#{opportunity_id}'
+        STRING
+      end
+
+      ##
+      # Return the string for the issue body
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.message
+        <<~STRING
+          ## Enable US Government Support for #{account.Account_ID_18__c}
+
+          A request has been filed to enable US Government Support for a SFDC account. The details are as follows:
+
+          - Requester: @#{requester.username}
+          - SFDC Account: [#{account.Account_ID_18__c}](https://gitlab.my.salesforce.com/#{account.Account_ID_18__c})
+          - SFDC Opportunity: [#{opportunity.Account_ID_18__c}](https://gitlab.my.salesforce.com/#{opportunity.Account_ID_18__c})
+          - Product Charges on SFDC account:
+          #{account.Zuora__R00N40000001lGjTEAU__r.map { |r| "  - #{r.Name}" }.join("\n")}
+
+          #### Readiness TODO list
+
+          - [ ] Review above information
+          - [ ] Follow the process detailed in [this handbook page](https://handbook.gitlab.com/handbook/support/readiness/operations/docs/policies/enable_us_gov_support)
+
+          /assign @#{requester.username} @jcolyer @secole @lyle
+
+          cc @jscarborough @JamesRLopes
+        STRING
+      end
+    end
+  end
+end

data/lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_billing_entity_change.rb

@@ -0,0 +1,218 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class GlobalIRDotcomSubscriptionsBillingEntityChange within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class GlobalIRDotcomSubscriptionsBillingEntityChange < Readiness::Client
+      ##
+      # Process a Global Internal Request GitLab.com Subscriptions Billing Entity Change 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 Readiness::GitLab::Namespaces.exists?(client, namespace_provided)
+          Readiness::SupportSuperFormProcessor::Shared.invalid_namespace(requester_email, namespace_provided)
+        end
+        @namespace = Readiness::GitLab::Namespaces.find!(@gitlab_admin_client, namespace_provided)
+        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 - GitLab.com - Billing Entity change'
+        ticket.tags = %w[lnr_internal_request lnr_valid_request lnr_billing_entity_change]
+        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_billing_entity_change' },
+          { 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 namespace_provided
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.namespace_provided
+        @namespace_provided ||= ENV.fetch('BILLING_ENTITY_CHANGE_NAMESPACE')
+      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 customer_link
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.customer_link
+        @customer_link ||= ENV.fetch('BILLING_ENTITY_CHANGE_CDOT')
+      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('BILLING_ENTITY_CHANGE_SFDC_ACCOUNT')
+      end
+
+      ##
+      # Sets the global variable old_opp_link
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.old_opp_link
+        @old_opp_link ||= ENV.fetch('BILLING_ENTITY_CHANGE_OLD_OPP')
+      end
+
+      ##
+      # Sets the global variable new_opp_link
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.new_opp_link
+        @new_opp_link ||= ENV.fetch('BILLING_ENTITY_CHANGE_NEW_OPP')
+      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 Billing Entity change.
+          </p>
+          <p>
+            The information for this is as follows:
+          </p>
+          <ul>
+            <li>Customer'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>Customer's company: #{company}</li>
+            <li>Link to customer in cDot: <a href='#{customer_link}' target='_blank'>#{customer_link}</a></li>
+            <li>GitLab.com namespace: #{@namespace.path}</li>
+            <li>#{Readiness::SupportSuperFormProcessor::Shared.sfdc_account_string(sfdc_account_link)}</li>
+            <li>Original #{Readiness::SupportSuperFormProcessor::Shared.sfdc_opportunity_string(old_opp_link)}</li>
+            <li>New #{Readiness::SupportSuperFormProcessor::Shared.sfdc_opportunity_string(new_opp_link)}</li>
+          </ul>
+          <p>
+            Some additional context for this request is:
+          </p>
+          <pre>
+            <%= @context %>
+          </pre>
+        STRING
+      end
+    end
+  end
+end