gitlab_support_readiness 1.0.90 → 1.0.92

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 80b4ed778d94e3611d7c5753c988aaa0e6b6e24825ed07a3bc18d66e7e103374
-  data.tar.gz: 1d20221f5950bc0f02139c4a4672c77bd38cab58c83aa93f8de6960f03f32da0
+  metadata.gz: 8e1bb9e106c7315b3948c30aea40a2c71996207ee7634d42a038b98365ce3879
+  data.tar.gz: e3ae654689797c2858906ba85ead2a827b96ad790b7420eb5f740f9dca98368f
 SHA512:
-  metadata.gz: 41c8dc7a3911017991183c7d20d069c1bb7728773aa13ede81efebdac61e0fbea7f361ae12215306cc69acb8456b0c9ed5ee1f5439c8e59bcf0c50586f39a814
-  data.tar.gz: 7eea03687ddd63f944ae3b84a88dc268afb8fcba3bfc5780a769072d19150ab9ef3b095f55fc388065b3354dc62c66a1b814032a37489e48097164c3e905430d
+  metadata.gz: f81a922e72e1e01418d998972953bdfd1a0bbdd3df1e48752d78b1870155dbfacc93c372a417bf86eec76e4f7e32e9beda4a0c262fc2e3cdfa32cb86d45d1eed
+  data.tar.gz: d4112092e1db77c60d52e5d0908f7a16bf231d5868b90017510766a8055cf55026fe6cfd99360724987813217173e052d05cf58b020f00f439739020e425d06f

data/lib/support_readiness/repos/automations.rb

@@ -237,7 +237,12 @@ module Readiness
           action['value'].each_with_index do |value, sub_index|
             next unless value == 'MANAGED_WEBHOOK'
 
-            object['actions'][index]['value'][sub_index] = JSON.parse(File.read(path))
+            converted_value = JSON.parse(File.read(path))
+            if converted_value.is_a? Hash
+              object['actions'][index]['value'][sub_index] = converted_value.to_json
+            else
+              object['actions'][index]['value'][sub_index] = converted_value
+            end
           end
         end
         object

data/lib/support_readiness/repos/triggers.rb

@@ -53,6 +53,7 @@ module Readiness
       #   pp diffs[:updates.count]
       #   # => 2
       def self.compare(zendesk_client, location = 'data', verbose = false)
+        @zendesk_client = zendesk_client
         diffs = {
           updates: [],
           creates: []
@@ -134,6 +135,11 @@ module Readiness
       #   pp repo.count
       #   # => 35
       def self.gather(location = 'data')
+        @categories = Readiness::Zendesk::TriggerCategories.list(@zendesk_client)
+        @schedules = Readiness::Zendesk::Schedules.list(@zendesk_client)
+        @ticket_fields = Readiness::Zendesk::TicketFields.list(@zendesk_client)
+        @ticket_forms = Readiness::Zendesk::TicketForms.list(@zendesk_client)
+        @webhooks = Readiness::Zendesk::Webhooks.list(@zendesk_client)
         @errors = []
         @location = location
         array = []
@@ -142,6 +148,11 @@ module Readiness
           object = convert_managed_content(object, f) if object['contains_managed_content']
           object['default'] = false
           #object = convert_managed_webhook(object, f) if object['contains_managed_webhook']
+          object = convert_names_to_ids(object)
+          if object['category_id'].to_i.zero?
+            trigger_category = Readiness::Zendesk::TriggerCategories.find_by_name(@zendesk_client, object['category_id'], @categories)
+            object['category_id'] = trigger_category.id.to_s
+          end
           validity_check(f, object)
           object['id'] = nil
           array.push(Zendesk::Triggers.new(object))
@@ -151,6 +162,64 @@ module Readiness
         array
       end
 
+      ##
+      # Converts various user Strings to the proper ID value
+      #
+      # @author Jason Colyer
+      # @since 1.0.92
+      # @param trigger [Hash] The trigger information from the YAMl file
+      # @return [Hash]
+      def self.convert_names_to_ids(trigger)
+        %w[any all].each do |type|
+          trigger['conditions'][type].each_with_index do |c, i|
+            if c['field'] == 'ticket_form_id'
+              if c['value'] =~ /Form\:\ /
+                name = c['value'].split('Form: ').last
+                ticket_form = Readiness::Zendesk::TicketForms.find_by_name(@zendesk_client, name, @ticket_forms)
+                trigger['conditions'][type][i]['value'] = ticket_form.id.to_s
+              end
+            end
+            if c['field'] =~ /Field\:\ /
+              name = c['field'].split('Field: ').last
+              ticket_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, name, @ticket_fields)
+              trigger['conditions'][type][i]['value'] = "custom_fields_#{ticket_field.id}"
+            end
+            if c['value'].to_s =~ /Schedule\:\ /
+              name = c['value'].split('Schedule: ').last
+              schedule = Readiness::Zendesk::Schedules.find_by_name(@zendesk_client, name, @schedules)
+              trigger['conditions'][type][i]['value'] = schedule.id.to_s
+            end
+          end
+        end
+        trigger['actions'].each_with_index do |a, i|
+          if a['field'] == 'notification_webhook'
+            if a['value'].first =~ /^Webhook\:\ /
+              name = a['value'].first.split('Webhook: ').last
+              webhook = Readiness::Zendesk::Webhooks.find_by_name(@zendesk_client, name, @webhooks)
+              trigger['actions'][i]['value'][0] = webhook.id.to_s
+            end
+          end
+          if a['field'] == 'ticket_form_id'
+            if a['value'] =~ /Form\:\ /
+              name = a['value'].split('Form: ').last
+              ticket_form = Readiness::Zendesk::TicketForms.find_by_name(@zendesk_client, name, @ticket_forms)
+              trigger['actions'][i]['value'] = ticket_form.id.to_s
+            end
+          end
+          if a['field'] =~ /Field\:\ /
+            name = a['field'].split('Field: ').last
+            ticket_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, name, @ticket_fields)
+            trigger['actions'][i]['field'] = "custom_fields_#{ticket_field.id}"
+          end
+          if a['field'] == 'set_schedule' && a['value'].to_s =~ /Schedule\:\ /
+            name = a['value'].split('Schedule: ').last
+            schedule = Readiness::Zendesk::Schedules.find_by_name(@zendesk_client, name, @schedules)
+            trigger['actions'][i]['value'] = schedule.id.to_s
+          end
+        end
+        trigger
+      end
+
       ##
       # Outputs an error report and exits with a status code of 1
       #
