bootpay-backend 2.5.0__tar.gz → 2.7.0__tar.gz

{bootpay_backend-2.5.0 → bootpay_backend-2.7.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bootpay_backend
-Version: 2.5.0
+Version: 2.7.0
 Summary: bootpay server side plugin for python
 Home-page: https://github.com/bootpay/backend-python/tree/2-x-development
 Author: bootpay <bootpay.co.kr@gmail.com>

{bootpay_backend-2.5.0 → bootpay_backend-2.7.0}/bootpay_backend/commerce/modules/order.py

@@ -52,7 +52,7 @@ class OrderModule:
             if params.get('payment_status') and len(params['payment_status']) > 0:
                 query_params['payment_status'] = ','.join(map(str, params['payment_status']))
             if params.get('order_subscription_ids') and len(params['order_subscription_ids']) > 0:
-                query_params['order_subscription_ids'] = ','.join(params['order_subscription_ids'])
+                query_params['order_subscription_ids'] = ','.join(map(str, params['order_subscription_ids']))
 
         query = urlencode(query_params) if query_params else ''
         return self._bootpay.get(f'orders{"?" + query if query else ""}')

{bootpay_backend-2.5.0 → bootpay_backend-2.7.0}/bootpay_backend/commerce/modules/order_subscription.py

@@ -193,6 +193,9 @@ class OrderSubscriptionModule:
                 query_params['status'] = params['status']
             if params.get('user_id'):
                 query_params['user_id'] = params['user_id']
+            # 주문번호 역조회 — 서버(#index)가 params[:order_number] 로 구독을 찾아준다.
+            if params.get('order_number'):
+                query_params['order_number'] = params['order_number']
 
         query = urlencode(query_params) if query_params else ''
         return self._bootpay.get(f'order_subscriptions{"?" + query if query else ""}')
@@ -210,6 +213,13 @@ class OrderSubscriptionModule:
         구독 계약 내용 변경
         PUT /v1/order_subscriptions/{order_subscription_id}
         바뀐 값만 보내면 된다 (나머지는 서버가 그대로 유지한다). supervisor scope.
+
+        price 는 회차별 결제 금액의 기준금액이다. 바꾸면 결제예정(READY) 회차의 청구액이
+        즉시 다시 계산되고, 이후 회차도 이 금액으로 만들어진다. 이미 결제된 회차는 그대로다.
+        0 이하는 받지 않는다. 특정 회차만 가감하려면 order_subscription_adjustment.create 를 쓴다.
+        (관리자 화면의 금액 변경과 같은 구현을 탄다)
+
+        memo 는 변경이력(SUBSCRIPTION_ACTION_UPDATE)에 남길 사유다.
         :param params: 수정 파라미터
         :return: CommerceOrderSubscription
         """

{bootpay_backend-2.5.0 → bootpay_backend-2.7.0}/bootpay_backend/commerce/modules/order_subscription_adjustment.py

@@ -27,6 +27,13 @@ class OrderSubscriptionAdjustmentModule:
         가감산 조정항목 추가
         POST /v1/order_subscriptions/{order_subscription_id}/adjustments
         type 미전달시 서버가 price > 0 이면 SETUP_PRICE, 아니면 PERIOD_DISCOUNT 로 자동 판정한다.
+
+        회차 지정 방법 3가지 (아래로 갈수록 넓다):
+          - duration: 5                          → 5회차 한 건만
+          - duration_from: 3, duration_to: 7     → 3~7회차 각각 한 건씩 (총 5건)
+          - duration_from: 3, is_unlimited: True → 3회차부터 계약 끝까지 (레코드는 1건, duration_to 는 무시)
+        상한은 계약 총회차이며, 총회차가 무제한인 계약은 60회차까지다.
+        이미 결제가 끝난 회차는 거절된다. 범위 중 한 회차라도 최종 금액이 음수면 전부 거절된다(부분 반영 없음).
         :param order_subscription_id: 정기구독 ID
         :param adjustment: 조정 정보 (price/duration/tax_free_price 미지정시 각각 0 / 1 / 0)
         :param idempotency_key: 미지정시 자동 생성

{bootpay_backend-2.5.0 → bootpay_backend-2.7.0}/bootpay_backend/commerce/modules/product.py

@@ -24,6 +24,12 @@ class ProductModule:
     def list(self, params: Optional[ProductListParams] = None):
         """
         상품 목록 조회
+        GET /v1/products
+
+        ⚠️ 서버(v1/products_controller#index)가 읽는 것은
+           page / limit / keyword / category_id / ex_uid / sort 뿐이다.
+           type / period_type / s_at / e_at / category_code 는 보내도 에러 없이 무시되고
+           전체 목록이 돌아온다 (하위호환을 위해 전송 자체는 유지한다).
         :param params: 조회 파라미터
         :return: {'items': List[CommerceProduct], 'total': int}
         """
@@ -35,6 +41,13 @@ class ProductModule:
                 query_params['limit'] = params['limit']
             if params.get('keyword'):
                 query_params['keyword'] = params['keyword']
+            if params.get('category_id'):
+                query_params['category_id'] = params['category_id']
+            if params.get('ex_uid'):
+                query_params['ex_uid'] = params['ex_uid']
+            if params.get('sort'):
+                query_params['sort'] = params['sort']
+            # 아래 4개는 서버가 읽지 않는다 — 기존 호출을 깨지 않으려고 전송만 유지한다
             if params.get('type') is not None:
                 query_params['type'] = params['type']
             if params.get('period_type'):
@@ -69,6 +82,8 @@ class ProductModule:
         }
         if params.get('category_id'):
             query_params['category_id'] = params['category_id']
+        if params.get('ex_uid'):
+            query_params['ex_uid'] = params['ex_uid']
         if params.get('sort'):
             query_params['sort'] = params['sort']
         if params.get('keyword'):
@@ -131,15 +146,18 @@ class ProductModule:
             headers=self._mall_headers(user_jwt=user_jwt, idempotency_key=idempotency_key)
         )
 
-    def lookup_product(self, product_id: str, idempotency_key: Optional[str] = None):
+    def lookup_product(self, product_id: str, user_jwt: Optional[str] = None,
+                       idempotency_key: Optional[str] = None):
         """
         상품 정보 조회 — `product_detail` 과 같은 endpoint 다.
         ruby 동기화 파이프라인이 쓰는 이름이라 호환용으로 둔다.
+        매뉴얼이 GET /v1/products/{product_id} 에 user_jwt 를 안내하므로 회원 컨텍스트 조회도 지원한다.
         :param product_id: 상품 ID
+        :param user_jwt: 회원 JWT (선택)
         :param idempotency_key: 미지정시 자동 생성
         :return: CommerceProduct
         """
-        return self.product_detail(product_id, idempotency_key=idempotency_key)
+        return self.product_detail(product_id, user_jwt=user_jwt, idempotency_key=idempotency_key)
 
     def update(self, product: CommerceProduct, idempotency_key: Optional[str] = None):
         """

{bootpay_backend-2.5.0 → bootpay_backend-2.7.0}/bootpay_backend/commerce/modules/user.py

@@ -170,6 +170,9 @@ class UserModule:
     def list(self, params: Optional[UserListParams] = None):
         """
         사용자 목록 조회
+        ⚠️ 회원등급 필터의 서버(v1/users_controller#index) 키는 membership_type 이다.
+           member_type 으로 보내면 에러 없이 조용히 무시되고 전체 목록이 돌아온다.
+           기존 호출 호환을 위해 member_type 도 받아 membership_type 으로 매핑한다.
         :param params: 조회 파라미터
         :return: {'items': List[CommerceUser], 'total': int}
         """
@@ -181,8 +184,11 @@ class UserModule:
                 query_params['limit'] = params['limit']
             if params.get('keyword'):
                 query_params['keyword'] = params['keyword']
-            if params.get('member_type') is not None:
-                query_params['member_type'] = params['member_type']
+            membership_type = params.get('membership_type')
+            if membership_type is None:
+                membership_type = params.get('member_type')
+            if membership_type is not None:
+                query_params['membership_type'] = membership_type
             if params.get('type'):
                 query_params['type'] = params['type']
 

{bootpay_backend-2.5.0 → bootpay_backend-2.7.0}/bootpay_backend/commerce/types/__init__.py

@@ -91,6 +91,9 @@ class CommerceUser(TypedDict, total=False):
 
 
 class UserListParams(ListParams, total=False):
+    # 회원등급 필터. 서버가 읽는 정식 키는 membership_type 이다.
+    membership_type: int
+    # ⚠️ 하위호환 별칭 — 지정하면 membership_type 으로 매핑되어 전송된다.
     member_type: int
     type: str
 
@@ -358,6 +361,23 @@ class CommerceProduct(TypedDict, total=False):
 
 
 class ProductListParams(ListParams, total=False):
+    # 상품 목록 조회 파라미터 (GET /v1/products)
+    #
+    # ⚠️ 서버(v1/products_controller#index)가 실제로 읽는 것은
+    #    page / limit / keyword / category_id / ex_uid / sort 뿐이다.
+    #    아래 type / period_type / s_at / e_at / category_code 는 전송되더라도 에러 없이
+    #    무시되고 전체 목록이 돌아온다 — 필터가 걸린 것으로 착각하지 말 것.
+    #    (keyword 는 26-08-26 서버 변경부터 적용된다. 그 이전 배포본에서는 무시된다.)
+
+    # 카테고리 ID 로 필터한다 (하위 카테고리 포함)
+    category_id: str
+    # 외부 UID 로 상품을 찾는다
+    ex_uid: str
+    # 정렬 키 — position | created_at | -created_at | price | -price | -sold
+    sort: str
+
+    # ── 아래는 서버가 읽지 않는다 (하위호환 때문에 인자만 유지) ──
+    # 서버의 상품 타입 필터는 문자열(subscription / discount / normal)이라 값 체계가 다르다
     type: int
     period_type: str
     s_at: str
@@ -367,9 +387,8 @@ class ProductListParams(ListParams, total=False):
 
 class MallProductListParams(ProductListParams, total=False):
     # 상품 목록 조회 (V1 Mall API) 파라미터
-    # ⚠️ keyword 는 서버가 읽지 않는다 (하위호환 때문에 인자는 유지)
-    category_id: str
-    sort: str
+    # category_id / ex_uid / sort 는 ProductListParams 에서 상속받는다.
+    # 회원 JWT — Bootpay-User-JWT 헤더로 전송된다 (query 에는 포함되지 않는다)
     user_jwt: str
     # 미지정시 자동 생성 (Idempotency-Key 헤더로 전송, query 에는 포함되지 않는다)
     idempotency_key: str
@@ -716,6 +735,8 @@ class OrderSubscriptionListParams(ListParams, total=False):
     user_group_id: str
     user_id: str
     status: int
+    # 주문번호로 구독을 역조회한다
+    order_number: str
 
 
 class OrderSubscriptionUpdateParams(TypedDict, total=False):
@@ -738,6 +759,12 @@ class OrderSubscriptionUpdateParams(TypedDict, total=False):
     status: int
     payment_next_at: str
     service_end_at: str
+    # 회차별 결제 금액의 기준금액. 바꾸면 결제예정(READY) 회차의 청구액이 즉시 재계산되고
+    # 이후 회차도 이 금액으로 만들어진다. 이미 결제된 회차는 그대로다. 0 이하는 받지 않는다.
+    # 특정 회차만 가감하려면 order_subscription_adjustment.create 를 쓴다.
+    price: int
+    # 변경이력(SUBSCRIPTION_ACTION_UPDATE)에 남길 사유
+    memo: str
     # 미지정시 자동 생성 (Idempotency-Key 헤더로 전송, body 에는 포함되지 않는다)
     idempotency_key: str
 
@@ -883,6 +910,13 @@ class CommerceOrderSubscriptionAdjustment(TypedDict, total=False):
     name: str
     type: int
     created_at: str
+    # 회차 지정 방법 3가지 (아래로 갈수록 넓다) — create 전용 파라미터
+    #   - duration: 5                        → 5회차 한 건만
+    #   - duration_from: 3, duration_to: 7   → 3~7회차 각각 한 건씩 (총 5건)
+    #   - duration_from: 3, is_unlimited: True → 3회차부터 계약 끝까지 (레코드 1건, duration_to 는 무시)
+    duration_from: int
+    duration_to: int
+    is_unlimited: bool
 
 
 class OrderSubscriptionAdjustmentUpdateParams(TypedDict, total=False):

{bootpay_backend-2.5.0 → bootpay_backend-2.7.0}/bootpay_backend/rest_client.py

@@ -11,7 +11,7 @@ class BootpayBackend:
         'production': 'https://api.bootpay.co.kr/v2'
     }
     API_VERSION = '5.1.0'
-    SDK_VERSION = '2.5.0'
+    SDK_VERSION = '2.7.0'
 
     def __init__(self, application_id=None, private_key=None, mode='production', client_key=None, secret_key=None):
         # application_id/private_key는 legacy 사용자를 위해 그대로 지원한다.

{bootpay_backend-2.5.0 → bootpay_backend-2.7.0}/bootpay_backend.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: bootpay_backend
-Version: 2.5.0
+Version: 2.7.0
 Summary: bootpay server side plugin for python
 Home-page: https://github.com/bootpay/backend-python/tree/2-x-development
 Author: bootpay <bootpay.co.kr@gmail.com>

{bootpay_backend-2.5.0 → bootpay_backend-2.7.0}/setup.py

@@ -9,7 +9,7 @@ with open(path.join(this_directory, 'README.md'), encoding='utf-8') as f:
 
 setuptools.setup(
     name = 'bootpay_backend',
-    version = '2.5.0',
+    version = '2.7.0',
     description = 'bootpay server side plugin for python',
     long_description=long_description,
     long_description_content_type='text/markdown',

{bootpay_backend-2.5.0 → bootpay_backend-2.7.0}/tests/commerce/test_wire_format.py

@@ -246,6 +246,19 @@ def test_products_mall_defaults_page_1_limit_20(commerce, captured):
     assert captured['headers']['Bootpay-User-JWT'] == 'member-jwt'
 
 
+def test_product_list_sends_server_read_filters(commerce, captured):
+    """list() 는 서버가 읽는 category_id / ex_uid / sort 를 실어야 한다."""
+    commerce.product.list({
+        'page': 1, 'limit': 10, 'keyword': '커피',
+        'category_id': 'cat1', 'ex_uid': 'EX-1', 'sort': '-price'
+    })
+    assert captured['method'] == 'get'
+    url = captured['url']
+    for fragment in ('page=1', 'limit=10', 'category_id=cat1', 'ex_uid=EX-1', 'sort=-price'):
+        assert fragment in url, f'{fragment} not in {url}'
+    assert 'keyword=' in url
+
+
 def test_product_detail_mall_supports_jwt(commerce, captured):
     commerce.product.product_detail('prod1', user_jwt='member-jwt')
     assert captured['url'].endswith('/v1/products/prod1')
@@ -390,6 +403,54 @@ def test_adjustment_create_defaults(commerce, captured):
     assert captured['json'] == {'price': 5000, 'duration': 1, 'tax_free_price': 0, 'name': '설치비'}
 
 
+def test_adjustment_create_supports_duration_range(commerce, captured):
+    """duration_from ~ duration_to 로 회차 범위를 지정한다 (3~7회차 각각 한 건씩)."""
+    commerce.order_subscription_adjustment.create('os1', {
+        'name': '기간할인',
+        'price': -1000,
+        'duration_from': 3,
+        'duration_to': 7,
+    })
+
+    assert captured['method'] == 'post'
+    assert captured['url'].endswith('/v1/order_subscriptions/os1/adjustments')
+    assert captured['json'] == {
+        'name': '기간할인', 'price': -1000, 'duration': 1, 'tax_free_price': 0,
+        'duration_from': 3, 'duration_to': 7,
+    }
+    assert captured['headers']['BOOTPAY-ROLE'] == 'supervisor'
+
+
+def test_adjustment_create_supports_unlimited_range(commerce, captured):
+    """duration_from + is_unlimited 이면 해당 회차부터 계약 끝까지 (duration_to 는 무시된다)."""
+    commerce.order_subscription_adjustment.create('os1', {
+        'name': '무기한할인',
+        'price': -500,
+        'duration_from': 3,
+        'is_unlimited': True,
+        'duration_to': None,
+    }, idempotency_key='adj-key')
+
+    assert captured['json'] == {
+        'name': '무기한할인', 'price': -500, 'duration': 1, 'tax_free_price': 0,
+        'duration_from': 3, 'is_unlimited': True,
+    }
+    assert captured['headers']['Idempotency-Key'] == 'adj-key'
+
+
+def test_adjustment_create_keeps_false_is_unlimited(commerce, captured):
+    """None 만 제거한다 — is_unlimited=False 는 그대로 전송되어야 한다."""
+    commerce.order_subscription_adjustment.create('os1', {
+        'name': '단일회차',
+        'price': 1000,
+        'duration_from': 2,
+        'duration_to': 4,
+        'is_unlimited': False,
+    })
+
+    assert captured['json']['is_unlimited'] is False
+
+
 # ---------------------------------------------------------------------------
 # 파라미터 확장 — userGroup.limit / order.list / orderSubscription.list / orderSubscriptionRequest.list
 # ---------------------------------------------------------------------------
@@ -501,6 +562,22 @@ def test_order_subscription_update_uses_supervisor_role(commerce, captured):
     assert captured['headers']['BOOTPAY-ROLE'] == 'supervisor'
 
 
+def test_order_subscription_update_sends_price(commerce, captured):
+    """price 는 회차별 결제 기준금액 — 계약변경 body 로 그대로 전송된다."""
+    commerce.order_subscription.update({
+        'order_subscription_id': 'os1',
+        'price': 15000,
+        'order_name': None,
+        'idempotency_key': 'price-key',
+    })
+
+    assert captured['method'] == 'put'
+    assert captured['url'].endswith('/v1/order_subscriptions/os1')
+    assert captured['json'] == {'price': 15000}
+    assert captured['headers']['BOOTPAY-ROLE'] == 'supervisor'
+    assert captured['headers']['Idempotency-Key'] == 'price-key'
+
+
 def test_order_subscription_request_list_role_depends_on_project_id(commerce, captured):
     commerce.order_subscription_request.list()
     assert 'page=1' in captured['url'] and 'limit=20' in captured['url']
@@ -561,3 +638,91 @@ def test_explicit_idempotency_key_is_forwarded_and_kept_out_of_body(commerce, ca
 
     assert captured['headers']['Idempotency-Key'] == 'fixed-key'
     assert captured['json'] == {'name': '카테고리'}
+
+
+# ---------------------------------------------------------------------------
+# ruby SDK 누락 파라미터 반영 — orders / order_subscriptions / products / users
+# ---------------------------------------------------------------------------
+def test_order_list_supports_subscription_filters(commerce, captured):
+    """구독 계약별·결제유형별 필터 — order_subscription_ids 는 콤마로 join 해서 보낸다."""
+    commerce.order.list({
+        'order_subscription_ids': ['os1', 'os2'],
+        'subscription_billing_type': 1,
+    })
+
+    assert captured['method'] == 'get'
+    assert 'order_subscription_ids=os1%2Cos2' in captured['url']
+    assert 'subscription_billing_type=1' in captured['url']
+
+
+def test_order_list_omits_empty_status_filters(commerce, captured):
+    """값이 비었으면 status=&payment_status= 를 실어 보내지 않는다 (서버는 무시하지만 노이즈)."""
+    commerce.order.list({'page': 1, 'status': [], 'payment_status': [], 'order_subscription_ids': []})
+
+    assert 'status=' not in captured['url']
+    assert 'payment_status=' not in captured['url']
+    assert 'order_subscription_ids=' not in captured['url']
+
+
+def test_order_subscription_list_supports_order_number(commerce, captured):
+    """주문번호로 구독을 역조회한다."""
+    commerce.order_subscription.list({'order_number': 'ON-1'})
+
+    assert captured['method'] == 'get'
+    assert '/v1/order_subscriptions?' in captured['url']
+    assert 'order_number=ON-1' in captured['url']
+
+
+def test_order_subscription_update_sends_memo(commerce, captured):
+    """memo 는 변경이력에 남길 사유로 body 에 그대로 전송된다."""
+    commerce.order_subscription.update({
+        'order_subscription_id': 'os1',
+        'price': 15000,
+        'memo': '고객 요청으로 금액 변경',
+    })
+
+    assert captured['method'] == 'put'
+    assert captured['url'].endswith('/v1/order_subscriptions/os1')
+    assert captured['json'] == {'price': 15000, 'memo': '고객 요청으로 금액 변경'}
+    assert captured['headers']['BOOTPAY-ROLE'] == 'supervisor'
+
+
+def test_products_mall_supports_ex_uid(commerce, captured):
+    """외부 UID 로 상품 조회 — 서버(v1/products_controller#index)가 params[:ex_uid] 를 읽는다."""
+    commerce.product.products({'ex_uid': 'EX-1'})
+
+    assert captured['method'] == 'get'
+    assert 'ex_uid=EX-1' in captured['url']
+
+
+def test_lookup_product_supports_jwt(commerce, captured):
+    """lookup_product 도 product_detail 과 같이 회원 컨텍스트 조회를 지원한다."""
+    commerce.product.lookup_product('prod1')
+    assert captured['url'].endswith('/v1/products/prod1')
+    assert 'Bootpay-User-JWT' not in captured['headers']
+
+    commerce.product.lookup_product('prod1', user_jwt='member-jwt', idempotency_key='lp-key')
+    assert captured['url'].endswith('/v1/products/prod1')
+    assert captured['headers']['Bootpay-User-JWT'] == 'member-jwt'
+    assert captured['headers']['Idempotency-Key'] == 'lp-key'
+
+
+def test_user_list_sends_membership_type_not_member_type(commerce, captured):
+    """서버가 읽는 회원등급 키는 membership_type 이다 — member_type 으로 보내면 조용히 무시된다."""
+    commerce.user.list({'membership_type': 1})
+
+    assert captured['method'] == 'get'
+    assert 'membership_type=1' in captured['url']
+    assert 'member_type=1' not in captured['url']
+
+
+def test_user_list_maps_legacy_member_type_alias(commerce, captured):
+    """기존 호출 호환 — member_type 은 membership_type 으로 매핑해서 보낸다."""
+    commerce.user.list({'member_type': 2, 'keyword': '테스트'})
+
+    assert 'membership_type=2' in captured['url']
+    assert 'member_type=2' not in captured['url']
+
+    # 둘 다 주면 정식 키가 우선한다.
+    commerce.user.list({'membership_type': 1, 'member_type': 2})
+    assert 'membership_type=1' in captured['url']