google-cloud-vision 0.31.0 → 0.32.0

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

@@ -1,98 +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.
-
-
-module Google
-  module Cloud
-    module Vision
-      ##
-      # # Location
-      #
-      # A latitude/longitude pair with values conforming to the [WGS84
-      # standard](http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf).
-      #
-      # @attr [Float] latitude The degrees latitude conforming to the [WGS84
-      #   standard](http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf).
-      # @attr [Float] longitude The degrees longitude conforming to the [WGS84
-      #   standard](http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf).
-      #
-      # @example
-      #   require "google/cloud/vision"
-      #
-      #   vision = Google::Cloud::Vision.new
-      #
-      #   image = vision.image "path/to/landmark.jpg"
-      #   entity = image.landmark
-      #
-      #   location = entity.locations.first
-      #
-      #   location.latitude #=> 43.878264
-      #   location.longitude #=> -103.45700740814209
-      #
-      class Location
-        attr_accessor :latitude, :longitude
-
-        ##
-        # @private Creates a new Location instance.
-        def initialize latitude, longitude
-          @latitude  = latitude
-          @longitude = longitude
-        end
-
-        ##
-        # Returns the object's property values as an array.
-        #
-        # @return [Array]
-        #
-        def to_a
-          [latitude, longitude]
-        end
-
-        ##
-        # Converts object to a hash. All keys will be symbolized.
-        #
-        # @return [Hash]
-        #
-        def to_h
-          { latitude: latitude, longitude: longitude }
-        end
-
-        # @private
-        def to_s
-          "(latitude: #{latitude.inspect}, longitude: #{longitude.inspect})"
-        end
-
-        # @private
-        def inspect
-          "#<#{self.class.name} #{self}>"
-        end
-
-        ##
-        # @private New GRPC LatLng object.
-        def to_grpc
-          Google::Type::LatLng.new(
-            latitude: latitude,
-            longitude: longitude
-          )
-        end
-
-        ##
-        # @private New Location from a GRPC LatLng object.
-        def self.from_grpc grpc
-          new grpc.latitude, grpc.longitude
-        end
-      end
-    end
-  end
-end

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

