test: 💄 coverage test

Author: chantouchsek

src/__tests__/base-proxy.test.ts

@@ -2,15 +2,19 @@ import Axios from 'axios'
 import BaseProxy from '../core/BaseProxy'
 import MockAdapter from 'axios-mock-adapter'
 import PostProxy from '../core/PostPorxy'
+import type { ValidatorType } from '../core/Validator'
+import Validator from '../core/Validator'
 import BaseTransformer from '../core/BaseTransformer'
 import PaginationTransformer from '../core/PaginationTransformer'
 import { merge } from '../util/objects'
 
 let proxy: PostProxy
 let mockAdapter: MockAdapter
+let validator: ValidatorType
 
 describe('BaseProxy', () => {
   beforeEach(() => {
+    validator = Validator
     const axios = Axios.create({ baseURL: 'https://mock-api.test' })
     BaseProxy.$http = axios
     proxy = new PostProxy()
@@ -21,7 +25,7 @@ describe('BaseProxy', () => {
   it('check if http was installed', async () => {
     BaseProxy.$http = undefined
     try {
-      await proxy.all()
+      await proxy.getMany()
     } catch (e) {
       expect(e.message).toBe('Vue Api Queries, No http library provided.')
     }
@@ -178,7 +182,7 @@ describe('BaseProxy', () => {
   it('it should find an item by id', async () => {
     const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
     mockAdapter.onGet('posts/1').reply(200, { data: item })
-    const { data } = await proxy.find(1)
+    const { data } = await proxy.getOne(1)
     expect(data).toEqual(item)
   })
 
@@ -198,7 +202,7 @@ describe('BaseProxy', () => {
       baz: new Date(Date.UTC(2012, 3, 13, 2, 12)),
     }
     form.field2 = file
-    form.files = [{ file }]
+    form.files = [file]
 
     mockAdapter.onPost('/posts').reply((request) => {
       expect(request.data).toBeInstanceOf(FormData)
@@ -207,20 +211,20 @@ describe('BaseProxy', () => {
       expect(request.data.get('field1[bar][1]')).toBe('testBar2')
       expect(request.data.get('field1[baz]')).toBe('2012-04-13T02:12:00.000Z')
       expect(request.data.get('field2')).toEqual(file)
-      expect(request.data.get('files[0][file]')).toEqual(file)
+      expect(request.data.get('files[0]')).toEqual(file)
 
       expect(getFormDataKeys(request.data)).toEqual([
         'field1[foo]',
         'field1[bar][0]',
         'field1[bar][1]',
         'field1[baz]',
         'field2',
-        'files[0][file]',
+        'files[0]',
       ])
       return [200, {}]
     })
 
-    await proxy.post(form)
+    await proxy.create(form)
   })
 
   it('transforms the data to a FormData object if there is a File with post', async () => {
@@ -257,44 +261,47 @@ describe('BaseProxy', () => {
 
   it('transforms the boolean values in FormData object to "1" or "0"', async () => {
     const file = new File(['hello world!'], 'myfile')
-    const form: any = { field1: {}, field2: null }
+    const form: any = { field1: {}, field2: null, files: null }
     form.field1 = {
       foo: true,
       bar: false,
     }
     form.field2 = file
+    form.files = [file]
+    form.__proto__ = file
 
     mockAdapter.onPost('/posts').reply((request) => {
       expect(request.data).toBeInstanceOf(FormData)
       expect(request.data.get('field1[foo]')).toBe('1')
       expect(request.data.get('field1[bar]')).toBe('0')
       expect(request.data.get('field2')).toEqual(file)
+      expect(request.data.get('files[0]')).toEqual(file)
+      expect(request.data.get('__proto__')).toEqual(null)
 
       expect(getFormDataKeys(request.data)).toEqual([
         'field1[foo]',
         'field1[bar]',
         'field2',
+        'files[0]',
       ])
       return [200, {}]
     })
 
     await proxy.post(form)
   })
 
-  /*
   it('it should throw errors message when data is not valid', async () => {
     const item = { first_name: null, last_name: 'Sek', id: 1 }
-    mockAdapter.onPost('/posts').reply(422, {
+    mockAdapter.onPost('/posts').replyOnce(422, {
       errors: { first_name: ['The first name field is required'] },
     })
     try {
       await proxy.post(item)
     } catch (e) {
-      console.log('post:', e)
+      expect(e.message).toBe('Request failed with status code 422')
     }
     expect(validator.has('first_name')).toBeTruthy()
   })
-  */
 
   it('it should store the item', async () => {
     const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
@@ -306,7 +313,7 @@ describe('BaseProxy', () => {
   it('it should be able to put item', async () => {
     const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
     mockAdapter.onPut('posts/1').reply(200, { data: item })
-    const { data } = await proxy.put(item.id, item)
+    const { data } = await proxy.replace(item.id, item)
     expect(data).toEqual(item)
   })
 
@@ -317,13 +324,27 @@ describe('BaseProxy', () => {
     expect(data).toEqual(item)
   })
 
-  it('it should be able to patch item', async () => {
+  it('it should be able to update an item', async () => {
+    const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
+    mockAdapter.onPatch('posts/1').reply(200, { data: item })
+    const { data } = await proxy.update(item.id, item)
+    expect(data).toEqual(item)
+  })
+
+  it('it should be able to delete an item', async () => {
     const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
     mockAdapter.onDelete('posts/1').reply(200, { data: item })
     const { data } = await proxy.delete(item.id)
     expect(data).toEqual(item)
   })
 
+  it('it should be able to remove an item', async () => {
+    const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
+    mockAdapter.onDelete('posts/1').reply(200, { data: item })
+    const { data } = await proxy.remove(item.id)
+    expect(data).toEqual(item)
+  })
+
   it('can accept a custom http instance in options', () => {
     BaseProxy.$http = Axios.create({ baseURL: 'https://another-example.com' })
     expect(proxy.$http.defaults.baseURL).toBe('https://another-example.com')

src/core/BaseProxy.ts

@@ -5,10 +5,9 @@ import {
   Method,
   AxiosRequestConfig,
 } from 'axios'
-import { isArray, isFile } from '../util/objects'
 import type { Errors } from '..'
 import Validator from './Validator'
-import { objectToFormData } from '../util/formData'
+import { hasFiles, objectToFormData } from '../util/formData'
 import qs, { ParsedQs } from 'qs'
 import { removeDoubleSlash } from '../util/string'
 
@@ -66,7 +65,7 @@ class BaseProxy {
    * Alternative of find method
    * @param {string | number} id
    */
-  getOne<T>(id: string | number) {
+  getOne<T>(id: number | string) {
     return this.find<T>(id)
   }
 
@@ -180,7 +179,7 @@ class BaseProxy {
     const method = BaseProxy.__validateRequestType(requestType)
     this.beforeSubmit()
     return new Promise((resolve, reject) => {
-      const data = this.__hasFiles(form) ? objectToFormData(form) : form
+      const data = hasFiles(form) ? objectToFormData(form) : form
       const url = parameter
         ? `/${this.endpoint}/${parameter}`
         : `/${this.endpoint}`
@@ -239,44 +238,6 @@ class BaseProxy {
     return requestType.toLowerCase()
   }
 
-  private __hasFiles(form: any): boolean {
-    for (const property in form) {
-      if (!form.hasOwnProperty(property)) {
-        return false
-      }
-      if (typeof window === 'undefined') {
-        return false
-      }
-      if (this.__hasFilesDeep(form[property])) {
-        return true
-      }
-    }
-    return false
-  }
-
-  private __hasFilesDeep(object: any): boolean {
-    if (object === null) {
-      return false
-    }
-    if (typeof object === 'object') {
-      for (const key in object) {
-        if (object.hasOwnProperty(key)) {
-          if (isFile(object[key])) {
-            return true
-          }
-        }
-      }
-    }
-    if (isArray(object)) {
-      for (const key in object) {
-        if (object.hasOwnProperty(key)) {
-          return this.__hasFilesDeep(object[key])
-        }
-      }
-    }
-    return isFile(object)
-  }
-
   /**
    * Set parameters by keys
    * @param {Object} parameters

src/util/formData.ts

@@ -1,3 +1,5 @@
+import { isArray, isFile } from './objects'
+
 export function objectToFormData(
   object: any,
   formData = new FormData(),
@@ -40,5 +42,50 @@ function appendToFormData(formData: FormData, key: string, value: any) {
     return formData.append(key, value)
   }
 
+  if (isArray(value) && hasFilesDeep(value)) {
+    for (let i = 0; i < value.length; i++) {
+      formData.append(key + '[' + i + ']', value[i])
+    }
+    return formData
+  }
+
   objectToFormData(value, formData, key)
 }
+
+export function hasFilesDeep(object: any): boolean {
+  if (object === null) {
+    return false
+  }
+  if (typeof object === 'object') {
+    for (const key in object) {
+      if (object.hasOwnProperty(key)) {
+        if (isFile(object[key])) {
+          return true
+        }
+      }
+    }
+  }
+  if (isArray(object)) {
+    for (const key in object) {
+      if (object.hasOwnProperty(key)) {
+        return hasFilesDeep(object[key])
+      }
+    }
+  }
+  return isFile(object)
+}
+
+export function hasFiles(form: any): boolean {
+  for (const property in form) {
+    if (!form.hasOwnProperty(property)) {
+      return false
+    }
+    if (typeof window === 'undefined') {
+      return false
+    }
+    if (hasFilesDeep(form[property])) {
+      return true
+    }
+  }
+  return false
+}