google-cloud-video_intelligence 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdd61e269b6216532e99e3dba7b5ae4229b7957650cd7af157d842f969ae67b9
-  data.tar.gz: ef80336588e1e5dfd0e37590db5854c0c22d430b34a4099b3188d1db8cf12b94
+  metadata.gz: 3cea7a7a08418a38120bd66b96432731c50fa70b999f747ad44f5d44e049a5fc
+  data.tar.gz: 22f0012b527ac1c7f535809203337f956b2314dee943c8aae8aee737c890a01b
 SHA512:
-  metadata.gz: b97f0d7ad74918b4aa2dd80e46434e73b77dd161dda704bb0a0a8f9f643bbf75996e6c623d5ccdf304efc4a8e6f6e4b2fe61e157f0bed81e015655d1bbbc04b8
-  data.tar.gz: 0f15661d7151abe675920e02e39ed30891966eb6ba2707114964162a441c529288c2b2c4af416e5138edf088fa33e7c9d9ca5ec6bf36a8440ff256c1bb248119
+  metadata.gz: 85977dbd6f10fd19a4ea484590f181b5a5aa3f86bc7252a93b9af7dd921333ebf1a45ffce9071fa55e43c747554681c73198e2f49e8698892623aaed64a4a617
+  data.tar.gz: 5f22dc14d90a74a8adf86521a2098593227cda1c7ee535fd91ee481ae4e99dcf3f00a3c2213c70ca0039e9ee39c5ec182d9e4377b6e635d08c91aafed1bd4856

data/.yardopts

@@ -7,3 +7,5 @@
 ./lib/**/*.rb
 -
 README.md
+AUTHENTICATION.md
+LICENSE

data/AUTHENTICATION.md

@@ -0,0 +1,199 @@
+# Authentication
+
+In general, the google-cloud-video_intelligence library uses [Service
+Account](https://cloud.google.com/iam/docs/creating-managing-service-accounts)
+credentials to connect to Google Cloud services. When running within [Google
+Cloud Platform environments](#google-cloud-platform-environments)
+the credentials will be discovered automatically. When running on other
+environments, the Service Account credentials can be specified by providing the
+path to the [JSON
+keyfile](https://cloud.google.com/iam/docs/managing-service-account-keys) for
+the account (or the JSON itself) in [environment
+variables](#environment-variables). Additionally, Cloud SDK credentials can also
+be discovered automatically, but this is only recommended during development.
+
+## Quickstart
+
+1. [Create a service account and credentials](#creating-a-service-account).
+2. Set the [environment variable](#environment-variables).
+
+```sh
+export VIDEO_INTELLIGENCE_CREDENTIALS=/path/to/json`
+```
+
+3. Initialize the client.
+
+```ruby
+require "google/cloud/video_intelligence"
+
+client = Google::Cloud::VideoIntelligence.new
+```
+
+## Project and Credential Lookup
+
+The google-cloud-video_intelligence library aims to make authentication
+as simple as possible, and provides several mechanisms to configure your system
+without providing **Project ID** and **Service Account Credentials** directly in
+code.
+
+**Project ID** is discovered in the following order:
+
+1. Specify project ID in method arguments
+2. Specify project ID in configuration
+3. Discover project ID in environment variables
+4. Discover GCE project ID
+5. Discover project ID in credentials JSON
+
+**Credentials** are discovered in the following order:
+
+1. Specify credentials in method arguments
+2. Specify credentials in configuration
+3. Discover credentials path in environment variables
+4. Discover credentials JSON in environment variables
+5. Discover credentials file in the Cloud SDK's path
+6. Discover GCE credentials
+
+### Google Cloud Platform environments
+
+While running on Google Cloud Platform environments such as Google Compute
+Engine, Google App Engine and Google Kubernetes Engine, no extra work is needed.
+The **Project ID** and **Credentials** and are discovered automatically. Code
+should be written as if already authenticated. Just be sure when you [set up the
+GCE instance][gce-how-to], you add the correct scopes for the APIs you want to
+access. For example:
+
+  * **All APIs**
+    * `https://www.googleapis.com/auth/cloud-platform`
+    * `https://www.googleapis.com/auth/cloud-platform.read-only`
+  * **BigQuery**
+    * `https://www.googleapis.com/auth/bigquery`
+    * `https://www.googleapis.com/auth/bigquery.insertdata`
+  * **Compute Engine**
+    * `https://www.googleapis.com/auth/compute`
+  * **Datastore**
+    * `https://www.googleapis.com/auth/datastore`
+    * `https://www.googleapis.com/auth/userinfo.email`
+  * **DNS**
+    * `https://www.googleapis.com/auth/ndev.clouddns.readwrite`
+  * **Pub/Sub**
+    * `https://www.googleapis.com/auth/pubsub`
+  * **Storage**
+    * `https://www.googleapis.com/auth/devstorage.full_control`
+    * `https://www.googleapis.com/auth/devstorage.read_only`
+    * `https://www.googleapis.com/auth/devstorage.read_write`
+
+### Environment Variables
+
+The **Project ID** and **Credentials JSON** can be placed in environment
+variables instead of declaring them directly in code. Each service has its own
+environment variable, allowing for different service accounts to be used for
+different services. (See the READMEs for the individual service gems for
+details.) The path to the **Credentials JSON** file can be stored in the
+environment variable, or the **Credentials JSON** itself can be stored for
+environments such as Docker containers where writing files is difficult or not
+encouraged.
+
+The environment variables that google-cloud-video_intelligence checks for project ID are:
+
+1. `VIDEO_INTELLIGENCE_PROJECT`
+2. `GOOGLE_CLOUD_PROJECT`
+
+The environment variables that google-cloud-video_intelligence checks for credentials are configured on {Google::Cloud::VideoIntelligence::V1::Credentials}:
+
+1. `VIDEO_INTELLIGENCE_CREDENTIALS` - Path to JSON file, or JSON contents
+2. `VIDEO_INTELLIGENCE_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
+
+```ruby
+require "google/cloud/video_intelligence"
+
+ENV["VIDEO_INTELLIGENCE_PROJECT"]     = "my-project-id"
+ENV["VIDEO_INTELLIGENCE_CREDENTIALS"] = "path/to/keyfile.json"
+
+client = Google::Cloud::VideoIntelligence.new
+```
+
+### Configuration
+
+The **Project ID** and **Credentials JSON** can be configured instead of placing them in environment variables or providing them as arguments.
+
+```ruby
+require "google/cloud/video_intelligence"
+
+Google::Cloud::VideoIntelligence.configure do |config|
+  config.project_id  = "my-project-id"
+  config.credentials = "path/to/keyfile.json"
+end
+
+client = Google::Cloud::VideoIntelligence.new
+```
+
+### Cloud SDK
+
+This option allows for an easy way to authenticate during development. If
+credentials are not provided in code or in environment variables, then Cloud SDK
+credentials are discovered.
+
+To configure your system for this, simply:
+
+1. [Download and install the Cloud SDK](https://cloud.google.com/sdk)
+2. Authenticate using OAuth 2.0 `$ gcloud auth login`
+3. Write code as if already authenticated.
+
+**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 a **Project ID** and **Service Account Credentials** to
+connect to the APIs. You will use the **Project ID** and **JSON key file** to
+connect to most services with google-cloud-video_intelligence.
+
+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. Create a new project or click on an existing project.
+1. Activate the slide-out navigation tray and select **API Manager**. 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.*
+
+1. 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.
+
+   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]
+
+   The key file you download will be used by this library to authenticate API
+   requests and should be stored in a secure location.
+
+## Troubleshooting
+
+If you're having trouble authenticating you can ask for help by following the
+{file:TROUBLESHOOTING.md Troubleshooting Guide}.

data/README.md

@@ -24,13 +24,13 @@ $ gem install google-cloud-video_intelligence
 ```rb
 require "google/cloud/video_intelligence"
 
-video_intelligence_service_client = Google::Cloud::VideoIntelligence.new
+video_intelligence_client = Google::Cloud::VideoIntelligence.new
 input_uri = "gs://demomaker/cat.mp4"
 features_element = :LABEL_DETECTION
 features = [features_element]
 
 # Register a callback during the method call.
-operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: features) do |op|
+operation = video_intelligence_client.annotate_video(input_uri: input_uri, features: features) do |op|
   raise op.results.message if op.error?
   op_results = op.results
   # Process the results.

data/lib/google/cloud/video_intelligence.rb

@@ -46,13 +46,13 @@ module Google
     # ```rb
     # require "google/cloud/video_intelligence"
     #
-    # video_intelligence_service_client = Google::Cloud::VideoIntelligence.new
+    # video_intelligence_client = Google::Cloud::VideoIntelligence.new
     # input_uri = "gs://demomaker/cat.mp4"
     # features_element = :LABEL_DETECTION
     # features = [features_element]
     #
     # # Register a callback during the method call.
-    # operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: features) do |op|
+    # operation = video_intelligence_client.annotate_video(input_uri: input_uri, features: features) do |op|
     #   raise op.results.message if op.error?
     #   op_results = op.results
     #   # Process the results.

data/lib/google/cloud/video_intelligence/v1.rb

@@ -48,13 +48,13 @@ module Google
       # ```rb
       # require "google/cloud/video_intelligence"
       #
-      # video_intelligence_service_client = Google::Cloud::VideoIntelligence.new(version: :v1)
+      # video_intelligence_client = Google::Cloud::VideoIntelligence.new(version: :v1)
       # input_uri = "gs://demomaker/cat.mp4"
       # features_element = :LABEL_DETECTION
       # features = [features_element]
       #
       # # Register a callback during the method call.
-      # operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: features) do |op|
+      # operation = video_intelligence_client.annotate_video(input_uri: input_uri, features: features) do |op|
       #   raise op.results.message if op.error?
       #   op_results = op.results
       #   # Process the results.

data/lib/google/cloud/video_intelligence/v1/doc/google/longrunning/operations.rb

@@ -31,7 +31,7 @@ module Google
     # @!attribute [rw] done
     #   @return [true, false]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [Google::Rpc::Status]

data/lib/google/cloud/video_intelligence/v1/doc/google/protobuf/any.rb

@@ -97,7 +97,8 @@ module Google
     # @!attribute [rw] type_url
     #   @return [String]
     #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. The last segment of the URL's path must represent
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
     #     the fully qualified name of the type (as in
     #     `path/google.protobuf.Duration`). The name should be in a canonical form
     #     (e.g., leading "." is not accepted).

data/lib/google/cloud/video_intelligence/v1/video_intelligence_service_client.rb

@@ -230,13 +230,13 @@ module Google
           # @example
           #   require "google/cloud/video_intelligence"
           #
-          #   video_intelligence_service_client = Google::Cloud::VideoIntelligence.new(version: :v1)
+          #   video_intelligence_client = Google::Cloud::VideoIntelligence.new(version: :v1)
           #   input_uri = "gs://demomaker/cat.mp4"
           #   features_element = :LABEL_DETECTION
           #   features = [features_element]
           #
           #   # Register a callback during the method call.
-          #   operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: features) do |op|
+          #   operation = video_intelligence_client.annotate_video(input_uri: input_uri, features: features) do |op|
           #     raise op.results.message if op.error?
           #     op_results = op.results
           #     # Process the results.

data/lib/google/cloud/video_intelligence/v1beta1/doc/google/longrunning/operations.rb

@@ -31,7 +31,7 @@ module Google
     # @!attribute [rw] done
     #   @return [true, false]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [Google::Rpc::Status]

data/lib/google/cloud/video_intelligence/v1beta1/doc/google/protobuf/any.rb

@@ -97,7 +97,8 @@ module Google
     # @!attribute [rw] type_url
     #   @return [String]
     #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. The last segment of the URL's path must represent
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
     #     the fully qualified name of the type (as in
     #     `path/google.protobuf.Duration`). The name should be in a canonical form
     #     (e.g., leading "." is not accepted).

data/lib/google/cloud/video_intelligence/v1beta1/video_intelligence_service_client.rb

@@ -229,13 +229,13 @@ module Google
           # @example
           #   require "google/cloud/video_intelligence"
           #
-          #   video_intelligence_service_client = Google::Cloud::VideoIntelligence.new(version: :v1beta1)
+          #   video_intelligence_client = Google::Cloud::VideoIntelligence.new(version: :v1beta1)
           #   input_uri = "gs://demomaker/cat.mp4"
           #   features_element = :LABEL_DETECTION
           #   features = [features_element]
           #
           #   # Register a callback during the method call.
-          #   operation = video_intelligence_service_client.annotate_video(input_uri, features) do |op|
+          #   operation = video_intelligence_client.annotate_video(input_uri, features) do |op|
           #     raise op.results.message if op.error?
           #     op_results = op.results
           #     # Process the results.

data/lib/google/cloud/video_intelligence/v1beta2/doc/google/longrunning/operations.rb

@@ -31,7 +31,7 @@ module Google
     # @!attribute [rw] done
     #   @return [true, false]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [Google::Rpc::Status]

data/lib/google/cloud/video_intelligence/v1beta2/doc/google/protobuf/any.rb

@@ -97,7 +97,8 @@ module Google
     # @!attribute [rw] type_url
     #   @return [String]
     #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. The last segment of the URL's path must represent
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
     #     the fully qualified name of the type (as in
     #     `path/google.protobuf.Duration`). The name should be in a canonical form
     #     (e.g., leading "." is not accepted).

data/lib/google/cloud/video_intelligence/v1beta2/video_intelligence_service_client.rb

@@ -230,13 +230,13 @@ module Google
           # @example
           #   require "google/cloud/video_intelligence"
           #
-          #   video_intelligence_service_client = Google::Cloud::VideoIntelligence.new(version: :v1beta2)
+          #   video_intelligence_client = Google::Cloud::VideoIntelligence.new(version: :v1beta2)
           #   input_uri = "gs://demomaker/cat.mp4"
           #   features_element = :LABEL_DETECTION
           #   features = [features_element]
           #
           #   # Register a callback during the method call.
-          #   operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: features) do |op|
+          #   operation = video_intelligence_client.annotate_video(input_uri: input_uri, features: features) do |op|
           #     raise op.results.message if op.error?
           #     op_results = op.results
           #     # Process the results.

data/lib/google/cloud/video_intelligence/v1p1beta1.rb

@@ -48,13 +48,13 @@ module Google
       # ```rb
       # require "google/cloud/video_intelligence"
       #
-      # video_intelligence_service_client = Google::Cloud::VideoIntelligence.new(version: :v1p1beta1)
+      # video_intelligence_client = Google::Cloud::VideoIntelligence.new(version: :v1p1beta1)
       # input_uri = "gs://demomaker/cat.mp4"
       # features_element = :LABEL_DETECTION
       # features = [features_element]
       #
       # # Register a callback during the method call.
-      # operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: features) do |op|
+      # operation = video_intelligence_client.annotate_video(input_uri: input_uri, features: features) do |op|
       #   raise op.results.message if op.error?
       #   op_results = op.results
       #   # Process the results.

data/lib/google/cloud/video_intelligence/v1p1beta1/doc/google/longrunning/operations.rb

@@ -31,7 +31,7 @@ module Google
     # @!attribute [rw] done
     #   @return [true, false]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [Google::Rpc::Status]

data/lib/google/cloud/video_intelligence/v1p1beta1/doc/google/protobuf/any.rb

@@ -97,7 +97,8 @@ module Google
     # @!attribute [rw] type_url
     #   @return [String]
     #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. The last segment of the URL's path must represent
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
     #     the fully qualified name of the type (as in
     #     `path/google.protobuf.Duration`). The name should be in a canonical form
     #     (e.g., leading "." is not accepted).

data/lib/google/cloud/video_intelligence/v1p1beta1/video_intelligence_service_client.rb

@@ -230,13 +230,13 @@ module Google
           # @example
           #   require "google/cloud/video_intelligence"
           #
-          #   video_intelligence_service_client = Google::Cloud::VideoIntelligence.new(version: :v1p1beta1)
+          #   video_intelligence_client = Google::Cloud::VideoIntelligence.new(version: :v1p1beta1)
           #   input_uri = "gs://demomaker/cat.mp4"
           #   features_element = :LABEL_DETECTION
           #   features = [features_element]
           #
           #   # Register a callback during the method call.
-          #   operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: features) do |op|
+          #   operation = video_intelligence_client.annotate_video(input_uri: input_uri, features: features) do |op|
           #     raise op.results.message if op.error?
           #     op_results = op.results
           #     # Process the results.

data/lib/google/cloud/video_intelligence/v1p2beta1.rb

@@ -48,13 +48,13 @@ module Google
       # ```rb
       # require "google/cloud/video_intelligence"
       #
-      # video_intelligence_service_client = Google::Cloud::VideoIntelligence.new(version: :v1p2beta1)
+      # video_intelligence_client = Google::Cloud::VideoIntelligence.new(version: :v1p2beta1)
       # input_uri = "gs://demomaker/cat.mp4"
       # features_element = :LABEL_DETECTION
       # features = [features_element]
       #
       # # Register a callback during the method call.
-      # operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: features) do |op|
+      # operation = video_intelligence_client.annotate_video(input_uri: input_uri, features: features) do |op|
       #   raise op.results.message if op.error?
       #   op_results = op.results
       #   # Process the results.

data/lib/google/cloud/video_intelligence/v1p2beta1/doc/google/longrunning/operations.rb

@@ -31,7 +31,7 @@ module Google
     # @!attribute [rw] done
     #   @return [true, false]
     #     If the value is `false`, it means the operation is still in progress.
-    #     If true, the operation is completed, and either `error` or `response` is
+    #     If `true`, the operation is completed, and either `error` or `response` is
     #     available.
     # @!attribute [rw] error
     #   @return [Google::Rpc::Status]

data/lib/google/cloud/video_intelligence/v1p2beta1/doc/google/protobuf/any.rb

@@ -97,7 +97,8 @@ module Google
     # @!attribute [rw] type_url
     #   @return [String]
     #     A URL/resource name that uniquely identifies the type of the serialized
-    #     protocol buffer message. The last segment of the URL's path must represent
+    #     protocol buffer message. This string must contain at least
+    #     one "/" character. The last segment of the URL's path must represent
     #     the fully qualified name of the type (as in
     #     `path/google.protobuf.Duration`). The name should be in a canonical form
     #     (e.g., leading "." is not accepted).

data/lib/google/cloud/video_intelligence/v1p2beta1/video_intelligence_service_client.rb

@@ -230,13 +230,13 @@ module Google
           # @example
           #   require "google/cloud/video_intelligence"
           #
-          #   video_intelligence_service_client = Google::Cloud::VideoIntelligence.new(version: :v1p2beta1)
+          #   video_intelligence_client = Google::Cloud::VideoIntelligence.new(version: :v1p2beta1)
           #   input_uri = "gs://demomaker/cat.mp4"
           #   features_element = :LABEL_DETECTION
           #   features = [features_element]
           #
           #   # Register a callback during the method call.
-          #   operation = video_intelligence_service_client.annotate_video(input_uri: input_uri, features: features) do |op|
+          #   operation = video_intelligence_client.annotate_video(input_uri: input_uri, features: features) do |op|
           #     raise op.results.message if op.error?
           #     op_results = op.results
           #     # Process the results.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-video_intelligence
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - Google LLC
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-04 00:00:00.000000000 Z
+date: 2019-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-gax
@@ -102,6 +102,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".yardopts"
+- AUTHENTICATION.md
 - LICENSE
 - README.md
 - lib/google/cloud/video_intelligence.rb
@@ -179,8 +180,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: API Client library for Cloud Video Intelligence API