gitlab-customer-support-operations_zendesk 1.0.0

data/lib/support_ops_zendesk/zendesk/job_statuses.rb

@@ -0,0 +1,231 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class JobStatuses within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] id Automatically assigned when the job is queued
+    # @attr [String] job_type The type of the job
+    # @attr [String] message Message from the job worker, if any
+    # @attr [Integer] progress Number of tasks that have already been completed
+    # @attr [Hash] results esult data from processed tasks
+    # @attr [String] status The current status. One of the following: "queued", "working", "failed", "completed"
+    # @attr [Integer] total The total number of tasks this job is batching through
+    class JobStatuses < SupportOps::Zendesk::Base
+      # @!parse
+      #   # Waits for a 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::JobStatuses.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::JobStatuses.get!('8b726e606741012ffc2d782bcb7848fe')
+      #   #   job.wait_for_completetion(interval: 5, verbose: false)
+      #   #   pp job.status
+      #   #   # => "completed"
+      #   def wait_for_completetion; end
+      define_attributes :id, :job_type, :message, :progress, :results, :status,
+                        :total
+      readonly_attributes :id
+
+      ##
+      # Lists job statuses in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload list(key: value)
+      #   @param limit [Integer optional] The limit to the number of job
+      #     statuses memberships returned. Default to 0 (i.e. no limit)
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/#list-job-statuses
+      #   Zendesk API > Job Statuses > List Job Statuses
+      # @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_statuses = SupportOps::Zendesk::JobStatuses.list(limit: 25)
+      #   pp job_statuses.count
+      #   # => 25
+      #   pp job_statuses.last.status
+      #   # => "completed"
+      def self.list(**args)
+        args[:limit] = 0 unless args[:limit]
+        items = []
+        opts = 'page[size]=100'
+        loop do
+          response = client.connection.get("job_statuses?#{opts}")
+          body = Oj.load(response.body)
+          items += body['job_statuses'].map { |j| JobStatuses.new(j) }
+          break if args[:limit].to_i.positive? && items.count >= args[:limit].to_i
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        return items if args[:limit].to_i.zero?
+        
+        items.first(args[:limit].to_i)
+      end
+
+
+      ##
+      # Locates a specific job status in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/#show-job-status
+      #   Zendesk API > Job Statuses > Show Job Status
+      # @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::JobStatuses.get('82de0b044094f0c67893ac9fe64f1a99')
+      #   pp job_status.status
+      #   # => "pending"
+      def self.get(object)
+        if object.is_a? JobStatuses
+          JobStatuses.new(id: id).find
+        else
+          JobStatuses.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific job status in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/ticket-management/job_statuses/#show-job-status
+      #   Zendesk API > Job Statuses > Show Job Status
+      # @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::JobStatuses.get!('82de0b044094f0c67893ac9fe64f1a99')
+      #   pp job_status.status
+      #   # => "pending"
+      def self.get!(object)
+        if object.is_a? JobStatuses
+          JobStatuses.new(id: id).find!
+        else
+          JobStatuses.new(id: object).find!
+        end
+      end
+
+      ##
+      # Locates up to 100 job statuses within Zendesk.
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @param job_status_ids [Array] The job status 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_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
+      #
+      #   jobs = SupportOps::Zendesk::JobStatuses.get_many(['8b726e606741012ffc2d782bcb7848fe', 'e7665094164c498781ebe4c8db6d2af5'])
+      #   pp jobs.map { |j| j.status }
+      #   # => ["completed", "completed"]
+      def self.get_many(job_status_ids)
+        raise 'The parameter must be an Array' unless job_status_ids.is_a? Array
+        raise 'You can only get a maximum of 100 job statuses at a time' if job_status_ids.count > 100
+
+        response = client.connection.get("job_statuses/show_many?ids=#{job_status_ids.join(',')}")
+        Oj.load(response.body)['job_statuses'].map { |j| JobStatuses.new(j) }
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("job_statuses/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['job_status']
+      end
+
+      ##
+      # @private
+      def wait_for_completetion_record(**args)
+        job_to_check = JobStatuses.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 = JobStatuses.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

data/lib/support_ops_zendesk/zendesk/locales.rb

@@ -0,0 +1,326 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class Locales within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [String] created_at The ISO 8601 formatted date-time the locale was created
+    # @attr [Integer] id The unique ID of the locale
+    # @attr [String] locale The name of the locale
+    # @attr [String] name The name of the language
+    # @attr [String] updated_at The ISO 8601 formatted date-time when the locale was last updated
+    # @todo get
+    # @todo get!
+    # @todo Detect Best Language for User => https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#detect-best-language-for-user
+    class Locales < SupportOps::Zendesk::Base
+      define_attributes :created_at, :id, :locale, :name, :updated_at
+      readonly_attributes :created_at, :id, :locale, :name, :updated_at
+
+      ##
+      # Lists all locales in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#list-locales
+      #   Zendesk API > Locales > List locales
+      # @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
+      #
+      #   locales = SupportOps::Zendesk::Locales.list
+      #   pp locales.first.name
+      #   # => "English"
+      def self.list
+        response = client.connection.get('locales')
+        Oj.load(response.body)['locales'].map { |l| Locales.new(l) }
+      end
+
+      ##
+      # Lists all enabled locales in the Zendesk Help Center system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/help_center/help-center-api/translations/#list-enabled-locales-and-default-locale
+      #   Zendesk API > Translations > List Enabled Locales and Default Locale
+      # @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
+      #
+      #   locales = SupportOps::Zendesk::Locales.list_help_center
+      #   pp locales.first
+      #   # => "en-us"
+      def self.list_help_center
+        response = client.connection.get('help_center/locales')
+        Oj.load(response.body)['locales']
+      end
+
+      ##
+      # Lists the default locale in the Zendesk Help Center system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/help_center/help-center-api/translations/#list-enabled-locales-and-default-locale
+      #   Zendesk API > Translations > List Enabled Locales and Default Locale
+      # @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
+      #
+      #   locale = SupportOps::Zendesk::Locales.list_help_center_default
+      #   pp locale
+      #   # => "en-us"
+      def self.list_help_center_default
+        response = client.connection.get('help_center/locales')
+        Oj.load(response.body)['default_locale']
+      end
+
+      ##
+      # Lists all locales for an agent in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#list-locales-for-agent
+      #   Zendesk API > Locales > List Locales for Agent
+      # @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
+      #
+      #   locales = SupportOps::Zendesk::Locales.list_for_agent
+      #   pp locales.first.name
+      #   # => "English"
+      def self.list_for_agent
+        response = client.connection.get('locales/agent')
+        Oj.load(response.body)['locales'].map { |l| Locales.new(l) }
+      end
+
+      ##
+      # Lists all available public locales in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#list-available-public-locales
+      #   Zendesk API > Locales > List Available Public Locales
+      # @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
+      #
+      #   locales = SupportOps::Zendesk::Locales.list_available
+      #   pp locales.first.name
+      #   # => "English"
+      def self.list_available
+        response = client.connection.get('locales/public')
+        Oj.load(response.body)['locales'].map { |l| Locales.new(l) }
+      end
+
+      ##
+      # Get the locale of the current agent in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @return [Array]
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#show-current-locale
+      #   Zendesk API > Locales > Show Current Locale
+      # @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
+      #
+      #   locale = SupportOps::Zendesk::Locales.current
+      #   pp locale.name
+      #   # => "English"
+      def self.current
+        response = client.connection.get('locales/current')
+        Oj.load(response.body)['locale'].map { |l| Locales.new(l) }
+      end
+
+      ##
+      # Locates a locale 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::Locales to use as a cache
+      # @return [Object] An instance of {SupportOps::Zendesk::Locales}
+      # @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
+      #
+      #   locales = SupportOps::Zendesk::Locales.list
+      #   locale = SupportOps::Zendesk::Locales.find_by_name(name: 'English', cache: locales)
+      #   pp locale.name
+      #   # => "English"
+      #   pp locale.id
+      #   # => 1
+      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
+          locales = args[:cache]
+        else
+          locales = list
+        end
+        locales.detect { |c| c.name.downcase == args[:name].to_s.downcase }
+      end
+
+      ##
+      # Locates a locale within Zendesk by locale code. Can utilize a cache for quicker results
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @overload find_by_name(key: value)
+      #   @param code [String required] The locale code to search for
+      #   @param cache [Array] An Array of SupportOps::Zendesk::Locales to use as a cache
+      # @return [Object] An instance of {SupportOps::Zendesk::Locales}
+      # @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
+      #
+      #   locales = SupportOps::Zendesk::Locales.list
+      #   locale = SupportOps::Zendesk::Locales.find_by_code(code: 'en-us', cache: locales)
+      #   pp locale.name
+      #   # => "English"
+      #   pp locale.id
+      #   # => 1
+      def self.find_by_code(**args)
+        raise 'You have to provide a name' unless args[:code]
+        if args[:cache]
+          raise 'Provided cache is not an Array' unless args[:cache].is_a? Array
+          locales = args[:cache]
+        else
+          locales = list
+        end
+        locales.detect { |c| c.locale.downcase == args[:code].to_s.downcase }
+      end
+
+      ##
+      # Locates a specific locale in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#show-locale
+      #   Zendesk API > Locales > Show Locale
+      # @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
+      #
+      #   locale = SupportOps::Zendesk::Locales.get(1)
+      #   pp locale.name
+      #   # => "English"
+      def self.get(object)
+        if object.is_a? Locales
+          Locales.new(id: id).find
+        else
+          Locales.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific locale in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/account-configuration/locales/#show-locale
+      #   Zendesk API > Locales > Show Locale
+      # @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
+      #
+      #   locale = SupportOps::Zendesk::Locales.get!(1)
+      #   pp locale.name
+      #   # => "English"
+      def self.get!(object)
+        if object.is_a? Locales
+          Locales.new(id: id).find!
+        else
+          Locales.new(id: object).find!
+        end
+      end
+
+      private
+      
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("locales/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)['locale']
+      end
+    end
+  end
+end