gitlab_support_readiness 1.0.131 → 1.0.132

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 735921b71920c43c43ac6c5d8d4bf1b4969b0cc42b9f127f0ed679ca94f7ac83
-  data.tar.gz: faabddbb97e01e10ababbb5cbbbc2188857af4d899bbaa22a29d939465345efd
+  metadata.gz: 7aefa86729b110948e278e94a4d413fe3ba5bda9093acc857c113fe2bd8aa793
+  data.tar.gz: 72651512ad7e1774e9545480b1643750d205662decda5cadb6269868647974ad
 SHA512:
-  metadata.gz: 94e652623f6b39d4da4b1ceccf6279d8ddeb480609251cf99369f34798b49d85f068a59ad57aeae71b9903718c4b5eb7b49b04aed761c83bcddcde6eedf3f988
-  data.tar.gz: 436b8d4cec96ccb6b7d7589c36793302f56842ee3d84904ee3f0831d8e87d3c993833e501adf45472516beecb800f5fa54f61be7fb46ed4faa7166db9d0336a6
+  metadata.gz: fa3c300cf2f5e6118bf9cd18e8d3c3c8017e699da2d3a01767616280a89fa9e2e04aceaa273620f9a993565d6c64bf1fc949223ed7133bb1e8976aa17ba79774
+  data.tar.gz: 0b701da3bf48d539258245893fc4fa6e11eae69cbd8f4337644019fb18037601de6b778b0cde4ac950e21870527f3c0b20fb5ef7f1f0067d5538037f197f7df5

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,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_support_readiness
 version: !ruby/object:Gem::Version
-  version: 1.0.131
+  version: 1.0.132
 platform: ruby
 authors:
 - Jason Colyer