google-cloud-vision-v1 0.6.0 → 0.6.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cef2b749ad95a501a0d721f0fb86fe5f0c984176df38c2935b455f885bc865a
-  data.tar.gz: 2d4decdb107d92d53eb7b90a567c2292bac09536c227e4122ec31f311dc25ee6
+  metadata.gz: 52910c7b44899ac515511259d2e2f8704b552366f38093ee450a5ca022c0620d
+  data.tar.gz: f85f6cc480ca2bd32b3f2ba3797d9425c1ff0b4641bbc113991620c882c8eefd
 SHA512:
-  metadata.gz: 77357648c7b0183fecbcb24a516cbf6c9acb013fb8a0c54a0e236db6c8dd5b25d9aea888993ea5fd9f0c7ae4a3b1985a609f6cc6e9323fb012a8eb12427f5b07
-  data.tar.gz: de32248085f957d85ffca1070e560ce668c07b65a8ba1189e8669e5bf23fb8d3ef9b5b4735cc574f78c2c28994015344f2b241a457a643c3d8e3b67b4a2ee622
+  metadata.gz: 92c418b56b69cf0ea77df5f5a7ff9f10f7910f54e01a3424efadd62001fd68516b9b0a6fd2c1d35940da1f5e6dd8ba71ec4852449f6677b90cef6b10a205431a
+  data.tar.gz: 3653dac03e49851aa508479463b5f6513324e7c0a8ba42970fb4260262ed75d027db497a5f341c1fc68a357c1c6f4d9ac5e63a67cc6ed1aa64fb2f460f18d9fd

data/.yardopts

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

data/AUTHENTICATION.md

@@ -66,11 +66,11 @@ The environment variables that google-cloud-vision-v1
 checks for credentials are configured on the service Credentials class (such as
 {::Google::Cloud::Vision::V1::ProductSearch::Credentials}):
 
-1. `VISION_CREDENTIALS` - Path to JSON file, or JSON contents
-2. `VISION_KEYFILE` - Path to JSON file, or JSON contents
-3. `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
-4. `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
-5. `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
+* `VISION_CREDENTIALS` - Path to JSON file, or JSON contents
+* `VISION_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_CREDENTIALS` - Path to JSON file, or JSON contents
+* `GOOGLE_CLOUD_KEYFILE` - Path to JSON file, or JSON contents
+* `GOOGLE_APPLICATION_CREDENTIALS` - Path to JSON file
 
 ```ruby
 require "google/cloud/vision/v1"
@@ -82,8 +82,8 @@ client = ::Google::Cloud::Vision::V1::ProductSearch::Client.new
 
 ### 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/vision/v1"
@@ -93,7 +93,7 @@ client = ::Google::Cloud::Vision::V1::ProductSearch::Client.new do |config|
 end
 ```
 
-Or configured globally for all clients:
+Or globally for all clients:
 
 ```ruby
 require "google/cloud/vision/v1"
@@ -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/README.md

@@ -33,7 +33,7 @@ In order to use this library, you first need to go through the following steps:
 require "google/cloud/vision/v1"
 
 client = ::Google::Cloud::Vision::V1::ProductSearch::Client.new
