1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
|
# frozen_string_literal: true
require "signet/oauth_2/client"
# Copyright 2025 Google LLC
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
module Google
module Auth
##
# Error mixin module for Google Auth errors
# All Google Auth errors should include this module
#
module Error; end
##
# Mixin module that contains detailed error information
# typically this is available if credentials initialization
# succeeds and credentials object is valid
#
module DetailedError
include Error
# The type of the credentials that the error was originated from
# @return [String, nil] The class name of the credential that raised the error
attr_reader :credential_type_name
# The principal for the authentication flow. Typically obtained from credentials
# @return [String, Symbol, nil] The principal identifier associated with the credentials
attr_reader :principal
# All details passed in the options hash when creating the error
# @return [Hash] Additional details about the error
attr_reader :details
# @private
def self.included base
base.extend ClassMethods
end
# Class methods to be added to including classes
module ClassMethods
# Creates a new error with detailed information
# @param message [String] The error message
# @param credential_type_name [String] The credential type that raised the error
# @param principal [String, Symbol] The principal for the authentication flow
# @return [Error] The new error with details
def with_details message, credential_type_name:, principal:
new(message).tap do |error|
error.instance_variable_set :@credential_type_name, credential_type_name
error.instance_variable_set :@principal, principal
end
end
end
end
##
# Error raised during Credentials initialization.
# All new code should use this instead of ArgumentError during initializtion.
#
class InitializationError < StandardError
include Error
end
##
# Generic error raised during operation of Credentials
# This should be used for all purposes not covered by other errors.
#
class CredentialsError < StandardError
include DetailedError
end
##
# An error indicating the remote server refused to authorize the client.
# Maintains backward compatibility with Signet.
#
# Should not be used in the new code, even when wrapping `Signet::AuthorizationError`.
# New code should use CredentialsError instead.
#
class AuthorizationError < Signet::AuthorizationError
include DetailedError
end
##
# An error indicating that the server sent an unexpected http status.
# Maintains backward compatibility with Signet.
#
# Should not be used in the new code, even when wrapping `Signet::UnexpectedStatusError`.
# New code should use CredentialsError instead.
#
class UnexpectedStatusError < Signet::UnexpectedStatusError
include DetailedError
end
##
# An error indicating the client failed to parse a value.
# Maintains backward compatibility with Signet.
#
# Should not be used in the new code, even when wrapping `Signet::ParseError`.
# New code should use CredentialsError instead.
#
class ParseError < Signet::ParseError
include DetailedError
end
end
end
|
