gitlab_support_readiness 1.0.110 → 1.0.112

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bcaad3ddf5dae80d44628c64919b1816fdcf5b9f55bcaf16be572abda1d39f40
-  data.tar.gz: a4e96419eda25a20c671d05ad98b4b368bd32a9585eb3d078cfdfb8f670100c5
+  metadata.gz: 8edd59d6823d5030545aa74b9ce7dba68822470283bc7384a6e071ea04003f94
+  data.tar.gz: 8f0871238aa1a5d14879f036b1e0dbaeff16e3a507c17451b51461093ec4f843
 SHA512:
-  metadata.gz: e0f612510cf7978298d2efdd89c7f7472c8662a5de27be23a81ad4bcf6741ef3265cb9c6ce74d4c0cd843895f17ead184c7dc2a12468b7fa22a115a878007536
-  data.tar.gz: e0541f1e0afc68ae449e67511d929a77eda037d5e9c5b29bd81eee49e15bc91748ba7447a905b60684125fd1e6b2def101746071241b7471129db6eebac73614
+  metadata.gz: bc6f3c2f6f6a4408f1639a2276c74305417af57536bf3f6a0d7b268c0c7b85283613b93ef9454c44bd6f7b7fcf465d58e85cc8ea9fda18dd2d83f85329576097
+  data.tar.gz: b7af37d1003e016d0269015402781d45c9cb25827d66024f3a3d5e7911866e7b37cc723fcdbdb087921ac2032554ced35f0dc411f06b4382da9adbfb7bcd3f26

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)
+      %w[any all].each do |type|
+        object['conditions'][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['conditions'][type][i]['value'] = group.id.to_s
+            end
+          end
+          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
+              object['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?
+              object['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?
+              object['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?
+              object['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?
+              object['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
+                object['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)
+              object['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)
+            object['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)
+            object['conditions'][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/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,136 +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 unless code.to_i.zero?
-
-              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']
-            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.110
+  version: 1.0.112
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-01-31 00:00:00.000000000 Z
+date: 2025-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport