gitlab_support_readiness 1.0.11 → 1.0.12

data/lib/support_readiness/zendesk/ticket_fields.rb

@@ -9,11 +9,6 @@ module Readiness
     #
     # @author Jason Colyer
     # @since 1.0.0
-    # @todo List ticket field options
-    # @todo Show ticket field option
-    # @todo Create or update ticket field option
-    # @todo Delete ticket field option
-    # @todo Reorder ticket fields
     class TicketFields < Readiness::Client
       attr_accessor :active, :agent_description, :collapsed_for_agents, :custom_field_options, :description, :editable_in_portal, :id, :key, :position, :regexp_for_validation, :removable, :required, :system_field_options, :tag, :title, :title_in_portal, :type, :visible_in_portal
 
@@ -22,15 +17,21 @@ module Readiness
       #
       # @author Jason Colyer
       # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
       # @param object [Object] An instance of {Readiness::Zendesk::TicketFields}
       # @example
       #   require 'support_readiness'
-      #   Readiness::Zendesk::TicketFields.new
-      def initialize(object = {})
+      #   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)
+      #   Readiness::Zendesk::TicketFields.new(client)
+      def initialize(client, object = {})
         @active = object['active']
         @agent_description = object['agent_description']
         @collapsed_for_agents = object['collapsed_for_agents']
-        @custom_field_options = object['custom_field_options']
+        @custom_field_options = ticket_field_options(client, object)
         @description = object['description']
         @editable_in_portal = object['editable_in_portal']
         @id = object['id']
@@ -47,6 +48,24 @@ module Readiness
         @visible_in_portal = object['visible_in_portal']
       end
 
+      ##
+      # Gets the ticket field options for a ticket field
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param object [Varies] Either a Hash from JSON or a {Readiness::Zendesk::TicketFields} instance
+      # @return [Array]
+      def ticket_field_options(client, object)
+        return nil unless %w[tagger multiselect].include? object['type']
+
+        # Handles when the position value is nil
+        object['custom_field_options'].each do |c|
+          c['position'] = object['custom_field_options'].index(c)
+        end
+        object['custom_field_options'].map { |c| TicketFieldOptions.new(c) }
+      end
+
       ##
       # Lists all ticket fields.
       #
@@ -72,7 +91,7 @@ module Readiness
           response = client.connection.get("ticket_fields?#{opts}")
           handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
           body = Oj.load(response.body)
-          array += body['ticket_fields'].map { |f| TicketFields.new(f) }
+          array += body['ticket_fields'].map { |f| TicketFields.new(client, f) }
           break if limit != 0 && array.count >= (limit * 100)
           break unless body['meta']['has_more']
 
@@ -103,7 +122,7 @@ module Readiness
       def self.find(client, fid)
         response = client.connection.get("ticket_fields/#{fid}")
         handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: fid }) unless response.status == 200
-        return TicketFields.new(Oj.load(response.body)['ticket_field']) if response.status == 200
+        return TicketFields.new(client, Oj.load(response.body)['ticket_field']) if response.status == 200
 
         Oj.load(response.body)
       end
@@ -130,11 +149,59 @@ module Readiness
       def self.find!(client, fid)
         response = client.connection.get("ticket_fields/#{fid}")
         handle_request_error(1, 'Zendesk', response.status, { action: 'Find ticket field', id: fid }) unless response.status == 200
