google-cloud-retail 1.0.1 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af87a0c6795e621937d2b38048b97f0bcbfc28f709cdc3fc9b0f094400be8d6f
-  data.tar.gz: 223bb020cc76f2556ae7d2a0d0c7bcf32fa67a7f7e27f433e0ed802f0f49a7fb
+  metadata.gz: b1d608763e7661aadb9a8bcf3bc059512759549fef4b0e6101ecbb169503c531
+  data.tar.gz: d3449081a36b65525625adc6ffc21a71d9a2ee672ed19d52f4f0a852b7fcbdc2
 SHA512:
-  metadata.gz: 3c1e1c00356eb50ae49f7cc3f4415dce7fef4f2709a5634500ea969c23fd5ca1d143530a73b488ae2ca9f0ca07b6c0c9c517ee614b76934acedf8a4f8237fd7b
-  data.tar.gz: ff288a0b4d1d68bf7ae5e5d458c2cf08d10bc307c04132db8b91801fba05c0f4ef313e41065ea3eb9e1cf5023cfbb4415ddb5a917614210379cb35b11da5db47
+  metadata.gz: a93fe2e853564130d4e1a078d368791e5d4c74bb1bce444825eb4116085752d0d6242349a625c58f37c83d0b611c8acac0ad12eb3be0106f3f3fc10b70361364
+  data.tar.gz: ed9c53fe0da430686fe3e9aedbfd85d9966ad1145e5d412f1d15573a67fc845042920f03f3a81db514a65c8220548fc5ad6ef697d7201de2bbdd52ccb6c09952

data/.yardopts

@@ -1,5 +1,5 @@
 --no-private
---title=Retail API
+--title="Retail API"
 --exclude _pb\.rb$
 --markup markdown
 --markup-provider redcarpet

data/AUTHENTICATION.md

@@ -82,8 +82,8 @@ client = Google::Cloud::Retail.catalog_service
 
 ### Configuration
 