@@ -1,367 +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/errors"
-require "google/cloud/vision/service"
-require "google/cloud/vision/credentials"
-require "google/cloud/vision/annotate"
-require "google/cloud/vision/image"
-require "google/cloud/vision/annotation"
-
-module Google
-  module Cloud
-    module Vision
-      ##
-      # # Project
-      #
-      # Google Cloud Vision allows developers to easily integrate vision
-      # detection features within applications, including image labeling, face
-      # and landmark detection, optical character recognition (OCR), and tagging
-      # of explicit content.
-      #
-      # @example
-      #   require "google/cloud/vision"
-      #
-      #   vision = Google::Cloud::Vision.new
-      #
-      #   image = vision.image "path/to/landmark.jpg"
-      #
-      #   annotation = vision.annotate image, labels: true
-      #
-      #   annotation.labels.map &:description
-      #   # ["stone carving", "ancient history", "statue", "sculpture",
-      #   #  "monument", "landmark"]
-      #
-      # See Google::Cloud#vision
-      class Project
-        ##
-        # @private The Service object.
-        attr_accessor :service
-
-        ##
-        # @private Creates a new Project instance.
-        def initialize service
-          @service = service
-        end
-
-        # The Vision project connected to.
-        #
-        # @example
-        #   require "google/cloud/vision"
-        #
-        #   vision = Google::Cloud::Vision.new(
-        #     project_id: "my-project",
-        #     credentials: "/path/to/keyfile.json"
-        #   )
-        #
-        #   vision.project_id #=> "my-project"
-        #
-        def project_id
-          service.project
-        end
-        alias project project_id
-
-        ##
-        # Returns a new image from the given source.
-        #
-        # 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.
-        #
-        # Note that an object in Google Cloud Storage is a single entity;
-        # permissions affect only that object. "Directory permissions" do not
-        # exist (though default bucket permissions do exist). Make sure the code
-        # which performs your request has access to that image.
-        #
-        # @see https://cloud.google.com/vision/docs/best-practices Best
-        #   Practices
-        #
-        # @param [String, IO, StringIO, Tempfile, Google::Cloud::Storage::File]
-        #   source A string file path, publicly-accessible image HTTP/HTTPS URL,
-        #   or Cloud Storage URI of the form
-        #   `"gs://bucketname/path/to/image_filename"`; or a File, IO, StringIO,
-        #   or Tempfile instance; or an instance of
-        #   Google::Cloud::Storage::File.
-        #
-        # @return [Image] An image for the Vision service.
-        #
-        # @example With a publicly-accessible image HTTP/HTTPS URL:
-        #   require "google/cloud/vision"
-        #
-        #   vision = Google::Cloud::Vision.new
-        #
-        #   image = vision.image "https://www.example.com/images/landmark.jpg"
-        #
-        # @example With a Google Cloud Storage URI:
-        #   require "google/cloud/vision"
-        #
-        #   vision = Google::Cloud::Vision.new
-        #
-        #   image = vision.image "gs://bucket-name/path_to_image_object"
-        #
-        # @example With a local file path:
-        #   require "google/cloud/vision"
-        #
-        #   vision = Google::Cloud::Vision.new
-        #
-        #   image = vision.image "path/to/landmark.jpg"
-        #
-        def image source
-          return source if source.is_a? Image
-          Image.from_source source, self
-        end
-
-        ##
-        # Performs detection of Cloud Vision
-        # [features](https://cloud.google.com/vision/reference/rest/v1/images/annotate#Feature)
-        # on the given image(s). If no options for features are provided,
-        # **all** image detection features will be performed, with a default of
-        # `100` results for faces, landmarks, logos, labels, crop_hints, and
-        # web. 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 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}: A string file path, publicly-accessible image HTTP/HTTPS
-        #   URL, or Cloud Storage URI of the form
-        #   `"gs://bucketname/path/to/image_filename"`; or a File, IO, StringIO,
-        #   or Tempfile instance; or an instance of
-        #   Google::Cloud::Storage::File.
-        # @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 Whether to perform the
-        #   object localizations feature. Optional.
-        #
-        # @yield [annotate] A block for requests that involve multiple feature
-        #   configurations. See {Annotate#annotate}.
-        # @yieldparam [Annotate] annotate the Annotate object
-        #
-        # @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 With a single image:
-        #   require "google/cloud/vision"
-        #
-        #   vision = Google::Cloud::Vision.new
-        #
-        #   image = vision.image "path/to/landmark.jpg"
-        #
-        #   annotation = vision.annotate image, labels: true
-        #
-        #   annotation.labels.map &:description
-        #   # ["stone carving", "ancient history", "statue", "sculpture",
-        #   #  "monument", "landmark"]
-        #
-        # @example With multiple images:
-        #   require "google/cloud/vision"
-        #
-        #   vision = Google::Cloud::Vision.new
-        #
-        #   face_img = vision.image "path/to/face.jpg"
-        #   landmark_img = vision.image "path/to/landmark.jpg"
-        #
-        #   annotations = vision.annotate face_img, landmark_img, labels: true
-        #
-        #   annotations[0].labels.count #=> 4
-        #   annotations[1].labels.count #=> 6
-        #
-        # @example With multiple images and configurations passed in a block:
-        #   require "google/cloud/vision"
-        #
-        #   vision = Google::Cloud::Vision.new
-        #
-        #   face_img = vision.image "path/to/face.jpg"
-        #   landmark_img = vision.image "path/to/landmark.jpg"
-        #   text_image = vision.image "path/to/text.png"
-        #
-        #   annotations = vision.annotate do |annotate|
-        #      annotate.annotate face_img, faces: true, labels: true
-        #      annotate.annotate landmark_img, 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
-        #
-        # @example Maximum result values can also be provided:
-        #   require "google/cloud/vision"
-        #
-        #   vision = Google::Cloud::Vision.new
-        #
-        #   image = vision.image "path/to/landmark.jpg"
-        #
-        #   annotation = vision.annotate image, labels: 3
-        #
-        #   annotation.labels.map &:description
-        #   # ["stone carving", "ancient history", "statue"]
-        #
-        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
-          a = Annotate.new self
-          a.annotate(*images, faces: faces, landmarks: landmarks, logos: logos,
-                              labels: labels, text: text, document: document,
-                              safe_search: safe_search, properties: properties,
-                              crop_hints: crop_hints, web: web,
-                              object_localizations: object_localizations)
-
-          yield a if block_given?
-
-          grpc = service.annotate a.requests
-          annotations = Array(grpc.responses).map do |g|
-            raise Error.from_error(g.error) if g.error
-            Annotation.from_grpc g
-          end
-          return annotations.first if annotations.count == 1
-          annotations
-        end
-
-        # rubocop:disable LineLength
-
-        ##
-        # Run asynchronous image detection and annotation for a list of generic
-        # files, such as PDF files, which may contain multiple pages and
-        # multiple images per page. Progress and results can be retrieved
-        # through the google.longrunning.Operations interface.
-        # Operation.metadata contains OperationMetadata (metadata).
-        # Operation.response contains AsyncBatchAnnotateFilesResponse
-        # (results).
-        #
-        # @param requests [Array<Google::Cloud::Vision::V1::AsyncAnnotateFileRequest|Hash>]
-        #   Individual async file annotation requests for this batch.
-        #   A hash of the same form as
-        #     `Google::Cloud::Vision::V1::AsyncAnnotateFileRequest` can also be
-        #   provided.
-        # @param options [Google::Gax::CallOptions]
-        #   Overrides the default settings for this call, e.g, timeout,
-        #   retries, etc.
-        # @return [Google::Gax::Operation]
-        # @raise [Google::Gax::GaxError] if the RPC is aborted.
-        #
-        # @example
-        #   require "google/cloud/vision"
-        #
-        #   # Create a new vision client.
-        #   vision_client = Google::Cloud::Vision.new project_id: 'project_id'
-        #   requests = [{
-        #     input_config: {
-        #       gcs_source: { uri: 'source_uri' },
-        #       mime_type: "application/pdf"
-        #     },
-        #     features: [{ type: :DOCUMENT_TEXT_DETECTION }],
-        #     output_config: {
-        #       gcs_destination: { uri: 'destination_uri' },
-        #       batch_size: 2
-        #     }
-        #   }]
-        #
-        #   # Register a callback during the method call.
-        #   operation = vision_client
-        #     .async_batch_annotate_files(requests) do |op|
-        #     raise op.results.message if op.error?
-        #     op_results = op.results
-        #     # Process the results.
-        #
-        #     metadata = op.metadata
-        #     # Process the metadata.
-        #   end
-        #
-        #   # Or use the return value to register a callback.
-        #   operation.on_done do |op|
-        #     raise op.results.message if op.error?
-        #     op_results = op.results
-        #     # Process the results.
-        #
-        #     metadata = op.metadata
-        #     # Process the metadata.
-        #   end
-        #
-        #   # Manually reload the operation.
-        #   operation.reload!
-        #
-        #   # Or block until the operation completes, triggering callbacks on
-        #   # completion.
-        #   operation.wait_until_done!
-        #
-        def async_batch_annotate_files requests, options = {}
-          service.service.async_batch_annotate_files requests, options
-        end
-
-        # rubocop:enable LineLength
-
-        alias mark annotate
-        alias detect annotate
-
-        protected
-
-        ##
-        # Raise an error unless an active connection is available.
-        def ensure_service!
-          raise "Must have active connection" unless service
-        end
-      end
-    end
-  end
-end