gcloud 0.11.0 → 0.12.0

data/lib/gcloud/translate.rb

@@ -30,6 +30,9 @@ module Gcloud
   # keys](https://cloud.google.com/translate/v2/using_rest#creating-server-api-keys).
   #
   # @param [String] key a public API access key (not an OAuth 2.0 token)
+  # @param [Integer] retries Number of times to retry requests on server error.
+  #   The default value is `3`. Optional.
+  # @param [Integer] timeout Default timeout to use in requests. Optional.
   #
   # @return [Gcloud::Translate::Api]
   #
@@ -51,8 +54,16 @@ module Gcloud
   #   translation = translate.translate "Hello world!", to: "la"
   #   translation.text #=> "Salve mundi!"
   #
-  def self.translate key = nil
-    Gcloud::Translate::Api.new key
+  def self.translate key = nil, retries: nil, timeout: nil
+    key ||= ENV["TRANSLATE_KEY"]
+    if key.nil?
+      key_missing_msg = "An API key is required to use the Translate API."
+      fail ArgumentError, key_missing_msg
+    end
+
+    Gcloud::Translate::Api.new(
+      Gcloud::Translate::Service.new(
+        key, retries: retries, timeout: timeout))
   end
 
   ##
@@ -231,24 +242,23 @@ module Gcloud
   # languages[0].name #=> "Afrikaans"
   # ```
   #
-  # ## Configuring Backoff
+  # ## Configuring retries and timeout
   #
-  # The {Gcloud::Backoff} class allows users to globally configure how Cloud API
-  # requests are automatically retried in the case of some errors, such as a
-  # `500` or `503` status code, or a specific internal error code such as
-  # `rateLimitExceeded`.
+  # You can configure how many times API requests may be automatically retried.
+  # When an API request fails, the response will be inspected to see if the
+  # request meets criteria indicating that it may succeed on retry, such as
+  # `500` and `503` status codes or a specific internal error code such as
+  # `rateLimitExceeded`. If it meets the criteria, the request will be retried
+  # after a delay. If another error occurs, the delay will be increased before a
+  # subsequent attempt, until the `retries` limit is reached.
   #
-  # If an API call fails, the response will be inspected to see if the call
-  # should be retried. If the response matches the criteria, then the request
-  # will be retried after a delay. If another error occurs, the delay will be
-  # increased incrementally before a subsequent attempt. The first retry will be
-  # delayed one second, the second retry two seconds, and so on.
+  # You can also set the request `timeout` value in seconds.
   #
   # ```ruby
   # require "gcloud"
-  # require "gcloud/backoff"
   #
-  # Gcloud::Backoff.retries = 5 # Raise the maximum number of retries from 3
+  # gcloud = Gcloud.new
+  # translate = gcloud.translate retries: 10, timeout: 120
   # ```
   #
   module Translate

data/lib/gcloud/translate/api.rb

@@ -13,11 +13,10 @@
 # limitations under the License.
 
 
-require "gcloud/translate/connection"
+require "gcloud/translate/service"
 require "gcloud/translate/translation"
 require "gcloud/translate/detection"
 require "gcloud/translate/language"
-require "gcloud/translate/errors"
 
 module Gcloud
   module Translate
@@ -52,20 +51,15 @@ module Gcloud
     #
     class Api
       ##
-      # @private The Connection object.
-      attr_accessor :connection
+      # @private The Service object.
+      attr_accessor :service
 
       ##
       # @private Creates a new Translate Api instance.
       #
       # See {Gcloud.translate}
-      def initialize key
-        key ||= ENV["TRANSLATE_KEY"]
-        if key.nil?
-          key_mising_msg = "An API key is required to use the Translate API."
-          fail ArgumentError, key_mising_msg
-        end
-        @connection = Connection.new key
+      def initialize service
+        @service = service
       end
 
       ##
@@ -149,10 +143,9 @@ module Gcloud
         from = from.to_s if from
         format = format.to_s if format
         text = Array(text).flatten
-        resp = connection.translate(text, to: to, from: from,
-                                          format: format, cid: cid)
-        fail ApiError.from_response(resp) unless resp.success?
-        Translation.from_response resp, text, to, from
+        gapi = service.translate text, to: to, from: from,
+                                       format: format, cid: cid
+        Translation.from_gapi_list gapi, text, to, from
       end
 
       ##
@@ -196,9 +189,8 @@ module Gcloud
       def detect *text
         return nil if text.empty?
         text = Array(text).flatten
-        resp = connection.detect(text)
-        fail ApiError.from_response(resp) unless resp.success?
-        Detection.from_response resp, text
+        gapi = service.detect(text)
+        Detection.from_gapi gapi, text
       end
 
       ##
@@ -241,9 +233,8 @@ module Gcloud
       #
       def languages language = nil
         language = language.to_s if language
-        resp = connection.languages language
-        fail ApiError.from_response(resp) unless resp.success?
-        Array(resp.data["languages"]).map { |gapi| Language.from_gapi gapi }
+        gapi = service.languages language
+        Array(gapi.languages).map { |g| Language.from_gapi g }
       end
     end
   end

data/lib/gcloud/translate/detection.rb

@@ -84,11 +84,11 @@ module Gcloud
       end
 
       ##
-      # @private New Detection from a DetectionsListResponse object as
+      # @private New Detection from a ListDetectionsResponse object as
       # defined by the Google API Client object.
-      def self.from_response resp, text
-        res = text.zip(Array(resp.data.detections)).map do |txt, gapi_list|
-          results = gapi_list.map { |gapi| Result.from_gapi gapi }
+      def self.from_gapi gapi, text
+        res = text.zip(Array(gapi.detections)).map do |txt, detections_gapi|
+          results = detections_gapi.map { |g| Result.from_gapi g }
           new txt, results
         end
         return res.first if res.size == 1
@@ -129,7 +129,7 @@ module Gcloud
         # @private New Detection::Result from a DetectionsResource object as
         # defined by the Google API Client object.
         def self.from_gapi gapi
-          new gapi["confidence"], gapi["language"]
+          new gapi.confidence, gapi.language
         end
       end
     end

data/lib/gcloud/translate/language.rb

@@ -62,7 +62,7 @@ module Gcloud
       # @private New Language from a LanguagesResource object as defined by the
       # Google API Client object.
       def self.from_gapi gapi
-        new gapi["language"], gapi["name"]
+        new gapi.language, gapi.name
       end
     end
   end

data/lib/gcloud/translate/service.rb

@@ -0,0 +1,80 @@
+# Copyright 2016 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.
+
+
+require "gcloud/version"
+require "gcloud/errors"
+require "google/apis/translate_v2"
+
+module Gcloud
+  module Translate
+    ##
+    # @private
+    # Represents the service to Translate, exposing the API calls.
+    class Service
+      ##
+      # Alias to the Google Client API module
+      API = Google::Apis::TranslateV2
+
+      attr_accessor :credentials
+
+      ##
+      # Creates a new Service instance.
+      def initialize key, retries: nil, timeout: nil
+        @service = API::TranslateService.new
+        @service.client_options.application_name    = "gcloud-ruby"
+        @service.client_options.application_version = Gcloud::VERSION
+        @service.request_options.retries = retries || 3
+        @service.request_options.timeout_sec = timeout if timeout
+        @service.authorization = nil
+        @service.key = key
+      end
+
+      def service
+        return mocked_service if mocked_service
+        @service
+      end
+      attr_accessor :mocked_service
+
+      ##
+      # Returns API::ListTranslationsResponse
+      def translate text, to: nil, from: nil, format: nil, cid: nil
+        service.list_translations Array(text), to, cid: cid, format: format,
+                                                   source: from
+      rescue Google::Apis::Error => e
+        raise Gcloud::Error.from_error(e)
+      end
+
+      ##
+      # Returns API::ListDetectionsResponse
+      def detect text
+        service.list_detections Array(text)
+      rescue Google::Apis::Error => e
+        raise Gcloud::Error.from_error(e)
+      end
+
+      ##
+      # Returns API::ListLanguagesResponse
+      def languages language = nil
+        service.list_languages target: language
+      rescue Google::Apis::Error => e
+        raise Gcloud::Error.from_error(e)
+      end
+
+      def inspect
+        "#{self.class}"
+      end
+    end
+  end
+end

data/lib/gcloud/translate/translation.rb

@@ -91,9 +91,9 @@ module Gcloud
       ##
       # @private New Translation from a TranslationsListResponse object as
       # defined by the Google API Client object.
-      def self.from_response resp, text, to, from
-        res = text.zip(Array(resp.data["translations"])).map do |origin, gapi|
-          from_gapi gapi, to, origin, from
+      def self.from_gapi_list gapi, text, to, from
+        res = text.zip(Array(gapi.translations)).map do |origin, g|
+          from_gapi g, to, origin, from
         end
         return res.first if res.size == 1
         res
@@ -103,9 +103,9 @@ module Gcloud
       # @private New Translation from a TranslationsResource object as defined
       # by the Google API Client object.
       def self.from_gapi gapi, to, origin, from
