#!/usr/bin/env python
# vim: set fileencoding=utf-8 :
###############################################################################
# #
# Copyright (c) 2016 Idiap Research Institute, http://www.idiap.ch/ #
# Contact: beat.support@idiap.ch #
# #
# This file is part of the beat.web module of the BEAT platform. #
# #
# Commercial License Usage #
# Licensees holding valid commercial BEAT licenses may use this file in #
# accordance with the terms contained in a written agreement between you #
# and Idiap. For further information contact tto@idiap.ch #
# #
# Alternatively, this file may be used under the terms of the GNU Affero #
# Public License version 3 as published by the Free Software and appearing #
# in the file LICENSE.AGPL included in the packaging of this file. #
# The BEAT platform 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. #
# #
# You should have received a copy of the GNU Affero Public License along #
# with the BEAT platform. If not, see http://www.gnu.org/licenses/. #
# #
###############################################################################
from ..code.api import DiffView
from ..code.api import RetrieveUpdateDestroyCodeView
from ..code.api import ShareCodeView
from ..code.serializers import CodeDiffSerializer
from ..common.api import CheckContributionNameView
from ..common.api import ListContributionView
from ..common.api import ListCreateContributionView
from .models import Library
from .serializers import FullLibrarySerializer
from .serializers import LibraryCreationSerializer
from .serializers import LibraryModSerializer
from .serializers import LibrarySerializer
# ----------------------------------------------------------
[docs]class CheckLibraryNameView(CheckContributionNameView):
"""
This view sanitizes a library name and
checks whether it is already used.
"""
model = Library
# ----------------------------------------------------------
[docs]class ShareLibraryView(ShareCodeView):
"""
This view allows to share a library with
other users and/or teams
"""
model = Library
# ----------------------------------------------------------
[docs]class ListLibrariesView(ListContributionView):
"""
List all available libraries
"""
model = Library
serializer_class = LibrarySerializer
# ----------------------------------------------------------
[docs]class ListCreateLibrariesView(ListCreateContributionView):
"""
Read/Write end point that list the libraries available
from a given author and allows the creation of new libraries
"""
model = Library
serializer_class = LibrarySerializer
writing_serializer_class = LibraryCreationSerializer
namespace = "api_libraries"
# ----------------------------------------------------------
[docs]class RetrieveUpdateDestroyLibrariesView(RetrieveUpdateDestroyCodeView):
"""
Read/Write/Delete endpoint for a given library
"""
model = Library
serializer_class = FullLibrarySerializer
writing_serializer_class = LibraryModSerializer
# ----------------------------------------------------------
[docs]class DiffLibraryView(DiffView):
"""
This view shows the differences between two libraries
"""
model = Library
serializer_class = CodeDiffSerializer