gitlab_support_readiness 1.0.130 → 1.0.132

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0102aacc88b5b814217895ec69e839a573c84055d0b786e1116a053895989a92
-  data.tar.gz: 40d8aa364040549bce14ee3bcd3e5c61889fd68ade93e5fc5ceda6fb73cf1fed
+  metadata.gz: 7aefa86729b110948e278e94a4d413fe3ba5bda9093acc857c113fe2bd8aa793
+  data.tar.gz: 72651512ad7e1774e9545480b1643750d205662decda5cadb6269868647974ad
 SHA512:
-  metadata.gz: af924cefa67d6300b81fb1d8052f4db5e084d25dbe86cd1e8e953654b25d483bb6ae2e8eddb5cc59a750d3df82d55647f5c9de831fbe6eab4eb064d7110706e3
-  data.tar.gz: 0af864729707ae8d02168ae4a6a2c50ce8f311eb997f3068d624b7e56e22d5148147067bd5e940b71a24f66579c0b1e1f8eb6dcc122ea1a784dcb44a976fe0af
+  metadata.gz: fa3c300cf2f5e6118bf9cd18e8d3c3c8017e699da2d3a01767616280a89fa9e2e04aceaa273620f9a993565d6c64bf1fc949223ed7133bb1e8976aa17ba79774
+  data.tar.gz: 0b701da3bf48d539258245893fc4fa6e11eae69cbd8f4337644019fb18037601de6b778b0cde4ac950e21870527f3c0b20fb5ef7f1f0067d5538037f197f7df5

data/lib/support_readiness/support_super_form_processor/sa_request_for_support.rb

@@ -28,8 +28,9 @@ module Readiness
         ticket.requester_id = 379855863520
         ticket.submitter_id = 379855863520
         ticket.comment = { html_body: body }
-        ticket.subject = 'Support Internal Request - SA - Request for Support'
+        ticket.subject = ticket_subject
         ticket.tags = %w[support_internal_request support_valid_request support_ir_sa_request_for_support]
+        ticket.tags.push("support_internal_request_category_#{category}")
         ticket.priority = request_priority
         ticket.status = 'new'
         ticket.ticket_form_id = 12829030177948
@@ -176,6 +177,79 @@ module Readiness
         @collab_project ||= ENV.fetch('INTERNAL_REQUEST_SUPPORT_SA_COLLAB_PROJECT')
       end
 
+      ##
+      # Sets the global variable ticket_subject
+      #
+      # @author Jason Colyer
+      # @since 1.0.131
+      def self.ticket_subject
+        @ticket_subject ||= ENV.fetch('INTERNAL_REQUEST_SUPPORT_SA_SUBJECT', 'Support Internal Request - SA - Request for Support')
+      end
+
+      ##
+      # Sets the global variable issue_description
+      #
+      # @author Jason Colyer
+      # @since 1.0.131
+      def self.issue_description
+        @issue_description ||= ENV.fetch('INTERNAL_REQUEST_SUPPORT_SA_DESCRIPTION')
+      end
+
+      ##
+      # Sets the global variable internal_request_support_sa_context
+      #
+      # @author Jason Colyer
+      # @since 1.0.131
+      def self.context
+        @context ||= ENV.fetch('INTERNAL_REQUEST_SUPPORT_SA_CONTEXT')
+      end
+
+      ##
+      # Sets the global variable replication
+      #
+      # @author Jason Colyer
+      # @since 1.0.131
+      def self.replication
+        @replication ||= ENV.fetch('INTERNAL_REQUEST_SUPPORT_SA_REPLICATION', '')
+      end
+
+      ##
+      # Sets the global variable arr_at_risk
+      #
+      # @author Jason Colyer
+      # @since 1.0.131
+      def self.arr_at_risk
+        @arr_at_risk ||= ENV.fetch('INTERNAL_REQUEST_SUPPORT_SA_ARR', '0')
+      end
+
+      ##
+      # Sets the global variable category
+      #
+      # @author Jason Colyer
+      # @since 1.0.131
+      def self.category
+        @category ||= ENV.fetch('INTERNAL_REQUEST_SUPPORT_SA_CATEGORY', 'other')
+      end
+
+      ## Determines category value from global variable
+      #
+      #@author Jason Colyer
+      # @since 1.0.131
+      def self.category_value
+        case category
+        when 'lnr'
+          'L&R (License & Registration)'
+        when 'com'
+          'GitLab.com'
+        when 'sm'
+          'Self-Managed'
+        when 'dedicated'
+          'GitLab Dedicated'
+        else
+          'Unknown'
+        end
+      end
+
       ##
       # Return the ticket body
       #
@@ -202,6 +276,8 @@ module Readiness
             <li>#{Readiness::SupportSuperFormProcessor::Shared.sfdc_account_string(sfdc_account)}</li>
             <li>#{Readiness::SupportSuperFormProcessor::Shared.sfdc_opportunity_string(sfdc_opportunity)}</li>
             <li>#{collab_project.empty? ? 'No collaboration project project' : "<a href='#{collab_project}' target='_blank'>Collaboration Project</a>"}</li>
