About

do-translate is npm package for translating text samples via translation providers like Google and Yandex. Browser version is available as well.

Todo

• Headless browser tests.
• Add provider lookup strategy (e.g. "web scraping")
• Use native ES6 without transpiler, when widely supported.
• Use native fetch fn in node version, when widely supported.

Cache

Every response is cached. Cached value is returned if result for current request is present locally. Note that to process translation, two requests at minimum are to perform:

• Request supported languages
• Ask for translation

API errors

API errors, in general, like "translation failure", "api limit excess" are silent and not reported in any form for now.

Node

Install

npm will install transpiled version of src folder.

$ npm install do-translate

Usage

Translator instance defines a bunch of methods, lookup is expecting three params: textToTranslate, langTo and langFrom. Translation process is asynchronous, result is immediately returned as Promise object. Only lookup should be used to for actual translation, getLangs and translate perform requests without caching.

var Translator = require('do-translate').Translator;

Provider alias is passed to Translator upon creation along with API key and uri.

With Google Translate

var googleTranslator = new Translator('google', 'google-key', 'google-uri');

googleTranslator.lookup('sample', 'ru', 'en')
    .then(function(result) {
        // "образец" from request
        return googleTranslator.lookup('sample', 'ru', 'en');
    })
    .then(function(result) {
        // "образец" from cache
    })
    .catch(function(error) {
        // debug error here
    })
;

With Yandex Translate

var yandexTranslator = new Translator('yandex', 'yandex-key', 'yandex-uri');

yandexTranslator.lookup('sample', 'ru', 'en')
    .then(function(result) {
        // "образец" from request
        return yandexTranslator.lookup('sample', 'ru', 'en');
    })
    .then(function(result) {
        // "образец" from cache
    })
    .catch(function(error) {
        // debug error here
    })
;

With NoopProvider for testing

var noopTranslator = new Translator('noop');

noopTranslator.lookup('sample', 'ru', 'en')
    .then(function(result) {
        // "sample_en-ru" from request
        return noopTranslator.lookup('sample', 'ru', 'en');
    })
    .then(function(result) {
        // "sample_en-ru" from cache
    })
    .catch(function(error) {
        // debug error here
    })
;

Browser

Browser version relies on native Promise object and fetch function. Corresponding Polyfills should be applied on consumer side.

Install

$ bower install do-translate

Usage

Install/include fetch and Promise polyfill scripts, if required.

<!-- optional scripts -->
<script src="path/to/fetch/polyfill.js"></script>
<script src="path/to/promise/polyfill.js"></script>
<!-- optional scripts -->

Include required scripts.

<script src="path/to/do-translate.js"></script>

Test with NoopProvider

var Translator = doTranslate.Translator;
var noopTranslator = new Translator('noop');

noopTranslator.lookup('sample', 'ru', 'en')
    .then(function(result) {
        console.log(result); // "sample_en-ru" from request

        return noopTranslator.lookup('sample', 'ru', 'en');
    })
    .then(function(result) {
        console.log(result); // "sample_en-ru" from cache
    })
    .catch(function(error) {
        console.log(error); // debug error here
    })
;