-        TicketFields.new(Oj.load(response.body)['ticket_field'])
+        TicketFields.new(client, Oj.load(response.body)['ticket_field'])
+      end
+
+      ##
+      # Locates a ticket field within Zendesk by name. This will not exit on error (except Authentication errors)
+      #
+      # @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
+      # @return [Object] An instance of {Readiness::Zendesk::TicketFields}
+      # @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::TicketFields.find_by_name(client, 'Age')
+      #   pp field.id
+      #   # => 89
+      def self.find_by_name(client, name)
+        fields = TicketFields.list(client)
+        fields.detect { |f| f.title == name }
+      end
+
+      ##
+      # Locates a ticket field within Zendesk by name. This will exit on error
+      #
+      # @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
+      # @return [Object] An instance of {Readiness::Zendesk::TicketFields}
+      # @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::TicketFields.find_by_name!(client, 'Age')
+      #   pp field.id
+      #   # => 89
+      def self.find_by_name!(client, name)
+        fields = TicketFields.list(client)
+        field = fields.detect { |f| f.title == name }
+        handle_request_error(1, 'Zendesk', 404, { action: 'Find ticket field', id: name }) if field.nil?
+        field
       end
 
       ##
-      # Creates a ticket field. Will exit if unsuccessful
+      # Creates a ticket field. Will exit if unsuccessful. Note that this does not not create ticket field options. Use {Readiness::Zendesk::TicketFieldOptions} for that.
       #
       # @author Jason Colyer
       # @since 1.0.0
@@ -149,20 +216,21 @@ module Readiness
       #   config.token = 'test123abc'
       #   config.url = 'https://example.zendesk.com/api/v2'
       #   client = Readiness::Zendesk::Client.new(config)
-      #   field = Readiness::Zendesk::TicketFields.new
+      #   field = Readiness::Zendesk::TicketFields.new(client)
       #   field.type = 'text'
       #   field.title = 'Age'
       #   create = Readiness::Zendesk::TicketFields.create!(client, field)
       #   pp create.id
       #   # => 89
       def self.create!(client, field)
+        field.custom_field_options = nil
         response = client.connection.post 'ticket_fields', to_clean_json_with_key(field, 'ticket_field')
         handle_request_error(1, 'Zendesk', response.status, { action: 'Create ticket field', message: Oj.load(response.body)}) unless response.status == 201
-        TicketFields.new(Oj.load(response.body)['ticket_field'])
+        TicketFields.new(client, Oj.load(response.body)['ticket_field'])
       end
 
       ##
-      # Updates a ticket field. Will exit if unsuccessful
+      # Updates a ticket field. Will exit if unsuccessful. Note that this does not not update ticket field options. Use {Readiness::Zendesk::TicketFieldOptions} for that.
       #
       # @author Jason Colyer
       # @since 1.0.0
@@ -187,9 +255,10 @@ module Readiness
       #   pp update.title
       #   # => "Pies"
       def self.update!(client, field)
+        field.custom_field_options = nil
         response = client.connection.put "ticket_fields/#{field.id}", to_clean_json_with_key(field, 'ticket_field')
         handle_request_error(1, 'Zendesk', response.status, { action: 'Update ticket field', message: Oj.load(response.body)}) unless response.status == 200
-        TicketFields.new(Oj.load(response.body)['ticket_field'])
+        TicketFields.new(client, Oj.load(response.body)['ticket_field'])
       end
 
       ##

data/lib/support_readiness/zendesk/ticket_forms.rb

@@ -23,10 +23,10 @@ module Readiness
       #   Readiness::Zendesk::TicketForms.new
       def initialize(object = {})
         @active = object['active']
-        @agent_conditions = object['agent_conditions']
+        @agent_conditions = clean_conditions(object['agent_conditions'])
         @default = object['default']
         @display_name = object['display_name']
-        @end_user_conditions = object['end_user_conditions']
+        @end_user_conditions = clean_conditions(object['end_user_conditions'])
         @end_user_visible = object['end_user_visible']
         @id = object['id']
         @in_all_brands = object['in_all_brands']
@@ -36,6 +36,21 @@ module Readiness
         @ticket_field_ids = object['ticket_field_ids']
       end
 
+      ##
+      # Removes unneeded values from the conditions variable on a {Readiness::Zendesk::TicketForms} object
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param conditions [Hash]
+      # @return [Hash]
+      def clean_conditions(conditions)
+        return nil if conditions.nil?
+        return [] if conditions.count.zero?
+
+        conditions.map { |c| c.delete('parent_field_type') }
+        conditions
+      end
+
       ##
       # Lists the first 100 ticket forms
       #