+            <li>ARR at risk: $#{sprintf("%.2f", arr_at_risk.to_f)}</li>
+            <li>Request category: #{category_value}</li>
           </ul>
           <p>
             What is expected from Support?
@@ -209,6 +285,24 @@ module Readiness
           <pre>
             #{expectations}
           </pre>
+          <p>
+            Issue description
+          </p>
+          <pre>
+            #{issue_description}
+          </pre>
+          <p>
+            Context/resources
+          </p>
+          <pre>
+            #{context}
+          </pre>
+          <p>
+            Replication information
+          </p>
+          <pre>
+            #{replication}
+          </pre>
         STRING
       end
     end

data/lib/support_readiness/zendesk/oauth_tokens.rb

@@ -9,9 +9,6 @@ module Readiness
     #
     # @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
 
@@ -37,7 +34,92 @@ module Readiness
         @used_at = object['used_at']
         @user_id = object['user_id']
       end
-      
+
+      ##
+      # Lists all OAuth tokens.
+      #
+      # @author Jason Colyer
+      # @since 1.0.132
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @return [Array]
+      # @see https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/#list-tokens Zendesk API > OAuth Tokens > List Tokens
+      # @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_tokens = Readiness::Zendesk::OAuthTokens.list(client)
+      #   pp oauth_tokens.count
+      #   # => 24
+      def self.list(client)
+        array = []
+        opts = 'page[size]=100'
+        loop do
+          response = client.connection.get("oauth/tokens?#{opts}")
+          handle_request_error(0, 'Zendesk', response.status) unless response.status == 200
+          body = Oj.load(response.body)
+          array += body['tokens'].map { |t| OAuthTokens.new(t) }
+          break unless body['meta']['has_more']
+
+          opts = body['links']['next'].split('?').last
+        end
+        array
+      end
+
+      ##
+      # Locates an OAuth token within Zendesk. This will not exit on error (except Authentication errors)
+      #
+      # @author Jason Colyer
+      # @since 1.0.132
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param tid [Integer[ The OAuth token ID to find
+      # @param return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/#show-token Zendesk API > OAuth Tokens > Show 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)
+      #   oauth_token = Readiness::Zendesk::OAuthTokens.find(client, 223443)
+      #   pp oauth_token.client_id
+      #   # => 1234
+      def self.find(client, tid)
+        response = client.connection.get("oauth/tokens/#{tid}")
+        handle_request_error(0, 'Zendesk', response.status,  { action: 'get', id: cid }) unless response.status == 200
+        return OAuthTokens.new(Oj.load(response.body)['token']) if response.status == 200
+
+        Oj.load(response.body)
+      end
+
+      ##
+      # Locates an OAuth token within Zendesk. This will exit on error
+      #
+      # @author Jason Colyer
+      # @since 1.0.132
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param tid [Integer[ The OAuth token ID to find
+      # @param return [Hash]
+      # @see https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/#show-token Zendesk API > OAuth Tokens > Show 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)
+      #   oauth_token = Readiness::Zendesk::OAuthTokens.find!(client, 223443)
+      #   pp oauth_token.client_id
+      #   # => 1234
+      def self.find!(client, tid)
+        response = client.connection.get("oauth/tokens/#{tid}")
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Find OAuth token', id: tid }) unless response.status == 200
+        OAuthTokens.new(Oj.load(response.body)['token'])
+      end
+
       ##
       # Creates an Oauth token. Will exit if unsuccessful.
       #
@@ -65,9 +147,35 @@ module Readiness
       #   # => "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'])
+        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
+
+      ##
+      # Revkokes an OAuth token. Will exit if unsuccessful
+      #
+      # @author Jason Colyer
+      # @since 1.0.132
+      # @param client [Object] An instance of {Readiness::Zendesk::Client}
+      # @param token [Object] An instance of {Readiness::Zendesk::OAuthTokens}
+      # @return [Boolean]
+      # @see https://developer.zendesk.com/api-reference/ticketing/oauth/oauth_tokens/#revoke-token Zendesk API > OAuth Tokens > Revoke 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)
+      #   oauth_token = Readiness::Zendesk::OAuthTokens.find!(client, 223443)
+      #   revoke = Readiness::Zendesk::OAuthTokens.revoke!(client, oauth_token)
+      #   pp revoke
+      #   # => true
+      def self.revoke!(client, token)
+        response = client.connection.delete "oauth/tokens/#{token.id}"
+        handle_request_error(1, 'Zendesk', response.status, { action: 'Revoke a token', id: token.id, message: Oj.load(response.body)}) unless response.status == 204
+        true
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.130
+  version: 1.0.132
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-03-10 00:00:00.000000000 Z
+date: 2025-04-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport