TRAC-303: add optional options param to getByName for multi-lang support

Author: bc-yevhenii-buliuk

spec/api/countries.spec.js

@@ -23,4 +23,49 @@ describe('Countries', () => {
         });
         expect(country.remoteRequest).toHaveBeenCalled();
     });
+
+    describe('getByName', () => {
+        let country;
+
+        beforeEach(() => {
+            Base.prototype.remoteRequest = jest.fn();
+            country = new Country();
+        });
+
+        test('should call remoteRequest with correct url when called without options (legacy signature)', () => {
+            const callback = jest.fn();
+
+            country.getByName('United States', callback);
+
+            expect(country.remoteRequest).toHaveBeenCalledWith(
+                '/country-states/United States',
+                'GET',
+                {},
+                callback,
+            );
+        });
+
+        test('should call remoteRequest with options when called with options object', () => {
+            const callback = jest.fn();
+            const options = { baseUrl: '/fr' };
+
+            country.getByName('United States', options, callback);
+
+            expect(country.remoteRequest).toHaveBeenCalledWith(
+                '/country-states/United States',
+                'GET',
+                options,
+                callback,
+            );
+        });
+
+        test('should pass baseUrl option through to remoteRequest for multi-lang support', () => {
+            const callback = jest.fn();
+
+            country.getByName('United States', { baseUrl: '/fr' }, callback);
+
+            const [, , passedOptions] = country.remoteRequest.mock.calls[0];
+            expect(passedOptions.baseUrl).toBe('/fr');
+        });
+    });
 });

src/api/countries.js

@@ -27,12 +27,18 @@ export default class extends Base {
 
     /**
      * Get country data by country name
-     * @param name
-     * @param callback
+     * @param {String} name
+     * @param {Object} [options] - optional request options
+     * @param {Function} callback
      */
-    getByName(name, callback) {
+    getByName(name, options, callback) {
+        if (typeof options === 'function') {
+            callback = options;
+            options = {};
+        }
+
         const url = this.endpoint + name;
 
-        this.remoteRequest(url, 'GET', {}, callback);
+        this.remoteRequest(url, 'GET', options, callback);
     }
 }