gitlab_support_readiness 1.0.131 → 1.0.133

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 735921b71920c43c43ac6c5d8d4bf1b4969b0cc42b9f127f0ed679ca94f7ac83
-  data.tar.gz: faabddbb97e01e10ababbb5cbbbc2188857af4d899bbaa22a29d939465345efd
+  metadata.gz: 5725d3ed4f90dc1debc220178b5c2e0c68204f3ddb556ad55142adaed95d1d40
+  data.tar.gz: da9a6c914594b3fb6e6df9e21c9e2f69fc6ecaef17f63549a3d0446cecd6c7d3
 SHA512:
-  metadata.gz: 94e652623f6b39d4da4b1ceccf6279d8ddeb480609251cf99369f34798b49d85f068a59ad57aeae71b9903718c4b5eb7b49b04aed761c83bcddcde6eedf3f988
-  data.tar.gz: 436b8d4cec96ccb6b7d7589c36793302f56842ee3d84904ee3f0831d8e87d3c993833e501adf45472516beecb800f5fa54f61be7fb46ed4faa7166db9d0336a6
+  metadata.gz: '08c623cb5a466a6f295232558a203a977533341cb3737513fbfb0380a61bf5dae091cc66a5fcb2d08400f53b728805a99bc3428d4a2963dba51584201926ab48'
+  data.tar.gz: a545b7f85e65b48e57fee31825dc54a8ca9abd478154d501d899eae7f0790648d3719408b1e0d1bae5a278401f7ca00e310ec104e9be41a236b5a69c9ca65525

data/lib/support_readiness/support_super_form_processor/create_article.rb

@@ -245,7 +245,7 @@ module Readiness
       # @author Jason Colyer
       # @since 1.0.42
       def self.project
-        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 68534119)
       end
 
       ##
@@ -321,9 +321,7 @@ module Readiness
 
           This process should be completely automated. If you see any issues, please rectify them and notify Jason so the processor can be looked into.
 
-          /label ~"Readiness Priority::Current Quarter"
-
-          /label ~"Readiness::Completed"
+          /label ~"administrative" ~"Stage::Completed" ~zendesk ~"Customer::Support" ~"p4"
 
           /assign @jcolyer @dtragjasi
         STRING
@@ -342,8 +340,6 @@ module Readiness
 
           If you see any issues, please reopen this issue and post in the support operations channel in Slack.
 
-          /label ~"Readiness::Completed"
-
           /close
         STRING
       end

data/lib/support_readiness/support_super_form_processor/create_macro.rb

@@ -74,7 +74,7 @@ module Readiness
 
           If you have any problems, please reopen this issue and ping the Support Readiness team for assistance.
 
-          /label ~"Readiness::Completed"
+          /label ~"Stage::Completed"
 
           /close
         STRING
@@ -197,7 +197,7 @@ module Readiness
       # @author Jason Colyer
       # @since 1.0.42
       def self.project
-        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 68534119)
       end
 
       ##
@@ -289,9 +289,7 @@ module Readiness
 
           ```
 
-          /label ~"Readiness Priority::Current Quarter"
-
-          /label ~"Readiness::Triage"
+          /label ~"Stage::Development" ~administrative ~p4 ~"Customer::Support" ~zendesk
 
           /assign #{issue_assignees}
         STRING

data/lib/support_readiness/support_super_form_processor/disable_us_government.rb

@@ -34,6 +34,15 @@ module Readiness
         exit 0
       end
 
+      ##
+      # Sets the global variable project
+      #
+      # @author Jason Colyer
+      # @since 1.0.133
+      def self.project
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 68534119)
+      end      
+
       ##
       # Peform validity checks for this request
       #
@@ -168,7 +177,7 @@ module Readiness
 
           /assign @#{requester.username} @jcolyer @secole @lyle
 
-          /label ~"Readiness::Triage" "Readiness::Current Quarter"
+          /label ~"Stage::Development" ~p4 ~zendesk ~administrative ~"Customer::Field"
 
           cc @leeeee-gtlb
         STRING

data/lib/support_readiness/support_super_form_processor/edit_macro.rb

@@ -80,7 +80,7 @@ module Readiness
       # @author Jason Colyer
       # @since 1.0.42
       def self.project
-        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 68534119)
       end
 
       ##
@@ -150,9 +150,7 @@ module Readiness
 
           ```
 
-          /label ~"Readiness Priority::Current Quarter"
-
-          /label ~"Readiness::Triage"
+          /label ~"Stage::Development" ~zendesk ~"Customer::Support" ~p4 ~administrative
 
           /assign #{issue_assignees}
         STRING

data/lib/support_readiness/support_super_form_processor/enable_us_government.rb

@@ -34,6 +34,15 @@ module Readiness
         exit 0
       end
 
+      ##
+      # Sets the global variable project
+      #
+      # @author Jason Colyer
+      # @since 1.0.133
+      def self.project
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 68534119)
+      end
+      
       ##
       # Peform validity checks for this request
       #
@@ -231,7 +240,7 @@ module Readiness
 
           /assign @#{requester.username} @jcolyer @secole @lyle
 
