yandex-translator-api 0.9.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c0f4b1bdcb3caa7e79e5debce7faf671cbe7f7db
-  data.tar.gz: 05b5cfec72eaa8ccfcb2830bc43a5dee11eab241
+  metadata.gz: 46d9608bcfdc944f75b0b5f4df553b3db20cef4a
+  data.tar.gz: ead7ffaf10b823fa0fae61c843374c37fedcef42
 SHA512:
-  metadata.gz: 3a2209a2e80482dffff70bb557d28a488320ac4cff0d05d207400317b39d80526eeafd1916bdafa33132b445ea09dcad75d595d7ed58c6163fc2399e129c0070
-  data.tar.gz: 412c3a1c025e1ea7924bcb032e53f339a460724cb210aed7ea4c561362ccbef47cdcbe83c24dc5ec4344a069866322e31781a7dcf3587b35051e25045a2bf8e7
+  metadata.gz: 67c3ed3b8634f8f1108e6d0a495f97555fe6a16ee84c9308a2d23cb7778385e8ac6c9bc5cff63c8f2dba55a888320f0cb23f1240b807c229601008a30f3681a2
+  data.tar.gz: 43d444a507b52c87a0f588c7421be5835994360fb51b0a40f8f5cc325a1b7558d4e4b938a5ae3c0d4fddcc781a5ffe62b4182a63e5c87a2bf3a2f823f698e027

data/README.md

@@ -1,6 +1,6 @@
 # Yandex Translator API
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/yandex`. To experiment with that code, run `bin/console` for an interactive prompt.
+Text translating by Yandex Translator API
 
 ## Installation
 
@@ -20,20 +20,51 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Create Translator object.
 
-## Development
+```ruby
+  translator = Yandex::Translator.new('api_key')
+```
+
+### Langs
+
+Request for getting possible translation directions is #langs.
+
+```ruby
+  translator.langs
+```
+
+    It returns array of possible translations or error.
+
+### Detect
+
+Request for detecting language of the text is #detect.
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```ruby
+  translator.detect text: 'Hello', hint: 'en,de'
+```
+
+    It returns locale of the text or error.
+    text - text for detecting, required param
+    hint - list of possible languages
+
+### Translate
+
+Request for translating of the text is #translate.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+  translator.translate text: 'Hello', from: 'en', to: 'ru'
+```
+
+    It returns translated text or error.
+    text - text for detecting, required param
+    from - language of the text
+    to - translating direction, required param
 
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/kortirso/yandex-translator-api.
 
-
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/yandex/translator/detect.rb

@@ -2,7 +2,7 @@ module Yandex
     class Translator
         module Detect
 
-            def detect(args)
+            def detect(args = {})
                 check_args(text: args[:text])
                 response = call('/detect', { hint: args[:hint], text: args[:text] })
                 JSON.parse(response.body)['lang']

data/lib/yandex/translator/translate.rb

@@ -2,7 +2,7 @@ module Yandex
     class Translator
         module Translate
 
-            def translate(args)
+            def translate(args = {})
                 check_args(text: args[:text], to: args[:to])
                 translate_direction = args[:from].nil? ? args[:to] : "#{args[:from]}-#{args[:to]}"
                 response = call('/translate', { lang: translate_direction, text: args[:text] })

data/lib/yandex/version.rb

@@ -1,3 +1,3 @@
 module Yandex
-  VERSION = '0.9.2'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: yandex-translator-api
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Anton Bogdanov
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-16 00:00:00.000000000 Z
+date: 2017-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler