mangopay4-python-sdk 3.52.0__tar.gz

mangopay4_python_sdk-3.52.0/DESCRIPTION.md

@@ -0,0 +1 @@
+This SDK is a client library for interacting with the Mangopay API.

mangopay4_python_sdk-3.52.0/LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 MANGOPAY
+
+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.
+

mangopay4_python_sdk-3.52.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include LICENSE
+include MANIFEST.in
+include README.md
+include DESCRIPTION.md
+include Makefile
+
+recursive-include mangopay *
+recursive-include tests *

mangopay4_python_sdk-3.52.0/Makefile

@@ -0,0 +1,8 @@
+install:
+	pip install -r requirements/base.txt
+
+test:
+	nosetests -s tests --with-coverage --cover-erase --cover-package=tests
+
+release:
+	python setup.py sdist register upload -s

mangopay4_python_sdk-3.52.0/PKG-INFO

@@ -0,0 +1,53 @@
+Metadata-Version: 2.4
+Name: mangopay4-python-sdk
+Version: 3.52.0
+Summary: A client library written in python to work with mangopay v2 api
+Home-page: https://github.com/Mangopay/mangopay2-python-sdk
+Author: Mangopay (www.mangopay.com)
+Author-email: support@mangopay.com
+License: MIT
+Keywords: mangopay api development emoney sdk
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+License-File: LICENSE
+Requires-Dist: requests
+Requires-Dist: simplejson
+Requires-Dist: blinker
+Requires-Dist: six
+Requires-Dist: pytz
+Provides-Extra: dev
+Requires-Dist: responses; extra == "dev"
+Requires-Dist: nose; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: httplib2; extra == "dev"
+Requires-Dist: pyopenssl; extra == "dev"
+Requires-Dist: ndg-httpsclient; extra == "dev"
+Requires-Dist: pyasn1; extra == "dev"
+Requires-Dist: exam; extra == "dev"
+Provides-Extra: test
+Requires-Dist: responses; extra == "test"
+Requires-Dist: nose; extra == "test"
+Requires-Dist: coverage; extra == "test"
+Requires-Dist: httplib2; extra == "test"
+Requires-Dist: pyopenssl; extra == "test"
+Requires-Dist: ndg-httpsclient; extra == "test"
+Requires-Dist: pyasn1; extra == "test"
+Requires-Dist: exam; extra == "test"
+Dynamic: author
+Dynamic: author-email
+Dynamic: classifier
+Dynamic: description
+Dynamic: home-page
+Dynamic: keywords
+Dynamic: license
+Dynamic: license-file
+Dynamic: provides-extra
+Dynamic: requires-dist
+Dynamic: summary
+
+This SDK is a client library for interacting with the Mangopay API.

mangopay4_python_sdk-3.52.0/README.md

