gcloud 0.7.2 → 0.8.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ODI3ODU0YWQzNDU0MmNlZjU1ZDM4NzgwM2ViOWM3YTliYWY4NTllMg==
+    ZmFhODViYTg5Nzc4Yjg0ZDJmMGFlZjQ3MmNiYTZjYWNlOTdlMjI5Zg==
   data.tar.gz: !binary |-
-    MTI3Y2U4MjA5ZmRjYjQ0YjllYzNlYmJlYmUzZmY5MjQ2NWVjYzJjNg==
+    ZDI5YjQ0YjRlMDE1YTNmYTNmMjYyN2I0ZTIzZTQyMjllNDljMTAwZQ==
 SHA512:
   metadata.gz: !binary |-
-    N2MzZjYyYTc3N2U1YTQxY2IwOTQ3OGQ5MjRhMjM3MWIxNmYyYTgxNzJmZjQx
-    YjNmYjI1OWY5NmFmNjZlZjk4NGVkZWFkMGViMjI3ZDNmYjMzOTM4YzdhNGI0
-    MzdiM2I5YTVjMDdmNTU2Yzk2Y2FiM2RjOGEyYjI1YTE1MzYxMjg=
+    ZTNkNDUxZTIzZWFkMjFkZmI2ODBjZDc1NWE2YjBlYmYwODUzMmU1Y2M4OTZl
+    MDBhYTI1YmI5NjI4N2QwODJmYzM4MTFkNDAwY2Y1MWFhYmJjYTlhMGQxNWE0
+    ZDQ1YzIyMjE4MTIxN2NjM2NkMTYzYzc5ZGQ5ZTQwZGQwOWVhNTM=
   data.tar.gz: !binary |-
-    M2MwMTIzOWU1ZDFiNzk2M2QzMDg4NmE2ZWYyOTViYjYzMGU5MDIyYTVhNGVl
-    ODA4NTNhNWFiZWI5NjkxYmUzNGYyMTZjYTM2MDEzNGFkNjU1OGM3MGExZmQ2
-    N2Q0MTAxMTFiZWZhMzI4YjQ3Nzc0NTAzMjk5ZWI1NGY5ZDViYzM=
+    MjBlNTAxNTBkYzVmMjA0MTBjZTNjZWE2NmM4OGZmMzE0NTM3Nzg5YTdiNjE5
+    ZmE0ODVhMDQxNGUwNjg0NjViYmFhNGU3OWYxNWY3ZWY0MWExNjhhMjExOTQx
+    YjhkNDUxOTQwODliYjAxMDM5ZTZlZDhjYmFiNzE4NWVhMTc0NTc=

data/CHANGELOG.md

@@ -1,5 +1,21 @@
 # Release History
 
+### 0.8.0 / 2016-04-28
+
+#### Major changes
+
+* Add support for Translate API
+* Drop support for Search service
+
+#### Minor changes
+
+* Pub/Sub
+  * Add support for emulator (dlorenc)
+* Datastore
+  * Fix bug where entities were not properly marked persisted after being saved
+  * Fix bug in transaction delete accepting keys (timanovsky)
+  * Update access token logic to avoid expired credentials (timanovsky)
+
 ### 0.7.2 / 2016-04-01
 
 #### Changes

data/OVERVIEW.md

@@ -191,24 +191,6 @@ end
 projects = resource_manager.projects filter: "labels.env:production"
 ```
 
-# Search
-
-[Google Cloud Search](https://cloud.google.com/search/) ([docs](https://cloud.google.com/search/reference/rest/index)) 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.
-
-See the {Gcloud::Search gcloud-ruby Search API documentation} to learn how to connect to Cloud Search using this library.
-
-```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"]
-```
-
 # Storage
 
 [Google Cloud Storage](https://cloud.google.com/storage/) ([docs](https://cloud.google.com/storage/docs/json_api/)) allows you to store data on Google infrastructure with very high reliability, performance and availability, and can be used to distribute large data objects to users via direct download.
@@ -232,3 +214,26 @@ file.download "/tasks/attachments/#{file.name}"
 backup = storage.bucket "task-attachment-backups"
 file.copy backup, file.name
 ```
