gcloud 0.7.2 → 0.8.0

data/lib/gcloud/{search → translate}/errors.rb

@@ -1,4 +1,4 @@
-# Copyright 2015 Google Inc. All rights reserved.
+# 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.
@@ -16,9 +16,9 @@
 require "gcloud/errors"
 
 module Gcloud
-  module Search
+  module Translate
     ##
-    # Base Search exception class.
+    # Base Translate exception class.
     class Error < Gcloud::Error
     end
 
@@ -42,14 +42,11 @@ module Gcloud
 
       # @private
       def self.from_response resp
-        data = JSON.parse resp.body
-        if data["error"]
-          from_response_data data["error"]
+        if resp.data? && resp.data["error"]
+          from_response_data resp.data["error"]
         else
           from_response_status resp
         end
-      rescue JSON::ParserError
-        from_response_status resp
       end
 
       # @private
@@ -60,10 +57,10 @@ module Gcloud
       # @private
       def self.from_response_status resp
         if resp.status == 404
-          new "#{resp.body}: #{resp.request.uri.request_uri}",
+          new "#{resp.error_message}: #{resp.request.uri.request_uri}",
               resp.status
         else
-          new resp.body, resp.status
+          new resp.error_message, resp.status
         end
       end
     end

data/lib/gcloud/translate/language.rb

@@ -0,0 +1,69 @@
+# 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.
+
+
+module Gcloud
+  module Translate
+    ##
+    # # Language
+    #
+    # Represents a supported languages query result. Returned by
+    # {Gcloud::Translate::Api#languages}.
+    #
+    # @see https://cloud.google.com/translate/v2/using_rest#supported-languages
+    #   Discover Supported Languages
+    #
+    # @example
+    #   require "gcloud"
+    #
+    #   gcloud = Gcloud.new
+    #   translate = gcloud.translate
+    #
+    #   languages = translate.languages "en"
+    #
+    #   languages.size #=> 104
+    #   languages[0].code #=> "af"
+    #   languages[0].name #=> "Afrikaans"
+    #
+    class Language
+      ##
+      # The language code. This is an [ISO
+      # 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) language
+      # code.
+      #
+      # @return [String]
+      attr_reader :code
+
+      ##
+      # The localized name of the language, if available.
+      #
+      # @return [String]
+      attr_reader :name
+
+      ##
+      # @private Create a new object.
+      def initialize code, name
+        @code = code
+        @name = name
+      end
+
+      ##
+      # @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"]
+      end
+    end
+  end
+end

data/lib/gcloud/translate/translation.rb

@@ -0,0 +1,112 @@
+# 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.
+
+
+module Gcloud
+  module Translate
+    ##
+    # # Translation
+    #
+    # Represents a translation query result. Returned by
+    # {Gcloud::Translate::Api#translate}.
+    #
+    # @see https://cloud.google.com/translate/v2/using_rest#Translate Translate
+    #   Text
+    #
+    # @example
+    #   require "gcloud"
+    #
+    #   gcloud = Gcloud.new
+    #   translate = gcloud.translate
+    #
+    #   translation = translate.translate "Hello world!", to: "la"
+    #
+    #   puts translation #=> Salve mundi!
+    #
+    #   translation.from #=> "en"
+    #   translation.origin #=> "Hello world!"
+    #   translation.to #=> "la"
+    #   translation.text #=> "Salve mundi!"
+    #
+    class Translation
+      ##
+      # The translated result.
+      #
+      # @return [String]
+      attr_reader :text
+      alias_method :to_s, :text
+      alias_method :to_str, :text
+
+      ##
+      # The original query text that was translated.
+      #
+      # @return [String]
+      attr_reader :origin
+
+      ##
+      # The target language into which the text was translated.
+      #
+      # @return [String]
+      attr_reader :to
+      alias_method :language, :to
+      alias_method :target, :to
+
+      ##
+      # The source language from which the text was translated.
+      attr_reader :from
+      alias_method :source, :from
+
+      ##
+      # @private Create a new object.
+      def initialize text, to, origin, from, detected
+        @text = text
+        @to = to
+        @origin = origin
+        @from = from
+        @detected = detected
+      end
+
+      ##
+      # Determines if the source language was detected by the Google Cloud
+      # Translate API.
+      #
+      # @return [Boolean] `true` if the source language was detected by the
+      #   Translate service, `false` if the source language was provided in the
+      #   request
+      def detected?
+        @detected
+      end
+
+      ##
+      # @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
+        end
+        return res.first if res.size == 1
+        res
+      end
+
+      ##
+      # @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
+      end
+    end
+  end
+end

data/lib/gcloud/version.rb

@@ -14,5 +14,5 @@
 
 
 module Gcloud
-  VERSION = "0.7.2"
+  VERSION = "0.8.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gcloud
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.8.0
 platform: ruby
 authors:
 - Silvano Luciani
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-04-02 00:00:00.000000000 Z
+date: 2016-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grpc
@@ -354,21 +354,6 @@ files:
 - lib/gcloud/resource_manager/project.rb
 - lib/gcloud/resource_manager/project/list.rb
 - lib/gcloud/resource_manager/project/updater.rb
-- lib/gcloud/search.rb
-- lib/gcloud/search/api_client.rb
-- lib/gcloud/search/connection.rb
-- lib/gcloud/search/credentials.rb
-- lib/gcloud/search/document.rb
-- lib/gcloud/search/document/list.rb
-- lib/gcloud/search/errors.rb
-- lib/gcloud/search/field_value.rb
-- lib/gcloud/search/field_values.rb
-- lib/gcloud/search/fields.rb
-- lib/gcloud/search/index.rb
-- lib/gcloud/search/index/list.rb
-- lib/gcloud/search/project.rb
-- lib/gcloud/search/result.rb
-- lib/gcloud/search/result/list.rb
 - lib/gcloud/storage.rb
 - lib/gcloud/storage/bucket.rb
 - lib/gcloud/storage/bucket/acl.rb
@@ -382,6 +367,13 @@ files:
 - lib/gcloud/storage/file/list.rb
 - lib/gcloud/storage/file/verifier.rb
 - lib/gcloud/storage/project.rb
+- lib/gcloud/translate.rb
+- lib/gcloud/translate/api.rb
+- lib/gcloud/translate/connection.rb
+- lib/gcloud/translate/detection.rb
+- lib/gcloud/translate/errors.rb
+- lib/gcloud/translate/language.rb
+- lib/gcloud/translate/translation.rb
 - lib/gcloud/upload.rb
 - lib/gcloud/version.rb
 - lib/google/api/annotations.rb

data/lib/gcloud/search.rb

