Merge pull request #108 from starkinfra/feature/brcode-preview-subscription

Add subscription and due attribute to BR code preview

Author: paulo-stark

CHANGELOG.md

@@ -13,6 +13,8 @@ Given a version number MAJOR.MINOR.PATCH, increment:
 
 
 ## [Unreleased]
+### Added
+- subcription and due attribute to BrcodePreview resource
 
 ## [0.20.0] - 2025-05-13
 ### Added

starkinfra/brcodepreview/__brcodepreview.py

@@ -1,6 +1,9 @@
 from ..utils import rest
 from starkcore.utils.resource import Resource
+from starkcore.utils.api import from_api_json
+from ..subscription.__subscription import Subscription
 from starkcore.utils.checks import check_datetime_or_date
+from ..subscription.__subscription import _resource as _subscription_resource
 
 
 class BrcodePreview(Resource):
@@ -25,6 +28,7 @@ class BrcodePreview(Resource):
     - cashier_bank_code [string]: Cashier's bank code. ex: "20018183"
     - cashier_type [string]: Cashier's type. Options: "merchant", "participant" and "other"
     - discount_amount [integer]: Discount value calculated over nominal_amount. ex: 3000
+    - due [datetime.datetime]: BR Code due date. ex: datetime(2020, 3, 10)
     - fine_amount [integer]: Fine value calculated over nominal_amount. ex: 20000
     - interest_amount [integer]: Interest value calculated over nominal_amount. ex: 10000
     - key_id [string]: Receiver's PixKey id. ex: "+5511989898989"
@@ -34,13 +38,14 @@ class BrcodePreview(Resource):
     - reduction_amount [integer]: Reduction value to discount from nominal_amount. ex: 1000
     - scheduled [datetime.datetime]: date of payment execution. ex: datetime(2020, 3, 10)
     - status [string]: Payment status. ex: "created", "paid", "canceled" or "expired"
+    - subscription [Subscription]: BR code subscription information
     - tax_id [string]: Payment receiver tax ID. ex: "012.345.678-90"
     """
 
     def __init__(self, id, payer_id, account_number=None, account_type=None, amount=None, amount_type=None, bank_code=None,
-                 branch_code=None, cash_amount=None, cashier_bank_code=None, cashier_type=None, discount_amount=None,
+                 branch_code=None, cash_amount=None, cashier_bank_code=None, cashier_type=None, discount_amount=None, due=None,
                  fine_amount=None, interest_amount=None, key_id=None, name=None, nominal_amount=None, end_to_end_id=None,
-                 reconciliation_id=None, reduction_amount=None, scheduled=None, status=None, tax_id=None, description=None):
+                 reconciliation_id=None, reduction_amount=None, scheduled=None, subscription=None, status=None, tax_id=None, description=None):
         Resource.__init__(self, id=id)
 
         self.payer_id = payer_id
@@ -55,6 +60,9 @@ def __init__(self, id, payer_id, account_number=None, account_type=None, amount=
         self.cashier_bank_code = cashier_bank_code
         self.cashier_type = cashier_type
         self.discount_amount = discount_amount
+        if(due == ""):
+            due = None
+        self.due = check_datetime_or_date(due)
         self.fine_amount = fine_amount
         self.interest_amount = interest_amount
         self.key_id = key_id
@@ -64,12 +72,19 @@ def __init__(self, id, payer_id, account_number=None, account_type=None, amount=
         self.reduction_amount = reduction_amount
         self.scheduled = check_datetime_or_date(scheduled)
         self.status = status
+        self.subscription = _parse_subscription(subscription)
         self.tax_id = tax_id
         self.description = description
 
 
 _resource = {"class": BrcodePreview, "name": "BrcodePreview"}
 
+def _parse_subscription(subscription):
+    if not subscription or subscription is None:
+        return None
+    if isinstance(subscription, Subscription):
+        return subscription
+    return from_api_json(_subscription_resource, subscription)
 
 def create(previews, user=None):
     """# Retrieve BrcodePreviews

starkinfra/subscription/__init__.py

@@ -0,0 +1,54 @@
+from starkcore.utils.subresource import SubResource
+from starkcore.utils.checks import check_datetime_or_date
+
+
+class Subscription(SubResource):
+    """# Subscription object
+    Subscription is a recurring payment that can be used to charge a user periodically.
+    ## Attributes (return-only):
+    - amount [integer]: amount to be charged in cents. ex: 1000 = R$ 10.00
+    - amount_min_limit [integer]: minimum amount limit for the subscription. ex: 500 = R$ 5.00
+    - bacen_id [string]: BACEN (Brazilian Central Bank) identifier.
+    - created [datetime.datetime]: creation datetime for the subscription. ex: datetime(2020, 3, 10)
+    - description [string]: description of the subscription.
+    - installment_end [datetime.datetime]: end datetime for the installments. ex: datetime(2020, 3, 10)
+    - installment_start [datetime.datetime]: start datetime for the installments. ex: datetime(2020, 3, 10)
+    - interval [string]: interval for the recurring charge. ex: "monthly"
+    - pull_retry_limit [integer]: maximum number of retries for pulling the payment.
+    - receiver_bank_code [string]: bank code of the receiver.
+    - receiver_name [string]: name of the receiver.
+    - receiver_tax_id [string]: tax ID of the receiver.
+    - reference_code [string]: reference code for the subscription.
+    - sender_final_name [string]: final sender name.
+    - sender_final_tax_id [string]: final sender tax ID.
+    - status [string]: current status of the subscription.
+    - type [string]: type of the subscription.
+    - updated [datetime.datetime]: last update datetime for the subscription. ex: datetime(2020, 3, 10)
+    """
+
+    def __init__(self, amount, amount_min_limit=None, bacen_id=None, created=None, description=None,
+        installment_end=None, installment_start=None, interval=None, pull_retry_limit=None, receiver_bank_code=None,
+        receiver_name=None, receiver_tax_id=None, reference_code=None, sender_final_name=None, sender_final_tax_id=None,
+        status=None, type=None, updated=None
+    ):
+        self.amount = amount
+        self.amount_min_limit = amount_min_limit
+        self.bacen_id = bacen_id
+        self.created = check_datetime_or_date(created)
+        self.description = description
+        self.installment_end = check_datetime_or_date(installment_end)
+        self.installment_start = check_datetime_or_date(installment_start)
+        self.interval = interval
+        self.pull_retry_limit = pull_retry_limit
+        self.receiver_bank_code = receiver_bank_code
+        self.receiver_name = receiver_name
+        self.receiver_tax_id = receiver_tax_id
+        self.reference_code = reference_code
+        self.sender_final_name = sender_final_name
+        self.sender_final_tax_id = sender_final_tax_id
+        self.status = status
+        self.type = type
+        self.updated = check_datetime_or_date(updated)
+
+
+_resource = {"class": Subscription, "name": "Subscription"}

starkinfra/subscription/__subscription.py

@@ -1,14 +1,16 @@
 import starkinfra
 from unittest import TestCase, main
 from tests.utils.user import exampleProject
+from tests.utils.brcodePreview import create_brcode_preview_by_id
+from tests.utils.dynamicBrcode import create_dynamic_brcode_by_type
 
 
 starkinfra.user = exampleProject
 
 
-class TestBrcodePreview(TestCase):
+class TestCreateBrcodePreview(TestCase):
 
-    def test_success(self):
+    def test_query_and_create(self):
         static_brcodes = list(starkinfra.staticbrcode.query(limit=2))
 
         dynamic_brcodes = list(starkinfra.dynamicbrcode.query(limit=2))
@@ -18,19 +20,19 @@ def test_success(self):
         previews = starkinfra.brcodepreview.create([
             starkinfra.BrcodePreview(
                 id=brcodes[0].id,
-                payer_id="012.345.678-90"
+                payer_id="20018183000180"
             ),
             starkinfra.BrcodePreview(
                 id=brcodes[1].id,
-                payer_id="012.345.678-90"
+                payer_id="20018183000180"
             ),
             starkinfra.BrcodePreview(
                 id=brcodes[2].id,
-                payer_id="012.345.678-90"
+                payer_id="20018183000180"
             ),
             starkinfra.BrcodePreview(
                 id=brcodes[3].id,
-                payer_id="012.345.678-90"
+                payer_id="20018183000180"
             )
         ])
 
@@ -39,8 +41,47 @@ def test_success(self):
         index = 0
         for preview in previews:
             self.assertEqual(str(preview.id), str(brcodes[index].id))
-            print(preview)
             index = index + 1
