feat(users): Add users collection to SDK

README.md

@@ -24,7 +24,7 @@ The official JavaScript SDK for the [Eventbrite v3 API](https://www.eventbrite.c
 
 > NOTE: This library is still in **beta** as we flesh out the API of the SDK.
 
-## ToC
+## Table of Contents
 
 *   [Installation](#installation)
 *   [Quick Usage](#quick-usage)

docs/README.md

@@ -2,11 +2,12 @@
 
 This SDK interface closely mirors the [Eventbrite v3 REST API](https://www.eventbrite.com/developer/v3/) endpoints that it wraps. The SDK provides many conveniences for making requests and processing responses to make it easier to use in the JavaScript environment.
 
-## ToC
+## Table of Contents
 
 -   [Including the package](#including-the-package)
 -   [Configuring a SDK object](#configuring-a-sdk-object)
 -   [`request()`](./request.md)
+-   [Users](./users.md)
 
 ## Including the package
 

docs/users.md

@@ -0,0 +1,93 @@
+# Users
+
+This is a collection of method that are intended to be helpful wrappers around the [Users API endpoints](user-api-docs).
+
+View the [User response object](user-object-reference) for details on the properties you'll get back with each response.
+
+## Table on Contents
+
+- [`sdk.users.me()`](#me)
+- [`sdk.users.get(id)`](#getById)
+- [`sdk.users.emailLookup(email)`](#lookByEmail)
+
+<a id="me"></a>
+
+## `sdk.users.me()`
+This method is used to get details about the current logged in user.
+
+**Read [`/users/me` documentation](user-get-me) for more details.**
+
+### API
+```js
+sdk.users.me(): Promise<User>
+```
+
+### Example
+
+```js
+const eventbrite = require('eventbrite');
+
+// Create configured Eventbrite SDK
+const sdk = eventbrite({token: 'OATH_TOKEN_HERE'});
+
+sdk.users.me().then((user) => {
+    console.log(`Hi ${user.name}!`);
+});
+```
+
+<a id="getById"></a>
+
+## `sdk.users.get(id)`
+This method is used to load the details for a specific user by their user id. 
+
+**Read [`/users/:id` documentation](user-get-me) for more details.**
+
+### API
+```js
+sdk.users.get(id: string): Promise<User>
+```
+
+### Example
+
+```js
+const eventbrite = require('eventbrite');
+
+// Create configured Eventbrite SDK
+const sdk = eventbrite({token: 'OATH_TOKEN_HERE'});
+
+sdk.users.get('1234567890').then((user) => {
+    console.log(`Hi ${user.name}!`);
+});
+```
+
+<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.
+
+**_Currently, no public documentation page._**
+
+### API
+```js
+sdk.users.emailLookup(string>): Promise<User>
+```
+
+### Example
+
+```js
+const eventbrite = require('eventbrite');
+
+// Create configured Eventbrite SDK
+const sdk = eventbrite({token: 'OATH_TOKEN_HERE'});
+
+sdk.users.emailLookup('[email protected]').then((user) => {
+    console.log(`Hi ${user.name}!`);
+});
+```
+
+
+<!-- link reference section -->
+[user-api-docs]: https://www.eventbrite.com/platform/api#/reference/user
+[user-object-reference]: https://www.eventbrite.com/platform/api#/reference/user/retrieve-a-user
+[user-by-id]: https://www.eventbrite.com/platform/api#/reference/user/retrieve-a-user
+[user-get-me]: https://www.eventbrite.com/platform/api#/reference/user/retrieve/retrieve-your-user

src/__tests__/index.spec.ts

@@ -90,4 +90,39 @@ describe('request', () => {
             })
         );
     });
+
+    describe('users collection', () => {
+        it('should return an object of functions', () => {
+            const {users} = eventbrite({
+                token: MOCK_TOKEN,
+                baseUrl: MOCK_BASE_URL,
+            });
+
+            expect(users).toBeDefined();
+            for (const value of Object.values(users)) {
+                expect(value).toBeInstanceOf(Function);
+            }
+        });
+
+        it('makes request to API base url override w/ specified token', async() => {
+            const {users} = eventbrite({
+                token: MOCK_TOKEN,
+                baseUrl: MOCK_BASE_URL,
+            });
+
+            await expect(users.me()).resolves.toEqual(
+                MOCK_USERS_ME_RESPONSE_DATA
+            );
+
+            expect(getMockFetch()).toHaveBeenCalledTimes(1);
+            expect(getMockFetch()).toHaveBeenCalledWith(
+                `${MOCK_BASE_URL}/users/me/`,
+                expect.objectContaining({
+                    headers: expect.objectContaining({
+                        Authorization: `Bearer ${MOCK_TOKEN}`,
+                    }),
+                })
+            );
+        });
+    });
 });

src/__tests__/users.spec.ts

@@ -0,0 +1,28 @@
+import {
+    mockFetch,
+    getMockFetch,
+    getMockResponse,
+    restoreMockFetch,
+} from './utils';
+import {MOCK_USERS_ME_RESPONSE_DATA} from './__fixtures__';
+
+import request from '../request';
+import usersCollection from '../users';
+
+const users = usersCollection(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);
+
+        expect(getMockFetch()).toHaveBeenCalledTimes(1);
+        expect(getMockFetch()).toHaveBeenCalledWith(
+            '/users/me/',
+            expect.objectContaining({})
+        );
+
+        restoreMockFetch();
+    });
+});

src/index.ts

@@ -1,5 +1,6 @@
-import {Sdk, SdkConfig} from './types';
+import {Sdk, SdkConfig, RequestHelper} from './types';
 import request from './request';
+import userCollection from './users';
 
 export * from './constants';
 
@@ -8,8 +9,8 @@ const DEFAULT_API_URL = 'https://www.eventbriteapi.com/v3';
 const eventbrite = ({
     baseUrl = DEFAULT_API_URL,
     token,
-}: SdkConfig = {}): Sdk => ({
-    request: (endpoint, options = {}) => {
+}: SdkConfig = {}): Sdk => {
+    const requestHelper: RequestHelper = (endpoint, options = {}) => {
         const url = `${baseUrl}${endpoint}`;
         let requestOptions = options;
 
@@ -24,7 +25,12 @@ const eventbrite = ({
         }
 
         return request(url, requestOptions);
-    },
-});
+    };
+
+    return {
+        request: requestHelper,
+        users: userCollection(requestHelper),
+    };
+};
 
 export default eventbrite;

src/types.ts

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

src/users.ts

@@ -0,0 +1,26 @@
+import {RequestHelper} from './types';
+
+export interface UserObject {
+    id: string;
+    first_name: string;
+    last_name: string;
+    image_id: string;
+    email: [
+        {
+            email: string;
+            primary: true;
+        }
+    ];
+}
+
+export interface UserCollection {
+    [key: string]: () => Promise<UserObject>;
+}
+
+export default (request: RequestHelper): UserCollection => {
+    const me = () => request('/users/me/') as Promise<UserObject>;
+
+    return {
+        me,
+    };
+};

tsconfig.json

@@ -1,6 +1,6 @@
 {
     "compilerOptions": {
-        "lib": ["es2015", "dom"],
+        "lib": ["es2017", "dom"],
         "noImplicitAny": true,
         "noEmit": true
     },