google-cloud-vision 0.20.2 → 0.21.0

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

@@ -31,10 +31,9 @@ module Google
       # See {Project#annotate}.
       #
       # @example
-      #   require "google/cloud"
+      #   require "google/cloud/vision"
       #
-      #   gcloud = Google::Cloud.new
-      #   vision = gcloud.vision
+      #   vision = Google::Cloud::Vision.new
       #
       #   face_image = vision.image "path/to/face.jpg"
       #   landmark_image = vision.image "path/to/landmark.jpg"
@@ -74,7 +73,7 @@ module Google
         # 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/image-best-practices#image_sizing)
+        # 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
@@ -118,10 +117,9 @@ module Google
         #   multiple images.
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #
         #   face_image = vision.image "path/to/face.jpg"
         #   landmark_image = vision.image "path/to/landmark.jpg"
@@ -159,10 +157,10 @@ module Google
 
           Array(images).flatten.each do |img|
             i = image(img)
-            @requests << Google::Apis::VisionV1::AnnotateImageRequest.new(
-              image: i.to_gapi,
+            @requests << Google::Cloud::Vision::V1::AnnotateImageRequest.new(
+              image: i.to_grpc,
               features: features,
-              imageContext: i.context.to_gapi
+              image_context: i.context.to_grpc
             )
           end
         end
@@ -176,18 +174,18 @@ module Google
             faces, landmarks, logos, labels)
 
           f = []
-          f << feature("FACE_DETECTION", faces) unless faces.zero?
-          f << feature("LANDMARK_DETECTION", landmarks) unless landmarks.zero?
-          f << feature("LOGO_DETECTION", logos) unless logos.zero?
-          f << feature("LABEL_DETECTION", labels) unless labels.zero?
-          f << feature("TEXT_DETECTION", 1) if text
-          f << feature("SAFE_SEARCH_DETECTION", 1) if safe_search
-          f << feature("IMAGE_PROPERTIES", 1) if properties
+          f << feature(:FACE_DETECTION, faces) unless faces.zero?
+          f << feature(:LANDMARK_DETECTION, landmarks) unless landmarks.zero?
+          f << feature(:LOGO_DETECTION, logos) unless logos.zero?
+          f << feature(:LABEL_DETECTION, labels) unless labels.zero?
+          f << feature(:TEXT_DETECTION, 1) if text
+          f << feature(:SAFE_SEARCH_DETECTION, 1) if safe_search
+          f << feature(:IMAGE_PROPERTIES, 1) if properties
           f
         end
 
         def feature type, max_results
