gitlab_support_readiness 1.0.40 → 1.0.42

data/lib/support_readiness/support_super_form_processor/gratis_support_upgrade.rb

@@ -0,0 +1,298 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class GratisSupportUpgrade within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class GratisSupportUpgrade < Readiness::Client
+      ##
+      # Process a Gratis Support Upgrade 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 an Upgrade Offerring'
+        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 != 'Customer'
+        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 current_plan
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.current_plan
+        @current_plan ||= ENV.fetch('GRATIS_SUPPORT_CURRENT_SUB')
+      end
+
+      ##
+      # Sets the global variable plan
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.plan
+        @plan ||= ENV.fetch('GRATIS_SUPPORT_NEW_SUB')
+      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 an Upgrade Offerring
+
+          - 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}
+          - Plan customer is currently on: #{current_plan}
+          - Plan customer is trialing: #{plan}
+          - 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::Upgrade Offerring"
+
+          /due in 72 hours
+        STRING
+      end
+    end
+  end
+end

data/lib/support_readiness/support_super_form_processor/namespace_availability.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class NamespaceAvailability within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class NamespaceAvailability < Readiness::Client
+      ##
+      # Process a Namesquatting Availability check request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(client, admin_client)
+        @gitlab_client = client
+        @gitlab_admin_client = admin_client
+        requester
+        namespace_does_not_exist unless Readiness::GitLab::Namespaces.exists?(@gitlab_admin_client, namespace_to_check)
+        namespace_not_available if Readiness::GitLab::Namespaces.is_paid?(@gitlab_admin_client, namespace)
+        user_checks if namespace.kind. == 'user'
+        group_checks if namespace.kind == 'group'
+      end
+
+      ##
+      # Perform the user checks for a Namesquatting Availability check request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.user_checks
+        search = Readiness::GitLab::Users.search_by_username(@gitlab_admin_client, namespace_to_check)
+        user = search.detect { |s| s.username.downcase == namespace_to_check.downcase }
+        namespace_may_be_available if user.confirmed_at.nil? && user_created_recently?(user)
+        namespace_not_available if (Date.today - 2.years) < Date.parse(user.current_sign_in_at)
+        namespace_not_available if Readiness::GitLab::Users.only_maintainer?(@gitlab_admin_client, user)
+        namespace_may_be_available
+      end
+
+      ##
+      # Determines if a user was created recently
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      # @return [Boolean]
+      def self.user_created_recently?(user)
+        (Date.today - 90.days) < Date.parse(user.created_at)
+      end
+
+      ##
+      # Perform the group checks for a Namesquatting Availability check request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.group_checks
+        group = Readiness::GitLab::Groups.new
+        group.id = namespace.id
+        projects = Readiness::GitLab::Groups.projects(client, group, ["archived=false", "include_subgroups=true"])
+        detection = projects.detect { |p| (Date.today - 2.years) < Date.parse(p.last_activity_at) }
+        namespace_may_be_available if detection.nil?
+        namespace_not_available
+      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 namespace_to_check
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.namespace_to_check
+        @namespace_to_check ||= ENV.fetch('NAMESPACE_CHECK_NAMESPACE')
+      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 namespace
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.namespace
+        @namespace ||= Readiness::GitLab::Namespaces.find!(@gitlab_admin_client, namespace_to_check)
+      end
+
+      ##
+      # Handles the case where the namespace does not exist
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.namespace_does_not_exist
+        issue = Readiness::GitLab::Issues.new
+        issue.title = "Namespace Availability Check - #{CGI.escape(namespace_to_check)}"
+        issue.description = namespace_does_not_exist_message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      ##
+      # Handles the case where the namespace is not available
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.namespace_not_available
+        issue = Readiness::GitLab::Issues.new
+        issue.title = "Namespace Availability Check - #{CGI.escape(namespace_to_check)}"
+        issue.description = namespace_not_available_message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      ##
+      # Handles the case where the namespace may be available
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.namespace_may_be_available
+        issue = Readiness::GitLab::Issues.new
+        issue.title = "Namespace Availability Check - #{CGI.escape(namespace_to_check)}"
+        issue.description = namespace_may_be_available_message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      ##
+      # Returns the issue description for a case where the namespace is not available
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.namespace_not_available_message
+        <<~STRING
+          ## Namespace Availability Check for #{CGI.escape(namespace_to_check)}
+
+          Greetings @#{requester.username} !
+
+          We have looked into the availability of the namespace #{CGI.escape(namespace_to_check)} and have determined it will not be available for release at this time.
+
+          /label ~"AutomatedRequests::Namespace Availability Check"
+
+          /assign @#{requester.username} 
+        STRING
+      end
+
+      ##
+      # Returns the issue description for a case where the namespace does not exist
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.namespace_does_not_exist_message
+        <<~STRING
+          ## Namespace Availability Check for #{CGI.escape(namespace_to_check)}
+
+          Greetings @#{requester.username} !
+
+          We have looked into the availability of the namespace #{CGI.escape(namespace_to_check)} and have been unable to locate the namespace on gitlab.com. This would mean it is not currently in use at all and should be available at this exact moment in time.
+
+          /label ~"AutomatedRequests::Namespace Availability Check"
+
+          /assign @#{requester.username} 
+        STRING
+      end
+
+      ##
+      # Returns the issue description for a case where the namespace may be available
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.namespace_may_be_available_message
+        <<~STRING
+          ## Namespace Availability Check for #{CGI.escape(namespace_to_check)}
+
+          Greetings @#{requester.username} !
+
+          We have looked into the availability of the namespace #{CGI.escape(namespace_to_check)} and have determined it _may_ be available for release at this time.
+
+          Please note this only reflects the _possibility_ of release _at this exact time_. Any number of factors or events could change in the future to change this determination.
+
+          /label ~"AutomatedRequests::Namespace Availability Check"
+
+          /assign @#{requester.username} 
+        STRING
+      end
+    end
+  end
+end

