yandex_cloud 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 297479377896994a62b9eae0d0481c58b701c9bc45d53812c0539cb5c43cd433
-  data.tar.gz: 9aa260fe5f0d97ff33c42ef4ffce432116c25c119366b9dbe1d22d49bd984047
+  metadata.gz: '08e9fc757c30c900829a38de1b39211d48a3cbd087a0c906acb2dd94f2ea5c93'
+  data.tar.gz: 11b41c648e0e050e459c0b6702faa6b65f75f2518d0be09bf1709bd00b576898
 SHA512:
-  metadata.gz: 90e35db9dd9110aeba9520c7737d729cd5ee0b42fe6083ebe5b5f8f3bea21753e02f9ddbc3f9d0bad0e0a30a743efbf0d2061072ba12cb85823fead6b1766222
-  data.tar.gz: 2ce35a6c50a764ec0152d328f469ed85b18ade85caa1edd6e9dd41670d5910d95dd019ccf37a61dff0210faf399972d61bd79571f26f319fc56232ea4c7508a7
+  metadata.gz: a359eed84de6a8a93a8930896fe5d536fa82ed7439c48ea9b5cb4a0a9f41975ba3ccbd69e73ee7708c2688e895a273b2d17ba8bfa483c60ac069e529d431a461
+  data.tar.gz: 7f2386eebf827e70bd653893738256ab31237c1f73f60b28e98fa32cf75e9027f5ddab412e8d6a587ea717bf5ec6a08e4500e5f2d61586ddc104afcaf72e3422

data/.env.example

@@ -1 +1,2 @@
 YANDEX_CLOUD_API_KEY=
+TRANSLATE_FOLDER_ID=

data/.rubocop.yml

@@ -39,7 +39,7 @@ Layout/AlignHash:
 Style/GuardClause:
   Enabled: false
 
-Style/FileName:
+Naming:
   Enabled: false
 
 Style/FormatStringToken:

data/CHANGELOG.md

@@ -4,12 +4,21 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
-## Unreleased
+## [0.3.0] - 2019-02-01
+### Added
+- languages() in module YandexCloud::Translate
+- detect() in module YandexCloud::Translate
+- translate() in module YandexCloud::Translate
+
+### Modified
+- README
+
+## [0.2.0] - 2019-02-01
 ### Added
 - CHANGELOG
 - dotenv support
-- YandexCloud::Auth with token()
-- specs for YandexCloud::Auth.token()
+- YandexCloud::Auth module with token()
+- specs for token() in module YandexCloud::Auth
 
 ### Modified
 - README

data/README.md

@@ -28,7 +28,7 @@ You can use your Oauth token directly in spesific requests or put it to the ENV
 
 ## Using
 
-### Get IAM-token for cloud API access
+## Get IAM-token for cloud API access
 
 Request for getting IAM-token for access to cloud API. Valid 12 hours.
 
@@ -37,7 +37,7 @@ Request for getting IAM-token for access to cloud API. Valid 12 hours.
 auth_service = YandexCloud::Auth.new
 auth_service.token
 
-# or with oauth_token in request
+# or with oauth_token in service declaration
 auth_service = YandexCloud::Auth.new(oauth_token: oauth_token)
 auth_service.token
 ```
@@ -46,10 +46,99 @@ auth_service.token
 
 ```ruby
 # successful response
-{ "iamToken" => iam_token }
+{ 'iamToken' => iam_token }
 
 # response with errors
