django-barobill 0.1.0__py3-none-any.whl → 0.1.2__py3-none-any.whl

django_barobill/__init__.py

@@ -1,2 +0,0 @@
-# django_barobill/__init__.py
-__version__ = "0.1.0"

django_barobill/models.py

@@ -53,8 +53,21 @@ class BankHelper:
             web_pwd: Optional[str] = None,
             identity_num: Optional[str] = None
     ):
-        # need test
-        result = self.client.service.RegisterBankAccount(
+        """
+        신규 계좌를 등록한다.
+        :param alias: 별칭
+        :param collect_cycle: 수거주기
+        :param bank: 은행
+        :param account_type: 법인/개인계좌 여부
+        :param account_no: 계좌번호
+        :param password: 계좌 비밀번호
+        :param usage: (선택)적요
+        :param web_id:  (선택)간편조회 아이디
+        :param web_pwd: (선택)간편조회 비밀번호
+        :param identity_num: (선택)간편조회 사업자등록번호 혹은 생년월일
+        :return: 생성된 BankAccount 인스턴스
+        """
+        result = self.client.service.RegistBankAccount(
             CERTKEY=self.partner.api_key,
             CorpNum=self.partner.brn,
             CollectCycle=collect_cycle,
@@ -72,7 +85,7 @@ class BankHelper:
             raise BarobillAPIError(result)
         account, created = BankAccount.objects.update_or_create(
             partner=self.partner, account_no=account_no, defaults=dict(
-                collect_cycle=collect_cycle, bank=bank, account_type=account_type, alias=alias, usage=usage, is_delete=False
+                collect_cycle=collect_cycle, bank=bank, account_type=account_type, alias=alias, usage=usage, is_stop=False
             )
         )
         return account
@@ -88,11 +101,32 @@ class BankHelper:
         ).update(is_stop=True, stop_date=timezone.localdate())
 
 
+class PartnerManager(models.Manager):
+    def register_partner(self, name, brn, api_key, userid, dev=False):
+        """
+        신규 파트너를 등록한다.
+        :param name: 파트너사명
+        :param brn: 바로빌에 등록한 파트너 사업자등록번호
+        :param api_key: 바로빌에서 발급한 파트너 api_key
+        :param userid: 바로빌에서 발급한 파트너 Id
+        :param dev: 개발모드 여부
+        :return: Partner
+        """
+        partner, created = self.get_or_create(
+            brn=brn, userid=userid, defaults=dict(name=name, api_key=api_key, dev=dev)
+        )
+        return partner
+
+
 class Partner(models.Model):
     class Meta:
         verbose_name = '파트너'
         verbose_name_plural = verbose_name
+        constraints = [
+            models.UniqueConstraint(fields=['brn', 'userid', 'dev'], name='unique_partner_brn_userid'),
+        ]
 
+    objects = PartnerManager()
     name = models.CharField(max_length=255, unique=True, verbose_name='파트너사명')
     brn = models.CharField(max_length=10, unique=True, verbose_name='사업자등록번호')
     api_key = models.CharField(max_length=36, verbose_name='인증키')
@@ -329,7 +363,6 @@ class BankAccount(models.Model):
             raise BarobillAPIError(result.CurrentPage)
         return result
 
-
     def get_monthly_log(
             self,
             base_month: str,

django_barobill-0.1.2.dist-info/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 cuhong
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

django_barobill-0.1.2.dist-info/METADATA

@@ -0,0 +1,119 @@
+Metadata-Version: 2.2
+Name: django-barobill
+Version: 0.1.2
+Summary: A reusable Django app for integration with BaroBill services.
+Home-page: https://github.com/cuhong/django-barobill
+Author: cuhong
+Author-email: hongcoilhouse@gmail.com
+License: MIT License
+Classifier: Environment :: Web Environment
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.0
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: django>=4.0
+Requires-Dist: requests==2.32.3
+Requires-Dist: zeep==4.3.1
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: description-content-type
+Dynamic: home-page
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: requires-python
+Dynamic: summary
+
+# Django Barobill
+바로빌 연동을 위한 reusable package
+
+## 설치
+아래 명령어로 패키지 설치한 후
+
+```pip install django-barobill```
+
+`django`의 `settings.py` 내 `INSTALLED_APPS`에 `django_barobill`을 추가합니다.
+
+```shell
+INSTALLED_APPS = [
+    ...
+    'django.contrib.staticfiles',
+    'django_barobill'
+]
+```
+
+마지막으로 마이그레이션을 수행하여 필요한 테이블을 생성합니다.
+
+```shell
+python manage.py migrate
+```
+
+## 구성
+### 파트너
+이 패키지는 기본적으로 여러개의 파트너사를 한 앱에서 관리할 수 있게 구성되어 있습니다.
+
+파트너사는 `models.Partner`에 저장되며 신규 파트너를 아래와 같이 등록할 수 있습니다.
+
+```python
+from django_barobill.models import Partner
+상세 학목은 메서드의 docstring 참고
+
+partner = Partner.objects.register_partner(
+    '회사명', '사업자등록번호', 'api key', 'userid', dev=False 
+)
+```
+
+## 계좌조회
+### 계좌조회 관련 client
+아래와 같이 은행 계좌 조회와 관련된 client를 생성한다.
+
+```python
+from django_barobill.models import Partner
+
+partner = Partner.objects.first()
+
+bank_client = partner.bank.client
+```
+### 계좌 등록
+생성된 client에서 아래와 같이 계좌를 생성한다.
+상세 학목은 메서드의 docstring 참고
+
+```python
+bank_account = bank_client.register_bank_account(
+    '수금계좌', BankAccountCollectCycle.MINUTE10, BankAccountBank.HANA,
+    BankAccountAccountType.C, '21223451241', '1234'
+)
+```
+
+### 계좌 거래내역
+
+#### 조회만
+아래와 같은 형태로 거래내역을 조회힌다. 응답은 barobill의 응답을 변경없이 반환한다.
+자세한 내용은 각 메서드의 docstring 참고
+```python
+# 기간 조회
+log_duration = bank_client.get_log('20240101', '20240105', 1)
+# 특정일 조회
+log_day = bank_client.get_daily_log('20240101', 1)
+# 특정월 조회
+log_month = bank_client.get_monthly_log('202401', 1)
+```
+
+#### 조회 및 데이터베이스 등록
+조회 후 데이터베이스 등록 까지 진행
+자세한 내용은 각 메서드의 docstring 참고
+```python
+# 특정일 조회 및 등록
+log_day = bank_client.update_date_log('20240101')
+# 오늘 조회 및 등록
+log_today = bank_client.update_today_log()
+# 어제 조회 및 등록
+log_yesterday = bank_client.update_yesterday_log()
+```

{django_barobill-0.1.0.dist-info → django_barobill-0.1.2.dist-info}/RECORD

@@ -1,17 +1,19 @@
-django_barobill/__init__.py,sha256=6APRtokGxem92Eirujfn1lSSABIc2gFsVvfwDIOEf7c,52
+django_barobill/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 django_barobill/admin.py,sha256=suMo4x8I3JBxAFBVIdE-5qnqZ6JAZV0FESABHOSc-vg,63
 django_barobill/apps.py,sha256=VUIGjvRJJKmOM0WaBbqoU5QULCvC0YGKhKIMFYGpXxI,161
 django_barobill/choices.py,sha256=qkh5baFFCycTOKcTiU2DSu2iDJTiIQyhFgQ8uNSWyDo,1236
 django_barobill/errors.py,sha256=lKEEEKzAdwAueQOLhoSLe-B9VLT-S7hqUCrkfpkRXp8,3555
-django_barobill/models.py,sha256=Utls8E_l_dh8Yb8O8HibuaUQara6KakHqQk_RfmZ5K0,16134
+django_barobill/models.py,sha256=PvAsCqSpQZ0W61y6wWnLkz6A0HHQMlj_oq-l5_SLC7E,17527
 django_barobill/parsers.py,sha256=boBB9ePTRJrOmoEql23VQk_TDcaWqbEwJhxtW9Gx2Yc,1027
 django_barobill/tests.py,sha256=iG0hzKegA86ls4QxLY_p6sgZ0fkb_CD0HyzY-aO28ic,1661
 django_barobill/utils.py,sha256=eKSI-QgM8WTHA1vUukbZnVKEhiMcX7wzxLPcJ_6VKVE,200
 django_barobill/views.py,sha256=xc1IQHrsij7j33TUbo-_oewy3vs03pw_etpBWaMYJl0,63
 django_barobill/migrations/0001_initial.py,sha256=Uh8Nx0mOJQjXnPhzXmT7mrQx5zTbE8bNQSJJXTqHNpU,5176
 django_barobill/migrations/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_barobill-0.1.0.dist-info/LICENSE,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-django_barobill-0.1.0.dist-info/METADATA,sha256=kyC3pz_IHWpZX05M7_5JhfpWEkQmxi5Sg6AyLCnZx7s,996
-django_barobill-0.1.0.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
-django_barobill-0.1.0.dist-info/top_level.txt,sha256=RmcbZUqTKXVI1jksKTaeennFkcSemFHwgxSMPqE7YgU,16
-django_barobill-0.1.0.dist-info/RECORD,,
+django_barobill/migrations/__pycache__/0001_initial.cpython-312.pyc,sha256=e9D59BlhPF0qvZ_QM6iSS53LkFe0LpaJ8t0RlzKqzzw,5537
+django_barobill/migrations/__pycache__/__init__.cpython-312.pyc,sha256=vKIJDzcsTZu8PdXPuC052vkL9-T0Fi69yIxRo4BI57s,181
+django_barobill-0.1.2.dist-info/LICENSE,sha256=o5IEBFE4Yr1q_q2_HvPqL2YXAfakEBi0X2WS9CDJlyY,1063
+django_barobill-0.1.2.dist-info/METADATA,sha256=KneDIWMjsDhSqXcn2eOdpKKZvdb6bx0kTPJfou5bpqk,3389
+django_barobill-0.1.2.dist-info/WHEEL,sha256=In9FTNxeP60KnTkGw7wk6mJPYd_dQSjEZmXdBdMCI-8,91
+django_barobill-0.1.2.dist-info/top_level.txt,sha256=RmcbZUqTKXVI1jksKTaeennFkcSemFHwgxSMPqE7YgU,16
+django_barobill-0.1.2.dist-info/RECORD,,

django_barobill-0.1.0.dist-info/METADATA

@@ -1,31 +0,0 @@
-Metadata-Version: 2.2
-Name: django-barobill
-Version: 0.1.0
-Summary: A reusable Django app for integration with BaroBill services.
-Home-page: https://github.com/cuhong/django-barobill
-Author: cuhong
-Author-email: hongcoilhouse@gmail.com
-License: MIT License
-Classifier: Environment :: Web Environment
-Classifier: Framework :: Django
-Classifier: Framework :: Django :: 4.0
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Topic :: Software Development :: Libraries :: Python Modules
-Requires-Python: >=3.8
-Description-Content-Type: text/markdown
-License-File: LICENSE
-Requires-Dist: django>=4.0
-Requires-Dist: requests==2.32.3
-Requires-Dist: zeep==4.3.1
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: license
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary