gitlab_support_readiness 1.0.19 → 1.0.21

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f6182992b5b76e5e94d186d3d998b3086aa2f8556ab2ec415831571f4cea307e
-  data.tar.gz: 2f5ced30fdfc09a3f77d0bf39e441ea17495d6aad1c773a0d83301f616c7143e
+  metadata.gz: 0ac5cbb03de328e4bec9581e0e6ddcd65876de9708427bc95c2a793100e93355
+  data.tar.gz: 159d9e4823dbad2b62579c9adf0a69a1e015e234388c300d898585d8fdfc493a
 SHA512:
-  metadata.gz: 1a83c65f3fcb8d2f87e332d7a68bcaa53196435d37bb48a93fe9172a9fe49d66b09f4c3ee6774e64893d19c988f6e0631b277b8d09e4ffbe04b98e36bc945319
-  data.tar.gz: 508307ad679cd07b8007773010367a9e5a2115f1cd1c4066b3edc07531363a14d8658e3065121b0219c1b60496a732abdf0ab95f0034c287bae5b8dd52204467
+  metadata.gz: 190e8d238e72846abf8d103cc4c24c6dd17d67f93a9204996bc64489bf01bf9c1e41d15cf96a3d57f760f27f8015620d9447dcdd4c16bee868acf1acaf932da8
+  data.tar.gz: 0f3ccceec4f67d4107d276835b601cf5255f9cdd842847e4453567b5c9c5d34c626ff6609617f3afe35b5022652bd2d1ff40bfde271e63fd3c967dcc83b0554b