@@ -0,0 +1,53 @@
+Mangopay Python SDK
+=================================================
+
+MangopaySDK is a Python client library to work with
+[Mangopay REST API](http://docs.mangopay.com/api-references/).
+
+
+Installation
+------------
+
+mangopaysdk requires: 
+
+* [requests](https://pypi.python.org/pypi/requests)
+* [blinker](https://pypi.python.org/pypi/blinker)
+
+To install the package:
+
+```
+    pip install mangopay4-python-sdk
+```
+
+By installing this package with [pip](https://pypi.python.org/pypi/pip), all dependencies will be installed for you.
+
+
+Documentation
+-------------
+
+For documentation and examples of usage for the Mangopay API please refer to: [API references](https://docs.mangopay.com/api-references/)
+
+See [docs](https://github.com/Mangopay/mangopay2-python-sdk/blob/master/docs/usage.rst) to find examples.
+
+License
+-------------------------------------------------
+MangopaySDK is distributed under MIT license, see LICENSE file.
+
+Contact
+-------------------------------------------------
+Report bugs or suggest features using [issue tracker at GitHub](https://github.com/Mangopay/mangopay2-python-sdk/issues).
+
+
+Account creation
+-------------------------------------------------
+You can get yourself a free sandbox account or sign up for a production account by [registering on the Mangopay site](https://www.mangopay.com/start/) (note that validation of your production account involves several steps, so think about doing it in advance of when you actually want to go live).
+
+Inspiration
+-----------
+
+The data model of python-mangopay is highly inspired by [peewee](https://github.com/coleifer/peewee).
+
+Credits
+-----------
+
+The inital basis of this SDK was generously coded and donated by [Ulule](https://www.ulule.com/)

mangopay4_python_sdk-3.52.0/mangopay/__init__.py

@@ -0,0 +1,27 @@
+client_id = None
+apikey = None
+api_url = 'https://api.mangopay.com/v2.01/'
+api_sandbox_url = 'https://api.sandbox.mangopay.com/v2.01/'
+temp_dir = None
+api_version = 2.01
+sandbox = True
+uk_header_flag = False
+
+package_version = None
+try:
+    with open('./setup.py', 'r') as f:
+        for line in f:
+            if line.startswith('    version'):
+                package_version = line.split('=')[1].replace("'", "").replace(",", "").replace("\n", "")
+except:
+    None
+
+
+from .api import APIRequest  # noqa
+from .utils import memoize
+
+
+def _get_default_handler():
+    return APIRequest()
+
+get_default_handler = memoize(_get_default_handler, {}, 0)

mangopay4_python_sdk-3.52.0/mangopay/api.py

@@ -0,0 +1,381 @@
+# -*- coding: utf-8 -*-
+from __future__ import print_function
+from __future__ import unicode_literals
+
+import logging
+import platform
+import time
+
+import requests
+import six
+from requests.exceptions import ConnectionError, Timeout
+
+import mangopay
+from mangopay.auth import AuthorizationTokenManager
+from mangopay.ratelimit import RateLimit
+from .exceptions import APIError, DecodeError
+from .signals import request_finished, request_started, request_error
+from .utils import reraise_as
+
+try:
+    import urllib.parse as urlrequest
+except ImportError:
+    import urllib as urlrequest
+
+try:
+    import simplejson as json
+except ImportError:
+    import json
+
+
+logger = logging.getLogger('mangopay')
+
+requests_session = requests.Session()
+rate_limits = None
+
+
+class APIRequest(object):
+
+    def __init__(self, client_id=None, apikey=None, api_url=None, api_sandbox_url=None, sandbox=None,
+                 timeout=30.0, storage_strategy=None, proxies=None, uk_header_flag=False):
+        global rate_limits
+        rate_limits = None
+        if (sandbox is None and mangopay.sandbox) or sandbox:
+            self.api_url = api_sandbox_url or mangopay.api_sandbox_url
+        else:
+            self.api_url = api_url or mangopay.api_url
+
+        self.client_id = client_id or mangopay.client_id
+        self.apikey = apikey or mangopay.apikey
+        self.auth_manager = AuthorizationTokenManager(self, storage_strategy)
+        self.timeout = timeout
+        self.proxies = proxies
+        self.uk_header_flag = uk_header_flag or mangopay.uk_header_flag
+
+    def set_rate_limit(self, rate_limit):
+        global rate_limits
+        rate_limits = rate_limit
+
+
+    def get_rate_limits(self):
+        return rate_limits
+
+    def request(self, method, url, data=None, idempotency_key=None, oauth_request=False, without_client_id=False,
+                is_v3=False, **params):
+        return self.custom_request(method, url, data, idempotency_key, oauth_request, True,
+                                   without_client_id, is_v3, **params)
+
+    def multipart_request(self, method, url, file, file_name, idempotency_key=None, oauth_request=False, is_v3=False):
+        return self.custom_multipart_request(method, url, file, file_name, idempotency_key, oauth_request, is_v3)
+
+    def custom_request(self, method, url, data=None, idempotency_key=None, oauth_request=False,
+                       is_mangopay_request=False, without_client_id=False, is_v3=False, **params):
+        params = params or {}
+
+        headers = {}
+
+        if is_mangopay_request:
+            headers['User-Agent'] = 'Mangopay-SDK/' + str(
+                mangopay.package_version) + ' (Python/' + platform.python_version() + ')'
+            if oauth_request:
+                headers['Authorization'] = self.auth_manager.basic_token()
+                headers['Content-Type'] = 'application/x-www-form-urlencoded'
+            else:
+                headers['Authorization'] = self.auth_manager.get_token()
+                headers['Content-Type'] = 'application/json'
+
+            if idempotency_key:
+                headers['Idempotency-Key'] = idempotency_key
+
+            if self.uk_header_flag:
+                logger.warning('uk_header_flag is deprecated and will be removed in future versions')
+                headers['x-tenant-id'] = 'uk'
+        else:
+            if "data_XXX" in params:
+                params[str("data")] = params[str("data_XXX")]
+                params.__delitem__(str("data_XXX"))
+                headers['Content-Type'] = 'application/x-www-form-urlencoded'
+
+        # truncated_data = None
+
+        encoded_params = urlrequest.urlencode(params)
+
+        if is_mangopay_request:
+            if oauth_request or without_client_id:
+                url = self.api_url + url
+            else:
+                url = self._absolute_url(url, encoded_params)
+        else:
+            url = '%s?%s' % (url, encoded_params)
+
+        if is_v3:
+            url = url.replace('v2.01', 'V3.0')
+
+        if data or data == {}:
+            # truncated_data = truncatechars(copy.copy(data))
+
+            data = json.dumps(data, default=lambda x: x.to_api_json())
+
+        logger.debug('DATA[IN -> %s]\n\t- headers: %s\n\t- content: %s', url, headers, data)
+
+        ts = time.time()
+
+        # signal:
+        request_started.send(url=url, data=data, headers=headers, method=method)
+
+        try:
+            result = requests_session.request(method, url,
+                                              data=data,
+                                              headers=headers,
+                                              timeout=self.timeout,
+                                              proxies=self.proxies)
+        except ConnectionError as e:
+            msg = '{}'.format(e)
+
+            if msg:
+                msg = '%s: %s' % (type(e).__name__, msg)
+            else:
+                msg = type(e).__name__
+
+            reraise_as(APIError(msg))
+
+        except Timeout as e:
+            msg = '{}'.format(e)
+
+            if msg:
+                msg = '%s: %s' % (type(e).__name__, msg)
+            else:
+                msg = type(e).__name__
+
+            reraise_as(APIError(msg))
+        laps = time.time() - ts
+
+        # signal:
+        request_finished.send(url=url,
+                              data=data,
+                              headers=headers,
+                              method=method,
+                              result=result,
+                              laps=laps)
+
+        logger.debug('DATA[OUT -> %s][%2.3f seconds]\n\t- status_code: %s\n\t- headers: %s\n\t- content: %s',
+            url,
+            laps,
+            result.status_code,
+            result.headers,
+            result.text if hasattr(result, 'text') else result.content
+        )
+
+        self.read_response_headers(result.headers)
+
+        if result.status_code not in (requests.codes.ok, requests.codes.not_found,
+                                      requests.codes.created, requests.codes.accepted,
+                                      requests.codes.no_content):
+            self._create_apierror(result, url=url, data=data, method=method)
+        elif result.status_code == requests.codes.no_content or (result.status_code == requests.codes.ok and result.content == b''):
+            return result, None
+        else:
+            if result.content:
+                try:
+                    content = result.content
+
+                    if six.PY3:
+                        content = content.decode('utf-8')
+
+                    return result, json.loads(content)
+                except ValueError:
+                    if result.content.startswith(b'data='):
+                        return result.content
+                    self._create_decodeerror(result, url=url)
+            else:
+                self._create_decodeerror(result, url=url)
+
+    def custom_multipart_request(self, method, url, file, file_name, idempotency_key=None, oauth_request=False, is_v3=False):
+        if not isinstance(file, bytes):
+            raise TypeError("The 'file' parameter must be of type 'bytes'.")
+
+        headers = {'User-Agent': 'Mangopay-SDK/' + str(
+            mangopay.package_version) + ' (Python/' + platform.python_version() + ')'}
+
+        if oauth_request:
+            headers['Authorization'] = self.auth_manager.basic_token()
+        else:
+            headers['Authorization'] = self.auth_manager.get_token()
+
+        if idempotency_key:
+            headers['Idempotency-Key'] = idempotency_key
+
+        if self.uk_header_flag:
+            logger.warning('uk_header_flag is deprecated and will be removed in future versions')
+            headers['x-tenant-id'] = 'uk'
+
+        if oauth_request:
+            url = self.api_url + url
+        else:
+            url = self._absolute_url(url, '')
+
+        if is_v3:
+            url = url.replace('v2.01', 'V3.0')
+
+        files = {'file': (file_name, file)}
+
+        logger.debug('DATA[IN -> %s]\n\t- headers: %s\n\t- file: %s', url, headers, 'provided' if file else 'none')
+        ts = time.time()
+
+        request_started.send(url=url, data=None, headers=headers, method=method)
+
+        try:
+            result = requests_session.request(method, url,
+                                              files=files,
+                                              headers=headers,
+                                              timeout=self.timeout,
+                                              proxies=self.proxies)
+        except ConnectionError as e:
+            msg = f'{type(e).__name__}: {e}' if str(e) else type(e).__name__
+            reraise_as(APIError(msg))
+
+        except Timeout as e:
+            msg = f'{type(e).__name__}: {e}' if str(e) else type(e).__name__
+            reraise_as(APIError(msg))
+
+        laps = time.time() - ts
+
+        request_finished.send(url=url,
+                              data=None,
+                              headers=headers,
+                              method=method,
+                              result=result,
+                              laps=laps)
+
+        logger.debug('DATA[OUT -> %s][%2.3f seconds]\n\t- status_code: %s\n\t- headers: %s\n\t- content: %s',
+                     url,
+                     laps,
+                     result.status_code,
+                     result.headers,
+                     result.text if hasattr(result, 'text') else result.content
+                     )
+
+        self.read_response_headers(result.headers)
+
+        if result.status_code not in (requests.codes.ok, requests.codes.not_found,
+                                      requests.codes.created, requests.codes.accepted,
+                                      requests.codes.no_content):
+            self._create_apierror(result, url=url, data=None, method=method)
+        elif result.status_code == requests.codes.no_content or (
+                result.status_code == requests.codes.ok and result.content == b''):
+            return result, None
+        else:
+            if result.content:
+                try:
+                    content = result.content
+                    if six.PY3:
+                        content = content.decode('utf-8')
+                    return result, json.loads(content)
+                except ValueError:
+                    if result.content.startswith(b'data='):
+                        return result.content
+                    self._create_decodeerror(result, url=url)
+            else:
+                self._create_decodeerror(result, url=url)
+
+    def read_response_headers(self, headers):
+        rate_limit_reset = headers.get('x-ratelimit-reset')
+        rate_limit_remaining = headers.get('x-ratelimit-remaining')
+        rate_limit_made = headers.get('x-ratelimit')
+
+        if rate_limit_reset is not None and rate_limit_remaining is not None and rate_limit_made is not None:
+            rate_limit_reset = rate_limit_reset.split(',')
+            rate_limit_remaining = rate_limit_remaining.split(',')
+            rate_limit_made = rate_limit_made.split(',')
+
+            if len(rate_limit_reset) == len(rate_limit_remaining) and len(rate_limit_reset) == len(rate_limit_made):
+                current_time = int(time.time())
+                updated_rate_limits = []
+
+                for i, rlr in enumerate(rate_limit_reset):
+                    rate_limit = RateLimit()
+                    number_of_minutes = (int(rate_limit_reset[i].strip()) - current_time) / 60
+
+                    if number_of_minutes <= 15:
+                        rate_limit.interval_minutes = 15
+                    elif number_of_minutes <= 30:
+                        rate_limit.interval_minutes = 30
+                    elif number_of_minutes <= 60:
+                        rate_limit.interval_minutes = 60
+                    elif number_of_minutes <= 60 * 24:
+                        rate_limit.interval_minutes = 60 * 24
+
+                    rate_limit.reset_time_millis = int(rate_limit_reset[i].strip())
+                    rate_limit.calls_remaining = int(rate_limit_remaining[i].strip())
+                    rate_limit.calls_made = int(rate_limit_made[i].strip())
+                    updated_rate_limits.append(rate_limit)
+
+                if len(updated_rate_limits) > 0:
+                    self.set_rate_limit(updated_rate_limits)
+
+            else:
+                logger.debug("Could not set rate limits: headers length should be the same")
+        else:
+            logger.debug("Could not set rate limits: missing headers")
+
+    def _absolute_url(self, url, encoded_params):
+        pattern = '%s%s%s'
+
+        if encoded_params:
+            pattern = '%s%s?%s'
+
+        return pattern % (self.api_url, self._construct_api_url(url), encoded_params)
+
+    def _construct_api_url(self, relative_url):
+        return '%s%s' % (self.client_id, relative_url)
+
+    def _create_apierror(self, result, url=None, data=None, method=None):
+        text = result.text if hasattr(result, 'text') else result.content
+
+        status_code = result.status_code
+
+        headers = result.headers
+
+        logger.error('API ERROR: status_code: %s | url: %s | method: %s | data: %r | headers: %s | content: %s',
+            status_code,
+            url,
+            method,
+            data,
+            headers,
+            text,
+        )
+
+        request_error.send(url=url, status_code=status_code, headers=headers)
+
+        try:
+            content = result.json()
+        except ValueError:
+            content = None
+
+        raise APIError(text, code=status_code, content=content, headers=headers)
+
+    def _create_decodeerror(self, result, url=None):
+
+        text = result.text if hasattr(result, 'text') else result.content
+
+        status_code = result.status_code
+
+        headers = result.headers
+
+        logger.error('DECODE ERROR: status_code: %s | headers: %s | content: %s',
+            status_code,
+            headers,
+            text,
+        )
+
+        request_error.send(url=url, status_code=status_code, headers=headers)
+
+        try:
+            content = result.json()
+        except ValueError:
+            content = None
+
+        raise DecodeError(text,
+                          code=status_code,
+                          headers=headers,
+                          content=content)

mangopay4_python_sdk-3.52.0/mangopay/auth.py

@@ -0,0 +1,130 @@
+import base64
+import hashlib
+import json
+import os
+import stat
+import tempfile
+import time
+
+import six
+
+import mangopay
+from mangopay.exceptions import AuthenticationError
+
+
+class StorageStrategyBase(object):
+
+    def get(self, env_key):
+        pass
+
+    def store(self, token, env_key):
+        pass
+
+
+class StaticStorageStrategy(StorageStrategyBase):
+
+    _dict = dict()
+
+    def get(self, env_key):
+        return StaticStorageStrategy._dict[env_key]
+
+    def store(self, token, env_key):
+        StaticStorageStrategy._dict[env_key] = token
+
+
+class FileStorageStrategy(StorageStrategyBase):
+
+    def __init__(self):
+        if mangopay.temp_dir is None:
+            mangopay.temp_dir = tempfile.gettempdir()
+
+    def get(self, env_key):
+        cache_path = os.path.join(mangopay.temp_dir, "cached-data." + env_key + ".py")
+
+        if not os.path.exists(cache_path):
+            return None
+
+        with open(cache_path, 'rb') as f:
+            serialized_obj = f.read().decode('UTF-8')
+            try:
+                cached = json.loads(serialized_obj[1:])
+            except:
+                cached = None
+
+        return cached
+
+    def store(self, token, env_key):
+        cache_path = os.path.join(mangopay.temp_dir, "cached-data." + env_key + ".py")
+        if token is None:
+            return
+
+        with open(cache_path, 'w') as f:
+            os.chmod(cache_path, stat.S_IRUSR | stat.S_IWUSR)
+            serialized_obj = "#" + json.dumps(token)
+            f.write(serialized_obj)
+
+
+class AuthorizationTokenManager(object):
+
+    def __init__(self, handler, storage_strategy):
+        self._handler = handler
+        self.authorization = ApiAuthorization(handler)
+        if storage_strategy:
+            self.storage_strategy = storage_strategy
+        else:
+            self.storage_strategy = StaticStorageStrategy()
+
+    def basic_token(self):
+        return self.authorization.basic_token()
+
+    def get_token(self):
+        try:
+            token = self.storage_strategy.get(self.get_evn_key())
+        except KeyError:
+            token = None
+
+        if not token or not token['timestamp'] or token['timestamp'] <= time.time():
+            auth_result = self.authorization.oauth_token()
+            if auth_result[0].status_code == 200:
+                token = auth_result[1]
+            else:
+                return None
+            token['timestamp'] = time.time() + (int(token['expires_in']) - 30)
+            self.set_token(token)
+
+        return token['token_type'] + ' ' + token['access_token']
+
+    def set_token(self, token):
+        self.storage_strategy.store(token, self.get_evn_key())
+
+    def get_evn_key(self):
+        return hashlib.md5((self._handler.client_id + self._handler.api_url +
+                            self._handler.apikey).encode('utf-8')).hexdigest()
+
+
+class ApiAuthorization(object):
+
+    def __init__(self, handler):
+        self._handler = handler
+
+    def oauth_token(self):
+        result = self._handler.request(method='POST',
+                                       url='oauth/token',
+                                       data={'grant_type': 'client_credentials'},
+                                       oauth_request=True)
+        return result
+
+    def basic_token(self):
+        if self._handler.client_id is None or self._handler.apikey is None:
+            raise AuthenticationError(
+                'Authentication failed. (Please set your Mangopay API username '
+                'and password using "mangopay.client_id = CLIENT_ID" '
+                'and "mangopay.apikey = APIKEY").')
+
+        credentials = '%s:%s' % (self._handler.client_id, self._handler.apikey)
+        credentials = base64.b64encode(credentials.encode('ascii'))
+
+        if six.PY3:
+            credentials = credentials.decode('utf-8')
+
+        return 'Basic %s' % credentials