bookbrainz/bookbrainz-site

/*
 * Copyright (C) 2019  Akhilesh Kumar
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */

import {lookupAndBrowseRequestSlowDown, searchRequestSlowDown} from './helpers/rateLimiter';
import {Router} from 'express';
import {allowOnlyGetMethod} from './helpers/utils';
import authorRouter from './routes/author';
import editionGroupRouter from './routes/edition-group';
import editionRouter from './routes/edition';
import publisherRouter from './routes/publisher';
import searchRouter from './routes/search';
import seriesRouter from './routes/series';
import swaggerRoute from './swagger';
import workRouter from './routes/work';

/**
 *@swagger
 * components:
 *   schemas:
 *     Alias:
 *       type: object
 *       properties:
 *         name:
 *           type: string
 *           example: 'John Doe'
 *         sortName:
 *           type: string
 *           example: 'Doe, John'
 *         language:
 *           type: string
 *           example: 'eng'
 *           description: Three letter ISO 639-3 language code
 *         primary:
 *           type: boolean
 *           example: true
 *     Aliases:
 *       type: object
 *       properties:
 *         bbid:
 *           type: string
 *           format: uuid
 *           example: '2e5f49a8-6a38-4cc7-97c7-8e624e1fc2c1'
 *         aliases:
 *           type: array
 *           items:
 *             $ref: '#/components/schemas/Alias'
 *     Identifiers:
 *       type: object
 *       properties:
 *         bbid:
 *           type: string
 *           format: uuid
 *           example: '2e5f49a8-6a38-4cc7-97c7-8e624e1fc2c1'
 *         identifiers:
 *           type: array
 *           items:
 *             type: object
 *             properties:
 *               type:
 *                 type: string
 *                 example: 'Wikidata ID'
 *               value:
 *                 type: string
 *                 example: 'Q123078'
 *     Relationships:
 *       type: object
 *       properties:
 *         bbid:
 *           type: string
 *           format: uuid
 *           example: '2e5f49a8-6a38-4cc7-97c7-8e624e1fc2c1'
 *         relationships:
 *           type: array
 *           items:
 *             type: object
 *             properties:
 *               direction:
 *                 type: string
 *                 example: 'forward'
 *               id:
 *                 type: number
 *                 example: 804
 *               linkPhrase:
 *                 type: string
 *                 example: 'wrote'
 *               relationshipTypeId:
 *                 type: number
 *                 example: 8
 *               relationshipTypeName:
 *                 type: string
 *                 example: 'Author'
 *               targetBbid:
 *                 type: string
 *                 format: uuid
 *                 example: '4682cf09-66fb-4542-b457-b889117e0279'
 *               targetEntityType:
 *                 type: string
 *                 example: 'work'
 *     SearchEntity:
 *       type: object
 *       properties:
 *         bbid:
 *           type: string
 *           format: uuid
 *           example: '2e5f49a8-6a38-4cc7-97c7-8e624e1fc2c1'
 *         entityType:
 *           type: string
 *           example: 'author'
 *         defaultAlias:
 *           type: object
 *           properties:
 *             name:
 *               type: string
 *               example: 'Robert A. Heinlein'
 *             sortName:
 *               type: string
 *               example: 'Heinlein, Robert A.'
 *             language:
 *               type: string
 *               example: 'eng'
 *               description: Three letter ISO 639-3 language code
 *             primary:
 *               type: boolean
 *               example: true
 *     SearchResultModel:
 *       type: object
 *       properties:
 *         searchCount:
 *           type: number
 *           example: 1
 *         searchResult:
 *           type: array
 *           items:
 *             $ref: '#/components/schemas/SearchEntity'
 */

function initWorkRoute(app) {
    app.use('/work', lookupAndBrowseRequestSlowDown, workRouter);
}

function initEditionRoute(app) {
    app.use('/edition', lookupAndBrowseRequestSlowDown, editionRouter);
}

function initEditionGroupRoute(app) {
    app.use('/edition-group', lookupAndBrowseRequestSlowDown, editionGroupRouter);
}

function initAuthorRoute(app) {
    app.use('/author', lookupAndBrowseRequestSlowDown, authorRouter);
}

function initSeriesRoute(app) {
    app.use('/series', lookupAndBrowseRequestSlowDown, seriesRouter);
}

function initPublisherRoute(app) {
    app.use('/publisher', lookupAndBrowseRequestSlowDown, publisherRouter);
}

function initSearchRouter(app) {
    app.use('/search', searchRequestSlowDown, searchRouter);
}

function initDocsRoute(app) {
    app.use(['/api-docs', '/docs'], swaggerRoute);
}

function initRoutes() {
    const router = Router();

    // Allow only get requests for now and throw error for any other type of requests
    router.all('/*', allowOnlyGetMethod);

    initWorkRoute(router);
    initEditionRoute(router);
    initEditionGroupRoute(router);
    initAuthorRoute(router);
    initSeriesRoute(router);
    initPublisherRoute(router);
    initSearchRouter(router);
    initDocsRoute(router);

    return router;
}

export default initRoutes;