Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: django-rest-framework #8053

Draft
wants to merge 28 commits into
base: feat/rpc-api
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
28 commits
Select commit Hold shift + click to select a range
5186823
chore: add django-rest-framework/drf-spectacular
jennifer-richards Oct 11, 2024
283cf2b
chore: set up drf and auth/authz
jennifer-richards Oct 11, 2024
b664548
chore: spectacular setup
jennifer-richards Oct 11, 2024
622958c
chore: add drf-standardized-errors
jennifer-richards Oct 12, 2024
b42219b
refactor: rpc_person -> PersonViewSet
jennifer-richards Oct 12, 2024
0ad57d0
refactor: rpc_subject_person -> SubjectPersonView
jennifer-richards Oct 12, 2024
3e4bf37
refactor: rpc_persons -> RpcPersonsView
jennifer-richards Oct 15, 2024
73e14e2
refactor: rpc_draft -> DraftViewSet
jennifer-richards Oct 15, 2024
7c2733a
refactor: drafts_by_names -> DraftsByNameView
jennifer-richards Oct 15, 2024
11f8cc1
refactor: submitted_to_rpc -> DraftViewSet
jennifer-richards Oct 15, 2024
14c3bfe
refactor: rfc_original_stream -> RfcViewSet
jennifer-richards Oct 15, 2024
6d49bb8
refactor: create_demo_person -> DemoViewSet
jennifer-richards Oct 15, 2024
82e2b24
refactor: create_demo_draft -> DemoViewSet
jennifer-richards Oct 16, 2024
e327111
fix: instantiate AnonymousUser class
jennifer-richards Oct 16, 2024
29e0cfa
refactor: move RpcPersonView into PersonViewSet
jennifer-richards Oct 16, 2024
88c0917
fix: adjust URLs
jennifer-richards Oct 16, 2024
99e8fb0
chore: remove unused imports
jennifer-richards Oct 16, 2024
efa2d3d
style: Black
jennifer-richards Oct 16, 2024
9eb8cbe
chore: Remove unused code
jennifer-richards Oct 16, 2024
b002c19
refactor: use serializer for parsing
jennifer-richards Oct 16, 2024
c50977f
chore: drf-standardized-errors settings
jennifer-richards Oct 16, 2024
dd7f9fd
chore: adjust drf-spectacular settings
jennifer-richards Oct 16, 2024
28b1e04
chore: generated API schema for comparison
jennifer-richards Oct 16, 2024
8600744
refactor: serializers_rpc module
jennifer-richards Oct 16, 2024
2a0182f
style: unnecessary parentheses
jennifer-richards Oct 16, 2024
1f6f549
fix: bad subject ID is really a 404
jennifer-richards Oct 16, 2024
3eaffa6
chore: fix comment
jennifer-richards Oct 16, 2024
ac4c006
Merge branch 'feat/rpc-api' into rpc-api-drf
jennifer-richards Oct 30, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
refactor: create_demo_draft -> DemoViewSet
  • Loading branch information
jennifer-richards committed Oct 16, 2024
commit 82e2b2451f66f0cce44c40d5fb666b8d1491b9f7
1 change: 0 additions & 1 deletion ietf/api/urls_rpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,6 @@
router.register(r"rfc", views_rpc.RfcViewSet, basename="rfc")

urlpatterns = [
url(r"^doc/create_demo_draft/$", views_rpc.create_demo_draft),
url(r"^doc/drafts_by_names/", views_rpc.DraftsByNamesView.as_view()),
url(r"^persons/$", views_rpc.RpcPersonsView.as_view()),
path(r"subject/<str:subject_id>/person/", views_rpc.SubjectPersonView.as_view()),
Expand Down
84 changes: 49 additions & 35 deletions ietf/api/views_rpc.py
Original file line number Diff line number Diff line change
Expand Up @@ -309,14 +309,36 @@ class Meta:
fields = ["user_id", "person_pk"]


class DemoDraftCreateSerializer(serializers.Serializer):
name = serializers.CharField(max_length=255, required=True)
stream_id = serializers.CharField(default="ietf")
rev = serializers.CharField(default=None)
states = serializers.DictField(child=serializers.CharField(), default=None)


class DemoDraftSerializer(serializers.ModelSerializer):
doc_id = serializers.IntegerField(source="pk")

class Meta:
model = Document
fields = ["doc_id", "name"]

@extend_schema_view(
create_demo_person=extend_schema(
operation_id="create_demo_person",
summary="Build a datatracker Person for RPC demo purposes",
description="returns a datatracker User id for a person created with the given name",
request=DemoPersonCreateSerializer,
responses=DemoPersonSerializer,
)
),
create_demo_draft=extend_schema(
operation_id="create_demo_draft",
summary="Build a datatracker WG draft for RPC demo purposes",
description="returns a datatracker document id for a draft created with the provided name and states. "
"The arguments, if present, are passed directly to the WgDraftFactory",
request=DemoDraftCreateSerializer,
responses=DemoDraftSerializer,
),
)
class DemoViewSet(viewsets.ViewSet):
"""SHOULD NOT MAKE IT INTO PRODUCTION"""
Expand All @@ -330,37 +352,29 @@ def create_demo_person(self, request):
person = Person.objects.filter(name=name).first() or PersonFactory(name=name)
return DemoPersonSerializer(person).data


@csrf_exempt
@requires_api_token("ietf.api.views_rpc")
def create_demo_draft(request):
"""Helper for creating rpc demo objects - SHOULD NOT MAKE IT INTO PRODUCTION"""
if request.method != "POST":
return HttpResponseNotAllowed(["POST"])

request_params = json.loads(request.body)
name = request_params.get("name")
rev = request_params.get("rev")
states = request_params.get("states")
stream_id = request_params.get("stream_id", "ietf")
doc = None
if not name:
return HttpResponse(status=400, content="Name is required")
doc = Document.objects.filter(name=name).first()
if not doc:
kwargs = {"name": name, "stream_id": stream_id}
if states:
kwargs["states"] = states
if rev:
kwargs["rev"] = rev
doc = WgDraftFactory(
**kwargs
) # Yes, things may be a little strange if the stream isn't IETF, but until we nned something different...
event_type = "iesg_approved" if stream_id == "ietf" else "requested_publication"
if not doc.docevent_set.filter(
type=event_type
).exists(): # Not using get_or_create here on purpose - these are wobbly facades we're creating
doc.docevent_set.create(
type=event_type, by_id=1, desc="Sent off to the RPC"
)
return JsonResponse({"doc_id": doc.pk, "name": doc.name})
@action(detail=False, methods=["post"])
def create_demo_draft(self, request):
"""Helper for creating rpc demo objects - SHOULD NOT MAKE IT INTO PRODUCTION"""
request_params = DemoDraftCreateSerializer(request.data)
name = request_params.data["name"]
rev = request_params.data["rev"]
stream_id = request_params.data["stream_id"]
states = request_params.data["states"]
doc = Document.objects.filter(name=name).first()
if not doc:
kwargs = {"name": name, "stream_id": stream_id}
if states:
kwargs["states"] = states
if rev:
kwargs["rev"] = rev
doc = WgDraftFactory(
**kwargs
) # Yes, things may be a little strange if the stream isn't IETF, but until we need something different...
event_type = "iesg_approved" if stream_id == "ietf" else "requested_publication"
if not doc.docevent_set.filter(
type=event_type
).exists(): # Not using get_or_create here on purpose - these are wobbly facades we're creating
doc.docevent_set.create(
type=event_type, by_id=1, desc="Sent off to the RPC"
)
return Response(DemoDraftSerializer(doc).data)