-The **Credentials JSON** can be configured instead of placing them in
-environment variables. Either on an individual client initialization:
+The path to the **Credentials JSON** file can be configured instead of storing
+it in an environment variable. Either on an individual client initialization:
 
 ```ruby
 require "google/cloud/retail"
@@ -93,7 +93,7 @@ client = Google::Cloud::Retail.catalog_service do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/retail"
@@ -120,15 +120,6 @@ To configure your system for this, simply:
 **NOTE:** This is _not_ recommended for running in production. The Cloud SDK
 *should* only be used during development.
 
-[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using
-[dev-console]: https://console.cloud.google.com/project
-
-[enable-apis]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/enable-apis.png
-
-[create-new-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account.png
-[create-new-service-account-existing-keys]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/create-new-service-account-existing-keys.png
-[reuse-service-account]: https://raw.githubusercontent.com/GoogleCloudPlatform/gcloud-common/master/authentication/reuse-service-account.png
-
 ## Creating a Service Account
 
 Google Cloud requires **Service Account Credentials** to
@@ -139,31 +130,22 @@ If you are not running this client within
 [Google Cloud Platform environments](#google-cloud-platform-environments), you
 need a Google Developers service account.
 
-1. Visit the [Google Developers Console][dev-console].
+1. Visit the [Google Cloud Console](https://console.cloud.google.com/project).
 2. Create a new project or click on an existing project.
-3. Activate the slide-out navigation tray and select **API Manager**. From
+3. Activate the menu in the upper left and select **APIs & Services**. From
    here, you will enable the APIs that your application requires.
 
-   ![Enable the APIs that your application requires][enable-apis]
-
    *Note: You may need to enable billing in order to use these services.*
 
 4. Select **Credentials** from the side navigation.
 
-   You should see a screen like one of the following.
-
-   ![Create a new service account][create-new-service-account]
-
-   ![Create a new service account With Existing Keys][create-new-service-account-existing-keys]
-
-   Find the "Add credentials" drop down and select "Service account" to be
-   guided through downloading a new JSON key file.
+   Find the "Create credentials" drop down near the top of the page, and select
+   "Service account" to be guided through downloading a new JSON key file.
 
    If you want to re-use an existing service account, you can easily generate a
-   new key file. Just select the account you wish to re-use, and click "Generate
-   new JSON key":
-
-   ![Re-use an existing service account][reuse-service-account]
+   new key file. Just select the account you wish to re-use, click the pencil
+   tool on the right side to edit the service account, select the **Keys** tab,
+   and then select **Add Key**.
 
    The key file you download will be used by this library to authenticate API
    requests and should be stored in a secure location.

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

@@ -20,7 +20,7 @@
 module Google
   module Cloud
     module Retail
-      VERSION = "1.0.1"
+      VERSION = "1.1.2"
     end
   end
 end

data/lib/google/cloud/retail.rb

@@ -74,6 +74,40 @@ module Google
         package_module.const_get(:CatalogService).const_get(:Client).new(&block)
       end
 
+      ##
+      # Create a new client object for CompletionService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Retail::V2::CompletionService::Client](https://googleapis.dev/ruby/google-cloud-retail-v2/latest/Google/Cloud/Retail/V2/CompletionService/Client.html)
+      # for version V2 of the API.
+      # However, you can specify specify a different API version by passing it in the
+      # `version` parameter. If the CompletionService service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      #
+      # ## About CompletionService
+      #
+      # Auto-completion service for retail.
+      #
+      # This feature is only available for users who have Retail Search enabled.
+      # Please submit a form [here](https://cloud.google.com/contact) to contact
+      # cloud sales if you are interested in using Retail Search.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @return [CompletionService::Client] A client object for the specified version.
+      #
+      def self.completion_service version: :v2, &block
+        require "google/cloud/retail/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::Retail
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        package_module = Google::Cloud::Retail.const_get package_name
+        package_module.const_get(:CompletionService).const_get(:Client).new(&block)
+      end
+
       ##
       # Create a new client object for PredictionService.
       #
@@ -135,6 +169,40 @@ module Google
         package_module.const_get(:ProductService).const_get(:Client).new(&block)
       end
 
+      ##
+      # Create a new client object for SearchService.
+      #
+      # By default, this returns an instance of
+      # [Google::Cloud::Retail::V2::SearchService::Client](https://googleapis.dev/ruby/google-cloud-retail-v2/latest/Google/Cloud/Retail/V2/SearchService/Client.html)
+      # for version V2 of the API.
+      # However, you can specify specify a different API version by passing it in the
+      # `version` parameter. If the SearchService service is
+      # supported by that API version, and the corresponding gem is available, the
+      # appropriate versioned client will be returned.
+      #
+      # ## About SearchService
+      #
+      # Service for search.
+      #
+      # This feature is only available for users who have Retail Search enabled.
+      # Please submit a form [here](https://cloud.google.com/contact) to contact
+      # cloud sales if you are interested in using Retail Search.
+      #
+      # @param version [::String, ::Symbol] The API version to connect to. Optional.
+      #   Defaults to `:v2`.
+      # @return [SearchService::Client] A client object for the specified version.
+      #
+      def self.search_service version: :v2, &block
+        require "google/cloud/retail/#{version.to_s.downcase}"
+
+        package_name = Google::Cloud::Retail
+                       .constants
+                       .select { |sym| sym.to_s.downcase == version.to_s.downcase.tr("_", "") }
+                       .first
+        package_module = Google::Cloud::Retail.const_get package_name
+        package_module.const_get(:SearchService).const_get(:Client).new(&block)
+      end
+
       ##
       # Create a new client object for UserEventService.
       #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-retail
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.2
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-30 00:00:00.000000000 Z
+date: 2022-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -30,7 +30,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -40,7 +40,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0.3'
+        version: '0.4'
     - - "<"
       - !ruby/object:Gem::Version
         version: 2.a
@@ -190,7 +190,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.17
+rubygems_version: 3.3.4
 signing_key: 
 specification_version: 4
 summary: API Client library for the Retail API