gitlab_support_readiness 1.0.0

data/lib/support_readiness/zendesk/job_statuses.rb

@@ -0,0 +1,188 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class JobStatuses within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class JobStatuses < Readiness::Client
+      attr_accessor :id, :job_type, :message, :progress, :results, :status, :total
+
+      ##
+      # Creates a new {Readiness::Zendesk::JobStatuses} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::JobStatuses}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::JobStatuses.new
+      def initialize(object = {})
+        @id = object['id']
+        @job_type = object['job_type']
+        @message = object['message']
+        @progress = object['progress']
+        @results = object['results']
+        @status = object['status']
+        @total = object['total']
+      end
+
+      ##
+      # Lists the first 100 job statuses
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/#list-job-statuses Zendesk API > Job Statuses > List Job Statuses
+      # @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)
+      #   jobs = Readiness::Zendesk::JobStatuses.list(client)
+      #   pp jobs.first.id
+      #   # => "8b726e606741012ffc2d782bcb7848fe"
+      def self.list(client)
+        response = client.connection.get("job_statuses?page[size]=100")
+        handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+        Oj.load(response.body)['job_statuses'].map { |j| JobStatuses.new(j) }
+      end
+
+      ##
+      # Locates a job status within Zendesk. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param jid [String] The job status ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/#show-job-status Zendesk API > Job Statuses > Show Job Status
+      # @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)
+      #   job = Readiness::Zendesk::JobStatuses.find(client, '8b726e606741012ffc2d782bcb7848fe')
+      #   pp job.first.status
+      #   # => "completed"
+      def self.find(client, jid)
+        response = client.connection.get("job_statuses/#{jid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: jid }) unless response.status == 200
+        return JobStatuses.new(Oj.load(response.body)['job_status']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a job status within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param jid [String] The job status ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/#show-job-status Zendesk API > Job Statuses > Show Job Status
+      # @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)
+      #   job = Readiness::Zendesk::JobStatuses.find!(client, '8b726e606741012ffc2d782bcb7848fe')
+      #   pp job.first.status
+      #   # => "completed"
+      def self.find!(client, jid)
+        response = client.connection.get("job_statuses/#{jid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find job status', id: jid }) unless response.status == 200
+        JobStatuses.new(Oj.load(response.body)['job_status'])
+      end
+
+      ##
+      # Locates up to 100 job statuses within Zendesk.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param jids [Array] The job statuses IDs to find
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/#show-many-job-statuses Zendesk API > Job Statuses > Show Many Job Statuses
+      # @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)
+      #   jobs = Readiness::Zendesk::JobStatuses.find_many(client, ['8b726e606741012ffc2d782bcb7848fe', 'e7665094164c498781ebe4c8db6d2af5'])
+      #   pp jobs.map { |j| j.status }
+      #   # => ["completed", "completed"]
+      def self.find_many(client, jids)
+        response = client.connection.get("job_statuses/show_many?ids=#{jids.join(',')}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: jids }) unless response.status == 200
+        Oj.load(response.body)['job_statuses'].map { |o| JobStatuses.new(o) }
+      end
+
+      ##
+      # Waits for a job to complete. Be mindful of API limits when setting the wait interval
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param job [Object] An instance of {Readiness::Zendesk::JobStatuses}
+      # @param interval [Integer] The time (in seconds) between checks
+      # @param verbose [Boolean] Whether or not to output messages
+      # @return [Object] An instance of {Readiness::Zendesk::JobStatuses}
+      # @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)
+      #   job = Readiness::Zendesk::JobStatuses.find!(client, '8b726e606741012ffc2d782bcb7848fe')
+      #   completed_job = Readiness::Zendesk::JobStatuses.wait_for_completetion(client, job, 10, true)
+      #   # => Waiting 10 seconds before checking 8b726e606741012ffc2d782bcb7848fe
+      #   # => Rechecking status of 8b726e606741012ffc2d782bcb7848fe...status is queued
+      #   # => Waiting 10 seconds before checking 8b726e606741012ffc2d782bcb7848fe
+      #   # => Rechecking status of 8b726e606741012ffc2d782bcb7848fe...status is working
+      #   # => Waiting 10 seconds before checking 8b726e606741012ffc2d782bcb7848fe
+      #   # => Rechecking status of 8b726e606741012ffc2d782bcb7848fe...status is completed
+      #   # => Job is finished with status of completed
+      #   pp completed_job.status
+      #   # => "completed"
+      # @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)
+      #   job = Readiness::Zendesk::JobStatuses.find!(client, '8b726e606741012ffc2d782bcb7848fe')
+      #   completed_job = Readiness::Zendesk::JobStatuses.wait_for_completetion(client, job, 5, false)
+      #   pp completed_job.status
+      #   # => "completed"
+      def self.wait_for_completetion(client, job, interval = 5, verbose = true)
+        loop do
+          puts "Waiting #{interval} seconds before checking #{job.id}" if verbose
+          sleep interval
+          print "Rechecking status of #{job.id}..." if verbose
+          job = JobStatuses.find!(client, job.id)
+          puts "status is #{job.status}" if verbose
+          break if %w[failed completed].include? job.status
+        end
+        puts "Job is finished with status of #{job.status}" if verbose
+        job
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/macros.rb

@@ -0,0 +1,267 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Macros within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    class Macros < Readiness::Client
+      attr_accessor :actions, :active, :default, :description, :id, :position, :restriction, :title
+
+      ##
+      # Creates a new {Readiness::Zendesk::Macros} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param object [Object] An instance of {Readiness::Zendesk::Macros}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::Macros.new
+      def initialize(object = {})
+        @actions = object['actions']
+        @active = object['active']
+        @default = object['default']
+        @description = object['description']
+        @id = object['id']
+        @position = object['position']
+        @restriction = object['restriction']
+        @title = object['title']
+      end
+
+      ##
+      # Lists macros
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#list-macros Zendesk API > Macros > List Macros
+      # @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)
+      #   macros = Readiness::Zendesk::Macros.list(client)
+      #   pp macros.first.id
+      #   # => 25
+      def self.list(client)
+        array = []
+        opts = "page[size]=100"
+        loop do
+          response = client.connection.get("macros?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['macros'].map { |t| Macros.new(t) }
+          break unless body['meta']['has_more']
+
+          opts = body['links'] ['next'].split('?').last
+        end
+        array
+      end
+
+      ##
+      # Locates a macro within Zendesk. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param mid [Integer] The macro ID to find
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#show-macro Zendesk API > Macros > Show Macro
+      # @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)
+      #   macro = Readiness::Zendesk::Macros.find(client, 25)
+      #   pp macro.title
+      #   # => "Assign priority tag"
+      def self.find(client, mid)
+        response = client.connection.get("macros/#{mid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: mid }) unless response.status == 200
+        return Macros.new(Oj.load(response.body)['macro']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates a macro within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param mid [Integer] The macro ID to find
+      # @return [Object] An instance of {Readiness::Zendesk::Macros}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#show-macro Zendesk API > Macros > Show Macro
+      # @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)
+      #   macro = Readiness::Zendesk::Macros.find!(client, 25)
+      #   pp macro.title
+      #   # => "Assign priority tag"
+      def self.find!(client, mid)
+        response = client.connection.get("macros/#{mid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find macro', id: mid }) unless response.status == 200
+        Macros.new(Oj.load(response.body)['macro'])
+      end
+
+      ##
+      # Creates a macro. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param macro [Object] An instance of {Readiness::Zendesk::Macros}
+      # @return [Object] An instance of {Readiness::Zendesk::Triggers}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#create-macro Zendesk API > Macros > Create Macro
+      # @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)
+      #   macro = Readiness::Zendesk::Macros.new
+      #   macro.title = 'Roger Wilco'
+      #   macro.actions = [{ field: 'status', value: 'solved' }]
+      #   create = Readiness::Zendesk::Macros.create!(client, macro)
+      #   pp create.id
+      #   # => 26
+      def self.create!(client, macro)
+        response = client.connection.post 'macros', to_clean_json_with_key(macro, 'macro')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create macro', message: Oj.load(response.body)}) unless response.status == 201
+        Macros.new(Oj.load(response.body)['macro'])
+      end
+
+      ##
+      # Updates a macro. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param macro [Object] An instance of {Readiness::Zendesk::Macros}
+      # @return [Object] An instance of {Readiness::Zendesk::Triggers}
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#update-macro Zendesk API > Macros > Update Macro
+      # @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)
+      #   macro = Readiness::Zendesk::Macros.find!(client, 26)
+      #   macro.title = 'Solve ticket'
+      #   update = Readiness::Zendesk::Macros.update!(client, macro)
+      #   pp update.title
+      #   # => "Solve ticket"
+      def self.update!(client, macro)
+        response = client.connection.put "macros/#{macro.id}", to_clean_json_with_key(macro, 'macro')
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update macro', id: macro.id, message: Oj.load(response.body)}) unless response.status == 200
+        Macros.new(Oj.load(response.body)['macro'])
+      end
+
+      ##
+      # Updates multiple macros via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param macros [Array] An array of {Readiness::Zendesk::Macros} instances
+      # @return [array] An array of {Readiness::Zendesk::Macros} instances
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#update-many-macros Zendesk API > Macros > Update Many Macros
+      # @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)
+      #   macro1 = Readiness::Zendesk::Macros.find!(client, 25)
+      #   macro1.title = 'Solve ticket'
+      #   macro2 = Readiness::Zendesk::Macros.find!(client, 25)
+      #   macro2.title = 'Solve ticket and add done tag'
+      #   macros = [macro1, macro2]
+      #   updates = Readiness::Zendesk::Macros.update_many!(client, macros)
+      #   pp updates.last.title
+      #   # => "Solve ticket and add done tag"
+      def self.update_many!(client, macros)
+        data = { macros: macros.map { |m| to_hash(m).compact } }.to_json
+        response = client.connection.put('macros/update_many', data)
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update many macros', message: Oj.load(response.body)}) unless response.status == 200
+        Oj.load(response.body)['macros'].map { |m| Macros.new(m) }
+      end
+
+      ##
+      # Deletes a macro. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param macro [Object] An instance of {Readiness::Zendesk::Macros}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#delete-macro Zendesk API > Macros > Delete Macro
+      # @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)
+      #   macro = Readiness::Zendesk::Macros.find!(client, 26)
+      #   delete = Readiness::Zendesk::Macros.delete!(client, macro)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, macro)
+        response = client.connection.delete "macros/#{macro.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete a macro', id: macro.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+
+      ##
+      # Deletes multiple macros via a batch job
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param mids [Array] An array of macro IDs
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/business-rules/macros/#bulk-delete-macros Zendesk API > Macros > Bulk Delete Macros
+      # @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)
+      #   deletes = Readiness::Zendesk::Macros.delete_many!(client, [25, 26])
+      #   pp deletes
+      #   # => true
+      def self.delete_many(client, mids)
+        response = client.connection.delete("macros/destroy_many?ids=#{mids.join(',')}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many macros', message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
+    end
+  end
+end
+
+
+
+
+
+
+
+
+