google-cloud-translate 1.2.1 → 1.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 255d2fe2c7ab9d9324f2b2c0b71b69a68f3e11abd5ce2f1866a189098ff4fd0c
-  data.tar.gz: adbeb37379bab6faae3b0e7fff4a9ceff972e7f38f98c398937fcbba35eb964f
+  metadata.gz: 20aedb79118d5f0746a0518fd9d62a707a0ee58f3538c4d8e50fe5868a92ca7c
+  data.tar.gz: 2df9d69ede2de2f7f0a6b206c44ca8d31849b91763af7c94283cd84723909488
 SHA512:
-  metadata.gz: 519126ed69768a715327ccb20e6fb2c8d574155010f9cbf5c12584f23977ffc822ceab954cd8ffc51c3b3236421cdf03dbb426ffcd98821c522b78b45c6ec8eb
-  data.tar.gz: b39dec563bbe53682c7493792b869eaa9dfb9b09ddd8fcd1901f67047e451fee529935af8a0404637bc4ad3e3278735a25cc6c6a47033f272b143ada9fadf02c
+  metadata.gz: 2a5e0b020842c1e96dcd033c06c12e69e42b1f6c9fe894f31664fe3664683f5deaef4172239915f650bdf237c91167f3687d74d7c5991dc91b12edec53db3f69
+  data.tar.gz: af719e821badb9d811591774f41d62d84429e398592f8c6728d15102c33d76c84340d80e6f8ef5c3500382b18307835a41b61dcc0f4da95a08159df0209f093e

data/.yardopts

@@ -2,7 +2,14 @@
 --title=Google Cloud Translation API
 --markup markdown
 --markup-provider redcarpet
+--main OVERVIEW.md
 
 ./lib/**/*.rb
 -
-README.md
+OVERVIEW.md
+AUTHENTICATION.md
+CONTRIBUTING.md
+TROUBLESHOOTING.md
+CHANGELOG.md
+CODE_OF_CONDUCT.md
+LICENSE

data/README.md

@@ -4,7 +4,7 @@
 
 Translation API supports more than one hundred 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.
 
-- [google-cloud-translate API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-translate/latest)
+- [google-cloud-translate API documentation](http://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-translate/latest)
 - [google-cloud-translate on RubyGems](https://rubygems.org/gems/google-cloud-translate)
 - [Google Cloud Translation API documentation](https://cloud.google.com/translation/docs)
 
@@ -21,7 +21,7 @@ authentication using a project ID and OAuth 2.0 credentials. In addition,
 it supports authentication using a public API access key. (If both the API
 key and the project and OAuth 2.0 credentials are provided, the API key
 will be used.) Instructions and configuration options are covered in the
-[Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-translate/guides/authentication).
+[Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-translate/latest/file.AUTHENTICATION).
 
 ## Example
 
@@ -42,7 +42,7 @@ translation.text #=> "Salve mundi!"
 
 ## Enabling Logging
 
-To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below, or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger) that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
+To enable logging for this library, set the logger for the underlying [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The logger that you set may be a Ruby stdlib [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html) as shown below, or a [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-logging/latest/Google/Cloud/Logging/Logger) that will write logs to [Stackdriver Logging](https://cloud.google.com/logging/). See [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb) and the gRPC [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb) for additional information.
 
 Configuring a Ruby stdlib logger:
 
@@ -67,9 +67,9 @@ end
 This library is supported on Ruby 2.3+.
 
 Google provides official support for Ruby versions that are actively supported
-by Ruby Core—that is, Ruby versions that are either in normal maintenance or
-in security maintenance, and not end of life. Currently, this means Ruby 2.3
-and later. Older versions of Ruby _may_ still work, but are unsupported and not
+by Ruby Core—that is, Ruby versions that are either in normal maintenance or in
+security maintenance, and not end of life. Currently, this means Ruby 2.3 and
+later. Older versions of Ruby _may_ still work, but are unsupported and not
 recommended. See https://www.ruby-lang.org/en/downloads/branches/ for details
 about the Ruby support schedule.
 
@@ -81,15 +81,24 @@ This library follows [Semantic Versioning](http://semver.org/).
 
 Contributions to this library are always welcome and highly encouraged.
 
-See the [Contributing Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/guides/contributing) for more information on how to get started.
+See the [Contributing
+Guide](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-translate/latest/file.CONTRIBUTING)
+for more information on how to get started.
 
-Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See [Code of Conduct](../CODE_OF_CONDUCT.md) for more information.
+Please note that this project is released with a Contributor Code of Conduct. By
+participating in this project you agree to abide by its terms. See [Code of
+Conduct](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-translate/latest/file.CODE_OF_CONDUCT)
+for more information.
 
 ## License
 
-This library is licensed under Apache 2.0. Full license text is available in [LICENSE](LICENSE).
+This library is licensed under Apache 2.0. Full license text is available in
+[LICENSE](https://googlecloudplatform.github.io/google-cloud-ruby/docs/google-cloud-translate/latest/file.LICENSE).
 
 ## Support
 
-Please [report bugs at the project on Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues).
-Don't hesitate to [ask questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby) about the client or APIs on [StackOverflow](http://stackoverflow.com).
+Please [report bugs at the project on
+Github](https://github.com/GoogleCloudPlatform/google-cloud-ruby/issues). Don't
+hesitate to [ask
+questions](http://stackoverflow.com/questions/tagged/google-cloud-platform+ruby)
+about the client or APIs on [StackOverflow](http://stackoverflow.com).

data/lib/google-cloud-translate.rb

@@ -34,7 +34,7 @@ module Google
     # it supports authentication using a public API access key. (If both the API
     # key and the project and OAuth 2.0 credentials are provided, the API key
     # will be used.) Instructions and configuration options are covered in the
-    # [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-translate/guides/authentication).
+    # {file:AUTHENTICATION.md Authentication Guide}.
     #
     # @param [String] key a public API access key (not an OAuth 2.0 token)
     # @param [String, Array<String>] scope The OAuth 2.0 scopes controlling the
@@ -87,7 +87,7 @@ module Google
     # it supports authentication using a public API access key. (If both the API
     # key and the project and OAuth 2.0 credentials are provided, the API key
     # will be used.) Instructions and configuration options are covered in the
-    # [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-translate/guides/authentication).
+    # {file:AUTHENTICATION.md Authentication Guide}.
     #
     # @param [String] key a public API access key (not an OAuth 2.0 token)
     # @param [String] project_id Project identifier for the Cloud Translation

data/lib/google/cloud/translate.rb

@@ -36,209 +36,7 @@ module Google
     # with translated text back. You don't need to extract your source text or
     # reassemble the translated content.
     #
-    # ## Authenticating
-    #
-    # Like other Cloud Platform services, Google Cloud Translation API supports
-    # authentication using a project ID and OAuth 2.0 credentials. In addition,
-    # it supports authentication using a public API access key. (If both the API
-    # key and the project and OAuth 2.0 credentials are provided, the API key
-    # will be used.) Instructions and configuration options are covered in the
-    # [Authentication Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-translate/guides/authentication).
-    #
-    # ## Enabling Logging
-    #
-    # To enable logging for this library, set the logger for the underlying
-    # [gRPC](https://github.com/grpc/grpc/tree/master/src/ruby) library. The
-    # logger that you set may be a Ruby stdlib
-    # [`Logger`](https://ruby-doc.org/stdlib-2.5.0/libdoc/logger/rdoc/Logger.html)
-    # as shown below, or a
-    # [`Google::Cloud::Logging::Logger`](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-logging/latest/google/cloud/logging/logger)
-    # that will write logs to [Stackdriver
-    # Logging](https://cloud.google.com/logging/). See
-    # [grpc/logconfig.rb](https://github.com/grpc/grpc/blob/master/src/ruby/lib/grpc/logconfig.rb)
-    # and the gRPC
-    # [spec_helper.rb](https://github.com/grpc/grpc/blob/master/src/ruby/spec/spec_helper.rb)
-    # for additional information.
-    #
-    # Configuring a Ruby stdlib logger:
-    #
-    # ```ruby
-    # require "logger"
-    #
-    # module MyLogger
-    #   LOGGER = Logger.new $stderr, level: Logger::WARN
-    #   def logger
-    #     LOGGER
-    #   end
-    # end
-    #
-    # # Define a gRPC module-level logger method before grpc/logconfig.rb loads.
-    # module GRPC
-    #   extend MyLogger
-    # end
-    # ```
-    #
-    # ## Translating texts
-    #
-    # Translating text from one language to another is easy (and extremely
-    # fast.) The only required arguments to
-    # {Google::Cloud::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 "google/cloud/translate"
-    #
-    # translate = Google::Cloud::Translate.new
-    #
-    # 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 Translation API much to work with.)
-    #
-    # ```ruby
-    # require "google/cloud/translate"
-    #
-    # translate = Google::Cloud::Translate.new
-    #
-    # 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 {Google::Cloud::Translate::Api#translate}.
-    #
-    # ```ruby
-    # require "google/cloud/translate"
-    #
-    # translate = Google::Cloud::Translate.new
-    #
-    # 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 "google/cloud/translate"
-    #
-    # translate = Google::Cloud::Translate.new
-    #
-    # translation = translate.translate "<strong>Hello</strong> world!",
-    #                                   to: :la
-    # translation.text #=> "<strong>Salve</strong> mundi!"
-    # ```
-    #
-    # ## Detecting languages
-    #
-    # You can use {Google::Cloud::Translate::Api#detect} to see which language
-    # the Translation API ranks as the most likely source language for a text.
-    # The `confidence` score is a float value between `0` and `1`.
-    #
-    # ```ruby
-    # require "google/cloud/translate"
-    #
-    # translate = Google::Cloud::Translate.new
-    #
-    # detection = translate.detect "chat"
-    #
-    # detection.text #=> "chat"
-    # detection.language #=> "en"
-    # detection.confidence #=> 0.59922177
-    # ```
-    #
-    # You can pass multiple texts to {Google::Cloud::Translate::Api#detect}.
-    #
-    # ```ruby
-    # require "google/cloud/translate"
-    #
-    # translate = Google::Cloud::Translate.new
-    #
-    # 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
-    #
-    # Translation API adds new languages frequently. You can use
-    # {Google::Cloud::Translate::Api#languages} to query the list of supported
-    # languages.
-    #
-    # ```ruby
-    # require "google/cloud/translate"
-    #
-    # translate = Google::Cloud::Translate.new
-    #
-    # 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 "google/cloud/translate"
-    #
-    # translate = Google::Cloud::Translate.new
-    #
-    # languages = translate.languages "en"
-    #
-    # languages.size #=> 104
-    # languages[0].code #=> "af"
-    # languages[0].name #=> "Afrikaans"
-    # ```
-    #
-    # ## Configuring retries and timeout
-    #
-    # 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.
-    #
-    # You can also set the request `timeout` value in seconds.
-    #
-    # ```ruby
-    # require "google/cloud/translate"
-    #
-    # translate = Google::Cloud::Translate.new retries: 10, timeout: 120
-    # ```
+    # See {file:OVERVIEW.md Translation Overview}.
     #
     module Translate
       ##
@@ -250,8 +48,7 @@ module Google
       # addition, it supports authentication using a public API access key. (If
       # both the API key and the project and OAuth 2.0 credentials are provided,
       # the API key will be used.) Instructions and configuration options are
-      # covered in the [Authentication
-      # Guide](https://googlecloudplatform.github.io/google-cloud-ruby/#/docs/google-cloud-translate/guides/authentication).
+      # covered in the {file:AUTHENTICATION.md Authentication Guide}.
       #
       # @param [String] project_id Project identifier for the Cloud Translation
       #   service you are connecting to. If not present, the default project for

data/lib/google/cloud/translate/version.rb

@@ -16,7 +16,7 @@
 module Google
   module Cloud
     module Translate
-      VERSION = "1.2.1".freeze
+      VERSION = "1.2.2".freeze
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: google-cloud-translate
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.2.2
 platform: ruby
 authors:
 - Mike Moore
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-21 00:00:00.000000000 Z
+date: 2018-09-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: google-cloud-core
@@ -183,16 +183,16 @@ dependencies:
   name: yard-doctest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.1.13
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.8
+        version: 0.1.13
 description: google-cloud-translate is the official library for Google Cloud Translation
   API.
 email: