yandex_translator 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '0579b88ecb55af9950551a6a242d5aa77e9569ce'
-  data.tar.gz: 1d97277044165f1af460a8733022ab3c016e91a3
+  metadata.gz: 86053b58b044ca2b8cb7e9afa2c392fe67fddb0d
+  data.tar.gz: 8162d1912471f0215c3c967779e2a27c59222893
 SHA512:
-  metadata.gz: 446ef411d73d0a9039a98271476efb13a87d8f80b95c047f9d0996efa0b6f480afbb28de9338911e4bda260600a04bc5621aecda809674d40d802f14a4edc823
-  data.tar.gz: 2838d3d2eefaeb45e0decbf54cf1bd2395890eb163610ad337ed012ad3f7bfda35c6d7bd6834e8bb44ea2cc89892e56916ec2573a9f0cf2d42381d0b4d677341
+  metadata.gz: 956e37fdd4adeb7af34673ad7659f4ea9e607cfe56df54cd09ea8b40ecfa170c8252e95b7a9be77f1e8cc63bce87649a8fa9646de922eab85dea9fbc83f3eafa
+  data.tar.gz: 351bada1a7ba9caa2551fa0cebddeb2cc66d7a6ff0d1c5e2ff511b7133468273c21119cc62ebca85bc9f59d7fb6be3b548d0b37235e41acec82514025d6dac1f

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea/
+*.gem

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in yandex_translator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Eeeeevgen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+# YandexTranslator::Translator
+
+A library for translating text using Yandex Translate API version 1.5 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'yandex_translator'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install yandex_translator
+
+## Usage
+
+1. Create translator object using your API key. You can obtain a key [here](https://tech.yandex.ru/keys/get/?service=trnsl).
+
+```ruby
+translator = YandexTranslator::Translator.new(key)
+```
+
+2. To get the list of available translation directions and transcriptions of languages abbreviations use method **lang_list**:
+
+```ruby
+translator.lang_list(text, hint=nil)
+```
+
+3. To get possible text languages use method **lang_detect**:
+
+```ruby
+translator.lang_detect(text, hint=nil)
+```
+
+4. To translate text use method **translate**:
+
+```ruby
+translator.translate(text, lang, format:nil, options:nil)
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+require 'yard'
+
+task :default => :test
+RSpec::Core::RakeTask.new('spec')
+YARD::Rake::YardocTask.new

data/lib/yandex_translator/version.rb

@@ -0,0 +1,3 @@
+module YandexTranslator
+  VERSION = "0.1.1"
+end

data/lib/yandex_translator.rb

@@ -0,0 +1,79 @@
+require "yandex_translator/version"
+
+# A library for translating text using Yandex Translate API version 1.5
+#
+module YandexTranslator
+  require 'net/http'
+  require 'json'
+
+  class YandexError < StandardError; end
+
+  class Translator
+    attr_accessor :key, :detected
+    @@url_base = 'https://translate.yandex.net/api/v1.5/tr.json/'
+
+    # Returns the Translator object
+    #
+    def initialize(key)
+      @key = key
+      @detected = nil
+    end
+
+    # Returns the list of available translation pairs and
+    # If the _lang_ argument is set also returns transcriptions of languages abbreviations
+    #
+    def lang_list(lang=nil)
+      url = @@url_base + 'getLangs?' + 'key=' + @key
+      if lang then url += '&ui=' + lang end
+      url = URI(url)
+      res = JSON.parse(Net::HTTP.get(url))
+      check_errors(res)
+      return res
+    end
+
+    # Returns possible text languages
+    # The _hint_ argument defaults to *nil*, can be a string or an array of prefered languages
+    #
+    def lang_detect(text, hint=nil)
+      url = @@url_base + 'detect?key=' + @key + '&text=' + URI::encode(text)
+      if hint
+        url += '&hint='
+        if hint.is_a?(String)  # parse hint if it is a string or array
+          url += hint
+        else
+          hint.each { |x| url += x + ','}
+          url = url[0..-2]
+        end
+      end
+      url = URI(url)
+      res = JSON.parse(Net::HTTP.get(url))
+      check_errors(res)
+      return res['lang']
+    end
+
+    # Return the translation of the _text_ argument
+    # _lang_ argument can be 2 types:
+    # * The pair of the languages "from-to" ('en-ru')
+    # * One destination language ('en')
+    # _format_ argument defaults to *nil*. Can be "plain" for plain text or "html" for HTMl marked text
+    # _options_ argument defaults to *nil*. Can be "1" to include to the response the autodetected language of the source text. You can obtain it by attribute *detected*
+    def translate(text, lang, format:nil, options:nil)
+      url = @@url_base + 'translate?' + 'key=' + @key + '&' + 'text=' + URI::encode(text) + '&' + 'lang=' + lang
+      if format then url += '&format=' + format end
+      if options then url += '&options=' + options.to_s end
+
+      url = URI(url)
+      res = JSON.parse(Net::HTTP.get(url))
+      check_errors(res)
+      if options == 1 then @detected = res['detected']['lang'] else @detected = nil end
+      return res['text']
+    end
+
+    def check_errors(res)
+      if res['code'] and res['code'] != 200
+        raise(YandexError , res['message'])
+      end
+    end
+
+  end
+end

data/yandex_translator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'yandex_translator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "yandex_translator"
+  spec.version       = YandexTranslator::VERSION
+  spec.author   	 = "Kozlov_Evgeny"
+  spec.email         = ["eeeeevgen@gmail.com"]
+  spec.date          = '2017-05-14'
+  spec.summary       = "A library for translating text using Yandex Translate API"
+  spec.license       = "MIT"
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "webmock"
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: yandex_translator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Kozlov_Evgeny
@@ -72,7 +72,15 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files: []
-files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/yandex_translator.rb
+- lib/yandex_translator/version.rb
+- yandex_translator.gemspec
 homepage: 
 licenses:
 - MIT