screwdriver-api/plugins/banners/remove.js

API server for the Screwdriver.cd service

'use strict';

const boom = require('@hapi/boom');
const schema = require('screwdriver-data-schema');
const joi = require('joi');
const idSchema = schema.models.banner.base.extract('id');

module.exports = () => ({
    method: 'DELETE',
    path: '/banners/{id}',
    options: {
        description: 'Delete a banner',
        notes: 'Delete a specific banner and return null if success',
        tags: ['api', 'banners'],
        auth: {
            strategies: ['token'],
            scope: ['user', '!guest']
        },

        handler: async (request, h) => {
            const { bannerFactory } = request.server.app;
            const { id } = request.params; // id of banner to delete
            const { username, scmContext, scmUserId } = request.auth.credentials;
            const { scm } = bannerFactory;
            const scmDisplayName = scm.getDisplayName({ scmContext });

            // lookup whether user is admin
            const adminDetails = request.server.plugins.banners.screwdriverAdminDetails(
                username,
                scmDisplayName,
                scmUserId
            );

            // verify user is authorized to remove banners
            // return unauthorized if not system admin
            if (!adminDetails.isAdmin) {
                return boom.forbidden(
                    `User ${adminDetails.userDisplayName}
                    does not have Screwdriver administrative privileges.`
                );
            }

            return bannerFactory
                .get(id)
                .then(banner => {
                    if (!banner) {
                        throw boom.notFound(`Banner ${id} does not exist`);
                    }

                    return banner.remove().then(() => h.response().code(204));
                })
                .catch(err => {
                    throw err;
                });
        },
        validate: {
            params: joi.object({
                id: idSchema
            })
        }
    }
});