@@ -245,7 +314,12 @@ module Readiness
           action['value'].each_with_index do |value, sub_index|
             next unless value == 'MANAGED_WEBHOOK'
 
-            object['actions'][index]['value'][sub_index] = JSON.parse(File.read(path))
+            converted_value = JSON.parse(File.read(path))
+            if converted_value.is_a? Hash
+              object['actions'][index]['value'][sub_index] = converted_value.to_json
+            else
+              object['actions'][index]['value'][sub_index] = converted_value
+            end
           end
         end
         object

data/lib/support_readiness/zendesk/schedules.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Webhooks within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.92
+    # @todo Find methods
+    # @todo Create method
+    # @todo Update method
+    # @todo Delete method
+    # @todo Holiday methods
+    # @todo Update Intervals method
+    class Schedules < Readiness::Client
+      attr_accessor :id, :intervals, :name, :time_zone
+
+      ##
+      # Creates a new {Readiness::Zendesk::Schedules} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.92
+      # @param object [Object] An instance of {Readiness::Zendesk::Schedules}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::Schedules.new
+      def initialize(object = {})
+        @id = object['id']
+        @intervals = object['intervals']
+        @name = object['name']
+        @time_zone = object['time_zone']
+      end
+
+      ##
+      # Lists schedules
+      #
+      # @author Jason Colyer
+      # @since 1.0.92
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/ticket-management/schedules/#list-schedules Zendesk API > Schedules > List Schedules
+      # @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)
+      #   categories = Readiness::Zendesk::Schedules.list(client)
+      #   pp categories.first.id
+      #   # => 10001
+      def self.list(client)
+        response = client.connection.get 'business_hours/schedules'
+        handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+        body = Oj.load(response.body)
+        body['schedules'].map { |t| Schedules.new(t) }
+      end
+
+      ##
+      # Locates a schehdule within Zendesk by name. Can utilize a cacheh for quicker results
+      #
+      # @author Jason Colyer
+      # @since 1.0.92
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param name [String] The webhook name to look for
+      # @param cache [Array] The results of {Readiness::Zendesk::Schedules#list}
+      # @return [Object] An instance of {Readiness::Zendesk::Schedules}
+      # @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)
+      #   schedule = Readiness::Zendesk::Schedules.find_by_name!(client, 'North America')
+      #   pp schedule.id
+      #   # => 1
+      #   list = Readiness::Zendesk::Schedules.list(client)
+      #   schedule = Readiness::Zendesk::Schedules.find_by_name!(client, 'North America', list)
+      #   pp schedule.id
+      #   # => 1
+      def self.find_by_name(client, name, cache = nil)
+        list = if cache.nil?
+                 Schedules.list(client)
+               else
+                 cache
+               end
+        list.detect { |c| c.name == name }
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/ticket_fields.rb

@@ -154,12 +154,13 @@ module Readiness
       end
 
       ##
-      # Locates a ticket field within Zendesk by name. This will not exit on error (except Authentication errors)
+      # Locates a ticket field within Zendesk by name. Can utilize a cacheh for quicker results
       #
       # @author Jason Colyer
       # @since 1.0.12
       # @param client [Object] An instance of {Readiness::Zendesk::Client}
       # @param name [String] The ticket field name to look for
+      # @param cache [Array] The results of {Readiness::Zendesk::Webhooks#list}
       # @return [Object] An instance of {Readiness::Zendesk::TicketFields}
       # @example
       #   require 'support_readiness'
@@ -171,8 +172,12 @@ module Readiness
       #   field = Readiness::Zendesk::TicketFields.find_by_name(client, 'Age')
       #   pp field.id
       #   # => 89
-      def self.find_by_name(client, name)
-        fields = TicketFields.list(client)
+      def self.find_by_name(client, name, cache = nil)
+        fields = if cache.nil?
+                   TicketFields.list(client)
+                 else
+                   cache
+                 end
         fields.detect { |f| f.title == name }
       end
 

data/lib/support_readiness/zendesk/ticket_forms.rb

@@ -154,12 +154,13 @@ module Readiness
       end
 
       ##
-      # Locates a ticket form within Zendesk by name. This will not exit on error (except Authentication errors)
+      # Locates a ticket form within Zendesk by name. Can utilize a cacheh for quicker results
       #
       # @author Jason Colyer
       # @since 1.0.12
       # @param client [Object] An instance of {Readiness::Zendesk::Client}
       # @param name [String] The ticket form name to look for
+      # @param cache [Array] The results of {Readiness::Zendesk::Webhooks#list}
       # @return [Object] An instance of {Readiness::Zendesk::TicketForms}
       # @example
       #   require 'support_readiness'
@@ -171,8 +172,12 @@ module Readiness
       #   form = Readiness::Zendesk::TicketForms.find_by_name(client, 'Snowboard Problem')
       #   pp form.id
       #   # => 47
-      def self.find_by_name(client, name)
-        forms = TicketForms.list(client)
+      def self.find_by_name(client, name, cache = nil)
+        forms = if cache.nil?
+                  TicketForms.list(client)
+                else
+                  cache
+                end
         forms.detect { |f| f.name == name }
       end
 

data/lib/support_readiness/zendesk/trigger_categories.rb

