refactor!: renamed all proxy to service

Author: chantouchsek

README.md

@@ -127,18 +127,18 @@ It will create `$errors` object inside components.
 
 1.Create **proxies** folder or your prefer folder name for this
 
-`~/proxies/NewsProxy.js`
+`~/proxies/NewsService.js`
 
 ```js
 import { BaseService } from 'vue-axios-http'
 
-class NewsProxy extends BaseService {
+class NewsService extends BaseService {
   constructor(parameters = {}) {
     super('news', parameters)
   }
 }
 
-export default NewsProxy
+export default NewsService
 ```
 
 2.Store
@@ -157,19 +157,19 @@ actions.js
 
 ```js
 import { ALL } from './mutation-types'
-import { NewsProxy } from '~/proxies'
+import { NewsService } from '~/proxies'
 import { BaseTransformer, PaginationTransformer } from 'vue-axios-http'
 import { pagination, notify } from '~/utils'
 
-const proxy = new NewsProxy()
+const service = new NewsService()
 
 const all = async ({ commit, dispatch }, payload = {}) => {
   const { fn } = payload
   if (typeof fn === 'function') {
-    await fn(proxy)
+    await fn(service)
   }
   try {
-    const { data, meta } = await proxy.all()
+    const { data, meta } = await service.all()
     const all = {
       items: BaseTransformer.fetchCollection(data),
       pagination: PaginationTransformer.fetch(meta),
@@ -247,8 +247,8 @@ export default {
   async asyncData({ app, store }) {
     const { id = null } = app.$auth.user
     await store.dispatch('news/all', {
-      fn: (proxy) => {
-        proxy
+      fn: (service) => {
+        service
           .setParameters({
             userId: id,
             include: ['categories'],
@@ -267,8 +267,8 @@ export default {
   mounted() {
     const { id = null } = this.$auth.user
     this.$store.dispatch('news/all', {
-      fn: (proxy) => {
-        proxy
+      fn: (service) => {
+        service
           .setParameters({
             userId: id,
             include: ['categories'],
@@ -282,7 +282,7 @@ export default {
 
 You can set or remove any parameters you like.
 
-## Proxy's methods are available
+## Service's methods are available
 
 | Method                                          | Description                 |
 | ----------------------------------------------- | --------------------------- |
@@ -301,7 +301,7 @@ Set parameters with key/value.
 #### Example
 
 ```js
-const proxy = new ExampleProxy()
+const service = new ExampleService()
 const parameters = {
   search: {
     first_name: 'Sek',
@@ -317,7 +317,7 @@ const parameters = {
   },
   category_id: 6,
 }
-const { data } = proxy.setParameters(parameters).all()
+const { data } = service.setParameters(parameters).all()
 this.data = data
 ```
 
@@ -334,8 +334,8 @@ if setParameter that value is empty or null it will remove that param for query
 #### Example 1
 
 ```js
-const proxy = new ExampleProxy()
-const { data } = await proxy.setParameter('page', 1).all()
+const service = new ExampleService()
+const { data } = await service.setParameter('page', 1).all()
 this.data = data
 ```
 
@@ -350,9 +350,9 @@ Expected will be:
 #### Example 2
 
 ```js
-const proxy = new ExampleProxy()
+const service = new ExampleService()
 const queryString = 'limit=10&page=1&search[name]=hello'
-const { data } = await proxy.setParameter(queryString).all()
+const { data } = await service.setParameter(queryString).all()
 this.data = data
 ```
 
@@ -370,20 +370,20 @@ Expected will be:
 
 Be sure to use only once in `mounted()` or `asyncData()` and `asyncData()` is only available in `NuxtJs`
 
-## Use proxy in components
+## Use service in components
 
 - news/\_id.vue pages
 
 ```js
-import { NewsProxy } from '~/proxies'
+import { NewsService } from '~/proxies'
 
-const proxy = new NewsProxy()
+const service = new NewsService()
 
 export default {
   methods: {
     async fetchNews(id) {
       try {
-        const { data } = await proxy.find(id)
+        const { data } = await service.find(id)
         this.detail = data
       } catch (e) {
         console.log(e)

src/__tests__/base-service.test.ts

@@ -6,7 +6,7 @@ import type { ValidatorType } from '../core/Validator'
 import Validator from '../core/Validator'
 import { merge } from '../util'
 
-let proxy: PostService
+let service: PostService
 let mockAdapter: MockAdapter
 let validator: ValidatorType
 
@@ -16,15 +16,15 @@ describe('BaseService', () => {
     const axios = Axios.create({ baseURL: 'https://mock-api.test' })
     BaseService.$http = axios
     BaseService.$errorProperty = 'message'
-    proxy = new PostService()
+    service = new PostService()
     mockAdapter = new MockAdapter(axios)
     mockAdapter.reset()
   })
 
   it('check if http was installed', async () => {
     BaseService.$http = undefined as any
     try {
-      await proxy.all()
+      await service.all()
     } catch (e) {
       const { message } = e as any
       expect(message).toBe('Vue Axios Http, No http library provided.')
@@ -37,7 +37,7 @@ describe('BaseService', () => {
       pagination: { count: 1, page: 1, perPage: 20 },
     }
     mockAdapter.onGet('/posts').reply(200, items)
-    const { data, pagination } = await proxy.removeParameters().all()
+    const { data, pagination } = await service.removeParameters().all()
     const all = {
       pagination,
       items: data,
@@ -56,7 +56,7 @@ describe('BaseService', () => {
       },
     }
     mockAdapter.onGet('/posts').reply(200, items)
-    const { data, meta } = await proxy.removeParameters().all()
+    const { data, meta } = await service.removeParameters().all()
     const item = {
       items: data,
       pagination: meta.pagination,
@@ -69,14 +69,14 @@ describe('BaseService', () => {
   it('will fetch all records', async () => {
     const items = [{ first_name: 'Chantouch', last_name: 'Sek' }]
     mockAdapter.onGet('/posts').reply(200, { data: items })
-    const { data } = await proxy.removeParameters().all()
+    const { data } = await service.removeParameters().all()
     expect(data).toEqual(items)
   })
 
   it('Check network server return 500', async () => {
     mockAdapter.onGet('/posts').networkError()
     try {
-      await proxy.all()
+      await service.all()
     } catch (e) {
       const { message } = e as any
       expect(message).toBe('Network Error')
@@ -89,7 +89,7 @@ describe('BaseService', () => {
       { first_name: 'Chantouch', last_name: 'Sek', id: 2 },
     ]
     mockAdapter.onGet('/posts?id=1&first_name=Dara').reply(200, { data: items })
-    const { data } = await proxy
+    const { data } = await service
       .setParameter('id', 1)
       .setParameters({ first_name: 'Dara' })
       .all()
@@ -113,11 +113,11 @@ describe('BaseService', () => {
     mockAdapter
       .onGet('/posts?id=1&last_name=Hok&search[name]=hello&first_name=Dara')
       .reply(200, { data: items })
-    const { data } = await proxy
+    const { data } = await service
       .setParameter('id=1&last_name=Hok&search[name]=hello')
       .setParameters({ first_name: 'Dara' })
       .all()
-    expect(proxy.parameters).toEqual({
+    expect(service.parameters).toEqual({
       id: '1',
       first_name: 'Dara',
       last_name: 'Hok',
@@ -134,7 +134,7 @@ describe('BaseService', () => {
       { first_name: 'Chantouch', last_name: 'Sek', id: 2 },
     ]
     mockAdapter.onGet('/posts?id=1').reply(200, { data: items })
-    const { data } = await proxy
+    const { data } = await service
       .setParameter('id', 1)
       .setParameters({ first_name: 'Dara', last_name: 'Sek' })
       .removeParameter('first_name')
@@ -156,25 +156,28 @@ describe('BaseService', () => {
       first_name: 'Dara',
       last_name: 'Hok',
     }
-    const { data } = await proxy
+    const { data } = await service
       .setParameters(params)
       .removeParameters(['last_name'])
       .all()
     expect(data).toEqual(items)
-    expect(proxy.parameters).toEqual({ search: { id: 1 }, first_name: 'Dara' })
+    expect(service.parameters).toEqual({
+      search: { id: 1 },
+      first_name: 'Dara',
+    })
   })
 
   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 service.find(1)
     expect(data).toEqual(item)
   })
 
   it('it should create a item by post', async () => {
     const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
     mockAdapter.onPost('/posts').reply(201, { data: item })
-    const { data } = await proxy.post(item)
+    const { data } = await service.post(item)
     expect(data).toEqual(item)
   })
 
@@ -209,7 +212,7 @@ describe('BaseService', () => {
       return [200, {}]
     })
 
-    await proxy.store(form)
+    await service.store(form)
   })
 
   it('transforms the data to a FormData object if there is a File with post', async () => {
@@ -241,7 +244,7 @@ describe('BaseService', () => {
       return [200, {}]
     })
 
-    await proxy.put(form.id, form)
+    await service.put(form.id, form)
   })
 
   it('transforms the boolean values in FormData object to "1" or "0"', async () => {
@@ -272,7 +275,7 @@ describe('BaseService', () => {
       return [200, {}]
     })
 
-    await proxy.post(form)
+    await service.post(form)
   })
 
   it('it should throw errors message when data is not valid', async () => {
@@ -281,7 +284,7 @@ describe('BaseService', () => {
       message: { first_name: 'The first name field is required' },
     })
     try {
-      await proxy.post(item)
+      await service.post(item)
     } catch (e) {
       const { message } = e as any
       expect(message).toBe('Request failed with status code 422')
@@ -292,65 +295,65 @@ describe('BaseService', () => {
   it('it should store the item', async () => {
     const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
     mockAdapter.onPost('/posts').reply(201, { data: item })
-    const { data } = await proxy.store(item)
+    const { data } = await service.store(item)
     expect(data).toEqual(item)
   })
 
   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 service.put(item.id, item)
     expect(data).toEqual(item)
   })
 
   it('it should be able to put item without id parameter', async () => {
     const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
     mockAdapter.onPut('posts').reply(200, { data: item })
-    const { data } = await proxy.put(item)
+    const { data } = await service.put(item)
     expect(data).toEqual(item)
   })
 
   it('it should be able to patch item', async () => {
     const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
     mockAdapter.onPatch('posts/1').reply(200, { data: item })
-    const { data } = await proxy.patch(item.id, item)
+    const { data } = await service.patch(item.id, item)
     expect(data).toEqual(item)
   })
 
   it('it should be able to patch item without id', async () => {
     const item = { first_name: 'Chantouch', last_name: 'Sek', id: 1 }
     mockAdapter.onPatch('posts').reply(200, { data: item })
-    const { data } = await proxy.patch(item)
+    const { data } = await service.patch(item)
     expect(data).toEqual(item)
   })
 
   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)
+    const { data } = await service.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)
+    const { data } = await service.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)
+    const { data } = await service.remove(item.id)
     expect(data).toEqual(item)
   })
 
   it('can accept a custom http instance in options', () => {
     BaseService.$http = Axios.create({ baseURL: 'https://another-example.com' })
-    expect(proxy.$http.defaults.baseURL).toBe('https://another-example.com')
+    expect(service.$http.defaults.baseURL).toBe('https://another-example.com')
 
     BaseService.$http = Axios.create()
-    expect(proxy.$http.defaults.baseURL).toBe(undefined)
+    expect(service.$http.defaults.baseURL).toBe(undefined)
   })
 })