Modify/#114 modify tour api

.gitignore

@@ -15,4 +15,5 @@ db.sqlite3
 # 로그파일 무시
 *.log
 /logs
-nginx.conf
+nginx.conf
+*.sqlite3

config/asgi.py

@@ -27,4 +27,4 @@
 application = ProtocolTypeRouter({
     "http": get_asgi_application(),
     "websocket": AuthMiddlewareStack(URLRouter(websocket_urlpatterns)),
-})
+})

config/wsgi.py

@@ -13,4 +13,4 @@
 
 os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings')
 
-application = get_wsgi_application()
+application = get_wsgi_application()

services/exception_handler.py

@@ -184,7 +184,6 @@ def get_full_details(self):
         return self.error_message
 
 
-
 def custom_exception_handler(exc, context):
     """
         DRF의 커스텀 핸들러를 설정하며, detail만 메시지가 갔던 기존 방식에 비해서 status code와 같은 부가 정보를 추가해 보냅니다.

services/public_data_portal_http_client.py

@@ -0,0 +1,29 @@
+import requests
+
+class HttpRequestException(Exception):
+    def __init__(self, message):
+        self.message = message
+    def __str__(self):
+        return self.message
+
+
+class PublicDataPortalHttpClient:
+    """
+    해당 클래스는 공공 데이터 포탈과 직접 소통하는 http 클라이언트 입니다.
+    """
+    def __init__(self, service_key):
+        # 공공 데이터 포탈과 소통하기 위한 서비스 키입니다.
+        self.service_key = service_key
+
+    def get_tour_api_response(self, path: str, **kwargs):
+        """
+        해당 함수는 한국관광공사_국문 관광정보 서비스_GW api와 직접 소통하는 함수 입니다.
+        :param path: 요청을 보낼 path를 의미합니다.
+        :param kwargs: 서비스 키를 제외한 요청을 보낼 body를 의미하며 dictionary 형태를 받습니다.
+        """
+        base_url = 'http://apis.data.go.kr/B551011/KorService2'
+        kwargs['serviceKey'] = self.service_key
+        response = requests.get(base_url + path, params=kwargs)
+        if response.status_code == 200:
+            return response.json()
+        raise HttpRequestException(f'Public Data Portal API HTTP request failed with status code {response.status_code}')

services/tour_api_service.py

@@ -0,0 +1,107 @@
+from .tour_api_http_client import *
+from dataclasses import dataclass
+from .exception_handler import *
+from config.settings import PUBLIC_DATA_PORTAL_API_KEY
+
+@dataclass
+class Place:
+    """
+    장소 정보를 저장하는 데이터 클래스 입니다.
+    """
+    addr1: str = None # 상세주소
+    addr2: str = None # 지역코드
+    areacode: str = None # 대분류코드
+    cat1: str = None # 중분류코드
+    cat2: str = None # 소분류코드
+    cat3: str = None # 상세주소
+    contentid: str = None # 콘텐츠ID
+    contenttypeid: str = None # 관광타입(관광지, 숙박등) ID
+    created_time: str = None # 콘텐츠최초등록일
+    firstimage: str = None # 원본대표이미지
+    cpyrhtDivCd: str = None # Type1:제1유형(출처표시-권장) Type3:제3유형(제1유형 + 변경금지)
+    mapx: str = None # GPS X좌표(WGS84 경도좌표) 응답
+    mapy: str = None # GPS Y좌표(WGS84 경도좌표) 응답
+    mlevel: str = None # Map Level 응답
+    modifiedtime: str = None # 콘텐츠수정일
+    sigungucode: str = None # 시군구코드
+    tel: str = None # 전화번호
+    title: str = None # 콘텐츠제목
+    zipcode: str = None # 우편번호
+    lDongRegnCd: str = None # 법정동 시도 코드
+    lDongSignguCd: str = None # 법정동 시군구 코드
+    lclsSystm1: str = None # 분류체계 대분류
+    lclsSystm2: str = None # 분류체계 중분류
+    lclsSystm3: str = None # 분류체계 소분류
+
+
+class TourAPIService:
+    """
+    해당 클래스는 tour_api_http_client로 받은  raw 데이터 정보를 가공하여 데이터를 제공하는 역할을 합니다.
+    """
+    def __init__(self, service_key):
+        self.service_key = service_key
+        self.tour_api_http_client = TourAPIHTTPClient(service_key)
+
+    def get_area_based_list(self,
+                            arrange: Arrange = None,
+                            contentTypeId: ContentType = None,
+                            area_info: Area = None,
+                            category: Category = None,
+                            modifiedtime: str = None,
+                            ldong: lDong = None,
+                            lclsSystem: lclsSystem = None
+                            ) -> list[Place]:
+        """
+        해당 함수는 장소 정보를 리스트 형식으로 받아옵니다.
+        각 장소 정보가 담긴 Place 객체 리스트로 받아옵니다.
+        """
+        raw_data = self.tour_api_http_client.get_area_based_list(
+            arrange=arrange,
+            contentTypeId=contentTypeId,
+            area_info=area_info,
+            category=category,
+            modifiedtime=modifiedtime,
+            ldong=ldong,
+            lclsSystem=lclsSystem,
+        )
+        items = []
+        try:
+            items = raw_data['response']['body']['items']['item']
+        except KeyError:
+            raise HttpRequestException(
+                get_error_file(),
+                get_my_function(),
+                get_error_line(),
+                'tour api server exception',
+                f'raw data: {raw_data}'
+            )
+        # 올바르게 데이터가 넘어왔다고 가정.
+
+        places = []
+        for each in items:
+            # 각 each는 특정 장소 정보가 담긴 dictionary 형식입니다.
+            place = Place()
+            for key, value in each.items():
+                if hasattr(place, key):
+                    setattr(place, key, value) # 속성 저장
+            places.append(place)
+        return places
+
+    def get_sigungu_code_as_name(self, area_code: str, target_sigungu_name: str):
+        """
+        해당 함수는 전국 17개 시/도 안에 포함된 특정 지역 시군구 코드를 이름을 통해서 얻고자 할 때 사용합니다.
+        ex) 강남 -> 1, 아산 -> 12 (예시일 뿐이며 실제 데이터 값과 다를 수 있습니다.)
+        """
+        raw_data = self.tour_api_http_client.get_area_code(area_code=area_code)
+        items = raw_data['response']['body']['items']['item']
+        for item in items:
+            if target_sigungu_name in item['name']:
+                return item['code']
+        return None
+
+
+
+
+if __name__ == '__main__':
+    tour_api_service = TourAPIService(PUBLIC_DATA_PORTAL_API_KEY)
+    print(tour_api_service.get_sigungu_code_as_name('1', '강남'))

tour/consumers.py

@@ -13,60 +13,67 @@ async def connect(self):
         ##query_string##
           - user_id: string (required)
           - areaCode: string (required)
-          - sigunguName: string (required)
-          - contentTypeId: string (required)
+          - sigunguName: string (optional)
+          - categoryName: string (comma-separated, required)
+          - unique_code: string (optional)
         """
