screwdriver-api/plugins/banners/get.js

API server for the Screwdriver.cd service

'use strict';

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

module.exports = () => ({
    method: 'GET',
    path: '/banners/{id}',
    options: {
        description: 'Get a single banner',
        notes: 'Return a banner record',
        tags: ['api', 'banners'],
        plugins: {
            'hapi-rate-limit': {
                enabled: false
            }
        },
        auth: {
            strategies: ['token'],
            scope: ['user'],
            mode: 'try' // This allows unauthenticated requests but still runs the auth check
        },
        handler: async (request, h) => {
            const { bannerFactory } = request.server.app;
            const { id } = request.params;

            return bannerFactory
                .get(id)
                .then(banner => {
                    if (!banner) {
                        throw boom.notFound(`Banner ${id} does not exist`);
                    }
                    if (banner.scope !== 'GLOBAL') {
                        if (!request.auth.isAuthenticated) {
                            throw boom.unauthorized('Authentication required');
                        }
                    }

                    return h.response(banner.toJson());
                })
                .catch(err => {
                    throw err;
                });
        },
        response: {
            schema: getSchema
        },
        validate: {
            params: joi.object({
                id: idSchema
            })
        }
    }
});