gitlab_support_readiness 1.0.8 → 1.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb6ce249d7793519dad87daf138f77b5bca3e0e856750afc720f7d8d1a7ec2d9
-  data.tar.gz: 1e6421faf02b125338fc8ebd3ec0844999b2ed3ba024914cbc7ac49571b3d455
+  metadata.gz: 7b6172a8a41b139003edf771fe377bd8910f12d41c27d54456290c114cae08cb
+  data.tar.gz: 568efc6d2b6cd4bd7c014787a70cce19927415b14944ed4e4bb7dac4f682b03a
 SHA512:
-  metadata.gz: 447477704b6d00f11f71927e26724160a485463b3b1f10e94b66f7dd978b0e34161f6ab67f47f1e58af7aa7a06e975b16792a2487baf87321b0896a5bb361b91
-  data.tar.gz: fc45684a9e03449b8962547622bc89e4fd5c3e8a64a248979dc1b5fdb5da0180e1581d72582f3ba19581079eb5a5ae0ab41645f22c87ba7e10d4daca9e52bc7d
+  metadata.gz: 50e8b47c5a5eb3cc7b3e537c4d64c30ebc5f1461c1586b7890ca97b20783d285a8c060cf4c35dac4ad9a76e75b6645f8b1498e42c3162ca71f2d96197b4b3acb
+  data.tar.gz: 502bee0ca7781bd1469a7551f0a40239f940e7619b083e8c148b6e81f2ba58c277d6adf8ce18f35465864df2ce16e465e93f14ede1d6b367c882c38f14a18e90

data/lib/support_readiness/client.rb

@@ -36,6 +36,22 @@ module Readiness
       hash.to_json
     end
 
+    ##
+    # Converts an Object to a JSON String, removing nil values except for ones defined in an Array
+    #
+    # @author Jason Colyer
+    # @since 1.0.9
+    # @param object [Object]
+    # @param keep_nil [Array] An array of keys to keep as nil in the final return
+    # @return [String]
+    def self.to_nearly_clean_json(object, keep_nil)
+      hash = to_hash(object).compact
+      keep_nil.each do |k|
+        hash[key.to_sym][k] = nil unless hash[key.to_sym].keys.include? k
+      end
+      hash.to_json
+    end
+
     ##
     # Converts an Object to a JSON String with a leading key, removing nil values
     #
@@ -49,6 +65,23 @@ module Readiness
       hash.to_json
     end
 
+    ##
+    # Converts an Object to a JSON String with a leading key, removing nil values except for ones defined in an Array
+    #
+    # @author Jason Colyer
+    # @since 1.0.9
+    # @param object [Object]
+    # @param key [String]
+    # @param keep_nil [Array] An array of keys to keep as nil in the final return
+    # @return [String]
+    def self.to_nearly_clean_json_with_key(object, key, keep_nil)
+      hash = { "#{key}": to_hash(object).compact }
+      keep_nil.each do |k|
+        hash[key.to_sym][k] = nil unless hash[key.to_sym].keys.include? k
+      end
+      hash.to_json
+    end
+
     ##
     # Handles error occurred from making Faraday requests
     #
@@ -86,9 +119,15 @@ module Readiness
       exit 1
     end
 
+    ##
+    # Handles 400 bad request errors from making Faraday requests.
+    #
+    # @author Jason Colyer
+    # @since 1.0.0
+    # @param system [String] The system the error occurred on
+    # @param params [Hash] A Hash of information about the request
     def self.bad_request_error(system, params)
-      pp system
-      pp params
+      puts "Action '#{params[:action]}' to ID #{params[:id]} on #{system} returned a 404 error"
       exit 1
     end
 

data/lib/support_readiness/gitlab/issues.rb

@@ -68,41 +68,6 @@ module Readiness
         @weight = object['weight']
       end
 
-      ##
-      # Lists all issues. Does not stop until it ends or the page limit is hit.
-      # This method can take a long time to run depending on the parameters used.
-      #
-      # @author Jason Colyer
-      # @since 1.0.0
-      # @param client [Object] An instance of {Readiness::GitLab::Client}
-      # @param limit [Integer] The number of pages to stop at. Using 0 means to list all.
-      # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
-      # @return [Array]
-      # @see https://docs.gitlab.com/ee/api/issues.html#list-issues GitLab API > Issues > List issues
-      # @example
-      #   require 'support_readiness'
-      #   config = Readiness::GitLab::Configuration.new
-      #   config.token = 'test123abc'
-      #   client = Readiness::GitLab::Client.new(config)
-      #   issues = Readiness::GitLab::Issues.list_all(client, 2, ["assignee_id=5", "state=opened"])
-      #   puts issues.first.web_url
-      #   # => "https://gitlab.com/gitlab-com/support/support-team-meta/-/issues/1"
-      def self.list_all(client, limit = 0, filters = [])
-        array = []
-        page = 1
-        loop do
-          response = client.connection.get "issues?per_page=100&page=#{page}&#{to_param_string(filters)}"
-          handle_request_error(0, 'GitLab', response.status) unless response.status == 200
-          body = Oj.load(response.body)
-          array += body.map { |p| Issues.new(p) }
-          break if body.count < 100
-          break if limit != 0 && array.count >= (limit * 100)
-
-          page += 1
-        end
-        array
-      end
-
       ##
       # Lists all issues for an object. Does not stop until it ends or the page limit is hit.
       # This method can take a long time to run depending on the parameters used.