@@ -137,6 +152,54 @@ module Readiness
         Oj.load(response.body)['ticket_forms'].map { |f| TicketForms.new(f) }
       end
 
+      ##
+      # Locates a ticket form within Zendesk by name. This will not exit on error (except Authentication errors)
+      #
+      # @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
+      # @return [Object] An instance of {Readiness::Zendesk::TicketForms}
+      # @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)
+      #   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)
+        forms.detect { |f| f.name == name }
+      end
+
+      ##
+      # Locates a ticket field within Zendesk by name. This will exit on error
+      #
+      # @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
+      # @return [Object] An instance of {Readiness::Zendesk::TicketForms}
+      # @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)
+      #   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)
+        form = forms.detect { |f| f.name == name }
+        handle_request_error(1, 'Zendesk', 404, { action: 'Find ticket form', id: name }) if form.nil?
+        form
+      end
+
       ##
       # Creates a ticket form. Will exit if unsuccessful
       #

data/lib/support_readiness/zendesk/tickets.rb

@@ -846,6 +846,83 @@ module Readiness
         handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many suspended ticket', id: sids }) unless response.status == 200
         true
       end
+
+      ##
+      # Redacts all attachments (inline and external) within a ticket. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param ticket [Object] An instance of {Readiness::Zendesk::Tickets}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/#redact-ticket-comment-in-agent-workspace Zendesk API > Ticket Comments > Redact Ticket Comment In Agent Workspace
+      # @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)
+      #   ticket = Readiness::Zendesk::Tickets.find!(client, 141)
+      #   redaction = Readiness::Zendesk::Tickets.redact_attachments!(client, ticket)
+      #   pp redaction
+      #   # => true
+      def self.redact_attachments(client, ticket)
+        redactions = []
+        Tickets.comments(client, ticket).each do |c|
+          object = {
+            id: c['id'],
+            redaction: { ticket_id: ticket.id }
+          }
+          object[:redaction][:external_attachment_urls] = c['attachments'].map { |a| a['content_url'] } unless c['attachments'].count.zero?
+          object[:redaction][:html_body] = c['html_body'].gsub('<img', '<img redact') if c['html_body'] =~ /<img/
+          redactions.push(object) unless object[:redaction][:external_attachment_urls].nil? && object[:redaction][:html_body].nil?
+        end
+        redactions.each do |r|
+          response = client.connection.put "comment_redactions/#{r[:id]}", r[:redaction].to_json
+          handle_request_error(0, 'Zendesk', response.status, { action: 'Redact attachments', id: "tickets/#{ticket.id}/comments/#{r[:id]}" }) unless response.status == 200
+          return false
+        end
+        true
+      end
+
+      ##
+      # Redacts all attachments (inline and external) within a ticket. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param ticket [Object] An instance of {Readiness::Zendesk::Tickets}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/ticket_comments/#redact-ticket-comment-in-agent-workspace Zendesk API > Ticket Comments > Redact Ticket Comment In Agent Workspace
+      # @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)
+      #   ticket = Readiness::Zendesk::Tickets.find!(client, 141)
+      #   redaction = Readiness::Zendesk::Tickets.redact_attachments!(client, ticket)
+      #   pp redaction
+      #   # => true
+      def self.redact_attachments!(client, ticket)
+        redactions = []
+        Tickets.comments(client, ticket).each do |c|
+          object = {
+            id: c['id'],
+            redaction: { ticket_id: ticket.id }
+          }
+          object[:redaction][:external_attachment_urls] = c['attachments'].map { |a| a['content_url'] } unless c['attachments'].count.zero?
+          object[:redaction][:html_body] = c['html_body'].gsub('<img', '<img redact') if c['html_body'] =~ /<img/
+          redactions.push(object) unless object[:redaction][:external_attachment_urls].nil? && object[:redaction][:html_body].nil?
+        end
+        redactions.each do |r|
+          response = client.connection.put "comment_redactions/#{r[:id]}", r[:redaction].to_json
+          handle_request_error(1, 'Zendesk', response.status, { action: 'Redact attachments', id: "tickets/#{ticket.id}/comments/#{r[:id]}" }) unless response.status == 200
+        end
+        true
+      end
     end
   end
 end