data/lib/support_readiness/repos/themes.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Repos
+  module Repos
+    ##
+    # Defines the class Themes within the module {Readiness::Repos}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.20
+    class Themes < Readiness::Client
+      ##
+      # Creates a modified theme
+      #
+      # @author Jason Colyer
+      # @since 1.0.20
+      # @param source [String] The absolute or relative path of the theme folder
+      # @param target [String] The absolute or relative path you want your modified theme put in
+      # @param fields [Array] An array of {Readiness::Zendesk::TicketFields} instances
+      # @param forms [Array] An array of {Readiness::Zendesk::TicketForms} instances
+      def self.create_modified(source, target, fields, forms)
+        create_copy(source, target)
+        convert_only(target, fields, forms)
+      end
+
+      ##
+      # Runs the conversion for a theme
+      #
+      # @author Jason Colyer
+      # @since 1.0.20
+      # @param destination [String] The absolute or relative path of the the theme folder to convert
+      # @param fields [Array] An array of {Readiness::Zendesk::TicketFields} instances
+      # @param forms [Array] An array of {Readiness::Zendesk::TicketForms} instances
+      def self.convert_only(destination, fields, forms)
+        @destination = destination
+        @fields = fields
+        @forms = forms
+        files_to_convert.each do |file|
+          convert_file(file)
+        end
+      end
+
+      ##
+      # Copies from source to target
+      #
+      # @author Jason Colyer
+      # @since 1.0.20
+      # @param source [String] The absolute or relative path of the theme folder
+      # @param target [String] The absolute or relative path you want your modified theme put in
+      def self.create_copy(source = 'data/theme', target = 'data/modified_theme')
+        FileUtils.copy_entry source, target
+      end
+
+      ##
+      # Generates an array of files to use
+      #
+      # @author Jason Colyer
+      # @since 1.0.20
+      # @return [Array]
+      def self.files_to_convert
+        Dir["#{@destination}/templates/*.hbs"] + ["#{@destination}/script.js"]
+      end
+
+      ##
+      # Converts the contents of a file for a theme
+      #
+      # @author Jason Colyer
+      # @since 1.0.20
+      # @param file [String] The absolute or relative path of a file to convert
+      def self.convert_file(file)
+        contents = File.read(file)
+        if contents =~ /\[\[form/ || contents =~ /\[\[field/
+          contents = scan_and_replace(contents)
+        end
+        File.write(file, contents)
+      end
+
+      ##
+      # Scans and replaces items for themes
+      #
+      # @author Jason Colyer
+      # @since 1.0.20
+      # @param contents [String] The contents of a file being converted
+      # @return [String]
+      def self.scan_and_replace(contents)
+        contents.scan(/\[\[form:\ ?['"]?[^\]]+['"]?\]\]/).each { |m| contents = replace_forms(contents, m) }
+        contents.scan(/\[\[field:\ ?['"]?[^\]]+['"]?\]\]/).each { |m| contents = replace_fields(contents, m) }
+        contents
+      end
+
+      ##
+      # Replaces form placeholders with their matching ID value
+      #
+      # @author Jason Colyer
+      # @since 1.0.20
+      # @param contents [String] The contents of a file being converted
+      # @param match [String] The regex match of a form placeholder
+      # @return [String]
+      def self.replace_forms(contents, match)
+        name = item_from_match(match)
+        form = @forms.detect { |f| f.name == name }
+        puts "Bad form in code: #{name}" if form.nil?
+        exit 1 if form.nil?
+
+        contents.gsub(match, form.id.to_s)
+      end
+
+      ##
+      # Replaces field placeholders with their matching ID value
+      #
+      # @author Jason Colyer
+      # @since 1.0.20
+      # @param contents [String] The contents of a file being converted
+      # @param match [String] The regex match of a field placeholder
+      # @return [String]
+      def self.replace_fields(contents, match)
+        name = item_from_match(match)
+        field = @fields.detect { |f| f.title == name }
+        puts "Bad field in code: #{name}" if field.nil?
+        exit 1 if field.nil?
+
+        contents.gsub(match, field.id.to_s)
+      end
+
+      ##
+      # Determine the title/name of the form/field in a match
+      #
+      # @author Jason Colyer
+      # @since 1.0.20
+      # @param match [String] The regex match of a form or field placeholder
+      # @return [String]
+      def self.item_from_match(match)
+        match.split(':').last.split(']').first.strip.gsub(/^['"]/, '').gsub(/['"]$/, '')
+      end
+    end
+  end
+end

data/lib/support_readiness/repos.rb

@@ -13,6 +13,7 @@ module Readiness
     require "#{__dir__}/repos/macros"
     require "#{__dir__}/repos/organization_fields"
     require "#{__dir__}/repos/sla_policies"
+    require "#{__dir__}/repos/themes"
     require "#{__dir__}/repos/ticket_fields"
     require "#{__dir__}/repos/ticket_forms"
     require "#{__dir__}/repos/triggers"

data/lib/support_readiness/zendesk/themes.rb

@@ -128,6 +128,29 @@ module Readiness
         Themes.new(Oj.load(response.body)['theme'])
       end
 
+      #
+      # Locates a theme within Zendesk by its name.
+      #
+      # @author Jason Colyer
+      # @since 1.0.20
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param name [String] The theme name to locate
+      # @return [Object]
+      # @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)
+      #   theme = Readiness::Zendesk::Themes.find_by_name(client, 'GitLab Zendesk Global Theme')
+      #   pp theme.id
+      #   # => "6d7ccf08-5674-467c-9036-3403b6c5e91d"
+      def self.find_by_name(client, name)
+        themes = Themes.list(client)
+        themes.detect { |t| t.name == name }
+      end
+
       ##
       # Creates a zip file from the given directory for a Zendesk app. This will exit on error
       #
@@ -209,7 +232,7 @@ module Readiness
           }
         }
         response = client.connection.post 'guide/theming/jobs/themes/imports', object.to_json
-        handle_request_error(1, 'Zendesk', response.status, { action: 'Upload app', id: file }) unless response.status == 200
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Create theme import job', id: theme.name }) unless response.status == 202
         ThemeJobStatuses.new(Oj.load(response.body)['job'])
       end
 
@@ -273,7 +296,7 @@ module Readiness
       end
 
       ##
-      # Updatea a theme. This will exit on error
+      # Creates a theme. This will exit on error
       #
       # @author Jason Colyer
       # @since 1.0.12
@@ -289,7 +312,7 @@ module Readiness
       #   config.url = 'https://example.zendesk.com/api/v2'
       #   client = Readiness::Zendesk::Client.new(config)
       #   theme = Readiness::Zendesk::Themes.live_theme(client)
-      #   job = Readiness::Zendesk::Themes.update!(client, theme, 'data/modified_theme')
+      #   job = Readiness::Zendesk::Themes.create!(client, theme, 'data/modified_theme')
       #   job = Readiness::Zendesk::Themes.upload!(client, job, file)
       #   pp job.id
       #   # => "a66e7bde543c6b6d018f0e07a654feaf"
@@ -298,6 +321,32 @@ module Readiness
         job = generate_import_job!(client, theme)
         upload!(client, job, file)
       end
+
+      ##
+      # Deletes a theme. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.20
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param theme [Object] An instance of {Readiness::Zendesk::Themes}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/help_center/help-center-api/theming/#delete-theme Zendesk API > Themes > Delete Theme
+      # @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)
+      #   theme = Readiness::Zendesk::Themes.find!(client, 'a66e7bde543c6b6d018f0e07a654feaf')
+      #   delete = Readiness::Zendesk::Themes.delete!(client, theme)
+      #   pp delete
+      #   # => true
+      def self.delete!(client, theme)
+        response = client.connection.delete "guide/themeing/themes/#{theme.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete a theme', id: theme.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.19
+  version: 1.0.21
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2024-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -278,6 +278,7 @@ files:
 - lib/support_readiness/repos/macros.rb
 - lib/support_readiness/repos/organization_fields.rb
 - lib/support_readiness/repos/sla_policies.rb
+- lib/support_readiness/repos/themes.rb
 - lib/support_readiness/repos/ticket_fields.rb
 - lib/support_readiness/repos/ticket_forms.rb
 - lib/support_readiness/repos/triggers.rb