gitlab_support_readiness 1.0.9 → 1.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7b6172a8a41b139003edf771fe377bd8910f12d41c27d54456290c114cae08cb
-  data.tar.gz: 568efc6d2b6cd4bd7c014787a70cce19927415b14944ed4e4bb7dac4f682b03a
+  metadata.gz: 7b80e496307fbfaa496e95ca2af86a765ec8264d08cd70c5dde730305c597d2e
+  data.tar.gz: 0c1b9bf16c261245a4c8d8928d581bfe08d7b8e5dde42cee7fc55129233b42c4
 SHA512:
-  metadata.gz: 50e8b47c5a5eb3cc7b3e537c4d64c30ebc5f1461c1586b7890ca97b20783d285a8c060cf4c35dac4ad9a76e75b6645f8b1498e42c3162ca71f2d96197b4b3acb
-  data.tar.gz: 502bee0ca7781bd1469a7551f0a40239f940e7619b083e8c148b6e81f2ba58c277d6adf8ce18f35465864df2ce16e465e93f14ede1d6b367c882c38f14a18e90
+  metadata.gz: 9d38234f4a29dc2965e3544eb4e8f75830992cde999619b655ea1941c63255e1debb8aacccc841d92ecf6580a8ea2faf2d2c7edfbb9064df40fa5cd88c333977
+  data.tar.gz: 7419e41c9dbbe22058e0e567dc79b26c5408b3d4766e9d618dc3dfbd494f6b6619cf1d6a312c14dbd2df852c230098b75cbb76161c0f03b586638505e20a107d

data/lib/support_readiness/gitlab/issues.rb

@@ -271,7 +271,7 @@ module Readiness
         array = []
         page = 0
         loop do
-          response = client.connection.get "projects/#{project.id}/issues/#{issues.iid}/notes?per_page=100&page=#{page}"
+          response = client.connection.get "projects/#{project.id}/issues/#{issue.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

data/lib/support_readiness/gitlab/repositories.rb

@@ -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)}", params.to_json
+        response = client.connection.delete "projects/#{project.id}/repository/files/#{CGI.escape(path)}", params
         handle_request_error(1, 'GitLab', response.status, { action: 'Delete file in repo', id: "#{project.id}" }) unless response.status == 204
         true
       end

data/lib/support_readiness/zendesk/articles.rb

@@ -156,7 +156,7 @@ module Readiness
       end
 
       ##
-      # Updates an article. Will exit if unsuccessful
+      # Updates an article (both metadata and translation). Will exit if unsuccessful
       #
       # @author Jason Colyer
       # @since 1.0.0
@@ -177,11 +177,65 @@ module Readiness
       #   pp update.body
       #   # => "Use a tripod and low light approved camera"
       def self.update!(client, article)
