clean flow, add WebhookMutator

Author: AntonPuko

src/lib/OAuthModel.js

@@ -1,24 +1,30 @@
 // @flow
 
-import type { Client, Repository, User } from '../types';
+import type {
+  Client,
+  TokenObject,
+  User,
+  UsersRepository,
+} from '../types';
 
 import ouathClients from '../oauthClients.json';
 
 class OauthModel {
-  _usersRepository: Repository<User>;
+  _usersRepository: UsersRepository;
 
-  constructor(usersRepository: Repository<User>) {
+  constructor(usersRepository: UsersRepository) {
     this._usersRepository = usersRepository;
   }
 
-  getAccessToken = (bearerToken: string) => {
+  getAccessToken = (bearerToken: string): ?Object => {
     const user = this._usersRepository.getByAccessToken(bearerToken);
     if (!user) {
-      return false;
+      return null;
     }
 
-    const userTokenObject = user.accessTokens.find((tokenObject) =>
-      tokenObject.accessToken === bearerToken,
+    const userTokenObject = user.accessTokens.find(
+      (tokenObject: TokenObject): boolean =>
+        tokenObject.accessToken === bearerToken,
     );
 
     return {
@@ -32,11 +38,11 @@ class OauthModel {
       client.clientId === clientId && client.clientSecret === clientSecret,
     );
 
-  getUser = async (username: string, password: string): User => {
-    return await this._usersRepository.validateLogin(username, password);
-  };
+  getUser = async (username: string, password: string): Promise<User> =>
+    await this._usersRepository.validateLogin(username, password);
+
 
-  saveToken = (tokenObject, client, user) => {
+  saveToken = (tokenObject: TokenObject, client: Client, user: User): Object => {
     this._usersRepository.saveAccessToken(user.id, tokenObject);
     return {
       accessToken: tokenObject.accessToken,

src/lib/controllers/Controller.js

@@ -1,15 +1,14 @@
+// @flow
+
+// todo annotate better
 export default class Controller {
-  bad(message) {
-    return {
-      data: {message},
-      status: 400,
-    };
-  }
+  bad = (message: string): Object => ({
+    data: { message },
+    status: 400,
+  });
 
-  ok(output) {
-    return {
-      data: output,
-      status: 200,
-    };
-  }
+  ok = (output?: Object): Object => ({
+    data: output,
+    status: 200,
+  });
 }

src/lib/controllers/UsersController.js

@@ -1,6 +1,9 @@
 // @flow
 
-import type { Repository, User, UserCredentials } from '../../types';
+import type {
+  UserCredentials,
+  UsersRepository,
+} from '../../types';
 
 import basicAuthParser from 'basic-auth-parser';
 import Controller from './Controller';
@@ -9,17 +12,17 @@ import httpVerb from '../decorators/httpVerb';
 import route from '../decorators/route';
 
 class UsersController extends Controller {
-  _usersRepository: Repository<User>;
+  _usersRepository: UsersRepository;
 
-  constructor(usersRepository: Repository<User>) {
+  constructor(usersRepository: UsersRepository) {
     super();
     this._usersRepository = usersRepository;
   }
 
   @httpVerb('post')
   @route('/v1/users')
   @anonymous()
-  async createUser(userCredentials: UserCredentials) {
+  async createUser(userCredentials: UserCredentials): Promise<Object> {
     try {
       const isUserNameInUse =
         this._usersRepository.isUserNameInUse(userCredentials.username);
@@ -38,7 +41,7 @@ class UsersController extends Controller {
   @httpVerb('delete')
   @route('/v1/access_tokens/:token')
   @anonymous()
-  async deleteAccessToken(token: string) {
+  async deleteAccessToken(token: string): Promise<Object> {
     try {
       const { username, password } = basicAuthParser(this.request.get('authorization'));
       const user = await this._usersRepository.validateLogin(username, password);
@@ -54,7 +57,7 @@ class UsersController extends Controller {
   @httpVerb('get')
   @route('/v1/access_tokens')
   @anonymous()
-  async getAccessTokens() {
+  async getAccessTokens(): Promise<Object> {
     try {
       const { username, password } = basicAuthParser(this.request.get('authorization'));
       const user = await this._usersRepository.validateLogin(username, password);

src/lib/controllers/WebhookController.js

@@ -1,13 +1,17 @@
 // @flow
 
-import type { Repository, Webhook, WebhookRequestType } from '../../types';
+import type {
+  Repository,
+  RequestType,
+  Webhook,
+  WebhookMutator,
+} from '../../types';
 
-import settings from '../../settings';
 import Controller from './Controller';
 import httpVerb from '../decorators/httpVerb';
 import route from '../decorators/route';
 
-const REQUEST_TYPES: Array<WebhookRequestType> = [
+const REQUEST_TYPES: Array<RequestType> = [
   'DELETE', 'GET', 'POST', 'PUT',
 ];
 
@@ -39,19 +43,19 @@ class WebhookController extends Controller {
 
   @httpVerb('get')
   @route('/v1/webhooks')
-  get() {
+  getAll(): Object {
     return this.ok(this._webhookRepository.getAll());
   }
 
   @httpVerb('get')
   @route('/v1/webhooks/:webhookId')
-  getByWebhookId(webhookId: string) {
+  getById(webhookId: string): Object {
     return this.ok(this._webhookRepository.getById(webhookId));
   }
 
   @httpVerb('post')
   @route('/v1/webhooks')
-  post(model: Webhook) {
+  create(model: WebhookMutator): Object {
     try {
       const validateError = validateWebhookModel(model);
       if (validateError) {
@@ -73,8 +77,8 @@ class WebhookController extends Controller {
 
   @httpVerb('delete')
   @route('/v1/webhooks/:webhookId')
-  delete(webhookId: string) {
-    this._webhookRepository.delete(webhookId);
+  deleteById(webhookId: string): Object {
+    this._webhookRepository.deleteById(webhookId);
     return this.ok();
   }
 }

src/lib/decorators/types.js

@@ -1,3 +1,5 @@
+// @flow
+
 export type Decorator = (
   target: Object,
   name: string,
@@ -8,7 +10,7 @@ export type HttpVerb =
   'checkout' |
   'connect' |
   'copy' |
-  'delete' |
+  'deleteById' |
   'head' |
   'get' |
   'lock' |

src/lib/repository/UsersFileRepository.js

@@ -5,15 +5,14 @@ import type { TokenObject, User, UserCredentials } from '../../types';
 import { FileManager, uuid } from 'spark-protocol';
 import PasswordHasher from '../PasswordHasher';
 
-// todo change class methods style to arrow functions.
 class UsersFileRepository {
   _fileManager: FileManager;
 
   constructor(path: string) {
     this._fileManager = new FileManager(path);
   }
 
-  create = async (userCredentials: UserCredentials): User => {
+  create = async (userCredentials: UserCredentials): Promise<User> => {
     const { username, password } = userCredentials;
 
     const salt = await PasswordHasher.generateSalt();
@@ -33,19 +32,16 @@ class UsersFileRepository {
     return modelToSave;
   };
 
-  getAll(): Array<User> {
-    return this._fileManager.getAllData();
-  }
+  getAll = (): Array<User> =>
+    this._fileManager.getAllData();
 
-  getById(id: string): User {
-    return this._fileManager.getFile(id + '.json');
-  }
+  getById = (id: string): User =>
+    this._fileManager.getFile(`${id}.json`);
 
-  getByUsername(username: string) {
-    return this.getAll().find((user: User) => user.username === username);
-  }
+  getByUsername = (username: string): ?User =>
+    this.getAll().find((user: User): boolean => user.username === username);
 
-  async validateLogin(username: string, password: string) {
+  async validateLogin(username: string, password: string): User {
     try {
       const user = this.getByUsername(username);
       if (!user) {
@@ -70,7 +66,7 @@ class UsersFileRepository {
       ),
     );
 
-  deleteAccessToken(user: User, token: string) {
+  deleteAccessToken = (user: User, token: string) => {
     const userToSave = {
       ...user,
       accessTokens: user.accessTokens.filter(
@@ -80,18 +76,18 @@ class UsersFileRepository {
     };
 
     this._fileManager.writeFile(`${user.id}.json`, userToSave);
-  }
+  };
 
-  deleteById(id: string) {
+  deleteById = (id: string): void =>
     this._fileManager.deleteFile(`${id}.json`);
-  }
+
 
   isUserNameInUse = (username: string): boolean =>
     this.getAll().some((user: User): boolean =>
       user.username === username,
     );
 
-  saveAccessToken(userId: string, tokenObject: TokenObject) {
+  saveAccessToken = (userId: string, tokenObject: TokenObject) => {
     const user = this.getById(userId);
     const userToSave = {
       ...user,

src/lib/repository/WebhookFileRepository.js

@@ -25,7 +25,7 @@ class WebhookFileRepository {
     return modelToSave;
   };
 
-  delete = (id: string): void =>
+  deleteById = (id: string): void =>
     this._fileManager.deleteFile(`${id}.json`);
 
   getAll = (): Array<Webhook> =>

src/types.js

@@ -1,3 +1,5 @@
+// @flow
+
 export type Webhook = {
   deviceID: string,
   event: string,
@@ -7,14 +9,32 @@ export type Webhook = {
   mydevices: boolean,
   productIdOrSlug: ?string,
   rejectUnauthorized: boolean,
-  requestType: string,
+  requestType: RequestType,
   responseTemplate: ?string,
   responseTopic: string,
   url: string,
 };
 
-export type WebhookRequestType = 'DELETE' | 'GET' |  'POST' | 'PUT';
+export type WebhookMutator = {
+  auth?: { Authorization: string },
+  deviceID?: boolean,
+  errorResponseTopic?: string,
+  event: string,
+  form?: { [key: string]: Object },
+  headers?:{ [key: string]: string },
+  json?: { [key: string]: Object },
+  mydevices?: boolean,
+  noDefaults?: boolean,
+  productIdOrSlug?: string,
+  query?: { [key: string]: Object },
+  rejectUnauthorized?: boolean,
+  requestType: RequestType,
+  responseTemplate?: string,
+  responseTopic?: string,
+  url: string,
+};
 
+export type RequestType = 'DELETE' | 'GET' | 'POST' | 'PUT';
 
 export type Client = {
   clientId: string,
@@ -59,12 +79,21 @@ export type UserCredentials = {
 
 export type Repository<TModel> = {
   create: (id: string, model: TModel) => TModel,
-  delete: (id: string) => void,
+  deleteById: (id: string) => void,
   getAll: () => Array<TModel>,
   getById: (id: string) => TModel,
   update: (id: string, model: TModel) => TModel,
 };
 
+export type UsersRepository = Repository<User> & {
+  deleteAccessToken: (accessToken: string) => void,
+  getByAccessToken: (accessToken: string) => User,
+  getByUsername: (username: string) => ?User,
+  isUserNameInUse: (username: string) => boolean,
+  saveAccessToken: (accessToken: string) => void,
+  validateLogin: (username: string, password: string) => User,
+};
+
 export type Settings = {
   accessTokenLifetime: number,
   baseUrl: string,

test/UsersController.test.js

@@ -1,14 +1,14 @@
 // @flow
 
-import type { TokenObject } from '../src/types';
+import type {  TokenObject, UserCredentials } from '../src/types';
 
 import test from 'ava';
 import request from 'supertest-as-promised';
 import ouathClients from '../src/oauthClients.json';
 import app from './testApp';
 import settings from './settings';
 
-const USER_CREDENTIALS = {
+const USER_CREDENTIALS: UserCredentials = {
   password: 'password',
   username: '[email protected]',
 };
@@ -67,7 +67,7 @@ test.serial('should return all access tokens for the user', async t => {
 });
 
 
-test.serial('should delete access token for the user', async t => {
+test.serial('should deleteById access token for the user', async t => {
   const deleteResponse = await request(app)
     .delete(`/v1/access_tokens/${userToken}`)
     .auth(USER_CREDENTIALS.username, USER_CREDENTIALS.password);