gitlab_support_readiness 1.0.117 → 1.0.118

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cf9fab733d81a7aa5c5c5d9e471a0f227c8d18a054c8dc0c9da5f968697a107
-  data.tar.gz: c0203eb2c3522b57969e8ec42b85115e994ebbe619de02024e832e0f9e349e7b
+  metadata.gz: 9f0bcf366ba1eb4cf4cb4db3bd2c12f1813d2cfcb1354e270f4ad06e4597bfe5
+  data.tar.gz: 3fb6cafe83120494ba4dae58e319ef2f76631ec3160ea119dfd42d75bd4f21aa
 SHA512:
-  metadata.gz: 41579e75455d37c9139d7df45f2a413cdf5629469e51977af063e1bea5b28c024ce7c8222d4ab6da3a5aa0a4c8f12cf6a11e6fe399fe51702c931be1362465f5
-  data.tar.gz: 1931b9f5d11cf0fdab299ea3a73c31256d73d309510c996a176f598d7bebe1d4df201ef23b3da8b2b45ba61afe5a070fe26b041c81593562b633124351844d3a
+  metadata.gz: d660ad4f9ec5cc6d97a44dd816a53784f8a786bde8c7a53cbe69f9d0d009784c2315544ff38ade8fb7f3aa5fdbdbe52604f2ff9a5ca2e6b1ac84501e52e1f0b6
+  data.tar.gz: 825c5a0c2e0cc70024f0991a9ca5fcc2ce65602c226b662a2a4aeb449a49c25e61d4dbcfe0f443bc361bf328d4fb1d547a5eee73fde23c236a728eac40b71622

data/lib/support_readiness/client.rb

@@ -439,5 +439,82 @@ module Readiness
       end
       object
     end
+
+    ##
+    # Convert user friendly Strings into Zendesk values for ticket form objects
+    #
+    # @author Jason Colyer
+    # @since 1.0.118
+    # @param object [Object] The object to parse
+    def self.convert_ticket_form_names_to_ids(object)
+      new_object = covert_ticket_form_field_ids(object)
+      new_object = convert_ticket_form_end_user_conditions(new_object)
+      new_object = convert_ticket_form_agent_conditions(new_object)
+      convert_ticket_form_brands(new_object)
+    end
+
+    ##
+    # Convert user friendly Strings into Zendesk values for ticket form field IDs
+    #
+    # @author Jason Colyer
+    # @since 1.0.118
+    # @param object [Object] The ticket form to parse
+    def self.covert_ticket_form_field_ids(object)
+      object['ticket_field_ids'] = object['ticket_field_ids'].map do |f|
+        field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, f, @ticket_fields)
+        field.nil? ? f : field.id
+      end
+      object
+    end
+
+    ##
+    # Convert user friendly Strings into Zendesk values for ticket form end_user conditions
+    #
+    # @author Jason Colyer
+    # @since 1.0.118
+    # @param object [Object] The ticket form to parse
+    def self.convert_ticket_form_end_user_conditions(object)
+      object['end_user_conditions'].each_with_index do |c, ci|
+        parent_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, c['parent_field_id'], @ticket_fields)
+        object['end_user_conditions'][ci]['parent_field_id'] = parent_field.id unless parent_field.nil?
+        c['child_fields'].each_with_index do |cf, cfi|
+          child_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, cf['id'], @ticket_fields)
+          object['end_user_conditions'][ci]['child_fields'][cfi]['id'] = child_field.id unless child_field.nil?
+        end
+      end
+      object
+    end
+
+    ##
+    # Convert user friendly Strings into Zendesk values for ticket form agent conditions
+    #
+    # @author Jason Colyer
+    # @since 1.0.118
+    # @param object [Object] The ticket form to parse
+    def self.convert_ticket_form_agent_conditions(object)
+      object['agent_conditions'].each_with_index do |c, ci|
+        parent_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, c['parent_field_id'], @ticket_fields)
+        object['agent_conditions'][ci]['parent_field_id'] = parent_field.id unless parent_field.nil?
+        c['child_fields'].each_with_index do |cf, cfi|
+          child_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, cf['id'], @ticket_fields)
+          object['agent_conditions'][ci]['child_fields'][cfi]['id'] = child_field.id unless child_field.nil?
+        end
+      end
+      object
+    end
+
+    ##
+    # Convert user friendly Strings into Zendesk values for ticket form brands
+    #
+    # @author Jason Colyer
+    # @since 1.0.118
+    # @param object [Object] The ticket form to parse
+    def self.convert_ticket_form_brands(object)
+      object['restricted_brand_ids'] = object['restricted_brand_ids'].map do |b|
+        brand = Readiness::Zendesk::Brands.find_by_name(@zendesk_client, b, @brands)
+        brand.nil? ? b : brand.id
+      end
+      object
+    end
   end
 end