-        query_string = self.scope['query_string'].decode() # 쿼리 스트링을 불러들입니다.
-        params = urllib.parse.parse_qs(query_string) # 쿼리 스트링을 파라미터로 변환합니다.
-        self.user_id = params.pop('user_id', [None])[0] # user 고유 sub를 가져옵니다.
-        self.unique_code = params.pop('unique_code', [""])[0] # 웹소켓 통신을 위한 고유 번호를 가져옵니다.
-        days = params.pop('days', [None])[0] # 여행 기간을 의미합니다.
-        self.user_id = self.user_id + '_' + self.unique_code if self.unique_code != "" else self.user_id
+        query_string = self.scope['query_string'].decode()
+        params = urllib.parse.parse_qs(query_string)
+        self.user_id = params.pop('user_id', [None])[0]
+        self.unique_code = params.pop('unique_code', [""])[0]
+        self.user_id = self.user_id + '_' + self.unique_code if self.unique_code else self.user_id
 
         if self.user_id is None:
             await self.close()
             return
 
-        # 웹소켓 그룹에 가입
+        # 그룹 가입
         logger.info(f'channel_id: {self.user_id} 웹소켓 가입')
-        await self.channel_layer.group_add(self.user_id, self.channel_name) # user_id를 그룹 이름으로 하고 웹소켓에 가입합니다.
-        await self.accept() # 웹소켓 연결
+        await self.channel_layer.group_add(self.user_id, self.channel_name)
+        await self.accept()
 
-        # 요청을 celery task로 보냅니다.
-        areaCode = params.pop('areaCode', [None])[0] # area_code 가져옴
-        sigunguName = params.pop('sigunguName', [None])[0] # 시군구 이름 가져옴
-        if areaCode is None or days is None: # areaCode가 존재하지 않는다면
+        # 파라미터 파싱
+        areaCode = params.pop('areaCode', [None])[0]
+        sigunguName = params.pop('sigunguName', [None])[0]
+        categoryName = params.pop('categoryName', [None])[0]
+
+        if areaCode is None or categoryName is None:
             await self.send(text_data=json.dumps({
                 'state': 'ERROR',
                 'Message': '필수 파라미터 중 일부가 없습니다.'
             }, ensure_ascii=False))
             return
+
+        # 시군구 코드 파싱
         tour = TourApi(MobileOS=MobileOS.ANDROID, MobileApp='AlphaProject2025', service_key=PUBLIC_DATA_PORTAL_API_KEY)
-        sigunguCode = None
         sigunguCodes = None
-        if sigunguName is not None:
+        if sigunguName:
             sigunguNames = sigunguName.split(',')
             sigunguCodes = []
             for each in sigunguNames:
-                sigunguCode = tour.get_sigungu_code(areaCode, each) # 시군구 이름에 대응되는 코드를 가져옵니다.
-                if sigunguCode is None: # 시군구 코드가 없다면
+                sigunguCode = tour.get_sigungu_code(areaCode, each)
+                if sigunguCode is None:
                     await self.send(text_data=json.dumps({
                         'state': 'ERROR',
                         'Message': '해당 시군구 이름에 대응되는 코드를 가져올 수 없습니다. 시군구 이름을 다시 한번 확인 바랍니다.'
                     }, ensure_ascii=False))
                     return
                 sigunguCodes.append(sigunguCode)
 
-        task_result = app.send_task('tour.tasks.get_recommended_tour_based_area', args=[self.user_id, # 채널 레이어 그룹 특정을 위해 보냅니다.
-                                                                                        areaCode, days, Arrange.TITLE_IMAGE.value, sigunguCodes])
+        # categoryName → 리스트로 변환 후 task 호출
+        categoryNames = categoryName.split(',')
+        task_result = app.send_task(
+            'tour.tasks.get_recommended_place_by_category_task',
+            args=[self.user_id, areaCode, categoryNames, sigunguCodes, Arrange.TITLE_IMAGE.value, self.user_id]  # ← 추가됨
+        )
+
         await self.send(text_data=json.dumps({
             'state': 'OK',
             'Message': {
                 'task_id': task_result.task_id,
             }
         }))
 
-
     async def disconnect(self, close_code):
         await self.channel_layer.group_discard(self.user_id, self.channel_name)
 
@@ -76,44 +83,50 @@ async def task_update(self, event):
 
     async def receive(self, text_data=None, bytes_data=None):
         """
-        재시도를 위한 메시지 입니다.
+        재시도를 위한 메시지입니다.
         """
         data = json.loads(text_data)
         user_id = data.get("user_id", None)
         areaCode = data.get("areaCode", None)
         sigunguName = data.get("sigunguName", None)
-        unique_code = data.get('unique_code', "")  # 웹소켓 통신을 위한 고유 번호를 가져옵니다.
-        user_id = user_id + '_' + unique_code
-        days = data.get("days", None)
-        if user_id is None or areaCode is None or days is None:
-            # 데이터가 없다면 예외 처리
+        unique_code = data.get("unique_code", "")  # 웹소켓 통신을 위한 고유 번호를 가져옵니다.
+        categoryName = data.get("categoryName", None)
+        user_id = user_id + '_' + unique_code if unique_code else user_id
+
+        if user_id is None or areaCode is None or categoryName is None:
             await self.send(text_data=json.dumps({
                 'state': 'ERROR',
                 'Message': '필수 파라미터 중 일부가 없거나 잘못되었습니다.'
             }, ensure_ascii=False))
             return
 
+        # 시군구 코드 파싱
         tour = TourApi(MobileOS=MobileOS.ANDROID, MobileApp='AlphaProject2025', service_key=PUBLIC_DATA_PORTAL_API_KEY)
         sigunguCodes = None
-        if sigunguName is not None:
-            sigunguCodes = []
+        if sigunguName:
             sigunguNames = sigunguName.split(',')
+            sigunguCodes = []
             for each in sigunguNames:
-                sigunguCode = tour.get_sigungu_code(areaCode, each)  # 시군구 이름에 대응되는 코드를 가져옵니다.
-                if sigunguCode is None:  # 시군구 코드가 없다면
+                sigunguCode = tour.get_sigungu_code(areaCode, each)
+                if sigunguCode is None:
                     await self.send(text_data=json.dumps({
                         'state': 'ERROR',
                         'Message': '해당 시군구 이름에 대응되는 코드를 가져올 수 없습니다. 시군구 이름을 다시 한번 확인 바랍니다.'
                     }, ensure_ascii=False))
                     return
                 sigunguCodes.append(sigunguCode)
 
-        task_result = app.send_task('tour.tasks.get_recommended_tour_based_area',
-                                    args=[self.user_id,  # 채널 레이어 그룹 특정을 위해 보냅니다.
-                                          areaCode, Arrange.TITLE_IMAGE.value, sigunguCodes])
+        # 카테고리 파라미터를 리스트로 변환
+        categoryNames = categoryName.split(',')
+
+        task_result = app.send_task(
+            'tour.tasks.get_recommended_place_by_category_task',
+            args=[user_id, areaCode, categoryNames, sigunguCodes, Arrange.TITLE_IMAGE.value, user_id]  # ← 추가됨
+        )
+
         await self.send(text_data=json.dumps({
             'state': 'OK',
             'Message': {
                 'task_id': task_result.task_id,
             }
-        }))
+        }))

tour/models.py

@@ -72,3 +72,5 @@ class UserTourImages(models.Model):
     def __str__(self):
         return f"{self.tour.tour_name} - {self.tour.tour_date}"
 
+    def __str__(self):
+        return f"{self.tour.tour_name} - {self.tour.tour_date}"