+
+# Translate
+
+[Google Translate](https://cloud.google.com/translate/) ([docs](https://cloud.google.com/translate/docs)) provides a simple, programmatic interface for translating an arbitrary string into any supported language. It is highly responsive, so websites and applications can integrate with Translate API for fast, dynamic translation of source text. Language detection is also available in cases where the source language is unknown.
+
+See the {Gcloud::Translate gcloud-ruby Translate API documentation} to learn how to connect to Google Translate using this library.
+
+```ruby
+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!"
+```
+

data/lib/gcloud.rb

@@ -311,33 +311,6 @@ module Gcloud
 
   # rubocop:enable Metrics/LineLength
 
-  ##
-  # Creates a new object for connecting 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, 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]
-  #
-  # @example
-  #   require "gcloud"
-  #
-  def search scope: nil
-    require "gcloud/search"
-    Gcloud.search @project, @keyfile, scope: scope
-  end
-
   ##
   # Creates a new object for connecting to the Logging service.
   # Each call creates a new connection.
@@ -374,4 +347,45 @@ module Gcloud
     require "gcloud/logging"
     Gcloud.logging @project, @keyfile, scope: scope
   end
+
+  ##
+  # Creates a new object for connecting to the Translate service.
+  # Each call creates a new connection.
+  #
+  # Unlike other Cloud Platform services, which authenticate using a project ID
+  # and OAuth 2.0 credentials, Google Translate API requires a public API access
+  # key. (This may change in future releases of Google Translate API.) Follow
+  # the general instructions at [Identifying your application to
+  # Google](https://cloud.google.com/translate/v2/using_rest#auth), and the
+  # specific instructions for [Server
+  # 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)
+  #
+  # @return [Gcloud::Translate::Api]
+  #
+  # @example
+  #   require "gcloud"
+  #
+  #   gcloud = Gcloud.new
+  #   translate = gcloud.translate "api-key-abc123XYZ789"
+  #
+  #   translation = translate.translate "Hello world!", to: "la"
+  #   translation.text #=> "Salve mundi!"
+  #
+  # @example Using API Key from the environment variable.
+  #   require "gcloud"
+  #
+  #   ENV["TRANSLATE_KEY"] = "api-key-abc123XYZ789"
+  #
+  #   gcloud = Gcloud.new
+  #   translate = gcloud.translate
+  #
+  #   translation = translate.translate "Hello world!", to: "la"
+  #   translation.text #=> "Salve mundi!"
+  #
+  def translate key = nil
+    require "gcloud/translate"
+    Gcloud.translate key
+  end
 end

data/lib/gcloud/datastore/credentials.rb

@@ -36,7 +36,7 @@ module Gcloud
       # Sign OAuth 2.0 API calls.
       def sign_http_request request
         if @client
-          @client.fetch_access_token! if @client.expired?
+          @client.fetch_access_token! if @client.expires_within? 30
           @client.generate_authenticated_request request: request
         end
         request

data/lib/gcloud/datastore/dataset.rb

@@ -127,6 +127,8 @@ module Gcloud
         save_entities_to_mutation entities, mutation
         response = connection.commit mutation
         auto_id_assign_ids response.mutation_result.insert_auto_id_key
+        # Make sure all entity keys are frozen so all show as persisted
+        entities.each { |e| e.key.freeze unless e.persisted? }
         entities
       end
 

data/lib/gcloud/datastore/transaction.rb

@@ -45,6 +45,7 @@ module Gcloud
       #
       def save *entities
         save_entities_to_mutation entities, shared_mutation
+        @_saved_entities += entities
         # Do not save or assign auto_ids yet
         entities
       end
@@ -59,9 +60,12 @@ module Gcloud
       #     end
       #   end
       #
-      def delete *entities
+      def delete *entities_or_keys
+        keys = entities_or_keys.map do |e_or_k|
+          e_or_k.respond_to?(:key) ? e_or_k.key.to_proto : e_or_k.to_proto
+        end
         shared_mutation.tap do |m|
-          m.delete = entities.map { |entity| entity.key.to_proto }
+          m.delete = keys
         end
         # Do not delete yet
         true
@@ -87,6 +91,8 @@ module Gcloud
 
         response = connection.commit shared_mutation, @id
         auto_id_assign_ids response.mutation_result.insert_auto_id_key
+        # Make sure all entity keys are frozen so all show as persisted
+        @_saved_entities.each { |e| e.key.freeze unless e.persisted? }
         true
       end
 
@@ -108,6 +114,7 @@ module Gcloud
         @shared_mutation = nil
         @id = nil
         @_auto_id_entities = []
+        @_saved_entities = []
       end
 
       protected

data/lib/gcloud/pubsub.rb

@@ -49,6 +49,11 @@ module Gcloud
   #
   def self.pubsub project = nil, keyfile = nil, scope: nil
     project ||= Gcloud::Pubsub::Project.default_project
+    if ENV["PUBSUB_EMULATOR_HOST"]
+      ps = Gcloud::Pubsub::Project.new project, :this_channel_is_insecure
+      ps.service.host = ENV["PUBSUB_EMULATOR_HOST"]
+      return ps
+    end
     if keyfile.nil?
       credentials = Gcloud::Pubsub::Credentials.default scope: scope
     else
@@ -424,6 +429,35 @@ module Gcloud
   # sub.topic.name #=> "projects/other-project-id/topics/other-topic"
   # ```
   #
+  # ## Using the Gcloud SDK Emulator
+  #
+  # To develop and test your application locally, you can use the [Google Cloud
+  # Pub/Sub Emulator](https://cloud.google.com/pubsub/emulator), which provides
+  # [local
+  # emulation](https://cloud.google.com/sdk/gcloud/reference/beta/emulators/) of
+  # the production Google Cloud Pub/Sub environment. You can start the Google
+  # Cloud Pub/Sub emulator using the `gcloud` command-line tool.
+  #
+  # To configure your ruby code to use the emulator, set the
+  # `PUBSUB_EMULATOR_HOST` environment variable to the host and port where the
+  # emulator is running. The value can be set as an environment variable in the
+  # shell running the ruby code, or can be set directly in the ruby code as
+  # shown below.
+  #
+  # ```ruby
+  # require "gcloud"
+  #
+  # # Make Pub/Sub use the emulator
+  # ENV["PUBSUB_EMULATOR_HOST"] = "localhost:8918"
+  #
+  # gcloud = Gcloud.new "emulator-project-id"
+  # pubsub = gcloud.pubsub
+  #
+  # # Get a topic in the current project
+  # my_topic = pubsub.new_topic "my-topic"
+  # my_topic.name #=> "projects/emulator-project-id/topics/my-topic"
+  # ```
+  #
   module Pubsub
   end
 end

data/lib/gcloud/pubsub/service.rb

@@ -36,6 +36,7 @@ module Gcloud
       end
 
       def creds
+        return credentials if insecure?
         GRPC::Core::ChannelCredentials.new.compose \
           GRPC::Core::CallCredentials.new credentials.client.updater_proc
       end
@@ -58,6 +59,10 @@ module Gcloud
       end
       attr_accessor :mocked_iam
 
+      def insecure?
+        credentials == :this_channel_is_insecure
+      end
+
       ##
       # Gets the configuration of a topic.
       # Since the topic only has the name attribute,

data/lib/gcloud/translate.rb

@@ -0,0 +1,236 @@
+# 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"
+require "gcloud/translate/api"
+
+module Gcloud
+  ##
+  # Creates a new object for connecting to the Translate service.
+  # Each call creates a new connection.
+  #
+  # Unlike other Cloud Platform services, which authenticate using a project ID
+  # and OAuth 2.0 credentials, Google Translate API requires a public API access
+  # key. (This may change in future releases of Google Translate API.) Follow
+  # the general instructions at [Identifying your application to
+  # Google](https://cloud.google.com/translate/v2/using_rest#auth), and the
+  # specific instructions for [Server
+  # 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)
+  #
+  # @return [Gcloud::Translate::Api]
+  #
+  # @example
+  #   require "gcloud"
+  #
+  #   translate = Gcloud.translate "api-key-abc123XYZ789"
+  #
+  #   translation = translate.translate "Hello world!", to: "la"
+  #   translation.text #=> "Salve mundi!"
+  #
+  # @example Using API Key from the environment variable.
+  #   require "gcloud"
+  #
+  #   ENV["TRANSLATE_KEY"] = "api-key-abc123XYZ789"
+  #
+  #   translate = Gcloud.translate
+  #
+  #   translation = translate.translate "Hello world!", to: "la"
+  #   translation.text #=> "Salve mundi!"
+  #
+  def self.translate key = nil
+    Gcloud::Translate::Api.new key
+  end
+
+  ##
+  # # Google Translate API
+  #
+  # [Google Translate API](https://cloud.google.com/translate/) provides a
+  # simple, programmatic interface for translating an arbitrary string into any
+  # supported language. It is highly responsive, so websites and applications
+  # can integrate with Translate API for fast, dynamic translation of source
+  # text. Language detection is also available in cases where the source
+  # language is unknown.
+  #
+  # Translate API supports more than ninety different languages, from Afrikaans
+  # to Zulu. Used in combination, this enables translation between thousands of
+  # language pairs. Also, you can send in HTML and receive HTML with translated
+  # text back. You don't need to extract your source text or reassemble the
+  # translated content.
+  #
+  # ## Authenticating
+  #
+  # Unlike other Cloud Platform services, which authenticate using a project ID
+  # and OAuth 2.0 credentials, Translate API requires a public API access key.
+  # (This may change in future releases of Translate API.) Follow the general
+  # instructions at [Identifying your application to
+  # Google](https://cloud.google.com/translate/v2/using_rest#auth), and the
+  # specific instructions for [Server
+  # keys](https://cloud.google.com/translate/v2/using_rest#creating-server-api-keys).
+  #
+  # ## Translating texts
+  #
+  # Translating text from one language to another is easy (and extremely fast.)
+  # The only required arguments to {Gcloud::Translate::Api#translate} are a
+  # string and the [ISO
+  # 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) code of the
+  # language to which you wish to translate.
+  #
+  # ```ruby
+  # 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!"
+  # ```
+  #
+  # You may want to use the `from` option to specify the language of the source
+  # text, as the following example illustrates. (Single words do not give
+  # Translate API much to work with.)
+  #
+  # ```ruby
+  # require "gcloud"
+  #
+  # gcloud = Gcloud.new
+  # translate = gcloud.translate
+  #
+  # translation = translate.translate "chat", to: "en"
+  #
+  # translation.detected? #=> true
+  # translation.from #=> "en"
+  # translation.text #=> "chat"
+  #
+  # translation = translate.translate "chat", from: "fr", to: "en"
+  #
+  # translation.detected? #=> false
+  # translation.from #=> "fr"
+  # translation.text #=> "cat"
+  # ```
+  #
+  # You can pass multiple texts to {Gcloud::Translate::Api#translate}.
+  #
+  # ```ruby
+  # require "gcloud"
+  #
+  # gcloud = Gcloud.new
+  # translate = gcloud.translate
+  #
+  # translations = translate.translate "chien", "chat", from: "fr", to: "en"
+  #
+  # translations.size #=> 2
+  # translations[0].origin #=> "chien"
+  # translations[0].text #=> "dog"
+  # translations[1].origin #=> "chat"
+  # translations[1].text #=> "cat"
+  # ```
+  #
+  # By default, any HTML in your source text will be preserved.
+  #
+  # ```ruby
+  # require "gcloud"
+  #
+  # gcloud = Gcloud.new
+  # translate = gcloud.translate
+  #
+  # translation = translate.translate "<strong>Hello</strong> world!",
+  #                                   to: :la
+  # translation.text #=> "<strong>Salve</strong> mundi!"
+  # ```
+  #
+  # ## Detecting languages
+  #
+  # You can use {Gcloud::Translate::Api#detect} to see which language the
+  # Translate API ranks as the most likely source language for a text. The
+  # `confidence` score is a float value between `0` and `1`.
+  #
+  # ```ruby
+  # require "gcloud"
+  #
+  # gcloud = Gcloud.new
+  # translate = gcloud.translate
+  #
+  # detection = translate.detect "chat"
+  #
+  # detection.text #=> "chat"
+  # detection.language #=> "en"
+  # detection.confidence #=> 0.59922177
+  # ```
+  #
+  # You can pass multiple texts to {Gcloud::Translate::Api#detect}.
+  #
+  # ```ruby
+  # require "gcloud"
+  #
+  # gcloud = Gcloud.new
+  # translate = gcloud.translate
+  #
+  # detections = translate.detect "chien", "chat"
+  #
+  # detections.size #=> 2
+  # detections[0].text #=> "chien"
+  # detections[0].language #=> "fr"
+  # detections[0].confidence #=> 0.7109375
+  # detections[1].text #=> "chat"
+  # detections[1].language #=> "en"
+  # detections[1].confidence #=> 0.59922177
+  # ```
+  #
+  # ## Listing supported languages
+  #
+  # Translate API adds new languages frequently. You can use
+  # {Gcloud::Translate::Api#languages} to query the list of supported languages.
+  #
+  # ```ruby
+  # require "gcloud"
+  #
+  # gcloud = Gcloud.new
+  # translate = gcloud.translate
+  #
+  # languages = translate.languages
+  #
+  # languages.size #=> 104
+  # languages[0].code #=> "af"
+  # languages[0].name #=> nil
+  # ```
+  #
+  # To receive the names of the supported languages, as well as their [ISO
+  # 639-1](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes) codes, provide
+  # the code for the language in which you wish to receive the names.
+  #
+  # ```ruby
+  # require "gcloud"
+  #
+  # gcloud = Gcloud.new
+  # translate = gcloud.translate
+  #
+  # languages = translate.languages "en"
+  #
+  # languages.size #=> 104
+  # languages[0].code #=> "af"
+  # languages[0].name #=> "Afrikaans"
+  # ```
+  #
+  module Translate
+  end
+end