Class: Readiness::SupportSuperFormProcessor::GlobalIRDotcomSubscriptionsExtension

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

Overview

Defines the class GlobalIRDotcomSubscriptionsExtension 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

.body ⇒ String

Returns the ticket body

Returns:

  • (String)

Author:

  • Jason Colyer

Since:

  • 1.0.42



216
217
218
219
220
221
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
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 216

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 Extend an (almost) expired subscription (GitLab.com).
    </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>#{Readiness::SupportSuperFormProcessor::Shared.()}</li>
      <li>#{Readiness::SupportSuperFormProcessor::Shared.sfdc_opportunity_string(opp_link)}</li>
      <li>GitLab.com namespace: #{@namespace.path}</li>
      <li>Plan: #{plan}</li>
      <li>Requested expiration date: #{extension_date}</li>
      <li>Subscription name: #{sub_name}</li>
      <li>Reason for extension: #{reason}</li>
    </ul>
    <p>
      <b>
        Verify the provided proof of approval of the extension before proceeding
      </b>
    </p>
    <p>
      Some additional context for this request is:
    </p>
    <pre>
      #{context}
    </pre>
  STRING
end

.company ⇒ Object

Sets the global variable company

Author:

  • Jason Colyer

Since:

  • 1.0.42



143
144
145
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 143

def self.company
  @company ||= ENV.fetch('COMPANY')
end

.contact_email ⇒ Object

Sets the global variable contact_email

Author:

  • Jason Colyer

Since:

  • 1.0.42



134
135
136
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 134

def self.contact_email
  @contact_email ||= ENV.fetch('CONTACT_EMAIL')
end

.contact_name ⇒ Object

Sets the global variable contact_name

Author:

  • Jason Colyer

Since:

  • 1.0.42



125
126
127
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 125

def self.contact_name
  @contact_name ||= ENV.fetch('CONTACT_NAME')
end

.context ⇒ Object

Sets the global variable context

Author:

  • Jason Colyer

Since:

  • 1.0.42



116
117
118
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 116

def self.context
  @context ||= ENV.fetch('LNR_OTHER_CONTEXT')
end

.extension_date ⇒ Object

Sets the global variable extension_date

Author:

  • Jason Colyer

Since:

  • 1.0.42



188
189
190
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 188

def self.extension_date
  @extension_date ||= ENV.fetch('EXPIRATION_DATE')
end

.namespace_provided ⇒ Object

Sets the global variable namespace_provided

Author:

  • Jason Colyer

Since:

  • 1.0.42



161
162
163
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 161

def self.namespace_provided
  @namespace_provided ||= ENV.fetch('NAMESPACE')
end

.opp_link ⇒ Object

Sets the global variable opp_link

Author:

  • Jason Colyer

Since:

  • 1.0.42



152
153
154
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 152

def self.opp_link
  @opp_link ||= ENV.fetch('SFDC_OPPORTUNITY')
end

.plan ⇒ Object

Sets the global variable plan

Author:

  • Jason Colyer

Since:

  • 1.0.42



170
171
172
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 170

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

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

Process a Global Internal Request GitLab.com Subscriptions Extension request

Author:

  • Jason Colyer

Since:

  • 1.0.42



18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 18

