translatomatic 0.1.1 → 0.1.2

data/lib/translatomatic/translator/my_memory.rb

@@ -1,64 +1,68 @@
-require 'bing_translator'
-
-module Translatomatic
-  module Translator
-
-    class MyMemory < Base
-
-      define_options(
-        { name: :mymemory_api_key, desc: "MyMemory API key", use_env: true },
-        { name: :mymemory_email, desc: "Email address", use_env: true }
-        )
-
-      # Create a new MyMemory translator instance
-      def initialize(options = {})
-        super(options)
-        @key = options[:mymemory_api_key] || ENV["MYMEMORY_API_KEY"]
-        @email = options[:mymemory_email] || ENV["MYMEMORY_EMAIL"]
-        @query_options = {}
-        @query_options.merge!(de: @email) if @email
-        @query_options.merge!(key: @key) if @key
-      end
-
-      # TODO: implement language list
-      # (see Translatomatic::Translator::Base#languages)
-      #def languages
-      #end
-
-      # Upload a set of translations to MyMemory
-      # @param [Translatomatic::TMX::Document] TMX document
-      def upload(tmx)
-        request = Translatomatic::HTTPRequest.new(UPLOAD_URL)
-        request.start do |http|
-          body = [
-            request.file(key: :tmx, filename: "import.tmx",
-              content: tmx.to_xml, mime_type: "application/xml"
-            ),
-            request.param(key: :private, value: 0)
-          ]
-          response = request.post(body, multipart: true)
-          log.debug("share response: #{response.body}")
-        end
-      end
-
-      private
-
-      GET_URL = 'https://api.mymemory.translated.net/get'
-      UPLOAD_URL = 'https://api.mymemory.translated.net/tmx/import'
-
-      def perform_translate(strings, from, to)
-        perform_fetch_translations(GET_URL, strings, from, to)
-      end
-
-      def fetch_translation(request, string, from, to)
-        response = request.get({
-            langpair: from.to_s + "|" + to.to_s,
-            q: string
-          }.merge(@query_options)
-        )
-        data = JSON.parse(response.body)
-        data['responseData']['translatedText']
-      end
-    end
-  end
-end
+require 'bing_translator'
+
+module Translatomatic
+  module Translator
+
+    # Interface to the MyMemory translation API
+    # @see https://mymemory.translated.net/doc/
+    class MyMemory < Base
+
+      define_options(
+        { name: :mymemory_api_key, desc: t("translator.mymemory_api_key"), use_env: true },
+        { name: :mymemory_email, desc: t("translator.email_address"), use_env: true }
+      )
+
+      # Create a new MyMemory translator instance
+      def initialize(options = {})
+        super(options)
+        @key = options[:mymemory_api_key] || ENV["MYMEMORY_API_KEY"]
+        @email = options[:mymemory_email] || ENV["MYMEMORY_EMAIL"]
+        @query_options = {}
+        @query_options.merge!(de: @email) if @email
+        @query_options.merge!(key: @key) if @key
+      end
+
+      # TODO: implement language list
+      # (see Translatomatic::Translator::Base#languages)
+      #def languages
+      #end
+
+      # Upload a set of translations to MyMemory
+      # @param tmx [Translatomatic::TMX::Document] TMX document
+      # @return [void]
+      def upload(tmx)
+        request = Translatomatic::HTTPRequest.new(UPLOAD_URL)
+        request.start do |http|
+          body = [
+            request.file(key: :tmx, filename: "import.tmx",
+              content: tmx.to_xml, mime_type: "application/xml"
+            ),
+            request.param(key: :private, value: 0)
+          ]
+          response = request.post(body, multipart: true)
+          log.debug(t("translator.share_response",
+            response: response.body.inspect))
+        end
+      end
+
+      private
+
+      GET_URL = 'https://api.mymemory.translated.net/get'
+      UPLOAD_URL = 'https://api.mymemory.translated.net/tmx/import'
+
+      def perform_translate(strings, from, to)
+        perform_fetch_translations(GET_URL, strings, from, to)
+      end
+
+      def fetch_translation(request, string, from, to)
+        response = request.get({
+            langpair: from.to_s + "|" + to.to_s,
+            q: string  # multiple q strings not supported (tested 20180101)
+          }.merge(@query_options)
+        )
+        data = JSON.parse(response.body)
+        data['responseData']['translatedText']
+      end
+    end
+  end
+end

data/lib/translatomatic/translator/yandex.rb

