Merge pull request #30 from bitpay/4.0.0-dev

New Major Version: 4.0.0

Author: bobbrodie

.github/workflows/build.yml

@@ -0,0 +1,40 @@
+name: Build
+
+on:
+  pull_request:
+    types:
+      - opened
+      - reopened
+  push:
+    branches-ignore:
+      - 'master'
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    strategy:
+        matrix:
+          python-version: [3.7, 3.8, 3.9, '3.10', 3.11]
+
+    steps:
+      - uses: actions/checkout@v3
+      - uses: actions/setup-python@v4
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install pipenv
+        run: |
+          pip3 install pipenv
+          pip3 install --upgrade pip
+      - name: Install dependencies
+        run: |
+          pipenv install --dev
+          pipenv run pip3 install typing-extensions
+      - name: Run code formatter
+        run: pipenv run black src/
+      - name: Run static analysis
+        run: |
+          pipenv run mypy --install-types --non-interactive src/
+          pipenv run mypy -p src
+      - name: Run unit tests
+        run: pipenv run pytest -vv -s -m unit

Pipfile

@@ -0,0 +1,19 @@
+[[source]]
+url = "https://pypi.org/simple"
+verify_ssl = true
+name = "pypi"
+
+[packages]
+ecdsa = "==0.18.0"
+requests = "==2.28.2"
+
+[dev-packages]
+black = "==23.3.0"
+pytest = "==7.3.1"
+pytest-mock = "==3.10.0"
+mypy = "==1.3.0"
+pytest-mypy-plugins = "==1.11.1"
+pytest-cov = "==4.1.0"
+
+[requires]
+python_version = "3"

Pipfile.lock

@@ -82,7 +82,7 @@ Facades : **`MERCHANT`**
 ```python
 today = date.today().strftime("%Y%m%d")
 date_start = (date.today() - timedelta(days=100)).strftime("%Y%m%d")
-ledger = bitpay.get_ledger(Currency.USD, date_start, today)
+ledger = bitpay.get_ledger_entries(Currency.USD, date_start, today)
 print(ledger)
 ```
 

docs/ledger.md

@@ -0,0 +1,9 @@
+[pytest]
+minversion = 7.0
+testpaths = tests
+python_files = test_*.py
+pythonpath = src
+addopts = "--import-mode=importlib"
+markers =
+    unit: Unit test
+    functional: Functional test

pytest.ini

@@ -1,2 +1,10 @@
 [metadata]
-description-file = README.md
+description-file = README.md
+
+[mypy]
+disallow_untyped_defs = True
+ignore_missing_imports = True
+no_implicit_optional = True
+check_untyped_defs = True
+show_error_codes = True
+warn_unused_ignores = True

requirements.txt

@@ -7,7 +7,7 @@
     name="bitpay",
     package_dir={"": "src"},
     packages=setuptools.find_packages(where="src"),
-    version="3.4.2203",
+    version="4.0.0",
     description="Accept bitcoin with BitPay",
     author="Antonio Buedo",
     author_email="[email protected]",

setup.cfg

@@ -0,0 +1 @@
+bitpay.config.json

setup.py

@@ -1,13 +1,17 @@
 import os
 import json
+from typing import Optional
+
 import requests
 
 from bitpay.utils.key_utils import *
 from bitpay.exceptions.bitpay_exception import BitPayException
 
 # Will be set to Test otherwise
 private_key_name = "private_key.pem"  # Add here the name for your Private key
-private_key_path = os.path.join(os.path.abspath(os.curdir), private_key_name)
+private_key_path: Optional[str] = os.path.join(
+    os.path.abspath(os.curdir), private_key_name
+)
 plain_private_key = None
 proxy = None
 api_url = None
@@ -16,7 +20,7 @@
 payout_token = None
 
 
-def select_env():
+def select_env() -> None:
     global environment
     try:
         print("Select target environment: ")
@@ -29,21 +33,21 @@ def select_env():
         else:
             select_env()
 
-        set_environment(environment)
+        set_environment(environment)  # type: ignore
         select_create_key()
     except BitPayException as exe:
         print(exe)
 
 
-def set_environment(env):
+def set_environment(env: str) -> None:
     global api_url
     if env == "Test":
         api_url = "https://test.bitpay.com"
     else:
         api_url = "https://bitpay.com"
 
 
-def select_create_key():
+def select_create_key() -> None:
     try:
         input_value = input(
             "Press enter to generate a brand new key or enter your private key location:"
@@ -56,15 +60,15 @@ def select_create_key():
         print(exe)
 
 
-def create_new_key():
+def create_new_key() -> None:
     try:
-        private_key = generate_pem()
+        private_key = generate_pem()  # type: ignore
         store_key(private_key)
     except BitPayException as exe:
         print(exe)
 
 
-def store_key(private_key):
+def store_key(private_key: str) -> None:
     global plain_private_key, private_key_path
     try:
         print("Select the way you want to store your private key:")
@@ -89,7 +93,7 @@ def store_key(private_key):
         print(exe)
 
 
-def select_tokens(private_key):
+def select_tokens(private_key: str) -> None:
     try:
         print("Select the tokens that you would like to request:")
         input_value = input("Press M for merchant, P for payout, or B for both: \n")
@@ -102,12 +106,12 @@ def select_tokens(private_key):
         print(exe)
 
 
-def request_tokens(token_type, private_key):
+def request_tokens(token_type: str, private_key: str) -> None:
     global merchant_token
     global payout_token
 
     try:
-        sin = get_sin_from_pem(private_key)
+        sin = get_sin_from_pem(private_key)  # type: ignore
         url = "%s/tokens" % api_url
         headers = {"content-type": "application/json", "X-accept-version": "2.0.0"}
 
@@ -148,7 +152,7 @@ def request_tokens(token_type, private_key):
         print(exe)
 
 
-def update_config_file():
+def update_config_file() -> None:
     try:
         config = {
             "BitPayConfiguration": {
@@ -187,7 +191,7 @@ def update_config_file():
         print(exe)
 
 
-def load_key():
+def load_key() -> None:
     # TODO: Need to implement this function
     pass