google-cloud-recommendation_engine 0.6.2 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab17040748f91b8f969a25467a64b36d8189acbc12d5271be704cfc3cefc110f
-  data.tar.gz: 3732ecb12138b3ea051a320448e9ee5315d764c2748b4f089c42bab39ef23dfa
+  metadata.gz: 56ebca0ce3beddcabeb136b67565051b234add79c989fc7bf2e3db3c2ce7cb9d
+  data.tar.gz: '08aa6f9c99e3db16cda8a50bd8cbf3a6635d01f20dc4559e9441de98fb24f16f'
 SHA512:
-  metadata.gz: ef0756e9b3dbdf32edf3c6559c1c751b4da7de1e71b5e77103d91c971f3027416707d64254c8cdfff58b974e33f9eb864f90c7322cf92d7ef1298c692a718467
-  data.tar.gz: 38fb77221bc73d1097edc6f572278c700d943205fd20599dfe6f4819d92c24074e9f65b1d5183c360cac75288c2944746b59bdeddb224b4bb0acea805913804b
+  metadata.gz: 7688f21701a650229879ac697b4ec40bc86cb698e3959f1ad85248a660b7c5f704c1bab6d88d19bab38f4a17ef936fa64607ed2d0e6e539fc1158909f8332895
+  data.tar.gz: d2327b43ba3d402652ce6daee1257fa002e5f66cd4864a52b08d2bebffb5a1e23271c61dbd14c7c5a0fca272f7e2ad28753254744b658099b3ad96788ea5b99e

data/README.md

@@ -7,7 +7,7 @@ Recommendations AI enables you to build an end-to-end personalized recommendatio
 Actual client classes for the various versions of this API are defined in
 _versioned_ client gems, with names of the form `google-cloud-recommendation_engine-v*`.
 The gem `google-cloud-recommendation_engine` is the main client library that brings the
-verisoned gems in as dependencies, and provides high-level methods for
+versioned gems in as dependencies, and provides high-level methods for
 constructing clients. More information on versioned clients can be found below
 in the section titled *Which client should I use?*.
 
@@ -34,9 +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/recommendationengine.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-cloud-recommendation_engine-v1beta1](https://cloud.google.com/ruby/docs/reference/google-cloud-recommendation_engine-v1beta1/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

data/lib/google/cloud/recommendation_engine/version.rb

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module RecommendationEngine
-      VERSION = "0.6.2"
+      VERSION = "0.7.1"
     end
   end
 end

data/lib/google/cloud/recommendation_engine.rb

@@ -58,6 +58,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 CatalogService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::RecommendationEngine.catalog_service_available?}.
+      #
       # ## About CatalogService
       #
       # Service for ingesting catalog information of the customer's website.
@@ -79,6 +84,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the CatalogService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::RecommendationEngine.catalog_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 CatalogService service,
+      # or if the versioned client gem needs an update to support the CatalogService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1beta1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.catalog_service_available? version: :v1beta1, transport: :grpc
+        require "google/cloud/recommendation_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::RecommendationEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::RecommendationEngine.const_get package_name
+        return false unless service_module.const_defined? :CatalogService
+        service_module = service_module.const_get :CatalogService
+        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
+
       ##
       # Create a new client object for PredictionApiKeyRegistry.
       #
@@ -92,6 +128,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 PredictionApiKeyRegistry service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::RecommendationEngine.prediction_api_key_registry_available?}.
+      #
       # ## About PredictionApiKeyRegistry
       #
       # Service for registering API keys for use with the `predict` method. If you
@@ -117,6 +158,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the PredictionApiKeyRegistry service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::RecommendationEngine.prediction_api_key_registry}.
+      # If false, that method will raise an exception. This could happen if the given
+      # API version does not exist or does not support the PredictionApiKeyRegistry service,
+      # or if the versioned client gem needs an update to support the PredictionApiKeyRegistry service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1beta1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.prediction_api_key_registry_available? version: :v1beta1, transport: :grpc
+        require "google/cloud/recommendation_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::RecommendationEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::RecommendationEngine.const_get package_name
+        return false unless service_module.const_defined? :PredictionApiKeyRegistry
+        service_module = service_module.const_get :PredictionApiKeyRegistry
+        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
+
       ##
       # Create a new client object for PredictionService.
       #
@@ -130,6 +202,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 PredictionService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::RecommendationEngine.prediction_service_available?}.
+      #
       # ## About PredictionService
       #
       # Service for making recommendation prediction.
@@ -151,6 +228,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the PredictionService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::RecommendationEngine.prediction_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 PredictionService service,
+      # or if the versioned client gem needs an update to support the PredictionService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1beta1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.prediction_service_available? version: :v1beta1, transport: :grpc
+        require "google/cloud/recommendation_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::RecommendationEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::RecommendationEngine.const_get package_name
+        return false unless service_module.const_defined? :PredictionService
+        service_module = service_module.const_get :PredictionService
+        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
+
       ##
       # Create a new client object for UserEventService.
       #
@@ -164,6 +272,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 UserEventService service.
+      # You can determine whether the method will succeed by calling
+      # {Google::Cloud::RecommendationEngine.user_event_service_available?}.
+      #
       # ## About UserEventService
       #
       # Service for ingesting end user actions on the customer website.
@@ -185,6 +298,37 @@ module Google
         service_module.const_get(:Client).new(&block)
       end
 
+      ##
+      # Determines whether the UserEventService service is supported by the current client.
+      # If true, you can retrieve a client object by calling {Google::Cloud::RecommendationEngine.user_event_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 UserEventService service,
+      # or if the versioned client gem needs an update to support the UserEventService service.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v1beta1`.
+      # @param transport [:grpc, :rest] The transport to use. Defaults to `:grpc`.
+      # @return [boolean] Whether the service is available.
+      #
+      def self.user_event_service_available? version: :v1beta1, transport: :grpc
+        require "google/cloud/recommendation_engine/#{version.to_s.downcase}"
+        package_name = Google::Cloud::RecommendationEngine
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        return false unless package_name
+        service_module = Google::Cloud::RecommendationEngine.const_get package_name
+        return false unless service_module.const_defined? :UserEventService
+        service_module = service_module.const_get :UserEventService
+        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
+
       ##
       # Configure the google-cloud-recommendation_engine library.
       #

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-recommendation_engine
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.1
 platform: ruby
 authors:
 - Google LLC
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -63,7 +62,6 @@ homepage: https://github.com/googleapis/google-cloud-ruby
 licenses:
 - Apache-2.0
 metadata: {}
-post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -71,15 +69,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.8
 specification_version: 4
 summary: API Client library for the Recommendations AI API
 test_files: []