@@ -1,39 +1,56 @@
-require 'yandex-translator'
-
-module Translatomatic
-  module Translator
-
-    class Yandex < Base
-
-      define_options({
-        name: :yandex_api_key, desc: "Yandex API key", use_env: true
-        })
-
-      # Create a new Yandex translator instance
-      def initialize(options = {})
-        super(options)
-        key = options[:yandex_api_key] || ENV["YANDEX_API_KEY"]
-        raise "yandex api key required" if key.nil?
-        @impl = ::Yandex::Translator.new(key)
-      end
-
-      # (see Translatomatic::Translator::Base#languages)
-      def languages
-        @languages ||= @impl.langs.collect { |i| i[0, 2] }.uniq
-      end
-
-      private
-
-      def perform_translate(strings, from, to)
-        translated = []
-        strings.each do |string|
-          result = @impl.translate(string, from: from.language, to: to.language) || ""
-          translated.push(result)
-          update_translated(result)
-        end
-        translated
-      end
-
-    end # class
-  end   # module
-end
+module Translatomatic
+  module Translator
+
+    # Interface to the Yandex translation API
+    # @see https://tech.yandex.com/translate/
+    class Yandex < Base
+
+      define_options({
+        name: :yandex_api_key, desc: t("translator.yandex_api_key"), use_env: true
+        })
+
+      # Create a new Yandex translator instance
+      def initialize(options = {})
+        super(options)
+        @api_key = options[:yandex_api_key] || ENV["YANDEX_API_KEY"]
+        raise t("translator.yandex_key_required") if @api_key.nil?
+      end
+
+      # (see Translatomatic::Translator::Base#languages)
+      def languages
+        @languages ||= begin
+          request = Translatomatic::HTTPRequest.new(LANGUAGES_URL)
+          response = request.post(key: @api_key, ui: "en")
+          data = JSON.parse(response.body) || {}
+          langs = data["langs"] || {}
+          langs.keys.flatten.uniq
+        end
+      end
+
+      private
+
+      TRANSLATE_URL = 'https://translate.yandex.net/api/v1.5/tr.json/translate'
+      LANGUAGES_URL = 'https://translate.yandex.net/api/v1.5/tr.json/getLangs'
+
+      def perform_translate(strings, from, to)
+        attempt_with_retries(3) do
+          fetch_translations(strings, from, to)
+        end
+      end
+
+      def fetch_translations(strings, from, to)
+        request = Translatomatic::HTTPRequest.new(TRANSLATE_URL)
+        body = {
+          key: @api_key,
+          text: strings,
+          lang: from.language + "-" + to.language,
+          format: "plain"
+        }
+        response = request.post(body)
+        data = JSON.parse(response.body)
+        data['text']
+      end
+
+    end # class
+  end   # module
+end

data/lib/translatomatic/translator.rb