data/lib/support_readiness/zendesk/triggers.rb

@@ -10,7 +10,7 @@ module Readiness
     # @author Jason Colyer
     # @since 1.0.0
     class Triggers < Readiness::Client
-      attr_accessor :actions, :active, :category_id, :conditions, :default, :description, :id, :position, :title
+      attr_accessor :actions, :active, :category_id, :conditions, :description, :id, :position, :title
 
       ##
       # Creates a new {Readiness::Zendesk::Triggers} instance
@@ -26,7 +26,6 @@ module Readiness
         @active = object['active']
         @category_id = object['category_id']
         @conditions = object['conditions']
-        @default = object['default']
         @description = object['description']
         @id = object['id']
         @position = object['position']

data/lib/support_readiness/zendesk/user_field_options.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class UserFieldOptions within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.12
+    class UserFieldOptions < Readiness::Client
+      attr_accessor :id, :name, :position, :value
+
+      ##
+      # Creates a new {Readiness::Zendesk::UserFieldOptions} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param object [Object] An instance of {Readiness::Zendesk::UserFieldOptions}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::TicketFieldOptions.new
+      def initialize(object = {})
+        @id = object['id']
+        @name = object['name']
+        @position = object['position']
+        @value = object['value']
+      end
+
+      ##
+      # Lists all user fields options for a specific user field.
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param fid [Integer] The field ID to get the field options for
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#list-user-field-options Zendesk API > User Fields > List User Field Options
+      # @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)
+      #   options = Readiness::Zendesk::UserFieldOptions.list(client, 123)
+      #   pp fields.count
+      #   # => 5
+      def self.list(client, fid)
+        array = []
+        page = 1
+        loop do
+          response = client.connection.get("user_fields/#{fid}/options?page=#{page}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['custom_field_options'].map { |f| UserFieldOptions.new(f) }
+          break unless body['custom_field_options'].count == 100
+
+          page += 1
+        end
+        array
+      end
+
+      ##
+      # Creates or updates an user field option. This will exit on error.
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param field [Object] An instance of {Readiness::Zendesk::UserFields}
+      # @param option [Object] An instance of {Readiness::Zendesk::UserFieldOptions}
+      # @return [Object]
+      # @see https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#create-or-update-a-user-field-option Zendesk API > User Fields > Create or Update a User Field Option
+      def self.create_or_update!(client, field, option)
+        response = client.connection.post "user_fields/#{field.id}/options", to_clean_json_with_key(option, 'custom_field_option')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create/update user field option', message: Oj.load(response.body)}) unless [200, 201].include?(response.status)
+        UserFieldOptions.new(Oj.load(response.body)['custom_field_option'])
+      end
+
+      ##
+      # Deletes aan user field option. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.12
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param field [Object] An instance of {Readiness::Zendesk::UserFields}
+      # @param option [Object] An instance of {Readiness::Zendesk::UserFieldOptions}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/users/user_fields/#delete-user-field-option Zendesk API > USer Fields > Delete User Field Option
+      # @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::UserFields.find!(client, 75)
+      #   option = field.custom_field_options.last
+      #   delete = Readiness::Zendesk::UserFieldOptions.delete!(client, field, option)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, field, option)
+        response = client.connection.delete "user_fields/#{field.id}/options/#{option.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete a user field option', id: "user_fields/#{field.id}/options/#{option.id}", message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+    end
+  end
+end