feat: presence.getPresenceByUserCode (#49)

Author: miyajan

docs/presence.md

@@ -1,6 +1,7 @@
 # Presence
 
 - [getPresenceByUserID](#getpresencebyuserid)
+- [getPresenceByUserCode](#getpresencebyusercode)
 
 ## Overview
 
@@ -38,3 +39,21 @@ See the example response in the `Reference`.
 #### Reference
 
 - https://developer.cybozu.io/hc/ja/articles/360026939891#step1
+
+### getPresenceByUserCode
+
+Get the presence information specified by the code of the user.
+
+#### Parameters
+
+| Name |  Type  | Required | Description           |
+| ---- | :----: | :------: | --------------------- |
+| code | String |   Yes    | The code of the user. |
+
+#### Returns
+
+See the example response in the `Reference`.
+
+#### Reference
+
+- https://developer.cybozu.io/hc/ja/articles/360026939891#step2

src/client/PresenceClient.ts

@@ -1,4 +1,5 @@
 import { HttpClient } from "../http";
+import { Presence } from "./types";
 import { buildPath } from "../url";
 
 export class PresenceClient {
@@ -10,21 +11,15 @@ export class PresenceClient {
 
   public getPresenceByUserID(params: {
     id: string | number;
-  }): Promise<{
-    user: {
-      id: string;
-      name: string;
-      code: string;
-    };
-    updatedAt: string;
-    notes: string;
-    status: {
-      name: string;
-      code: string;
-    };
-  }> {
+  }): Promise<Presence> {
     const { id } = params;
     const path = buildPath({ endpointName: `presence/users/${id}` });
     return this.client.get(path, {});
   }
+
+  public getPresenceByUserCode(params: { code: string }): Promise<Presence> {
+    const { code } = params;
+    const path = buildPath({ endpointName: `presence/users/code/${code}` });
+    return this.client.get(path, {});
+  }
 }

src/client/__tests__/PresenceClient.test.ts

@@ -35,4 +35,22 @@ describe("PresenceClient", () => {
       expect(mockClient.getLogs()[0].params).toEqual({});
     });
   });
+
+  describe("getPresenceByUserCode", () => {
+    const params = { code: "cybozu" };
+    beforeEach(async () => {
+      await presenceClient.getPresenceByUserCode(params);
+    });
+    it("should pass the path to the http client", () => {
+      expect(mockClient.getLogs()[0].path).toBe(
+        "/api/v1/presence/users/code/cybozu"
+      );
+    });
+    it("should send a get request", () => {
+      expect(mockClient.getLogs()[0].method).toBe("get");
+    });
+    it("should pass an empty object as a param to the http client", () => {
+      expect(mockClient.getLogs()[0].params).toEqual({});
+    });
+  });
 });

src/client/types/index.ts

@@ -1,2 +1,3 @@
 export * from "./schedule";
 export * from "./workflow";
+export * from "./presence";

src/client/types/presence/index.ts

@@ -0,0 +1,13 @@
+export type Presence = {
+  user: {
+    id: string;
+    name: string;
+    code: string;
+  };
+  updatedAt: string;
+  notes: string;
+  status: {
+    name: string;
+    code: string;
+  };
+};