@@ -306,7 +271,7 @@ module Readiness
         array = []
         page = 0
         loop do
-          response = client.connection.get "projects/#{project.id}/issues/#{issues.id}/notes?per_page=100&page=#{page}"
+          response = client.connection.get "projects/#{project.id}/issues/#{issues.iid}/notes?per_page=100&page=#{page}"
           handle_request_error(0, 'GitLab', response.status) unless response.status == 200
           body = Oj.load(response.body)
           array += body
@@ -374,7 +339,7 @@ module Readiness
       #   pp comment['updated_at']
       #    # => "2024-09-23T16:47:36Z"
       def self.update_comment!(client, project, issue, cid, params)
-        response = client.connection.put "projects/#{project.id}/issues/#{issue.iid}/notes/#{cid}", to_clean_json(params)
+        response = client.connection.put "projects/#{project.id}/issues/#{issue.iid}/notes/#{cid}", params.to_json
         handle_request_error(1, 'GitLab', response.status, { action: 'Update issue comment', id: issue.id }) unless response.status == 200
         Oj.load(response.body)
       end

data/lib/support_readiness/gitlab/projects.rb

@@ -447,7 +447,7 @@ module Readiness
       #   pp badge['id']
       #   # => 7
       def self.create_badge!(client, project, params)
-        response = client.connection.post "projects/#{project.id}/badges", to_clean_json(params)
+        response = client.connection.post "projects/#{project.id}/badges", params.to_json
         handle_request_error(1, 'GitLab', response.status, { action: 'Create badge', id: project.id }) unless response.status == 200
         Oj.load(response.body)
       end
@@ -472,11 +472,11 @@ module Readiness
       #   bdge_params = {
       #     image_url: 'https://shields.io/my/badge'
       #   }
-      #   badge = Readiness::GitLab::Projects.create_badge!(client, project, 7, bdge_params)
+      #   badge = Readiness::GitLab::Projects.update_badge!(client, project, 7, bdge_params)
       #   pp badge['name']
       #   # => "mybadge"
       def self.update_badge!(client, project, bid, params)
-        response = client.connection.put "projects/#{project.id}/badges/#{bid}", to_clean_json(params)
+        response = client.connection.put "projects/#{project.id}/badges/#{bid}", params.to_json
         handle_request_error(1, 'GitLab', response.status, { action: 'Update badge', id: project.id }) unless response.status == 200
         Oj.load(response.body)
       end
@@ -497,7 +497,7 @@ module Readiness
       #   config.token = 'test123abc'
       #   client = Readiness::GitLab::Client.new(config)
       #   project = Readiness::GitLab::Projects.find!(client, 1083469)
-      #   badge = Readiness::GitLab::Projects.create_badge!(client, project, 7)
+      #   badge = Readiness::GitLab::Projects.delete_badge!(client, project, 7)
       #   pp badge
       #   # => true
       def self.delete_badge!(client, project, bid)

data/lib/support_readiness/gitlab/repositories.rb

@@ -81,7 +81,7 @@ module Readiness
       # @param project [Object] An instance of {Readiness::GitLab::Projects}
       # @param path [String] The full file path. Ex: lib/support_readiness/gitlab/repositories.rb
       # @param ref [String] The name of branch, tag or commit
-      # @return [Array]
+      # @return [String]
       # @see https://docs.gitlab.com/ee/api/repository_files.html#get-raw-file-from-repository GitLab API > Repository files > Get raw file from repository
       # @example
       #   require 'support_readiness'
@@ -90,12 +90,12 @@ module Readiness
       #   client = Readiness::GitLab::Client.new(config)
       #   project = Readiness::GitLab::Projects.find!(client, 1083469)
       #   file = Readiness::GitLab::Repositories.raw_file(client, project, ".gitlab/CODEOWNERS", "main")
-      #   pp file['size']
-      #   # => 88
+      #   pp file
+      #   # => "Hello World!"
       def self.raw_file(client, project, path, ref)
         response = client.connection.get "projects/#{project.id}/repository/files/#{CGI.escape(path)}/raw?ref=#{ref}"
         handle_request_error(0, 'GitLab', response.status) unless response.status == 200
-        Oj.load(response.body)
+        response.body
       end
 
       ##
@@ -126,7 +126,7 @@ module Readiness
       #   pp file['path']
       #   # => "spec/test.file"
       def self.create_file!(client, project, path, params)
-        response = client.connection.post "projects/#{project.id}/repository/files/#{CGI.escape(path)}", to_clean_json(params)
+        response = client.connection.post "projects/#{project.id}/repository/files/#{CGI.escape(path)}", params.to_json
         handle_request_error(1, 'GitLab', response.status, { action: 'Create file in repo', id: "#{project.id}" }) unless response.status == 200
         Oj.load(response.body)
       end
