Skip to content

Commit 84ff28a

Browse files
futa-ikedajadeddeltaadlius
authored
[ENG-8975] Feature/redirect service support (#335)
* initial implementation of redirect service * fix some issues so that API returns external redirect service * register redirect service as an AddonImp * Appease pre-commit linters * Update DummyRedirectImp * Allow selection of Addon Implementation in admin app * Add Datapipe logo * CR feedback --------- Co-authored-by: jade <101148768+jadeddelta@users.noreply.github.com> Co-authored-by: Yuhuai Liu <yuhuai@cos.io>
1 parent 7e7ea25 commit 84ff28a

14 files changed

Lines changed: 176 additions & 0 deletions

File tree

‎addon_imps/redirect/__init__.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
"""addon_imps.redirect: imps that implement a redirect-like interface
2+
"""
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
from addon_toolkit.interfaces._base import BaseAddonInterface
2+
from addon_toolkit.interfaces.redirect import RedirectAddonImp
3+
4+
5+
class DummyRedirectImp(RedirectAddonImp):
6+
"""this is a dummy AddonImp for ALL redirect services.
7+
redirect links will be specified in django admin configuration."""
8+
9+
ADDON_INTERFACE = BaseAddonInterface

‎addon_service/admin/__init__.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -93,6 +93,22 @@ class ExternalComputingServiceAdmin(GravyvaletModelAdmin):
9393
}
9494

9595

96+
@admin.register(models.ExternalRedirectService)
97+
class ExternalRedirectServiceAdmin(GravyvaletModelAdmin):
98+
list_display = ("display_name", "created", "modified")
99+
readonly_fields = (
100+
"id",
101+
"created",
102+
"modified",
103+
)
104+
raw_id_fields = ("oauth2_client_config", "oauth1_client_config")
105+
enum_choice_fields = {
106+
"int_addon_imp": known_imps.RedirectAddonImpNumbers,
107+
"int_credentials_format": CredentialsFormats,
108+
"int_service_type": ServiceTypes,
109+
}
110+
111+
96112
@admin.register(models.OAuth2ClientConfig)
97113
@linked_many_field("external_storage_services")
98114
@linked_many_field("external_citation_services")

