v2.0.0

* Automated Payouts
* Support to BlockBee Checkout page
* Various improvements

Author: arianoangelo

README.md

@@ -3,8 +3,11 @@
 """
 
 import requests
+import json
 from requests.models import PreparedRequest
 
+from urllib.parse import urljoin, urlencode
+
 
 class BlockBeeHelper:
     BLOCKBEE_URL = 'https://api.blockbee.io/'
@@ -47,7 +50,7 @@ def get_address(self):
         if self.own_address is not None:
             params['address'] = self.own_address
 
-        _address = BlockBeeHelper.process_request(coin, endpoint='create', params=params)
+        _address = BlockBeeHelper.process_request_get(coin, endpoint='create', params=params)
         if _address:
             self.payment_address = _address['address_in']
             return _address
@@ -71,7 +74,7 @@ def get_logs(self):
             'apikey': self.api_key
         }
 
-        _logs = BlockBeeHelper.process_request(coin, endpoint='logs', params=params)
+        _logs = BlockBeeHelper.process_request_get(coin, endpoint='logs', params=params)
 
         if _logs:
             return _logs
@@ -82,16 +85,21 @@ def get_qrcode(self, value='', size=300):
         if self.coin is None:
             return None
 
+        address = self.payment_address
+
+        if not address:
+            address = self.get_address().get('address_in')
+
         params = {
-            'address': self.payment_address,
+            'address': address,
             'size': size,
             'apikey': self.api_key
         }
 
         if value:
             params['value'] = value
 
-        _qrcode = BlockBeeHelper.process_request(self.coin, endpoint='qrcode', params=params)
+        _qrcode = BlockBeeHelper.process_request_get(self.coin, endpoint='qrcode', params=params)
 
         if _qrcode:
             return _qrcode
@@ -108,7 +116,7 @@ def get_conversion(self, from_coin, value, api_key):
             'apikey': api_key
         }
 
-        _value = BlockBeeHelper.process_request(self.coin, endpoint='convert', params=params)
+        _value = BlockBeeHelper.process_request_get(self.coin, endpoint='convert', params=params)
 
         if _value:
             return _value
@@ -120,7 +128,7 @@ def get_info(coin, api_key):
         if api_key is None:
             raise Exception("API Key Missing")
 
-        _info = BlockBeeHelper.process_request(coin, endpoint='info', params={
+        _info = BlockBeeHelper.process_request_get(coin, endpoint='info', params={
             'apikey': api_key
         })
 
@@ -161,33 +169,110 @@ def get_estimate(coin, addresses=1, priority='default', api_key=''):
             'apikey': api_key
         }
 
-        _estimate = BlockBeeHelper.process_request(coin, endpoint='estimate', params=params)
+        _estimate = BlockBeeHelper.process_request_get(coin, endpoint='estimate', params=params)
 
         if _estimate:
             return _estimate
 
         return None
 
     @staticmethod
-    def create_payout(coin, address, value, api_key=''):
-        if api_key is None:
-            raise Exception("API Key Missing")
+    def create_payout(coin, payout_requests, api_key, process=False):
+        if not payout_requests:
+            raise ValueError('No requests provided')
+
+        body = {'outputs': payout_requests}
+
+        endpoint = 'payout/request/bulk'
+
+        if process:
+            endpoint = endpoint + '/process'
+
+        _payout = BlockBeeHelper.process_request_post(coin, endpoint, api_key, body, True)
+
+        if _payout.get('status') == 'success':
+            return _payout
+
+        return None
+
+    @staticmethod
+    def list_payouts(coin, status = 'all', page = 1, api_key = '', payout_request=False):
+        if not api_key:
+            return None
 
         params = {
-            'value': value,
-            'address': address,
-            'apikey': api_key
+            'apikey': api_key,
+            'status': status,
+            'page': page
         }
 
-        _payout = BlockBeeHelper.process_request(coin, endpoint='payout/request/create', params=params)
+        endpoint = 'payout/list'
+
+        if payout_request:
+            endpoint = 'payout/request/list'
+
+        _payouts = BlockBeeHelper.process_request_get(coin, endpoint, params)
+
+        if _payouts.get('status') == 'success':
+            return _payouts
+
+        return None
+
+    @staticmethod
+    def get_payout_wallet(coin, api_key, balance=False):
+        wallet = BlockBeeHelper.process_request_get(coin, 'payout/address', {'apikey': api_key})
+
+        if wallet.get('status') != 'success':
+            return None
+
+        output = {'address': wallet.get('address')}
+
+        if balance:
+            wallet_balance = BlockBeeHelper.process_request_get(coin, 'payout/balance', {'apikey': api_key})
+
+            if wallet_balance.get('status') == 'success':
+                output['balance'] = wallet_balance.get('balance')
+
+        return output
 
-        if _payout:
+    @staticmethod
+    def create_payout_by_ids(api_key, payout_ids):
+        if not payout_ids:
+            raise ValueError('Please provide the Payout Request(s) ID(s)')
+
+        _payout = BlockBeeHelper.process_request_post('', 'payout/create', api_key, {'request_ids': ','.join(map(str, payout_ids))})
+
+        if _payout.get('status') == 'success':
             return _payout
 
         return None
 
     @staticmethod
-    def process_request(coin='', endpoint='', params=None):
+    def process_payout(api_key, payout_id):
+        if not payout_id:
+            return None
+
+        _process = BlockBeeHelper.process_request_post('', 'payout/process', api_key, {'payout_id': payout_id})
+
+        if _process.get('status') == 'success':
+            return _process
+
+        return None
+
+    @staticmethod
+    def check_payout_status(api_key, payout_id):
+        if not id:
+            raise ValueError('Please provide the Payout ID')
+
+        _status = BlockBeeHelper.process_request_post('', 'payout/status', api_key, {'payout_id': payout_id})
+
+        if _status.get('status') == 'success':
+            return _status
+
+        return None
+
+    @staticmethod
+    def process_request_get(coin='', endpoint='', params=None):
         if coin != '':
             coin += '/'
 
@@ -202,3 +287,28 @@ def process_request(coin='', endpoint='', params=None):
         )
 
         return response.json()
+
+    @staticmethod
+    def process_request_post(coin='', endpoint='', apiKey='', body=None, isJson=False):
+        if coin:
+            coin_path = coin.replace('_', '/') + '/'
+        else:
+            coin_path = ''
+
+        url = urljoin(BlockBeeHelper.BLOCKBEE_URL, f"{coin_path}{endpoint}/")
+        url += '?' + urlencode({'apikey': apiKey})
+
+        headers = {
+            'Host': BlockBeeHelper.BLOCKBEE_HOST,
+        }
+
+        if isJson:
+            headers['Content-Type'] = 'application/json'
+            data = json.dumps(body)
+        else:
+            headers['Content-Type'] = 'application/x-www-form-urlencoded'
+            data = urlencode(body)
+
+        response = requests.post(url, headers=headers, data=data)
+
+        return response.json()

blockbee/BlockBee.py

@@ -0,0 +1,114 @@
+"""
+BlockBee's Checkout Python Helper
+"""
+
+import requests
+from requests.models import PreparedRequest
+
+
+class BlockBeeCheckoutHelper:
+    BLOCKBEE_URL = 'https://api.blockbee.io/'
+    BLOCKBEE_HOST = 'api.blockbee.io'
+
+    def __init__(self, api_key, parameters=None, bb_params=None):
+        if parameters is None:
+            parameters = {}
+
+        if bb_params is None:
+            bb_params = {}
+
+        if api_key is None:
+            raise Exception("API Key Missing")
+
+        self.parameters = parameters
+        self.bb_params = bb_params
+        self.api_key = api_key
+
+    def payment_request(self, redirect_url, value):
+        if redirect_url is None or value is None:
+            return None
+
+        if self.parameters:
+            req = PreparedRequest()
+            req.prepare_url(redirect_url, self.parameters)
+            redirect_url = req.url
+
+        params = {
+            'redirect_url': redirect_url,
+            'apikey': self.api_key,
+            'value': value,
+            **self.bb_params}
+
+        _request = BlockBeeCheckoutHelper.process_request('', endpoint='checkout/request', params=params)
+        if _request['status'] == 'success':
+            return _request
+        return None
+
+    @staticmethod
+    def payment_logs(token, api_key):
+        if token is None or api_key is None:
+            return None
+
+        params = {
+            'apikey': api_key,
+            'token': token
+        }
+
+        _request = BlockBeeCheckoutHelper.process_request('', endpoint='checkout/logs', params=params)
+
+        if _request['status'] == 'success':
+            return _request
+        return None
+
+    def deposit_request(self, notify_url):
+        if notify_url is None:
+            return None
+
+        if self.parameters:
+            req = PreparedRequest()
+            req.prepare_url(notify_url, self.parameters)
+            notify_url = req.url
+
+        params = {
+            'notify_url': notify_url,
+            'apikey': self.api_key,
+            **self.bb_params}
+
+        _request = BlockBeeCheckoutHelper.process_request('', endpoint='deposit/request', params=params)
+
+        if _request['status'] == 'success':
+            return _request
+        return None
+
+    @staticmethod
+    def deposit_logs(token, api_key):
+        if token is None or api_key is None:
+            return None
+
+        params = {
+            'apikey': api_key,
+            'token': token
+        }
+
+        _request = BlockBeeCheckoutHelper.process_request('', endpoint='deposit/logs', params=params)
+
+        if _request['status'] == 'success':
+            return _request
+        return None
+
+    @staticmethod
+    def process_request(coin='', endpoint='', params=None):
+        if coin != '':
+            coin += '/'
+
+        response = requests.get(
+            url="{base_url}{coin}{endpoint}/".format(
+                base_url=BlockBeeCheckoutHelper.BLOCKBEE_URL,
+                coin=coin.replace('_', '/'),
+                endpoint=endpoint,
+            ),
+            params=params,
+            headers={'Host': BlockBeeCheckoutHelper.BLOCKBEE_HOST},
+        )
+
+        return response.json()

blockbee/BlockBeeCheckout.py

@@ -1 +1,2 @@
-from .BlockBee import BlockBeeHelper
+from .BlockBee import BlockBeeHelper
+from .BlockBeeCheckout import BlockBeeCheckoutHelper

blockbee/__init__.py

@@ -10,7 +10,7 @@
 
     name='python-blockbee',
 
-    version='1.1.1',
+    version='2.0.0',
 
     packages=find_packages(),