gitlab_support_readiness 1.0.124 → 1.0.125

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc950bed810fd3f7ae72f252bae3cc7808d703ccf13474991be560b90b76e486
-  data.tar.gz: 571fc409b7cb717295d9b7edc986735b238dcb1dcdbe5929915b15b5a078c059
+  metadata.gz: 77742079ee62db6c4f2ed4dce4642ea2bf2fa06e3fd473d9cbe99e81e0f3bfae
+  data.tar.gz: 5756f05d4e08901351b13bb437c8681cc4c88267f653c28ff57d509c3cc468ac
 SHA512:
-  metadata.gz: eba8f245731ff253cd0517cf6ef09cb81bc3d4d5e9c683b75b6a5b3537ce26810f058e507e6266cf469215026b3c5b5da28bb452b867f281bdf45214320812db
-  data.tar.gz: d1ebd58aee4dae34bb3c32eddd43ec4f162d1f668989086cf5fa2610785c5dc77be8c8f7cc50e16b6de6201682aadbdbf0af1b9d0005bb545a7dc47d529d0385
+  metadata.gz: 2929642f4896b0c56d0edfc3c48464a0aa0da419cd6fd94cedd6bb64f8bcca8e2672fa41e61d8c37e0b700e9e91cd025474394508929fc1e09ff13a9f681df75
+  data.tar.gz: cdafbe5d734f4ad9e5eee5fe82593dfc46041884f3bf41665461652c635185ace3ee2346fb0065d6d4d0cee292711aee7db8551c31d330100bedd7ccd9debe96

