@mx-space/api-client 1.0.0-beta.2 → 1.0.0

package/__tests__/contronllers/post.test.ts

@@ -0,0 +1,77 @@
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { PostController } from '~/controllers'
+
+describe('test post client', () => {
+  const client = mockRequestInstance(PostController)
+
+  it('should get post list', async () => {
+    mockResponse('/posts', { data: [] })
+
+    const data = await client.post.getList()
+    expect(data).toEqual({ data: [] })
+  })
+
+  it('should get post list filter filed', async () => {
+    const mocked = mockResponse('/posts?page=1&size=1&select=created+title', {
+      data: [
+        {
+          id: '61586f7e769f07b6852f3da0',
+          title: '终于可以使用 Docker 托管整个 Mix Space 了',
+          created: '2021-10-02T14:41:02.742Z',
+          category: null,
+        },
+        {
+          id: '614c539cfdf566c5d93a383f',
+          title: '再遇 Docker，容器化 Node 应用',
+          created: '2021-09-23T10:14:52.491Z',
+          category: null,
+        },
+      ],
+    })
+
+    const data = await client.post.getList(1, 1, {
+      select: ['created', 'title'],
+    })
+    expect(data).toEqual(mocked)
+  })
+
+  it('should get latest post', async () => {
+    mockResponse('/posts/latest', { title: '1' })
+    const data = await client.post.getLatest()
+    expect(data.title).toBe('1')
+  })
+
+  it('should get single post by id', async () => {
+    mockResponse('/posts/613c91d0326cfffc61923ea2', {
+      title: '1',
+    })
+
+    const data = await client.post.getPost('613c91d0326cfffc61923ea2')
+
+    expect(data).toStrictEqual({ title: '1' })
+    expect(data.$raw).toBeDefined()
+  })
+
+  it('should get single post by slug and category', async () => {
+    mockResponse('/posts/website/host-an-entire-Mix-Space-using-Docker', {
+      title: '1',
+    })
+
+    const data = await client.post.getPost(
+      'website',
+      'host-an-entire-Mix-Space-using-Docker',
+    )
+
+    expect(data).toStrictEqual({ title: '1' })
+    expect(data.$raw).toBeDefined()
+  })
+
+  it('should thumbs-up post', async () => {
+    mockResponse('/posts/_thumbs-up?id=1', null)
+
+    const data = await client.post.thumbsUp('1')
+
+    expect(data).toBeNull()
+  })
+})

package/__tests__/contronllers/recently.test.ts

@@ -0,0 +1,49 @@
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { RecentlyController } from '~/controllers'
+
+describe('test recently client, /recently', () => {
+  const client = mockRequestInstance(RecentlyController)
+
+  test('GET /', async () => {
+    const mocked = mockResponse('/recently?before=616182162657089e483aac5c', {
+      data: [
+        {
+          id: '615c58cbf41656a119b1a4a9',
+          content: 'x',
+          created: '2021-10-05T13:53:15.891Z',
+        },
+      ],
+    })
+    const data = await client.recently.getList('616182162657089e483aac5c')
+    expect(data).toEqual(mocked)
+  })
+
+  test('GET /latest', async () => {
+    const mocked = mockResponse('/recently/latest', {
+      id: '615c58cbf41656a119b1a4a9',
+      content: 'xxx',
+      created: '2021-10-05T13:53:15.891Z',
+    })
+    const data = await client.recently.getLatestOne()
+    expect(data).toEqual(mocked)
+  })
+
+  test('GET /all', async () => {
+    const mocked = mockResponse('/recently/all', {
+      data: [
+        {
+          id: '615c58cbf41656a119b1a4a9',
+          content: 'x',
+          created: '2021-10-05T13:53:15.891Z',
+        },
+      ],
+    })
+    const data = await client.recently.getAll()
+    expect(data).toEqual(mocked)
+  })
+
+  it('should `recently` == `shorthand`', () => {
+    expect(client.recently).toEqual(client.shorthand)
+  })
+})

package/__tests__/contronllers/say.test.ts

@@ -0,0 +1,106 @@
+import camelcaseKeys from 'camelcase-keys'
+
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { SayController } from '~/controllers/say'
+
+describe('test say client', () => {
+  const client = mockRequestInstance(SayController)
+
+  test('GET /says/all', async () => {
+    const mocked = mockResponse('/says/all', {
+      data: [
+        {
+          id: '5eb52a73505ad56acfd25c94',
+          source: '网络',
+          text: '找不到路，就自己走一条出来。',
+          author: '魅影陌客',
+          created: '2020-05-08T09:46:27.694Z',
+        },
+        {
+          id: '5eb52a94505ad56acfd25c95',
+          source: '网络',
+          text: '生活中若没有朋友，就像生活中没有阳光一样。',
+          author: '能美',
+          created: '2020-05-08T09:47:00.436Z',
+        },
+      ],
+    })
+    const data = await client.say.getAll()
+    expect(data.$raw.data).toEqual(mocked)
+    expect(data.data).toEqual(mocked.data)
+    expect(data.data[0].text).toEqual('找不到路，就自己走一条出来。')
+  })
+
+  describe('GET /says', () => {
+    it('should get without page and size', async () => {
+      const mocked = mockResponse('/says', {
+        data: [
+          {
+            id: '61397d9892992823d7329bc9',
+            text: '每位师傅各有所长，我都会一点点。',
+            author: '陆沉',
+            source: '',
+            created: '2021-09-09T03:20:56.769Z',
+          },
+          {
+            id: '60853492fbfab397775cc12d',
+            text: '我不是一个优秀的人，只是我们观测的角度不同。',
+            created: '2021-04-25T09:21:22.115Z',
+          },
+        ],
+        pagination: {
+          total: 26,
+          current_page: 1,
+          total_page: 3,
+          size: 10,
+          has_next_page: true,
+          has_prev_page: false,
+        },
+      })
+
+      const data = await client.say.getAllPaginated()
+      expect(data.$raw.data).toEqual(mocked)
+      expect(data.data).toEqual(camelcaseKeys(mocked.data, { deep: true }))
+      expect(data.data[0].text).toEqual('每位师傅各有所长，我都会一点点。')
+    })
+
+    it('should with page and size', async () => {
+      const mocked = await mockResponse('/says?size=1&page=1', {
+        data: [
+          {
+            id: '61397d9892992823d7329bc9',
+            text: '每位师傅各有所长，我都会一点点。',
+            author: '陆沉',
+            source: '',
+            created: '2021-09-09T03:20:56.769Z',
+          },
+        ],
+        pagination: {
+          total: 26,
+          current_page: 1,
+          total_page: 26,
+          size: 1,
+          has_next_page: true,
+          has_prev_page: false,
+        },
+      })
+
+      const data = await client.say.getAllPaginated(1, 1)
+      expect(data.$raw.data).toEqual(mocked)
+    })
+  })
+
+  test('GET /says/:id', async () => {
+    const mocked = mockResponse('/says/61397d9892992823d7329bc9', {
+      id: '61397d9892992823d7329bc9',
+      text: '每位师傅各有所长，我都会一点点。',
+      author: '陆沉',
+      source: '',
+      created: '2021-09-09T03:20:56.769Z',
+    })
+    const data = await client.say.getById('61397d9892992823d7329bc9')
+    expect(data.$raw.data).toEqual(mocked)
+    expect(data.id).toEqual('61397d9892992823d7329bc9')
+  })
+})

package/__tests__/contronllers/search.test.ts

@@ -0,0 +1,81 @@
+import camelcaseKeys from 'camelcase-keys'
+
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { SearchController } from '~/controllers'
+
+import mockData from '../mock/algolia.json'
+
+describe('test search client, /search', () => {
+  const client = mockRequestInstance(SearchController)
+
+  test('GET /search/post', async () => {
+    const mocked = mockResponse('/search/post?keyword=1', {
+      data: [
+        {
+          modified: '2020-11-14T16:15:36.162Z',
+          id: '5eb2c62a613a5ab0642f1f80',
+          title: '打印沙漏(C#实现)',
+          slug: 'acm-test',
+          created: '2019-01-31T13:02:00.000Z',
+          category: {
+            type: 0,
+            id: '5eb2c62a613a5ab0642f1f7a',
+            count: 56,
+            name: '编程',
+            slug: 'programming',
+            created: '2020-05-06T14:14:02.339Z',
+          },
+        },
+      ],
+      pagination: {
+        total: 86,
+        current_page: 1,
+        total_page: 9,
+        size: 10,
+        has_next_page: true,
+        has_prev_page: false,
+      },
+    })
+
+    const data = await client.search.search('post', '1')
+    expect(data).toEqual(camelcaseKeys(mocked, { deep: true }))
+    expect(data.data[0].id).toEqual('5eb2c62a613a5ab0642f1f80')
+  })
+
+  test('GET /search/note', async () => {
+    const mocked = mockResponse('/search/note?keyword=1', {
+      data: [
+        {
+          modified: '2020-11-15T09:43:33.199Z',
+          id: '5eb35d6f5ae43bbd0c90b8c0',
+          title: '回顾快要逝去的寒假',
+          created: '2019-02-19T11:59:00.000Z',
+          nid: 11,
+        },
+      ],
+      pagination: {
+        total: 86,
+        current_page: 1,
+        total_page: 9,
+        size: 10,
+        has_next_page: true,
+        has_prev_page: false,
+      },
+    })
+
+    const data = await client.search.search('note', '1')
+    expect(data).toEqual(camelcaseKeys(mocked, { deep: true }))
+    expect(data.data[0].id).toEqual('5eb35d6f5ae43bbd0c90b8c0')
+  })
+
+  test('GET /search/algolia', async () => {
+    mockResponse('/search/algolia', mockData)
+    const data = await client.search.searchByAlgolia('algolia')
+
+    expect(data.data[0].id).toEqual('5fe97d1d5b11408f99ada0fd')
+    expect(data.raw).toBeDefined()
+
+    expect(data.$raw.data).toEqual(mockData)
+  })
+})

package/__tests__/contronllers/serverless.test.ts

@@ -0,0 +1,19 @@
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { ServerlessController } from '~/controllers'
+
+describe('test Snippet client', () => {
+  const client = mockRequestInstance(ServerlessController)
+
+  test('GET /:reference/:name', async () => {
+    const mocked = mockResponse('/serverless/api/ping', { message: 'pong' })
+
+    const data = await client.serverless.getByReferenceAndName<{}>(
+      'api',
+      'ping',
+    )
+
+    expect(data).toEqual(mocked)
+    expect(data.$raw.data).toEqual(mocked)
+  })
+})

package/__tests__/contronllers/snippet.test.ts

@@ -0,0 +1,38 @@
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { SnippetController } from '~/controllers'
+
+describe('test Snippet client', () => {
+  const client = mockRequestInstance(SnippetController)
+
+  // test('GET /:id', async () => {
+  //   const mocked = mockResponse('/snippets/61a0cac4b4aefa000fcc1822', {
+  //     id: '61a0cac4b4aefa000fcc1822',
+  //     type: 'json',
+  //     private: true,
+  //     reference: 'theme',
+  //     raw: '{}',
+  //     name: 'config',
+  //     created: '2021-11-26T11:53:40.863Z',
+  //     updated: '2021-11-26T11:53:40.863Z',
+  //   })
+
+  //   const data = await client.snippet.getById('61a0cac4b4aefa000fcc1822')
+
+  //   expect(data).toEqual(mocked)
+  //   expect(data.$raw.data).toEqual(mocked)
+  //   expect(data.raw).toEqual('{}')
+  // })
+
+  test('GET /:reference/:name', async () => {
+    const mocked = mockResponse('/snippets/theme/config', {})
+
+    const data = await client.snippet.getByReferenceAndName<{}>(
+      'theme',
+      'config',
+    )
+
+    expect(data).toEqual(mocked)
+    expect(data.$raw.data).toEqual(mocked)
+  })
+})

package/__tests__/contronllers/topic.test.ts

@@ -0,0 +1,17 @@
+import camelcaseKeys from 'camelcase-keys'
+
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { TopicController } from '~/controllers/topic'
+
+describe('test topic client', () => {
+  const client = mockRequestInstance(TopicController)
+
+  test('GET /topics/slug/:slug', async () => {
+    const mocked = mockResponse('/topics/slug/111', {
+      name: 'name-topic',
+    })
+    const data = await client.topic.getTopicBySlug('111')
+    expect(data).toEqual(camelcaseKeys(mocked))
+  })
+})

package/__tests__/contronllers/user.test.ts

@@ -0,0 +1,59 @@
+import camelcaseKeys from 'camelcase-keys'
+
+import { mockRequestInstance } from '~/__tests__/helpers/instance'
+import { mockResponse } from '~/__tests__/helpers/response'
+import { UserController } from '~/controllers'
+
+describe('test user client', () => {
+  const client = mockRequestInstance(UserController)
+
+  test('GET /master', async () => {
+    const mocked = mockResponse('/master', {
+      id: '5ea4fe632507ba128f4c938c',
+      introduce: '这是我的小世界呀',
+      mail: 'i@innei.ren',
+      url: 'https://innei.ren',
+      name: 'Innei',
+      social_ids: {
+        bili_id: 26578164,
+        netease_id: 84302804,
+        github: 'Innei',
+      },
+      username: 'Innei',
+      created: '2020-04-26T03:22:11.784Z',
+      modified: '2020-11-13T09:38:49.014Z',
+      last_login_time: '2021-11-17T13:42:48.209Z',
+      avatar: 'https://cdn.innei.ren/avatar.png',
+    })
+    const data = await client.user.getMasterInfo()
+    expect(data.id).toEqual(mocked.id)
+    expect(data).toEqual(camelcaseKeys(mocked, { deep: true }))
+    expect(data.$raw.data).toEqual(mocked)
+  })
+
+  test('POST /login', async () => {
+    const mocked = mockResponse(
+      '/master/login',
+      {
+        id: '5ea4fe632507ba128f4c938c',
+      },
+      'post',
+    )
+    const data = await client.user.login('test', 'test')
+    expect(data.id).toEqual(mocked.id)
+    expect(data.$raw.data).toEqual(mocked)
+  })
+
+  test('GET /check_logged', async () => {
+    const mocked = mockResponse('/check_logged?token=bearer token', {
+      isGuest: true,
+    })
+    const data = await client.user.checkTokenValid('token')
+    expect(data).toEqual(mocked)
+  })
+
+  it('should call `master.xx` work', () => {
+    expect(client.master.getMasterInfo).toBeInstanceOf(Function)
+    expect(client.master).toEqual(client.user)
+  })
+})