google-cloud-api_gateway 1.3.0 → 1.5.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: f8106000ff47b182ded09df384710abb040553c19efff6632aae38f2fdc33b4b
4
- data.tar.gz: 3f22ea6a4c1a95c60a925ca3e94d1785471635de36ea116c5081c80228936e16
3
+ metadata.gz: aab47c178a0b441f9955f578354f1eda69e43243561031bfb2e2917b772df011
4
+ data.tar.gz: 1376cefb107bba806927579ceb1c8687e3b451de62823578615c26e4197e9dff
5
5
  SHA512:
6
- metadata.gz: 67d104afe0df0181db5f75d334f89a630a4b806e5705b0f90d934fe070590d4bea7252961946fbb0d593ef724c0c6211b8e3c3a6da724ed1b00d7b373605b3a6
7
- data.tar.gz: 73f3022b13836576b5f7636cd0a8b7752b28f6e19f775d41fdb2ae2dbaeee3da855a99d05297d558bac2746d5c0f0ce85bae5707630ec8e1b7b60540ddd66576
6
+ metadata.gz: 56bc8352fa863ce0223577071c9809674395c10e7212dabfd41d63702d02e19c7f5111cca74954aca6039a87afae7d349b3dde80989f3db29fb9ac22e5ab12ac
7
+ data.tar.gz: 0f8c6bed4d7593783c68ebd913f5c920100b199634854acd3eda5341be8430fc8c6f4626cf0f2ba8f54c896706a42e03aad88f0dc691b6de70caed6a88ee916f
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/apigateway.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-api_gateway-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-api_gateway-v1/latest).
66
+
37
67
  ## Supported Ruby Versions
38
68
 
39
- This library is supported on Ruby 2.6+.
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 ApiGateway
23
- VERSION = "1.3.0"
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 ApiGatewayService service.
63
+ # You can determine whether the method will succeed by calling
64
+ # {Google::Cloud::ApiGateway.api_gateway_service_available?}.
65
+ #
61
66
  # ## About ApiGatewayService
62
67
  #
63
68
  # The API Gateway Service is the interface for managing API Gateways.
@@ -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 ApiGatewayService service is supported by the current client.
89
+ # If true, you can retrieve a client object by calling {Google::Cloud::ApiGateway.api_gateway_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 ApiGatewayService service,
92
+ # or if the versioned client gem needs an update to support the ApiGatewayService 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.api_gateway_service_available? version: :v1, transport: :grpc
100
+ require "google/cloud/api_gateway/#{version.to_s.downcase}"
101
+ package_name = Google::Cloud::ApiGateway
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::ApiGateway.const_get package_name
107
+ return false unless service_module.const_defined? :ApiGatewayService
108
+ service_module = service_module.const_get :ApiGatewayService
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
  # Configure the google-cloud-api_gateway library.
84
120
  #
metadata CHANGED
@@ -1,14 +1,13 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-api_gateway
3
3
  version: !ruby/object:Gem::Version
4
- version: 1.3.0
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-01-15 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-api_gateway-v1
@@ -44,118 +43,6 @@ dependencies:
44
43
  - - "~>"
45
44
  - !ruby/object:Gem::Version
46
45
  version: '1.6'
