google-cloud-iap 1.4.1 → 1.5.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f348c104f35f573d96888988288fd69884611e0a50cde8b30b1ce78795ee240d
4
- data.tar.gz: 97fa468fb2258281f90a618833ce6f309c8628ba8d543c57ad917f15e065f216
3
+ metadata.gz: 3b0c10f53483d934ecc82ed4ea9c6122f5ec359cfd3dd4f508ca0829cea858c4
4
+ data.tar.gz: a6588f80dbb5b3940b1ac6475ea5231a3ba14ca82ce6ecec3c8e8ab3cf9e1279
5
5
  SHA512:
6
- metadata.gz: adcec21bf6cb97a10be4400ae96f08e947216dfe93e0f381020878bb1929a3a9ef0e3a1342117749056a50c4745b7a8c2ae6d30866522f2ee525f145ce67cb4b
7
- data.tar.gz: 5e2a6d30fd3972b728d67d8931700abdd2886ff3ae0837769717ddcb798842e4f4883868a4d7c3c52253ee6ca3a75eac4016096b9d3c4f33fcc9ed3dd04998ca
6
+ metadata.gz: 20a608ad60c6489bd9864396a0ad33bdd2ec6b44bed9035cccca903fad896388a57dc49d6a176c738cc45e2013509c39c3aadad5fe05f09c3c979c93e1532e18
7
+ data.tar.gz: f006491e0c233ffd6762bef41592998fc2890c97fa9213b5194cacfb54509f7d84f92851df0ee99f8d95d6e94709d3be23dcd4b8b146524c005f17681bc36e74
data/README.md CHANGED
@@ -34,9 +34,39 @@ In order to use this library, you first need to go through the following steps:
34
34
  1. [Enable the API.](https://console.cloud.google.com/apis/library/iap.googleapis.com)
35
35
  1. {file:AUTHENTICATION.md Set up authentication.}
36
36
 
37
+ ## Debug Logging
38
+
39
+ This library comes with opt-in Debug Logging that can help you troubleshoot
40
+ your application's integration with the API. When logging is activated, key
41
+ events such as requests and responses, along with data payloads and metadata
42
+ such as headers and client configuration, are logged to the standard error
43
+ stream.
44
+
45
+ **WARNING:** Client Library Debug Logging includes your data payloads in
46
+ plaintext, which could include sensitive data such as PII for yourself or your
47
+ customers, private keys, or other security data that could be compromising if
48
+ leaked. Always practice good data hygiene with your application logs, and follow
49
+ the principle of least access. Google also recommends that Client Library Debug
50
+ Logging be enabled only temporarily during active debugging, and not used
51
+ permanently in production.
52
+
53
+ To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
54
+ to the value `all`. Alternatively, you can set the value to a comma-delimited
55
+ list of client library gem names. This will select the default logging behavior,
56
+ which writes logs to the standard error stream. On a local workstation, this may
57
+ result in logs appearing on the console. When running on a Google Cloud hosting
58
+ service such as [Google Cloud Run](https://cloud.google.com/run), this generally
59
+ results in logs appearing alongside your application logs in the
60
+ [Google Cloud Logging](https://cloud.google.com/logging/) service.
61
+
62
+ Debug logging also requires that the versioned clients for this service be
63
+ sufficiently recent, released after about Dec 10, 2024. If logging is not
64
+ working, try updating the versioned clients in your bundle or installed gems:
65
+ [google-cloud-iap-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-iap-v1/latest).
66
+
37
67
  ## Supported Ruby Versions
38
68
 
39
- This library is supported on Ruby 2.7+.
69
+ This library is supported on Ruby 3.0+.
40
70
 
41
71
  Google provides official support for Ruby versions that are actively supported
42
72
  by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -20,7 +20,7 @@
20
20
  module Google
21
21
  module Cloud
22
22
  module Iap
23
- VERSION = "1.4.1"
23
+ VERSION = "1.5.0"
24
24
  end
25
25
  end
26
26
  end
@@ -58,6 +58,11 @@ module Google
58
58
  # You can also specify a different transport by passing `:rest` or `:grpc` in
59
59
  # the `transport` parameter.
60
60
  #
61
+ # Raises an exception if the currently installed versioned client gem for the
62
+ # given API version does not support the given transport of the IdentityAwareProxyAdminService service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::Iap.identity_aware_proxy_admin_service_available?}.
65
+ #
61
66
  # ## About IdentityAwareProxyAdminService
62
67
  #
63
68
  # APIs for Identity-Aware Proxy Admin configurations.
@@ -79,6 +84,37 @@ module Google
79
84
  service_module.const_get(:Client).new(&block)
80
85
  end
81
86
 
87
+ ##
88
+ # Determines whether the IdentityAwareProxyAdminService service is supported by the current client.
89
+ # If true, you can retrieve a client object by calling {Google::Cloud::Iap.identity_aware_proxy_admin_service}.
90
+ # If false, that method will raise an exception. This could happen if the given
91
+ # API version does not exist or does not support the IdentityAwareProxyAdminService service,
92
+ # or if the versioned client gem needs an update to support the IdentityAwareProxyAdminService service.
93
+ #
94
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
95
+ # Defaults to `:v1`.
96
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
97
+ # @return [boolean] Whether the service is available.
98
+ #
99
+ def self.identity_aware_proxy_admin_service_available? version: :v1, transport: :grpc
100
+ require "google/cloud/iap/#{version.to_s.downcase}"
101
+ package_name = Google::Cloud::Iap
102
+ .constants
103
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
104
+ .first
105
+ return false unless package_name
106
+ service_module = Google::Cloud::Iap.const_get package_name
107
+ return false unless service_module.const_defined? :IdentityAwareProxyAdminService
108
+ service_module = service_module.const_get :IdentityAwareProxyAdminService
109
+ if transport == :rest
110
+ return false unless service_module.const_defined? :Rest
111
+ service_module = service_module.const_get :Rest
112
+ end
113
+ service_module.const_defined? :Client
114
+ rescue ::LoadError
115
+ false
116
+ end
117
+
82
118
  ##
83
119
  # Create a new client object for IdentityAwareProxyOAuthService.
84
120
  #
@@ -92,6 +128,11 @@ module Google
92
128
  # You can also specify a different transport by passing `:rest` or `:grpc` in
93
129
  # the `transport` parameter.
94
130
  #
131
+ # Raises an exception if the currently installed versioned client gem for the
132
+ # given API version does not support the given transport of the IdentityAwareProxyOAuthService service.
133
+ # You can determine whether the method will succeed by calling
134
+ # {Google::Cloud::Iap.identity_aware_proxy_o_auth_service_available?}.
135
+ #
95
136
  # ## About IdentityAwareProxyOAuthService
96
137
  #
97
138
  # API to programmatically create, list and retrieve Identity Aware Proxy (IAP)
@@ -115,6 +156,37 @@ module Google
115
156
  service_module.const_get(:Client).new(&block)
116
157
  end
117
158
 
159
+ ##
160
+ # Determines whether the IdentityAwareProxyOAuthService service is supported by the current client.
161
+ # If true, you can retrieve a client object by calling {Google::Cloud::Iap.identity_aware_proxy_o_auth_service}.
162
+ # If false, that method will raise an exception. This could happen if the given
163
+ # API version does not exist or does not support the IdentityAwareProxyOAuthService service,
164
+ # or if the versioned client gem needs an update to support the IdentityAwareProxyOAuthService service.
165
+ #
166
+ # @param version [::String, ::Symbol] The API version to connect to. Optional.
167
+ # Defaults to `:v1`.
168
+ # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
169
+ # @return [boolean] Whether the service is available.
170
+ #
171
+ def self.identity_aware_proxy_o_auth_service_available? version: :v1, transport: :grpc
172
+ require "google/cloud/iap/#{version.to_s.downcase}"
173
+ package_name = Google::Cloud::Iap
174
+ .constants
175
+ .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
176
+ .first
177
+ return false unless package_name
178
+ service_module = Google::Cloud::Iap.const_get package_name
179
+ return false unless service_module.const_defined? :IdentityAwareProxyOAuthService
180
+ service_module = service_module.const_get :IdentityAwareProxyOAuthService
181
+ if transport == :rest
182
+ return false unless service_module.const_defined? :Rest
183
+ service_module = service_module.const_get :Rest
184
+ end
185
+ service_module.const_defined? :Client
186
+ rescue ::LoadError
187
+ false
188
+ end
189
+
118
190
  ##
119
191
  # Configure the google-cloud-iap library.
120
192
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-iap
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.4.1
4
+ version: 1.5.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
- autorequire:
9
8
  bindir: bin
10
9
  cert_chain: []
11
- date: 2024-08-09 00:00:00.000000000 Z
10
+ date: 2025-01-29 00:00:00.000000000 Z
12
11
  dependencies:
13
12
  - !ruby/object:Gem::Dependency
14
13
  name: google-cloud-core
@@ -63,7 +62,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
63
62
  licenses:
64
63
  - Apache-2.0
65
64
  metadata: {}
66
- post_install_message:
67
65
  rdoc_options: []
68
66
  require_paths:
69
67
  - lib
@@ -71,15 +69,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
71
69
  requirements:
72
70
  - - ">="
73
71
  - !ruby/object:Gem::Version
74
- version: '2.7'
72
+ version: '3.0'
75
73
  required_rubygems_version: !ruby/object:Gem::Requirement
76
74
  requirements:
77
75
  - - ">="
78
76
  - !ruby/object:Gem::Version
79
77
  version: '0'
80
78
  requirements: []
81
- rubygems_version: 3.5.6
82
- signing_key:
79
+ rubygems_version: 3.6.2
83
80
  specification_version: 4
84
81
  summary: API Client library for the Identity-Aware Proxy API
85
82
  test_files: []