gitlab-customer-support-operations_zendesk 1.0.0

data/lib/support_ops_zendesk/zendesk/sla_policies.rb

@@ -0,0 +1,302 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class SLAs within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] created_at The time the SLA policy was created
+    # @attr [String] description The description of the SLA policy
+    # @attr [Hash] filter An object that describes the conditions that a ticket must match in order for an SLA policy to be applied to that ticket.
+    # @attr [Integer] id Automatically assigned when created
+    # @attr [Array] policy_metrics Array of Policy Metric objects
+    # @attr [Integer] position Position of the SLA policy that determines the order they will be matched. If not specified, the SLA policy is added as the last position
+    # @attr [String] title The title of the SLA policy
+    # @attr [String] updated_at The time of the last update of the SLA policy
+    # @todo Retrieve Supported Filter Definition Items => https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/#retrieve-supported-filter-definition-items
+    class SLAs < SupportOps::Zendesk::Base
+      # @!parse
+      #   # Creates/updates a SLA
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Object] Instance of {SupportOps::Zendesk::SLAs}
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#save!}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/#create-sla-policy
+      #   #   Zendesk API > SLA Policies > Create SLA Policy
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/#update-sla-policy
+      #   #   Zendesk API > SLA Policies > Update SLA Policy
+      #   # @example
+      #   #   require 'support_ops_zendesk'
+      #   #
+      #   #   SupportOps::Zendesk::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #   #     config.username = 'jason@example.com'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   new_policy = SupportOps::Zendesk::SLAs.new
+      #   #   new_policy.title = 'Incidents'
+      #   #   new_policy.description = 'For urgent incidents, we will respond to tickets in 10 minutes'
+      #   #   new_policy.position = 3
+      #   #   new_policy.filter = {
+      #   #     all: [
+      #   #       { field: 'type', operator: 'is', value: 'incident' }
+      #   #     ],
+      #   #     any: []
+      #   #   }
+      #   #   new_policy.policy_metrics = [
+      #   #     { priority: 'normal', metric: 'first_reply_time', target: 30,  business_hours: false },
+      #   #     { priority: 'urgent', metric: 'first_reply_time', target: 10,  business_hours: false },
+      #   #     { priority: 'low', metric: 'requester_wait_time', target: 180, business_hours: false },
+      #   #     { priority: 'normal', metric: 'requester_wait_time', target: 160, business_hours: false },
+      #   #     { priority: 'high', metric: 'requester_wait_time', target: 140, business_hours: false },
+      #   #     { priority: 'urgent', metric: 'requester_wait_time', target: 120, business_hours: false }
+      #   #   ]
+      #   #
+      #   #   new_policy.save!
+      #   #
+      #   #   pp new_policy.id
+      #   #   # => 36
+      #   # @example
+      #   #   require 'support_ops_zendesk'
+      #   #
+      #   #   SupportOps::Zendesk::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #   #     config.username = 'jason@example.com'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   existing_policy = SupportOps::Zendesk::SLAs.get!(36)
+      #   #   existing_policy.title = 'Urgent Incidents'
+      #   #
+      #   #   existing_policy.save!
+      #   #
+      #   #   pp existing_policy.title
+      #   #   # => "Urgent Incidents"
+      #   def save!; end
+      # @!parse
+      #   # Deletes a SLA
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @return [Boolean]
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#delete!}
+      #   # @see
+      #   #   https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/#delete-sla-policy
+      #   #   Zendesk API > SLA Policies > Delete SLA Policy
+      #   # @example
+      #   #   require 'support_ops_zendesk'
+      #   #
+      #   #   SupportOps::Zendesk::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #   #     config.username = 'jason@example.com'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   existing_policy = SupportOps::Zendesk::SLAs.get!(36)
+      #   #   existing_policy.delete!
+      #   def delete!; end
+      define_attributes :created_at, :description, :filter, :id,
+                        :policy_metrics, :position, :title, :updated_at
+      readonly_attributes :created_at, :id, :updated_at
+
+      ##
+      # Lists SLAs in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/#list-sla-policies
+      #   Zendesk API > SLA Policies > List SLA Policies
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   policies = SupportOps::Zendesk::SLAs.list
+      #   pp policies.count
+      #   # => 17
+      def self.list
+        response = client.connection.get('slas/policies')
+        body = Oj.load(response.body)
+        body['sla_policies'].map { |s| SLAs.new(s) }
+      end
+
+      ##
+      # Locates a SLA within Zendesk by name. Can utilize a cache for quicker results
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload find_by_name(key: value)
+      #   @param name [String required] The name to search for
+      #   @param cache [Array] An Array of SupportOps::Zendesk::SLAs to use as a cache
+      # @return [Object] An instance of {SupportOps::Zendesk::SLAs}
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   policies = SupportOps::Zendesk::SLAs.list
+      #   policy = SupportOps::Zendesk::SLAs.find_by_name(name: 'Emergency Support', cache: policies)
+      #   pp policy.name
+      #   # => "Emergency Support"
+      #   pp policy.id
+      #   # => 12510663676700
+      def self.find_by_name(**args)
+        raise 'You have to provide a name' unless args[:name]
+        if args[:cache]
+          raise 'Provided cache is not an Array' unless args[:cache].is_a? Array
+          policies = args[:cache]
+        else
+          policies = list
+        end
+        policies.detect { |c| c.title.downcase == args[:name].to_s.downcase }
+      end
+
+      ##
+      # Locates a specific SLA in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/#show-sla-policy
+      #   Zendesk API > SLA Policies > Show SLA Policy
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   policy = SupportOps::Zendesk::SLAs.get(12510663676700)
+      #   pp policy.name
+      #   # => "Emergency Support"
+      def self.get(object)
+        if object.is_a? SLAs
+          SLAs.new(id: id).find
+        else
+          SLAs.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific SLA in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/#show-sla-policy
+      #   Zendesk API > SLA Policies > Show SLA Policy
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   policy = SupportOps::Zendesk::SLAs.get!(12510663676700)
+      #   pp policy.name
+      #   # => "Emergency Support"
+      def self.get!(object)
+        if object.is_a? SLAs
+          SLAs.new(id: id).find!
+        else
+          SLAs.new(id: object).find!
+        end
+      end
+
+      ##
+      # Reorders the SLAs positions in Zendesk. Must include all of them.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param sla_ids [Array] The IDs of SLAs in the new order
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/business-rules/sla_policies/#reorder-sla-policies
+      #   Zendesk API > SLA Policies > Reorder SLA Policies
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   pp SupportOps::Zendesk::SLAs.reorder!([25, 38, 24, 37])
+      #   # => true
+      def self.reorder!(sla_ids)
+        current_order = list.sort_by { |l| l.position }.map { |l| l.id }
+        raise 'You must include all SLA IDs here' unless sla_ids.count == current_order.count
+        raise 'You did not make any changes' if current_order == sla_ids
+        data = { sla_policy_ids: sla_ids }.to_json
+        response = client.connection.put('slas/policies/reorder', data)
+        body = Oj.load(response.body)
+        raise "Unable to reorder SLAs => #{body}" if response.status != 200
+        true
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("slas/policies/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['sla_policy']
+      end
+
+      ##
+      # @private
+      def create_record
+        response = self.client.connection.post('slas/policies', { sla_policy: attributes_for_save }.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to create SLA => #{body}" if response.status != 201
+        body['sla_policy']
+      end
+
+      ##
+      # @private
+      def update_record
+        raise "Failed to update SLA => You didn't change anything in the object" if attributes_for_save.keys == [:id]
+        response = self.client.connection.put("slas/policies/#{self.id}", { sla_policy: attributes_for_save }.to_json)
+        body = Oj.load(response.body)
+        raise "Failed to update SLA #{self.id} => #{body['details']}" if response.status != 200
+        body['sla_policy']
+      end
+
+      ##
+      # @private
+      def delete_record
+        response = self.client.connection.delete("slas/policies/#{self.id}")
+        raise "Failed to delete SLA => #{body['details']}" if response.status != 204
+        true
+      end
+    end
+  end
+end

data/lib/support_ops_zendesk/zendesk/targets.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Targets within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Boolean] active Whether or not the target is activated
+    # @attr [String] created_at The time the target was created
+    # @attr [String] email The email address to send to
+    # @attr [Integer] id Automatically assigned when created
+    # @attr [String] subject The subject of the email
+    # @attr [String] title A name for the target
+    # @attr [String] type A pre-defined target, such as "email"
+    # @todo Show Target => https://developer.zendesk.com/api-reference/ticketing/targets/targets/#show-target
+    # @todo Create Target => https://developer.zendesk.com/api-reference/ticketing/targets/targets/#create-target
+    # @todo Update Target => https://developer.zendesk.com/api-reference/ticketing/targets/targets/#update-target
+    # @todo Delete Target => https://developer.zendesk.com/api-reference/ticketing/targets/targets/#delete-target
+    # @todo Add other attributes for other target types
+    class Targets < SupportOps::Zendesk::Base
+      define_attributes :active, :created_at, :email, :id, :subject, :title,
+                        :type
+      readonly_attributes :created_at, :id
+
+
+      ##
+      # Lists targets in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/targets/targets/#list-targets
+      #   Zendesk API > Targets > List Targets
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   targets = SupportOps::Zendesk::Targets.list
+      #   pp targets.count
+      #   # => 3
+      def self.list
+        response = client.connection.get('targets')
+        body = Oj.load(response.body)
+        body['targets'].map { |t| Targets.new(t) }
+      end
+
+      ##
+      # Locates a target within Zendesk by name. Can utilize a cache for quicker results
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload find_by_name(key: value)
+      #   @param name [String required] The name to search for
+      #   @param cache [Array] An Array of SupportOps::Zendesk::Targets to use as a cache
+      # @return [Object] An instance of {SupportOps::Zendesk::Targets}
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   targets = SupportOps::Zendesk::Targets.list
+      #   target = SupportOps::Zendesk::Targets.find_by_name(name: 'Fancy box', cache: targets)
+      #   pp target.name
+      #   # => "Fancy box"
+      #   pp target.id
+      #   # => 211
+      def self.find_by_name(**args)
+        raise 'You have to provide a name' unless args[:name]
+        if args[:cache]
+          raise 'Provided cache is not an Array' unless args[:cache].is_a? Array
+          targets = args[:cache]
+        else
+          targets = list
+        end
+        targets.detect { |c| c.title.downcase == args[:name].to_s.downcase }
+      end
+
+      private
+    end
+  end
+end

data/lib/support_ops_zendesk/zendesk/theme_job_statuses.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class ThemeJobStatuses within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Hash] data Job-specific data provided on job creation
+    # @attr [String] id Automatically assigned when the job is queued
+    # @attr [Array] errors An array of errors if the job failed. Returns null if the job is pending or successful.
+    # @attr [String] status The current status of the job; possible values:
+    #   "pending", "completed", or "failed"
+    class ThemeJobStatuses < SupportOps::Zendesk::Base
+      # @!parse
+      #   # Waits for a theme job to complete. Be mindful of API limits when setting the wait interval
+      #   # 
+      #   # @author Jason Colyer
+      #   # @since 1.0.0
+      #   # @overload wait_for_completetion(key: value)
+      #   #   @param interval [Integer optional] The time to wait between checks. Defaults to 5
+      #   #   @param verbose [Boolean optional] If you want info lines output. Defaults to false
+      #   # @return [Object] Instance of {SupportOps::Zendesk::JobStatuses}
+      #   # @note This is inherited from {SupportOps::Zendesk::Base#wait_for_completetion}
+      #   # @example
+      #   #   require 'support_ops_zendesk'
+      #   #
+      #   #   SupportOps::Zendesk::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #   #     config.username = 'jason@example.com'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   job = SupportOps::Zendesk::ThemeJobStatuses.get!('8b726e606741012ffc2d782bcb7848fe')
+      #   #   job.wait_for_completetion(interval: 10, verbose: 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 job.status
+      #   #   # => "completed"
+      #   # @example
+      #   #   require 'support_ops_zendesk'
+      #   #
+      #   #   SupportOps::Zendesk::Configuration.configure do |config|
+      #   #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #   #     config.username = 'jason@example.com'
+      #   #     config.token = 'abc123'
+      #   #   end
+      #   #
+      #   #   job = SupportOps::Zendesk::ThemeJobStatuses.get!('8b726e606741012ffc2d782bcb7848fe')
+      #   #   job.wait_for_completetion(interval: 5, verbose: false)
+      #   #   pp job.status
+      #   #   # => "completed"
+      #   def wait_for_completetion; end
+      define_attributes :data, :id, :errors, :status
+      readonly_attributes :data, :id, :errors, :status
+
+      ##
+      # Locates a specific theme job status in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/help_center/help-center-api/theming/#json-format-for-jobs
+      #   Zendesk API > Theme > Show Job
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   job_status = SupportOps::Zendesk::ThemeJobStatuses.get('82de0b044094f0c67893ac9fe64f1a99')
+      #   pp job_status.status
+      #   # => "queued"
+      def self.get(object)
+        if object.is_a? ThemeJobStatuses
+          ThemeJobStatuses.new(id: id).find
+        else
+          ThemeJobStatuses.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific theme job status in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/help_center/help-center-api/theming/#json-format-for-jobs
+      #   Zendesk API > Theme > Show Job
+      # @see SupportOps::Zendesk::Configuration Setting up a client
+      # @example
+      #   require 'support_ops_zendesk'
+      #
+      #   SupportOps::Zendesk::Configuration.configure do |config|
+      #     config.url = 'https://gitlab.zendesk.com/api/v2'
+      #     config.username = 'jason@example.com'
+      #     config.token = 'abc123'
+      #   end
+      #
+      #   job_status = SupportOps::Zendesk::ThemeJobStatuses.get('82de0b044094f0c67893ac9fe64f1a99')
+      #   pp job_status.status
+      #   # => "queued"
+      def self.get!(object)
+        if object.is_a? ThemeJobStatuses
+          ThemeJobStatuses.new(id: id).find!
+        else
+          ThemeJobStatuses.new(id: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("guide/theming/jobs/#{self.id}")
+        return nil if response.status != 200
+
+        data = Oj.load(response.body)['job']
+        data['id'] = self.id if data['id'].nil?
+        data
+      end
+
+      ##
+      # @private
+      def wait_for_completetion_record(**args)
+        job_to_check = ThemeJobStatuses.get!(self.id)
+        verbose = (args[:verbose] ? true : false)
+        interval = (args[:interval].to_i.zero? ? 5 : args[:interval].to_i)
+        loop do
+          puts "Waiting #{interval} seconds before checking #{job_to_check.id}" if verbose
+          sleep interval
+          job_to_check = ThemeJobStatuses.get!(job_to_check.id)
+          puts "status is #{job_to_check.status}" if verbose
+          break if %w[failed completed].include? job_to_check.status
+        end
+        puts "Job is finished with status of #{job_to_check.status}" if verbose
+        job_to_check
+      end
+    end
+  end
+end