‎addon_service/common/known_imps.py‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@
1111
)
1212
from addon_imps.computing import boa
1313
from addon_imps.link import dataverse as link_dataverse
14+
from addon_imps.redirect import redirect_dummy
1415
from addon_imps.storage import (
1516
azure_blob_storage,
1617
bitbucket,
@@ -30,6 +31,7 @@
3031
from addon_toolkit.interfaces.citation import CitationAddonImp
3132
from addon_toolkit.interfaces.computing import ComputingAddonImp
3233
from addon_toolkit.interfaces.link import LinkAddonImp
34+
from addon_toolkit.interfaces.redirect import RedirectAddonImp
3335
from addon_toolkit.interfaces.storage import StorageAddonImp
3436

3537

@@ -102,6 +104,9 @@ class KnownAddonImps(enum.Enum):
102104
# Type: Link
103105
LINK_DATAVERSE = link_dataverse.DataverseLinkImp
104106

107+
# Type: Redirect
108+
REDIRECT_DUMMY = redirect_dummy.DummyRedirectImp
109+
105110
if __debug__:
106111
BLARG = my_blarg.MyBlargStorage
107112

@@ -140,6 +145,9 @@ class AddonImpNumbers(enum.Enum):
140145
# Type: Link
141146
LINK_DATAVERSE = 1030
142147

148+
# Type: Redirect
149+
REDIRECT_DUMMY = 1040
150+
143151
if __debug__:
144152
BLARG = -7
145153

@@ -158,3 +166,4 @@ def filter_addons_by_type(addon_type):
158166
CitationAddonImpNumbers = filter_addons_by_type(CitationAddonImp)
159167
ComputingAddonImpNumbers = filter_addons_by_type(ComputingAddonImp)
160168
LinkAddonImpNumbers = filter_addons_by_type(LinkAddonImp)
169+
RedirectAddonImpNumbers = filter_addons_by_type(RedirectAddonImp)
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
"""addon_service.external_service.redirect: imps that implement a redirect service
2+
"""
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
from django.db import models
2+
3+
from addon_service.external_service.models import ExternalService
4+
5+
6+
class ExternalRedirectService(ExternalService):
7+
redirect_url = models.URLField(blank=True, default="")
8+
9+
class Meta:
10+
verbose_name = "External Redirect Service"
11+
verbose_name_plural = "External Redirect Services"
12+
app_label = "addon_service"
13+
14+
class JSONAPIMeta:
15+
resource_name = "external-redirect-services"
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
from rest_framework_json_api import serializers
2+
from rest_framework_json_api.utils import get_resource_type_from_model
3+
4+
from addon_service.addon_imp.models import AddonImpModel
5+
from addon_service.common import view_names
6+
from addon_service.common.serializer_fields import DataclassRelatedDataField
7+
from addon_service.external_service.serializers import ExternalServiceSerializer
8+
9+
from .models import ExternalRedirectService
10+
11+
12+
RESOURCE_TYPE = get_resource_type_from_model(ExternalRedirectService)
13+
14+
15+
class ExternalRedirectServiceSerializer(ExternalServiceSerializer):
16+
"""api serializer for the `ExternalRedirectService` model"""
17+
18+
url = serializers.HyperlinkedIdentityField(
19+
view_name=view_names.detail_view(RESOURCE_TYPE)
20+
)
21+
22+
addon_imp = DataclassRelatedDataField(
23+
dataclass_model=AddonImpModel,
24+
related_link_view_name=view_names.related_view(RESOURCE_TYPE),
25+
)
26+
27+
redirect_url = serializers.CharField(
28+
read_only=True,
29+
)
30+
31+
class Meta:
32+
model = ExternalRedirectService
33+
fields = [
34+
"id",
35+
"addon_imp",
36+
"auth_uri",
37+
"credentials_format",
38+
"display_name",
39+
"url",
40+
"wb_key",
41+
"external_service_name",
42+
"configurable_api_root",
43+
"icon_url",
44+
"api_base_url_options",
45+
"redirect_url",
46+
]
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
from drf_spectacular.utils import (
2+
extend_schema,
3+
extend_schema_view,
4+
)
5+
from rest_framework_json_api.views import ReadOnlyModelViewSet
6+
7+
from .models import ExternalRedirectService
8+
from .serializers import ExternalRedirectServiceSerializer
9+
10+
11+
@extend_schema_view(
12+
list=extend_schema(
13+
description="Get the list of all available external redirect services"
14+
),
15+
get=extend_schema(
16+
description="Get particular external redirect service",
17+
),
18+
)
19+
class ExternalRedirectServiceViewSet(ReadOnlyModelViewSet):
20+
queryset = ExternalRedirectService.objects.all()
21+
serializer_class = ExternalRedirectServiceSerializer
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Generated by Django 4.2.20 on 2025-09-11 18:14
2+
3+
import django.db.models.deletion
4+
from django.db import (
5+
migrations,
6+
models,
7+
)
8+
9+
10+
class Migration(migrations.Migration):
11+
12+
dependencies = [
13+
("addon_service", "0016_externallinkservice_int_supported_features_and_more"),
14+
]
15+
16+
operations = [
17+
migrations.CreateModel(
18+
name="ExternalRedirectService",
19+
fields=[
20+
(
21+
"externalservice_ptr",
22+
models.OneToOneField(
23+
auto_created=True,
24+
on_delete=django.db.models.deletion.CASCADE,
25+
parent_link=True,
26+
primary_key=True,
27+
serialize=False,
28+
to="addon_service.externalservice",
29+
),
30+
),
31+
("redirect_url", models.URLField(blank=True, default="")),
32+
],
33+
options={
34+
"verbose_name": "External Redirect Service",
35+
"verbose_name_plural": "External Redirect Services",
36+
},
37+
bases=("addon_service.externalservice",),
38+
),
39+
]

‎addon_service/models.py‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
from addon_service.external_service.citation.models import ExternalCitationService
1616
from addon_service.external_service.computing.models import ExternalComputingService
1717
from addon_service.external_service.link.models import ExternalLinkService
18+
from addon_service.external_service.redirect.models import ExternalRedirectService
1819
from addon_service.external_service.storage.models import ExternalStorageService
1920
from addon_service.oauth1.models import OAuth1ClientConfig
2021
from addon_service.oauth2.models import (
@@ -47,4 +48,5 @@
4748
"ExternalLinkService",
4849
"AuthorizedLinkAccount",
4950
"ConfiguredLinkAddon",
51+
"ExternalRedirectService",
5052
)

0 commit comments

Comments
 (0)