google-cloud-vision 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 264c4bec187e3b7f07a1071352e54a7d41052349
-  data.tar.gz: 78d4f95902e26bd2d78d95e84cf0f8775fcc1d42
+SHA256:
+  metadata.gz: 2c09d8049f20a5c93eb8bd360bf9342829812606be35eec929e2c87abdb4758f
+  data.tar.gz: dda3ffc1e2ea698d2e0e14d6904378a5ad9c4dd7d6fd7e556a1003b07c41d632
 SHA512:
-  metadata.gz: 433215101554848c5ba0ea8f55a0ae6524772d61eedfca5087cf3053946bcf196b14046778833b2833d8bd57de04fdcfda8f2ed72c393c6247679c886b99d611
-  data.tar.gz: d3aae9451019ece567eacbc30e6b81bca5c2303e3afe648795ccdbad4ae796c89106a3b526e00f21631ece6fd7d262bec04e446651bca853618e2f0255716883
+  metadata.gz: b23ca2e917b9313c5aa8933ddd861b854cb036161b25d6db7d23da1ab80651908e7117a6e4ccaa59654a250916939655d92ec11a3a961f68a121cf3cb9b2e81f
+  data.tar.gz: ec7ed02b242c7fa31255a0f20b39da2450fef2a1964e85bce8a2b7fc062d991529979163b7743fd730b96332a3869e50e1e97eb518cbd2fe53483706eeb1c672

data/lib/google-cloud-vision.rb

@@ -13,9 +13,9 @@
 # limitations under the License.
 
 ##
-# This file is here to be autorequired by bundler, so that the .bigquery and
-# #bigquery methods can be available, but the library and all dependencies won't
-# be loaded until required and used.
+# This file is here to be autorequired by bundler, so that the
+# Google::Cloud.vision and Google::Cloud#vision methods can be available, but
+# the library and all dependencies won't be loaded until required and used.
 
 
 gem "google-cloud-core"
@@ -69,10 +69,12 @@ module Google
     # Creates a new object for connecting to the Vision service.
     # Each call creates a new connection.
     #
-    # @param [String] project Project identifier for the Vision service you are
-    #   connecting to.
-    # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
-    #   file path the file must be readable.
+    # @param [String] project_id Project identifier for the Vision service you
+    #   are connecting to. If not present, the default project for the
+    #   credentials is used.
+    # @param [String, Hash, Google::Auth::Credentials] credentials The path to
+    #   the keyfile as a String, the contents of the keyfile as a Hash, or a
+    #   Google::Auth::Credentials object. (See {Vision::Credentials})
     # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
     #   set of resources and operations that the connection can access. See
     #   [Using OAuth 2.0 to Access Google
@@ -97,10 +99,11 @@ module Google
     #   landmark = image.landmark
     #   landmark.description #=> "Mount Rushmore"
     #
-    def self.vision project = nil, keyfile = nil, scope: nil, timeout: nil,
-                    client_config: nil
+    def self.vision project_id = nil, credentials = nil, scope: nil,
+                    timeout: nil, client_config: nil
       require "google/cloud/vision"
-      Google::Cloud::Vision.new project: project, keyfile: keyfile,
+      Google::Cloud::Vision.new project_id: project_id,
+                                credentials: credentials,
                                 scope: scope, timeout: timeout,
                                 client_config: client_config
     end

data/lib/google/cloud/vision.rb

@@ -570,10 +570,12 @@ module Google
       # Creates a new object for connecting to the Vision service.
       # Each call creates a new connection.
       #
-      # @param [String] project Project identifier for the Vision service you
-      #   are connecting to.
-      # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If
-      #   file path the file must be readable.
+      # @param [String] project_id Project identifier for the Vision service you
+      #   are connecting to. If not present, the default project for the
+      #   credentials is used.
+      # @param [String, Hash, Google::Auth::Credentials] credentials The path to
+      #   the keyfile as a String, the contents of the keyfile as a Hash, or a
+      #   Google::Auth::Credentials object. (See {Vision::Credentials})
       # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling
       #   the set of resources and operations that the connection can access.
       #   See [Using OAuth 2.0 to Access Google
@@ -585,6 +587,9 @@ module Google
       # @param [Integer] timeout Default timeout to use in requests. Optional.
       # @param [Hash] client_config A hash of values to override the default
       #   behavior of the API client. Optional.
+      # @param [String] project Alias for the `project_id` argument. Deprecated.
+      # @param [String] keyfile Alias for the `credentials` argument.
+      #   Deprecated.
       #
       # @return [Google::Cloud::Vision::Project]
       #
@@ -598,23 +603,21 @@ module Google
       #   landmark = image.landmark
       #   landmark.description #=> "Mount Rushmore"
       #
-      def self.new project: nil, keyfile: nil, scope: nil, timeout: nil,
-                   client_config: nil
-        project ||= Google::Cloud::Vision::Project.default_project
-        project = project.to_s # Always cast to a string
-        fail ArgumentError, "project is missing" if project.empty?
+      def self.new project_id: nil, credentials: nil, scope: nil, timeout: nil,
+                   client_config: nil, project: nil, keyfile: nil
+        project_id ||= (project || Vision::Project.default_project_id)
+        project_id = project_id.to_s # Always cast to a string
+        fail ArgumentError, "project_id is missing" if project_id.empty?
 
-        if keyfile.nil?
-          credentials = Google::Cloud::Vision::Credentials.default scope: scope
-        else
-          credentials = Google::Cloud::Vision::Credentials.new \
-            keyfile, scope: scope
+        credentials ||= (keyfile || Vision::Credentials.default(scope: scope))
+        unless credentials.is_a? Google::Auth::Credentials
+          credentials = Vision::Credentials.new credentials, scope: scope
         end
 
-        Google::Cloud::Vision::Project.new(
-          Google::Cloud::Vision::Service.new(
-            project, credentials, timeout: timeout,
-                                  client_config: client_config))
+        Vision::Project.new(
+          Vision::Service.new(
+            project_id, credentials, timeout: timeout,
+                                     client_config: client_config))
       end
     end
   end

data/lib/google/cloud/vision/annotation/text.rb

@@ -290,6 +290,7 @@ module Google
             # @return [Array<Language>]
             #
             def languages
+              return [] if @grpc.property.nil?
               @languages ||= Array(@grpc.property.detected_languages).map do |l|
                 Language.from_grpc l
               end
@@ -301,6 +302,7 @@ module Google
             # @return [::Symbol]
             #
             def break_type
+              return nil if @grpc.property.nil?
               @grpc.property.detected_break &&
                 @grpc.property.detected_break.type.to_sym
             end
@@ -311,6 +313,7 @@ module Google
             # @return [Boolean]
             #
             def prefix_break?
+              return nil if @grpc.property.nil?
               @grpc.property.detected_break &&
                 @grpc.property.detected_break.is_prefix
             end
@@ -411,6 +414,7 @@ module Google
               # @return [Array<Language>]
               #
               def languages
+                return [] if @grpc.property.nil?
                 detected_languages = @grpc.property.detected_languages
                 @languages ||= Array(detected_languages).map do |l|
                   Language.from_grpc l
@@ -423,6 +427,7 @@ module Google
               # @return [::Symbol]
               #
               def break_type
+                return nil if @grpc.property.nil?
                 @grpc.property.detected_break &&
                   @grpc.property.detected_break.type.to_sym
               end
@@ -433,6 +438,7 @@ module Google
               # @return [Boolean]
               #
               def prefix_break?
+                return nil if @grpc.property.nil?
                 @grpc.property.detected_break &&
                   @grpc.property.detected_break.is_prefix
               end
@@ -555,6 +561,7 @@ module Google
               # @return [Array<Language>]
               #
               def languages
+                return [] if @grpc.property.nil?
                 detected_languages = @grpc.property.detected_languages
                 @languages ||= Array(detected_languages).map do |l|
                   Language.from_grpc l
@@ -567,6 +574,7 @@ module Google
               # @return [::Symbol]
               #
               def break_type
+                return nil if @grpc.property.nil?
                 @grpc.property.detected_break &&
                   @grpc.property.detected_break.type.to_sym
               end
@@ -577,6 +585,7 @@ module Google
               # @return [Boolean]
               #
               def prefix_break?
+                return nil if @grpc.property.nil?
                 @grpc.property.detected_break &&
                   @grpc.property.detected_break.is_prefix
               end
@@ -688,6 +697,7 @@ module Google
               # @return [Array<Language>]
               #
               def languages
+                return [] if @grpc.property.nil?
                 detected_languages = @grpc.property.detected_languages
                 @languages ||= Array(detected_languages).map do |l|
                   Language.from_grpc l
@@ -700,6 +710,7 @@ module Google
               # @return [::Symbol]
               #
               def break_type
+                return nil if @grpc.property.nil?
                 @grpc.property.detected_break &&
                   @grpc.property.detected_break.type.to_sym
               end
@@ -710,6 +721,7 @@ module Google
               # @return [Boolean]
               #
               def prefix_break?
+                return nil if @grpc.property.nil?
                 @grpc.property.detected_break &&
                   @grpc.property.detected_break.is_prefix
               end
@@ -823,6 +835,7 @@ module Google
               # @return [Array<Language>]
               #
               def languages
+                return [] if @grpc.property.nil?
                 detected_languages = @grpc.property.detected_languages
                 @languages ||= Array(detected_languages).map do |l|
                   Language.from_grpc l
@@ -835,6 +848,7 @@ module Google
               # @return [::Symbol]
               #
               def break_type
+                return nil if @grpc.property.nil?
                 @grpc.property.detected_break &&
                   @grpc.property.detected_break.type.to_sym
               end
@@ -845,6 +859,7 @@ module Google
               # @return [Boolean]
               #
               def prefix_break?
