google-shopping-merchant-notifications 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6486d1adc0189e8a01bf00ece7d8c5a43d10ebe3221acc6986da5caf7395d136
-  data.tar.gz: 48fb870422a6c3eae5279e7892fd53cb861f14bb0b38d037809b32fc01372cbf
+  metadata.gz: 7f9da22fdb86376a60b876395464b2256aae0a4cc050a7c9d0faf2d3a7e94551
+  data.tar.gz: c2f2f7b32c6b5ca5d61ca9199dbbbe1da0b04b4cbcb381983cbdda2eb115c783
 SHA512:
-  metadata.gz: 44bbf8d2c741478abfea67967d3a4295d6dceb68401717da0ec2c252584c89142b615cf0de665e3c6606854090f73ead6ff87910aff44e88eb5255fb4118c1ad
-  data.tar.gz: 8f339140639d483e6e5c6485d650a75b5c30b8b11c97f5c38a7fb7172deef099de8983c9d0151d149de40866446b14d24e5263f32c24d84d272025c3b2cac74d
+  metadata.gz: 53c7264543f34d8b6a6308a856529a87438ab6b4db81c668e7dfef26a38c2957e86ed8ef088af14660b137ce378ef206bde7fe74a0d87950d7470b0334ddd58d
+  data.tar.gz: 244afbc8a3efed65f4e5ba80d037bf6bb6ddbcd3487631d7839f5b483357fe31f74f7433de8298007bbfe62ff60290e3984e238b9f193b276349d5116fa05cf9

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-notifications-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-notifications-v1beta](https://rubydoc.info/gems/google-shopping-merchant-notifications-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/notifications/version.rb

@@ -21,7 +21,7 @@ module Google
   module Shopping
     module Merchant
       module Notifications
-        VERSION = "0.1.0"
+        VERSION = "0.2.0"
       end
     end
   end

data/lib/google/shopping/merchant/notifications.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 NotificationsApiService service.
+        # You can determine whether the method will succeed by calling
+        # {Google::Shopping::Merchant::Notifications.notifications_api_service_available?}.
+        #
         # ## About NotificationsApiService
         #
         # Service to manage notification subscriptions for merchants
@@ -61,6 +66,37 @@ module Google
           service_module = service_module.const_get(:Rest) if transport == :rest
           service_module.const_get(:Client).new(&block)
         end
+
+        ##
+        # Determines whether the NotificationsApiService service is supported by the current client.
+        # If true, you can retrieve a client object by calling {Google::Shopping::Merchant::Notifications.notifications_api_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 NotificationsApiService service,
+        # or if the versioned client gem needs an update to support the NotificationsApiService 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.notifications_api_service_available? version: :v1beta, transport: :grpc
+          require "google/shopping/merchant/notifications/#{version.to_s.downcase}"
+          package_name = Google::Shopping::Merchant::Notifications
+                         .constants
+                         .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                         .first
+          return false unless package_name
+          service_module = Google::Shopping::Merchant::Notifications.const_get package_name
+          return false unless service_module.const_defined? :NotificationsApiService
+          service_module = service_module.const_get :NotificationsApiService
+          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-notifications
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-04-25 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: []