47
- - !ruby/object:Gem::Dependency
48
- name: google-style
49
- requirement: !ruby/object:Gem::Requirement
50
- requirements:
51
- - - "~>"
52
- - !ruby/object:Gem::Version
53
- version: 1.26.1
54
- type: :development
55
- prerelease: false
56
- version_requirements: !ruby/object:Gem::Requirement
57
- requirements:
58
- - - "~>"
59
- - !ruby/object:Gem::Version
60
- version: 1.26.1
61
- - !ruby/object:Gem::Dependency
62
- name: minitest
63
- requirement: !ruby/object:Gem::Requirement
64
- requirements:
65
- - - "~>"
66
- - !ruby/object:Gem::Version
67
- version: '5.16'
68
- type: :development
69
- prerelease: false
70
- version_requirements: !ruby/object:Gem::Requirement
71
- requirements:
72
- - - "~>"
73
- - !ruby/object:Gem::Version
74
- version: '5.16'
75
- - !ruby/object:Gem::Dependency
76
- name: minitest-focus
77
- requirement: !ruby/object:Gem::Requirement
78
- requirements:
79
- - - "~>"
80
- - !ruby/object:Gem::Version
81
- version: '1.1'
82
- type: :development
83
- prerelease: false
84
- version_requirements: !ruby/object:Gem::Requirement
85
- requirements:
86
- - - "~>"
87
- - !ruby/object:Gem::Version
88
- version: '1.1'
89
- - !ruby/object:Gem::Dependency
90
- name: minitest-rg
91
- requirement: !ruby/object:Gem::Requirement
92
- requirements:
93
- - - "~>"
94
- - !ruby/object:Gem::Version
95
- version: '5.2'
96
- type: :development
97
- prerelease: false
98
- version_requirements: !ruby/object:Gem::Requirement
99
- requirements:
100
- - - "~>"
101
- - !ruby/object:Gem::Version
102
- version: '5.2'
103
- - !ruby/object:Gem::Dependency
104
- name: rake
105
- requirement: !ruby/object:Gem::Requirement
106
- requirements:
107
- - - ">="
108
- - !ruby/object:Gem::Version
109
- version: '13.0'
110
- type: :development
111
- prerelease: false
112
- version_requirements: !ruby/object:Gem::Requirement
113
- requirements:
114
- - - ">="
115
- - !ruby/object:Gem::Version
116
- version: '13.0'
117
- - !ruby/object:Gem::Dependency
118
- name: redcarpet
119
- requirement: !ruby/object:Gem::Requirement
120
- requirements:
121
- - - "~>"
122
- - !ruby/object:Gem::Version
123
- version: '3.0'
124
- type: :development
125
- prerelease: false
126
- version_requirements: !ruby/object:Gem::Requirement
127
- requirements:
128
- - - "~>"
129
- - !ruby/object:Gem::Version
130
- version: '3.0'
131
- - !ruby/object:Gem::Dependency
132
- name: simplecov
133
- requirement: !ruby/object:Gem::Requirement
134
- requirements:
135
- - - "~>"
136
- - !ruby/object:Gem::Version
137
- version: '0.9'
138
- type: :development
139
- prerelease: false
140
- version_requirements: !ruby/object:Gem::Requirement
141
- requirements:
142
- - - "~>"
143
- - !ruby/object:Gem::Version
144
- version: '0.9'
145
- - !ruby/object:Gem::Dependency
146
- name: yard
147
- requirement: !ruby/object:Gem::Requirement
148
- requirements:
149
- - - "~>"
150
- - !ruby/object:Gem::Version
151
- version: '0.9'
152
- type: :development
153
- prerelease: false
154
- version_requirements: !ruby/object:Gem::Requirement
155
- requirements:
156
- - - "~>"
157
- - !ruby/object:Gem::Version
158
- version: '0.9'
159
46
  description: API Gateway enables you to provide secure access to your backend services
160
47
  through a well-defined REST API that is consistent across all of your services,
161
48
  regardless of the service implementation. Clients consume your REST APIS to implement
@@ -177,7 +64,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
177
64
  licenses:
178
65
  - Apache-2.0
179
66
  metadata: {}
180
- post_install_message:
181
67
  rdoc_options: []
182
68
  require_paths:
183
69
  - lib
@@ -185,15 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
185
71
  requirements:
186
72
  - - ">="
187
73
  - !ruby/object:Gem::Version
188
- version: '2.6'
74
+ version: '3.0'
189
75
  required_rubygems_version: !ruby/object:Gem::Requirement
190
76
  requirements:
191
77
  - - ">="
192
78
  - !ruby/object:Gem::Version
193
79
  version: '0'
194
80
  requirements: []
195
- rubygems_version: 3.5.3
196
- signing_key:
81
+ rubygems_version: 3.6.2
197
82
  specification_version: 4
198
83
  summary: API Client library for the API Gateway API
199
84
  test_files: []