diff --git a/swh/deposit/api/private/__init__.py b/swh/deposit/api/private/__init__.py --- a/swh/deposit/api/private/__init__.py +++ b/swh/deposit/api/private/__init__.py @@ -58,7 +58,7 @@ return utils.merge(*metadata) -class SWHPrivateAPIView(APIConfig, AuthenticatedAPIView): +class APIPrivateView(APIConfig, AuthenticatedAPIView): """Mixin intended as private api (so no authentication) based API view (for the private ones). diff --git a/swh/deposit/api/private/deposit_check.py b/swh/deposit/api/private/deposit_check.py --- a/swh/deposit/api/private/deposit_check.py +++ b/swh/deposit/api/private/deposit_check.py @@ -15,7 +15,7 @@ from swh.scheduler.utils import create_oneshot_task_dict -from . import DepositReadMixin, SWHPrivateAPIView +from . import DepositReadMixin, APIPrivateView from ..common import APIGet from ...config import DEPOSIT_STATUS_VERIFIED, DEPOSIT_STATUS_REJECTED from ...config import ARCHIVE_TYPE @@ -55,7 +55,7 @@ ) -class SWHChecksDeposit(SWHPrivateAPIView, APIGet, DepositReadMixin): +class APIChecks(APIPrivateView, APIGet, DepositReadMixin): """Dedicated class to read a deposit's raw archives content. Only GET is supported. diff --git a/swh/deposit/api/private/deposit_list.py b/swh/deposit/api/private/deposit_list.py --- a/swh/deposit/api/private/deposit_list.py +++ b/swh/deposit/api/private/deposit_list.py @@ -9,7 +9,7 @@ from rest_framework.pagination import PageNumberPagination from rest_framework import serializers -from . import SWHPrivateAPIView +from . import APIPrivateView from ..converters import convert_status_detail from ...models import Deposit @@ -38,7 +38,7 @@ fields = "__all__" -class DepositList(ListAPIView, SWHPrivateAPIView): +class APIList(ListAPIView, APIPrivateView): """Deposit request class to list the deposit's status per page. HTTP verbs supported: GET diff --git a/swh/deposit/api/private/deposit_read.py b/swh/deposit/api/private/deposit_read.py --- a/swh/deposit/api/private/deposit_read.py +++ b/swh/deposit/api/private/deposit_read.py @@ -16,7 +16,7 @@ from swh.model import identifiers from swh.deposit.utils import normalize_date -from . import DepositReadMixin, SWHPrivateAPIView +from . import DepositReadMixin, APIPrivateView from ...config import SWH_PERSON, ARCHIVE_TYPE from ..common import APIGet from ...models import Deposit @@ -60,7 +60,7 @@ shutil.rmtree(dir_path) -class SWHDepositReadArchives(SWHPrivateAPIView, APIGet, DepositReadMixin): +class APIReadArchives(APIPrivateView, APIGet, DepositReadMixin): """Dedicated class to read a deposit's raw archives content. Only GET is supported. @@ -102,7 +102,7 @@ ) -class SWHDepositReadMetadata(SWHPrivateAPIView, APIGet, DepositReadMixin): +class APIReadMetadata(APIPrivateView, APIGet, DepositReadMixin): """Class in charge of aggregating metadata on a deposit. """ diff --git a/swh/deposit/api/private/deposit_update_status.py b/swh/deposit/api/private/deposit_update_status.py --- a/swh/deposit/api/private/deposit_update_status.py +++ b/swh/deposit/api/private/deposit_update_status.py @@ -7,7 +7,7 @@ from swh.model.identifiers import DIRECTORY, swhid, REVISION, SNAPSHOT -from . import SWHPrivateAPIView +from . import APIPrivateView from ..common import APIPut from ...errors import make_error_dict, BAD_REQUEST from ...models import Deposit, DEPOSIT_STATUS_DETAIL @@ -17,7 +17,7 @@ MANDATORY_KEYS = ["origin_url", "revision_id", "directory_id", "snapshot_id"] -class SWHUpdateStatusDeposit(SWHPrivateAPIView, APIPut): +class APIUpdateStatus(APIPrivateView, APIPut): """Deposit request class to update the deposit's status. HTTP verbs supported: PUT diff --git a/swh/deposit/api/private/urls.py b/swh/deposit/api/private/urls.py --- a/swh/deposit/api/private/urls.py +++ b/swh/deposit/api/private/urls.py @@ -1,4 +1,4 @@ -# Copyright (C) 2017-2018 The Software Heritage developers +# Copyright (C) 2017-2020 The Software Heritage developers # See the AUTHORS file at the top-level directory of this distribution # License: GNU General Public License version 3, or any later version # See top-level LICENSE file for more information @@ -12,68 +12,68 @@ PRIVATE_CHECK_DEPOSIT, PRIVATE_LIST_DEPOSITS, ) -from .deposit_read import SWHDepositReadArchives -from .deposit_read import SWHDepositReadMetadata -from .deposit_update_status import SWHUpdateStatusDeposit -from .deposit_check import SWHChecksDeposit -from .deposit_list import DepositList +from .deposit_read import APIReadArchives +from .deposit_read import APIReadMetadata +from .deposit_update_status import APIUpdateStatus +from .deposit_check import APIChecks +from .deposit_list import APIList urlpatterns = [ # Retrieve deposit's raw archives' content # -> GET url( r"^(?P[^/]+)/(?P[^/]+)/raw/$", - SWHDepositReadArchives.as_view(), + APIReadArchives.as_view(), name=PRIVATE_GET_RAW_CONTENT, ), # Update deposit's status # -> PUT url( r"^(?P[^/]+)/(?P[^/]+)/update/$", - SWHUpdateStatusDeposit.as_view(), + APIUpdateStatus.as_view(), name=PRIVATE_PUT_DEPOSIT, ), # Retrieve metadata information on a specific deposit # -> GET url( r"^(?P[^/]+)/(?P[^/]+)/meta/$", - SWHDepositReadMetadata.as_view(), + APIReadMetadata.as_view(), name=PRIVATE_GET_DEPOSIT_METADATA, ), # Check archive and metadata information on a specific deposit # -> GET url( r"^(?P[^/]+)/(?P[^/]+)/check/$", - SWHChecksDeposit.as_view(), + APIChecks.as_view(), name=PRIVATE_CHECK_DEPOSIT, ), # Retrieve deposit's raw archives' content # -> GET url( r"^(?P[^/]+)/raw/$", - SWHDepositReadArchives.as_view(), + APIReadArchives.as_view(), name=PRIVATE_GET_RAW_CONTENT + "-nc", ), # Update deposit's status # -> PUT url( r"^(?P[^/]+)/update/$", - SWHUpdateStatusDeposit.as_view(), + APIUpdateStatus.as_view(), name=PRIVATE_PUT_DEPOSIT + "-nc", ), # Retrieve metadata information on a specific deposit # -> GET url( r"^(?P[^/]+)/meta/$", - SWHDepositReadMetadata.as_view(), + APIReadMetadata.as_view(), name=PRIVATE_GET_DEPOSIT_METADATA + "-nc", ), # Check archive and metadata information on a specific deposit # -> GET url( r"^(?P[^/]+)/check/$", - SWHChecksDeposit.as_view(), + APIChecks.as_view(), name=PRIVATE_CHECK_DEPOSIT + "-nc", ), - url(r"^deposits/$", DepositList.as_view(), name=PRIVATE_LIST_DEPOSITS), + url(r"^deposits/$", APIList.as_view(), name=PRIVATE_LIST_DEPOSITS), ] diff --git a/swh/deposit/tests/api/conftest.py b/swh/deposit/tests/api/conftest.py --- a/swh/deposit/tests/api/conftest.py +++ b/swh/deposit/tests/api/conftest.py @@ -17,7 +17,7 @@ from swh.deposit.models import Deposit from swh.deposit.parsers import parse_xml -from swh.deposit.api.private.deposit_check import SWHChecksDeposit +from swh.deposit.api.private.deposit_check import APIChecks @pytest.fixture @@ -91,4 +91,4 @@ @pytest.fixture def swh_checks_deposit(): - return SWHChecksDeposit() + return APIChecks()