data/lib/support_readiness/repos/ticket_forms.rb

@@ -48,6 +48,7 @@ module Readiness
       #   pp diffs[:updates.count]
       #   # => 1
       def self.compare(zendesk_client, location = 'data', verbose = false)
+        @zendesk_client = zendesk_client
         diffs = {
           updates: [],
           creates: []
@@ -138,11 +139,14 @@ module Readiness
       #   pp repo.count
       #   # => 35
       def self.gather(location = 'data')
+        @brands = Readiness::Zendesk::Brands.list(@zendesk_client)
+        @ticket_fields = Readiness::Zendesk::TicketFields.list(@zendesk_client)
         @errors = []
         @location = location
         array = []
         Dir["#{@location}/**/*.yaml"].each do |f|
           object = YAML.safe_load_file(f)
+          object = convert_ticket_form_names_to_ids(object)
           validity_check(f, object)
           object['id'] = nil
           array.push(Zendesk::TicketForms.new(object))

data/lib/support_readiness/zendesk/brands.rb

@@ -0,0 +1,102 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Brands within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.118
+    # @todo find
+    # @todo find!
+    # @todo Create
+    # @todo Update
+    # @todo Delete
+    # @todo Check Host Mapping Validity
+    # @todo Check Host Mapping Validity for an Existing Brand
+    class Brands < Readiness::Client
+      attr_accessor :active, :brand_url, :created_at, :default, :has_help_center, :help_center_state, :host_mapping, :id, :logo, :name, :signature_template, :subdomain, :ticket_form_ids, :updated_at      
+
+      ##
+      # Creates a new {Readiness::Zendesk::Brands} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.118
+      # @param object [Object] An instance of {Readiness::Zendesk::Brands}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::Brands.new
+      def initialize(object = {})
+        @active = object['active']
+        @brand_url = object['brand_url']
+        @created_at = object['created_at']
+        @default = object['default']
+        @has_help_center = object['has_help_center']
+        @help_center_state = object['help_center_state']
+        @host_mapping = object['host_mapping']
+        @id = object['id']
+        @logo = object['logo']
+        @name = object['name']
+        @signature_template = object['signature_template']
+        @subdomain = object['subdomain']
+        @ticket_form_ids = object['ticket_form_ids']
+        @updated_at = object['updated_at']
+      end
+
+      ##
+      # Lists all brands.
+      #
+      # @author Jason Colyer
+      # @since 1.0.118
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/account-configuration/brands/#list-brands Zendesk API > Brands > List Brands
+      # @example
+      #   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)
+      #   brands = Readiness::Zendesk::Brands.list(client)
+      #   pp brands.count
+      #   # => 2
+      def self.list(client)
+        response = client.connection.get 'brands'
+        handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+        body = Oj.load(response.body)
+        body['brands'].map { |b| Brands.new(b) }
+      end
+
+      ##
+      # Locates a brand within Zendesk by name. Can utilize a cacheh for quicker results
+      #
+      # @author Jason Colyer
+      # @since 1.0.118
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param name [String] The brand name to look for
+      # @param cache [Array] The results of {Readiness::Zendesk::Brands#list}
+      # @return [Object] An instance of {Readiness::Zendesk::Brands}
+      # @example
+      #   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)
+      #   brand = Readiness::Zendesk::Brands.find_by_name(client, 'Brand 1')
+      #   pp brand.id
+      #   # => 360002783572
+      def self.find_by_name(client, name, cache = nil)
+        brands = if cache.nil?
+                   Brands.list(client)
+                 else
+                   cache
+                 end
+        brands.detect { |f| f.name == name }
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk.rb

@@ -11,6 +11,7 @@ module Readiness
     require "#{__dir__}/zendesk/apps"
     require "#{__dir__}/zendesk/articles"
     require "#{__dir__}/zendesk/automations"
+    require "#{__dir__}/zendesk/brands"
     require "#{__dir__}/zendesk/client"
     require "#{__dir__}/zendesk/configuration"
     require "#{__dir__}/zendesk/dynamic_content"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.117
+  version: 1.0.118
 platform: ruby
 authors:
 - Jason Colyer
@@ -405,6 +405,7 @@ files:
 - lib/support_readiness/zendesk/apps.rb
 - lib/support_readiness/zendesk/articles.rb
 - lib/support_readiness/zendesk/automations.rb
+- lib/support_readiness/zendesk/brands.rb
 - lib/support_readiness/zendesk/client.rb
 - lib/support_readiness/zendesk/configuration.rb
 - lib/support_readiness/zendesk/dynamic_content.rb