Skip to content

Commit 721ec06

Browse files
PalbahngmiyinePalbahngmiyine
committed
웹훅 엔드포인트 추가 및 Django 예제 업데이트
- 그룹 리포트와 단일 리포트 웹훅 컨트롤러 추가 - Django URL 패턴 수정: 새로운 웹훅 경로 추가 - pyproject.toml 및 uv.lock 파일 수정: 의존성 및 작업 공간 설정 업데이트 - 모델 및 응답 형식 개선: Pydantic 모델에 선택적 필드 추가
1 parent 67d9f58 commit 721ec06

12 files changed

Lines changed: 185 additions & 335 deletions

File tree

examples/webhook/django_example/django_example/app/example_controller.py renamed to examples/webhook/django_example/django_example/app/group_report_controller.py

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,13 @@
55
from django.views import View
66
from django.views.decorators.csrf import csrf_exempt
77

8-
from solapi.model.response.send_message_response import SendMessageResponse
8+
from solapi.model.webhook.group_report import GroupReportPayload
99

1010

1111
@method_decorator(csrf_exempt, name="dispatch")
12-
class WebhookController(View):
12+
class GroupReportWebhookController(View):
1313
"""
14-
POST 로만 받는 웹훅 엔드포인트
14+
POST 로만 받는 그룹 리포트(Group Report) 웹훅 엔드포인트
1515
CSRF 예외 처리(@csrf_exempt) 를 걸어야 외부에서 POST 요청이 들어올 때 403 에러가 나지 않습니다.
1616
"""
1717

@@ -23,9 +23,19 @@ def post(self, request, *args, **kwargs):
2323
except json.JSONDecodeError:
2424
return JsonResponse({"error": "invalid JSON"}, status=400)
2525

26-
message_response = SendMessageResponse.model_validate(payload)
26+
message_response = GroupReportPayload.model_validate(payload)
27+
group_report = message_response.root[0]
2728

28-
return JsonResponse(message_response.model_dump_json(), status=200)
29+
# 이후 필요한 프로그래밍 처리.. 아래 방식처럼 데이터를 추출해서 사용할 수 있습니다.
30+
print(group_report.data.group_id)
31+
32+
# 혹은..
33+
print(group_report.data.date_created)
34+
35+
# 또는..
36+
print(group_report.data.log)
37+
38+
return JsonResponse(group_report.model_dump(), status=200)
2939

3040
def options(self, request, *args, **kwargs):
3141
response = JsonResponse({"status": "options OK"})

‎examples/webhook/django_example/django_example/app/single_report_controller.py‎

Lines changed: 48 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
import json
2+
3+
from django.http import HttpResponseNotAllowed, JsonResponse
4+
from django.utils.decorators import method_decorator
5+
from django.views import View
6+
from django.views.decorators.csrf import csrf_exempt
7+
8+
from solapi.model.webhook.single_report import SingleReportPayload
9+
10+
11+
@method_decorator(csrf_exempt, name="dispatch")
12+
class SingleReportWebhookController(View):
13+
"""
14+
POST 로만 받는 메시지 리포트(Single Report) 웹훅 엔드포인트
15+
CSRF 예외 처리(@csrf_exempt) 를 걸어야 외부에서 POST 요청이 들어올 때 403 에러가 나지 않습니다.
16+
"""
17+
18+
http_method_names = ["post", "options"]
19+
20+
def post(self, request, *args, **kwargs):
21+
try:
22+
payload = json.loads(request.body.decode("utf-8"))
23+
except json.JSONDecodeError:
24+
return JsonResponse({"error": "invalid JSON"}, status=400)
25+
26+
message_response = SingleReportPayload.model_validate(payload)
27+
single_report = message_response.root[0]
28+
29+
# 이후 필요한 프로그래밍 처리.. 아래 방식처럼 데이터를 추출해서 사용할 수 있습니다.
30+
print(single_report.data.kakao_options.pf_id)
31+
32+
# 혹은..
33+
print(single_report.data.message_id)
34+
35+
# 또는..
36+
print(single_report.data.naver_options)
37+
38+
return JsonResponse(single_report.model_dump(), status=200)
39+
40+
def options(self, request, *args, **kwargs):
41+
response = JsonResponse({"status": "options OK"})
42+
response["Access-Control-Allow-Origin"] = "*"
43+
response["Access-Control-Allow-Methods"] = "POST, OPTIONS"
44+
response["Access-Control-Allow-Headers"] = "Content-Type"
45+
return response
46+
47+
def http_method_not_allowed(self, request, *args, **kwargs):
48+
return HttpResponseNotAllowed(["POST", "OPTIONS"])

‎examples/webhook/django_example/django_example/urls.py‎

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,15 @@
1818
from django.contrib import admin
1919
from django.urls import path
2020

