Skip to content

Commit 194fc77

Browse files
authored
Merge pull request watson-developer-cloud#273 from watson-developer-cloud/lt-rename
Language Translator rename
2 parents ff9e2f1 + 24f71ec commit 194fc77

File tree

6 files changed

+57
-44
lines changed

6 files changed

+57
-44
lines changed

README.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ APIs and SDKs that use cognitive computing to solve complex problems.
2525
* [Concept Insights](#concept-insights)
2626
* [Dialog](#dialog)
2727
* [Document Conversion](#document-conversion)
28-
* [Language Translation](#language-translation)
28+
* [Language Translator](#language-translator)
2929
* [Natural Language Classifier](#natural-language-classifier)
3030
* [Personality Insights](#personality-insights)
3131
* [Relationship Extraction](#relationship-extraction)
@@ -298,20 +298,20 @@ document_conversion.convert({
298298
See the [Document Conversion integration example][document_conversion_integration_example] about how to integrate the Document Conversion service
299299
with the Retrieve and Rank service.
300300

301-
### Language Translation
301+
### Language Translator
302302

303-
Translate text from one language to another or idenfity a language using the [Language Translation][language_translation] service.
303+
Translate text from one language to another or idenfity a language using the [Language Translator][language_translator] service.
304304

305305
```javascript
306306
var watson = require('watson-developer-cloud');
307307

308-
var language_translation = watson.language_translation({
308+
var language_translator = watson.language_translator({
309309
username: '<username>',
310310
password: '<password>',
311311
version: 'v2'
312312
});
313313

314-
language_translation.translate({
314+
language_translator.translate({
315315
text: 'A sentence must have a verb', source : 'en', target: 'es' },
316316
function (err, translation) {
317317
if (err)
@@ -320,8 +320,8 @@ language_translation.translate({
320320
console.log(JSON.stringify(translation, null, 2));
321321
});
322322

323-
language_translation.identify({
324-
text: 'The language translation service takes text input and identifies the language used.' },
323+
language_translator.identify({
324+
text: 'The language translator service takes text input and identifies the language used.' },
325325
function (err, language) {
326326
if (err)
327327
console.log('error:', err);
@@ -663,7 +663,7 @@ See [CONTRIBUTING](https://github.com/watson-developer-cloud/node-sdk/blob/maste
663663
[speech_to_text]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/speech-to-text/
664664
[concept_insights]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/concept-insights/
665665
[tradeoff_analytics]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/tradeoff-analytics/
666-
[language_translation]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/language-translation/
666+
[language_translator]: http://www.ibm.com/smarterplanet/us/en/ibmwatson/developercloud/doc/language-translation/
667667

668668
[alchemy_language]: http://www.alchemyapi.com/products/alchemylanguage
669669
[sentiment_analysis]: http://www.alchemyapi.com/products/alchemylanguage/sentiment-analysis

examples/language_translation.v2.js renamed to examples/language_translator.v2.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@
33
var watson = require('watson-developer-cloud');
44
var fs = require('fs');
55

6-
var language_translation = watson.language_translation({
6+
var language_translator = watson.language_translator({
77
username: 'INSERT YOUR USERNAME FOR THE SERVICE HERE',
88
password: 'INSERT YOUR PASSWORD FOR THE SERVICE HERE',
99
version: 'v2'
1010
});
1111

12-
language_translation.translate({
12+
language_translator.translate({
1313
text: 'A sentence must have a verb', source : 'en', target: 'es' },
1414
function (err, translation) {
1515
if (err)
@@ -20,7 +20,7 @@ language_translation.translate({
2020

2121

2222
// Create a translation model using a tmx file
23-
language_translation.createModel({
23+
language_translator.createModel({
2424
base_model_id: 'en-fr',
2525
name:'my-model',
2626
forced_glossary: fs.createReadStream('resources/glossary.tmx')

lib/index.js

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -205,7 +205,7 @@ var watson = {
205205
* @param {{}} options
206206
* @returns {LanguageTranslation}
207207
*/
208-
language_translation: createServiceAPI('language_translation'),
208+
language_translator: createServiceAPI('language_translator'),
209209

210210
/**
211211
* @function
@@ -288,4 +288,17 @@ var watson = {
288288
});
289289
});
290290

291+
Object.defineProperty(watson, 'language_translation', {
292+
enumerable: false,
293+
configurable: true,
294+
writable: true,
295+
value: function(options) {
296+
if (!options.silent) {
297+
//eslint-disable-next-line no-console
298+
console.warn(new Error("Watson language_translation is now language_translator. Set {silent: true} to disable this message.").stack)
299+
}
300+
return watson.language_translator(options);
301+
}
302+
});
303+
291304
module.exports = watson;

test/test.integration-all-services.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -557,12 +557,12 @@ describe('integration-all-services', function() {
557557
});
558558
});
559559

560-
describe('functional_language_translation', function() {
560+
describe('functional_language_translator', function() {
561561
this.timeout(TWENTY_SECONDS * 2);
562-
var language_translation = watson.language_translation(auth.language_translation);
562+
var language_translator = watson.language_translator(auth.language_translator || auth.language_translation);
563563

564564
it('getModels()', function(done) {
565-
language_translation.getModels(null, failIfError.bind(failIfError, done));
565+
language_translator.getModels(null, failIfError.bind(failIfError, done));
566566
});
567567

568568
it('translate()', function(done) {
@@ -571,18 +571,18 @@ describe('integration-all-services', function() {
571571
source: 'en',
572572
target: 'es'
573573
};
574-
language_translation.translate(params, failIfError.bind(failIfError, done));
574+
language_translator.translate(params, failIfError.bind(failIfError, done));
575575
});
576576

577577
it('getIdentifiableLanguages()', function(done) {
578-
language_translation.getIdentifiableLanguages(null, failIfError.bind(failIfError, done));
578+
language_translator.getIdentifiableLanguages(null, failIfError.bind(failIfError, done));
579579
});
580580

581581
it('identify()', function(done) {
582582
var params = {
583583
text: 'this is an important test that needs to work'
584584
};
585-
language_translation.identify(params, failIfError.bind(failIfError, done));
585+
language_translator.identify(params, failIfError.bind(failIfError, done));
586586
});
587587
});
588588

@@ -709,7 +709,7 @@ describe('integration-all-services', function() {
709709
}, failIfError.bind(failIfError, done));
710710
});
711711

712-
describe.only('typedRelations()', function() {
712+
describe('typedRelations()', function() {
713713
it('should process html', function(done) {
714714
alchemy_language.typedRelations({
715715
html: text,

test/test.language_translation.v2.js renamed to test/test.language_translator.v2.js

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ var watson = require('../lib/index');
55
var nock = require('nock');
66
var fs = require('fs');
77

8-
describe('language_translation', function() {
8+
describe('language_translator', function() {
99

1010
var noop = function() {};
1111

@@ -24,7 +24,7 @@ describe('language_translation', function() {
2424
nock.cleanAll();
2525
});
2626

27-
var language_translation = watson.language_translation(service);
27+
var language_translator = watson.language_translator(service);
2828

2929
var missingParameter = function(err) {
3030
assert.ok((err instanceof Error) && /required parameters/.test(err));
@@ -40,7 +40,7 @@ describe('language_translation', function() {
4040
.get(path)
4141
.reply(200, corpus);
4242

43-
var req = language_translation.getModels(null, noop);
43+
var req = language_translator.getModels(null, noop);
4444
assert.equal(req.uri.href, service.url + path);
4545
assert.equal(req.method, 'GET');
4646
});
@@ -49,10 +49,10 @@ describe('language_translation', function() {
4949
describe('translate()', function(){
5050

5151
it('should check no parameters provided', function() {
52-
language_translation.translate({source:''}, missingParameter);
53-
language_translation.translate({target:''}, missingParameter);
54-
language_translation.translate({text:''}, missingParameter);
55-
language_translation.translate({model_id:''}, missingParameter);
52+
language_translator.translate({source:''}, missingParameter);
53+
language_translator.translate({target:''}, missingParameter);
54+
language_translator.translate({text:''}, missingParameter);
55+
language_translator.translate({model_id:''}, missingParameter);
5656
});
5757

5858
it('should generate a valid payload', function() {
@@ -65,7 +65,7 @@ describe('language_translation', function() {
6565
.post(path,service_request)
6666
.reply(200);
6767

68-
var req = language_translation.translate(service_request, noop);
68+
var req = language_translator.translate(service_request, noop);
6969
assert.equal(req.uri.href, service.url + path);
7070
assert.equal(req.method, 'POST');
7171
var body = new Buffer(req.body).toString('ascii');
@@ -82,7 +82,7 @@ describe('language_translation', function() {
8282
.get(path)
8383
.reply(200);
8484

85-
var req = language_translation.getIdentifiableLanguages(null, noop);
85+
var req = language_translator.getIdentifiableLanguages(null, noop);
8686
assert.equal(req.uri.href, service.url + path);
8787
assert.equal(req.method, 'GET');
8888
});
@@ -91,9 +91,9 @@ describe('language_translation', function() {
9191
describe('identify()', function(){
9292

9393
it('should check no parameters provided', function() {
94-
language_translation.identify({}, missingParameter);
95-
language_translation.identify(null, missingParameter);
96-
language_translation.identify(undefined, missingParameter);
94+
language_translator.identify({}, missingParameter);
95+
language_translator.identify(null, missingParameter);
96+
language_translator.identify(undefined, missingParameter);
9797
});
9898

9999
it('should generate a valid payload', function() {
@@ -103,7 +103,7 @@ describe('language_translation', function() {
103103
.post(path,service_request)
104104
.reply(200);
105105

106-
var req = language_translation.identify(service_request, noop);
106+
var req = language_translator.identify(service_request, noop);
107107
assert.equal(req.uri.href, service.url + path);
108108
assert.equal(req.method, 'POST');
109109
var body = new Buffer(req.body).toString('ascii');
@@ -114,9 +114,9 @@ describe('language_translation', function() {
114114
describe('createModel()', function(){
115115

116116
it('should check no parameters provided', function() {
117-
language_translation.createModel({}, missingParameter);
118-
language_translation.createModel(null, missingParameter);
119-
language_translation.createModel(undefined, missingParameter);
117+
language_translator.createModel({}, missingParameter);
118+
language_translator.createModel(null, missingParameter);
119+
language_translator.createModel(undefined, missingParameter);
120120
});
121121

122122
it('should generate a valid payload', function() {
@@ -132,7 +132,7 @@ describe('language_translation', function() {
132132
.post(path,service_request)
133133
.reply(200);
134134

135-
var req = language_translation.createModel(service_request, noop);
135+
var req = language_translator.createModel(service_request, noop);
136136
assert.equal(req.uri.href, service.url + path+ '?base_model_id=foo');
137137
assert.equal(req.method, 'POST');
138138
});
@@ -141,9 +141,9 @@ describe('language_translation', function() {
141141
describe('deleteModel()', function(){
142142

143143
it('should check no parameters provided', function() {
144-
language_translation.deleteModel({}, missingParameter);
145-
language_translation.deleteModel(null, missingParameter);
146-
language_translation.deleteModel(undefined, missingParameter);
144+
language_translator.deleteModel({}, missingParameter);
145+
language_translator.deleteModel(null, missingParameter);
146+
language_translator.deleteModel(undefined, missingParameter);
147147
});
148148

149149
it('should generate a valid payload', function() {
@@ -156,7 +156,7 @@ describe('language_translation', function() {
156156
.delete(path,service_request)
157157
.reply(200);
158158

159-
var req = language_translation.deleteModel(service_request, noop);
159+
var req = language_translator.deleteModel(service_request, noop);
160160
assert.equal(req.uri.href, service.url + path);
161161
assert.equal(req.method, 'DELETE');
162162
});
@@ -165,9 +165,9 @@ describe('language_translation', function() {
165165
describe('getModel()', function(){
166166

167167
it('should check no parameters provided', function() {
168-
language_translation.getModel({}, missingParameter);
169-
language_translation.getModel(null, missingParameter);
170-
language_translation.getModel(undefined, missingParameter);
168+
language_translator.getModel({}, missingParameter);
169+
language_translator.getModel(null, missingParameter);
170+
language_translator.getModel(undefined, missingParameter);
171171
});
172172

173173
it('should generate a valid payload', function() {
@@ -180,7 +180,7 @@ describe('language_translation', function() {
180180
.get(path,service_request)
181181
.reply(200);
182182

183-
var req = language_translation.getModel(service_request, noop);
183+
var req = language_translator.getModel(service_request, noop);
184184
assert.equal(req.uri.href, service.url + path);
185185
assert.equal(req.method, 'GET');
186186
});

0 commit comments

Comments
 (0)