-{ "code" => 16, "message" => "Token is invalid or has expired.", "details" => [...] } 
+{ 'code' => 16, 'message' => 'Token is invalid or has expired.', 'details' => [...] } 
+```
+
+## Translate service
+
+### Configuration
+
+For using Translate service you need additionally get FOLDER_ID.
+
+Instruction for getting FOLDER_ID is [here](https://cloud.yandex.com/docs/translate/concepts/auth)
+
+You can use your FOLDER_ID directly in spesific requests or put it to the ENV variables.
+
+```ruby
+# with FOLDER_ID in ENV
+translator = YandexCloud::Translate.new(iam_token: iam_token)
+
+# or with FOLDER_ID in service declaration
+translator = YandexCloud::Translate.new(iam_token: iam_token, folder_id: '12345')
+```
+
+#### Options
+
+    iam_token - IAM-token, required
+    folder_id - folder ID of your account at YandexCloud, optional
+
+### Supported languages
+
+Request for getting list of supported languages is #languages.
+
+```ruby
+translator.languages()
+```
+
+#### Responses
+
+```ruby
+# successful response
+{ 'languages' => [...] }
+
+# response with errors
+{ 'error_message' => '' }
+```
+
+### Detection
+
+Request for detecting language of text is #detect.
+
+```ruby
+translator.detect(text: 'Hello')
+```
+
+#### Options
+
+    text - text for detection, required
+    hint - list of possible languages, optional, example - 'en,ru'
+
+#### Responses
+
+```ruby
+# successful response
+{ 'language' => 'es' }
+
+# response with errors
+{ 'error_message' => '' }
+```
+
+### Translation
+
+Request for translating text is #translate.
+
+```ruby
+translator.translate(text: 'Hola', target: 'en')
+```
+
+#### Options
+
+    text - text for detection, required
+    source - source language, ISO 639-1 format (like 'en'), optional
+    target - target language, ISO 639-1 format (like 'ru'), required
+    format - text format, one of the [plain|html], default - plain, optional
+
+#### Responses
+
+```ruby
+# successful response
+{ 'translations' => [{ 'text' => 'Hello' }]}
+
+# response with errors
+{ 'error_message' => '' }
 ```
 
 ## Contributing

data/lib/yandex_cloud.rb

@@ -1,6 +1,7 @@
 require 'dotenv/load'
 require_relative 'yandex_cloud/version'
 require_relative 'yandex_cloud/auth'
+require_relative 'yandex_cloud/translate'
 
 # define main endpoint
 module YandexCloud

data/lib/yandex_cloud/translate.rb

@@ -0,0 +1,24 @@
+require 'httparty'
+require_relative 'translate/languages'
+require_relative 'translate/detect'
+require_relative 'translate/translate'
+
+module YandexCloud
+  # Authentification requests
+  class Translate
+    include HTTParty
+    include YandexCloud::Translate::Languages
+    include YandexCloud::Translate::Detect
+    include YandexCloud::Translate::Translate
+
+    base_uri 'https://translate.api.cloud.yandex.net/translate/v1'
+    format :json
+
+    attr_reader :iam_token, :folder_id
+
+    def initialize(args = {})
+      @iam_token = args[:iam_token]
+      @folder_id = args[:folder_id] || ENV['TRANSLATE_FOLDER_ID']
+    end
+  end
+end

data/lib/yandex_cloud/translate/detect.rb

@@ -0,0 +1,15 @@
+module YandexCloud
+  class Translate
+    # Module for detecting language of the text
+    module Detect
+      # Detect
+      def detect(args = {})
+        # define params for request
+        body = { 'folderId' => folder_id, 'hint' => args[:hint], 'text' => args[:text] }
+        headers = { 'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => "Bearer #{iam_token}" }
+        # make request
+        self.class.post('/detect', query: body, headers: headers).parsed_response
+      end
+    end
+  end
+end

data/lib/yandex_cloud/translate/languages.rb

@@ -0,0 +1,15 @@
+module YandexCloud
+  class Translate
+    # Module for getting list of languages from Translation service
+    module Languages
+      # Get list
+      def languages
+        # define params for request
+        body = { 'folderId' => folder_id }
+        headers = { 'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => "Bearer #{iam_token}" }
+        # make request
+        self.class.post('/languages', query: body, headers: headers).parsed_response
+      end
+    end
+  end
+end

data/lib/yandex_cloud/translate/translate.rb

@@ -0,0 +1,15 @@
+module YandexCloud
+  class Translate
+    # Module for translation for text or phrase
+    module Translate
+      # Translate
+      def translate(args = {})
+        # define params for request
+        body = { 'folderId' => folder_id, 'text' => args[:text], 'source' => args[:source], 'target' => args[:target], 'format' => args[:format] }
+        headers = { 'Content-Type' => 'application/x-www-form-urlencoded', 'Authorization' => "Bearer #{iam_token}" }
+        # make request
+        self.class.post('/translate', query: body, headers: headers).parsed_response
+      end
+    end
+  end
+end

data/lib/yandex_cloud/version.rb

@@ -1,3 +1,3 @@
 module YandexCloud
-  VERSION = '0.2.0'.freeze
+  VERSION = '0.3.0'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yandex_cloud
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Anton Bogdanov
@@ -103,6 +103,10 @@ files:
 - lib/yandex_cloud.rb
 - lib/yandex_cloud/auth.rb
 - lib/yandex_cloud/auth/iam_token.rb
+- lib/yandex_cloud/translate.rb
+- lib/yandex_cloud/translate/detect.rb
+- lib/yandex_cloud/translate/languages.rb
+- lib/yandex_cloud/translate/translate.rb
 - lib/yandex_cloud/version.rb
 - yandex_cloud.gemspec
 homepage: https://github.com/kortirso/yandex-cloud