21-
from .app.example_controller import (
22-
WebhookController,
21+
from .app.group_report_controller import (
22+
GroupReportWebhookController,
23+
)
24+
from .app.single_report_controller import (
25+
SingleReportWebhookController,
2326
)
2427

2528
urlpatterns = [
2629
path("admin/", admin.site.urls),
27-
path("webhook", WebhookController.as_view(), name="webhook"),
30+
path("webhook/single-report", SingleReportWebhookController.as_view()),
31+
path("webhook/group-report", GroupReportWebhookController.as_view()),
2832
]

‎examples/webhook/django_example/pyproject.toml‎

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,17 @@
11
[project]
22
name = "django_example"
33
version = "0.1.0"
4-
description = "Add your description here"
4+
description = "Django example for SOLAPI webhook"
55
readme = "README.md"
66
requires-python = ">=3.9"
77
dependencies = [
8-
"django>=4.2.21",
9-
"solapi>=5.0.0",
8+
"django>=4.2.0",
9+
"solapi"
1010
]
11+
12+
[build-system]
13+
requires = ["hatchling"]
14+
build-backend = "hatchling.build"
15+
16+
[tool.hatch.metadata]
17+
allow-direct-references = true

‎examples/webhook/django_example/uv.lock‎

Lines changed: 1 addition & 251 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pyproject.toml‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,3 +42,9 @@ build-backend = "hatchling.build"
4242

4343
[tool.hatch.build]
4444
packages = ["solapi"]
45+
46+
[tool.uv.workspace]
47+
members = ["examples/webhook/django_example"]
48+
49+
[tool.uv.sources]
50+
solapi = { workspace = true }

‎solapi/model/naver/naver_button.py‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
from typing import Optional
2+
3+
from pydantic import BaseModel, ConfigDict
4+
from pydantic.alias_generators import to_camel
5+
6+
7+
class NaverButton(BaseModel):
8+
button_name: Optional[str] = None
9+
button_type: Optional[str] = None
10+
link_mo: Optional[str] = None
11+
link_pc: Optional[str] = None
12+
link_and: Optional[str] = None
13+
link_ios: Optional[str] = None
14+
15+
model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)

‎solapi/model/naver/naver_option.py‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
from typing import Optional
2+
3+
from pydantic import BaseModel, ConfigDict
4+
from pydantic.alias_generators import to_camel
5+
6+
from solapi.model.naver.naver_button import NaverButton
7+
8+
9+
class NaverOption(BaseModel):
10+
talk_id: Optional[str] = None
11+
template_id: Optional[str] = None
12+
disable_sms: Optional[bool] = None
13+
variables: Optional[dict[str, str]] = None
14+
buttons: Optional[list[NaverButton]] = None
15+
16+
model_config = ConfigDict(populate_by_name=True, alias_generator=to_camel)

‎solapi/model/response/common_response.py‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -30,47 +30,47 @@ class CommonCashResponse(BaseModel):
3030

3131

3232
class CommonPriceTypeResponse(BaseModel):
33-
sms: dict[str, float]
34-
lms: dict[str, float]
35-
mms: dict[str, float]
36-
ata: dict[str, float]
37-
cta: dict[str, float]
38-
cti: dict[str, float]
39-
nsa: dict[str, float]
40-
rcs_sms: dict[str, float]
41-
rcs_lms: dict[str, float]
42-
rcs_mms: dict[str, float]
43-
rcs_tpl: dict[str, float]
44-
rcs_itpl: dict[str, float]
45-
rcs_ltpl: dict[str, float]
46-
fax: dict[str, float]
47-
voice: dict[str, float]
33+
sms: Optional[dict[str, float]] = None
34+
lms: Optional[dict[str, float]] = None
35+
mms: Optional[dict[str, float]] = None
36+
ata: Optional[dict[str, float]] = None
37+
cta: Optional[dict[str, float]] = None
38+
cti: Optional[dict[str, float]] = None
39+
nsa: Optional[dict[str, float]] = None
40+
rcs_sms: Optional[dict[str, float]] = None
41+
rcs_lms: Optional[dict[str, float]] = None
42+
rcs_mms: Optional[dict[str, float]] = None
43+
rcs_tpl: Optional[dict[str, float]] = None
44+
rcs_itpl: Optional[dict[str, float]] = None
45+
rcs_ltpl: Optional[dict[str, float]] = None
46+
fax: Optional[dict[str, float]] = None
47+
voice: Optional[dict[str, float]] = None
4848

4949
model_config = ConfigDict(extra="ignore")
5050

5151

5252
class EachTypePriceResponse(BaseModel):
53-
sms: float
54-
lms: float
55-
mms: float
56-
ata: float
57-
cta: float
58-
cti: float
59-
nsa: float
60-
rcs_sms: float
61-
rcs_lms: float
62-
rcs_mms: float
63-
rcs_tpl: float
64-
rcs_itpl: float
65-
rcs_ltpl: float
66-
fax: float
67-
voice: float
53+
sms: Optional[float] = None
54+
lms: Optional[float] = None
55+
mms: Optional[float] = None
56+
ata: Optional[float] = None
57+
cta: Optional[float] = None
58+
cti: Optional[float] = None
59+
nsa: Optional[float] = None
60+
rcs_sms: Optional[float] = None
61+
rcs_lms: Optional[float] = None
62+
rcs_mms: Optional[float] = None
63+
rcs_tpl: Optional[float] = None
64+
rcs_itpl: Optional[float] = None
65+
rcs_ltpl: Optional[float] = None
66+
fax: Optional[float] = None
67+
voice: Optional[float] = None
6868

6969
model_config = ConfigDict(extra="ignore")
7070

7171

7272
class AppResponse(BaseModel):
73-
profit: EachTypePriceResponse
73+
profit: Optional[EachTypePriceResponse] = None
7474
app_id: Optional[str] = None
7575

7676
model_config = ConfigDict(

‎solapi/model/webhook/group_report.py‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
from typing import Optional
2+
3+
from pydantic import BaseModel, ConfigDict, RootModel
4+
from pydantic.alias_generators import to_camel
5+
6+
from solapi.model.response.common_response import GroupMessageResponse
7+
8+
9+
class GroupReport(BaseModel):
10+
event_data_id: Optional[str] = None
11+
data: Optional[GroupMessageResponse] = None
12+
retry_count: Optional[int] = None
13+
14+
model_config = ConfigDict(
15+
populate_by_name=True, alias_generator=to_camel, extra="ignore"
16+
)
17+
18+
19+
class GroupReportPayload(RootModel[list[GroupReport]]):
20+
pass

0 commit comments

Comments
 (0)