Update swagger endpoint with more fields

Author: lukemorton

.gitignore

@@ -1,4 +1,3 @@
 **/*.js
 .next
 node_modules
-api/mock

api/.gitignore

@@ -0,0 +1,4 @@
+.swagger-codegen*
+swagger.json
+mock
+README.md

api/Makefile

@@ -1,6 +1,7 @@
 all: install start
 
 install:
+	swagger-codegen generate -i swagger.yml -l swagger
 	swagger-codegen generate -i swagger.yml -l nodejs-server -o mock
 
 start:

api/swagger.yml

@@ -31,17 +31,43 @@ paths:
           schema:
             $ref: "#/definitions/Error"
 definitions:
-  User:
-    required:
-      - name
-      - email
+  UserBasicInfo:
     properties:
       name:
         type: string
         example: "Mr Bob Example"
-      email:
+      biography:
+        type: string
+        example: "I like bicycles"
+      twitter:
+        type: string
+        example: "@bobexample"
+      createdAt:
         type: string
-        example: "[email protected]"
+        format: date-time
+      lastSeenAt:
+        type: string
+        format: date-time
+
+  User:
+    properties:
+      basicInfo:
+        $ref: "#/definitions/UserBasicInfo"
+      friends:
+        type: array
+        items:
+          $ref: "#/definitions/UserBasicInfo"
+        example:
+          - name: James
+            biography: Like Bond
+            createdAt: 2017-11-12T22:27:35.278Z
+            lastSeenAt: 2017-11-12T22:27:35.278Z
+          - name: Dan
+            biography: Yeah mayne
+            twitter: "@danmayne"
+            createdAt: 2017-11-12T22:27:35.278Z
+            lastSeenAt: 2017-11-12T22:27:35.278Z
+
   Error:
     required:
       - message

components/User/components/Profile.test.tsx

@@ -4,6 +4,6 @@ import Profile from './Profile'
 
 describe('<Profile />', () => {
   it('should display name', () => {
-    expect(shallow(<Profile name='Luke' />)).toIncludeText('Luke')
+    expect(shallow(<Profile name='Luke' />)).toIncludeText('Name: Luke')
   })
 })

lib/api/Client.ts

@@ -1,12 +1,10 @@
 import * as Swagger from 'swagger-client'
-import * as fs from 'fs'
-import * as jsYaml from 'js-yaml'
+import * as spec from '../../api/swagger.json'
 
 const API_HOST = process.env.API_HOST
 
 export function loadSpec (): any {
-  const spec = fs.readFileSync(__dirname + '/../../api/swagger.yml', 'utf8')
-  return { ...jsYaml.safeLoad(spec), host: API_HOST }
+  return { ...spec, host: API_HOST }
 }
 
 export async function execute (operationId: String, parameters: any): Promise<any> {

lib/user/HTTPUserGateway.test.ts

@@ -2,9 +2,11 @@ import * as HTTPUserGateway from './HTTPUserGateway'
 import mockExecute from '../../test/support/mockExecute'
 
 describe('HTTPUserGateway', () => {
+  const fakeUser = { basicInfo: { name: 'Jim', email: '[email protected]' } }
+
   describe('when finding by id', () => {
     test('user has name', async () => {
-      mockExecute('findUserById', { userId: 'guid' }).reply(200, { name: 'Jim', email: '[email protected]' })
+      mockExecute('findUserById', { userId: 'guid' }).reply(200, fakeUser)
       const user = await HTTPUserGateway.findById('guid')
       expect(user.name).toBe('Jim')
       expect(user.email).toBe('[email protected]')

lib/user/HTTPUserGateway.ts

@@ -4,6 +4,7 @@ import User from './User'
 const API_ORIGIN = process.env.API_ORIGIN
 
 export async function findById (userId: string) : Promise<User> {
-  const { name, email } = await execute('findUserById', { userId })
+  const user = await execute('findUserById', { userId })
+  const { name, email } = user.basicInfo
   return new User(name, email)
 }

lib/user/LoadUserProfile.ts

@@ -11,7 +11,6 @@ type Response = {
 }
 
 export default async function LoadUserProfile (gateway: UserGateway, req: Request) : Promise<Response> {
-  return {
-    user: await gateway.findById(req.id)
-  }
+  const user = await gateway.findById(req.id)
+  return { user }
 }

pages/users/profile.test.tsx

@@ -4,9 +4,11 @@ import mockExecute from '../../test/support/mockExecute'
 import UserProfile from './profile'
 
 describe('UserProfile', () => {
+  const fakeUser = { basicInfo: { name: 'Luke', email: '[email protected]' } }
+
   describe('when user views the page', () => {
     test('user can see user name', async () => {
-      mockExecute('findUserById', { userId: 'guid' }).reply(200, { name: 'Luke' })
+      mockExecute('findUserById', { userId: 'guid' }).reply(200, fakeUser)
       const page = await mountPage(UserProfile, 'users#profile')
       expect(page).toIncludeText('Luke')
     })