-          /label ~"Readiness::Triage" "Readiness::Current Quarter"
+          /label ~"Stage::Development" ~p4 ~zendesk ~administrative ~"Customer::Field"
 
           cc @jscarborough @leeeee-gtlb
         STRING

data/lib/support_readiness/support_super_form_processor/global_set_collaboration_id.rb

@@ -73,7 +73,7 @@ module Readiness
       # @author Jason Colyer
       # @since 1.0.42
       def self.project
-        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 68534119)
       end
 
       ##
@@ -116,7 +116,7 @@ module Readiness
 
           We have set the collaboration project ID of the Zendesk Global organization to that of #{collaboration_project_id} at this time.
 
-          /label ~"AutomatedRequests::Set Org Collab ID"
+          /label ~"AutomatedRequests::Set Org Collab ID" ~zendesk ~administrative ~"Stage::Completed" ~p4
 
           /assign @#{requester.username}
         STRING
@@ -139,9 +139,7 @@ module Readiness
 
           If you need assistance in locating the organization's ID, please ask in the Slack channel [#support_operations](https://gitlab.slack.com/archives/C018ZGZAMPD)
 
-          /label ~"AutomatedRequests::Invalid Organization"
-
-          /label ~"Invalid Zendesk Global organization given"
+          /label ~"AutomatedRequests::Invalid Organization" ~zendesk ~administrative ~"Stage::Blocked" ~p4
 
           /assign @#{requester.username}
         STRING

data/lib/support_readiness/support_super_form_processor/global_set_org_ase.rb

@@ -156,7 +156,7 @@ module Readiness
       # @author Jason Colyer
       # @since 1.0.42
       def self.project
-        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 68534119)
       end
 
       ##
@@ -212,7 +212,7 @@ module Readiness
 
           If you need assistance in locating the agent's ID, please ask in the Slack channel [#support_operations](https://gitlab.slack.com/archives/C018ZGZAMPD)
 
-          /label ~"AutomatedRequests::Set Org ASE"
+          /label ~"AutomatedRequests::Set Org ASE" ~"Stage::Completed" ~administrative ~p4 ~zendesk ~"Customer::Support"
 
           /assign @#{requester.username}
         STRING
@@ -235,9 +235,7 @@ module Readiness
 
           If you need assistance in locating the organization's ID, please ask in the Slack channel [#support_operations](https://gitlab.slack.com/archives/C018ZGZAMPD)
 
-          /label ~"AutomatedRequests::Invalid Organization"
-
-          /label ~"Invalid Zendesk Global organization given"
+          /label ~"AutomatedRequests::Invalid Organization" ~"Stage::Blocked" ~administrative ~p4 ~zendesk ~"Customer::Support"
 
           /assign @#{requester.username}
         STRING
@@ -255,7 +253,7 @@ module Readiness
 
           #{approved_requester_list.map { |a| "- #{a['email']}" }.join("\n")}
 
-          /label ~"AutomatedRequests::Invalid Permissions"
+          /label ~"AutomatedRequests::Invalid Permissions" ~"Stage::Blocked" ~administrative ~p4 ~zendesk ~"Customer::Support"
 
           /assign @#{requester.username}
         STRING
@@ -283,7 +281,7 @@ module Readiness
 
           If you need assistance in locating the agent's ID, please ask in the Slack channel [#support_operations](https://gitlab.slack.com/archives/C018ZGZAMPD)
 
-          /label ~"AutomatedRequests::Set Org ASE" ~"SupportOps::Blocked"
+          /label ~"AutomatedRequests::Set Org ASE" ~"Stage::Blocked" ~administrative ~p4 ~zendesk ~"Customer::Support"
 
           /assign @#{requester.username}
         STRING

data/lib/support_readiness/support_super_form_processor/namespace_availability.rb

@@ -96,7 +96,7 @@ module Readiness
       # @author Jason Colyer
       # @since 1.0.42
       def self.project
-        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 68534119)
       end
 
       ##
@@ -163,7 +163,7 @@ module Readiness
 
           We have looked into the availability of the namespace #{CGI.escape(namespace_to_check)} and have determined it will not be available for release at this time.
 
-          /label ~"AutomatedRequests::Namespace Availability Check"
+          /label ~"AutomatedRequests::Namespace Availability Check" ~p4 ~administrative ~"Stage::Completed"
 
           /assign @#{requester.username} 
         STRING
@@ -182,7 +182,7 @@ module Readiness
 
           We have looked into the availability of the namespace #{CGI.escape(namespace_to_check)} and have been unable to locate the namespace on gitlab.com. This would mean it is not currently in use at all and should be available at this exact moment in time.
 
-          /label ~"AutomatedRequests::Namespace Availability Check"
+          /label ~"AutomatedRequests::Namespace Availability Check" ~p4 ~administrative ~"Stage::Completed"
 
           /assign @#{requester.username} 
         STRING
@@ -203,7 +203,7 @@ module Readiness
 
           Please note this only reflects the _possibility_ of release _at this exact time_. Any number of factors or events could change in the future to change this determination.
 