+                return nil if @grpc.property.nil?
                 @grpc.property.detected_break &&
                   @grpc.property.detected_break.is_prefix
               end

data/lib/google/cloud/vision/credentials.rb

@@ -13,18 +13,44 @@
 # limitations under the License.
 
 
-require "google/cloud/credentials"
+require "googleauth"
 
 module Google
   module Cloud
     module Vision
       ##
-      # @private Represents the OAuth 2.0 signing logic for Vision.
-      class Credentials < Google::Cloud::Credentials
+      # # Credentials
+      #
+      # Represents the authentication and authorization used to connect to the
+      # Vision API.
+      #
+      # @example
+      #   require "google/cloud/vision"
+      #
+      #   keyfile = "/path/to/keyfile.json"
+      #   creds = Google::Cloud::Vision::Credentials.new keyfile
+      #
+      #   vision = Google::Cloud::Vision.new(
+      #     project_id: "my-project",
+      #     credentials: creds
+      #   )
+      #
+      #   vision.project_id #=> "my-project"
+      #
+      class Credentials < Google::Auth::Credentials
         SCOPE = ["https://www.googleapis.com/auth/cloud-platform"]
-        PATH_ENV_VARS = %w(VISION_KEYFILE GOOGLE_CLOUD_KEYFILE GCLOUD_KEYFILE)
-        JSON_ENV_VARS = %w(VISION_KEYFILE_JSON GOOGLE_CLOUD_KEYFILE_JSON
+        PATH_ENV_VARS = %w(VISION_CREDENTIALS
+                           VISION_KEYFILE
+                           GOOGLE_CLOUD_CREDENTIALS
+                           GOOGLE_CLOUD_KEYFILE
+                           GCLOUD_KEYFILE)
+        JSON_ENV_VARS = %w(VISION_CREDENTIALS_JSON
+                           VISION_KEYFILE_JSON
+                           GOOGLE_CLOUD_CREDENTIALS_JSON
+                           GOOGLE_CLOUD_KEYFILE_JSON
                            GCLOUD_KEYFILE_JSON)
+        DEFAULT_PATHS = \
+          ["~/.config/gcloud/application_default_credentials.json"]
       end
     end
   end

data/lib/google/cloud/vision/project.rb

@@ -63,19 +63,20 @@ module Google
         #   require "google/cloud/vision"
         #
         #   vision = Google::Cloud::Vision.new(
-        #     project: "my-todo-project",
-        #     keyfile: "/path/to/keyfile.json"
+        #     project_id: "my-project",
+        #     credentials: "/path/to/keyfile.json"
         #   )
         #
-        #   vision.project #=> "my-todo-project"
+        #   vision.project_id #=> "my-project"
         #
-        def project
+        def project_id
           service.project
         end
+        alias_method :project, :project_id
 
         ##
         # @private Default project.
-        def self.default_project
+        def self.default_project_id
           ENV["VISION_PROJECT"] ||
             ENV["GOOGLE_CLOUD_PROJECT"] ||
             ENV["GCLOUD_PROJECT"] ||

data/lib/google/cloud/vision/service.rb

@@ -25,37 +25,22 @@ module Google
       # @private
       # Represents the service to Vision, exposing the API calls.
       class Service
-        attr_accessor :project, :credentials, :host, :timeout, :client_config
+        attr_accessor :project, :credentials, :timeout, :client_config
 
         ##
         # Creates a new Service instance.
-        def initialize project, credentials, host: nil, timeout: nil,
-                       client_config: nil
+        def initialize project, credentials, timeout: nil, client_config: nil
           @project = project
           @credentials = credentials
-          @host = host || V1::ImageAnnotatorClient::SERVICE_ADDRESS
           @timeout = timeout
           @client_config = client_config || {}
         end
 
-        def channel
-          require "grpc"
-          GRPC::Core::Channel.new host, nil, chan_creds
-        end
-
-        def chan_creds
-          return credentials if insecure?
-          require "grpc"
-          GRPC::Core::ChannelCredentials.new.compose \
-            GRPC::Core::CallCredentials.new credentials.client.updater_proc
-        end
-
         def service
           return mocked_service if mocked_service
           @service ||= \
             V1::ImageAnnotatorClient.new(
-              service_path: host,
-              channel: channel,
+              credentials: credentials,
               timeout: timeout,
               client_config: client_config,
               lib_name: "gccl",
@@ -63,10 +48,6 @@ module Google
         end
         attr_accessor :mocked_service
 
-        def insecure?
-          credentials == :this_channel_is_insecure
-        end
-
         ##
         # Returns API::BatchAnnotateImagesResponse
         def annotate requests

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

@@ -1,4 +1,4 @@
-# Copyright 2016 Google Inc. All rights reserved.
+# Copyright 2017, Google Inc. All rights reserved.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -13,3 +13,115 @@
 # limitations under the License.
 
 require "google/cloud/vision/v1/image_annotator_client"
+
+module Google
+  module Cloud
+    # rubocop:disable LineLength
+
+    ##
+    # # Ruby Client for Google Cloud Vision API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    #
+    # [Google Cloud Vision API][Product Documentation]:
+    # Integrates Google Vision features, including image labeling, face, logo, and
+    # landmark detection, optical character recognition (OCR), and detection of
+    # explicit content, into applications.
+    # - [Product Documentation][]
+    #
+    # ## Quick Start
+    # In order to use this library, you first need to go through the following
+    # steps:
+    #
+    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+    # 2. [Enable the Google Cloud Vision API.](https://console.cloud.google.com/apis/api/vision)
+    # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Preview
+    # #### ImageAnnotatorClient
+    # ```rb
+    # require "google/cloud/vision/v1"
+    #
+    # image_annotator_client = Google::Cloud::Vision::V1.new
+    # gcs_image_uri = "gs://gapic-toolkit/President_Barack_Obama.jpg"
+    # source = { gcs_image_uri: gcs_image_uri }
+    # image = { source: source }
+    # type = :FACE_DETECTION
+    # features_element = { type: type }
+    # features = [features_element]
+    # requests_element = { image: image, features: features }
+    # requests = [requests_element]
+    # response = image_annotator_client.batch_annotate_images(requests)
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [Google Cloud Vision API Product documentation][Product Documentation]
+    #   to learn more about the product and see How-to Guides.
+    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+    #   to see the full list of Cloud APIs that we cover.
+    #
+    # [Product Documentation]: https://cloud.google.com/vision
+    #
+    #
+    module Vision
+      module V1
+        # rubocop:enable LineLength
+
+        ##
+        # Service that performs Google Cloud Vision API detection tasks over client
+        # images, such as face, landmark, logo, label, and text detection. The
+        # ImageAnnotator service returns detected entities from the images.
+        #
+        # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+        #   Provides the means for authenticating requests made by the client. This parameter can
+        #   be many types.
+        #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+        #   authenticating requests made by this client.
+        #   A `String` will be treated as the path to the keyfile to be used for the construction of
+        #   credentials for this client.
+        #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+        #   credentials for this client.
+        #   A `GRPC::Core::Channel` will be used to make calls through.
+        #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+        #   should already be composed with a `GRPC::Core::CallCredentials` object.
+        #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+        #   metadata for requests, generally, to give OAuth credentials.
+        # @param scopes [Array<String>]
+        #   The OAuth scopes for this service. This parameter is ignored if
+        #   an updater_proc is supplied.
+        # @param client_config [Hash]
+        #   A Hash for call options for each method. See
+        #   Google::Gax#construct_settings for the structure of
+        #   this data. Falls back to the default config if not specified
+        #   or the specified config is missing data points.
+        # @param timeout [Numeric]
+        #   The default timeout, in seconds, for calls made through this client.
+        def self.new \
+            service_path: nil,
+            port: nil,
+            channel: nil,
+            chan_creds: nil,
+            updater_proc: nil,
+            credentials: nil,
+            scopes: nil,
+            client_config: nil,
+            timeout: nil,
+            lib_name: nil,
+            lib_version: nil
+          kwargs = {
+            service_path: service_path,
+            port: port,
+            channel: channel,
+            chan_creds: chan_creds,
+            updater_proc: updater_proc,
+            credentials: credentials,
+            scopes: scopes,
+            client_config: client_config,
+            timeout: timeout,
+            lib_name: lib_name,
+            lib_version: lib_version
+          }.select { |_, v| v != nil }
+          Google::Cloud::Vision::V1::ImageAnnotatorClient.new(**kwargs)
+        end
+      end
+    end
+  end
+end

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

@@ -15,6 +15,17 @@
 module Google
   module Cloud
     module Vision
+      ##
+      # # Google Cloud Vision API Contents
+      #
+      # | Class | Description |
+      # | ----- | ----------- |
+      # | [ImageAnnotatorClient][] | Integrates Google Vision features, including image labeling, face, logo, and landmark detection, optical character recognition (OCR), and detection of explicit content, into applications. |
+      # | [Data Types][] | Data types for Google::Cloud::Vision::V1 |
+      #
+      # [ImageAnnotatorClient]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-vision/latest/google/cloud/vision/v1/imageannotatorclient
+      # [Data Types]: https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-vision/latest/google/cloud/vision/v1/datatypes
+      #
       module V1
         # Users describe the type of Google Cloud Vision API tasks to perform over
         # images by using *Feature*s. Each Feature indicates a type of image
@@ -71,16 +82,16 @@ module Google
         #     NOTE: For new code +image_uri+ below is preferred.
         #     Google Cloud Storage image URI, which must be in the following form:
         #     +gs://bucket_name/object_name+ (for details, see
-        #     {Google Cloud Storage Request
-        #     URIs}[https://cloud.google.com/storage/docs/reference-uris]).
+        #     [Google Cloud Storage Request
+        #     URIs](https://cloud.google.com/storage/docs/reference-uris)).
         #     NOTE: Cloud Storage object versioning is not supported.
         # @!attribute [rw] image_uri
         #   @return [String]
         #     Image URI which supports:
         #     1) Google Cloud Storage image URI, which must be in the following form:
         #     +gs://bucket_name/object_name+ (for details, see
-        #     {Google Cloud Storage Request
-        #     URIs}[https://cloud.google.com/storage/docs/reference-uris]).
+        #     [Google Cloud Storage Request
+        #     URIs](https://cloud.google.com/storage/docs/reference-uris)).
         #     NOTE: Cloud Storage object versioning is not supported.
         #     2) Publicly accessible image HTTP/HTTPS URL.
         #     This is preferred over the legacy +gcs_image_uri+ above. When both
@@ -308,7 +319,7 @@ module Google
         # @!attribute [rw] mid
         #   @return [String]
         #     Opaque entity ID. Some IDs may be available in
-        #     {Google Knowledge Graph Search API}[https://developers.google.com/knowledge-graph/].
+        #     [Google Knowledge Graph Search API](https://developers.google.com/knowledge-graph/).
         # @!attribute [rw] locale
         #   @return [String]
         #     The language code for the locale in which the entity textual
@@ -448,7 +459,7 @@ module Google
         #     setting a hint will help get better results (although it will be a
         #     significant hindrance if the hint is wrong). Text detection returns an
         #     error if one or more of the specified languages is not one of the
-        #     {supported languages}[https://cloud.google.com/vision/docs/languages].
+        #     [supported languages](https://cloud.google.com/vision/docs/languages).
         # @!attribute [rw] crop_hints_params
         #   @return [Google::Cloud::Vision::V1::CropHintsParams]
         #     Parameters for crop hints annotation request.

data/lib/google/cloud/vision/v1/doc/google/cloud/vision/v1/text_annotation.rb

@@ -21,7 +21,7 @@ module Google
         #     TextAnnotation -> Page -> Block -> Paragraph -> Word -> Symbol
         # Each structural component, starting from Page, may further have their own
         # properties. Properties describe detected languages, breaks etc.. Please
-        # refer to the Google::Cloud::Vision::V1::TextAnnotation::TextProperty message
+        # refer to the {Google::Cloud::Vision::V1::TextAnnotation::TextProperty} message
         # definition below for more detail.
         # @!attribute [rw] pages
         #   @return [Array<Google::Cloud::Vision::V1::Page>]
@@ -109,15 +109,15 @@ module Google
         #     is represented as around the top-left corner as defined when the text is
         #     read in the 'natural' orientation.
         #     For example:
-        #       * when the text is horizontal it might look like:
-        #          0----1
-        #          |    |
-        #          3----2
+        #     * when the text is horizontal it might look like:
+        #       0----1
+        #       |    |
+        #       3----2
         #       * when it's rotated 180 degrees around the top-left corner it becomes:
-        #          2----3
-        #          |    |
-        #          1----0
-        #       and the vertice order will still be (0, 1, 2, 3).
+        #         2----3
+        #         |    |
+        #         1----0
+        #         and the vertice order will still be (0, 1, 2, 3).
         # @!attribute [rw] paragraphs
         #   @return [Array<Google::Cloud::Vision::V1::Paragraph>]
         #     List of paragraphs in this block (if this blocks is of type text).
@@ -159,15 +159,15 @@ module Google
         #     is represented as around the top-left corner as defined when the text is
         #     read in the 'natural' orientation.
         #     For example:
-        #       * when the text is horizontal it might look like:
-        #          0----1
-        #          |    |
-        #          3----2
+        #     * when the text is horizontal it might look like:
+        #       0----1
+        #       |    |
+        #       3----2
         #       * when it's rotated 180 degrees around the top-left corner it becomes:
-        #          2----3
-        #          |    |
-        #          1----0
-        #       and the vertice order will still be (0, 1, 2, 3).
+        #         2----3
+        #         |    |
+        #         1----0
+        #         and the vertice order will still be (0, 1, 2, 3).
         # @!attribute [rw] words
         #   @return [Array<Google::Cloud::Vision::V1::Word>]
         #     List of words in this paragraph.
@@ -185,15 +185,15 @@ module Google
         #     is represented as around the top-left corner as defined when the text is
         #     read in the 'natural' orientation.
         #     For example:
-        #       * when the text is horizontal it might look like:
-        #          0----1
-        #          |    |
-        #          3----2
+        #     * when the text is horizontal it might look like:
+        #       0----1
+        #       |    |
+        #       3----2
         #       * when it's rotated 180 degrees around the top-left corner it becomes:
-        #          2----3
-        #          |    |
-        #          1----0
-        #       and the vertice order will still be (0, 1, 2, 3).
+        #         2----3
+        #         |    |
+        #         1----0
+        #         and the vertice order will still be (0, 1, 2, 3).
         # @!attribute [rw] symbols
         #   @return [Array<Google::Cloud::Vision::V1::Symbol>]
         #     List of symbols in the word.
@@ -212,15 +212,15 @@ module Google
         #     is represented as around the top-left corner as defined when the text is
         #     read in the 'natural' orientation.
         #     For example:
-        #       * when the text is horizontal it might look like:
-        #          0----1
-        #          |    |
-        #          3----2
+        #     * when the text is horizontal it might look like:
+        #       0----1
+        #       |    |
+        #       3----2
         #       * when it's rotated 180 degrees around the top-left corner it becomes:
-        #          2----3
-        #          |    |
-        #          1----0
-        #       and the vertice order will still be (0, 1, 2, 3).
+        #         2----3
+        #         |    |
+        #         1----0
+        #         and the vertice order will still be (0, 1, 2, 3).
         # @!attribute [rw] text
         #   @return [String]
         #     The actual UTF-8 representation of the symbol.

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

@@ -49,6 +49,16 @@ module Google
     #       any.Unpack(foo)
     #       ...
     #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := ptypes.MarshalAny(foo)
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #        ...
+    #      }
+    #
     # The pack methods provided by protobuf library will by default use
     # 'type.googleapis.com/full.type.name' as the type URL and the unpack
     # methods only use the fully qualified type name after the last '/'
@@ -77,7 +87,7 @@ module Google
     # If the embedded message type is well-known and has a custom JSON
     # representation, that representation will be embedded adding a field
     # +value+ which holds the custom JSON in addition to the +@type+
-    # field. Example (for message Google::Protobuf::Duration):
+    # field. Example (for message {Google::Protobuf::Duration}):
     #
     #     {
     #       "@type": "type.googleapis.com/google.protobuf.Duration",
@@ -96,7 +106,7 @@ module Google
     #       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).
-    #     * An HTTP GET on the URL must yield a Google::Protobuf::Type
+    #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
     #       value in binary format, or produce an error.
     #     * Applications are allowed to cache lookup results based on the
     #       URL, or have them precompiled into a binary to avoid any

data/lib/google/cloud/vision/v1/doc/google/rpc/status.rb

@@ -16,22 +16,22 @@ module Google
   module Rpc
     # The +Status+ type defines a logical error model that is suitable for different
     # programming environments, including REST APIs and RPC APIs. It is used by
-    # {gRPC}[https://github.com/grpc]. The error model is designed to be:
+    # [gRPC](https://github.com/grpc). The error model is designed to be:
     #
-    # - Simple to use and understand for most users
-    # - Flexible enough to meet unexpected needs
+    # * Simple to use and understand for most users
+    # * Flexible enough to meet unexpected needs
     #
     # = Overview
     #
     # The +Status+ message contains three pieces of data: error code, error message,
     # and error details. The error code should be an enum value of
-    # Google::Rpc::Code, but it may accept additional error codes if needed.  The
+    # {Google::Rpc::Code}, but it may accept additional error codes if needed.  The
     # error message should be a developer-facing English message that helps
     # developers *understand* and *resolve* the error. If a localized user-facing
     # error message is needed, put the localized message in the error details or
     # localize it in the client. The optional error details may contain arbitrary
     # information about the error. There is a predefined set of error detail types
-    # in the package +google.rpc+ which can be used for common error conditions.
+    # in the package +google.rpc+ that can be used for common error conditions.
     #
     # = Language mapping
     #
@@ -49,35 +49,35 @@ module Google
     #
     # Example uses of this error model include:
     #
-    # - Partial errors. If a service needs to return partial errors to the client,
-    #     it may embed the +Status+ in the normal response to indicate the partial
-    #     errors.
+    # * Partial errors. If a service needs to return partial errors to the client,
+    #   it may embed the +Status+ in the normal response to indicate the partial
+    #   errors.
     #
-    # - Workflow errors. A typical workflow has multiple steps. Each step may
-    #     have a +Status+ message for error reporting purpose.
+    # * Workflow errors. A typical workflow has multiple steps. Each step may
+    #   have a +Status+ message for error reporting.
     #
-    # - Batch operations. If a client uses batch request and batch response, the
-    #     +Status+ message should be used directly inside batch response, one for
-    #     each error sub-response.
+    # * Batch operations. If a client uses batch request and batch response, the
+    #   +Status+ message should be used directly inside batch response, one for
+    #   each error sub-response.
     #
-    # - Asynchronous operations. If an API call embeds asynchronous operation
-    #     results in its response, the status of those operations should be
-    #     represented directly using the +Status+ message.
+    # * Asynchronous operations. If an API call embeds asynchronous operation
+    #   results in its response, the status of those operations should be
+    #   represented directly using the +Status+ message.
     #
-    # - Logging. If some API errors are stored in logs, the message +Status+ could
-    #     be used directly after any stripping needed for security/privacy reasons.
+    # * Logging. If some API errors are stored in logs, the message +Status+ could
+    #   be used directly after any stripping needed for security/privacy reasons.
     # @!attribute [rw] code
     #   @return [Integer]
-    #     The status code, which should be an enum value of Google::Rpc::Code.
+    #     The status code, which should be an enum value of {Google::Rpc::Code}.
     # @!attribute [rw] message
     #   @return [String]
     #     A developer-facing error message, which should be in English. Any
     #     user-facing error message should be localized and sent in the
-    #     Google::Rpc::Status#details field, or localized by the client.
+    #     {Google::Rpc::Status#details} field, or localized by the client.
     # @!attribute [rw] details
     #   @return [Array<Google::Protobuf::Any>]
-    #     A list of messages that carry the error details.  There will be a
-    #     common set of message types for APIs to use.
+    #     A list of messages that carry the error details.  There is a common set of
+    #     message types for APIs to use.
     class Status; end
   end
 end

data/lib/google/cloud/vision/v1/doc/overview.rb

@@ -0,0 +1,72 @@
+# Copyright 2017, Google Inc. All rights reserved.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Cloud
+    # rubocop:disable LineLength
+
+    ##
+    # # Ruby Client for Google Cloud Vision API ([Alpha](https://github.com/GoogleCloudPlatform/google-cloud-ruby#versioning))
+    #
+    # [Google Cloud Vision API][Product Documentation]:
+    # Integrates Google Vision features, including image labeling, face, logo, and
+    # landmark detection, optical character recognition (OCR), and detection of
+    # explicit content, into applications.
+    # - [Product Documentation][]
+    #
+    # ## Quick Start
+    # In order to use this library, you first need to go through the following
+    # steps:
+    #
+    # 1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project)
+    # 2. [Enable the Google Cloud Vision API.](https://console.cloud.google.com/apis/api/vision)
+    # 3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud/master/guides/authentication)
+    #
+    # ### Installation
+    # ```
+    # $ gem install google-cloud-vision
+    # ```
+    #
+    # ### Preview
+    # #### ImageAnnotatorClient
+    # ```rb
+    # require "google/cloud/vision"
+    #
+    # image_annotator_client = Google::Cloud::Vision.new
+    # gcs_image_uri = "gs://gapic-toolkit/President_Barack_Obama.jpg"
+    # source = { gcs_image_uri: gcs_image_uri }
+    # image = { source: source }
+    # type = :FACE_DETECTION
+    # features_element = { type: type }
+    # features = [features_element]
+    # requests_element = { image: image, features: features }
+    # requests = [requests_element]
+    # response = image_annotator_client.batch_annotate_images(requests)
+    # ```
+    #
+    # ### Next Steps
+    # - Read the [Google Cloud Vision API Product documentation][Product Documentation]
+    #   to learn more about the product and see How-to Guides.
+    # - View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-ruby/blob/master/README.md)
+    #   to see the full list of Cloud APIs that we cover.
+    #
+    # [Product Documentation]: https://cloud.google.com/vision
+    #
+    #
+    module Vision
+      module V1
+      end
+    end
+  end
+end

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

@@ -28,6 +28,7 @@ require "pathname"
 require "google/gax"
 
 require "google/cloud/vision/v1/image_annotator_pb"
+require "google/cloud/vision/credentials"
 
 module Google
   module Cloud
@@ -53,18 +54,28 @@ module Google
           # The scopes needed to make gRPC calls to all of the methods defined in
           # this service.
           ALL_SCOPES = [
-            "https://www.googleapis.com/auth/cloud-platform"
+            "https://www.googleapis.com/auth/cloud-platform",
+            "https://www.googleapis.com/auth/cloud-vision"
           ].freeze
 
-          # @param service_path [String]
-          #   The domain name of the API remote host.
-          # @param port [Integer]
-          #   The port on which to connect to the remote host.
-          # @param channel [Channel]
-          #   A Channel object through which to make calls.
-          # @param chan_creds [Grpc::ChannelCredentials]
-          #   A ChannelCredentials for the setting up the RPC client.
-          # @param client_config[Hash]
+          # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
+          #   Provides the means for authenticating requests made by the client. This parameter can
+          #   be many types.
+          #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
+          #   authenticating requests made by this client.
+          #   A `String` will be treated as the path to the keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
+          #   credentials for this client.
+          #   A `GRPC::Core::Channel` will be used to make calls through.
+          #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
+          #   should already be composed with a `GRPC::Core::CallCredentials` object.
+          #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
+          #   metadata for requests, generally, to give OAuth credentials.
+          # @param scopes [Array<String>]
+          #   The OAuth scopes for this service. This parameter is ignored if
+          #   an updater_proc is supplied.
+          # @param client_config [Hash]
           #   A Hash for call options for each method. See
           #   Google::Gax#construct_settings for the structure of
           #   this data. Falls back to the default config if not specified
@@ -76,11 +87,11 @@ module Google
               port: DEFAULT_SERVICE_PORT,
               channel: nil,
               chan_creds: nil,
+              updater_proc: nil,
+              credentials: nil,
               scopes: ALL_SCOPES,
               client_config: {},
               timeout: DEFAULT_TIMEOUT,
-              app_name: nil,
-              app_version: nil,
               lib_name: nil,
               lib_version: ""
             # These require statements are intentionally placed here to initialize
@@ -89,14 +100,38 @@ module Google
             require "google/gax/grpc"
             require "google/cloud/vision/v1/image_annotator_services_pb"
 
+            if channel || chan_creds || updater_proc
+              warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
+                "on 2017/09/08"
+              credentials ||= channel
+              credentials ||= chan_creds
+              credentials ||= updater_proc
+            end
+            if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
+              warn "`service_path` and `port` parameters are deprecated and will be removed"
+            end
 
-            if app_name || app_version
-              warn "`app_name` and `app_version` are no longer being used in the request headers."
+            credentials ||= Google::Cloud::Vision::Credentials.default
+
+            if credentials.is_a?(String) || credentials.is_a?(Hash)
+              updater_proc = Google::Cloud::Vision::Credentials.new(credentials).updater_proc
+            end
+            if credentials.is_a?(GRPC::Core::Channel)
+              channel = credentials
+            end
+            if credentials.is_a?(GRPC::Core::ChannelCredentials)
+              chan_creds = credentials
+            end
+            if credentials.is_a?(Proc)
+              updater_proc = credentials
+            end
+            if credentials.is_a?(Google::Auth::Credentials)
+              updater_proc = credentials.updater_proc
             end
 
             google_api_client = "gl-ruby/#{RUBY_VERSION}"
             google_api_client << " #{lib_name}/#{lib_version}" if lib_name
-            google_api_client << " gapic/0.6.8 gax/#{Google::Gax::VERSION}"
+            google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
             google_api_client << " grpc/#{GRPC::VERSION}"
             google_api_client.freeze
 
@@ -120,6 +155,7 @@ module Google
               port,
               chan_creds: chan_creds,
               channel: channel,
+              updater_proc: updater_proc,
               scopes: scopes,
               &Google::Cloud::Vision::V1::ImageAnnotator::Stub.method(:new)
             )
@@ -134,28 +170,29 @@ module Google
 
           # Run image detection and annotation for a batch of images.
           #
-          # @param requests [Array<Google::Cloud::Vision::V1::AnnotateImageRequest>]
+          # @param requests [Array<Google::Cloud::Vision::V1::AnnotateImageRequest | Hash>]
           #   Individual image annotation requests for this batch.
+          #   A hash of the same form as `Google::Cloud::Vision::V1::AnnotateImageRequest`
+          #   can also be provided.
           # @param options [Google::Gax::CallOptions]
           #   Overrides the default settings for this call, e.g, timeout,
           #   retries, etc.
           # @return [Google::Cloud::Vision::V1::BatchAnnotateImagesResponse]
           # @raise [Google::Gax::GaxError] if the RPC is aborted.
           # @example
-          #   require "google/cloud/vision/v1/image_annotator_client"
-          #
-          #   ImageAnnotatorClient = Google::Cloud::Vision::V1::ImageAnnotatorClient
+          #   require "google/cloud/vision/v1"
           #
-          #   image_annotator_client = ImageAnnotatorClient.new
+          #   image_annotator_client = Google::Cloud::Vision::V1.new
           #   requests = []
           #   response = image_annotator_client.batch_annotate_images(requests)
 
           def batch_annotate_images \
               requests,
               options: nil
-            req = Google::Cloud::Vision::V1::BatchAnnotateImagesRequest.new({
+            req = {
               requests: requests
-            }.delete_if { |_, v| v.nil? })
+            }.delete_if { |_, v| v.nil? }
+            req = Google::Gax::to_proto(req, Google::Cloud::Vision::V1::BatchAnnotateImagesRequest)
             @batch_annotate_images.call(req, options)
           end
         end

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

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Vision
-      VERSION = "0.25.0"
+      VERSION = "0.26.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-vision
 version: !ruby/object:Gem::Version
-  version: 0.25.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-11 00:00:00.000000000 Z
+date: 2017-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -17,28 +17,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '1.1'
 - !ruby/object:Gem::Dependency
   name: google-gax
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.0
+        version: 0.10.1
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +203,7 @@ files:
 - lib/google/cloud/vision/v1/doc/google/rpc/status.rb
 - lib/google/cloud/vision/v1/doc/google/type/color.rb
 - lib/google/cloud/vision/v1/doc/google/type/latlng.rb
+- lib/google/cloud/vision/v1/doc/overview.rb
 - lib/google/cloud/vision/v1/geometry_pb.rb
 - lib/google/cloud/vision/v1/image_annotator_client.rb
 - lib/google/cloud/vision/v1/image_annotator_client_config.json
@@ -231,7 +232,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 2.7.2
 signing_key: 
 specification_version: 4
 summary: API Client library for Google Cloud Vision API