gitlab_support_readiness 1.0.41 → 1.0.42

data/lib/support_readiness/support_super_form_processor/shared.rb

@@ -0,0 +1,518 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class Shared within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class Shared < Readiness::Client
+      ##
+      # Performs a gitlab.com user check
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param email [String] The email to search for
+      def self.gitlab_user_check(client, email)
+        user_search = Readiness::GitLab::Users.search_by_email(client, email)
+        requester = user_search.detect { |u| u.email == email }
+        no_such_gitlab_user(email) if requester.nil?
+        requester
+      end
+
+      ##
+      # Performs a Zendesk user check
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @param client [Object] An instance of {Readiness::GitLab::Client}
+      # @param email [String] The email to search for
+      def self.zendesk_user_check(client, email)
+        user_search = Readiness::Zendesk::Search.users(client, "email:#{CGI.escape(email)} -role:end-user")
+        user = user_search.detect { |u| u.email.downcase == email.downcase }
+        no_such_zendesk_user(email) if user.nil?
+        user
+      end
+
+      ##
+      # Sends an email if a gitlab.com user check fails
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @param address [String] The email addresses used
+      def self.no_such_gitlab_user(address)
+        email = Readiness::Mailgun::Emails.new
+        email.from = 'GitLab Support <techsupport@gitlab.com>'
+        email.to = address
+        email.subject = 'Invalid Support Super Form submission'
+        email.text = no_such_gitlab_user_message(email)
+        Readiness::Mailgun::Emails.send!(mailgun_client, email)
+        puts "No such gitlab.com account tied to #{address}"
+        exit 0
+      end
+
+      ##
+      # Sends an email if a Zendesk user check fails
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @param address [String] The email addresses used
+      def self.no_such_zendesk_user(address)
+        email = Readiness::Mailgun::Emails.new
+        email.from = 'GitLab Support <techsupport@gitlab.com>'
+        email.to = address
+        email.subject = 'Invalid Support Super Form submission'
+        email.text = no_such_zendesk_user_message(email)
+        Readiness::Mailgun::Emails.send!(mailgun_client, email)
+        puts "No such Zendesk account tied to #{address}"
+        exit 0
+      end
+
+      ##
+      # Sends an email if not an OEM member
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @param address [String] The email addresses used
+      def self.not_oem_member(address)
+        email = Readiness::Mailgun::Emails.new
+        email.from = 'GitLab Support <techsupport@gitlab.com>'
+        email.to = address
+        email.subject = 'Invalid Support Super Form submission'
+        email.text = not_oem_member_message
+        Readiness::Mailgun::Emails.send!(mailgun_client, email)
+        puts "Not an OEM member - #{address}"
+        exit 0
+      end
+
+      ##
+      # Sends an email if not an Order Management member
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @param address [String] The email addresses used
+      def self.not_order_management_member(address)
+        email = Readiness::Mailgun::Emails.new
+        email.from = 'GitLab Support <techsupport@gitlab.com>'
+        email.to = address
+        email.subject = 'Invalid Support Super Form submission'
+        email.text = not_order_management_member_message
+        Readiness::Mailgun::Emails.send!(mailgun_client, email)
+        puts "Not an Order Management member - #{address}"
+        exit 0
+      end
+
+      ##
+      # Sends an email if the namespace provided was invalid
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @param address [String] The email addresses used
+      def self.invalid_namespace(address, namespace)
+        email = Readiness::Mailgun::Emails.new
+        email.from = 'GitLab Support <techsupport@gitlab.com>'
+        email.to = address
+        email.subject = 'Invalid Support Super Form submission'
+        email.text = invalid_namespace_message(namespace)
+        Readiness::Mailgun::Emails.send!(mailgun_client, email)
+        puts "#{address} provided invalid namespace - #{namespace}"
+        exit 0
+      end
+
+      ##
+      # Sends an email if not an Partner Support member
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @param address [String] The email addresses used
+      def self.not_partner_support_member(address)
+        email = Readiness::Mailgun::Emails.new
+        email.from = 'GitLab Support <techsupport@gitlab.com>'
+        email.to = address
+        email.subject = 'Invalid Support Super Form submission'
+        email.text = not_partner_support_member_message
+        Readiness::Mailgun::Emails.send!(mailgun_client, email)
+        puts "Not an Order Management member - #{address}"
+        exit 0
+      end
+
+      ##
+      # Sends an email if not a valid NFR request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @param address [String] The email addresses used
+      def self.invalid_nfr_request(address)
+        email = Readiness::Mailgun::Emails.new
+        email.from = 'GitLab Support <techsupport@gitlab.com>'
+        email.to = address
+        email.subject = 'Invalid Support Super Form submission'
+        email.text = invalid_nfr_request_message
+        Readiness::Mailgun::Emails.send!(mailgun_client, email)
+        puts "Invalid NFR request made by #{address}"
+        exit 0
+      end
+
+      ##
+      # Sends an email if not a valid Wider Community License request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @param address [String] The email addresses used
+      def self.cannot_self_approve(address)
+        email = Readiness::Mailgun::Emails.new
+        email.from = 'GitLab Support <techsupport@gitlab.com>'
+        email.to = address
+        email.subject = 'Invalid Support Super Form submission'
+        email.text = cannot_self_approve_message
+        Readiness::Mailgun::Emails.send!(mailgun_client, email)
+        puts "Invalid WCL request made by #{address}"
+        exit 0
+      end
+
+      ##
+      # Sends an email if not a valid article creation request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.invalid_article_creation(requester, errors)
+        email = Readiness::Mailgun::Emails.new
+        email.from = 'GitLab Support <techsupport@gitlab.com>'
+        email.to = requester.email
+        email.subject = 'Invalid Support Super Form submission'
+        email.text = invalid_article_creation_message(requester, errors)
+        Readiness::Mailgun::Emails.send!(mailgun_client, email)
+        puts "Invalid article creation submission by #{requester.email}"
+        exit 0
+      end
+
+      ##
+      # Sends an email if not a valid enable us gov request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.invalid_enable_usgov(requester, errors)
+        email = Readiness::Mailgun::Emails.new
+        email.from = 'GitLab Support <techsupport@gitlab.com>'
+        email.to = requester.email
+        email.subject = 'Invalid Support Super Form submission'
+        email.text = invalid_enable_usgov_message(requester, errors)
+        Readiness::Mailgun::Emails.send!(mailgun_client, email)
+        puts "Invalid enable us gov submission by #{requester.email}"
+        exit 0
+      end
+
+      ##
+      # Sets a global variable for an instance of {Readiness::Mailgun::Client}
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [Object] {Readiness::Mailgun::Client}
+      def self.mailgun_client
+        @mailgun_client ||= generate_mailgun_connection
+      end
+
+      ##
+      # Generates a Mailgun connection
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [Object] {Readiness::Mailgun::Client}
+      def self.generate_mailgun_connection
+        mailgun_config = Readiness::Mailgun::Configuration.new
+        mailgun_config.domain = 'mg.gitlab.com'
+        mailgun_config.token = ENV.fetch('MAILGUN_KEY')
+        Readiness::Mailgun::Client.new(mailgun_config)
+      end
+
+      ##
+      # Returns the email body message for a failed gitlab.com user check
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.no_such_gitlab_user_message(email)
+        <<~STRING
+          Greetings,
+
+          Recently a Support Super Form submission was made stating the requester email was #{email}.
+
+          We were unable to find a gitlab.com account using that email address as the primary email. As such, the request could not be completed.
+
+          If you have a gitlab.com account using that as a secondary email, please modify your gitlab.com account to make your official GitLab email the primary.
+
+          Once that has been rectified, please re-submit your request.
+
+          Thank you,
+
+          GitLab Support
+        STRING
+      end
+
+      ##
+      # Returns the email body message for a failed Zendesk user check
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.no_such_zendesk_user_message(email)
+        <<~STRING
+          Greetings,
+
+          The Internal Request Form submission you recently filed was not able to be filed due to the following issues:
+
+          - Invalid Zendesk user: #{CGI.escape(email)}
+
+          Please rectify the above issues and re-submit your Internal Request via the form.
+          
+          Thank you,
+          
+          GitLab Support
+          
+          Please note this is sent from an unmonitored inbox and replies to it will not be followed up on.
+        STRING
+      end
+
+      ##
+      # Returns the email body message for a failed OEM check
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.not_oem_member_message
+        <<~STRING
+          Greetings,
+
+          The Internal Request Form submission you recently filed was not able to be filed due to the following issues:
+
+          - You are not a member of the OEM management team.
+
+          Please rectify the above issues and re-submit your Internal Request via the form.
+          
+          Thank you,
+          
+          GitLab Support
+          
+          Please note this is sent from an unmonitored inbox and replies to it will not be followed up on.
+        STRING
+      end
+
+      ##
+      # Returns the email body message for a failed Order Management check
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.not_order_management_member_message
+        <<~STRING
+          Greetings,
+
+          The Internal Request Form submission you recently filed was not able to be filed due to the following issues:
+
+          - You are not a member of the order management team.
+
+          Please rectify the above issues and re-submit your Internal Request via the form.
+
+          Thank you,
+
+          GitLab Support
+
+          Please note this is sent from an unmonitored inbox and replies to it will not be followed up on.
+        STRING
+      end
+
+      ##
+      # Returns the email body message when the namespace is invalid
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.invalid_namespace_message(namespace)
+        <<~STRING
+          Greetings,
+
+          The Internal Request Form submission you recently filed was not able to be filed due to the following issues:
+
+          - Invalid namespace: '#{namespace}'. Ensure the provided namespace is an existing top-level group, as only those are accepted.
+
+          Please rectify the above issues and re-submit your Internal Request via the form.
+
+          Thank you,
+
+          GitLab Support
+
+          Please note this is sent from an unmonitored inbox and replies to it will not be followed up on.
+        STRING
+      end
+
+      ##
+      # Returns the email body message when not a Partner Supprot member
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.not_partner_support_member_message
+        <<~STRING
+          Greetings,
+
+          The Internal Request Form submission you recently filed was not able to be filed due to the following issues:
+
+          - You are not a member of the partner support team.
+
+          Please rectify the above issues and re-submit your Internal Request via the form.
+
+          Thank you,
+
+          GitLab Support
+
+          Please note this is sent from an unmonitored inbox and replies to it will not be followed up on.
+        STRING
+      end
+
+      ##
+      # Returns the email body message when not a valid NFR request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.invalid_nfr_request_message
+        <<~STRING
+          Greetings,
+
+          The Internal Request Form submission you recently filed was not able to be filed due to one of the following issues:
+
+          - NFR licenses cannot exceed 25 seats
+          - NFR licenses cannot have an expiration more than one year in the future
+
+          Please rectify the above issues and re-submit your Internal Request via the form.
+
+          Thank you,
+
+          GitLab Support
+
+          Please note this is sent from an unmonitored inbox and replies to it will not be followed up on.
+        STRING
+      end
+
+      ##
+      # Returns the email body message when not a valid Wider Community License request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.cannot_self_approve_message
+        <<~STRING
+          Greetings,
+
+          The Internal Request Form submission you recently filed was not able to be filed due to one of the following issues:
+
+          - You cannot be the approver for community licenses lasting more than 90 days.
+
+          Please rectify the above issues and re-submit your Internal Request via the form.
+
+          Thank you,
+
+          GitLab Support
+
+          Please note this is sent from an unmonitored inbox and replies to it will not be followed up on.
+        STRING
+      end
+
+      ##
+      # Returns the email body message when not a valid article creation submission
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.invalid_article_creation_message(requester, errors)
+        <<~STRING
+          Greetings @#{requester.username} ,
+
+          Your recent request to create a Zendesk article was not able to be filed due to the following issues:
+
+          #{errors.map { |e| "- #{e}" }.join("\n")}
+
+          Please rectify the above issues and re-submit your request via the form.
+
+          Thank you,
+
+          GitLab Support
+
+          Please note this is sent from an unmonitored inbox and replies to it will not be followed up on.
+        STRING
+      end
+
+      ##
+      # Returns the email body message when not a valid enable us gov submission
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [String]
+      def self.invalid_enable_usgov_message(requester, errors)
+        <<~STRING
+          Greetings @#{requester.username} ,
+
+          Your recent request to enable US Goverment support was not able to be filed due to the following issues:
+
+          #{errors.map { |e| "- #{e}" }.join("\n")}
+
+          Please rectify the above issues and re-submit your request via the form.
+
+          Thank you,
+
+          GitLab Support
+
+          Please note this is sent from an unmonitored inbox and replies to it will not be followed up on.
+        STRING
+      end
+
+      def self.sfdc_account_string(link)
+        id = if link =~ /lightning/
+          link.split('/')[-2]
+        else
+          link.split('/').last
+        end
+        classic = "<a href='https://gitlab.my.salesforce.com/#{id}' target='_blank'>Classic</a>"
+        lightning = "<a href='https://gitlab.lightning.force.com/lightning/r/Account/#{id}/view' target='_blank'>Lightning</a>"
+        "SFDC Account: #{id} (#{classic} | #{lightning})"
+      end
+
+      def self.sfdc_opportunity_string(link)
+        id = if link =~ /lightning/
+          link.split('/')[-2]
+        else
+          link.split('/').last
+        end
+        classic = "<a href='https://gitlab.my.salesforce.com/#{id}' target='_blank'>Classic</a>"
+        lightning = "<a href='https://gitlab.lightning.force.com/lightning/r/Opportunity/#{id}/view' target='_blank'>Lightning</a>"
+        "SFDC Opportunity: #{id} (#{classic} | #{lightning})"
+      end
+
+      def self.sfdc_upload_string(link)
+        id = if link =~ /lightning/
+          link.split('/')[-2]
+        else
+          link.split('/').last
+        end
+        classic = "<a href='https://gitlab.my.salesforce.com/#{id}' target='_blank'>Classic</a>"
+        lightning = "<a href='https://gitlab.lightning.force.com/lightning/r/ContentDocument/#{id}/view' target='_blank'>Lightning</a>"
+        "Customer verification proof: #{id} (#{classic} | #{lightning})"
+      end
+
+      def self.sfdc_chattr_string(link)
+        id = if link =~ /lightning/
+          link.split('/')[-2]
+        else
+          link.split('/').last
+        end
+        classic = "<a href='https://gitlab.my.salesforce.com/#{id}' target='_blank'>Classic</a>"
+        lightning = "<a href='https://gitlab.lightning.force.com/lightning/r/#{id}/view' target='_blank'>Lightning</a>"
+        "Chattr link containing approval: #{id} (#{classic} | #{lightning})"
+      end
+    end
+  end
+end