-        from ||= gapi["detectedSourceLanguage"]
-        detected = !gapi["detectedSourceLanguage"].nil?
-        new gapi["translatedText"], to, origin, from, detected
+        from ||= gapi.detected_source_language
+        detected = !gapi.detected_source_language.nil?
+        new gapi.translated_text, to, origin, from, detected
       end
     end
   end

data/lib/gcloud/version.rb

@@ -14,5 +14,5 @@
 
 
 module Gcloud
-  VERSION = "0.11.0"
+  VERSION = "0.12.0"
 end

data/lib/gcloud/vision.rb

@@ -33,6 +33,9 @@ module Gcloud
   #   The default scope is:
   #
   #   * `https://www.googleapis.com/auth/cloud-platform`
+  # @param [Integer] retries Number of times to retry requests on server error.
+  #   The default value is `3`. Optional.
+  # @param [Integer] timeout Default timeout to use in requests. Optional.
   #
   # @return [Gcloud::Vision::Project]
   #
@@ -47,14 +50,21 @@ module Gcloud
   #   landmark = image.landmark
   #   landmark.description #=> "Mount Rushmore"
   #
-  def self.vision project = nil, keyfile = nil, scope: nil
+  def self.vision project = nil, keyfile = nil, scope: nil, retries: nil,
+                  timeout: nil
     project ||= Gcloud::Vision::Project.default_project
+    project = project.to_s # Always cast to a string
+    fail ArgumentError, "project is missing" if project.empty?
+
     if keyfile.nil?
       credentials = Gcloud::Vision::Credentials.default scope: scope
     else
       credentials = Gcloud::Vision::Credentials.new keyfile, scope: scope
     end
-    Gcloud::Vision::Project.new project, credentials
+
+    Gcloud::Vision::Project.new(
+      Gcloud::Vision::Service.new(
+        project, credentials, retries: retries, timeout: timeout))
   end
 
   ##
@@ -68,7 +78,7 @@ module Gcloud
   # For more information about Cloud Vision, read the [Google Cloud Vision API
   # Documentation](https://cloud.google.com/vision/docs/).
   #
-  # Gcloud's goal is to provide an API that is familiar and comfortable to
+  # The goal of gcloud-ruby is to provide an API that is comfortable to
   # Rubyists. Authentication is handled by {Gcloud#vision}. You can provide the
   # project and credential information to connect to the Cloud Vision service,
   # or if you are running on Google Compute Engine this configuration is taken
@@ -239,24 +249,23 @@ module Gcloud
   # annotation = vision.annotate image, faces: 5
   # ```
   #
-  # ## Configuring Backoff
+  # ## Configuring retries and timeout
   #
-  # The {Gcloud::Backoff} class allows users to globally configure how Cloud API
-  # requests are automatically retried in the case of some errors, such as a
-  # `500` or `503` status code, or a specific internal error code such as
-  # `rateLimitExceeded`.
+  # You can configure how many times API requests may be automatically retried.
+  # When an API request fails, the response will be inspected to see if the
+  # request meets criteria indicating that it may succeed on retry, such as
+  # `500` and `503` status codes or a specific internal error code such as
+  # `rateLimitExceeded`. If it meets the criteria, the request will be retried
+  # after a delay. If another error occurs, the delay will be increased before a
+  # subsequent attempt, until the `retries` limit is reached.
   #
-  # If an API call fails, the response will be inspected to see if the call
-  # should be retried. If the response matches the criteria, then the request
-  # will be retried after a delay. If another error occurs, the delay will be
-  # increased incrementally before a subsequent attempt. The first retry will be
-  # delayed one second, the second retry two seconds, and so on.
+  # You can also set the request `timeout` value in seconds.
   #
   # ```ruby
   # require "gcloud"
-  # require "gcloud/backoff"
   #
-  # Gcloud::Backoff.retries = 5 # Raise the maximum number of retries from 3
+  # gcloud = Gcloud.new
+  # vision = gcloud.vision retries: 10, timeout: 120
   # ```
   #
   module Vision

data/lib/gcloud/vision/annotate.rb

@@ -14,6 +14,7 @@
 
 
 require "gcloud/vision/image"
+require "google/apis/vision_v1"
 
 module Gcloud
   module Vision
@@ -154,8 +155,11 @@ module Gcloud
 
         Array(images).flatten.each do |img|
           i = image(img)
-          @requests << { image: i.to_gapi, features: features,
-                         imageContext: i.context.to_gapi }
+          @requests << Google::Apis::VisionV1::AnnotateImageRequest.new(
+            image: i.to_gapi,
+            features: features,
+            imageContext: i.context.to_gapi
+          )
         end
       end
 
@@ -168,17 +172,20 @@ module Gcloud
           faces, landmarks, logos, labels)
 
         f = []
