google-cloud-vision 0.31.0 → 0.32.0

data/TROUBLESHOOTING.md

@@ -1,37 +0,0 @@
-# Troubleshooting
-
-## Where can I get more help?
-
-### Ask the Community
-
-If you have a question about how to use a Google Cloud client library in your
-project or are stuck in the Developer's console and don't know where to turn,
-it's possible your questions have already been addressed by the community.
-
-First, check out the appropriate tags on StackOverflow:
-  - [`google-cloud-platform+ruby+vision`][so-ruby]
-
-Next, try searching through the issues on GitHub:
-
-  - [`api:vision` issues][gh-search-ruby]
-
-Still nothing?
-
-### Ask the Developers
-
-If you're experiencing a bug with the code, or have an idea for how it can be
-improved, *please* create a new issue on GitHub so we can talk about it.
-
-  - [New issue][gh-ruby]
-
-Or, you can ask questions on the [Google Cloud Platform Slack][slack-ruby]. You
-can use the "ruby" channel for general Ruby questions, or use the
-"google-cloud-ruby" channel if you have questions about this gem in particular.
-
-[so-ruby]: http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby+vision
-
-[gh-search-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues?q=label%3A%22api%3A+vision%22
-
-[gh-ruby]: https://github.com/googlecloudplatform/google-cloud-ruby/issues/new
-
-[slack-ruby]: https://gcp-slack.appspot.com/

data/lib/google-cloud-vision.rb

@@ -1,146 +0,0 @@
-# Copyright 2016 Google LLC
-#
-# 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
-#
-#     https://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.
-
-
-##
-# 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"
-require "google/cloud" unless defined? Google::Cloud.new
-require "google/cloud/config"
-require "googleauth"
-
-module Google
-  module Cloud
-    ##
-    # Creates a new object for connecting to the Vision service.
-    # Each call creates a new connection.
-    #
-    # @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
-    #   APIs](https://developers.google.com/identity/protocols/OAuth2).
-    #
-    #   The default scope is:
-    #
-    #   * `https://www.googleapis.com/auth/cloud-platform`
-    # @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.
-    #
-    # @return [Google::Cloud::Vision::Project]
-    #
-    # @example
-    #   require "google/cloud"
-    #
-    #   gcloud = Google::Cloud.new
-    #   vision = gcloud.vision
-    #
-    #   image = vision.image "path/to/landmark.jpg"
-    #
-    #   landmark = image.landmark
-    #   landmark.description #=> "Mount Rushmore"
-    #
-    # @example The default scope can be overridden with the `scope` option:
-    #   require "google/cloud"
-    #
-    #   gcloud  = Google::Cloud.new
-    #   platform_scope = "https://www.googleapis.com/auth/cloud-platform"
-    #   vision = gcloud.vision scope: platform_scope
-    #
-    def vision scope: nil, timeout: nil, client_config: nil
-      Google::Cloud.vision @project, @keyfile, scope: scope,
-                                               timeout: (timeout || @timeout),
-                                               client_config: client_config
-    end
-
-    ##
-    # Creates a new object for connecting to the Vision service.
-    # Each call creates a new connection.
-    #
-    # @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
-    #   APIs](https://developers.google.com/identity/protocols/OAuth2).
-    #
-    #   The default scope is:
-    #
-    #   * `https://www.googleapis.com/auth/cloud-platform`
-    # @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.
-    #
-    # @return [Google::Cloud::Vision::Project]
-    #
-    # @example
-    #   require "google/cloud"
-    #
-    #   vision = Google::Cloud.vision
-    #
-    #   image = vision.image "path/to/landmark.jpg"
-    #
-    #   landmark = image.landmark
-    #   landmark.description #=> "Mount Rushmore"
-    #
-    def self.vision project_id = nil, credentials = nil, scope: nil,
-                    timeout: nil, client_config: nil
-      require "google/cloud/vision"
-      Google::Cloud::Vision.new project_id: project_id,
-                                credentials: credentials,
-                                scope: scope, timeout: timeout,
-                                client_config: client_config
-    end
-  end
-end
-
-# Set the default vision configuration
-Google::Cloud.configure.add_config! :vision do |config|
-  default_project = Google::Cloud::Config.deferred do
-    ENV["VISION_PROJECT"]
-  end
-  default_creds = Google::Cloud::Config.deferred do
-    Google::Cloud::Config.credentials_from_env(
-      "VISION_CREDENTIALS", "VISION_CREDENTIALS_JSON",
-      "VISION_KEYFILE", "VISION_KEYFILE_JSON"
-    )
-  end
-
-  config.add_field! :project_id, default_project, match: String, allow_nil: true
-  config.add_alias! :project, :project_id
-  config.add_field! :credentials, default_creds,
-                    match: [String, Hash, Google::Auth::Credentials],
-                    allow_nil: true
-  config.add_alias! :keyfile, :credentials
-  config.add_field! :scope, nil, match: [String, Array]
-  config.add_field! :timeout, nil, match: Integer
-  config.add_field! :client_config, nil, match: Hash
-  # Update the documentation on the Vision module methods when these
-  # defaults change.
-  config.add_field! :default_max_faces, 100
-  config.add_field! :default_max_landmarks, 100
-  config.add_field! :default_max_logos, 100
-  config.add_field! :default_max_labels, 100
-  config.add_field! :default_max_crop_hints, 100
-  config.add_field! :default_max_web, 100
-  config.add_field! :default_max_object_localizations, 100
-end

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

@@ -1,303 +0,0 @@
-# Copyright 2016 Google LLC
-#
-# 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
-#
-#     https://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.
-
-
-require "google/cloud/vision/image"
-
-module Google
-  module Cloud
-    module Vision
-      ##
-      # # Annotate
-      #
-      # Accumulates configuration for an image annotation request. Users
-      # describe the type of Google Cloud Vision API tasks to perform over
-      # images by configuring features such as `faces`, `landmarks`, `text`,
-      # etc. This configuration captures the Cloud Vision API vertical to
-      # operate on and the number of top-scoring results to return.
-      #
-      # See {Project#annotate}.
-      #
-      # @example
-      #   require "google/cloud/vision"
-      #
-      #   vision = Google::Cloud::Vision.new
-      #
-      #   face_image = vision.image "path/to/face.jpg"
-      #   landmark_image = vision.image "path/to/landmark.jpg"
-      #
-      #   annotations = vision.annotate do |annotate|
-      #      annotate.annotate face_image, faces: true, labels: true
-      #      annotate.annotate landmark_image, landmarks: true
-      #   end
-      #
-      #   annotations[0].faces.count #=> 1
-      #   annotations[0].labels.count #=> 4
-      #   annotations[1].landmarks.count #=> 1
-      #
-      class Annotate
-        # @private
-        attr_accessor :requests
-
-        ##
-        # @private Creates a new Annotate instance.
-        def initialize project
-          @project = project
-          @requests = []
-        end
-
-        ##
-        # Performs detection of Cloud Vision
-        # [features](https://cloud.google.com/vision/reference/rest/v1/images/annotate#Feature)
-        # on the given images. If no options for features are provided, **all**
-        # image detection features will be performed, with a default of `100`
-        # results for faces, landmarks, logos, and labels. If any feature option
-        # is provided, only the specified feature detections will be performed.
-        # Please review [Pricing](https://cloud.google.com/vision/docs/pricing)
-        # before use, as a separate charge is incurred for each feature
-        # performed on an image.
-        #
-        # Cloud Vision sets upper limits on file size as well as on the total
-        # combined size of all images in a request. Reducing your file size can
-        # significantly improve throughput; however, be careful not to reduce
-        # image quality in the process. See [Best Practices - Image
-        # Sizing](https://cloud.google.com/vision/docs/best-practices#image_sizing)
-        # for current file size limits.
-        #
-        # See {Project#annotate} for requests that do not involve multiple
-        # feature configurations.
-        #
-        # @see https://cloud.google.com/vision/docs/requests-and-responses Cloud
-        #   Vision API Requests and Responses
-        # @see https://cloud.google.com/vision/reference/rest/v1/images/annotate#AnnotateImageRequest
-        #   AnnotateImageRequest
-        # @see https://cloud.google.com/vision/docs/pricing Cloud Vision Pricing
-        #
-        # @param [Image, Object] images The image or images to annotate. This
-        #   can be an {Image} instance, or any other type that converts to an
-        #   {Image}. See {#image} for details.
-        # @param [Boolean, Integer] faces Whether to perform the facial
-        #   detection feature. The maximum number of results is configured in
-        #   {Google::Cloud::Vision.default_max_faces}, or may be provided here.
-        #   Optional.
-        # @param [Boolean, Integer] landmarks Whether to perform the landmark
-        #   detection feature. The maximum number of results is configured in
-        #   {Google::Cloud::Vision.default_max_landmarks}, or may be provided
-        #   here. Optional.
-        # @param [Boolean, Integer] logos Whether to perform the logo detection
-        #   feature. The maximum number of results is configured in
-        #   {Google::Cloud::Vision.default_max_logos}, or may be provided here.
-        #   Optional.
-        # @param [Boolean, Integer] labels Whether to perform the label
-        #   detection feature. The maximum number of results is configured in
-        #   {Google::Cloud::Vision.default_max_labels}, or may be provided here.
-        #   Optional.
-        # @param [Boolean] text Whether to perform the text detection feature
-        #   (OCR for shorter documents with sparse text). Optional.
-        # @param [Boolean] document Whether to perform the document text
-        #   detection feature (OCR for longer documents with dense text).
-        #   Optional.
-        # @param [Boolean] safe_search Whether to perform the safe search
-        #   feature. Optional.
-        # @param [Boolean] properties Whether to perform the image properties
-        #   feature (currently, the image's dominant colors.) Optional.
-        # @param [Boolean, Integer] crop_hints Whether to perform the crop hints
-        #   feature. Optional.
-        # @param [Boolean, Integer] web Whether to perform the web annotation
-        #   feature. Optional.
-        # @param [Boolean, Integer] object_localizations TODO! Optional.
-        #
-        # @return [Annotation, Array<Annotation>] The results for all image
-        #   detections, returned as a single {Annotation} instance for one
-        #   image, or as an array of {Annotation} instances, one per image, for
-        #   multiple images.
-        #
-        # @example
-        #   require "google/cloud/vision"
-        #
-        #   vision = Google::Cloud::Vision.new
-        #
-        #   face_image = vision.image "path/to/face.jpg"
-        #   landmark_image = vision.image "path/to/landmark.jpg"
-        #   text_image = vision.image "path/to/text.png"
-        #
-        #   annotations = vision.annotate do |annotate|
-        #      annotate.annotate face_image, faces: true, labels: true
-        #      annotate.annotate landmark_image, landmarks: true
-        #      annotate.annotate text_image, text: true
-        #   end
-        #
-        #   annotations[0].faces.count #=> 1
-        #   annotations[0].labels.count #=> 4
-        #   annotations[1].landmarks.count #=> 1
-        #   annotations[2].text.pages.count #=> 1
-        #
-        def annotate *images, faces: false, landmarks: false, logos: false,
-                     labels: false, text: false, document: false,
-                     safe_search: false, properties: false, crop_hints: false,
-                     web: false, object_localizations: false
-          add_requests(images, faces, landmarks, logos, labels, text, document,
-                       safe_search, properties, crop_hints, web,
-                       object_localizations)
-        end
-
-        protected
-
-        def image source
-          return source if source.is_a? Image
-          Image.from_source source, @project
-        end
-
-        def add_requests images, faces, landmarks, logos, labels, text,
-                         document, safe_search, properties, crop_hints, web,
-                         object_localizations
-          features = annotate_features(faces, landmarks, logos, labels, text,
-                                       document, safe_search, properties,
-                                       crop_hints, web, object_localizations)
-
-          Array(images).flatten.each do |img|
-            i = image(img)
-            @requests << Google::Cloud::Vision::V1::AnnotateImageRequest.new(
-              image: i.to_grpc,
-              features: features,
-              image_context: i.context.to_grpc
-            )
-          end
-        end
-
-        def annotate_features faces, landmarks, logos, labels, text, document,
-                              safe_search, properties, crop_hints, web,
-                              object_localizations
-          return default_features if default_features?(
-            faces, landmarks, logos, labels, text, document, safe_search,
-            properties, crop_hints, web, object_localizations
-          )
-
-          faces, landmarks, logos, labels, crop_hints, web, \
-            object_localizations = validate_max_args(
-              faces, landmarks, logos, labels, crop_hints, web,
-              object_localizations
-            )
-
-          f = value_features faces, landmarks, logos, labels, crop_hints, web,
-                             object_localizations
-          f + boolean_features(text, document, safe_search, properties)
-        end
-
-        def value_features faces, landmarks, logos, labels, crop_hints, web,
-                           object_localizations
-          [
-            value_feature(:FACE_DETECTION, faces),
-            value_feature(:LANDMARK_DETECTION, landmarks),
-            value_feature(:LOGO_DETECTION, logos),
-            value_feature(:LABEL_DETECTION, labels),
-            value_feature(:CROP_HINTS, crop_hints),
-            value_feature(:WEB_DETECTION, web),
-            value_feature(:OBJECT_LOCALIZATION, object_localizations)
-          ].compact
-        end
-
-        def value_feature type, value
-          return if value.zero?
-          feature type, value
-        end
-
-        def boolean_features text, document, safe_search, properties
-          [
-            boolean_feature(:TEXT_DETECTION, text),
-            boolean_feature(:DOCUMENT_TEXT_DETECTION, document),
-            boolean_feature(:SAFE_SEARCH_DETECTION, safe_search),
-            boolean_feature(:IMAGE_PROPERTIES, properties)
-          ].compact
-        end
-
-        def boolean_feature type, value
-          return unless value
-          feature type, 1
-        end
-
-        def feature type, max_results
-          Google::Cloud::Vision::V1::Feature.new(
-            type: type, max_results: max_results
-          )
-        end
-
-        def default_features? faces, landmarks, logos, labels, text, document,
-                              safe_search, properties, crop_hints, web,
-                              object_localizations
-          faces == false && landmarks == false && logos == false &&
-            labels == false && text == false && document == false &&
-            safe_search == false && properties == false &&
-            crop_hints == false && web == false && object_localizations == false
-        end
-
-        def default_features
-          [
-            feature(:FACE_DETECTION, Google::Cloud::Vision.default_max_faces),
-            feature(:LANDMARK_DETECTION,
-                    Google::Cloud::Vision.default_max_landmarks),
-            feature(:LOGO_DETECTION, Google::Cloud::Vision.default_max_logos),
-            feature(:LABEL_DETECTION,
-                    Google::Cloud::Vision.default_max_labels),
-            feature(:TEXT_DETECTION, 1),
-            feature(:DOCUMENT_TEXT_DETECTION, 1),
-            feature(:SAFE_SEARCH_DETECTION, 1),
-            feature(:IMAGE_PROPERTIES, 1),
-            feature(:CROP_HINTS, Google::Cloud::Vision.default_max_crop_hints),
-            feature(:WEB_DETECTION, Google::Cloud::Vision.default_max_web),
-            feature(:OBJECT_LOCALIZATION,
-                    Google::Cloud::Vision.default_max_object_localizations)
-          ]
-        end
-
-        def validate_max_args faces, landmarks, logos, labels, crop_hints, web,
-                              object_localizations
-          faces = validate_max_value(
-            faces, Google::Cloud::Vision.default_max_faces
-          )
-          landmarks = validate_max_value(
-            landmarks, Google::Cloud::Vision.default_max_landmarks
-          )
-          logos = validate_max_value(
-            logos, Google::Cloud::Vision.default_max_logos
-          )
-          labels = validate_max_value(
-            labels, Google::Cloud::Vision.default_max_labels
-          )
-          crop_hints = validate_max_value(
-            crop_hints, Google::Cloud::Vision.default_max_crop_hints
-          )
-          web = validate_max_value(
-            web, Google::Cloud::Vision.default_max_web
-          )
-          object_localizations = validate_max_value(
-            object_localizations,
-            Google::Cloud::Vision.default_max_object_localizations
-          )
-
-          [
-            faces, landmarks, logos, labels, crop_hints, web,
-            object_localizations
-          ]
-        end
-
-        def validate_max_value value, default_value
-          return value.to_int if value.respond_to? :to_int
-          return default_value if value
-          0 # not a number, not a truthy value
-        end
-      end
-    end
-  end
-end