@@ -1,318 +0,0 @@
-# Copyright 2015 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"
-require "gcloud/search/project"
-
-module Gcloud
-  ##
-  # Creates a new `Project` instance connected to the Search service.
-  # Each call creates a new connection.
-  #
-  # For more information on connecting to Google Cloud see the [Authentication
-  # Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/authentication).
-  #
-  # @param [String] project Identifier for a Search project. If not present, the
-  #   default project for the credentials is used.
-  # @param [String, Hash] keyfile Keyfile downloaded from Google Cloud. If file
-  #   path the file must be readable.
-  # @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 scopes are:
-  #
-  #   * `https://www.googleapis.com/auth/cloudsearch`
-  #   * `https://www.googleapis.com/auth/userinfo.email`
-  #
-  # @return [Gcloud::Search::Project]
-  #
-  def self.search project = nil, keyfile = nil, scope: nil
-    project ||= Gcloud::Search::Project.default_project
-    if keyfile.nil?
-      credentials = Gcloud::Search::Credentials.default scope: scope
-    else
-      credentials = Gcloud::Search::Credentials.new keyfile, scope: scope
-    end
-    Gcloud::Search::Project.new project, credentials
-  end
-
-  # rubocop:disable Metrics/LineLength
-  # Disabled because there are links in the docs that are long.
-
-  ##
-  # # Google Cloud Search
-  #
-  # Google Cloud Search allows an application to quickly perform full-text and
-  # geo-spatial searches without having to spin up instances and without the
-  # hassle of managing and maintaining a search service.
-  #
-  # Cloud Search provides a model for indexing documents containing structured
-  # data, with documents and indexes saved to a separate persistent store
-  # optimized for search operations. The API supports full text matching on
-  # string fields and allows indexing any number of documents in any number of
-  # indexes.
-  #
-  # The Cloud Search API is an Alpha release, and might be changed in
-  # backward-incompatible ways. It is not currently recommended for production
-  # use. It is not subject to any SLA or deprecation policy.
-  #
-  # ## Accessing the Service
-  #
-  # Currently, the Cloud Search API is available only to white-listed users.
-  # Contact your account manager or a member of the Google Cloud sales team if
-  # you are interested in access.
-  #
-  # ## Authentication
-  #
-  # Authentication is handled by {Gcloud#search}. You can provide the project and
-  # credential information to connect to the Cloud Search service, or if you are
-  # running on Google Compute Engine this configuration is taken care of for
-  # you. You can read more about the options for connecting in the
-  # [Authentication
-  # Guide](https://googlecloudplatform.github.io/gcloud-ruby/#/docs/guides/authentication).
-  #
-  # ## Managing Indexes
-  #
-  # An Index is a searchable collection of documents that belongs to a Project.
-  #
-  # You can list the indexes in your current project:
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # search = gcloud.search
-  #
-  # indexes = search.indexes  # API call
-  # indexes.each do |index|
-  #   puts index.index_id
-  # end
-  # ```
-  #
-  # And you can use the project to create new indexes:
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # search = gcloud.search
-  #
-  # index = search.index "products", skip_lookup: true
-  # ```
-  #
-  # A new index is an unsaved value object. Indexes cannot be created,
-  # updated, or deleted directly in the service: They are derived from the
-  # documents which are created "within" them. A new index will exist in the
-  # service once you save a document that references it.
-  #
-  # ## Managing Documents
-  #
-  # Using an index, create a new, unsaved Document instance, providing
-  # your own unique document ID, as shown below, or omitting this argument to
-  # let the service assign the ID.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # search = gcloud.search
-  #
-  # index = search.index "products"
-  # document = index.document "product-sku-000001"
-  # index.find document # API call
-  # #=> nil
-  # document.rank #=> nil
-  # ```
-  #
-  # Add one or more fields to the document. (See [Adding document fields](#module-Gcloud::Search-label-Adding`document`fields), below.)
-  #
-  # ```ruby
-  # document.add "price", 24.95
-  # ```
-  #
-  # When your document is complete, save it:
-  #
-  # ```ruby
-  # index.save document # API call
-  # document.rank # set by the server
-  # #=> 1443648166
-  # ```
-  #
-  # You can list the documents in an index:
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # search = gcloud.search
-  # index = search.index "products"
-  #
-  # documents = index.documents # API call
-  # documents.map &:doc_id #=> ["product-sku-000001"]
-  # ```
-  #
-  # And you can delete documents:
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # search = gcloud.search
-  # index = search.index "products"
-  #
-  # document = index.find "product-sku-000001"
-  #
-  # document.delete  # API call
-  # index.find document # API call
-  # #=> nil
-  # ```
-  #
-  # To update a document after manipulating its fields or rank, just re-save it:
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # search = gcloud.search
-  # index = search.index "products"
-  #
-  # document = index.find "product-sku-000001"
-  #
-  # document.rank = 12345
-  # document.add "price", 9.95 # replace existing number value
-  # index.save document # API call
-  # ```
-  #
-  # ## Adding document fields
-  #
-  # Fields belong to documents and are the data that actually gets searched.
-  # Each field has a FieldValues collection, which facilitates access to
-  # FieldValue objects. Each FieldValue object will be saved as one of the
-  # [Cloud Search types](https://cloud.google.com/search/documents_indexes#document_fields_field_names_and_multi-valued_fields).
-  # The type will be inferred from the value when possible, or you can
-  # explicitly specify it by passing a symbol with the `type` option to
-  # {Gcloud::Search::Document#add}.
-  #
-  # - String (`:atom`, `:html`, `:text`, or `:default`)
-  # - Number (`:number`)
-  # - Timestamp (`:datetime`)
-  # - Geovalue (`:geo`)
-  #
-  # String values can be tokenized using one of three different types of
-  # tokenization, which can be passed with the `type` option when the value is
-  # added:
-  #
-  # - `:atom` means "don't tokenize this string", treat it as one
-  #   thing to compare against
-  #
-  # - `:html` means "treat this string as HTML", not comparing against the
-  #   tags, and treating the rest of the content like `:text`
-  #
-  # - `:text` means "treat this string as normal text" and split words
-  #   apart to be compared against
-  #
-  # Again, you can add more than one value to a field, and the values may be of
-  # different types.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # search = gcloud.search
-  #
-  # index = search.index "products"
-  # document = index.find "product-sku-000001"
-  # document.add "description", "The best T-shirt ever.", type: :text, lang: "en"
-  # document.add "description", "<p>The best T-shirt ever.</p>", type: :html, lang: "en"
-  # document["description"].size #=> 2
-  # ```
-  #
-  # ## Searching
-  #
-  # After populating an index with documents, you can request search results
-  # with a query:
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # search = gcloud.search
-  # index = search.index "books"
-  #
-  # results = index.search "dark stormy"
-  # results.each do |result|
-  #   puts result.doc_id
-  # end
-  # ```
-  #
-  # By default, Result objects are sorted by document rank. For more information
-  # see the [REST API documentation for Document.rank](https://cloud.google.com/search/reference/rest/v1/projects/indexes/documents#resource_representation.google.cloudsearch.v1.Document.rank).
-  #
-  # You can specify how to sort results with the `order` option:
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # search = gcloud.search
-  # index = search.index "books"
-  #
-  # results = index.search "dark stormy", order: "published, avg_review desc"
-  # documents = index.search query # API call
-  # ```
-  #
-  # You can add computed fields with the `expressions` option, and specify the
-  # fields that are returned with the `fields` option. No document data will be
-  # returned if you omit the `fields` option, only `doc_id` references to any
-  # matched documents.
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # search = gcloud.search
-  # index = search.index "products"
-  #
-  # results = index.search "cotton T-shirt",
-  #                        expressions: { total_price: "(price + tax)" },
-  #                        fields: ["name", "total_price", "highlight"]
-  # ```
-  #
-  # Just as in documents, Result data is accessible via Fields methods:
-  #
-  # ```ruby
-  # require "gcloud"
-  #
-  # gcloud = Gcloud.new
-  # search = gcloud.search
-  # index = search.index "products"
-  # document = index.find "product-sku-000001"
-  # results = index.search "cotton T-shirt"
-  # values = results[0]["description"]
-  #
-  # values[0] #=> "100% organic cotton ruby gem T-shirt"
-  # values[0].type #=> :text
-  # values[0].lang #=> "en"
-  # values[1] #=> "<p>100% organic cotton ruby gem T-shirt</p>"
-  # values[1].type #=> :html
-  # values[1].lang #=> "en"
-  # ```
-  #
-  module Search
-  end
-  # rubocop:enable Metrics/LineLength
-end