data/lib/support_readiness/zendesk/oauth_clients.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class OAuthClients within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.125
+    # @todo create - https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#create-client
+    # @todo update - https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#update-client
+    # @todo delete - https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#delete-client
+    # @todo generate secret - https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#delete-client
+    class OAuthClients < Readiness::Client
+      attr_accessor :company, :created_at, :description, :id, :identifier, :name, :redirect_uri, :secret, :unique_id, :updated_at, :user_id
+
+      ##
+      # Creates a new {Readiness::Zendesk::OAuthClients} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.125
+      # @param object [Object] An instance of {Readiness::Zendesk::OAuthClients}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::OAuthClients.new
+      def initialize(object = {})
+        @company = object['company']
+        @created_at = object['created_at']
+        @description = object['description']
+        @id = object['id']
+        @identifier = object['identifier']
+        @name = object['name']
+        @redirect_uri = object['redirect_uri']
+        @secret = object['secret']
+        @unique_id = object['unique_id']
+        @updated_at = object['updated_at']
+        @user_id = object['user_id']
+      end
+      
+      ##
+      # Lists all OAuth clients.
+      #
+      # @author Jason Colyer
+      # @since 1.0.125
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#list-clients Zendesk API > OAuth Clients > List Clients
+      # @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)
+      #   oauth_clients = Readiness::Zendesk::OAuthClients.list(client)
+      #   pp oauth_clients.count
+      #   # => 12
+      def self.list(client)
+        array = []
+        opts = 'page[size]=100'
+        loop do
+          response = client.connection.get("oauth/clients?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['clients'].map { |c| OAuthClients.new(c) }
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        array
+      end
+      
+      ##
+      # Locates an OAuth client within Zendesk. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.125
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param cid [Integer[ The OAuth client ID to find
+      # @param return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#show-client Zendesk API > OAuth Clients > Show Client
+      # @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)
+      #   oauth_client = Readiness::Zendesk::OAuthClients.find(client, 223443)
+      #   pp oauth_client.name
+      #   # => "Test Client"
+      def self.find(client, cid)
+        response = client.connection.get("oauth/clients/#{cid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: cid }) unless response.status == 200
+        return OAuthClients.new(Oj.load(response.body)['client']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+      
+      ##
+      # Locates an OAuth client within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.125
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param cid [Integer[ The OAuth client ID to find
+      # @param return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_clients/#show-client Zendesk API > OAuth Clients > Show Client
+      # @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)
+      #   oauth_client = Readiness::Zendesk::OAuthClients.find!(client, 223443)
+      #   pp oauth_client.name
+      #   # => "Test Client"
+      def self.find!(client, cid)
+        response = client.connection.get("oauth/clients/#{cid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find OAuth client', id: cid }) unless response.status == 200
+        OAuthClients.new(Oj.load(response.body)['client'])
+      end
+      
+      ##
+      # Locates an OAuth client within Zendesk by name. Can utilize a cache for quicker results
+      #
+      # @author Jason Colyer
+      # @since 1.0.125
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param name [String] The OAuth client name to look for
+      # @param cache [Array] The results of {Readiness::Zendesk::OAuthClients#list}
+      # @return [Object] An instance of {Readiness::Zendesk::OAuthClients}
+      # @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)
+      #   oauth_client = Readiness::Zendesk::OAuthClients.find_by_name(client, 'Test Client')
+      #   pp oauth_client.id
+      #   # => 223443
+      def self.find_by_name(client, name, cache = nil)
+        oauth_clients = if cache.nil?
+                          OAuthClients.list(client)
+                        else
+                          cache
+                        end
+        oauth_clients.detect { |o| o.name == name }
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/oauth_tokens.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Defines the module Readiness.
+module Readiness
+  # Defines the module Zendesk
+  module Zendesk
+    ##
+    # Defines the class OAuthTokens within the module {Readiness::Zendesk}.
+    #
+    # @author Jason Colyer
+    # @since 1.0.125
+    # @todo list - https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/#list-tokens
+    # @todo show - https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/#show-token
+    # @todo revoke - https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/#revoke-token
+    class OAuthTokens < Readiness::Client
+      attr_accessor :client_id, :created_at, :expires_at, :full_token, :id, :refresh_token, :refresh_token_expires_at, :scopes, :token, :used_at, :user_id
+
+      ##
+      # Creates a new {Readiness::Zendesk::OAuthTokens} instance
+      #
+      # @author Jason Colyer
+      # @since 1.0.125
+      # @param object [Object] An instance of {Readiness::Zendesk::OAuthTokens}
+      # @example
+      #   require 'support_readiness'
+      #   Readiness::Zendesk::OAuthTokens.new
+      def initialize(object = {})
+        @client_id = object['client_id']
+        @created_at = object['created_at']
+        @expires_at = object['expires_at']
+        @full_token = object['full_token']
+        @id = object['id']
+        @refresh_token = object['refresh_token']
+        @refresh_token_expires_at = object['refresh_token_expires_at']
+        @scopes = object['scopes']
+        @token = object['token']
+        @used_at = object['used_at']
+        @user_id = object['user_id']
+      end
+      
+      ##
+      # Creates an Oauth token. Will exit if unsuccessful.
+      #
+      # @author Jason Colyer
+      # @since 1.0.125
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param token [Object] An instance of {Readiness::Zendesk::OAuthTokens}
+      # @return [Object] An instance of {Readiness::Zendesk::OAuthTokens}
+      # @see https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/#create-token Zendesk API > OAuth Tokens > Create Token
+      # @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)
+      #   token = Readiness::Zendesk::OAuthTokens.new
+      #   token.client_id = 1234
+      #   token.scopes = [
+      #     'impersonate',
+      #     'write'
+      #   ]
+      #   create = Readiness::Zendesk::OAuthTokens.create!(client, token)
+      #   pp create.full_token
+      #   # => "4v8AR9vXCM7dV4murXlIaBAAzDrAw9lIbaHF7X9VbVPtOABAyy3dnTtHE3A6AdNC"
+      def self.create!(client, token)
+        pp to_clean_json_with_key(token, 'token')
+       response = client.connection.post 'oauth/tokens', to_clean_json_with_key(token, 'token')
+       handle_request_error(1, 'Zendesk', response.status, { action: 'Create Oauth token', message: Oj.load(response.body)}) unless response.status == 201
+       OAuthTokens.new(Oj.load(response.body)['token'])
+      end
+    end
+  end
+end

data/lib/support_readiness/zendesk/tickets.rb

@@ -927,6 +927,58 @@ module Readiness
         end
         true
       end
+
+      ##
+      # Add a satisfaction rating to a ticket (must be done using end-user as the config.username). Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since NEW_VERSION
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param ticket [Object] An instance of {Readiness::Zendesk::Tickets}
+      # @param score [String] The score to use ('good' or 'bad' is the normal usage)
+      # @param comment [String] The comment to use
+      # @return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/ticket-management/satisfaction_ratings/#create-a-satisfaction-rating Zendesk API > Satisfaction Ratings > Create a Satisfaction Rating
+      # @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)
+      #   ticket = Readiness::Zendesk::Tickets.find!(client, 141)
+      #   user = Readiness::Zendesk::Users.find!(client, 123456)
+      #   oauth_client = Readiness::Zendesk::OAuthClients.find_by_name(client, 'Test App')
+      #   new_token = Readiness::Zendesk::OAuthTokens.new
+      #   new_token.client_id = oauth_client.id
+      #   new_token.scopes = [
+      #     'impersonate',
+      #     'write'
+      #   ]
+      #   oauth_token = Readiness::Zendesk::OAuthTokens.create!(client, new_token)
+      #   user_client = Faraday.new(client.url) do |c|
+      #     c.request :retry, {
+      #       max: client.retry_max,
+      #       interval: sb_zendesk_config.retry_interval,
+      #       interval_randomness: client.retry_randomness,
+      #       backoff_factor: client.retry_backoff,
+      #       exceptions: client.retry_exceptions
+      #     }
+      #     c.adapter Faraday.default_adapter
+      #     c.headers['Content-Type'] = 'application/json'
+      #     c.headers['Authorization'] = "Bearer #{oauth_token.full_token}"
+      #     c.headers['X-On-Behalf-Of'] = user.email
+      #   end
+      #   rating = Readiness::Zendesk::Tickets.create_satisfaction_score!(user_client, ticket, 'good', 'jason is awesome!')
+      #   pp rating['score']
+      #   # => "good"
+      def self.create_satisfaction_score!(client, ticket, score, comment)
+        data = { satisfaction_rating: { score: score, comment: comment }}.to_json
+        response = client.post "tickets/#{ticket.id}/satisfaction_rating", data
+        pp response.body
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Add satisfaction rating', message: Oj.load(response.body)}) unless response.status == 200
+        Oj.load(response.body)['satisfaction_rating']
+      end
     end
   end
 end

data/lib/support_readiness/zendesk.rb

@@ -21,6 +21,8 @@ module Readiness
     require "#{__dir__}/zendesk/job_statuses"
     require "#{__dir__}/zendesk/locales"
     require "#{__dir__}/zendesk/macros"
+    require "#{__dir__}/zendesk/oauth_clients"
+    require "#{__dir__}/zendesk/oauth_tokens"
     require "#{__dir__}/zendesk/organization_fields"
     require "#{__dir__}/zendesk/organization_memberships"
     require "#{__dir__}/zendesk/organizations"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.124
+  version: 1.0.125
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-02-20 00:00:00.000000000 Z
+date: 2025-02-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -418,6 +418,8 @@ files:
 - lib/support_readiness/zendesk/job_statuses.rb
 - lib/support_readiness/zendesk/locales.rb
 - lib/support_readiness/zendesk/macros.rb
+- lib/support_readiness/zendesk/oauth_clients.rb
+- lib/support_readiness/zendesk/oauth_tokens.rb
 - lib/support_readiness/zendesk/organization_fields.rb
 - lib/support_readiness/zendesk/organization_memberships.rb
 - lib/support_readiness/zendesk/organizations.rb