google-cloud-api_hub-v1 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1bf41a283c08bd0449f6ad1a4a72dc03620810ccd66697f931de51f2a915f33
-  data.tar.gz: 2794aafbd6bf6356f908e84b4a7a291259735340144465af3933cbe327e57fc1
+  metadata.gz: 3f9f5dcd83cc8f97c195ae85c4f0f8312f571567986e431cbb06523e7f63ef0c
+  data.tar.gz: 3421bdaabaef64a538dc18ed669f1b26f0702a5b647a914929bcaebcf9ab0c13
 SHA512:
-  metadata.gz: e49056bbd0fe3cc1b9dbad2563f770a444e7ab99b7e755af928359c021f2e31f6b75f0b11de641beb1f9ce8f0229ecee0b03c7907cc0ee7f390074da6f2ac531
-  data.tar.gz: 7b90efd60173df61c8572ade0a417008f4406839b9db193e5dd31232622ce71be294f0fcdf44cc002f7511744b7f3159ad942af7ae81ce45c440fc6c8f29df21
+  metadata.gz: 89c2f7433626d064d47daaf5cf6502dcd72700ca460f68aae98d5e14fc0663b4c949169b8b016429938be02281b82ea29b8d704ac6417e3a924284748c29fa6b
+  data.tar.gz: 41f971be8e6592c162ca29300969bef3c537eff9b509d4643df6d8e17eab427a8c79a92cd2983702e85bbef8ed76f33e4134a296e6d74c5f585d47b2b78e1611

data/README.md

@@ -43,6 +43,42 @@ for class and method documentation.
 See also the [Product Documentation](https://cloud.google.com/apigee/docs/apihub/what-is-api-hub)
 for general usage information.
 
+## 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/cloud/api_hub/v1"
+require "logger"
+
+client = ::Google::Cloud::ApiHub::V1::ApiHub::Rest::Client.new do |config|
+  config.logger = Logger.new "my-app.log"
+end
+```
 
 ## Google Cloud Samples
 

data/lib/google/cloud/api_hub/v1/api_hub/rest/client.rb

@@ -272,15 +272,27 @@ module Google
                   endpoint: @config.endpoint,
                   endpoint_template: DEFAULT_ENDPOINT_TEMPLATE,
                   universe_domain: @config.universe_domain,
-                  credentials: credentials
+                  credentials: credentials,
+                  logger: @config.logger
                 )
 
+                @api_hub_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
+
                 @location_client = Google::Cloud::Location::Locations::Rest::Client.new do |config|
                   config.credentials = credentials
                   config.quota_project = @quota_project_id
                   config.endpoint = @api_hub_stub.endpoint
                   config.universe_domain = @api_hub_stub.universe_domain
                   config.bindings_override = @config.bindings_override
+                  config.logger = @api_hub_stub.logger if config.respond_to? :logger=
                 end
               end
 
@@ -291,6 +303,15 @@ module Google
               #
               attr_reader :location_client
 
+              ##
+              # The logger used for request/response debug logging.
+              #
+              # @return [Logger]
+              #
+              def logger
+                @api_hub_stub.logger
+              end
+
               # Service calls
 
               ##
@@ -380,7 +401,6 @@ module Google
 
                 @api_hub_stub.create_api 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)
@@ -460,7 +480,6 @@ module Google
 
                 @api_hub_stub.get_api 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)
@@ -628,7 +647,7 @@ module Google
                 @api_hub_stub.list_apis request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @api_hub_stub, :list_apis, "apis", 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)
@@ -731,7 +750,6 @@ module Google
 
                 @api_hub_stub.update_api 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)
@@ -815,7 +833,6 @@ module Google
 
                 @api_hub_stub.delete_api 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)
@@ -907,7 +924,6 @@ module Google
 
                 @api_hub_stub.create_version 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)
@@ -990,7 +1006,6 @@ module Google
 
                 @api_hub_stub.get_version 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)
@@ -1146,7 +1161,7 @@ module Google
                 @api_hub_stub.list_versions request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @api_hub_stub, :list_versions, "versions", 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)
@@ -1245,7 +1260,6 @@ module Google
 
                 @api_hub_stub.update_version 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)
@@ -1330,7 +1344,6 @@ module Google
 
                 @api_hub_stub.delete_version 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)
@@ -1444,7 +1457,6 @@ module Google
 
                 @api_hub_stub.create_spec 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)
@@ -1528,7 +1540,6 @@ module Google
 
                 @api_hub_stub.get_spec 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)
@@ -1609,7 +1620,6 @@ module Google
 
                 @api_hub_stub.get_spec_contents 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)
@@ -1758,7 +1768,7 @@ module Google
                 @api_hub_stub.list_specs request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @api_hub_stub, :list_specs, "specs", 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)
@@ -1864,7 +1874,6 @@ module Google
 
                 @api_hub_stub.update_spec 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)
@@ -1947,7 +1956,6 @@ module Google
 
                 @api_hub_stub.delete_spec 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)
@@ -2028,7 +2036,6 @@ module Google
 
                 @api_hub_stub.get_api_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)
@@ -2166,7 +2173,7 @@ module Google
                 @api_hub_stub.list_api_operations request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @api_hub_stub, :list_api_operations, "api_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)
@@ -2247,7 +2254,6 @@ module Google
 
                 @api_hub_stub.get_definition 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)
@@ -2342,7 +2348,6 @@ module Google
 
                 @api_hub_stub.create_deployment 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)
@@ -2422,7 +2427,6 @@ module Google
 
                 @api_hub_stub.get_deployment 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)
@@ -2577,7 +2581,7 @@ module Google
                 @api_hub_stub.list_deployments request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @api_hub_stub, :list_deployments, "deployments", 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)
@@ -2678,7 +2682,6 @@ module Google
 
                 @api_hub_stub.update_deployment 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)
@@ -2758,7 +2761,6 @@ module Google
 
                 @api_hub_stub.delete_deployment 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)
@@ -2857,7 +2859,6 @@ module Google
 
                 @api_hub_stub.create_attribute 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)
@@ -2938,7 +2939,6 @@ module Google
 
                 @api_hub_stub.get_attribute 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)
@@ -3045,7 +3045,6 @@ module Google
 
                 @api_hub_stub.update_attribute 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)
@@ -3130,7 +3129,6 @@ module Google
 
                 @api_hub_stub.delete_attribute 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)
@@ -3270,7 +3268,7 @@ module Google
                 @api_hub_stub.list_attributes request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @api_hub_stub, :list_attributes, "attributes", 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)
@@ -3395,7 +3393,7 @@ module Google
                 @api_hub_stub.search_resources request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @api_hub_stub, :search_resources, "search_results", 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)
@@ -3489,7 +3487,6 @@ module Google
 
                 @api_hub_stub.create_external_api 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)
@@ -3570,7 +3567,6 @@ module Google
 
                 @api_hub_stub.get_external_api 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)
@@ -3666,7 +3662,6 @@ module Google
 
                 @api_hub_stub.update_external_api 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)
@@ -3747,7 +3742,6 @@ module Google
 
                 @api_hub_stub.delete_external_api 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)
@@ -3843,7 +3837,7 @@ module Google
                 @api_hub_stub.list_external_apis request, options do |result, operation|
                   result = ::Gapic::Rest::PagedEnumerable.new @api_hub_stub, :list_external_apis, "external_apis", 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)
@@ -3923,6 +3917,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
@@ -3951,6 +3950,7 @@ module Google
                 # by the host service.
                 # @return [::Hash{::Symbol=>::Array<::Gapic::Rest::GrpcTranscoder::HttpBinding>}]
                 config_attr :bindings_override, {}, ::Hash, nil
+                config_attr :logger, :default, ::Logger, nil, :default
 
                 # @private
                 def initialize parent_config = nil