+    
+    def test_create_type_instant(self):
+        created_dynamic_brcode = create_dynamic_brcode_by_type("instant")
+        preview = create_brcode_preview_by_id(created_dynamic_brcode.id)
+
+        self.assertEqual(preview.id, created_dynamic_brcode.id)
+        self.assertEqual(preview.due, None)
+        self.assertEqual(preview.subscription, None)
+
+    def test_create_type_due(self):
+        created_dynamic_brcode = create_dynamic_brcode_by_type("due")
+        preview = create_brcode_preview_by_id(created_dynamic_brcode.id)
+
+        self.assertEqual(preview.id, created_dynamic_brcode.id)
+        self.assertNotEqual(preview.due, None)
+        self.assertEqual(preview.subscription, None)
+
+    def test_create_type_subscription(self):
+        created_dynamic_brcode = create_dynamic_brcode_by_type("subscription")
+        preview = create_brcode_preview_by_id(created_dynamic_brcode.id)
+
+        self.assertEqual(preview.id, created_dynamic_brcode.id)
+        self.assertEqual(preview.payer_id, '')
+        self.assertEqual(preview.subscription.type, "qrcode")
+
+    def test_create_type_subscription_and_instant(self):
+        created_dynamic_brcode = create_dynamic_brcode_by_type("subscriptionAndInstant")
+        preview = create_brcode_preview_by_id(created_dynamic_brcode.id)
+
+        self.assertEqual(preview.id, created_dynamic_brcode.id)
+        self.assertNotEqual(preview.payer_id, None)
+        self.assertEqual(preview.subscription.type, "qrcodeAndPayment")
+    
+    def test_create_type_due_and_or_subscription(self):
+        created_dynamic_brcode = create_dynamic_brcode_by_type("dueAndOrSubscription")
+        preview = create_brcode_preview_by_id(created_dynamic_brcode.id)
+
+        self.assertEqual(preview.id, created_dynamic_brcode.id)
+        self.assertNotEqual(preview.payer_id, None)
+        self.assertEqual(preview.subscription.type, "paymentAndOrQrcode")
 
 
 if __name__ == '__main__':

tests/sdk/testBrcodePreview.py

@@ -4,7 +4,7 @@
 from datetime import date, timedelta, datetime
 from tests.utils.user import exampleProject
 from starkcore.error import InvalidSignatureError
-from tests.utils.dynamicBrcode import generateExampleDynamicBrcodeJson
+from tests.utils.dynamicBrcode import create_dynamic_brcode_by_type
 
 starkinfra.user = exampleProject
 
@@ -52,13 +52,40 @@ def test_success(self):
 
 class TestDynamicBrcodePost(TestCase):
 
-    def test_success(self):
-        example_dynamic_brcode = generateExampleDynamicBrcodeJson()
-        dynamic_brcode = starkinfra.dynamicbrcode.create(
-            brcodes=[example_dynamic_brcode]
-        )
-        for brcode in dynamic_brcode:
-            print(brcode)
+    def test_create_instant_brcode(self):
+        type = "instant"
+        created_brcode = create_dynamic_brcode_by_type(type)
+        
+        self.assertEqual(created_brcode.type, type)
+        self.assertNotEqual(created_brcode.uuid, "")
+
+    def test_create_due_brcode(self):
+        type = "due"
+        created_brcode = create_dynamic_brcode_by_type(type)
+        
+        self.assertEqual(created_brcode.type, type)
+        self.assertNotEqual(created_brcode.uuid, "")
+
+    def test_create_subscription_brcode(self):
+        type = "subscription"
+        created_brcode = create_dynamic_brcode_by_type(type)
+        
+        self.assertEqual(created_brcode.type, type)
+        self.assertNotEqual(created_brcode.uuid, "")
+    
+    def test_create_subscription_and_instant_brcode(self):
+        type = "subscriptionAndInstant"
+        created_brcode = create_dynamic_brcode_by_type(type)
+        
+        self.assertEqual(created_brcode.type, type)
+        self.assertNotEqual(created_brcode.uuid, "")
+
+    def test_create_due_and_or_subscription_brcode(self):
+        type = "dueAndOrSubscription"
+        created_brcode = create_dynamic_brcode_by_type(type)
+        
+        self.assertEqual(created_brcode.type, type)
+        self.assertNotEqual(created_brcode.uuid, "")
 
 
 class TestDynamicBrcodeParseRight(TestCase):

tests/sdk/testDynamicBrcode.py

@@ -0,0 +1,11 @@
+import starkinfra
+from starkinfra import BrcodePreview
+
+def create_brcode_preview_by_id(id):
+    previews = starkinfra.brcodepreview.create([
+        starkinfra.BrcodePreview(
+            id=id,
+            payer_id="20018183000180"
+        )
+    ])
+    return previews[0]

tests/utils/brcodePreview.py

@@ -1,4 +1,5 @@
 import random
+import starkinfra
 from starkinfra import DynamicBrcode
 
 
@@ -10,7 +11,17 @@
 )
 
 
-def generateExampleDynamicBrcodeJson():
+def generate_example_dynamic_brcode_json(type = None):
     example_dynamic_brcode.type = random.choice(["instant", "due"])
-    example_dynamic_brcode.external_id = str(random.randint(1, 100000))
+    example_dynamic_brcode.external_id = str(random.randint(1, 1000000))
     return example_dynamic_brcode
+
+def create_dynamic_brcode_by_type(type = None):
+    example_dynamic_brcode.type = type
+    if type is None:
+        type = random.choice(["instant", "due", "subscription", "subscriptionAndInstant", "dueAndOrSubscription"])
+    example_dynamic_brcode.external_id = str(random.randint(1, 1000000))
+    dynamic_brcode = starkinfra.dynamicbrcode.create(
+        brcodes=[example_dynamic_brcode]
+    )
+    return dynamic_brcode[0]