@@ -1,63 +1,99 @@
-require 'translatomatic/translator/base'
-require 'translatomatic/translator/yandex'
-require 'translatomatic/translator/google'
-require 'translatomatic/translator/microsoft'
-require 'translatomatic/translator/frengly'
-require 'translatomatic/translator/my_memory'
-
-module Translatomatic::Translator
-
-  class << self
-    include Translatomatic::Util
-  end
-
-  # @return [Class] The translator class corresponding to the given name
-  def self.find(name)
-    name ? self.const_get(name) : nil
-  end
-
-  # @return [List<Class>] A list of all translator classes
-  def self.modules
-    self.constants.collect { |c| self.const_get(c) }.select do |klass|
-      klass.is_a?(Class) && klass != Translatomatic::Translator::Base
-    end
-  end
-
-  # @return [List<String>] A list of all translators
-  def self.names
-    modules.collect { |i| i.name.demodulize }
-  end
-
-  # Find all configured translators
-  # @param [Hash<String,String>] options Translator options
-  # @return [Array<#translate>] A list of translator instances
-  def self.available(options = {})
-    available = []
-    modules.each do |mod|
-      begin
-        translator = mod.new(options)
-        available << translator
-      rescue Exception
-        log.debug("translator #{mod.name.demodulize} is unavailable")
-      end
-    end
-    available
-  end
-
-  # @return [String] A description of all translators and options
-  def self.list
-    out = "Translators:\n"
-    modules.each do |mod|
-      out += "\n" + mod.name.demodulize + ":\n"
-      opts = mod.options
-      opts.each do |opt|
-        optname = opt.name.to_s.gsub("_", "-")
-        out += "  --%-18s  %18s  %10s  %15s\n" % [optname, opt.description,
-          opt.required ? "(required)" : "",
-          opt.use_env ? "ENV[#{opt.name.upcase}]" : ""]
-      end
-    end
-    out + "\n"
-  end
-
-end
+require 'translatomatic/translator/base'
+require 'translatomatic/translator/yandex'
+require 'translatomatic/translator/google'
+require 'translatomatic/translator/microsoft'
+require 'translatomatic/translator/frengly'
+require 'translatomatic/translator/my_memory'
+
+# Provides methods to access and create instances of
+# interfaces to translation APIs.
+module Translatomatic::Translator
+
+  class << self
+    include Translatomatic::Util
+  end
+
+  # @return [Class] The translator class corresponding to the given name
+  def self.find(name)
+    name && !name.empty? ? self.const_get(name) : nil
+  end
+
+  # Resolve the given list of translator names to a list of translators.
+  # If the list is empty, return all translators that are configured.
+  # @param list [Array<String>] Translator names or translators
+  # @param options [Hash<String,String>] Translator options
+  # @return [Array<Translatomatic::Translator::Base>] Translators
+  def self.resolve(list, options = {})
+    list = [list] unless list.kind_of?(Array)
+    list = list.compact.collect do |translator|
+      if translator.respond_to?(:translate)
+        translator
+      else
+        klass = Translatomatic::Translator.find(translator)
+        translator = klass.new(options)
+      end
+      translator
+    end
+
+    if list.empty?
+      # find all available translators that work with the given options
+      list = Translatomatic::Translator.available(options)
+      if list.empty?
+        raise t("cli.no_translators")
+      end
+    end
+    list
+  end
+
+  # @return [List<Class>] A list of all translator classes
+  def self.modules
+    self.constants.collect { |c| self.const_get(c) }.select do |klass|
+      klass.is_a?(Class) && klass != Translatomatic::Translator::Base
+    end
+  end
+
+  # @return [List<String>] A list of all translators
+  def self.names
+    modules.collect { |i| i.name.demodulize }
+  end
+
+  # Find all configured translators
+  # @param options [Hash<String,String>] Translator options
+  # @return [Array<#translate>] A list of translator instances
+  def self.available(options = {})
+    available = []
+    modules.each do |mod|
+      begin
+        translator = mod.new(options)
+        available << translator
+      rescue Exception
+        log.debug(t("translator.unavailable", name: mod.name.demodulize))
+      end
+    end
+    available
+  end
+
+  # @return [String] A description of all translators and options
+  def self.list
+    out = t("translator.translators") + "\n"
+    modules.each do |mod|
+      out += "\n" + mod.name.demodulize + ":\n"
+      opts = mod.options
+      opts.each do |opt|
+        optname = opt.name.to_s.gsub("_", "-")
+        out += "  --%-18s  %18s  %10s  %15s\n" % [optname, opt.description,
+          opt.required ? t("translator.required_option") : "",
+          opt.use_env ? "ENV[#{opt.name.upcase}]" : ""]
+      end
+    end
+    out += "\n"
+    out += t("translator.configured") + "\n"
+    configured = available
+    configured.each do |translator|
+      out += "  " + translator.name + "\n"
+    end
+    out += t("translator.no_translators") if configured.empty?
+    out + "\n"
+  end
+
+end

data/lib/translatomatic/util.rb

@@ -1,6 +1,30 @@
-
+# Utility functions, used internally
 module Translatomatic::Util
 
+  private
+
+  # @!visibility private
+  module CommonMethods
+    private
+    def t(key, options = {})
+      tkey = "translatomatic.#{key}"
+      raise "missing translation: #{tkey}" unless I18n.exists?(tkey)
+      I18n.t(tkey, options)
+    end
+  end
+
+  include CommonMethods
+
+  # @!visibility private
+  module ClassMethods
+    private
+    include CommonMethods
+  end
+
+  def self.included(klass)
+    klass.extend(ClassMethods)
+  end
+
   def log
     Translatomatic::Config.instance.logger
   end
@@ -12,4 +36,10 @@ module Translatomatic::Util
   def string(value, locale)
     Translatomatic::String.new(value, locale)
   end
+
+  def hashify(list)
+    hash = {}
+    list.each { |i| hash[i.to_s] = i }
+    hash
+  end
 end

data/lib/translatomatic/version.rb

@@ -1,4 +1,7 @@
 module Translatomatic
-  VERSION = "0.1.1"
+  # @return [String] Gem version
+  VERSION = "0.1.2"
+
+  # @return [String] Homepage
   URL = "https://github.com/smugglys/translatomatic"
 end

data/lib/translatomatic.rb

@@ -1,7 +1,23 @@
+require 'i18n'
+require 'rails-i18n'
+
+# Module containing all of the translation goodness
 module Translatomatic
+  # @return [Translatomatic::Config] configuration
   def self.config
     @config ||= Translatomatic::Config.new
   end
+
+  private
+
+  def self.init_i18n(lib_path)
+    locale_path = File.join(File.dirname(lib_path), "..", "config", "locales")
+    I18n.load_path += Dir[File.join(locale_path, "**", "*.yml")]
+  end
+end
+
+begin
+  Translatomatic.init_i18n(__FILE__)
 end
 
 require 'pathname'
@@ -13,6 +29,7 @@ require 'ruby-progressbar'
 require 'translatomatic/option'
 require 'translatomatic/locale'
 require 'translatomatic/string'
+require 'translatomatic/translation'
 require 'translatomatic/util'
 require 'translatomatic/version'
 require 'translatomatic/logger'

data/translatomatic.gemspec

@@ -27,18 +27,19 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec-mocks", "~> 3.0"
   spec.add_development_dependency "simplecov"
-  spec.add_development_dependency "webmock"
+  spec.add_development_dependency "webmock"
   spec.add_development_dependency "factory_bot"  # RIP girl
 
   spec.add_dependency "thor", "~> 0.20"
-  spec.add_dependency "yandex-translator"
   spec.add_dependency "easy_translate"
   spec.add_dependency "bing_translator", "~> 5.1.0"
   spec.add_dependency "activerecord", "~> 5.0"
   spec.add_dependency "i18n"
   spec.add_dependency "i18n_data"
+  spec.add_dependency "rails-i18n", '~> 5.0.0' # For 5.0.x and 5.1.x
   spec.add_dependency "nokogiri"
-  spec.add_dependency "ruby-progressbar"
-  spec.add_dependency "kramdown"           # markdown -> html
+  spec.add_dependency "ruby-progressbar"
+  spec.add_dependency "kramdown"           # markdown -> html
   spec.add_dependency "reverse_markdown"   # html -> markdown
+  spec.add_dependency "concurrent-ruby"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: translatomatic
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrew Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-28 00:00:00.000000000 Z
+date: 2018-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -122,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.20'
-- !ruby/object:Gem::Dependency
-  name: yandex-translator
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: easy_translate
   requirement: !ruby/object:Gem::Requirement
@@ -206,6 +192,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rails-i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
 - !ruby/object:Gem::Dependency
   name: nokogiri
   requirement: !ruby/object:Gem::Requirement
@@ -262,6 +262,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - contact@smugglys.com
@@ -274,6 +288,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"
+- ".yardopts"
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Guardfile
@@ -283,16 +298,40 @@ files:
 - README.fr.md
 - README.it.md
 - README.ja.md
+- README.ko.md
 - README.md
+- README.ms.md
+- README.pt.md
+- README.ru.md
+- README.sv.md
+- README.zh.md
 - Rakefile
 - bin/console
 - bin/setup
 - bin/translatomatic
 - bin/travis
+- config/locales/translatomatic/de.yml
+- config/locales/translatomatic/en.yml
+- config/locales/translatomatic/es.yml
+- config/locales/translatomatic/fr.yml
+- config/locales/translatomatic/it.yml
+- config/locales/translatomatic/ja.yml
+- config/locales/translatomatic/ko.yml
+- config/locales/translatomatic/ms.yml
+- config/locales/translatomatic/pt.yml
+- config/locales/translatomatic/ru.yml
+- config/locales/translatomatic/sv.yml
+- config/locales/translatomatic/zh.yml
 - db/database.yml
 - db/migrate/201712170000_initial.rb
 - lib/translatomatic.rb
 - lib/translatomatic/cli.rb
+- lib/translatomatic/cli/base.rb
+- lib/translatomatic/cli/common_options.rb
+- lib/translatomatic/cli/config.rb
+- lib/translatomatic/cli/database.rb
+- lib/translatomatic/cli/main.rb
+- lib/translatomatic/cli/translate.rb
 - lib/translatomatic/config.rb
 - lib/translatomatic/converter.rb
 - lib/translatomatic/converter_stats.rb
@@ -324,6 +363,7 @@ files:
 - lib/translatomatic/tmx.rb
 - lib/translatomatic/tmx/document.rb
 - lib/translatomatic/tmx/translation_unit.rb
+- lib/translatomatic/translation.rb
 - lib/translatomatic/translation_result.rb
 - lib/translatomatic/translator.rb
 - lib/translatomatic/translator/base.rb