hermes-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 641902ce8949b32a7215d788dd4b09d4048c9a9254200a13494303a8da673eb4
+  data.tar.gz: e97c423aabe0d3ee6d4a72377553db8a764baacc0d5e6fed7e0c8c83ed625497
+SHA512:
+  metadata.gz: 02340e4f170170d08230d3432cea10e8df5e2c650c6535cc97add84dcd4bf178eb1fb6ee94a330ec75db5915be15172f89f5ef1698eecf984409c3e8ca7fd37a
+  data.tar.gz: 693a4ff2ea986bec345530ae498e2c21e1f3a544f773b046f146beee3c58b16207b7b5f924e148a3751f2a532e44845fbf7cbd04453558d2634d2b9021028902

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,28 @@
+#AllCops:
+#  Include:
+#  - "**/*.gemspec"
+#  - "**/*.podspec"
+#  - "**/*.jbuilder"
+#  - "**/*.rake"
+#  - "**/*.opal"
+#  - "**/Gemfile"
+#  - "**/Rakefile"
+#  - "**/Capfile"
+#  - "**/Guardfile"
+#  - "**/Podfile"
+#  - "**/Thorfile"
+#  - "**/Vagrantfile"
+#  - "**/Berksfile"
+#  - "**/Cheffile"
+#  - "**/Vagabondfile"
+#  Exclude:
+#  - "vendor/**/*"
+#  - "**/schema.rb"
+
+Metrics/LineLength:
+  Max: 120
+
+Metrics/BlockLength:
+  Exclude:
+    - "hermes-ruby.gemspec"
+    - "spec/**/*.rb"

data/.ruby-gemset

@@ -0,0 +1 @@
+hermes-ruby

data/.ruby-version

@@ -0,0 +1 @@
+2.5.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+before_install: gem install bundler -v 1.16.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hermes-ruby.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Boris Drazhzhov
+
+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,52 @@
+# HermesRuby
+
+Allows to translate text from/to different languages using open API.
+
+Yandex Translate API is supported only.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hermes-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install hermes-ruby
+
+## Usage
+
+```ruby
+require 'hermes-ruby'
+
+# Create Yandex Translate client
+# API Key can be obtained here https://translate.yandex.com/developers/keys
+client = HermesRuby::Yandex.new('you_api_key')
+
+# List of supported languages
+client.get_langs
+
+# Attempt to detect text language
+client.detect('Hello!', [:en, :de])
+
+# Text translation
+client.translate('Hello!', 'en-ru') 
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## 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,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/hermes-ruby.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hermes-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'hermes-ruby'
+  spec.version       = HermesRuby::VERSION
+  spec.authors       = ['Boris Drazhzhov']
+  spec.email         = ['bdrazhzhov@gmail.com']
+
+  spec.summary       = 'Allows to translate text from/to different languages using open API.'
+  spec.description   = 'It uses translation API of Google, Microsoft, Yandex and other ones for translation. '\
+                       'You can chose one of them and use. Unfortunately Yandex API is supported only.'
+  spec.homepage      = 'https://github.com/bdrazhzhov/hermes-ruby'
+  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.16'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.58.0'
+  spec.add_dependency 'querystring', '~> 0.1.0'
+  spec.add_dependency 'rest-client', '~> 2.0'
+end

data/lib/hermes-ruby.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require 'hermes-ruby/version'
+require 'hermes-ruby/yandex'

data/lib/hermes-ruby/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HermesRuby
+  VERSION = '0.1.0'
+end

data/lib/hermes-ruby/yandex.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require 'rest-client'
+require 'querystring'
+require 'json'
+
+module HermesRuby
+  # HermesRuby::Yandex class needs to be used
+  # for making calls to the Yandex Translator API.
+  class Yandex
+    # @param api_key - can be obtained at https://translate.yandex.com/developers/keys.
+    def initialize(api_key)
+      @base_url = 'https://translate.yandex.net/api/v1.5/tr.json'
+      @api_key = api_key
+    end
+
+    # Gets a list of translation directions supported by the service.
+    # @param ui_lang - the language code that specifies a response language.
+    def get_langs(ui_lang = 'en')
+      call_api({ ui: ui_lang }, 'getLangs')
+    end
+
+    # Detects the language of the specified text.
+    # @param text - the text to detect the language for.
+    # @param hint - array of symbols containing language codes.
+    # of the most likely languages, for example [:en, :de].
+    def detect(text, hint = nil)
+      query_obj = { text: text }
+      query_obj[:hint] = hint if hint
+      result = call_api(query_obj, 'detect')
+
+      result['lang']
+    end
+
+    # Translates text to the specified language.
+    # @param text - the text to translate.
+    # @param lang - the translation direction.
+    # You can set it in either of the following ways:
+    #   - As a pair of language codes separated by a hyphen ("from"-"to").
+    #     For example, en-ru indicates translating from English to Russian.
+    #   - As the target language code (for example, ru).
+    #     In this case, the service tries to detect the source language automatically.
+    # Default value: 'en'.
+    # @param format - text format.
+    # Possible values:
+    #   - plain - Text without markup (default value).
+    #   - html - Text in HTML format.
+    def translate(text, lang = 'en', format = 'plain')
+      query_obj = { text: text, lang: lang, format: format }
+      result = call_api(query_obj, 'translate')['text']
+
+      result.first
+    end
+
+    # Makes calls to Yandex Translator API.
+    # @param query_obj - a set of key value pairs containing params passing to the API.
+    # @param method_name - an API method name that should be called,
+    # for example, 'detect', 'translate'.
+    def call_api(query_obj, method_name)
+      query_obj[:key] = @api_key
+      query_string = QueryString.stringify(query_obj)
+      headers = { 'Content-Type': 'application/x-www-form-urlencoded' }
+
+      begin
+        result = RestClient.post("#{@base_url}/#{method_name}", query_string, headers: headers)
+        return JSON.parse(result.body)
+      rescue RestClient::RequestFailed => e
+        raise e.response.body
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: hermes-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Boris Drazhzhov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.58.0
+- !ruby/object:Gem::Dependency
+  name: querystring
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: It uses translation API of Google, Microsoft, Yandex and other ones for
+  translation. You can chose one of them and use. Unfortunately Yandex API is supported
+  only.
+email:
+- bdrazhzhov@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- hermes-ruby.gemspec
+- lib/hermes-ruby.rb
+- lib/hermes-ruby/version.rb
+- lib/hermes-ruby/yandex.rb
+homepage: https://github.com/bdrazhzhov/hermes-ruby
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.7
+signing_key: 
+specification_version: 4
+summary: Allows to translate text from/to different languages using open API.
+test_files: []