gitlab_support_readiness 1.0.111 → 1.0.113

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 76db68661570a026ab3995ec2a8b9ab882372b5589ed401881844485298ca670
-  data.tar.gz: 1bdb1a5122dca406871c78e1b65449c12422824163384e9bfff4c2d14145b8c7
+  metadata.gz: '027085156c8432506c68b06131cea002a4830cc4508556ccc6a56895c4d4440b'
+  data.tar.gz: 8e23a57b995694c5ffe85e9d47d113001fce4d40aba51796af9c4f34f554e4db
 SHA512:
-  metadata.gz: 4fe8cce60d44b4874f4d91bb8f1d3d5a6f50c8692e2f066cfc7ff232200d5f8fde8ed837bc9868facfaa294eea4ee2c0230dd00bebc23518afa7dbef7b5b7612
-  data.tar.gz: 81ffcf980569383eb449ad461e47a0f7185d9f7025ebd6e0bad8668e0567a7d9983fb18a54d8691852a84aeb30faff77b64941b0556e5166e1ad9e7de9d05fcd
+  metadata.gz: ad61f3ce7896ce12a581793771684f8e295121a3655382f5c85b94c60dd7c68393fadd7ea363b0f4ed697a6444ad118ed0e371682316f371516217bc47f0d6c4
+  data.tar.gz: ed9ac045fcf5e53cbb54d49356129ffb304648923c93c742455ec3b36b13f9229b645fd512b65569bc254e7b2175034c3a0ad7083790d4e4411adc9f2eb045dc

data/lib/support_readiness/client.rb

@@ -231,5 +231,171 @@ module Readiness
     def self.erb_renderer(file)
       ERB.new(File.read(file))
     end