@@ -0,0 +1,100 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class TriggerCategories within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.92
+    # @todo Find methods
+    # @todo Create method
+    # @todo Update method
+    # @todo Delete method
+    class TriggerCategories < Readiness::Client
+      attr_accessor :id, :name, :position
+
+      ##
+      # Creates a new {Readiness::Zendesk::TriggerCategories} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.92
+      # @param object [Object] An instance of {Readiness::Zendesk::TriggerCategories}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::TriggerCategories.new
+      def initialize(object = {})
+        @id = object['id']
+        @name = object['name']
+        @position = object['position']
+      end
+
+      ##
+      # Lists trigger categories
+      #
+      # @author Jason Colyer
+      # @since 1.0.92
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/trigger_categories/#list-ticket-trigger-categories Zendesk API > Ticket Trigger Categories > List Ticket Trigger Categories
+      # @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)
+      #   categories = Readiness::Zendesk::TriggerCategories.list(client)
+      #   pp categories.first.id
+      #   # => 10001
+      def self.list(client)
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("trigger_categories?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['trigger_categories'].map { |t| TriggerCategories.new(t) }
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        array
+      end
+
+      ##
+      # Locates a trigger category within Zendesk by name. Can utilize a cacheh for quicker results
+      #
+      # @author Jason Colyer
+      # @since 1.0.92
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param name [String] The trigger category name to look for
+      # @param cache [Array] The results of {Readiness::Zendesk::TriggerCategories#list}
+      # @return [Object] An instance of {Readiness::Zendesk::TriggerCategories}
+      # @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)
+      #   category = Readiness::Zendesk::TriggerCategories.find_by_name!(client, 'Notification App')
+      #   pp category.id
+      #   # => 10092446182300
+      #   list = Readiness::Zendesk::TriggerCategories.list(client)
+      #   category = Readiness::Zendesk::TriggerCategories.find_by_name!(client, 'Notification App', list)
+      #   pp category.id
+      #   # => 10092446182300
+      def self.find_by_name(client, name, cache = nil)
+        categories = if cache.nil?
+                       TriggerCategories.list(client)
+                     else
+                       cache
+                     end
+        categories.detect { |c| c.name == name }
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/triggers.rb

@@ -60,7 +60,7 @@ module Readiness
           array += body['triggers'].map { |t| Triggers.new(t) }
           break unless body['meta']['has_more']
 
-          opts = body['links'] ['next'].split('?').last
+          opts = body['links']['next'].split('?').last
         end
         array
       end

data/lib/support_readiness/zendesk/webhooks.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Webhooks within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.92
+    # @todo Find methods
+    # @todo Create method
+    # @todo Update method
+    # @todo Patch method
+    # @todo Test method
+    # @todo Delete method
+    class Webhooks < Readiness::Client
+      attr_accessor :authenticiation, :custom_headers, :endpoint, :http_method, :id, :name, :request_format, :status, :subscriptions
+
+      ##
+      # Creates a new {Readiness::Zendesk::Webhooks} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.92
+      # @param object [Object] An instance of {Readiness::Zendesk::Webhooks}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::Webhooks.new
+      def initialize(object = {})
+        @authenticiation = object['authenticiation']
+        @custom_headers = object['custom_headers']
+        @endpoint = object['endpoint']
+        @http_method = object['http_method']
+        @id = object['id']
+        @name = object['name']
+        @request_format = object['request_format']
+        @status = object['status']
+        @subscriptions = object['subscriptions']
+      end
+
+      ##
+      # Lists webhooks
+      #
+      # @author Jason Colyer
+      # @since 1.0.92
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/webhooks/webhooks-api/webhooks/#list-webhooks Zendesk API > Webhooks > List Webhooks
+      # @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)
+      #   categories = Readiness::Zendesk::Webhooks.list(client)
+      #   pp categories.first.id
+      #   # => 10001
+      def self.list(client)
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("webhooks?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['webhooks'].map { |t| Webhooks.new(t) }
+          break if !body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        array
+      end
+
+      ##
+      # Locates a webhook within Zendesk by name. Can utilize a cacheh for quicker results
+      #
+      # @author Jason Colyer
+      # @since 1.0.92
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param name [String] The webhook name to look for
+      # @param cache [Array] The results of {Readiness::Zendesk::Webhooks#list}
+      # @return [Object] An instance of {Readiness::Zendesk::Webhooks}
+      # @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)
+      #   webhook = Readiness::Zendesk::Webhooks.find_by_name!(client, 'Post update to ticket')
+      #   pp webhook.id
+      #   # => "01FQKTKVAQJ2BYDZ47KT35SCP9"
+      #   list = Readiness::Zendesk::Webhhooks.list(client)
+      #   webhook = Readiness::Zendesk::Webhooks.find_by_name!(client, 'Post update to ticket', list)
+      #   pp webhook.id
+      #   # => "01FQKTKVAQJ2BYDZ47KT35SCP9"
+      def self.find_by_name(client, name, cache = nil)
+        list = if cache.nil?
+                 Webhooks.list(client)
+               else
+                 cache
+               end
+        list.detect { |c| c.name == name }
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk.rb

@@ -25,6 +25,7 @@ module Readiness
     require "#{__dir__}/zendesk/organizations"
     require "#{__dir__}/zendesk/roles"
     require "#{__dir__}/zendesk/search"
+    require "#{__dir__}/zendesk/schedules"
     require "#{__dir__}/zendesk/sla_policies"
     require "#{__dir__}/zendesk/theme_job_statuses"
     require "#{__dir__}/zendesk/themes"
@@ -33,9 +34,11 @@ module Readiness
     require "#{__dir__}/zendesk/ticket_forms"
     require "#{__dir__}/zendesk/tickets"
     require "#{__dir__}/zendesk/triggers"
+    require "#{__dir__}/zendesk/trigger_categories"
     require "#{__dir__}/zendesk/user_field_options"
     require "#{__dir__}/zendesk/user_fields"
     require "#{__dir__}/zendesk/users"
     require "#{__dir__}/zendesk/views"
+    require "#{__dir__}/zendesk/webhooks"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.90
+  version: 1.0.92
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-02 00:00:00.000000000 Z
+date: 2025-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -401,6 +401,7 @@ files:
 - lib/support_readiness/zendesk/organization_memberships.rb
 - lib/support_readiness/zendesk/organizations.rb
 - lib/support_readiness/zendesk/roles.rb
+- lib/support_readiness/zendesk/schedules.rb
 - lib/support_readiness/zendesk/search.rb
 - lib/support_readiness/zendesk/sla_policies.rb
 - lib/support_readiness/zendesk/theme_job_statuses.rb
@@ -409,11 +410,13 @@ files:
 - lib/support_readiness/zendesk/ticket_fields.rb
 - lib/support_readiness/zendesk/ticket_forms.rb
 - lib/support_readiness/zendesk/tickets.rb
+- lib/support_readiness/zendesk/trigger_categories.rb
 - lib/support_readiness/zendesk/triggers.rb
 - lib/support_readiness/zendesk/user_field_options.rb
 - lib/support_readiness/zendesk/user_fields.rb
 - lib/support_readiness/zendesk/users.rb
 - lib/support_readiness/zendesk/views.rb
+- lib/support_readiness/zendesk/webhooks.rb
 homepage: https://gitlab.com/gitlab-support-readiness/gitlab_support_readiness_gem
 licenses:
 - MIT