Class: Readiness::Repos::OrganizationFields

Inherits:
Client
  • Object
show all
Defined in:
lib/support_readiness/repos/organization_fields.rb

Overview

Defines the class OrganizationFields within the module Readiness::Repos.

Author:

  • Jason Colyer

Since:

  • 1.0.12

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

.compare(zendesk_client, location = 'data', verbose = false) ⇒ Hash

Compares the repo automation files to the Zendesk instance organization fields

Examples:

require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
diffs = Readiness::Repos::OrganizationFields.compare(client, 'organizations/fields/data', false)
pp diffs[:updates.count]
# => 1
require 'support_readiness'
config = Readiness::Zendesk::Configuration.new
config.username = 'alice@example.com'
config.token = 'test123abc'
config.url = 'https://example.zendesk.com/api/v2'
client = Readiness::Zendesk::Client.new(config)
diffs = Readiness::Repos::OrganizationFields.compare(client, 'organizations/fields/data', true)
# => Detailed diff of Support Ops
# => - @description Repo:
# => "For GitLab Support Operations"
# =>   @description Zendesk:
# => "For GitLab Support Ops"
# => Compare report:
# => - Creates: 0
# => - Updates: 1
pp diffs[:updates.count]
# => 1

Parameters:

  • zendesk_client (Object) —

    An instance of Zendesk::Client

  • location (String) (defaults to: 'data') —

    The location (relative or absolute) of the repo’s data folder

  • verbose (Boolean) (defaults to: false) —

    Whether you want a detailed report or not

Returns:

  • (Hash)

Author:

  • Jason Colyer

Since:

  • 1.0.12



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/support_readiness/repos/organization_fields.rb', line 50

def self.compare(zendesk_client, location = 'data', verbose = false)
  diffs = {
    updates: [],
    creates: []
  }
  from_repo = gather(location)
  from_zendesk = Zendesk::OrganizationFields.list(zendesk_client)
  from_repo.each do |repo|
    zd = from_zendesk.detect { |z| z.title == repo.title }
    if zd.nil?
      diffs[:creates].push(repo)
    else
      comparable_zd = zd.dup
      comparable_repo = repo.dup
      comparable_zd.id = nil
      comparable_zd.custom_field_options.map { |a| a.delete('raw_name') } unless comparable_zd.custom_field_options.nil?
      diffs[:updates].push(update_object(repo, zd)) if to_clean_json(comparable_repo) != to_clean_json(comparable_zd)
      detailed_diff(comparable_repo, comparable_zd) if verbose && to_clean_json(comparable_repo) != to_clean_json(comparable_zd)
    end
  end
  report_diffs(diffs) if verbose
  diffs
end

.detailed_diff(repo, zendesk) ⇒ Object

Outputs a comparison report

Parameters:

Author:

  • Jason Colyer

Since:

  • 1.0.12



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/support_readiness/repos/organization_fields.rb', line 93

def self.detailed_diff(repo, zendesk)
  puts "Detailed diff of #{repo.title}"
  repo.instance_variables.each do |v|
    next if v == :@id

    if repo.instance_variable_get(v) != zendesk.instance_variable_get(v)
      puts "- #{v} Repo:"
      pp repo.instance_variable_get(v)
      puts "  #{v} Zendesk:"
      pp zendesk.instance_variable_get(v)
    end
  end
end

.gather(location = 'data') ⇒ Array

Parses repo group files

Examples:

require 'support_readiness'
repo = Readiness::Repos::OrganizationFields.gather('organizations/fields/data')
pp repo.count
# => 35

Parameters:

  • location (String) (defaults to: 'data') —

    The location (relative or absolute) of the repo’s data folder

Returns:

  • (Array)

Author:

  • Jason Colyer

Since:

  • 1.0.12



133
134
135
136
137
138
139
140
141
142
143
144
145
146
 
# File 'lib/support_readiness/repos/organization_fields.rb', line 133

def self.gather(location = 'data')
  @errors = []
  @location = location
  array = []
  Dir["#{@location}/**/*.yaml"].each do |f|
    object = YAML.safe_load_file(f)
    validity_check(f, object)
    object['id'] = nil
    array.push(Zendesk::OrganizationFields.new(object))
  end
  repo_check(array)
  report_errors unless @errors.count.zero?
  array
end

.repo_check(objects) ⇒ Object

Performs basic checks on the repo

Parameters:

  • objects (Array) —

    The Array of Hashes derived from parsing the repo files

Author:

  • Jason Colyer

Since:

  • 1.0.12



183
184
185
186
187
188
189
190
 
# File 'lib/support_readiness/repos/organization_fields.rb', line 183

def self.repo_check(objects)
  duplicate_names = objects.group_by { |o| o.title }.select { |k, v| v.size > 1 }.map(&:first)
  unless duplicate_names.count.zero?
    duplicate_names.each do |d|
      @errors.push("The name '#{d}' is used in multiple files")
    end
  end
end

.report_diffs(diffs) ⇒ Object

Outputs a comparison report

Parameters:

  • diffs (Hash) —

    The returned value of compare

Author:

  • Jason Colyer

Since:

  • 1.0.12



80
81
82
83
84
 
# File 'lib/support_readiness/repos/organization_fields.rb', line 80

def self.report_diffs(diffs)
  puts 'Compare report:'
  puts "- Creates: #{diffs[:creates].count}"
  puts "- Updates: #{diffs[:updates].count}"
end

.report_errors ⇒ Object

Outputs an error report and exits with a status code of 1

Author:

  • Jason Colyer

Since:

  • 1.0.12



153
154
155
156
157
158
159
160
 
# File 'lib/support_readiness/repos/organization_fields.rb', line 153

def self.report_errors
  puts 'The following errors were found in the repo files:'
  @errors.each do |e|
    puts "- #{e}"
  end
  puts 'Rectify the errors and retry. We cannot proceed with those errors occurring.'
  exit 1
end

.update_object(repo, zendesk) ⇒ Object

Creates an instance of Zendesk::OrganizationFields to use for updates

Parameters:

Returns:

  • (Object)

Author:

  • Jason Colyer

Since:

  • 1.0.12



115
116
117
118
119
 
# File 'lib/support_readiness/repos/organization_fields.rb', line 115

def self.update_object(repo, zendesk)
  object = repo
  object.id = zendesk.id
  object
end

.validity_check(file, object) ⇒ Object

Performs basic checks on a repo file

Parameters:

  • file (String) —

    The path to the repo file

  • object (Hash) —

    The Hash derived from parsing a YAML file

Author:

  • Jason Colyer

Since:

  • 1.0.12



169
170
171
172
173
174
175
 
# File 'lib/support_readiness/repos/organization_fields.rb', line 169

def self.validity_check(file, object)
  folder = file.split("#{@location}/").last.split('/').first
  @errors.push("Missing title: #{file}") if object['title'].nil?
  @errors.push("Missing position: #{file}") if object['position'].nil?
  @errors.push("Inactive organization field in active folder: #{file}") if folder == 'active' && !object['active']
  @errors.push("Active organization field in inactive folder: #{file}") if folder == 'inactive' && object['active']
end