@@ -159,7 +159,7 @@ module Readiness
       #   pp file['path']
       #   # => "spec/test.file"
       def self.update_file!(client, project, path, params)
-        response = client.connection.put "projects/#{project.id}/repository/files/#{CGI.escape(path)}", to_clean_json(params)
+        response = client.connection.put "projects/#{project.id}/repository/files/#{CGI.escape(path)}", params.to_json
         handle_request_error(1, 'GitLab', response.status, { action: 'Update file in repo', id: "#{project.id}" }) unless response.status == 200
         Oj.load(response.body)
       end
@@ -190,7 +190,7 @@ module Readiness
       #   pp file
       #   # => true
       def self.delete_file!(client, project, path, params)
-        response = client.connection.delete "projects/#{project.id}/repository/files/#{CGI.escape(path)}", to_clean_json(params)
+        response = client.connection.delete "projects/#{project.id}/repository/files/#{CGI.escape(path)}", params.to_json
         handle_request_error(1, 'GitLab', response.status, { action: 'Delete file in repo', id: "#{project.id}" }) unless response.status == 204
         true
       end
@@ -227,7 +227,7 @@ module Readiness
       #   pp commit['title']
       #   # => "Notify via slack for failed pipelines"
       def self.create_commit!(client, project, params)
-        response = client.connection.post "projects/#{project.id}/repository/commits", to_clean_json(params)
+        response = client.connection.post "projects/#{project.id}/repository/commits", params.to_json
         handle_request_error(1, 'GitLab', response.status, { action: 'Create commit', id: "#{project.id}" }) unless response.status == 200
         Oj.load(response.body)
       end
@@ -258,7 +258,7 @@ module Readiness
       #   pp update['parent_ids']
       #   # => ["ae1d9fb46aa2b07ee9836d49862ec4e2c46fbbba"]
       def self.update_submodule!(client, project, path, params)
-        response = clinet.connection.put "projects/#{project.id}/repository/submodules/#{CGI.escape(path)}", to_clean_json(params)
+        response = clinet.connection.put "projects/#{project.id}/repository/submodules/#{CGI.escape(path)}", params.to_json
         handle_request_error(1, 'GitLab', response.status, { action: 'Update submodule in repo', id: "#{project.id}" }) unless response.status == 200
         Oj.load(response.body)
       end

data/lib/support_readiness/gitlab/users.rb

@@ -248,7 +248,7 @@ module Readiness
       # @param user [Object] An instance of {Readiness::GitLab::Users}
       # @param filters [Array] An array of filter Strings to use. Should be in the format of key=value
       # @return [Array]
-      # @see https://docs.gitlab.com/ee/api/projects.html#list-user-projects GitLab API > Projects > List user projects
+      # @see https://docs.gitlab.com/ee/api/projects.html#list-a-users-projects GitLab API > Projects > List user projects
       # @example
       #   require 'support_readiness'
       #   config = Readiness::GitLab::Configuration.new
@@ -383,7 +383,7 @@ module Readiness
       #   pp token['token']
       #   # => "s3cr3t1"
       def self.create_token!(client, user, params)
-        response = client.connection.post "users/#{user.id}/personal_access_tokens", to_clean_json(params)
+        response = client.connection.post "users/#{user.id}/personal_access_tokens", params.to_json
         handle_request_error(1, 'GitLab', response.status, { action: 'Create PAT for a user', id: "#{user.id}" }) unless response.status == 200
         Oj.load(response.body)
       end

data/lib/support_readiness/redis.rb

@@ -54,6 +54,8 @@ module Readiness
     #   # => bar
     def self.get(client, key)
       Marshal.load client.connection.get(key)
+    rescue TypeError
+      nil
     end
 
     ##
@@ -69,7 +71,7 @@ module Readiness
     #   redis = Readiness::Redis.new('domain.com', 6379, 'p@assw0rd!')
     #   Readiness::Redis.set(redis, 'foo', 'bar2')
     def self.set(client, key, value)
-      client.connection.set(key, Marhsal.dump(value))
+      client.connection.set(key, Marshal.dump(value))
     end
 
     ##
@@ -79,12 +81,16 @@ module Readiness
     # @since 1.0.0
     # @param client [Object] A {Readiness::Redis} instance
     # @param key [String] The Redis key to delete
+    # @return [Boolean]
     # @example
     #   require 'support_readiness'
     #   redis = Readiness::Redis.new('domain.com', 6379, 'p@assw0rd!')
     #   Readiness::Redis.del(redis, 'foo')
     def self.del(client, key)
-      client.connection.del(key)
+      response = client.connection.del(key)
+      return true if response == 1
+
+      false
     end
   end
 end

data/lib/support_readiness/zendesk/articles.rb

@@ -141,14 +141,16 @@ module Readiness
       #   client = Readiness::Zendesk::Client.new(config)
       #   article = Readiness::Zendesk::Articles.new
       #   article.title = 'Taking photos in low light'
-      #   artricle.body = 'Use a tripod'
+      #   article.body = 'Use a tripod'
       #   article.section_id = 123
       #   article.locale = 'en-us'
+      #   article.user_segment_id = nil
+      #   article.permission_group_id = 12528735509276
       #   create = Readiness::Zendesk::Articles.create!(client, article)
       #   pp create.id
       #   # => 35468
       def self.create!(client, article)
-        response = client.connection.post "help_center/sections/#{article.section_id}/articles", to_clean_json_with_key(article, 'article')
+        response = client.connection.post "help_center/sections/#{article.section_id}/articles", to_nearly_clean_json_with_key(article, 'article', ['user_segment_id'])
         handle_request_error(1, 'Zendesk', response.status, { action: 'Create article', message: Oj.load(response.body)}) unless response.status == 201
         Articles.new(Oj.load(response.body)['article'])
       end
@@ -175,7 +177,7 @@ module Readiness
       #   pp update.body
       #   # => "Use a tripod and low light approved camera"
       def self.update!(client, article)
-        response = client.connection.put "help_center/sections/#{article.section_id}/articles", to_clean_json_with_key(article, 'article')
+        response = client.connection.put "help_center/articles/#{article.id}", to_nearly_clean_json_with_key(article, 'article', ['user_segment_id'])
         handle_request_error(1, 'Zendesk', response.status, { action: 'Update article', id: article.id, message: Oj.load(response.body)}) unless response.status == 200
         Articles.new(Oj.load(response.body)['article'])
       end
@@ -201,7 +203,7 @@ module Readiness
       #   pp archive
       #   # => true
       def self.archive!(client, article)
-        response = client.connection.delete "help_center/articles/#{article_id}"
+        response = client.connection.delete "help_center/articles/#{article.id}"
         handle_request_error(1, 'Zendesk', response.status, { action: 'Archive article', id: article.id, message: Oj.load(response.body)}) unless response.status == 204
         true
       end

data/lib/support_readiness/zendesk/automations.rb

@@ -137,21 +137,21 @@ module Readiness
       #   automation.conditions = {
       #     all: [
       #       {
-      #         field: 'status'
-      #         operator: 'is'
+      #         field: 'status',
+      #         operator: 'is',
       #         value: 'solved'
       #       },
       #       {
-      #         field: 'priority'
-      #         operator: 'is_not'
+      #         field: 'priority',
+      #         operator: 'is_not',
       #         value: 'low'
       #       }
-      #     ]
+      #     ],
       #     any: []
       #   }
       #   automation.actions = [
       #       {
-      #         field: 'priority'
+      #         field: 'priority',
       #         value: 'low'
       #       }
       #   ]
@@ -213,7 +213,7 @@ module Readiness
       end
 
       ##
-      # Updates multiple automations via a batch job
+      # Updates multiple automations. Can only update position and active values.
       #
       # @author Jason Colyer
       # @since 1.0.0
@@ -238,11 +238,11 @@ module Readiness
       #   updated = Readiness::Zendesk::Automations.update_many!(client, automation)
       #   pp updated.first.position
       #   # => 2
-      def self.update_many(client, automations)
+      def self.update_many!(client, automations)
         data = { automations: automations.map { |t| to_hash(t).compact } }.to_json
         response = client.connection.put('automations/update_many', data)
         handle_request_error(1, 'Zendesk', response.status, { action: 'Update many automations', message: Oj.load(response.body)}) unless response.status == 200
-        Oj.load(response.body).map { |a| Automations.new(a) }
+        Oj.load(response.body)['automations'].map { |a| Automations.new(a) }
       end
 
       ##
@@ -287,11 +287,7 @@ module Readiness
       #   config.token = 'test123abc'
       #   config.url = 'https://example.zendesk.com/api/v2'
       #   client = Readiness::Zendesk::Client.new(config)
-      #   automation1 = Readiness::Zendesk::Automations.find!(client, 1)
-      #   automation2 = Readiness::Zendesk::Automations.find!(client, 2)
-      #   automation3 = Readiness::Zendesk::Automations.find!(client, 3)
-      #   automations = [automation1, automation2, automation3]
-      #   deleted = Readiness::Zendesk::Automations.delete_many!(client, automation)
+      #   deleted = Readiness::Zendesk::Automations.delete_many!(client, [1, 7, 19])
       #   pp deleted
       #   # => true
       def self.delete_many!(client, aids)

data/lib/support_readiness/zendesk/group_memberships.rb

@@ -194,7 +194,7 @@ module Readiness
       #   create = Readiness::Zendesk::GroupMemberships.create_many!(client, memberships)
       #   pp create.id
       #   # => "82de0b044094f0c67893ac9fe64f1a99"
-      def self.create_many(client, memberships)
+      def self.create_many!(client, memberships)
         data = { group_memberships: memberships.map { |t| to_hash(t).compact } }.to_json
         response = client.connection.post('group_memberships/create_many', data)
         handle_request_error(1, 'Zendesk', response.status, { action: 'Create many group memberships', message: Oj.load(response.body)}) unless response.status == 200

data/lib/support_readiness/zendesk/groups.rb

@@ -237,7 +237,6 @@ module Readiness
           handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
           body = Oj.load(response.body)
           array += body['group_memberships']
-          break if limit != 0 && array.count >= (limit * 100)
           break unless body['meta']['has_more']
 
           opts = body['links'] ['next'].split('?').last

