feature/deploy2 또다른 deploy 방법

.gitignore

@@ -158,11 +158,10 @@ cython_debug/
 #  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
-#.idea/
+.idea/
 
 ### Flask template
 instance/*
 !instance/.gitignore
-.webassets-cache
-.env
 
+.aws-sam/

main.py

@@ -0,0 +1,5 @@
+"""테스트 서버를 실행시키기 위한 파일입니다."""
+import uvicorn
+
+if __name__ == "__main__":
+    uvicorn.run("sandol.app:app", host="0.0.0.0", port=5600, reload=True)

requirements.txt

@@ -1,23 +1,7 @@
-beautifulsoup4==4.12.3
-blinker==1.7.0
-bs4==0.0.2
-certifi==2024.2.2
-charset-normalizer==3.3.2
-click==8.1.7
-exceptiongroup==1.2.0
-Flask==3.0.2
-idna==3.6
-importlib_metadata==7.1.0
-iniconfig==2.0.0
-itsdangerous==2.1.2
-Jinja2==3.1.3
-MarkupSafe==2.1.5
-packaging==24.0
-pluggy==1.4.0
-pytest==8.1.1
-requests==2.31.0
-soupsieve==2.5
-tomli==2.0.1
-urllib3==2.2.1
-Werkzeug==3.0.1
-zipp==3.18.1
+fastapi
+pandas
+requests
+openpyxl
+mangum
+annotated-types
+boto3

samconfig.toml

@@ -0,0 +1,8 @@
+version = 0.1
+[default.deploy.parameters]
+stack_name = "sandol-sam"
+resolve_s3 = true
+s3_prefix = "sandol-sam"
+region = "ap-northeast-2"
+capabilities = "CAPABILITY_IAM"
+image_repositories = []

sandol/api_server/__init__.py

@@ -0,0 +1,10 @@
+"""API 서버를 구성하는 모듈들
+
+API 서버를 구성하는 모듈들이 정의되어 있습니다.
+settings.py에는 환경 변수가 설정되어 있습니다.
+utils.py에는 API 서버에서 사용하는 유틸리티 함수들이 정의되어 있습니다.
+이외의 모듈은 각각의 API 엔드포인트를 정의하고 있습니다.
+"""
+from .meal import meal_api
+
+__all__ = ["meal_api"]

sandol/api_server/kakao/__init__.py

@@ -0,0 +1,23 @@
+"""카카오톡 챗봇을 개발하기 위한 라이브러리입니다.
+
+Packages:
+    response: 카카오톡 응답 규칙에 맞는 응답 객체들을 정의합니다.
+
+Modules:
+    base: 라이브러리의 기본 부모 클래스(BaseModel)와 스킬 템플릿(SkillTemplate)을 정의합니다.
+    context: 컨텍스트 정보를 담는 클래스를 정의합니다.
+    customerror: 사용자 정의 예외를 정의합니다.
+    input: 스킬 실행시 봇 시스템이 스킬 서버에게 전달하는 정보를 객체화한 Payload 객체들을 정의합니다.
+    utils: 라이브러리에서 사용하는 유틸리티 함수들을 정의합니다.
+    validation: 라이브러리에서 사용하는 유효성 검사 함수들을 정의합니다.
+"""
+from .base import BaseModel
+from . import response
+from .customerror import InvalidLinkError, InvalidTypeError, InvalidActionError
+from .input import Payload, ValidationPayload
+
+__all__ = [
+    "response",
+    "InvalidActionError", "InvalidLinkError", "InvalidTypeError",
+    "Payload", "ValidationPayload"
+]

sandol/api_server/kakao/base.py

@@ -0,0 +1,130 @@
+"""카카오 라이브러리의 대부분의 클래스의 부모 클래스를 정의합니다.
+
+classes:
+    BaseModel: 카카오 라이브러리의 대부분의 클래스의 부모 클래스
+    ParentPayload: Payload 객체의 부모 클래스
+    SkillTemplate: 카카오톡 스킬 응답중 SkilllTemplate을 객체로 생성하는 추상 클래스
+"""
+from abc import ABC, ABCMeta, abstractmethod
+import json
+
+
+class BaseModel(ABC, metaclass=ABCMeta):
+    """카카오 라이브러리의 대부분의 클래스의 부모 클래스
+
+    카카오 라이브러리의 대부분의 클래스는 이 클래스를 상속받아 구현됩니다.
+    remove_none_item 메서드를 통해 None이 아닌 값만을 가진 dict를 생성할 수 있습니다.
+    render 메서드를 통해 객체를 카카오톡 응답 형식에 알맞게 dict로 변환하도록 구현해야 합니다.
+    validate 메서드를 통해 카카오톡 응답 규칙에 맞는지 검증하도록 구현해야 합니다.
+    """
+    @staticmethod
+    def remove_none_item(base: dict) -> dict:
+        """key-value 쌍 item을 base에서 제거합니다.
+
+        카카오톡 서버로 반환 시 None인 값을 제외하고 반환하기 위해 사용합니다.
+
+        Args:
+            base (dict): None인 값을 제거할 딕셔너리
+
+        Returns:
+            dict: None인 값을 제거한 딕셔너리
+        """
+        out = {}
+        for key, value in base.items():
+            if value is not None:
+                out[key] = value
+        return out
+
+    @abstractmethod
+    def render(self) -> dict | list:
+        """객체를 카카오톡 응답 형식에 알맞게 dict로 변환합니다.
+
+        변환된 dict는 각 객체가 타깃으로 하는
+        카카오톡 응답 형식의 상세 필드를 key로 가집니다.
+        TextCard 객체의 경우 다음과 같은 형식으로 변환됩니다:
+        {
+            'title': '제목',
+            'description': '설명',
+            'buttons': [
+                {
+                    'action': 'webLink',
+                    'label': '링크',
+                    'webLinkUrl': 'https://www.example.com',
+                },
+            ],
+        }
+
+        Returns:
+            dict
+        """
+
+    @abstractmethod
+    def validate(self):
+        """카카오톡 응답 규칙에 알맞은지 객체를 검증합니다.
+
+        응답 규칙에 맞지 않을 경우 예외를 발생시키도록 구현해야 합니다.
+        """
+
+
+class ParentPayload(ABC, metaclass=ABCMeta):
+    """Payload 객체의 부모 클래스
+
+    Payload 객체들의 부모 클래스로, from_json과 from_dict 메서드를 가지고 있습니다.
+    Payload 객체들은 스킬 실행시 봇 시스템이 스킬 서버에게 전달하는 정보를 객체화한 것입니다.
+    이 객체를 상속받는 클래스 중 Payload와 Context를 제외한 클래스들은 단독으로 사용되지 않습니다.
+
+    from_dict 메서드를 통해 딕셔너리를 객체로 변환할 수 있도록 구현해야 합니다.
+    from_json 메서드를 통해 JSON 문자열을 객체로 변환할 수 있도록 구현해야 합니다.
+    """
+    @classmethod
+    @abstractmethod
+    def from_dict(cls, data: dict):
+        """딕셔너리를 객체로 변환하는 메서드
+
+        딕셔너리를 받아서 객체로 변환하는 메서드입니다.
+
+        Args:
+            data (dict): 딕셔너리
+        """
+
+    @classmethod
+    def from_json(cls, data: str):
+        """JSON 문자열을 객체로 변환하는 메서드
+
+        from_dict 메서드를 호출하여 JSON 문자열을 객체로 변환합니다.
+
+        Args:
+            data (str): JSON 문자열
+        """
+        return cls.from_dict(json.loads(data))
+
+
+class SkillTemplate(BaseModel, metaclass=ABCMeta):
+    """카카오톡 SkillTemplate 출력요소를 객체로 생성하는 추상 클래스
+
+    BaseModel을 상속받아 구현되며, render와 validate 메서드를 구현해야 합니다.
+
+    is_empty 프로퍼티를 통해 응답 객체가 비어있는지 여부를 확인할 수 있습니다.
+    render() 메서드를 호출하여 생성된 응답 객체가 비어있는지 확인합니다.
+
+    Raises:
+        NotImplementedError: render 또는 validate 메서드가 구현되지 않았을 때
+
+    Examples:
+        >>> class TextCard(ParentComponent):
+        ...     name = "textCard"   # 응답 객체의 템플릿 이름
+        >>> print(TextCard.name)
+        ... "textCard"
+    """
+
+    @property
+    def is_empty(self) -> bool:
+        """응답 객체가 비어있는지 여부를 반환합니다.
+
+        self.render() 메서드를 호출하여 응답 객체를 생성한 후,
+        응답 객체가 비어있는지 여부를 반환합니다.
+
+        Returns:
+            bool: 응답 객체가 비어있으면 True, 아니면 False
+        """
+        return not bool(self.render())

sandol/api_server/kakao/context.py

@@ -0,0 +1,125 @@
+"""컨텍스트 정보를 담는 클래스를 정의하는 모듈입니다.
+
+컨텍스틑 정보는 Payload 및 Response에서 동일한 형태의 데이터로 사용되기 떄문에,
+이를 통일된 형태로 관리하기 위해 별도의 모듈 및 클래스로 정의합니다.
+"""
+
+from typing import Optional
+from .base import ParentPayload, SkillTemplate
+from .validation import validate_int, validate_str, validate_type
+
+
+class Context(ParentPayload, SkillTemplate):
+    """컨텍스트 정보를 담는 클래스입니다.
+
+    컨텍스트 정보는 봇과 사용자간의 문맥적 상황 공유를 위해 사용됩니다.
+    컨텍스트 정보는 이름, 남은 횟수, 유지 시간, 추가 정보를 가집니다.
+    챗봇 관리자센터에서 컨텍스트를 설정하지 않으면 이 정보는 무시됩니다.
+
+    이 클래스는 Payload와 Response에서 사용될 수 있도록 공통된 형태로 정의됩니다.
+    따라서 from_dict와 render 메서드를 함께 제공합니다.
+
+    Attributes:
+        name (str): 컨텍스트의 이름
+        lifespan (int): 컨텍스트의 남은 횟수
+        ttl (int): 컨텍스트가 유지되는 시간
+        params (dict): 컨텍스트의 추가 정보
+
+    Examples:
+    >>> context = Context(
+    ...     name="context_name",
+    ...     lifespan=1,
+    ...     ttl=600,
+    ...     params={
+    ...         "key": "value"
+    ...     }
+    ... )
+    >>> context.render()
+    {
+        "name": "context_name",
+        "lifespan": 1,
+        "ttl": 600,
+        "params": {
+            "key": "value"
+        }
+    }
+    """
+
+    def __init__(
+            self,
+            name: str,
+            lifespan: int,
+            ttl: Optional[int] = None,
+            params: Optional[dict] = None):
+        """Context 객체를 초기화합니다.
+
+        Args:
+            name (str): 컨텍스트의 이름
+            lifespan (int): 컨텍스트의 남은 횟수
+            ttl (int, optional): 컨텍스트가 유지되는 시간
+            params (dict, optional): 컨텍스트의 추가 정보
+        """
+        super().__init__()
+        self.name = name
+        self.lifespan = lifespan
+        self.ttl = ttl
+        self.params = params
+
+    @classmethod
+    def from_dict(cls, data: dict) -> 'Context':
+        """딕셔너리를 Context 객체로 변환합니다.
+
+        변환할 딕셔너리는 다음과 같은 형태입니다.
+        {
+            "name": "context_name",
+            "lifespan": 1,
+            "ttl": 600,
+            "params": {
+                "key": "value"
+            }
+        }
+
+        Args:
+            data (dict): 변환할 딕셔너리
+
+        Returns:
+            Context: 변환된 Context 객체
+        """
+        return cls(**data)
+
+    def render(self) -> dict:
+        """Context 객체를 카카오톡 응답 규칙에 맞게 딕셔너리로 변환합니다.
+
+        반환되는 딕셔너리는 다음과 같은 형태입니다.
+        {
+            "name": "context_name",
+            "lifespan": 1,
+            "ttl": 600,
+            "params": {
+                "key": "value"
+            }
+        }
+
+        Returns:
+            dict: Context 객체를 변환한 딕셔너리
+        """
+        response = {
+            "name": self.name,
+            "lifeSpan": self.lifespan,
+            "ttl": self.ttl,
+            "params": self.params
+        }
+        return self.remove_none_item(response)
+
+    def validate(self):
+        """Context 객체의 유효성을 검사합니다.
+
+        Raises:
+            InvalidTypeError: name이 str이 아닐 경우 발생합니다.
+            InvalidTypeError: lifespan이 int가 아닐 경우 발생합니다.
+            InvalidTypeError: ttl이 int가 아닐 경우 발생합니다.
+            InvalidTypeError: params가 dict가 아닐 경우 발생합니다.
+        """
+        validate_str(self.name)
+        validate_int(self.lifespan, self.ttl)
+        validate_type(dict, self.params)