-request = my_create_request
+request = ::Google::Cloud::Vision::V1::CreateProductSetRequest.new # (request fields as keyword arguments...)
 response = client.create_product_set request
 ```
 

data/lib/google/cloud/vision/v1/geometry_pb.rb

@@ -1,9 +1,9 @@
 # Generated by the protocol buffer compiler.  DO NOT EDIT!
 # source: google/cloud/vision/v1/geometry.proto
 
+require 'google/api/annotations_pb'
 require 'google/protobuf'
 
-require 'google/api/annotations_pb'
 Google::Protobuf::DescriptorPool.generated_pool.build do
   add_file("google/cloud/vision/v1/geometry.proto", :syntax => :proto3) do
     add_message "google.cloud.vision.v1.Vertex" do

data/lib/google/cloud/vision/v1/image_annotator/client.rb

@@ -43,13 +43,12 @@ module Google
             # See {::Google::Cloud::Vision::V1::ImageAnnotator::Client::Configuration}
             # for a description of the configuration fields.
             #
-            # ## Example
+            # @example
             #
-            # To modify the configuration for all ImageAnnotator clients:
-            #
-            #     ::Google::Cloud::Vision::V1::ImageAnnotator::Client.configure do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Modify the configuration for all ImageAnnotator clients
+            #   ::Google::Cloud::Vision::V1::ImageAnnotator::Client.configure do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the Client client.
             # @yieldparam config [Client::Configuration]
@@ -69,34 +68,22 @@ module Google
 
                 default_config.rpcs.batch_annotate_images.timeout = 600.0
                 default_config.rpcs.batch_annotate_images.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.batch_annotate_files.timeout = 600.0
                 default_config.rpcs.batch_annotate_files.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.async_batch_annotate_images.timeout = 600.0
                 default_config.rpcs.async_batch_annotate_images.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config.rpcs.async_batch_annotate_files.timeout = 600.0
                 default_config.rpcs.async_batch_annotate_files.retry_policy = {
-                  initial_delay: 0.1,
-              max_delay: 60.0,
-              multiplier: 1.3,
-              retry_codes: [4, 14]
+                  initial_delay: 0.1, max_delay: 60.0, multiplier: 1.3, retry_codes: [4, 14]
                 }
 
                 default_config
@@ -128,19 +115,15 @@ module Google
             ##
             # Create a new ImageAnnotator client object.
             #
-            # ## Examples
-            #
-            # To create a new ImageAnnotator client with the default
-            # configuration:
+            # @example
             #
-            #     client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new
+            #   # Create a client using the default configuration
+            #   client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new
             #
-            # To create a new ImageAnnotator client with a custom
-            # configuration:
-            #
-            #     client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new do |config|
-            #       config.timeout = 10.0
-            #     end
+            #   # Create a client using a custom configuration
+            #   client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new do |config|
+            #     config.timeout = 10.0
+            #   end
             #
             # @yield [config] Configure the ImageAnnotator client.
             # @yieldparam config [Client::Configuration]
@@ -160,14 +143,13 @@ module Google
 
               # Create credentials
               credentials = @config.credentials
-              # Use self-signed JWT if the scope and endpoint are unchanged from default,
+              # Use self-signed JWT if the endpoint is unchanged from default,
               # but only if the default endpoint does not have a region prefix.
-              enable_self_signed_jwt = @config.scope == Client.configure.scope &&
-                                       @config.endpoint == Client.configure.endpoint &&
+              enable_self_signed_jwt = @config.endpoint == Client.configure.endpoint &&
                                        !@config.endpoint.split(".").first.include?("-")
               credentials ||= Credentials.default scope: @config.scope,
                                                   enable_self_signed_jwt: enable_self_signed_jwt
-              if credentials.is_a?(String) || credentials.is_a?(Hash)
+              if credentials.is_a?(::String) || credentials.is_a?(::Hash)
                 credentials = Credentials.new credentials, scope: @config.scope
               end
               @quota_project_id = @config.quota_project
@@ -175,6 +157,7 @@ module Google
 
               @operations_client = Operations.new do |config|
                 config.credentials = credentials
+                config.quota_project = @quota_project_id
                 config.endpoint = @config.endpoint
               end
 
@@ -238,6 +221,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/vision/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Vision::V1::BatchAnnotateImagesRequest.new
+            #
+            #   # Call the batch_annotate_images method.
+            #   result = client.batch_annotate_images request
+            #
+            #   # The returned object is of type Google::Cloud::Vision::V1::BatchAnnotateImagesResponse.
+            #   p result
+            #
             def batch_annotate_images request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -258,7 +256,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.batch_annotate_images.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.batch_annotate_images.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @image_annotator_stub.call_rpc :batch_annotate_images, request, options: options do |response, operation|
@@ -318,6 +318,21 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/vision/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Vision::V1::BatchAnnotateFilesRequest.new
+            #
+            #   # Call the batch_annotate_files method.
+            #   result = client.batch_annotate_files request
+            #
+            #   # The returned object is of type Google::Cloud::Vision::V1::BatchAnnotateFilesResponse.
+            #   p result
+            #
             def batch_annotate_files request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -338,7 +353,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.batch_annotate_files.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.batch_annotate_files.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @image_annotator_stub.call_rpc :batch_annotate_files, request, options: options do |response, operation|
@@ -401,6 +418,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/vision/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Vision::V1::AsyncBatchAnnotateImagesRequest.new
+            #
+            #   # Call the async_batch_annotate_images method.
+            #   result = client.async_batch_annotate_images request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def async_batch_annotate_images request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -421,7 +460,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.async_batch_annotate_images.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.async_batch_annotate_images.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @image_annotator_stub.call_rpc :async_batch_annotate_images, request, options: options do |response, operation|
@@ -480,6 +521,28 @@ module Google
             #
             # @raise [::Google::Cloud::Error] if the RPC is aborted.
             #
+            # @example Basic example
+            #   require "google/cloud/vision/v1"
+            #
+            #   # Create a client object. The client can be reused for multiple calls.
+            #   client = Google::Cloud::Vision::V1::ImageAnnotator::Client.new
+            #
+            #   # Create a request. To set request fields, pass in keyword arguments.
+            #   request = Google::Cloud::Vision::V1::AsyncBatchAnnotateFilesRequest.new
+            #
+            #   # Call the async_batch_annotate_files method.
+            #   result = client.async_batch_annotate_files request
+            #
+            #   # The returned object is of type Gapic::Operation. You can use this
+            #   # object to check the status of an operation, cancel it, or wait
+            #   # for results. Here is how to block until completion:
+            #   result.wait_until_done! timeout: 60
+            #   if result.response?
+            #     p result.response
+            #   else
+            #     puts "Error!"
+            #   end
+            #
             def async_batch_annotate_files request, options = nil
               raise ::ArgumentError, "request must be provided" if request.nil?
 
@@ -500,7 +563,9 @@ module Google
               options.apply_defaults timeout:      @config.rpcs.async_batch_annotate_files.timeout,
                                      metadata:     metadata,
                                      retry_policy: @config.rpcs.async_batch_annotate_files.retry_policy
-              options.apply_defaults metadata:     @config.metadata,
+
+              options.apply_defaults timeout:      @config.timeout,
+                                     metadata:     @config.metadata,
                                      retry_policy: @config.retry_policy
 
               @image_annotator_stub.call_rpc :async_batch_annotate_files, request, options: options do |response, operation|
@@ -525,22 +590,21 @@ module Google
             # Configuration can be applied globally to all clients, or to a single client
             # on construction.
             #
-            # # Examples
-            #
-            # To modify the global config, setting the timeout for batch_annotate_images
-            # to 20 seconds, and all remaining timeouts to 10 seconds:
-            #
-            #     ::Google::Cloud::Vision::V1::ImageAnnotator::Client.configure do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.batch_annotate_images.timeout = 20.0
-            #     end
-            #
-            # To apply the above configuration only to a new client:
-            #
-            #     client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new do |config|
-            #       config.timeout = 10.0
-            #       config.rpcs.batch_annotate_images.timeout = 20.0
-            #     end
+            # @example
+            #
+            #   # Modify the global config, setting the timeout for
+            #   # batch_annotate_images to 20 seconds,
+            #   # and all remaining timeouts to 10 seconds.
+            #   ::Google::Cloud::Vision::V1::ImageAnnotator::Client.configure do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.batch_annotate_images.timeout = 20.0
+            #   end
+            #
+            #   # Apply the above configuration only to a new client.
+            #   client = ::Google::Cloud::Vision::V1::ImageAnnotator::Client.new do |config|
+            #     config.timeout = 10.0
+            #     config.rpcs.batch_annotate_images.timeout = 20.0
+            #   end
             #
             # @!attribute [rw] endpoint
             #   The hostname or hostname:port of the service endpoint.