Class: Readiness::SupportSuperFormProcessor::GratisSupportMigration

Inherits:
Client
  • Object
show all
Defined in:
lib/support_readiness/support_super_form_processor/gratis_support_migration.rb

Overview

Defines the class GratisSupportMigration within the module Zendesk.

Author:

  • Jason Colyer

Since:

  • 1.0.42

Class Method Summary collapse

Methods inherited from Client

auth_error, bad_request_error, convert_actions, convert_conditions, convert_standard_names_to_ids, convert_ticket_form_agent_conditions, convert_ticket_form_brands, convert_ticket_form_end_user_conditions, convert_ticket_form_names_to_ids, convert_view_names_to_ids, convert_view_restrictions, covert_ticket_form_field_ids, create_package!, erb_renderer, handle_request_error, not_found_error, not_processible_error, put_into_archive, recursively_deflate_directory, timestamp_filename, to_clean_json, to_clean_json_with_key, to_hash, to_nearly_clean_json, to_nearly_clean_json_with_key, to_param_string, write_entries

Class Method Details

.account_query ⇒ Object

Returns a SOQL query string to get Account info

Author:

  • Jason Colyer

Since:

  • 1.0.42



186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 186

def self.
  <<~STRING
    SELECT
      Account.Account_ID_18__c,
      Account.Name,
      Account.Type
    FROM Account
    WHERE
      Account.Account_ID_18__c = '#{}'
  STRING
end

.checks ⇒ Object

Perform the checks for this request

Author:

  • Jason Colyer

Since:

  • 1.0.42



46
47
48
49
50
51
52
53
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 46

def self.checks
  if .nil?
    errors.push('Invalid SFDC account given')
  else
    errors.push('Incorrect SFDC account type') if .Type != 'Customer'
  end
  errors.push('Invalid manager handle given') if manager.nil?
end

.current_plan ⇒ Object

Sets the global variable current_plan

Author:

  • Jason Colyer

Since:

  • 1.0.42



137
138
139
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 137

def self.current_plan
  @current_plan ||= ENV.fetch('GRATIS_SUPPORT_CURRENT_SUB')
end

.determine_manager ⇒ Object

Sets the global variable customer_email

Author:

  • Jason Colyer

Since:

  • 1.0.42



164
165
166
167
168
169
170
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 164

def self.determine_manager
  user_search = Readiness::GitLab::Users.search_by_username(@gitlab_admin_client, manager_handle)
  found_user = user_search.detect { |u| u.email.downcase == manager_handle.downcase }
  return nil if found_user.nil?

  found_user
end

.determine_sfdc_account_id ⇒ Object

Determines the SFDC Account ID based off of the link given

Author:

  • Jason Colyer

Since:

  • 1.0.42



96
97
98
99
100
101
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 96

def self.
  link = ENV.fetch('GRATUS_SUPPORT_SFDC_ACCOUNT')
  return link.split('/')[-2] if link =~ /lightning/

  link.split('/').last
end

.errors ⇒ Object

Sets the global variable errors

Author:

  • Jason Colyer

Since:

  • 1.0.42



37
38
39
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 37

def self.errors
  @errors ||= []
end

.errors_block ⇒ Object

Returns a string for the errors block

Author:

  • Jason Colyer

Since:

  • 1.0.42



203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 203

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

.fetch_sfdc_account ⇒ Object

Gets the SFDC Account information

Author:

  • Jason Colyer

Since:

  • 1.0.42



117
118
119
120
121
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 117

def self.
  query = Readiness::Salesforce::Queries.new()
  results = Readiness::Salesforce::Queries.run!(@sfdc_client, query)
  results.first
end

.justification ⇒ Object

Sets the global variable justification

Author:

  • Jason Colyer

Since:

  • 1.0.42



128
129
130
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 128

def self.justification
  @justification ||= ENV.fetch('GRATUS_SUPPORT_JUSTIFICATION')
end

.manager ⇒ Object

Sets the global variable manager

Author:

  • Jason Colyer

Since:

  • 1.0.44



155
156
157
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 155

def self.manager
  @manager ||= determine_manager
end

.manager_handle ⇒ Object

Sets the global variable manager_handle

Author:

  • Jason Colyer

Since:

  • 1.0.44



177
178
179
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 177

def self.manager_handle
  @manager_handle ||= ENV.fetch('GRATUS_SUPPORT_APPROVING_MANAGER')
end

.message ⇒ Object

Returns a string for the issue body

Author:

  • Jason Colyer

Since:

  • 1.0.42



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 222

def self.message
  <<~STRING
    ## Gratis Support Request for a Migration Offerring

    - Requester: @#{requester.username}
    - Approver: @#{manager.nil? ? manager_handle : manager.username}
    - SFDC Account: #{.nil? ?  : .Account_ID_18__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::Migration Offerring"

    /due in 72 hours
  STRING
end

.plan ⇒ Object

Sets the global variable plan

Author:

  • Jason Colyer

Since:

  • 1.0.42



146
147
148
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 146

def self.plan
  @plan ||= ENV.fetch('GRATIS_SUPPORT_NEW_SUB')
end

.process!(gitlab_client, gitlab_admin_client, sfdc_client) ⇒ Object

Process a Gratis Support Migration request

Author:

  • Jason Colyer

Since:

  • 1.0.42



18
19
20
21
22
23
24
25
26
27
28
29
30
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 18

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 Migration Offerring'
  issue.description = message
  create = Readiness::GitLab::Issues.create!(@gitlab_client, project, issue)
  puts "Issue created: #{create.web_url}"
  exit 0
end

.project ⇒ Object

Sets the global variable project

Author:

  • Jason Colyer

Since:

  • 1.0.42



78
79
80
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 78

def self.project
  @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
end

.requester ⇒ Object

Sets the global variable requester

Author:

  • Jason Colyer

Since:

  • 1.0.42



60
61
62
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 60

def self.requester
  @requester ||= Readiness::SupportSuperFormProcessor::Shared.gitlab_user_check(@gitlab_admin_client, requester_email)
end

.requester_email ⇒ Object

Sets the global variable requester_email

Author:

  • Jason Colyer

Since:

  • 1.0.42



69
70
71
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 69

def self.requester_email
  @requester_email ||= ENV.fetch('REQUESTER_EMAIL')
end

.sfdc_account ⇒ Object

Sets the global variable sfdc_account

Author:

  • Jason Colyer

Since:

  • 1.0.42



108
109
110
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 108

def self.
  @sfdc_account ||= 
end

.sfdc_account_id ⇒ Object

Sets the global variable sfdc_account_id

Author:

  • Jason Colyer

Since:

  • 1.0.42



87
88
89
 
# File 'lib/support_readiness/support_super_form_processor/gratis_support_migration.rb', line 87

def self.
  @sfdc_account_id ||= 
end