test: add configure axios test

Author: single9

package.json

@@ -18,6 +18,16 @@
     "wrapper"
   ],
   "author": "Duye Chen",
+  "contributors": [
+    {
+      "name": "Duye Chen",
+      "email": "k078264@gmail.com"
+    },
+    {
+      "name": "Richy Yang",
+      "email": "w4567892015@gmail.com"
+    }
+  ],
   "license": "MIT",
   "dependencies": {
     "axios": "^1.1.3"

test/configure-axios.test.ts

@@ -0,0 +1,120 @@
+import should from 'should';
+import ApiWrapper from '../src/index';
+
+describe('ApiWrapper with `configureAxios`', () => {
+  let api: ApiWrapper;
+  let reqInterceptorReqData;
+  let resInterceptorResData;
+
+  it('should create an instance of ApiWrapper', () => {
+    api = new ApiWrapper([
+      {
+        name: 'newPost',
+        path: '/posts',
+        method: 'post',
+      },
+      {
+        name: 'getPosts',
+        path: '/posts',
+        method: 'get',
+      },
+      {
+        name: 'getPostById',
+        path: '/posts/:postId',
+        method: 'get',
+      },
+      {
+        name: 'updatePost',
+        path: '/posts/:postId',
+        method: 'patch',
+      },
+      {
+        name: 'deletePost',
+        path: '/posts/:postId',
+        method: 'delete',
+      },
+    ], {
+      baseUrl: 'https://jsonplaceholder.typicode.com',
+      configureAxios: (axios) => {
+        axios.interceptors.request.use((request) => {
+          reqInterceptorReqData = request.data;
+          return request;
+        });
+
+        axios.interceptors.response.use((response) => {
+          resInterceptorResData = response.data;
+          return response;
+        });
+      }
+    });
+  });
+
+  it('should do newPost', async () => {
+    const reqData = {
+      title: 'foo!!!!!!',
+      body: 'bar!!',
+      userId: 1
+    };
+    const resp = await api.newPost({
+      data: reqData,
+    });
+    should(resp).be.an.Object();
+    should(reqInterceptorReqData).be.have.containEql(reqData);
+    should(resInterceptorResData).be.have.containEql(resp.data);
+  });
+
+  it('should do updatePost', async () => {
+    const resp = await api.updatePost({
+      pathParams: {
+        postId: '1',
+      }
+    });
+    should(resp).be.an.Object();
+    should(resp.config.url).be.equal('https://jsonplaceholder.typicode.com/posts/1');
+  });
+
+  it('should do deletePost', async () => {
+    const resp = await api.deletePost({
+      pathParams: {
+        postId: '1',
+      }
+    });
+    should(resp).be.an.Object();
+    should(resp.config.url).be.equal('https://jsonplaceholder.typicode.com/posts/1');
+  });
+
+  it('should do getPosts', async () => {
+    const resp = await api.getPosts();
+    should(resp).be.an.Object();
+  });
+
+  it('should do getPosts (with queryString)', async () => {
+    const resp = await api.getPosts({
+      queryString: {
+        userId: '1'
+      }
+    });
+    should(resp.data).be.an.Array();
+    should(resp.config.url).be.equal('https://jsonplaceholder.typicode.com/posts?userId=1');
+  });
+
+  it('should do getPostById', async () => {
+    const resp = await api.getPostById({
+      pathParams: {
+        postId: '1',
+      },
+    });
+    should(resp).be.an.Object();
+    should(resp.config.url).be.equal('https://jsonplaceholder.typicode.com/posts/1');
+  });
+
+  it('should do getPostById (array path params)', async () => {
+    const resp = await api.getPostById({
+      pathParams: [
+        {field: 'postId', value: '1'},
+      ],
+    });
+    should(resp).be.an.Object();
+    should(resp.config.url).be.equal('https://jsonplaceholder.typicode.com/posts/1');
+  });
+});

test/index.test.ts

@@ -4,6 +4,51 @@ import ApiWrapper from '../src/index';
 describe('ApiWrapper', () => {
   let api: ApiWrapper;
 
+  it('should thow an error of ApiWrapper due to missing baseUrl', () => {
+    should(() =>
+        new ApiWrapper([
+          {
+            name: 'newPost',
+            path: '/posts',
+            method: 'post',
+          },
+        ], {})
+    ).throwError();
+  });
+
+  it('should thow an error of ApiWrapper: "name only allow certain words and digits"', () => {
+    should(() =>
+        new ApiWrapper([
+          {
+            name: 'newPost.+',
+            path: '/posts',
+            method: 'post',
+          },
+        ], {
+          baseUrl: 'https://jsonplaceholder.typicode.com',
+        })
+    ).throwError('name only allow certain words and digits');
+  });
+
+  it('should thow an error of ApiWrapper: "Duplicated API: newPost"', () => {
+    should(() =>
+        new ApiWrapper([
+          {
+            name: 'newPost',
+            path: '/posts',
+            method: 'post',
+          },
+          {
+            name: 'newPost',
+            path: '/posts',
+            method: 'post',
+          },
+        ], {
+          baseUrl: 'https://jsonplaceholder.typicode.com',
+        })
+    ).throwError('Duplicated API: newPost');
+  });
+
   it('should create an instance of ApiWrapper', () => {
     api = new ApiWrapper([
       {
@@ -47,6 +92,25 @@ describe('ApiWrapper', () => {
     should(resp).be.an.Object();
   });
 
+  it('should do newPost with auth', async () => {
+    const resp = await api.newPost({
+      data: {
+        title: 'foo!!!!!!',
+        body: 'bar!!',
+        userId: 1
+      },
+      auth: {
+        username: 'user',
+        password: 'pass'
+      }
+    });
+    should(resp).be.an.Object();
+    should(resp.config.auth).be.containEql({
+      username: 'user',
+      password: 'pass'
+    });
+  });
+
   it('should do updatePost', async () => {
     const resp = await api.updatePost({
       pathParams: {
@@ -72,6 +136,12 @@ describe('ApiWrapper', () => {
     should(resp).be.an.Object();
   });
 
+  it('should do getPosts but got error', async () => {
+    await should(api.getPostById({
+      pathParams: [{} as any]
+    })).be.rejectedWith('pathParams is invalid');
+  });
+
   it('should do getPosts (with queryString)', async () => {
     const resp = await api.getPosts({
       queryString: {