-        f << { type: :FACE_DETECTION, maxResults: faces } unless faces.zero?
-        f << { type: :LANDMARK_DETECTION,
-               maxResults: landmarks } unless landmarks.zero?
-        f << { type: :LOGO_DETECTION, maxResults: logos } unless logos.zero?
-        f << { type: :LABEL_DETECTION, maxResults: labels } unless labels.zero?
-        f << { type: :TEXT_DETECTION, maxResults: 1 } if text
-        f << { type: :SAFE_SEARCH_DETECTION, maxResults: 1 } if safe_search
-        f << { type: :IMAGE_PROPERTIES, maxResults: 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 type: type, max_results: max_results
+      end
+
       def default_features? faces, landmarks, logos, labels, text,
                             safe_search, properties
         faces == false && landmarks == false && logos == false &&
@@ -188,17 +195,13 @@ module Gcloud
 
       def default_features
         [
-          { type: :FACE_DETECTION,
-            maxResults: Gcloud::Vision.default_max_faces },
-          { type: :LANDMARK_DETECTION,
-            maxResults: Gcloud::Vision.default_max_landmarks },
-          { type: :LOGO_DETECTION,
-            maxResults: Gcloud::Vision.default_max_logos },
-          { type: :LABEL_DETECTION,
-            maxResults: Gcloud::Vision.default_max_labels },
-          { type: :TEXT_DETECTION, maxResults: 1 },
-          { type: :SAFE_SEARCH_DETECTION, maxResults: 1 },
-          { type: :IMAGE_PROPERTIES, maxResults: 1 }
+          feature("FACE_DETECTION", Gcloud::Vision.default_max_faces),
+          feature("LANDMARK_DETECTION", Gcloud::Vision.default_max_landmarks),
+          feature("LOGO_DETECTION", Gcloud::Vision.default_max_logos),
+          feature("LABEL_DETECTION", Gcloud::Vision.default_max_labels),
+          feature("TEXT_DETECTION", 1),
+          feature("SAFE_SEARCH_DETECTION", 1),
+          feature("IMAGE_PROPERTIES", 1)
         ]
       end
 

data/lib/gcloud/vision/annotation.rb

@@ -68,7 +68,7 @@ module Gcloud
       #   face = annotation.faces.first
       #
       def faces
-        @faces ||= Array(@gapi["faceAnnotations"]).map do |fa|
+        @faces ||= Array(@gapi.face_annotations).map do |fa|
           Face.from_gapi fa
         end
       end
@@ -128,7 +128,7 @@ module Gcloud
       #   landmark = annotation.landmarks.first
       #
       def landmarks
-        @landmarks ||= Array(@gapi["landmarkAnnotations"]).map do |lm|
+        @landmarks ||= Array(@gapi.landmark_annotations).map do |lm|
           Entity.from_gapi lm
         end
       end
@@ -189,7 +189,7 @@ module Gcloud
       #   logo = annotation.logos.first
       #
       def logos
-        @logos ||= Array(@gapi["logoAnnotations"]).map do |lg|
+        @logos ||= Array(@gapi.logo_annotations).map do |lg|
           Entity.from_gapi lg
         end
       end
@@ -250,7 +250,7 @@ module Gcloud
       #   label = annotation.labels.first
       #
       def labels
-        @labels ||= Array(@gapi["labelAnnotations"]).map do |lb|
+        @labels ||= Array(@gapi.label_annotations).map do |lb|
           Entity.from_gapi lb
         end
       end
@@ -310,7 +310,7 @@ module Gcloud
       #   text = annotation.text
       #
       def text
-        @text ||= Text.from_gapi(@gapi["textAnnotations"])
+        @text ||= Text.from_gapi(@gapi.text_annotations)
       end
 
       ##
@@ -348,8 +348,8 @@ module Gcloud
       #   safe_search = annotation.safe_search
       #
       def safe_search
-        return nil unless @gapi["safeSearchAnnotation"]
-        @safe_search ||= SafeSearch.from_gapi(@gapi["safeSearchAnnotation"])
+        return nil unless @gapi.safe_search_annotation
+        @safe_search ||= SafeSearch.from_gapi(@gapi.safe_search_annotation)
       end
 
       ##
@@ -388,8 +388,8 @@ module Gcloud
       #   properties = annotation.properties
       #
       def properties
-        return nil unless @gapi["imagePropertiesAnnotation"]
-        @properties ||= Properties.from_gapi(@gapi["imagePropertiesAnnotation"])
+        return nil unless @gapi.image_properties_annotation
+        @properties ||= Properties.from_gapi(@gapi.image_properties_annotation)
       end
 
       ##