-          Google::Apis::VisionV1::Feature.new(
+          Google::Cloud::Vision::V1::Feature.new(
             type: type, max_results: max_results)
         end
 
@@ -200,15 +198,15 @@ module Google
 
         def default_features
           [
-            feature("FACE_DETECTION", Google::Cloud::Vision.default_max_faces),
-            feature("LANDMARK_DETECTION",
+            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",
+            feature(:LOGO_DETECTION, Google::Cloud::Vision.default_max_logos),
+            feature(:LABEL_DETECTION,
                     Google::Cloud::Vision.default_max_labels),
-            feature("TEXT_DETECTION", 1),
-            feature("SAFE_SEARCH_DETECTION", 1),
-            feature("IMAGE_PROPERTIES", 1)
+            feature(:TEXT_DETECTION, 1),
+            feature(:SAFE_SEARCH_DETECTION, 1),
+            feature(:IMAGE_PROPERTIES, 1)
           ]
         end
 

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

@@ -30,10 +30,9 @@ module Google
       # See {Project#annotate} and {Image}.
       #
       # @example
-      #   require "google/cloud"
+      #   require "google/cloud/vision"
       #
-      #   gcloud = Google::Cloud.new
-      #   vision = gcloud.vision
+      #   vision = Google::Cloud::Vision.new
       #   image = vision.image "path/to/face.jpg"
       #
       #   annotation = vision.annotate image, faces: true, labels: true
@@ -43,13 +42,13 @@ module Google
       #
       class Annotation
         ##
-        # @private The AnnotateImageResponse Google API Client object.
-        attr_accessor :gapi
+        # @private The AnnotateImageResponse GRPC object.
+        attr_accessor :grpc
 
         ##
         # @private Creates a new Annotation instance.
         def initialize
-          @gapi = nil
+          @grpc = nil
         end
 
         ##
@@ -58,10 +57,9 @@ module Google
         # @return [Array<Face>]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/face.jpg"
         #
         #   annotation = vision.annotate image, faces: true
@@ -69,8 +67,8 @@ module Google
         #   face = annotation.faces.first
         #
         def faces
-          @faces ||= Array(@gapi.face_annotations).map do |fa|
-            Face.from_gapi fa
+          @faces ||= Array(@grpc.face_annotations).map do |fa|
+            Face.from_grpc fa
           end
         end
 
@@ -80,10 +78,9 @@ module Google
         # @return [Face]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/face.jpg"
         #
         #   annotation = vision.annotate image, faces: 1
@@ -99,10 +96,9 @@ module Google
         # @return [Boolean]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/face.jpg"
         #
         #   annotation = vision.annotate image, faces: 1
@@ -118,10 +114,9 @@ module Google
         # @return [Array<Entity>]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/landmark.jpg"
         #
         #   annotation = vision.annotate image, landmarks: 1
@@ -129,8 +124,8 @@ module Google
         #   landmark = annotation.landmarks.first
         #
         def landmarks
-          @landmarks ||= Array(@gapi.landmark_annotations).map do |lm|
-            Entity.from_gapi lm
+          @landmarks ||= Array(@grpc.landmark_annotations).map do |lm|
+            Entity.from_grpc lm
           end
         end
 
@@ -140,10 +135,9 @@ module Google
         # @return [Entity]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/landmark.jpg"
         #
         #   annotation = vision.annotate image, landmarks: 1
@@ -160,10 +154,9 @@ module Google
         # @return [Boolean]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/landmark.jpg"
         #
         #   annotation = vision.annotate image, landmarks: 1
@@ -179,10 +172,9 @@ module Google
         # @return [Array<Entity>]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/logo.jpg"
         #
         #   annotation = vision.annotate image, logos: 1
@@ -190,8 +182,8 @@ module Google
         #   logo = annotation.logos.first
         #
         def logos
-          @logos ||= Array(@gapi.logo_annotations).map do |lg|
-            Entity.from_gapi lg
+          @logos ||= Array(@grpc.logo_annotations).map do |lg|
+            Entity.from_grpc lg
           end
         end
 
@@ -201,10 +193,9 @@ module Google
         # @return [Entity]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/logo.jpg"
         #
         #   annotation = vision.annotate image, logos: 1
@@ -221,10 +212,9 @@ module Google
         # @return [Boolean]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/logo.jpg"
         #
         #   annotation = vision.annotate image, logos: 1
@@ -240,10 +230,9 @@ module Google
         # @return [Array<Entity>]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/face.jpg"
         #
         #   annotation = vision.annotate image, labels: 1
@@ -251,8 +240,8 @@ module Google
         #   label = annotation.labels.first
         #
         def labels
-          @labels ||= Array(@gapi.label_annotations).map do |lb|
-            Entity.from_gapi lb
+          @labels ||= Array(@grpc.label_annotations).map do |lb|
+            Entity.from_grpc lb
           end
         end
 
@@ -262,10 +251,9 @@ module Google
         # @return [Entity]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/face.jpg"
         #
         #   annotation = vision.annotate image, labels: 1
@@ -282,10 +270,9 @@ module Google
         # @return [Boolean]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/face.jpg"
         #
         #   annotation = vision.annotate image, labels: 1
@@ -301,17 +288,16 @@ module Google
         # @return [Text]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/text.png"
         #
         #   annotation = vision.annotate image, text: true
         #   text = annotation.text
         #
         def text
-          @text ||= Text.from_gapi(@gapi.text_annotations)
+          @text ||= Text.from_grpc(@grpc.text_annotations)
         end
 
         ##
@@ -320,10 +306,9 @@ module Google
         # @return [Boolean]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/text.png"
         #
         #   annotation = vision.annotate image, text: true
@@ -339,18 +324,17 @@ module Google
         # @return [SafeSearch]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/face.jpg"
         #
         #   annotation = vision.annotate image, safe_search: true
         #   safe_search = annotation.safe_search
         #
         def safe_search
-          return nil unless @gapi.safe_search_annotation
-          @safe_search ||= SafeSearch.from_gapi(@gapi.safe_search_annotation)
+          return nil unless @grpc.safe_search_annotation
+          @safe_search ||= SafeSearch.from_grpc(@grpc.safe_search_annotation)
         end
 
         ##
@@ -360,10 +344,9 @@ module Google
         # @return [Boolean]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/face.jpg"
         #
         #   annotation = vision.annotate image, safe_search: true
@@ -379,19 +362,18 @@ module Google
         # @return [Properties]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/face.jpg"
         #
         #   annotation = vision.annotate image, properties: true
         #   properties = annotation.properties
         #
         def properties
-          return nil unless @gapi.image_properties_annotation
-          @properties ||= Properties.from_gapi(
-            @gapi.image_properties_annotation)
+          return nil unless @grpc.image_properties_annotation
+          @properties ||= Properties.from_grpc(
+            @grpc.image_properties_annotation)
         end
 
         ##
@@ -400,10 +382,9 @@ module Google
         # @return [Boolean]
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #   image = vision.image "path/to/face.jpg"
         #
         #   annotation = vision.annotate image, properties: true
@@ -439,9 +420,9 @@ module Google
         end
 
         ##
-        # @private New Annotation from a Google API Client object.
-        def self.from_gapi gapi
-          new.tap { |a| a.instance_variable_set :@gapi, gapi }
+        # @private New Annotation from a GRPC object.
+        def self.from_grpc grpc
+          new.tap { |a| a.instance_variable_set :@grpc, grpc }
         end
       end
     end

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

@@ -30,10 +30,9 @@ module Google
         # @see https://developers.google.com/knowledge-graph/ Knowledge Graph
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #
         #   image = vision.image "path/to/landmark.jpg"
         #
@@ -43,10 +42,9 @@ module Google
         #   landmark.mid #=> "/m/019dvv"
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #
         #   image = vision.image "path/to/logo.jpg"
         #
@@ -56,10 +54,9 @@ module Google
         #   logo.mid #=> "/m/0b34hf"
         #
         # @example
-        #   require "google/cloud"
+        #   require "google/cloud/vision"
         #
-        #   gcloud = Google::Cloud.new
-        #   vision = gcloud.vision
+        #   vision = Google::Cloud::Vision.new
         #
         #   image = vision.image "path/to/face.jpg"
         #
@@ -73,13 +70,13 @@ module Google
         #
         class Entity
           ##
-          # @private The EntityAnnotation Google API Client object.
-          attr_accessor :gapi
+          # @private The EntityAnnotation GRPC object.
+          attr_accessor :grpc
 
           ##
           # @private Creates a new Entity instance.
           def initialize
-            @gapi = {}
+            @grpc = nil
           end
 
           ##
@@ -91,7 +88,7 @@ module Google
           # @return [String] The opaque entity ID.
           #
           def mid
-            @gapi.mid
+            @grpc.mid
           end
 
           ##
@@ -103,7 +100,7 @@ module Google
           #   language code.
           #
           def locale
-            @gapi.locale
+            @grpc.locale
           end
 
           ##
@@ -112,7 +109,7 @@ module Google
           # @return [String] A description of the entity.
           #
           def description
-            @gapi.description
+            @grpc.description
           end
 
           ##
@@ -121,7 +118,7 @@ module Google
           # @return [Float] A value in the range [0, 1].
           #
           def score
-            @gapi.score
+            @grpc.score
           end
 
           ##
@@ -132,7 +129,7 @@ module Google
           # @return [Float] A value in the range [0, 1].
           #
           def confidence
-            @gapi.confidence
+            @grpc.confidence
           end
 
           ##
@@ -145,7 +142,7 @@ module Google
           # @return [Float] A value in the range [0, 1].
           #
           def topicality
-            @gapi.topicality
+            @grpc.topicality
           end
 
           ##
@@ -155,9 +152,9 @@ module Google
           # @return [Array<Vertex>] An array of vertices.
           #
           def bounds
-            return [] unless @gapi.bounding_poly
-            @bounds ||= Array(@gapi.bounding_poly.vertices).map do |v|
-              Vertex.from_gapi v
+            return [] unless @grpc.bounding_poly
+            @bounds ||= Array(@grpc.bounding_poly.vertices).map do |v|
+              Vertex.from_grpc v
             end
           end
 
@@ -172,8 +169,8 @@ module Google
           #   and longitude.
           #
           def locations
-            @locations ||= Array(@gapi.locations).map do |l|
-              Location.from_gapi l.lat_lng
+            @locations ||= Array(@grpc.locations).map do |l|
+              Location.from_grpc l.lat_lng
             end
           end
 
@@ -186,7 +183,7 @@ module Google
           #
           def properties
             @properties ||=
-              Hash[Array(@gapi.properties).map { |p| [p.name, p.value] }]
+              Hash[Array(@grpc.properties).map { |p| [p.name, p.value] }]
           end
 
           ##
@@ -217,9 +214,9 @@ module Google
           end
 
           ##
-          # @private New Annotation::Entity from a Google API Client object.
-          def self.from_gapi gapi
-            new.tap { |f| f.instance_variable_set :@gapi, gapi }
+          # @private New Annotation::Entity from a GRPC object.
+          def self.from_grpc grpc
+            new.tap { |f| f.instance_variable_set :@grpc, grpc }
           end
         end
       end