data/lib/support_readiness/support_super_form_processor/pd_shadow_modification.rb

@@ -0,0 +1,189 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module SupportSuperFormProcessor
+  module SupportSuperFormProcessor
+    ##
+    # Defines the class PagerdutyShadowModification within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.42
+    class PagerdutyShadowModification < Readiness::Client
+      ##
+      # Process a Pagerduty Shadow Modification request
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.process!(gitlab_client, gitlab_admin_client, pagerduty_client)
+        @gitlab_client = gitlab_client
+        @gitlab_admin_client = gitlab_admin_client
+        @pagerduty_client = pagerduty_client
+        requester
+        pd_user = Readiness::Pagerduty::Users.find_by_email(@pagerduty_client, requester_email)
+        bad_pd_user if pd_user.nil?
+        schedule = Readiness::Pagerduty::Schedules.find!(@pagerduty_client, schedule_id)
+        layer = schedule.schedule_layers.detect { |l| l['name'] == "Layer #{layer_name}" }
+        if layer['users'].detect { |u| u['user']['id'] == pd_user.id }
+          type = 'remove'
+          if layer['users'].count == 1
+            layer['users'] = [{ user: { id: 'PRGFAO1', type: 'user_reference' }}]
+          else
+            layer['users'].delete_at(layer['users'].find_index { |u| u['user']['id'] == pd_user.id })
+          end
+        else
+          type = 'add'
+          if layer['users'].count == 1 && layer['users'].first['user']['id'] == 'PRGFAO1'
+            layer['users'] = [{ user: { id: pd_user.id, type: 'user_reference' }}]
+          else
+            layer['users'].push({ user: { id: pd_user.id, type: 'user_reference' }})
+          end
+        end
+        schedule.schedule_layers.each_with_index do |l, i|
+          schedule.schedule_layers[i] = layer if l['name'] == layer['name']
+          break if l['name'] == layer['name']
+        end
+        Readiness::Pagerduty::Schedules.update!(@pagerduty_client, schedule)
+        added if type == 'add'
+        removed if type == 'remove'
+      end
+
+      ##
+      # Creates an issue to indicate the requesterer doesn't have a PD user
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.bad_pd_user
+        issue = Readiness::GitLab::Issues.new
+        issue.title = "Invalid request regarding Pagerduty Shadow rotation"
+        issue.description = bad_user_message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      ##
+      # Creates an issue to indicate being added
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.added
+        issue = Readiness::GitLab::Issues.new
+        issue.title = "Add to Pagerduty Shadow rotation"
+        issue.description = added_message
+        create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
+        puts "Issue created: #{create.web_url}"
+        exit 0
+      end
+
+      ##
+      # Creates an issue to indicate being removed
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.removed
+        issue = Readiness::GitLab::Issues.new
+        issue.title = "Remove from Pagerduty Shadow rotation"
+        issue.description = removed_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 schedule_id
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.schedule_id
+        @schedule_id ||= ENV.fetch('PD_SHADOW_SCHEDULE')
+      end
+
+      ##
+      # Sets the global layer_name
+      #
+      # @author Jason Colyer
+      # @since 1.0.42
+      def self.layer_name
+        @layer_name ||= ENV.fetch('PD_SHADOW_LAYER')
+      end
+
+      def self.bad_user_message
+        <<~STRING
+          ## Invalid request regarding Pagerduty Shadow rotation
+
+          Greetings @#{requester.username} !
+
+          We received a request to add or remove you from a Pagerduty shadow rotation.
+
+          We were unable to proceed as a PD user using your email, #{requester_email}, was not found
+
+          Please double check your request to ensure the email you used matches the email in Pagerduty.
+
+          Once that has been rectified, please submit a new request.
+
+          /label ~"AutomatedRequests::Bad Pagerduty User"
+
+          /assign @#{requester.username}
+        STRING
+      end
+
+      def self.added_message
+        <<~STRING
+          ## Add to Pagerduty Shadow rotation
+
+          Greetings @#{requester.username} !
+
+          We received a request to add you to a Pagerduty shadow rotation. This is to let you know it has been completed at this time.
+
+          Do note you are at the top of the list, so your oncall for that would start this week.
+
+          /label ~"AutomatedRequests::Pagerduty"
+
+          /assign @#{requester.username}
+        STRING
+      end
+
+      def self.removed_message
+        <<~STRING
+          ## Remove from Pagerduty Shadow rotation
+
+          Greetings @#{requester.username} !
+
+          We received a request to remove you from a Pagerduty shadow rotation. This is to let you know it has been completed at this time.
+
+          /label ~"AutomatedRequests::Pagerduty"
+
+          /assign @#{requester.username}
+        STRING
+      end
+    end
+  end
+end