google-shopping-merchant-reports 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6808b1c8bbc385a498e8d03f59888b108cc94d989f6ed1111fb1a72ee9cdd254
-  data.tar.gz: 70191d9dc1e2bc20d5bf9763433c176de64af799055404d3a81371cdfbec8751
+  metadata.gz: 00cde6bdfb77c31201821bd9a955883f628bb11c1f8cdca7aa52973e8b3b411b
+  data.tar.gz: eeb00397753eaedc8e798766cccbdd085a25c7146242e20f2044906d4cc51a03
 SHA512:
-  metadata.gz: d1d2aa3a55e5fcac3d4ce9b09d86af9484e499b75d58235bcce7d5170fa2ce1ecce607cd24deccb02f19e0cf6027d24290e9820effcdeb554b1fbfb1fab4b4b5
-  data.tar.gz: 9137bf036afd1f8b0251827ec9d40cf8038180bdaed69976460828782b39ae35e7f716b1a5071016c1f23447228102297306e210b5874cc08f4151e8b1b2071b
+  metadata.gz: b315c3747ab683916a513f01f02c87073d2101dd441a9e3de12b257a4e8aebd0e25e5e4a0974c2a726f290cf055f5c318bfcd6c0656968cc4a1170b77fea6773
+  data.tar.gz: 8bf66b0b98ed1d2f1850dc9c9f9199ccbf90ea420107b5cc91625fca696b50f71d06d53e8bec664ded0a7c93060e8779774ba34822d4e1b67c2f19f0b2bae467

data/README.md

@@ -2,7 +2,6 @@
 
 Programmatically manage your Merchant Center accounts.
 
-Programmatically manage your Merchant Center accounts.
 
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-shopping-merchant-reports-v*`.
@@ -34,9 +33,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/merchantapi.googleapis.com)
 1. {file:AUTHENTICATION.md Set up authentication.}
 
+## 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-shopping-merchant-reports-v1beta](https://rubydoc.info/gems/google-shopping-merchant-reports-v1beta).
+
 ## 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

data/lib/google/shopping/merchant/reports/version.rb

@@ -21,7 +21,7 @@ module Google
   module Shopping
     module Merchant
       module Reports
-        VERSION = "0.3.0"
+        VERSION = "0.4.0"
       end
     end
   end

data/lib/google/shopping/merchant/reports.rb

@@ -41,6 +41,11 @@ module Google
         # You can also specify a different transport by passing `:rest` or `:grpc` in
         # the `transport` parameter.
         #
+        # Raises an exception if the currently installed versioned client gem for the
+        # given API version does not support the given transport of the ReportService service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Shopping::Merchant::Reports.report_service_available?}.
+        #
         # ## About ReportService
         #
         # Service for retrieving reports and insights about your products, their
@@ -62,6 +67,37 @@ module Google
           service_module = service_module.const_get(:Rest) if transport == :rest
           service_module.const_get(:Client).new(&block)
         end
+
+        ##
+        # Determines whether the ReportService service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Shopping::Merchant::Reports.report_service}.
+        # If false, that method will raise an exception. This could happen if the given
+        # API version does not exist or does not support the ReportService service,
+        # or if the versioned client gem needs an update to support the ReportService service.
+        #
+        # @param version [::String, ::Symbol] The API version to connect to. Optional.
+        #   Defaults to `:v1beta`.
+        # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+        # @return [boolean] Whether the service is available.
+        #
+        def self.report_service_available? version: :v1beta, transport: :grpc
+          require "google/shopping/merchant/reports/#{version.to_s.downcase}"
+          package_name = Google::Shopping::Merchant::Reports
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Shopping::Merchant::Reports.const_get package_name
+          return false unless service_module.const_defined? :ReportService
+          service_module = service_module.const_get :ReportService
+          if transport == :rest
+            return false unless service_module.const_defined? :Rest
+            service_module = service_module.const_get :Rest
+          end
+          service_module.const_defined? :Client
+        rescue ::LoadError
+          false
+        end
       end
     end
   end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-shopping-merchant-reports
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-02-26 00:00:00.000000000 Z
+date: 2025-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -61,7 +60,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -69,15 +67,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: Programmatically manage your Merchant Center accounts.
 test_files: []