gitlab-customer-support-operations_zendesk 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 950534203deda40c1904a8d60a7b4508ff4c6da8e5957d8d5dcf853ea4064fcc
+  data.tar.gz: 885b715a608b92039ee319e5b1413c5ee1e9d013ec9c16e2260f256abb276c44
+SHA512:
+  metadata.gz: 1bc75a0f801939a845caf4e99cf2698c490992e2a259c9568165bd7c66996b5ba0b61e24a897677fcdb843ddd192340952363c7f4d9807a874bd1d094a2cd245
+  data.tar.gz: 97bf57bfaebe458579344da2cbcc121e5b65f7d5a9f37c9b1b7958803a3d6e6cda10dbe08a22c2d43383480b331a12dd6308e1d4970cdc8b3d484c5067366a7b

data/lib/support_ops_zendesk/packages.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  ##
+  # Defines the class Packages within the module {SupportOps}.
+  #
+  # @author Jason Colyer
+  # @since 1.0.0
+  class Packages
+    ##
+    # Creates a zipfile
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @overload create_zipfile!(key: value)
+    #   @param item_list [Array required] The list of entries to add to the
+    #     zipfile; it will recursively grab files if given directories in the
+    #     list
+    #   @param output_file [String option] The zipfile name to create
+    #   @param input_dir [String option] The relative path where the items are
+    #     located
+    # @return [String] The The zipfile that was created
+    # @example
+    #   require 'support_ops_zendesk'
+    #
+    #   list = [
+    #     'data/1',
+    #     'data/2',
+    #     'data/3',
+    #     'data/a/b/c'
+    #   ]
+    #   file = SupportOps::Packages.create_zipfile!(item_list: list)
+    #   pp file
+    #   # => "data/20250407135848913.zip"
+    #   file = SupportOps::Packages.create_zipfile!(item_list: list, output_file: 'data/application.zip')
+    #   pp file
+    #   # => "data/application.zip"
+    def self.create_zipfile!(**args)
+      raise 'No file list provided' if args[:item_list].nil?
+      raise 'No file list entries provided' unless args[:item_list].is_a? Array
+      raise 'No file list entries provided' if args[:item_list].count.zero?
+      args[:output_file] = "data/#{Time.now.strftime('%Y%m%d%H%M%S%L')}.zip" unless args[:output_file]
+      args[:input_dir] = './' unless args[:input_dir]
+      @input_dir = args[:input_dir]
+      FileUtils.rm_f args[:output_file] if File.exist? args[:output_file]
+      Zip::File.open(args[:output_file], create: true) do |zipfile|
+        write_zipfile_entries args[:item_list], zipfile
+      end
+      args[:output_file]
+    end
+
+    ##
+    # Writes an entry to a zipfile
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param items [Array] The list of items being worked with
+    # @param path [String] The path being worked with (defaults to '')
+    # @param zipfile [Object]
+    def self.write_zipfile_entries(items, path = '', zipfile)
+      items.each do |i|
+        zipfile_path = path == '' ? i : File.join(path, i)
+        disk_path = File.join(@input_dir, zipfile_path)
+        if File.directory? disk_path
+          handle_zipfile_directory zipfile, zipfile_path, disk_path
+        elsif File.file? disk_path
+          zipfile.add(zipfile_path, disk_path)
+        else
+          puts "Unable to locate #{i}, skipping it."
+        end
+      end
+    end
+
+    ##
+    # Handles writing a directory recursively to a zipfile
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param zipfile [Object]
+    # @param zipfile_path [String] The path of the item being worked on in the zipfile
+    # @param disk_path [String] The path of the item being worked on in the disk
+    def self.handle_zipfile_directory(zipfile, zipfile_path, disk_path)
+      zipfile.mkdir zipfile_path
+      subdir = Dir.entries(disk_path) - %w[. ..]
+      write_zipfile_entries subdir, zipfile_path, zipfile
+    end
+  end
+end