+
+    ##
+    # Convert user friendly Strings into Zendesk values for standard objects
+    #
+    # @author Jason Colyer
+    # @since 1.0.112
+    # @param object [Object] The object to parse
+    def self.convert_standard_names_to_ids(object)
+      new_object = convert_conditions(object)
+      convert_actions(new_object)
+    end
+
+    ##
+    # Convert user friendly Strings within conditions into Zendesk values for standard objects
+    #
+    # @author Jason Colyer
+    # @since 1.0.112
+    # @param object [Object] The object to parse
+    def self.convert_conditions(object, attribute_name = 'conditions')
+      %w[any all].each do |type|
+        object[attribute_name][type].each_with_index do |c, i|
+          if c['field'] == 'group_id'
+            group = Readiness::Zendesk::Groups.find_by_name(@zendesk_client, c['value'], @groups)
+            unless group.nil?
+              object[attribute_name][type][i]['value'] = group.id.to_s
+            end
+          end
+          if c['field'] == 'organization_id'
+            code = c['value'].to_s
+            next if code.empty?
+            next if %r{^[0-9]+$}.match code
+
+            search = Readiness::Zendesk::Search.organizations(@zendesk_client, "salesforce_id:#{code}")
+            if search.count == 1
+              object[attribute_name][type][i]['value'] = search.first.id.to_s
+            end
+          end
+          if c['field'] == 'satisfaction_reason_code'
+            reason = Readiness::Zendesk::SatisfactionReasons.find_by_name(@zendesk_client, c['value'], @satisfaction_reasons)
+            unless reason.nil?
+              object[attribute_name][type][i]['value'] = reason.reason_code.to_s
+            end
+          end
+          if c['field'] == 'via_id'
+            via_type = Readiness::Zendesk::ViaTypes.find_by_name(c['value'])
+            unless via_type.nil?
+              object[attribute_name][type][i]['value'] = via_type.id.to_s
+            end
+          end
+          if c['field'] == 'requester_role'
+            role = Readiness::Zendesk::RequesterRoles.find_by_name(c['value'])
+            unless role.nil?
+              object[attribute_name][type][i]['value'] = role.id.to_s
+            end
+          end
+          if c['field'] == 'role'
+            role = Readiness::Zendesk::TicketUserTypes.find_by_name(@zendesk_client, c['value'])
+            unless role.nil?
+              object[attribute_name][type][i]['value'] = role.id.to_s
+            end
+          end
+          if c['field'] == 'assignee_id'
+            unless ['', 'current_user', 'requester_id'].include? c['value']
+              search = Readiness::Zendesk::Search.users(@zendesk_client, "email:#{c['value']}")
+              if search.count == 1
+                object[attribute_name][type][i]['value'] = search.first.id.to_s
+              end
+            end
+          end
+          if c['field'] == 'ticket_form_id'
+            if c['value'].to_s =~ /Form\:\ /
+              name = c['value'].split('Form: ').last
+              ticket_form = Readiness::Zendesk::TicketForms.find_by_name(@zendesk_client, name, @ticket_forms)
+              object[attribute_name][type][i]['value'] = ticket_form.id.to_s
+            end
+          end
+          if c['field'].to_s =~ /Field\:\ /
+            name = c['field'].split('Field: ').last
+            ticket_field = Readiness::Zendesk::TicketFields.find_by_name(@zendesk_client, name, @ticket_fields)
+            object[attribute_name][type][i]['field'] = "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)
+            object[attribute_name][type][i]['value'] = schedule.id.to_s
+          end
+        end
+      end
+      object
+    end
+
+    ##
+    # Convert user friendly Strings within actions into Zendesk values for standard objects
+    #
+    # @author Jason Colyer
+    # @since 1.0.112
+    # @param object [Object] The object to parse
+    def self.convert_actions(object)
+      object['actions'].each_with_index do |a, i|
+        if a['field'] == 'group_id'
+          group = Readiness::Zendesk::Groups.find_by_name(@zendesk_client, a['value'], @groups)
+          unless group.nil?
+            object['actions'][i]['value'] = group.id.to_s
+          end
+        end
+        if a['field'] == 'organization_id'
+          code = a['value']
+          next if code.empty?
+          next if %r{^[0-9]+$}.match code
+
+          search = Readiness::Zendesk::Search.organizations(@zendesk_client, "salesforce_id:#{code}")
+          if search.count == 1
+            object['actions'][i]['value'][0] = search.first.id.to_s
+          end
+        end
+        if a['field'] == 'notification_target'
+          if a['value'].first =~ /^Target\:\ /
+            name = a['value'].first.split('Target: ').last
+            target = Readiness::Zendesk::Targets.find_by_name(@zendesk_client, name, @targets)
+            object['actions'][i]['value'][0] = target.id.to_s
+          end
+        end
+        if a['field'] == 'role'
+          role = Readiness::Zendesk::TicketUserTypes.find_by_name(@zendesk_client, c['value'])
+          unless role.nil?
+            object['actions'][i]['value'] = role.id.to_s
+          end
+        end
+        if a['field'] == 'assignee_id'
+          unless ['', 'current_user', 'requester_id'].include? a['value']
+            search = Readiness::Zendesk::Search.users(@zendesk_client, "email:#{a['value']}")
+            if search.count == 1
+              object['actions'][i]['value'] = search.first.id.to_s
+            else
+              puts "Cannot find user #{a['value']} for #{object['title']}"
+              exit 1
+            end
+          end
+        end
+        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)
+            object['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)
+            object['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)
+          object['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)
+          object['actions'][i]['value'] = schedule.id.to_s
+        end
+      end
+      object
+    end
   end
 end

data/lib/support_readiness/repos/sla_policies.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: []
@@ -133,11 +134,20 @@ module Readiness
       #   pp repo.count
       #   # => 35
       def self.gather(location = 'data')
+        @categories = Readiness::Zendesk::TriggerCategories.list(@zendesk_client)
+        @groups = Readiness::Zendesk::Groups.list(@zendesk_client)
+        @schedules = Readiness::Zendesk::Schedules.list(@zendesk_client)
+        @satisfaction_reasons = Readiness::Zendesk::SatisfactionReasons.list(@zendesk_client)
+        @targets = Readiness::Zendesk::Targets.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 = []
         Dir["#{@location}/*.yaml"].each do |f|
           object = YAML.safe_load_file(f)
+          object = convert_conditions(object, 'filter')
           validity_check(f, object)
           object['id'] = nil
           array.push(Zendesk::SLAs.new(object))

data/lib/support_readiness/repos/triggers.rb

@@ -136,6 +136,7 @@ module Readiness
       #   # => 35
       def self.gather(location = 'data')
         @categories = Readiness::Zendesk::TriggerCategories.list(@zendesk_client)
+        @groups = Readiness::Zendesk::Groups.list(@zendesk_client)
         @schedules = Readiness::Zendesk::Schedules.list(@zendesk_client)
         @satisfaction_reasons = Readiness::Zendesk::SatisfactionReasons.list(@zendesk_client)
         @targets = Readiness::Zendesk::Targets.list(@zendesk_client)
@@ -150,7 +151,7 @@ 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)
+          object = convert_standard_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
@@ -164,140 +165,6 @@ 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'] == 'organization_id'              
-              code = c['value']
-              next if code.empty?
-              next if %r{^[0-9]+$}.match code
-
-              search = Readiness::Zendesk::Search.organizations(@zendesk_client, "salesforce_id:#{code}")
-              if search.count == 1
-                trigger['conditions'][type][i]['value'] = search.first.id.to_s
-              end
-            end
-            if c['field'] == 'satisfaction_reason_code'
-              reason = Readiness::Zendesk::SatisfactionReasons.find_by_name(@zendesk_client, c['value'], @satisfaction_reasons)
-              unless reason.nil?
-                trigger['conditions'][type][i]['value'] = reason.reason_code.to_s
-              end
-            end
-            if c['field'] == 'via_id'
-              via_type = Readiness::Zendesk::ViaTypes.find_by_name(c['value'])
-              unless via_type.nil?
-                trigger['conditions'][type][i]['value'] = via_type.id.to_s
-              end
-            end
-            if c['field'] == 'requester_role'
-              role = Readiness::Zendesk::RequesterRoles.find_by_name(c['value'])
-              unless role.nil?
-                trigger['conditions'][type][i]['value'] = role.id.to_s
-              end
-            end
-            if c['field'] == 'role'
-              role = Readiness::Zendesk::TicketUserTypes.find_by_name(@zendesk_client, c['value'])
-              unless role.nil?
-                trigger['conditions'][type][i]['value'] = role.id.to_s
-              end
-            end
-            if c['field'] == 'assignee_id'
-              unless ['', 'current_user', 'requester_id'].include? c['value']
-                search = Readiness::Zendesk::Search.users(@zendesk_client, "email:#{c['value']}")
-                if search.count == 1
-                  trigger['conditions'][type][i]['value'] = search.first.id.to_s
-                end
-              end
-            end
-            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]['field'] = "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'] == 'organization_id'
-            code = a['value']
-            next if code.empty?
-            next if %r{^[0-9]+$}.match code
-
-            search = Readiness::Zendesk::Search.organizations(@zendesk_client, "salesforce_id:#{code}")
-            if search.count == 1
-              trigger['actions'][i]['value'][0] = search.first.id.to_s
-            end
-          end
-          if a['field'] == 'notification_target'
-            if a['value'].first =~ /^Target\:\ /
-              name = a['value'].first.split('Target: ').last
-              target = Readiness::Zendesk::Targets.find_by_name(@zendesk_client, name, @targets)
-              trigger['actions'][i]['value'][0] = target.id.to_s
-            end
-          end
-          if a['field'] == 'role'
-            role = Readiness::Zendesk::TicketUserTypes.find_by_name(@zendesk_client, c['value'])
-            unless role.nil?
-              trigger['actions'][i]['value'] = role.id.to_s
-            end
-          end
-          if a['field'] == 'assignee_id'
-            unless ['', 'current_user', 'requester_id'].include? a['value']
-              search = Readiness::Zendesk::Search.users(@zendesk_client, "email:#{a['value']}")
-              if search.count == 1
-                trigger['actions'][i]['value'] = search.first.id.to_s
-              else
-                puts "Cannot find user #{a['value']} for #{trigger['title']}"
-                exit 1
-              end
-            end
-          end
-          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
       #

data/lib/support_readiness/zendesk/groups.rb

@@ -130,6 +130,34 @@ module Readiness
         Groups.new(Oj.load(response.body)['group'])
       end
 
+      ##
+      # Locates a group within Zendesk by name. Can utilize a cacheh for quicker results
+      #
+      # @author Jason Colyer
+      # @since 1.0.112
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param name [String] The group name to look for
+      # @param cache [Array] The results of {Readiness::Zendesk::Groups#list}
+      # @return [Object] An instance of {Readiness::Zendesk::Groups}
+      # @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)
+      #   field = Readiness::Zendesk::Groups.find_by_name(client, 'Security')
+      #   pp field.id
+      #   # => 456
+      def self.find_by_name(client, name, cache = nil)
+        groups = if cache.nil?
+                   Groups.list(client)
+                 else
+                   cache
+                 end
+        groups.detect { |f| f.name == name }
+      end
+
       ##
       # Creates a group. Will exit if unsuccessful
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.111
+  version: 1.0.113
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-01 00:00:00.000000000 Z
+date: 2025-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport