google-cloud-gke_connect-gateway 1.1.0 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2dc7fa6f11328119ad1f01bcdbae77d749575c95ddc98a9e1956836e15f0c481
-  data.tar.gz: 88a5ac151595839a6671e7adc39dd936d2938d642820aa12741d310f17212328
+  metadata.gz: 42720d23559ea509477c71e52721045aed1eee0390268c278a0626ac4ebe394b
+  data.tar.gz: '095829014be3c9effd0a79a3c5e5fdfaeb2b04086745502310708ac0077e7d6e'
 SHA512:
-  metadata.gz: df4709afe7a639e205d7633d5fcb332f71caf20019474300a05a663511a2e9bb051d7e24a54a15b6f0ec7cefd4ba53045bf2c2367fca1991a2ac6a8ac898a108
-  data.tar.gz: d996382ff1edd8fed089185107f9ed0669b1ca1f046a9ef42aad0f0207d791c543a9c8bbfab324d0481c5451a2c4b28a180e59e354726ac3d38e062217c04d35
+  metadata.gz: 8a9ccb409c29bc5c9314ec8095dfff7c572f549bbb38da3290db0fbd1e27c1f5cc902fa2ebd76afa1eb1fabb87a09e2ae747cd77c2cea9d49ae76e3fe2ea6e95
+  data.tar.gz: 4cd4605acc92a180324bb7f8ee51fe1455c728ae876a5086729f323de5df2da5c6d0fe5b83f891fae4538df9d15f2e2d06be9cf6e50834145594816a2308a515

data/README.md

@@ -16,7 +16,7 @@ for this library, google-cloud-gke_connect-gateway, to see the convenience metho
 constructing client objects. Reference documentation for the client objects
 themselves can be found in the client library documentation for the versioned
 client gems:
-[google-cloud-gke_connect-gateway-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/latest).
+[google-cloud-gke_connect-gateway-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_connect-gateway-v1/latest).
 
 See also the [Product Documentation](https://cloud.google.com/anthos/multicluster-management/gateway/)
 for more usage information.
@@ -34,35 +34,39 @@ In order to use this library, you first need to go through the following steps:
 1. [Enable the API.](https://console.cloud.google.com/apis/library/connectgateway.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
-## Enabling Logging
-
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library.
-The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/current/stdlibs/logger/Logger.html) as shown below,
-or a [`Google::Cloud::Logging::Logger`](https://cloud.google.com/ruby/docs/reference/google-cloud-logging/latest)
-that will write logs to [Cloud Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
-
-Configuring a Ruby stdlib logger:
-
-```ruby
-require "logger"
-
-module MyLogger
-  LOGGER = Logger.new $stderr, level: Logger::WARN
-  def logger
-    LOGGER
-  end
-end
-
-# Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-module GRPC
-  extend MyLogger
-end
-```
+## Debug Logging
+
+This library comes with opt-in Debug Logging that can help you troubleshoot
+your application's integration with the API. When logging is activated, key
+events such as requests and responses, along with data payloads and metadata
+such as headers and client configuration, are logged to the standard error
+stream.
+
+**WARNING:** Client Library Debug Logging includes your data payloads in
+plaintext, which could include sensitive data such as PII for yourself or your
+customers, private keys, or other security data that could be compromising if
+leaked. Always practice good data hygiene with your application logs, and follow
+the principle of least access. Google also recommends that Client Library Debug
+Logging be enabled only temporarily during active debugging, and not used
+permanently in production.
+
+To enable logging, set the environment variable `GOOGLE_SDK_RUBY_LOGGING_GEMS`
+to the value `all`. Alternatively, you can set the value to a comma-delimited
+list of client library gem names. This will select the default logging behavior,
+which writes logs to the standard error stream. On a local workstation, this may
+result in logs appearing on the console. When running on a Google Cloud hosting
+service such as [Google Cloud Run](https://cloud.google.com/run), this generally
+results in logs appearing alongside your application logs in the
+[Google Cloud Logging](https://cloud.google.com/logging/) service.
+
+Debug logging also requires that the versioned clients for this service be
+sufficiently recent, released after about Dec 10, 2024. If logging is not
+working, try updating the versioned clients in your bundle or installed gems:
+[google-cloud-gke_connect-gateway-v1](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_connect-gateway-v1/latest).
 
 ## Supported Ruby Versions
 
-This library is supported on Ruby 2.7+.
+This library is supported on Ruby 3.0+.
 
 Google provides official support for Ruby versions that are actively supported
 by Ruby Core—that is, Ruby versions that are either in normal maintenance or
@@ -76,7 +80,7 @@ support schedule.
 Most modern Ruby client libraries for Google APIs come in two flavors: the main
 client library with a name such as `google-cloud-gke_connect-gateway`,
 and lower-level _versioned_ client libraries with names such as
-`google-cloud-gke_connect-gateway-v1beta1`.
+`google-cloud-gke_connect-gateway-v1`.
 _In most cases, you should install the main client._
 
 ### What's the difference between the main client and a versioned client?
@@ -114,7 +118,7 @@ You can use a versioned client if you are content with a possibly lower-level
 class interface, you explicitly want to avoid features provided by the main
 client, or you want to access a specific service version not be covered by the
 main client. You can identify versioned client gems because the service version
-is part of the name, e.g. `google-cloud-gke_connect-gateway-v1beta1`.
+is part of the name, e.g. `google-cloud-gke_connect-gateway-v1`.
 
 ### What about the google-apis-<name> clients?
 

data/lib/google/cloud/gke_connect/gateway/version.rb

@@ -21,7 +21,7 @@ module Google
   module Cloud
     module GkeConnect
       module Gateway
-        VERSION = "1.1.0"
+        VERSION = "2.1.0"
       end
     end
   end

data/lib/google/cloud/gke_connect/gateway.rb

@@ -34,7 +34,6 @@ require "google/cloud/config"
   config.add_field! :scope,         nil, match: [::Array, ::String]
   config.add_field! :lib_name,      nil, match: ::String
   config.add_field! :lib_version,   nil, match: ::String
-  config.add_field! :interceptors,  nil, match: ::Array
   config.add_field! :timeout,       nil, match: ::Numeric
   config.add_field! :metadata,      nil, match: ::Hash
   config.add_field! :retry_policy,  nil, match: [::Hash, ::Proc]
@@ -50,22 +49,27 @@ module Google
         # Create a new client object for GatewayControl.
         #
         # By default, this returns an instance of
-        # [Google::Cloud::GkeConnect::Gateway::V1beta1::GatewayControl::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_connect-gateway-v1beta1/latest/Google-Cloud-GkeConnect-Gateway-V1beta1-GatewayControl-Client)
-        # for a gRPC client for version V1beta1 of the API.
+        # [Google::Cloud::GkeConnect::Gateway::V1::GatewayControl::Rest::Client](https://cloud.google.com/ruby/docs/reference/google-cloud-gke_connect-gateway-v1/latest/Google-Cloud-GkeConnect-Gateway-V1-GatewayControl-Rest-Client)
+        # for a REST client for version V1 of the API.
         # However, you can specify a different API version by passing it in the
         # `version` parameter. If the GatewayControl service is
         # supported by that API version, and the corresponding gem is available, the
         # appropriate versioned client will be returned.
         #
+        # Raises an exception if the currently installed versioned client gem for the
+        # given API version does not support the GatewayControl service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Cloud::GkeConnect::Gateway.gateway_control_available?}.
+        #
         # ## About GatewayControl
         #
         # GatewayControl is the control plane API for Connect Gateway.
         #
         # @param version [::String, ::Symbol] The API version to connect to. Optional.
-        #   Defaults to `:v1beta1`.
+        #   Defaults to `:v1`.
         # @return [::Object] A client object for the specified version.
         #
-        def self.gateway_control version: :v1beta1, &block
+        def self.gateway_control version: :v1, &block
           require "google/cloud/gke_connect/gateway/#{version.to_s.downcase}"
 
           package_name = Google::Cloud::GkeConnect::Gateway
@@ -73,7 +77,35 @@ module Google
                          .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
                          .first
           service_module = Google::Cloud::GkeConnect::Gateway.const_get(package_name).const_get(:GatewayControl)
-          service_module.const_get(:Client).new(&block)
+          service_module.const_get(:Rest).const_get(:Client).new(&block)
+        end
+
+        ##
+        # Determines whether the GatewayControl service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Cloud::GkeConnect::Gateway.gateway_control}.
+        # If false, that method will raise an exception. This could happen if the given
+        # API version does not exist or does not support the GatewayControl service,
+        # or if the versioned client gem needs an update to support the GatewayControl service.
+        #
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1`.
+        # @return [boolean] Whether the service is available.
+        #
+        def self.gateway_control_available? version: :v1
+          require "google/cloud/gke_connect/gateway/#{version.to_s.downcase}"
+          package_name = Google::Cloud::GkeConnect::Gateway
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Cloud::GkeConnect::Gateway.const_get package_name
+          return false unless service_module.const_defined? :GatewayControl
+          service_module = service_module.const_get :GatewayControl
+          return false unless service_module.const_defined? :Rest
+          service_module = service_module.const_get :Rest
+          service_module.const_defined? :Client
+        rescue ::LoadError
+          false
         end
 
         ##
@@ -88,8 +120,6 @@ module Google
         #   The library name as recorded in instrumentation and logging.
         # * `lib_version` (*type:* `String`) -
         #   The library version as recorded in instrumentation and logging.
-        # * `interceptors` (*type:* `Array<GRPC::ClientInterceptor>`) -
-        #   An array of interceptors that are run before calls are executed.
         # * `timeout` (*type:* `Numeric`) -
         #   Default timeout in seconds.
         # * `metadata` (*type:* `Hash{Symbol=>String}`) -

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-gke_connect-gateway
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 2.1.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-27 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -25,12 +24,12 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.6'
 - !ruby/object:Gem::Dependency
-  name: google-cloud-gke_connect-gateway-v1beta1
+  name: google-cloud-gke_connect-gateway-v1
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -40,7 +39,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.2'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -65,7 +64,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -73,15 +71,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.7'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: API Client library for the Connect Gateway API
 test_files: []