data/lib/support_readiness/zendesk/macros.rb

@@ -173,7 +173,7 @@ module Readiness
       end
 
       ##
-      # Updates multiple macros via a batch job
+      # Updates multiple macros. Can only update position and active values.
       #
       # @author Jason Colyer
       # @since 1.0.0
@@ -230,7 +230,7 @@ module Readiness
       end
 
       ##
-      # Deletes multiple macros via a batch job
+      # Deletes multiple macros
       #
       # @author Jason Colyer
       # @since 1.0.0

data/lib/support_readiness/zendesk/organization_fields.rb

@@ -139,7 +139,7 @@ module Readiness
       #   field.type = 'text'
       #   field.title = 'Support desc'
       #   field.description = 'This field describes the support plan this organization has'
-      #   field.position: 0
+      #   field.position = 0
       #   field.active = true
       #   field.key = 'support_description'
       #   create = Readiness::Zendesk::OrganizationFields.create!(client, field)
@@ -173,7 +173,7 @@ module Readiness
       #   pp create.title
       #   # => "Support description"
       def self.update!(client, field)
-        response = client.connection.put "organization_fields/#{field.id}", to_clean_json_with_key(field, 'ticket_field')
+        response = client.connection.put "organization_fields/#{field.id}", to_clean_json_with_key(field, 'organization_field')
         handle_request_error(1, 'Zendesk', response.status, { action: 'Update organization field', message: Oj.load(response.body)}) unless response.status == 200
         OrganizationFields.new(Oj.load(response.body)['organization_field'])
       end

data/lib/support_readiness/zendesk/organization_memberships.rb

@@ -244,10 +244,10 @@ module Readiness
       #   config.token = 'test123abc'
       #   config.url = 'https://example.zendesk.com/api/v2'
       #   client = Readiness::Zendesk::Client.new(config)
-      #   deletes = Readiness::Zendesk::OrganizationMemberships.delete!(client, [461, 462])
+      #   deletes = Readiness::Zendesk::OrganizationMemberships.delete_many!(client, [461, 462])
       #   pp deletes.id
       #   # => "82de0b044094f0c67893ac9fe64f1a99"
-      def self.delete_many(client, mids)
+      def self.delete_many!(client, mids)
         response = client.connection.delete("organization_memberships/destroy_many?ids=#{mids.join(',')}")
         handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many organization memberships', message: Oj.load(response.body)}) unless response.status == 200
         JobStatuses.new(Oj.load(response.body)['job_status'])

data/lib/support_readiness/zendesk/organizations.rb

@@ -503,7 +503,6 @@ module Readiness
           handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
           body = Oj.load(response.body)
           array += body['organization_memberships'].map { |o| OrganizationMemberships.new(o) }
-          break if limit != 0 && array.count >= (limit * 100)
           break unless body['meta']['has_more']
 
           opts = body['links'] ['next'].split('?').last

data/lib/support_readiness/zendesk/roles.rb

@@ -62,7 +62,7 @@ module Readiness
       # @param client [Object] An instance of {Readiness::Zendesk::Client}
       # @param rid [Integer] The Custom Role ID to find
       # @return [Hash]
-      # @see https:/developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#show-custom-role Zendesk API > Custom Roles > Show Custom Role
+      # @see https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#show-custom-role Zendesk API > Custom Roles > Show Custom Role
       # @example
       #   require 'support_readiness'
       #   config = Readiness::Zendesk::Configuration.new
@@ -89,7 +89,7 @@ module Readiness
       # @param client [Object] An instance of {Readiness::Zendesk::Client}
       # @param rid [Integer] The Custom Role ID to find
       # @return [Object] An instance of {Readiness::Zendesk::Roles}
-      # @see https:/developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#show-custom-role Zendesk API > Custom Roles > Show Custom Role
+      # @see https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#show-custom-role Zendesk API > Custom Roles > Show Custom Role
       # @example
       #   require 'support_readiness'
       #   config = Readiness::Zendesk::Configuration.new
@@ -114,7 +114,7 @@ module Readiness
       # @param client [Object] An instance of {Readiness::Zendesk::Client}
       # @param role [Object] An instance of {Readiness::Zendesk::Roles}
       # @return [Object] An instance of {Readiness::Zendesk::Roles}
-      # @see https:/developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#create-custom-role Zendesk API > Custom Roles > Create Custom Role
+      # @see https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#create-custom-role Zendesk API > Custom Roles > Create Custom Role
       # @example
       #   require 'support_readiness'
       #   config = Readiness::Zendesk::Configuration.new
@@ -145,7 +145,7 @@ module Readiness
       # @param client [Object] An instance of {Readiness::Zendesk::Client}
       # @param role [Object] An instance of {Readiness::Zendesk::Roles}
       # @return [Object] An instance of {Readiness::Zendesk::Roles}
-      # @see https:/developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#update-custom-role Zendesk API > Custom Roles > Update Custom Role
+      # @see https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#update-custom-role Zendesk API > Custom Roles > Update Custom Role
       # @example
       #   require 'support_readiness'
       #   config = Readiness::Zendesk::Configuration.new