-          /label ~"AutomatedRequests::Namespace Availability Check"
+          /label ~"AutomatedRequests::Namespace Availability Check" ~p4 ~administrative ~"Stage::Completed"
 
           /assign @#{requester.username} 
         STRING

data/lib/support_readiness/support_super_form_processor/team_member_license.rb

@@ -79,7 +79,7 @@ module Readiness
       # @author Jason Colyer
       # @since 1.0.42
       def self.project
-        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 68534119)
       end
 
       ##
@@ -156,7 +156,7 @@ module Readiness
 
           ### Support Operations
 
-          * [ ] Follow the directions of the workflow, which can be found [here](https://handbook.gitlab.com/handbook/support/readiness/operations/docs/policies/team_member_licenses/)
+          * [ ] Follow the directions of the workflow, which can be found [here](https://handbook.gitlab.com/handbook/security/customer-support-operations/docs/team_member_licenses/)
 
           ---
 
@@ -164,7 +164,7 @@ module Readiness
 
           /assign @nabeel.bilgrami @avilla4 @secole @rverschoor
 
-          /label ~"Internal-License" ~"Readiness::Triage" ~"Readiness Priority::Current Quarter"
+          /label ~"Stage::Development" ~administrative ~p4
         STRING
       end
     end

data/lib/support_readiness/support_super_form_processor/usgov_set_collaboration_id.rb

@@ -73,7 +73,7 @@ module Readiness
       # @author Jason Colyer
       # @since 1.0.42
       def self.project
-        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 68534119)
       end
 
       ##
@@ -116,7 +116,7 @@ module Readiness
 
           We have set the collaboration project ID of the Zendesk US Government organization to that of #{collaboriation_project_id} at this time.
 
-          /label ~"AutomatedRequests::Set Org Collab ID"
+          /label ~"AutomatedRequests::Set Org Collab ID" ~"Stage::Completed" ~administrative ~p4 ~zendesk
 
           /assign @#{requester.username}
         STRING
@@ -139,9 +139,7 @@ module Readiness
 
           If you need assistance in locating the organization's ID, please ask in the Slack channel [#support_operations](https://gitlab.slack.com/archives/C018ZGZAMPD)
 
-          /label ~"AutomatedRequests::Invalid Organization"
-
-          /label ~"Invalid Zendesk US Government organization given"
+          /label ~"AutomatedRequests::Invalid Organization" ~"Stage::Blocked" ~administrative ~p4 ~zendesk
 
           /assign @#{requester.username}
         STRING

data/lib/support_readiness/support_super_form_processor/usgov_set_org_ase.rb

@@ -158,7 +158,7 @@ module Readiness
       # @author Jason Colyer
       # @since 1.0.42
       def self.project
-        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 12811526)
+        @project ||= Readiness::GitLab::Projects.find!(@gitlab_client, 68534119)
       end
 
       ##
@@ -214,7 +214,7 @@ module Readiness
 
           If you need assistance in locating the agent's ID, please ask in the Slack channel [#support_operations](https://gitlab.slack.com/archives/C018ZGZAMPD)
 
-          /label ~"AutomatedRequests::Set Org ASE"
+          /label ~"AutomatedRequests::Set Org ASE" ~"Stage::Completed" ~administrative ~p4 ~zendesk ~"Customer::Support"
 
           /assign @#{requester.username}
         STRING
@@ -237,9 +237,7 @@ module Readiness
 
           If you need assistance in locating the organization's ID, please ask in the Slack channel [#support_operations](https://gitlab.slack.com/archives/C018ZGZAMPD)
 
-          /label ~"AutomatedRequests::Invalid Organization"
-
-          /label ~"Invalid Zendesk US Goverment organization given"
+          /label ~"AutomatedRequests::Invalid Organization" ~"Stage::Blocked" ~administrative ~p4 ~zendesk ~"Customer::Support"
 
           /assign @#{requester.username}
         STRING
@@ -257,7 +255,7 @@ module Readiness
 
           #{approved_requester_list.map { |a| "- #{a['email']}" }.join("\n")}
 
-          /label ~"AutomatedRequests::Invalid Permissions"
+          /label ~"AutomatedRequests::Invalid Permissions" ~"Stage::Blocked" ~administrative ~p4 ~zendesk ~"Customer::Support"
 
           /assign @#{requester.username}
         STRING
@@ -285,7 +283,7 @@ module Readiness
 
           If you need assistance in locating the agent's ID, please ask in the Slack channel [#support_operations](https://gitlab.slack.com/archives/C018ZGZAMPD)
 
-          /label ~"AutomatedRequests::Set Org ASE" ~"SupportOps::Blocked"
+          /label ~"AutomatedRequests::Set Org ASE" ~"Stage::Blocked" ~administrative ~p4 ~zendesk ~"Customer::Support"
 
           /assign @#{requester.username}
         STRING

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.131
+  version: 1.0.133
 platform: ruby
 authors:
 - Jason Colyer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2025-04-01 00:00:00.000000000 Z
+date: 2025-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport