google-iam-v2 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c819f6c58cebafdc2ebb7b3b04a15d6ef6a0e3ddd4c001402eee453359c2e8e
-  data.tar.gz: f7a104dd3d7c6efe031f1e74f69a200ee0b2f2f2265e5bcdbcd584ab2fc638d6
+  metadata.gz: 3bb33dd2d324db645bd9448b8b1c6fba86f1e6f96bd335fc25c7d8c3acb7bedc
+  data.tar.gz: e0620271b616d7d0a81f1758ae4e4be785ffb483b74628329ba6514882f0dbf4
 SHA512:
-  metadata.gz: 774d63b8bb700d7441c95f138b27c5f8bc155a1d5909c769396f41881cc26cf28ad0a033f3bd99ae02177006c18eabd990e6020c4aaa45370fc8839f5ba1cbbd
-  data.tar.gz: 8b177bd609a48d7ea541f314c3726ad9cdd077dc7b28fb2f21a249618b25a696cf0b1ff73e4f41355a82e7ea0161189be29c8489b891dec0b81030fb2bf9810e
+  metadata.gz: 8aaddae04373d0b2310a73276ccac976b5a7c3fa5c52d0e849ab736e8f1ea84a2c36e75615b9fbe51023ffa5d1d4771374f5d283b9bb1cc1afe219d0639d4297
+  data.tar.gz: 58c28591974193b873f0f42036f8b17b54e70d7ca950577327fad169805f7d4ba1f0b1ea19d17b87c25e91cd578acd79505aa6d66a540c77e4a315e4b3b5733e

data/README.md

@@ -43,33 +43,43 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/iam)
 for general usage information.
 
-## 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:
+## 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.
+
+You can customize logging by modifying the `logger` configuration when
+constructing a client object. For example:
 
 ```ruby
+require "google/iam/v2"
 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
+client = ::Google::Iam::V2::Policies::Client.new do |config|
+  config.logger = Logger.new "my-app.log"
 end
 ```
 
-
 ## Google Cloud Samples
 
 To browse ready to use code samples check [Google Cloud Samples](https://cloud.google.com/docs/samples).

data/lib/google/iam/v2/policies/client.rb

@@ -186,8 +186,19 @@ module Google
               universe_domain: @config.universe_domain,
               channel_args: @config.channel_args,
               interceptors: @config.interceptors,
-              channel_pool_config: @config.channel_pool
+              channel_pool_config: @config.channel_pool,
+              logger: @config.logger
             )
+
+            @policies_stub.stub_logger&.info do |entry|
+              entry.set_system_name
+              entry.set_service
+              entry.message = "Created client for #{entry.service}"
+              entry.set_credentials_fields credentials
+              entry.set "customEndpoint", @config.endpoint if @config.endpoint
+              entry.set "defaultTimeout", @config.timeout if @config.timeout
+              entry.set "quotaProject", @quota_project_id if @quota_project_id
+            end
           end
 
           ##
@@ -197,6 +208,15 @@ module Google
           #
           attr_reader :operations_client
 
+          ##
+          # The logger used for request/response debug logging.
+          #
+          # @return [Logger]
+          #
+          def logger
+            @policies_stub.logger
+          end
+
           # Service calls
 
           ##
@@ -305,7 +325,7 @@ module Google
             @policies_stub.call_rpc :list_policies, request, options: options do |response, operation|
               response = ::Gapic::PagedEnumerable.new @policies_stub, :list_policies, request, response, operation, options
               yield response, operation if block_given?
-              return response
+              throw :response, response
             end
           rescue ::GRPC::BadStatus => e
             raise ::Google::Cloud::Error.from_error(e)
@@ -400,7 +420,6 @@ module Google
 
             @policies_stub.call_rpc :get_policy, request, options: options do |response, operation|
               yield response, operation if block_given?
-              return response
             end
           rescue ::GRPC::BadStatus => e
             raise ::Google::Cloud::Error.from_error(e)
@@ -511,7 +530,7 @@ module Google
             @policies_stub.call_rpc :create_policy, request, options: options do |response, operation|
               response = ::Gapic::Operation.new response, @operations_client, options: options
               yield response, operation if block_given?
-              return response
+              throw :response, response
             end
           rescue ::GRPC::BadStatus => e
             raise ::Google::Cloud::Error.from_error(e)
@@ -619,7 +638,7 @@ module Google
             @policies_stub.call_rpc :update_policy, request, options: options do |response, operation|
               response = ::Gapic::Operation.new response, @operations_client, options: options
               yield response, operation if block_given?
-              return response
+              throw :response, response
             end
           rescue ::GRPC::BadStatus => e
             raise ::Google::Cloud::Error.from_error(e)
@@ -729,7 +748,7 @@ module Google
             @policies_stub.call_rpc :delete_policy, request, options: options do |response, operation|
               response = ::Gapic::Operation.new response, @operations_client, options: options
               yield response, operation if block_given?
-              return response
+              throw :response, response
             end
           rescue ::GRPC::BadStatus => e
             raise ::Google::Cloud::Error.from_error(e)
@@ -818,6 +837,11 @@ module Google
           #   default endpoint URL. The default value of nil uses the environment
           #   universe (usually the default "googleapis.com" universe).
           #   @return [::String,nil]
+          # @!attribute [rw] logger
+          #   A custom logger to use for request/response debug logging, or the value
+          #   `:default` (the default) to construct a default logger, or `nil` to
+          #   explicitly disable logging.
+          #   @return [::Logger,:default,nil]
           #
           class Configuration
             extend ::Gapic::Config
@@ -842,6 +866,7 @@ module Google
             config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
             config_attr :quota_project, nil, ::String, nil
             config_attr :universe_domain, nil, ::String, nil
+            config_attr :logger, :default, ::Logger, nil, :default
 
             # @private
             def initialize parent_config = nil

data/lib/google/iam/v2/policies/operations.rb

@@ -212,7 +212,7 @@ module Google
               wrap_lro_operation = ->(op_response) { ::Gapic::Operation.new op_response, @operations_client }
               response = ::Gapic::PagedEnumerable.new @operations_stub, :list_operations, request, response, operation, options, format_resource: wrap_lro_operation
               yield response, operation if block_given?
-              return response
+              throw :response, response
             end
           rescue ::GRPC::BadStatus => e
             raise ::Google::Cloud::Error.from_error(e)
@@ -308,7 +308,7 @@ module Google
             @operations_stub.call_rpc :get_operation, request, options: options do |response, operation|
               response = ::Gapic::Operation.new response, @operations_client, options: options
               yield response, operation if block_given?
-              return response
+              throw :response, response
             end
           rescue ::GRPC::BadStatus => e
             raise ::Google::Cloud::Error.from_error(e)
@@ -397,7 +397,6 @@ module Google
 
             @operations_stub.call_rpc :delete_operation, request, options: options do |response, operation|
               yield response, operation if block_given?
-              return response
             end
           rescue ::GRPC::BadStatus => e
             raise ::Google::Cloud::Error.from_error(e)
@@ -493,7 +492,6 @@ module Google
 
             @operations_stub.call_rpc :cancel_operation, request, options: options do |response, operation|
               yield response, operation if block_given?
-              return response
             end
           rescue ::GRPC::BadStatus => e
             raise ::Google::Cloud::Error.from_error(e)
@@ -591,7 +589,7 @@ module Google
             @operations_stub.call_rpc :wait_operation, request, options: options do |response, operation|
               response = ::Gapic::Operation.new response, @operations_client, options: options
               yield response, operation if block_given?
-              return response
+              throw :response, response
             end
           rescue ::GRPC::BadStatus => e
             raise ::Google::Cloud::Error.from_error(e)
@@ -680,6 +678,11 @@ module Google
           #   default endpoint URL. The default value of nil uses the environment
           #   universe (usually the default "googleapis.com" universe).
           #   @return [::String,nil]
+          # @!attribute [rw] logger
+          #   A custom logger to use for request/response debug logging, or the value
+          #   `:default` (the default) to construct a default logger, or `nil` to
+          #   explicitly disable logging.
+          #   @return [::Logger,:default,nil]
           #
           class Configuration
             extend ::Gapic::Config
@@ -704,6 +707,7 @@ module Google
             config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
             config_attr :quota_project, nil, ::String, nil
             config_attr :universe_domain, nil, ::String, nil
+            config_attr :logger, :default, ::Logger, nil, :default
 
             # @private
             def initialize parent_config = nil

data/lib/google/iam/v2/policies/rest/client.rb

@@ -179,8 +179,19 @@ module Google
                 endpoint: @config.endpoint,
                 endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                 universe_domain: @config.universe_domain,
-                credentials: credentials
+                credentials: credentials,
+                logger: @config.logger
               )
+
+              @policies_stub.logger(stub: true)&.info do |entry|
+                entry.set_system_name
+                entry.set_service
+                entry.message = "Created client for #{entry.service}"
+                entry.set_credentials_fields credentials
+                entry.set "customEndpoint", @config.endpoint if @config.endpoint
+                entry.set "defaultTimeout", @config.timeout if @config.timeout
+                entry.set "quotaProject", @quota_project_id if @quota_project_id
+              end
             end
 
             ##
@@ -190,6 +201,15 @@ module Google
             #
             attr_reader :operations_client
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger
+              @policies_stub.logger
+            end
+
             # Service calls
 
             ##
@@ -291,7 +311,7 @@ module Google
               @policies_stub.list_policies request, options do |result, operation|
                 result = ::Gapic::Rest::PagedEnumerable.new @policies_stub, :list_policies, "policies", request, result, options
                 yield result, operation if block_given?
-                return result
+                throw :response, result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -379,7 +399,6 @@ module Google
 
               @policies_stub.get_policy request, options do |result, operation|
                 yield result, operation if block_given?
-                return result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -483,7 +502,7 @@ module Google
               @policies_stub.create_policy request, options do |result, operation|
                 result = ::Gapic::Operation.new result, @operations_client, options: options
                 yield result, operation if block_given?
-                return result
+                throw :response, result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -584,7 +603,7 @@ module Google
               @policies_stub.update_policy request, options do |result, operation|
                 result = ::Gapic::Operation.new result, @operations_client, options: options
                 yield result, operation if block_given?
-                return result
+                throw :response, result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -687,7 +706,7 @@ module Google
               @policies_stub.delete_policy request, options do |result, operation|
                 result = ::Gapic::Operation.new result, @operations_client, options: options
                 yield result, operation if block_given?
-                return result
+                throw :response, result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -767,6 +786,11 @@ module Google
             #   default endpoint URL. The default value of nil uses the environment
             #   universe (usually the default "googleapis.com" universe).
             #   @return [::String,nil]
+            # @!attribute [rw] logger
+            #   A custom logger to use for request/response debug logging, or the value
+            #   `:default` (the default) to construct a default logger, or `nil` to
+            #   explicitly disable logging.
+            #   @return [::Logger,:default,nil]
             #
             class Configuration
               extend ::Gapic::Config
@@ -788,6 +812,7 @@ module Google
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
               config_attr :universe_domain, nil, ::String, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil

data/lib/google/iam/v2/policies/rest/operations.rb

@@ -195,7 +195,7 @@ module Google
               @operations_stub.list_operations request, options do |result, operation|
                 result = ::Gapic::Rest::PagedEnumerable.new @operations_stub, :list_operations, "operations", request, result, options
                 yield result, operation if block_given?
-                return result
+                throw :response, result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -284,7 +284,7 @@ module Google
               @operations_stub.get_operation request, options do |result, operation|
                 result = ::Gapic::Operation.new result, @operations_client, options: options
                 yield result, operation if block_given?
-                return result
+                throw :response, result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -366,7 +366,6 @@ module Google
 
               @operations_stub.delete_operation request, options do |result, operation|
                 yield result, operation if block_given?
-                return result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -455,7 +454,6 @@ module Google
 
               @operations_stub.cancel_operation request, options do |result, operation|
                 yield result, operation if block_given?
-                return result
               end
             rescue ::Gapic::Rest::Error => e
               raise ::Google::Cloud::Error.from_error(e)
@@ -535,6 +533,11 @@ module Google
             #   default endpoint URL. The default value of nil uses the environment
             #   universe (usually the default "googleapis.com" universe).
             #   @return [::String,nil]
+            # @!attribute [rw] logger
+            #   A custom logger to use for request/response debug logging, or the value
+            #   `:default` (the default) to construct a default logger, or `nil` to
+            #   explicitly disable logging.
+            #   @return [::Logger,:default,nil]
             #
             class Configuration
               extend ::Gapic::Config
@@ -556,6 +559,7 @@ module Google
               config_attr :retry_policy,  nil, ::Hash, ::Proc, nil
               config_attr :quota_project, nil, ::String, nil
               config_attr :universe_domain, nil, ::String, nil
+              config_attr :logger, :default, ::Logger, nil, :default
 
               # @private
               def initialize parent_config = nil
@@ -675,16 +679,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "list_operations",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Longrunning::ListOperationsResponse.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##
@@ -713,16 +719,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "get_operation",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##
@@ -751,16 +759,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "delete_operation",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##
@@ -789,16 +799,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "cancel_operation",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Protobuf::Empty.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##

data/lib/google/iam/v2/policies/rest/service_stub.rb

@@ -29,7 +29,8 @@ module Google
           # including transcoding, making the REST call, and deserialing the response.
           #
           class ServiceStub
-            def initialize endpoint:, endpoint_template:, universe_domain:, credentials:
+            # @private
+            def initialize endpoint:, endpoint_template:, universe_domain:, credentials:, logger:
               # These require statements are intentionally placed here to initialize
               # the REST modules only when it's required.
               require "gapic/rest"
@@ -39,7 +40,9 @@ module Google
                                                            universe_domain: universe_domain,
                                                            credentials: credentials,
                                                            numeric_enums: true,
-                                                           raise_faraday_errors: false
+                                                           service_name: self.class,
+                                                           raise_faraday_errors: false,
+                                                           logger: logger
             end
 
             ##
@@ -60,6 +63,15 @@ module Google
               @client_stub.endpoint
             end
 
+            ##
+            # The logger used for request/response debug logging.
+            #
+            # @return [Logger]
+            #
+            def logger stub: false
+              stub ? @client_stub.stub_logger : @client_stub.logger
+            end
+
             ##
             # Baseline implementation for the list_policies REST call
             #
@@ -86,16 +98,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "list_policies",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Iam::V2::ListPoliciesResponse.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##
@@ -124,16 +138,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "get_policy",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Iam::V2::Policy.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##
@@ -162,16 +178,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "create_policy",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##
@@ -200,16 +218,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "update_policy",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##
@@ -238,16 +258,18 @@ module Google
 
               response = @client_stub.make_http_request(
                 verb,
-                uri:     uri,
-                body:    body || "",
-                params:  query_string_params,
+                uri: uri,
+                body: body || "",
+                params: query_string_params,
+                method_name: "delete_policy",
                 options: options
               )
               operation = ::Gapic::Rest::TransportOperation.new response
               result = ::Google::Longrunning::Operation.decode_json response.body, ignore_unknown_fields: true
-
-              yield result, operation if block_given?
-              result
+              catch :response do
+                yield result, operation if block_given?
+                result
+              end
             end
 
             ##

data/lib/google/iam/v2/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Iam
     module V2
-      VERSION = "0.6.2"
+      VERSION = "0.7.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-iam-v2
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-05 00:00:00.000000000 Z
+date: 2024-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.21.1
+        version: 0.24.0
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a