feat(request): support custom baseUrl

Author: zhyupe

src/model/xivapi-options.ts

@@ -43,6 +43,11 @@ export interface XivapiOptions {
      */
     staging?: boolean;
 
+    /**
+     * A custom xivapi instance to request instead of `xivapi.com`. This is prior to `staging`.
+     */
+    baseUrl?: string;
+
     /**
      * Servers for the market endpoint.
      */

src/xivapi.service.ts

@@ -239,14 +239,19 @@ export class XivapiService {
 
      protected request<T>(endpoint: string, params?: XivapiOptions): Observable<T> {
         let queryParams: HttpParams = this.prepareQueryString(params);
-        let baseUrl: string;
-        if (params !== undefined) {
-            baseUrl = params.staging ? XivapiService.STAGING_API_BASE_URL : XivapiService.API_BASE_URL;
-            if (params.staging) {
-                queryParams = queryParams.delete('staging');
+        let baseUrl = XivapiService.API_BASE_URL;
+        if (params) {
+            if (params.baseUrl) {
+                baseUrl = params.baseUrl;
+            } else if (params.staging) {
+                baseUrl = XivapiService.STAGING_API_BASE_URL;
             }
-        } else {
-            baseUrl = XivapiService.API_BASE_URL;
+
+            ['staging', 'baseUrl'].forEach(key => {
+                if (params.hasOwnProperty(key)) {
+                    queryParams.delete(key);
+                }
+            })
         }
         return this.doGet<any>(`${baseUrl}${endpoint}`, queryParams);
     }

test/xivapi.service.spec.ts

@@ -64,4 +64,25 @@ describe('Client tests', () => {
         expect(req.request.params.get('string')).toEqual('legendary');
         expect(req.request.params.get('columns')).toEqual('Context,Source,SourceID,Text,Data.Icon');
     });
+
+    it('Should use custom baseUrl when `baseUrl` is provided', () => {
+        const service: XivapiService = new XivapiService(httpClient);
+        service.get(XivapiEndpoint.Item, 12087, {
+            baseUrl: 'https://example.org'
+        }).subscribe();
+        const req: TestRequest = <TestRequest>httpMock.match({method: 'GET'})
+            .find(row => row.request.url === 'https://example.org/Item/12087');
+        expect(req).not.toBeUndefined();
+    });
+
+    it('Should use custom baseUrl when both baseUrl and staging are provided', () => {
+        const service: XivapiService = new XivapiService(httpClient);
+        service.get(XivapiEndpoint.Item, 12087, {
+            baseUrl: 'https://example.org',
+            staging: true
+        }).subscribe();
+        const req: TestRequest = <TestRequest>httpMock.match({method: 'GET'})
+            .find(row => row.request.url === 'https://example.org/Item/12087');
+        expect(req).not.toBeUndefined();
+    });
 });