@@ -172,7 +172,7 @@ module Readiness
       # @param client [Object] An instance of {Readiness::Zendesk::Client}
       # @param role [Object] An instance of {Readiness::Zendesk::Roles}
       # @return [Boolean]
-      # @see https:/developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#delete-custom-role Zendesk API > Custom Roles > Delete Custom Role
+      # @see https://developer.zendesk.com/api-reference/ticketing/account-configuration/custom_roles/#delete-custom-role Zendesk API > Custom Roles > Delete Custom Role
       # @example
       #   require 'support_readiness'
       #   config = Readiness::Zendesk::Configuration.new

data/lib/support_readiness/zendesk/sla_policies.rb

@@ -145,7 +145,7 @@ module Readiness
       #   pp create.id
       #   # => 36
       def self.create!(client, policy)
-        response = client.connection.post 'slas/policies', to_clean_json_with_key(policyt, 'sla_policy')
+        response = client.connection.post 'slas/policies', to_clean_json_with_key(policy, 'sla_policy')
         handle_request_error(1, 'Zendesk', response.status, { action: 'Create SLA Policy', message: Oj.load(response.body)}) unless response.status == 201
         SLAs.new(Oj.load(response.body)['sla_policy'])
       end

data/lib/support_readiness/zendesk/ticket_forms.rb

@@ -280,7 +280,7 @@ module Readiness
       #   reorder = Readiness::Zendesk::TicketForms.reorder!(client, [2, 23, 46, 50])
       #   pp reorder.count
       #   # => 4
-      def self.reorder(client, fids)
+      def self.reorder!(client, fids)
         response = client.connection.put 'ticket_forms/reorder', { ticket_form_ids: fids }.to_json
         handle_request_error(1, 'Zendesk', response.status, { action: 'Clone a ticket form', id: form.id, message: Oj.load(response.body)}) unless response.status == 200
         Oj.load(response.body)['ticket_form'].map { |f| TicketForms.new(f) }

data/lib/support_readiness/zendesk/tickets.rb

@@ -108,7 +108,7 @@ module Readiness
       end
 
       ##
-      # Lists the CCs on a ticket
+      # Lists the CCs on a ticket. If your system is not using followers, you need to use {collaborators}
       #
       # @author Jason Colyer
       # @since 1.0.0
@@ -492,7 +492,7 @@ module Readiness
       def self.delete_permanently!(client, tid)
         response = client.connection.delete "deleted_tickets/#{tid}"
         handle_request_error(1, 'Zendesk', response.status) unless response.status == 200
-        JobStatuses.new(Oj.load(response.body['job_status']))
+        JobStatuses.new(Oj.load(response.body)['job_status'])
       end
 
       ##
@@ -523,7 +523,6 @@ module Readiness
           handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
           body = Oj.load(response.body)
           array += body['tickets'].map { |t| Tickets.new(t) }
-          break if limit != 0 && array.count >= (limit * 100)
           break unless body['meta']['has_more']
 
           opts = body['links'] ['next'].split('?').last
@@ -557,7 +556,6 @@ module Readiness
           handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
           body = Oj.load(response.body)
           array += body['tickets'].map { |t| Tickets.new(t) }
-          break if limit != 0 && array.count >= (limit * 100)
           break unless body['meta']['has_more']
 
           opts = body['links'] ['next'].split('?').last
@@ -742,7 +740,6 @@ module Readiness
           handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
           body = Oj.load(response.body)
           array += body['suspended_tickets']
-          break if limit != 0 && array.count >= (limit * 100)
           break unless body['meta']['has_more']
 
           opts = body['links'] ['next'].split('?').last

data/lib/support_readiness/zendesk/triggers.rb

@@ -184,7 +184,7 @@ module Readiness
       end
 
       ##
-      # Updates multiple triggers via a batch job
+      # Updates multiple triggers
       #
       # @author Jason Colyer
       # @since 1.0.0
@@ -211,7 +211,7 @@ module Readiness
         data = { triggers: triggers.map { |t| to_hash(t).compact } }.to_json
         response = client.connection.put('triggers/update_many', data)
         handle_request_error(1, 'Zendesk', response.status, { action: 'Update many triggers', message: Oj.load(response.body)}) unless response.status == 200
-        Oj.load(response.body)['trigger'].map { |t| Triggers.new(t) }
+        Oj.load(response.body)['triggers'].map { |t| Triggers.new(t) }
       end
 
       ##
@@ -256,10 +256,10 @@ module Readiness
       #   config.token = 'test123abc'
       #   config.url = 'https://example.zendesk.com/api/v2'
       #   client = Readiness::Zendesk::Client.new(config)
-      #   deletes = Readiness::Zendesk::Triggers.delete!(client, [25, 23, 27, 22])
+      #   deletes = Readiness::Zendesk::Triggers.delete_many!(client, [25, 23, 27, 22])
       #   pp deletes
       #   # => true
-      def self.delete_many(client, tids)
+      def self.delete_many!(client, tids)
         response = client.connection.delete("triggers/destroy_many?ids=#{tids.join(',')}")
         handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many triggers', message: Oj.load(response.body)}) unless response.status == 204
         true