+        update_article_metadata!(client, article)
+        update_article_translation!(client, article)
+        Articles.find!(client, article.id)
+      end
+
+      ##
+      # Updates an article's metadata. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.10
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param article [Object] An instance of {Readiness::Zendesk::Articles}
+      # @return [Object] An instance of {Readiness::Zendesk::Articles}
+      # @see https://developer.zendesk.com/api-reference/help_center/help-center-api/articles/#update-article Zendesk API > Articles > Update Article
+      # @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)
+      #   article = Readiness::Zendesk::Articles.find!(client, 35468)
+      #   artricle.promoted = true
+      #   update = Readiness::Zendesk::Articles.update_article_metadata!(client, article)
+      #   pp update.promoted
+      #   # => true
+      def self.update_article_metadata!(client, 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
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update article metadata', id: article.id, message: Oj.load(response.body)}) unless response.status == 200
         Articles.new(Oj.load(response.body)['article'])
       end
 
+      ##
+      # Updates an article's translation. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.10
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param article [Object] An instance of {Readiness::Zendesk::Articles}
+      # @return [Object] An instance of {Readiness::Zendesk::Articles}
+      # @see https://developer.zendesk.com/api-reference/help_center/help-center-api/translations/#update-translation Zendesk API > Translations > Update Translation
+      # @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)
+      #   article = Readiness::Zendesk::Articles.find!(client, 35468)
+      #   artricle.body = 'Contact support'
+      #   update = Readiness::Zendesk::Articles.update_article_translation!(client, article)
+      #   pp update.body
+      #   # => "Contact support"
+      def self.update_article_translation!(client, article)
+        response = client.connection.put "help_center/articles/#{article.id}/translations/#{article.locale}", to_nearly_clean_json_with_key(article, 'translation', ['user_segment_id'])
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Update article translation', id: article.id, message: Oj.load(response.body)}) unless response.status == 200
+        Oj.load(response.body)['translation']
+      end
+
       ##
       # Archives an article. Will exit if unsuccessful
       #

data/lib/support_readiness/zendesk/macros.rb

@@ -248,7 +248,7 @@ module Readiness
       #   deletes = Readiness::Zendesk::Macros.delete_many!(client, [25, 26])
       #   pp deletes
       #   # => true
-      def self.delete_many(client, mids)
+      def self.delete_many!(client, mids)
         response = client.connection.delete("macros/destroy_many?ids=#{mids.join(',')}")
         handle_request_error(1, 'Zendesk', response.status, { action: 'Delete many macros', message: Oj.load(response.body)}) unless response.status == 204
         true

data/lib/support_readiness/zendesk/tickets.rb

@@ -478,7 +478,7 @@ module Readiness
       # @param client [Object] An instance of {Readiness::Zendesk::Client}
       # @param tid [Integer] The deleted ticket's ID
       # @return [Object] A {Readiness::Zendesk::JobStatuses} instance
-      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#delete-ticket-permanentlyt Zendesk API > Tickets > Delete Ticket Permanently
+      # @see https://developer.zendesk.com/api-reference/ticketing/tickets/tickets/#delete-ticket-permanently Zendesk API > Tickets > Delete Ticket Permanently
       # @example
       #   require 'support_readiness'
       #   config = Readiness::Zendesk::Configuration.new
@@ -517,7 +517,7 @@ module Readiness
       #   # => [33, 34]
       def self.incidents(client, ticket)
         array = []
-        opts = "page[size]=100&sort=#{sort}"
+        opts = "page[size]=100"
         loop do
           response = client.connection.get("tickets/#{ticket.id}/incidents?#{opts}")
           handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
@@ -550,9 +550,9 @@ module Readiness
       #   # => [33, 34]
       def self.problems(client)
         array = []
-        opts = "page[size]=100&sort=#{sort}"
+        opts = "page[size]=100"
         loop do
-          response = client.connection.get("tickets/problems?#{opts}")
+          response = client.connection.get("problems?#{opts}")
           handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
           body = Oj.load(response.body)
           array += body['tickets'].map { |t| Tickets.new(t) }
@@ -734,7 +734,7 @@ module Readiness
       #   # => 18
       def self.list_suspended(client)
         array = []
-        opts = "page[size]=100&sort=#{sort}"
+        opts = "page[size]=100"
         loop do
           response = client.connection.get("suspended_tickets?#{opts}")
           handle_request_error(0, 'Zendesk', response.status) unless response.status == 200

data/lib/support_readiness/zendesk/users.rb

@@ -827,7 +827,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/views.rb

@@ -336,12 +336,10 @@ module Readiness
       def self.preview!(client, view)
         converted = create_or_update_object(view)
         data = {
-          view: {
-            all: converted['all'],
-            any: converted['any'],
-            output: converted['output']
-          }
-        }.compact.to_json
+          all: converted[:all],
+          any: converted[:any],
+          output: converted[:output]
+        }.compact
         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)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.9
+  version: 1.0.11
 platform: ruby
 authors:
 - Jason Colyer