Merge pull request #103 from Smartling/ZD-825-locales-api

ZD-825: Added locales api

Author: PavelLoparev

api/dto/base-locale-dto.ts

@@ -0,0 +1,6 @@
+interface BaseLocaleDto {
+    localeId: string;
+    description: string;
+}
+
+export { BaseLocaleDto };

api/locales/dto/country-dto.ts

@@ -0,0 +1,6 @@
+interface CountryDto {
+    countryId: string;
+    description: string;
+}
+
+export { CountryDto };

api/locales/dto/smartling-language-dto.ts

@@ -0,0 +1,8 @@
+interface SmartlingLanguageDto {
+    description: string;
+    direction: string;
+    languageId: string;
+    wordDelimiter: string;
+}
+
+export { SmartlingLanguageDto };

api/locales/dto/smartling-locale-dto.ts

@@ -0,0 +1,11 @@
+import { BaseLocaleDto } from "../../dto/base-locale-dto";
+import { CountryDto } from "./country-dto";
+import { SmartlingLanguageDto } from "./smartling-language-dto";
+
+interface SmartlingLocaleDto extends BaseLocaleDto {
+    mtSupported: boolean;
+    country: CountryDto;
+    language: SmartlingLanguageDto;
+}
+
+export { SmartlingLocaleDto };

api/locales/index.ts

@@ -0,0 +1,24 @@
+import { SmartlingBaseApi } from "../base/index";
+import { SmartlingAuthApi } from "../auth/index";
+import { Logger } from "../logger";
+import { SmartlingLocaleDto } from "./dto/smartling-locale-dto";
+import { SmartlingListResponse } from "../http/smartling-list-response";
+import { GetLocalesParameters } from "./params/get-locales-parameters";
+
+export class SmartlingLocalesApi extends SmartlingBaseApi {
+    constructor(smartlingApiBaseUrl: string, authApi: SmartlingAuthApi, logger: Logger) {
+        super(logger);
+        this.authApi = authApi;
+        this.entrypoint = `${smartlingApiBaseUrl}/locales-api/v2/dictionary`;
+    }
+
+    async getLocales(
+        params?: GetLocalesParameters
+    ): Promise<SmartlingListResponse<SmartlingLocaleDto>> {
+        return await this.makeRequest(
+            "get",
+            `${this.entrypoint}/locales`,
+            params ? params.export() : null
+        );
+    }
+}

api/locales/params/get-locales-parameters.ts

@@ -0,0 +1,15 @@
+import { BaseParameters } from "../../parameters";
+
+export class GetLocalesParameters extends BaseParameters {
+    public setLocaleIds(localeIds: Array<string>): GetLocalesParameters {
+        this.set("localeIds", localeIds);
+
+        return this;
+    }
+
+    public setSupportedOnly(supportedOnly: boolean): GetLocalesParameters {
+        this.set("supportedOnly", supportedOnly);
+
+        return this;
+    }
+}

api/projects/dto/locale-dto.ts

@@ -1,6 +1,6 @@
-interface LocaleDto {
-    localeId: string;
-    description: string;
+import { BaseLocaleDto } from "../../dto/base-locale-dto";
+
+interface LocaleDto extends BaseLocaleDto {
     enabled: boolean;
 }
 

index.ts

@@ -96,3 +96,8 @@ export * from "./api/logger";
 export * from "./api/jobs/params/add-file-parameters";
 export * from "./api/files/params/download-file-all-translations-parameters";
 export * from "./api/jobs/params/authorize-job-parameters";
+export * from "./api/locales/dto/country-dto";
+export * from "./api/locales/dto/smartling-language-dto";
+export * from "./api/locales/dto/smartling-locale-dto";
+export * from "./api/locales/params/get-locales-parameters";
+export * from "./api/locales/index";

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "smartling-api-sdk-nodejs",
-  "version": "2.8.1",
+  "version": "2.9.0",
   "description": "Package for Smartling API",
   "main": "built/index.js",
   "engines": {

package.json

@@ -0,0 +1,68 @@
+import sinon from "sinon";
+import { SmartlingLocalesApi } from "../api/locales";
+import { GetLocalesParameters } from "../api/locales/params/get-locales-parameters";
+import { SmartlingAuthApi } from "../api/auth/index";
+import { loggerMock, authMock, responseMock } from "./mock";
+
+describe("SmartlingLocalesApi class tests.", () => {
+    let localesApi;
+    let localesApiFetchStub;
+    let localesApiUaStub;
+    let responseMockTextStub;
+
+    beforeEach(() => {
+        localesApi = new SmartlingLocalesApi("https://test.com", authMock as unknown as SmartlingAuthApi, loggerMock);
+
+        localesApiFetchStub = sinon.stub(localesApi, "fetch");
+        localesApiUaStub = sinon.stub(localesApi, "ua");
+        responseMockTextStub = sinon.stub(responseMock, "text");
+
+        localesApiUaStub.returns("test_user_agent");
+        localesApiFetchStub.returns(responseMock);
+        responseMockTextStub.returns("{\"response\": {}}");
+    });
+
+    afterEach(() => {
+        localesApiFetchStub.restore();
+        responseMockTextStub.restore();
+        localesApiUaStub.restore();
+    });
+
+    it("Get all locales", async () => {
+        await localesApi.getLocales();
+
+        sinon.assert.calledOnce(localesApiFetchStub);
+        sinon.assert.calledWithExactly(
+            localesApiFetchStub,
+            "https://test.com/locales-api/v2/dictionary/locales", {
+                headers: {
+                    Authorization: "test_token_type test_access_token",
+                    "Content-Type": "application/json",
+                    "User-Agent": "test_user_agent"
+                },
+                method: "get"
+            }
+        );
+    });
+
+    it("Get locales with filters", async () => {
+        const params = new GetLocalesParameters()
+            .setLocaleIds(["fr-FR", "de-DE"])
+            .setSupportedOnly(true);
+
+        await localesApi.getLocales(params);
+
+        sinon.assert.calledOnce(localesApiFetchStub);
+        sinon.assert.calledWithExactly(
+            localesApiFetchStub,
+            "https://test.com/locales-api/v2/dictionary/locales?localeIds=fr-FR&localeIds=de-DE&supportedOnly=true", {
+                headers: {
+                    Authorization: "test_token_type test_access_token",
+                    "Content-Type": "application/json",
+                    "User-Agent": "test_user_agent"
+                },
+                method: "get"
+            }
+        );
+    });
+});