data/lib/support_readiness/zendesk/users.rb

@@ -383,8 +383,8 @@ module Readiness
       #   # => 189304711533
       def self.delete_permanently!(client, uid)
         response = client.connection.delete "deleted_users/#{uid}"
-        handle_request_error(1, 'Zendesk', response.status) unless response.status == 200
-        Oj.load(response.body['deleted_user'])
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Delete user permanently', id: uid, message: Oj.load(response.body)}) unless response.status == 200
+        Oj.load(response.body)['deleted_user']
       end
 
       ##
@@ -466,7 +466,7 @@ module Readiness
       #   pp deletes['value']
       #   # => 13
       def self.deleted_count(client)
-        response = client.connection.get("deleted_users/count?#{opts}")
+        response = client.connection.get('deleted_users/count')
         handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
         Oj.load(response.body)['count']
       end
@@ -636,6 +636,8 @@ module Readiness
       #   pp tickets.count
       #   # => 2
       def self.assigned_tickets(client, user)
+        return 0 if user.role == 'end-user'
+
         array = []
         opts = "page[size]=100"
         loop do
@@ -736,7 +738,7 @@ module Readiness
       #   # => "82de0b044094f0c67893ac9fe64f1a99"
       def self.create_or_update_many!(client, users)
         data = { users: users.map { |u| to_hash(u).compact } }.to_json
-        response = client.connection.post('users/create_or_update_many', data)
+        response = client.connection.put('users/create_or_update_many', data)
         handle_request_error(1, 'Zendesk', response.status, { action: 'Create or update many users', message: Oj.load(response.body)}) unless response.status == 200
         JobStatuses.new(Oj.load(response.body)['job_status'])
       end
@@ -821,7 +823,7 @@ module Readiness
         array = []
         opts = "page[size]=100"
         loop do
-          response = client.connection.get("user/#{user.id}/organization_memberships?#{opts}")
+          response = client.connection.get("users/#{user.id}/organization_memberships?#{opts}")
           handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
           body = Oj.load(response.body)
           array += body['organization_memberships'].map { |o| OrganizationMemberships.new(o) }
@@ -840,9 +842,9 @@ module Readiness
       # @since 1.0.0
       # @param client [Object] An instance of {Readiness::Zendesk::Client}
       # @param user [Object] An instance of {Readiness::Zendesk::Users}
-      # @param organization [Object] An instance of {Readiness::Zendesk::Organizations}
+      # @param membership [Object] An instance of {Readiness::Zendesk::OrganizationMemberships}
       # @return [Array]
-      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#set-organization-as-default Zendesk API > Organization Memberships > Set Organization as Default
+      # @see https://developer.zendesk.com/api-reference/ticketing/organizations/organization_memberships/#set-membership-as-default Zendesk API > Organization Memberships > Set Membership as Default
       # @example
       #   require 'support_readiness'
       #   config = Readiness::Zendesk::Configuration.new
@@ -851,12 +853,12 @@ module Readiness
       #   config.url = 'https://example.zendesk.com/api/v2'
       #   client = Readiness::Zendesk::Client.new(config)
       #   user = Readiness::Zendesk::Users.find!(client, 123)
-      #   org = Readiness::Zendesk::Organizations.find!(client, 456)
-      #   member = Readiness::Zendesk::Users.set_default_organization!(client, user, org)
+      #   membership = Readiness::Zendesk::Users.organization_memberships(client, user).last
+      #   member = Readiness::Zendesk::Users.set_default_organization!(client, user, membership)
       #   pp member.id
       #   # => 4
-      def self.set_default_organization!(client, user, organization)
-        response = client.connection.put("users/#{user.id}/organizations/#{organization.id}/make_default")
+      def self.set_default_organization!(client, user, membership)
+        response = client.connection.put("users/#{user.id}/organization_memberships/#{membership.id}/make_default")
         handle_request_error(1, 'Zendesk', response.status, { action: 'Set org as default', message: Oj.load(response.body)}) unless response.status == 200
         OrganizationMemberships.new(Oj.load(response.body)['organization_membership'])
       end
@@ -894,7 +896,7 @@ module Readiness
       # @since 1.0.0
       # @param client [Object] An instance of {Readiness::Zendesk::Client}
       # @param user [Object] An instance of {Readiness::Zendesk::Users}
-      # @param group [Object] An instance of {Readiness::Zendesk::Group}
+      # @param membership [Object] An instance of {Readiness::Zendesk::GroupMemberships}
       # @return [Array]
       # @see https://developer.zendesk.com/api-reference/ticketing/groups/group_memberships/#set-membership-as-default Zendesk API > Group Memberships > Set Membership as Default
       # @example
@@ -905,12 +907,12 @@ module Readiness
       #   config.url = 'https://example.zendesk.com/api/v2'
       #   client = Readiness::Zendesk::Client.new(config)
       #   user = Readiness::Zendesk::Users.find!(client, 123)
-      #   group = Readiness::Zendesk::Groups.find!(client, 456)
-      #   member = Readiness::Zendesk::Users.set_default_group!(client, user, group)
+      #   membership = Readiness::Zendesk::Users.group_memberships(client, user).last
+      #   member = Readiness::Zendesk::Users.set_default_group!(client, user, membership)
       #   pp member.id
       #   # => 4