data/lib/support_ops_zendesk/zendesk/app_installations.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class AppInstallations within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Integer] app_id id of the app
+    # @attr [Boolean] collapsible If true, the app can be minimized in the Zendesk user interface (UI)
+    # @attr [String] created_at When the app installation was created
+    # @attr [Boolean] enabled If true, the app installation is enabled
+    # @attr [Array] group_restrictions Group restrictions for the app installation
+    # @attr [Boolean] has_incomplete_subscription If true, the app installation's Stripe payment subscription is incomplete
+    # @attr [Boolean] has_unpaid_subscription If true, the app installation's Stripe payment subscription is unpaid
+    # @attr [Integer] id id of the app installation
+    # @attr [Boolean] paid If true, the app is a paid app
+    # @attr [Boolean] pending_installation If true, the app installation is pending
+    # @attr [String] pending_job_id id for the app installation job
+    # @attr [Object] plan_information Information about the Stripe payment plan for the app installation
+    # @attr [String] product Zendesk product the app is installed on
+    # @attr [Boolean] recurring_payment If true, the app installation has a recurring Stripe payment subscription
+    # @attr [Boolean] redirect_path URL path used to redirect admins after installing the app in the Zendesk UI
+    # @attr [Array] role_restrictions Role restrictions for the app installation
+    # @attr [Boolean] servable If true, user making the API request can use the app installation
+    # @attr [Object] settings Installation settings for the app, formatted as a flat object
+    # @attr [Array] settings_objects Installation settings for the app, formatted as an array of objects
+    # @attr [String] stripe_account App developer's Stripe account id
+    # @attr [String] stripe_publishable_key Publishable key for the app developer's Stripe account
+    # @attr [String] stripe_subscription_id Stripe subscription id for the app installation
+    # @attr [String] updated When the app was last updated
+    # @attr [String] updated_at When the app installation was last updated
+    # @todo Install App > https://developer.zendesk.com/api-reference/ticketing/apps/apps/#install-app
+    # @todo List App Installations > https://developer.zendesk.com/api-reference/ticketing/apps/apps/#list-app-installations
+    # @todo Show App Installation > https://developer.zendesk.com/api-reference/ticketing/apps/apps/#show-app-installation
+    # @todo Update App Installation > https://developer.zendesk.com/api-reference/ticketing/apps/apps/#update-app-installation
+    # @todo Remove App Installation > https://developer.zendesk.com/api-reference/ticketing/apps/apps/#remove-app-installation
+    # @todo List Requirements > https://developer.zendesk.com/api-reference/ticketing/apps/apps/#list-requirements
+    # @todo Get Requirements Install Status > https://developer.zendesk.com/api-reference/ticketing/apps/apps/#get-requirements-install-status
+    class AppInstallations < SupportOps::Zendesk::Base
+      define_attributes :app_id, :collapsible, :created_at, :enabled,
+                        :group_restrictions, :has_incomplete_subscription,
+                        :has_unpaid_subscription, :id, :paid,
+                        :pending_installation, :pending_job_id,
+                        :plan_information, :product, :recurring_payment,
+                        :redirect_path, :role_restrictions, :servable,
+                        :settings, :settings_objects, :stripe_account,
+                        :stripe_publishable_key, :stripe_subscription_id,
+                        :updated, :updated_at
+      readonly_attributes :collapsible, :created_at,
+                          :has_incomplete_subscription,
+                          :has_unpaid_subscription, :id, :paid,
+                          :pending_installation, :pending_job_id,
+                          :plan_information, :product, :servable,
+                          :stripe_account, :stripe_publishable_key,
+                          :stripe_subscription_id, :updated, :updated_at
+    end
+  end
+end

data/lib/support_ops_zendesk/zendesk/app_job_statuses.rb

@@ -0,0 +1,157 @@
+# frozen_string_literal: true
+
+# Defines the module SupportOps.
+module SupportOps
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class AppJobStatuses within the module {SupportOps::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @attr [Integer] app_id The ID of the app created by this job, if it exists
+    # @attr [String] id Automatically assigned when the job is queued
+    # @attr [String] message Message from the job worker, if any
+    # @attr [Integer] progress Number of tasks completed
+    # @attr [Integer] retry_in Number of seconds after which you may re-check status
+    # @attr [String] status One of "queued", "working", "failed", "completed", "killed"
+    # @attr [Integer] total The total number of tasks this job is batching through
+    class AppJobStatuses < SupportOps::Zendesk::Base
+      # @!parse
+      #   # Waits for an app 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::AppJobStatuses.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::AppJobStatuses.get!('8b726e606741012ffc2d782bcb7848fe')
+      #   #   job.wait_for_completetion(interval: 5, verbose: false)
+      #   #   pp job.status
+      #   #   # => "completed"
+      #   def wait_for_completetion; end
+      define_attributes :app_id, :id, :message, :progress, :retry_in, :status,
+                        :total
+      readonly_attributes :app_id, :id, :message, :progress, :retry_in, :status,
+                          :total
+
+      ##
+      # Locates a specific app job status in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/apps/apps/#get-job-status
+      #   Zendesk API > Apps > Get 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::AppJobStatuses.get('82de0b044094f0c67893ac9fe64f1a99')
+      #   pp job_status.status
+      #   # => "queued"
+      def self.get(object)
+        if object.is_a? AppJobStatuses
+          AppJobStatuses.new(id: id).find
+        else
+          AppJobStatuses.new(id: object).find
+        end
+      end
+
+      ##
+      # Locates a specific app job status in the Zendesk system
+      #
+      # @author Jason Colyer
+      # @since 1.0.0
+      # @see
+      #   https://developer.zendesk.com/api-reference/ticketing/apps/apps/#get-job-status
+      #   Zendesk API > Apps > Get 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::AppJobStatuses.get!('82de0b044094f0c67893ac9fe64f1a99')
+      #   pp job_status.status
+      #   # => "queued"
+      def self.get!(object)
+        if object.is_a? AppJobStatuses
+          AppJobStatuses.new(id: id).find!
+        else
+          AppJobStatuses.new(id: object).find!
+        end
+      end
+
+      private
+
+      ##
+      # @private
+      def get_record
+        response = self.client.connection.get("apps/job_statuses/#{self.id}")
+        return nil if response.status != 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # @private
+      def wait_for_completetion_record(**args)
+        job_to_check = AppJobStatuses.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 = AppJobStatuses.get!(job_to_check.id)
+          puts "status is #{job_to_check.status}" if verbose
+          break if %w[failed completed killed].include? job_to_check.status
+        end
+        puts "Job is finished with status of #{job_to_check.status}" if verbose
+        response = self.client.connection.get("apps/job_statuses/#{job_to_check.id}")
+        Oj.load(response.body)
+      end
+    end
+  end
+end