rhodecode/integrations/schema.py

# -*- coding: utf-8 -*-

# Copyright (C) 2012-2016  RhodeCode GmbH
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Affero General Public License, version 3
# (only), as published by the Free Software Foundation.
#
# 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 Affero General Public License
# along with this program.  If not, see <http://www.gnu.org/licenses/>.
#
# This program is dual-licensed. If you wish to learn more about the
# RhodeCode Enterprise Edition, including its added features, Support services,
# and proprietary license terms, please see https://rhodecode.com/licenses/

import colander

from rhodecode.translation import lazy_ugettext


class IntegrationSettingsSchemaBase(colander.MappingSchema):
    """
    This base schema is intended for use in integrations.
    It adds a few default settings (e.g., "enabled"), so that integration
    authors don't have to maintain a bunch of boilerplate.
    """
    enabled = colander.SchemaNode(
        colander.Bool(),
        default=True,
        description=lazy_ugettext('Enable or disable this integration.'),
        missing=False,
        title=lazy_ugettext('Enabled'),
    )

    name = colander.SchemaNode(
        colander.String(),
        description=lazy_ugettext('Short name for this integration.'),
        missing=colander.required,
        title=lazy_ugettext('Integration name'),
    )