-      def self.set_default_group!(client, user, group)
-        response = client.connection.put("users/#{user.id}/group_memberships/#{group.id}/make_default")
+      def self.set_default_group!(client, user, membership)
+        response = client.connection.put("users/#{user.id}/group_memberships/#{membership.id}/make_default")
         handle_request_error(1, 'Zendesk', response.status, { action: 'Set group as default', message: Oj.load(response.body)}) unless response.status == 200
         GroupMemberships.new(Oj.load(response.body)['group_memberships'])
       end

data/lib/support_readiness/zendesk/views.rb

@@ -163,39 +163,36 @@ module Readiness
       #   view.title = "Kelly's tickets"
       #   view.description = 'Tickets that are assigned to Kelly'
       #   view.active = true
-      #   view.position: 3
-      #   view.restriction: { type: 'User', id: '213977756' }
+      #   view.position = 3
       #   view.conditions = {
-      #     all: [
-      #       { field: 'status', operator: 'less_than', value: 'solved' },
-      #       { field: 'group_id', operator: 'is', value: '24000932' },
-      #       { field: 'custom_fields_360011872073', operator: 'is', value: 'Canada' }
+      #     "all" => [
+      #       { "field" => 'status', "operator" => 'less_than', "value" => 'solved' }
       #     ],
-      #     any: []
+      #     "any" => []
       #   }
       #   view.execution = {
-      #     columns: [
-      #       { id: 'status', title: 'Status', filterable: true, sortable: true},
-      #       { id: 'requester', title: 'Requester', filterable: true, sortable: true},
-      #       { id: 'assignee', title: 'Assignee', filterable: true, sortable: true},
-      #     ]
-      #     group_by: 'assignee',
-      #     group_order: 'desc',
-      #     sort_by: 'status',
-      #     sort_order: 'desc',
-      #     group: {
-      #       id: 'assignee',
-      #       title: 'Assignee',
-      #       filterable: true,
-      #       sortable: true,
-      #       order: 'desc'
-      #     }
-      #     sort: {
-      #       id: 'status',
-      #       title: 'Status',
-      #       filterable: true,
-      #       sortable: true,
-      #       order: 'desc'
+      #     "columns" => [
+      #       { "id" => 'status', "title" => 'Status', "filterable" => true, "sortable" => true},
+      #       { "id" => 'requester', "title" => 'Requester', "filterable" => true, "sortable" => true},
+      #       { "id" => 'assignee', "title" => 'Assignee', "filterable" => true, "sortable" => true},
+      #     ],
+      #     "group_by" => 'assignee',
+      #     "group_order" => 'desc',
+      #     "sort_by" => 'status',
+      #     "sort_order" => 'desc',
+      #     "group" => {
+      #       "id" => 'assignee',
+      #       "title" => 'Assignee',
+      #       "filterable" => true,
+      #       "sortable" => true,
+      #       "order" => 'desc'
+      #     },
+      #     "sort" => {
+      #       "id" => 'status',
+      #       "title" => 'Status',
+      #       "filterable" => true,
+      #       "sortable" => true,
+      #       "order" => 'desc'
       #     }
       #   }
       #   create = Readiness::Zendesk::Views.create!(client, view)
@@ -259,7 +256,7 @@ module Readiness
       #   pp updates.map { |v| v.title }
       #   # => ["Canada tickets", "Mexico tickets"]
       def self.update_many!(client, views)
-        data = { views: views.map { |v| create_or_update_object(view) } }.to_json
+        data = { views: views.map { |v| create_or_update_object(v) } }.to_json
         response = client.connection.put('views/update_many', data)
         handle_request_error(1, 'Zendesk', response.status, { action: 'Update many views', message: Oj.load(response.body)}) unless response.status == 200
         JobStatuses.new(Oj.load(response.body)['job_status'])
@@ -292,7 +289,7 @@ module Readiness
       end
 
       ##
-      # Deletes multiple views via a batch job
+      # Deletes multiple views
       #
       # @author Jason Colyer
       # @since 1.0.0
@@ -310,7 +307,7 @@ module Readiness
       #   deletes = Readiness::Zendesk::Views.find!(client, [9873858, 9873843])
       #   pp deletes
       #   # => true
-      def self.delete_many(client, vids)
+      def self.delete_many!(client, vids)
         response = client.connection.delete("views/destroy_many?ids=#{vids.join(',')}")
         handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many views', message: Oj.load(response.body)}) unless response.status == 204
         true
@@ -345,7 +342,7 @@ module Readiness
             output: converted['output']
           }
         }.compact.to_json
-        response = client.connection.post 'views/preview', data
+        response = client.connection.post 'views/preview', { view: data }.to_json
         handle_request_error(1, 'Zendesk', response.status, { action: 'Preview a view', message: Oj.load(response.body)}) unless response.status == 200
         Oj.load(response.body)
       end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.8
+  version: 1.0.9
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-26 00:00:00.000000000 Z
+date: 2024-09-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport