Add support for target option to translate.getLanguages.

Author: jmdobry

packages/translate/package.json

@@ -50,7 +50,7 @@
     "translate"
   ],
   "dependencies": {
-    "@google-cloud/common": "^0.1.0",
+    "@google-cloud/common": "^0.2.0",
     "arrify": "^1.0.0",
     "extend": "^3.0.0",
     "is": "^3.0.1",

packages/translate/src/index.js

@@ -164,36 +164,93 @@ Translate.prototype.detect = function(input, callback) {
 /**
  * Get an array of all supported languages.
  *
- * @resource [Discover Supported Languages]{@link https://cloud.google.com/translate/v2/using_rest#supported-languages}
+ * @resource [Discovering Supported Languages]{@link https://cloud.google.com/translate/v2/discovering-supported-languages-with-rest}
  *
+ * @param {string=} target - Get the language names in a language other than
+ *     English.
  * @param {function} callback - The callback function.
  * @param {?error} callback.err - An error returned while making this request.
- * @param {string[]} callback.languages - The supported ISO 639-1 language
- *     codes.
+ * @param {object[]} callback.languages - The languages supported by the API.
+ * @param {string} callback.languages[].code - The [ISO 639-1](https://en.wikipedia.org/wiki/ISO_639-1)
+ *     language code.
+ * @param {string} callback.languages[].name - The language name. This can be
+ *     translated into your preferred language with the `target` option
+ *     described above.
  * @param {object} callback.apiResponse - Raw API response.
  *
  * @example
  * translate.getLanguages(function(err, languages) {
  *   if (!err) {
  *     // languages = [
- *     //   'af',
- *     //   'ar',
- *     //   'az',
+ *     //   {
+ *     //     code: 'af',
+ *     //     name: 'Afrikaans'
+ *     //   },
+ *     //   {
+ *     //     code: 'ar',
+ *     //     name: 'Arabic'
+ *     //   },
+ *     //   {
+ *     //     code: 'az',
+ *     //     name: 'Azerbaijani'
+ *     //   },
+ *     //   ...
+ *     // ]
+ *   }
+ * });
+ *
+ * //-
+ * // Get the language names in a language other than English.
+ * //-
+ * translate.getLanguages('es', function(err, languages) {
+ *   if (!err) {
+ *     // languages = [
+ *     //   {
+ *     //     code: 'af',
+ *     //     name: 'afrikáans'
+ *     //   },
+ *     //   {
+ *     //     code: 'ar',
+ *     //     name: 'árabe'
+ *     //   },
+ *     //   {
+ *     //     code: 'az',
+ *     //     name: 'azerí'
+ *     //   },
  *     //   ...
  *     // ]
  *   }
  * });
  */
-Translate.prototype.getLanguages = function(callback) {
-  this.request({
-    uri: '/languages'
-  }, function(err, resp) {
+Translate.prototype.getLanguages = function(target, callback) {
+  if (is.fn(target)) {
+    callback = target;
+    target = 'en';
+  }
+
+  var reqOpts = {
+    uri: '/languages',
+    useQuerystring: true,
+    qs: {}
+  };
+
+  if (target && is.string(target)) {
+    reqOpts.qs.target = target;
+  }
+
+  this.request(reqOpts, function(err, resp) {
     if (err) {
       callback(err, null, resp);
       return;
     }
 
-    var languages = resp.data.languages.map(prop('language'));
+    var languages = resp.data.languages.map(function(language) {
+      return {
+        code: language.language,
+        name: language.name
+      };
+    });
+
     callback(null, languages, resp);
   });
 };

packages/translate/system-test/translate.js

@@ -102,7 +102,33 @@ var API_KEY = process.env.GCLOUD_TESTS_API_KEY;
     it('should get a list of supported languages', function(done) {
       translate.getLanguages(function(err, languages) {
         assert.ifError(err);
-        assert(languages.length > 0);
+
+        var englishResult = languages.filter(function(language) {
+          return language.code === 'en';
+        })[0];
+
+        assert.deepEqual(englishResult, {
+          code: 'en',
+          name: 'English'
+        });
+
+        done();
+      });
+    });
+
+    it('should accept a target language', function(done) {
+      translate.getLanguages('es', function(err, languages) {
+        assert.ifError(err);
+
+        var englishResult = languages.filter(function(language) {
+          return language.code === 'en';
+        })[0];
+
+        assert.deepEqual(englishResult, {
+          code: 'en',
+          name: 'inglés'
+        });
+
         done();
       });
     });

packages/translate/test/index.js

@@ -18,7 +18,6 @@
 
 var assert = require('assert');
 var extend = require('extend');
-var prop = require('propprop');
 var proxyquire = require('proxyquire');
 var util = require('@google-cloud/common').util;
 
@@ -182,12 +181,27 @@ describe('Translate', function() {
     it('should make the correct API request', function(done) {
       translate.request = function(reqOpts) {
         assert.strictEqual(reqOpts.uri, '/languages');
+        assert.deepEqual(reqOpts.qs, {
+          target: 'en'
+        });
         done();
       };
 
       translate.getLanguages(assert.ifError);
     });
 
+    it('should make the correct API request with target', function(done) {
+      translate.request = function(reqOpts) {
+        assert.strictEqual(reqOpts.uri, '/languages');
+        assert.deepEqual(reqOpts.qs, {
+          target: 'es'
+        });
+        done();
+      };
+
+      translate.getLanguages('es', assert.ifError);
+    });
+
     describe('error', function() {
       var error = new Error('Error.');
       var apiResponse = {};
@@ -213,16 +227,27 @@ describe('Translate', function() {
         data: {
           languages: [
             {
-              language: 'en'
+              language: 'en',
+              name: 'English'
             },
             {
-              language: 'es'
+              language: 'es',
+              name: 'Spanish'
             }
           ]
         }
       };
 
-      var expectedResults = apiResponse.data.languages.map(prop('language'));
+      var expectedResults = [
+        {
+          code: 'en',
+          name: 'English'
+        },
+        {
+          code: 'es',
+          name: 'Spanish'
+        }
+      ];
 
       beforeEach(function() {
         translate.request = function(reqOpts, callback) {