data/lib/support_readiness/support_super_form_processor/team_member_license.rb

@@ -0,0 +1,144 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class TeamMemberLicense within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class TeamMemberLicense < Readiness::Client
+      ##
+      # Process a Team Member License check request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(client, admin_client)
+        @gitlab_client = client
+        @gitlab_admin_client = admin_client
+        requester
+        issue = Readiness::GitLab::Issues.new
+        issue.title = "GitLab Team Member License request - #{requester.name}"
+        issue.description = team_member_license_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 plan
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.plan
+        @plan ||= ENV.fetch('TEAM_MEMBER_LICENSE_PLAN')
+      end
+
+      ##
+      # Sets the global variable seats
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.seats
+        @seats ||= ENV.fetch('TEAM_MEMBER_LICENSE_COUNT')
+      end
+
+      ##
+      # Sets the global variable trueup
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.trueup
+        @trueup ||= ENV.fetch('TEAM_MEMBER_LICENSE_TRUEUP')
+      end
+
+      ##
+      # Sets the global variable previous
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.previous
+        @previous ||= ENV.fetch('TEAM_MEMBER_LICENSE_PREVIOUS')
+      end
+
+      ##
+      # Sets the global variable expiration
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.expiration
+        @expiration ||= ENV.fetch('TEAM_MEMBER_LICENSE_EXPIRATION')
+      end
+
+      ##
+      # Returns the issue description for a team member license request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.team_member_license_message
+        <<~STRING
+          # GitLab Team Member License request
+
+          ## Please Note the Following
+
+          - This is for requesting an **internal** self-managed GitLab license. This license should **only** be used by **GitLab team members**.
+          - This is solely for **self-managed** GitLab instances. If you are wanting a subscription put on a GitLab.com namespace, please file an AR to IT Ops using the appropriate template.
+          - The license can only exist for one year at a time
+          - The license will be generated via our cDot **staging** environment only.
+
+          ## Information
+
+          - Name: #{requester.name}
+          - Email: #{requester.email}
+          - GitLab username: @#{requester.username}
+          - License plan: #{plan.capitalize}
+          - Number of users: #{seats}
+          - True-up count: #{trueup}
+          - Previous user count: #{previous}
+          - Expiration date: #{expiration}
+
+          ### Support Operations
+
+          * [ ] Follow the directions of the workflow, which can be found [here](https://handbook.gitlab.com/handbook/support/readiness/operations/docs/policies/team_member_licenses/)
+
+          ---
+
+          /confidential
+
+          /assign @nabeel.bilgrami @avilla4 @secole @rverschoor
+
+          /label ~"Internal-License" ~"Readiness::Triage" ~"Readiness Priority::Current Quarter"
+        STRING
+      end
+    end
+  end
+end