feat(users): Add users collection to SDK

docs/users.md

@@ -13,7 +13,7 @@ View the [User response object](user-object-reference) for details on the proper
 <a id="me"></a>
 
 ## `sdk.users.me()`
-This method is used to get details about the current logged in user.
+Gets details about the current logged in user.
 
 **Read [`/users/me` documentation](user-get-me) for more details.**
 
@@ -38,7 +38,7 @@ sdk.users.me().then((user) => {
 <a id="getById"></a>
 
 ## `sdk.users.get(id)`
-This method is used to load the details for a specific user by their user id. 
+Gets the details for a specific user by their user id. 
 
 **Read [`/users/:id` documentation](user-get-me) for more details.**
 
@@ -63,7 +63,7 @@ sdk.users.get('1234567890').then((user) => {
 <a id="lookByEmail"></a>
 
 ## `sdk.users.emailLookup(email)`
-This method is used to load the details for a specific user. Currently it supports look ups via the email property.
+Gets the details for a specific user using their emaill address.
 
 **_Currently, no public documentation page._**
 

src/__tests__/__fixtures__/index.ts

@@ -14,6 +14,22 @@ export const MOCK_USERS_ME_RESPONSE_DATA = {
     image_id: null as string,
 };
 
+export const MOCK_TRANSFORMED_USERS_ME_RESPONSE_DATA = {
+    emails: [
+        {
+            email: '[email protected]',
+            verified: true,
+            primary: true,
+        },
+    ],
+    id: '142429416488',
+    name: 'Eventbrite Engineer',
+    firstName: 'Eventbrite',
+    lastName: 'Engineer',
+    isPublic: false,
+    imageId: null as string,
+};
+
 export const MOCK_INTERNAL_ERROR_RESPONSE_DATA = {
     status_code: 500,
     error: 'INTERNAL_ERROR',

src/__tests__/index.spec.ts

@@ -5,7 +5,10 @@ import {
     restoreMockFetch,
     getMockResponse,
 } from './utils';
-import {MOCK_USERS_ME_RESPONSE_DATA} from './__fixtures__';
+import {
+    MOCK_USERS_ME_RESPONSE_DATA,
+    MOCK_TRANSFORMED_USERS_ME_RESPONSE_DATA,
+} from './__fixtures__';
 
 describe('configurations', () => {
     it('does not error when creating sdk object w/o configuration', () => {
@@ -111,7 +114,7 @@ describe('request', () => {
             });
 
             await expect(users.me()).resolves.toEqual(
-                MOCK_USERS_ME_RESPONSE_DATA
+                MOCK_TRANSFORMED_USERS_ME_RESPONSE_DATA
             );
 
             expect(getMockFetch()).toHaveBeenCalledTimes(1);

src/__tests__/users.spec.ts

@@ -4,18 +4,23 @@ import {
     getMockResponse,
     restoreMockFetch,
 } from './utils';
-import {MOCK_USERS_ME_RESPONSE_DATA} from './__fixtures__';
+import {
+    MOCK_USERS_ME_RESPONSE_DATA,
+    MOCK_TRANSFORMED_USERS_ME_RESPONSE_DATA,
+} from './__fixtures__';
 
 import request from '../request';
-import usersCollection from '../users';
+import usersMethods from '../users';
 
-const users = usersCollection(request);
+const users = usersMethods(request);
 
 describe('users.me()', () => {
     it('calls fetch and calls fetch with appropriate defaults', async() => {
         mockFetch(getMockResponse(MOCK_USERS_ME_RESPONSE_DATA));
 
-        await expect(users.me()).resolves.toEqual(MOCK_USERS_ME_RESPONSE_DATA);
+        await expect(users.me()).resolves.toEqual(
+            MOCK_TRANSFORMED_USERS_ME_RESPONSE_DATA
+        );
 
         expect(getMockFetch()).toHaveBeenCalledTimes(1);
         expect(getMockFetch()).toHaveBeenCalledWith(

src/index.ts

@@ -1,6 +1,6 @@
-import {Sdk, SdkConfig, RequestHelper} from './types';
+import {Sdk, SdkConfig, JSONRequest} from './types';
 import request from './request';
-import userCollection from './users';
+import userMethods from './users';
 
 export * from './constants';
 
@@ -10,7 +10,7 @@ const eventbrite = ({
     baseUrl = DEFAULT_API_URL,
     token,
 }: SdkConfig = {}): Sdk => {
-    const requestHelper: RequestHelper = (endpoint, options = {}) => {
+    const requestHelper: JSONRequest = (endpoint, options = {}) => {
         const url = `${baseUrl}${endpoint}`;
         let requestOptions = options;
 
@@ -29,7 +29,7 @@ const eventbrite = ({
 
     return {
         request: requestHelper,
-        users: userCollection(requestHelper),
+        users: userMethods(requestHelper),
     };
 };
 

src/request.ts

@@ -1,4 +1,4 @@
-import {JSONResponseData, ParsedResponseError} from './types';
+import {JSONRequest, JSONResponseData, ParsedResponseError} from './types';
 import 'isomorphic-fetch';
 
 /**
@@ -145,5 +145,7 @@ const _catchStatusError = (res: Response): Promise<any> =>
  * Low-level method that makes fetch requests, returning the response formatted as JSON.
  * It parses errors from API v3 and throws exceptions with those errors
  */
-export default (url: string, options?: RequestInit): Promise<{}> =>
+const jsonRequest: JSONRequest = (url: string, options?: RequestInit) =>
     _fetchJSON(url, options).catch(_catchStatusError);
+
+export default jsonRequest;

src/types.ts

@@ -1,18 +1,18 @@
-import {UserCollection} from './users';
+import {UserMethods} from './users';
 
 export interface SdkConfig {
     token?: string;
     baseUrl?: string;
 }
 
-export type RequestHelper = (
+export type JSONRequest = (
     apiPath: string,
     options?: RequestInit
 ) => Promise<{}>;
 
 export interface Sdk {
-    request: RequestHelper;
-    users: UserCollection;
+    request: JSONRequest;
+    users: UserMethods;
 }
 
 export interface ArgumentErrors {

src/users.ts

@@ -1,24 +1,48 @@
-import {RequestHelper} from './types';
+import {JSONRequest} from './types';
 
-export interface UserObject {
+export type Email = {
+    email: string;
+    primary: boolean;
+};
+
+export interface User {
     id: string;
-    first_name: string;
-    last_name: string;
-    image_id: string;
-    email: [
-        {
-            email: string;
-            primary: true;
-        }
-    ];
+    firstName: string;
+    lastName: string;
+    imageId: string;
+    email: Email[];
 }
 
-export interface UserCollection {
-    [key: string]: () => Promise<UserObject>;
+export interface UserMethods {
+    me: () => Promise<User>;
 }
 
-export default (request: RequestHelper): UserCollection => {
-    const me = () => request('/users/me/') as Promise<UserObject>;
+const SNAKE_CASE_MATCH = /_\w/g;
+const snakeToCamel = (str: string) =>
+    str.replace(SNAKE_CASE_MATCH, (chars: string) => chars[1].toUpperCase());
+
+const transformKeysSnakeToCamel = (obj: {}): {} =>
+    Object.entries(obj).reduce((memo, [key, value]) => {
+        const camelKey = snakeToCamel(key);
+        let newValue = value;
+
+        if (
+            newValue &&
+            typeof newValue === 'object' &&
+            !Array.isArray(newValue)
+        ) {
+            newValue = transformKeysSnakeToCamel(newValue);
+        }
+
+        return {
+            ...memo,
+            [camelKey]: newValue,
+        };
+    }, {});
+
+export default (request: JSONRequest): UserMethods => {
+    const me = () =>
+        request('/users/me/').then(transformKeysSnakeToCamel) as Promise<User>;
 
     return {
         me,