def self.process!(gitlab_client, gitlab_admin_client, zendesk_client)
  @gitlab_client = gitlab_client
  @gitlab_admin_client = gitlab_admin_client
  @zendesk_client = zendesk_client
  @ticket_forms = Readiness::Zendesk::TicketForms.list(@zendesk_client)
  @ticket_fields = Readiness::Zendesk::TicketFields.list(@zendesk_client)
  @lnr_form = Readiness::Zendesk::TicketForms.find_by_name(@zendesk_client, 'L&R', @ticket_forms)
  @area_of_focus_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'Area of Focus', @ticket_fields)
  @ticket_stage_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'Ticket Stage', @ticket_fields)
  @prfs_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'Preferred Region for Support', @ticket_fields)
  @plan_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'GitLab Plan', @ticket_fields)
  @sales_name_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'Sales contact name', @ticket_fields)
  @sales_email_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'Sales contact email', @ticket_fields)
  @severity_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'Customer Severity (maps to priority, do not change)', @ticket_fields)
  @arr_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'Ticket ARR', @ticket_fields)
  @priority_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'Customer Priority', @ticket_fields)
  @ir_category_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'IR Category', @ticket_fields)
  @ir_submitter_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'IR Submitter', @ticket_fields)
  @channel_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, 'Channel (Received at email)', @ticket_fields)
  search = Readiness::Zendesk::Users.find_many(@zendesk_client, [379855863520, 12816218763676])
  end_user = search.detect { |s| s.email == 'gitlab_support@example.com' }        
  requester
  zd_user
  unless Readiness::SupportSuperFormProcessor::Shared.namespace_exists?(@gitlab_admin_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_ccs = [
    { user_id: zd_user.id }
  ]
  ticket.requester_id = end_user.id
  ticket.submitter_id = end_user.id
  ticket.comment = { html_body: body }
  ticket.subject = 'Internal Request - GitLab.com - Extend an (almost) expired subscription'
  ticket.tags = %w[lnr_internal_request lnr_valid_request lnr_saas_subscription lnr_saas_sub_extension]
  ticket.priority = request_priority
  ticket.status = 'new'
  ticket.ticket_form_id = @lnr_form.id
  ticket.custom_fields = [
    { id: @area_of_focus_field.id, value: 'aof_lnr' },
    { id: @ticket_stage_field.id, value: 'stage-frt' },
    { id: @prfs_field.id, value: 'all_regions' },
    { id: @plan_field.id, value: 'free_plan' },
    { id: @sales_name_field.id, value: zd_user.name },
    { id: @sales_email_field.id, value: zd_user.email },
    { id: @severity_field.id, value: 'sev3' },
    { id: @arr_field.id, value: '0' },
    { id: @priority_field.id, value: 'medium' },
    { id: @ir_category_field.id, value: 'ir_extend_saas_sub' },
    { id: @ir_submitter_field.id, value: zd_user.email },
    { id: @channel_field.id, value: 'created_by_agent' }          
  ]
  create = Readiness::Zendesk::Tickets.create!(@zendesk_client, ticket)
  puts "Ticket created: #{create.id}"
end

.reason ⇒ Object

Sets the global variable reason

Author:

  • Jason Colyer

Since:

  • 1.0.42



206
207
208
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 206

def self.reason
  @reason ||= ENV.fetch('EXTENSION_REASON')
end

.request_priority ⇒ Object

Sets the global variable request_priority

Author:

  • Jason Colyer

Since:

  • 1.0.42



107
108
109
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 107

def self.request_priority
  @request_priority ||= ENV.fetch('PRIORITY')
end

.requester ⇒ Object

Sets the global variable requester

Author:

  • Jason Colyer

Since:

  • 1.0.42



80
81
82
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 80

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



98
99
100
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 98

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

.sfdc_account_link ⇒ Object

Sets the global variable sfdc_account_link

Author:

  • Jason Colyer

Since:

  • 1.0.42



179
180
181
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 179

def self.
  @sfdc_account_link ||= ENV.fetch('SFDC_ACCOUNT')
end

.sub_name ⇒ Object

Sets the global variable sub_name

Author:

  • Jason Colyer

Since:

  • 1.0.42



197
198
199
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 197

def self.sub_name
  @sub_name ||= ENV.fetch('SUB_NAME')
end

.zd_user ⇒ Object

Sets the global variable zd_user

Author:

  • Jason Colyer

Since:

  • 1.0.42



89
90
91
 
# File 'lib/support_readiness/support_super_form_processor/global_ir_dotcom_subscriptions_extension.rb', line 89

def self.zd_user
  @zd_user ||= Readiness::SupportSuperFormProcessor::Shared.zendesk_user_check(@zendesk_client, requester_email)
end