Merge pull request #171 from Adyen/develop

Release 7.1.0

Author: michaelpaul

.github/CODEOWNERS

@@ -1 +1 @@
-* @AlexandrosMor @martinsrenato @rikterbeek @acampos1916 @candemiralp
+* @AlexandrosMor @rikterbeek @acampos1916 @candemiralp @michaelpaul @jillingk

.github/workflows/unittest.yml

@@ -0,0 +1,26 @@
+name: Python package
+
+on:
+  pull_request:
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.6','3.7', '3.8']
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v2
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install tox
+          sudo apt install libcurl4-openssl-dev
+      - name: Test with tox
+        run: tox

.travis.yml

@@ -20,7 +20,8 @@
     AdyenPayment,
     AdyenThirdPartyPayout,
     AdyenHPP,
-    AdyenCheckoutApi
+    AdyenCheckoutApi,
+    AdyenTerminal
 )
 
 from .httpclient import HTTPClient
@@ -35,6 +36,7 @@ def __init__(self, **kwargs):
         self.hpp = AdyenHPP(client=self.client)
         self.recurring = AdyenRecurring(client=self.client)
         self.checkout = AdyenCheckoutApi(client=self.client)
+        self.terminal = AdyenTerminal(client=self.client)
 
 
 _base_adyen_obj = Adyen()
@@ -44,3 +46,4 @@ def __init__(self, **kwargs):
 payout = _base_adyen_obj.payout
 checkout = _base_adyen_obj.checkout
 binlookup = _base_adyen_obj.binlookup
+terminal = _base_adyen_obj.terminal

Adyen/__init__.py

@@ -89,6 +89,7 @@ def __init__(
         api_payment_version=None,
         api_payout_version=None,
         api_recurring_version=None,
+        api_terminal_version=None,
     ):
         self.username = username
         self.password = password
@@ -115,6 +116,7 @@ def __init__(
         self.api_payment_version = api_payment_version or settings.API_PAYMENT_VERSION
         self.api_payout_version = api_payout_version or settings.API_PAYOUT_VERSION
         self.api_recurring_version = api_recurring_version or settings.API_RECURRING_VERSION
+        self.api_terminal_version = api_terminal_version or settings.API_TERMINAL_VERSION
 
     def _determine_api_url(self, platform, service, action):
         """This returns the Adyen API endpoint based on the provided platform,
@@ -138,6 +140,9 @@ def _determine_api_url(self, platform, service, action):
             api_version = self.api_payout_version
         elif service == "BinLookup":
             api_version = self.api_bin_lookup_version
+        elif service == "terminal":
+            base_uri = settings.BASE_TERMINAL_URL.format(platform)
+            api_version = self.api_terminal_version
         else:
             api_version = self.api_payment_version
         return '/'.join([base_uri, service, api_version, action])
@@ -157,13 +162,14 @@ def _determine_hpp_url(platform, action):
         result = '/'.join([base_uri, service])
         return result
 
-    def _determine_checkout_url(self, platform, action):
+    def _determine_checkout_url(self, platform, action, path_param=None):
         """This returns the Adyen API endpoint based on the provided platform,
         service and action.
 
         Args:
             platform (str): Adyen platform, ie 'live' or 'test'.
             action (str): the API action to perform.
+            path_param Optional[(str)]: a generic id that can be used to modify a payment e.g. paymentPspReference.
         """
         api_version = self.api_checkout_version
         if platform == "test":
@@ -183,6 +189,16 @@ def _determine_checkout_url(self, platform, action):
             action = "payments/details"
         if action == "paymentsResult":
             action = "payments/result"
+        if action == "cancels":
+            action = "/cancels"
+        if action == "paymentsCancelsWithReference":
+            action = f"payments/{path_param}/cancels"
+        if action == "paymentsCapture":
+            action = f"/payments/{path_param}/captures"
+        if action == "paymentsReversals":
+            action = f"payments/{path_param}/reversals"
+        if action == "payments/Refunds":
+            action = f"payments/{path_param}/refunds"
         if action == "originKeys":
             api_version = self.api_checkout_utility_version
         if action == "paymentMethodsBalance":
@@ -449,7 +465,7 @@ class instance.
                                              status_code, headers, message)
         return adyen_result
 
-    def call_checkout_api(self, request_data, action, idempotency_key=None,
+    def call_checkout_api(self, request_data, action, idempotency_key=None, path_param=None,
                           **kwargs):
         """This will call the checkout adyen api. xapi key merchant_account,
         and platform are pulled from root module level and or self object.
@@ -464,6 +480,7 @@ def call_checkout_api(self, request_data, action, idempotency_key=None,
                 https://docs.adyen.com/api-explorer/#/CheckoutService
             service (str): This is the API service to be called.
             action (str): The specific action of the API service to be called
+            path_param (str): This is used to pass the id or referenceID to the API sercie
         """
         if not self.http_init:
             self._init_http_client()
@@ -530,7 +547,7 @@ def call_checkout_api(self, request_data, action, idempotency_key=None,
         headers = {}
         if idempotency_key:
             headers[self.IDEMPOTENCY_HEADER_NAME] = idempotency_key
-        url = self._determine_checkout_url(platform, action)
+        url = self._determine_checkout_url(platform, action, path_param)
 
         raw_response, raw_request, status_code, headers = \
             self.http_client.request(url, json=request_data,
@@ -594,7 +611,7 @@ def _handle_response(self, url, raw_response, raw_request,
         Returns:
             AdyenResult: Result object if successful.
         """
-        if (status_code != 200 and status_code !=  201):
+        if (status_code != 200 and status_code != 201):
             response = {}
             # If the result can't be parsed into json, most likely is raw html.
             # Some response are neither json or raw html, handle them here:
@@ -629,7 +646,7 @@ def _handle_response(self, url, raw_response, raw_request,
         else:
             try:
                 response = json_lib.loads(raw_response)
-                psp = headers.get('pspReference', response.get('pspReference'))
+                psp = self._get_psp(response, headers)
                 return AdyenResult(message=response, status_code=status_code,
                                    psp=psp, raw_request=raw_request,
                                    raw_response=raw_response)
@@ -777,3 +794,11 @@ def _error_from_hpp(html):
         match_obj = re.search(r'>Error:\s*(.*?)<br', html)
         if match_obj:
             return match_obj.group(1)
+
+    @staticmethod
+    def _get_psp(response, header):
+        psp_ref = response.get('pspReference')
+        if psp_ref == "":
+            return header.get('pspReference')
+        else:
+            return psp_ref

Adyen/client.py

@@ -279,6 +279,13 @@ class AdyenCheckoutApi(AdyenServiceBase):
         payments/details
         originKeys
 
+        Modifications:
+        capture
+        refunds
+        cancels
+        reversals
+
+
     Please refer to the checkout documentation for specifics around the API.
     https://docs.adyen.com/online-payments
 
@@ -321,6 +328,42 @@ def payment_result(self, request=None, **kwargs):
         action = "paymentsResult"
         return self.client.call_checkout_api(request, action, **kwargs)
 
+    def payments_captures(self, request, idempotency_key=None, path_param=None, **kwargs):
+        if path_param == "":
+            raise ValueError(
+                'must contain a pspReference in the path_param, path_param cannot be empty'
+            )
+        action = "paymentsCapture"
+        return self.client.call_checkout_api(request, action, idempotency_key, path_param, **kwargs)
+
+    def payments_cancels_without_reference(self, request, idempotency_key=None, **kwargs):
+        action = "cancels"
+        return self.client.call_checkout_api(request, action, idempotency_key, **kwargs)
+
+    def payments_cancels_with_reference(self, request, idempotency_key=None, path_param=None, **kwargs):
+        if path_param == "":
+            raise ValueError(
+                'must contain a pspReference in the path_param, path_param cannot be empty'
+            )
+        action = "paymentsCancelsWithReference"
+        return self.client.call_checkout_api(request, action, idempotency_key, path_param, **kwargs)
+
+    def payments_reversals(self, request, idempotency_key=None, path_param=None, **kwargs):
+        if path_param == "":
+            raise ValueError(
+                'must contain a pspReference in the path_param, path_param cannot be empty'
+            )
+        action = "paymentsReversals"
+        return self.client.call_checkout_api(request, action, idempotency_key, path_param, **kwargs)
+
+    def payments_refunds(self, request, idempotency_key=None, path_param=None, **kwargs):
+        if path_param == "":
+            raise ValueError(
+                'must contain a pspReference in the path_param, path_param cannot be empty'
+            )
+        action = "paymentsRefunds"
+        return self.client.call_checkout_api(request, action, idempotency_key, path_param, **kwargs)
+
     def origin_keys(self, request=None, **kwargs):
         action = "originKeys"
         return self.client.call_checkout_api(request, action, **kwargs)
@@ -367,3 +410,40 @@ def get_cost_estimate(self, request="", **kwargs):
         action = "getCostEstimate"
 
         return self.client.call_api(request, self.service, action, **kwargs)
+
+
+class AdyenTerminal(AdyenServiceBase):
+    """This represents the Adyen API Terminal service.
+
+    API call currently implemented:
+        - assignTerminals
+        - findTerminal
+        - getStoreUnderAccount
+        - getTerminalDetails
+        - getTerminalsUnderAccount
+    Please refer to the Terminal Manual for specifics around the API.
+    https://docs.adyen.com/api-explorer/#/postfmapi/
+
+    Args:
+        client (AdyenAPIClient, optional): An API client for the service to
+            use. If not provided, a new API client will be created.
+    """
+
+    def __init__(self, client=None):
+        super(AdyenTerminal, self).__init__(client=client)
+        self.service = "terminal"
+
+    def assign_terminals(self, request="", **kwargs):
+        return self.client.call_api(request, self.service, "assignTerminals", **kwargs)
+
+    def find_terminal(self, request="", **kwargs):
+        return self.client.call_api(request, self.service, "findTerminal", **kwargs)
+
+    def get_stores_under_account(self, request="", **kwargs):
+        return self.client.call_api(request, self.service, "getStoresUnderAccount", **kwargs)
+
+    def get_terminal_details(self, request="", **kwargs):
+        return self.client.call_api(request, self.service, "getTerminalDetails", **kwargs)
+
+    def get_terminals_under_account(self, request="", **kwargs):
+        return self.client.call_api(request, self.service, "getTerminalsUnderAccount", **kwargs)

Adyen/services.py

@@ -1,5 +1,6 @@
 # Those constants are used from the library only
 BASE_PAL_URL = "https://pal-{}.adyen.com/pal/servlet"
+BASE_TERMINAL_URL = "https://postfmapi-{}.adyen.com/postfmapi"
 PAL_LIVE_ENDPOINT_URL_TEMPLATE = "https://{}-pal-live" \
                                  ".adyenpayments.com/pal/servlet"
 BASE_HPP_URL = "https://{}.adyen.com/hpp"
@@ -12,5 +13,6 @@
 API_RECURRING_VERSION = "v49"
 API_PAYMENT_VERSION = "v64"
 API_PAYOUT_VERSION = "v64"
-LIB_VERSION = "7.0.0"
+API_TERMINAL_VERSION = "v1"
+LIB_VERSION = "7.1.0"
 LIB_NAME = "adyen-python-api-library"

Adyen/settings.py

@@ -35,6 +35,8 @@ def escape_val(val):
 
 
 def is_valid_hmac(dict_object, hmac_key):
+    dict_object = dict_object.copy()
+
     if 'additionalData' in dict_object:
         if dict_object['additionalData']['hmacSignature'] == "":
             raise ValueError("Must Provide hmacSignature in additionalData")
@@ -43,7 +45,7 @@ def is_valid_hmac(dict_object, hmac_key):
             del dict_object['additionalData']
             merchant_sign = generate_hpp_sig(dict_object, hmac_key)
             merchant_sign_str = merchant_sign.decode("utf-8")
-            return merchant_sign_str == expected_sign
+            return hmac.compare_digest(merchant_sign_str, expected_sign)
 
 
 def generate_notification_sig(dict_object, hmac_key):
@@ -85,6 +87,8 @@ def escape_val(val):
 
 
 def is_valid_hmac_notification(dict_object, hmac_key):
+    dict_object = dict_object.copy()
+
     if 'additionalData' in dict_object:
         if dict_object['additionalData']['hmacSignature'] == "":
             raise ValueError("Must Provide hmacSignature in additionalData")
@@ -93,4 +97,4 @@ def is_valid_hmac_notification(dict_object, hmac_key):
             del dict_object['additionalData']
             merchant_sign = generate_notification_sig(dict_object, hmac_key)
             merchant_sign_str = merchant_sign.decode("utf-8")
-            return merchant_sign_str == expected_sign
+            return hmac.compare_digest(merchant_sign_str, expected_sign)

Adyen/util.py

@@ -1,6 +1,6 @@
 # Adyen APIs Library for Python
 
-[![version](https://img.shields.io/badge/version-7.0.0-blue.svg)](https://docs.adyen.com/development-resources/libraries)
+[![version](https://img.shields.io/badge/version-7.1.0-blue.svg)](https://docs.adyen.com/development-resources/libraries)
 
 This is the officially supported Python library for using Adyen's APIs.
 
@@ -13,6 +13,7 @@ The library supports all APIs under the following services:
 * [Payouts API](https://docs.adyen.com/api-explorer/#/Payout/v64/overview): Endpoints for sending funds to your customers. Current supported version:  **v64**
 * [Orders API](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/orders): Endpoints for creating and canceling orders. Current supported version:  **v67**
 * [Utility API](https://docs.adyen.com/api-explorer/#/CheckoutService/v67/post/originKeys): This operation takes the origin domains and returns a JSON object containing the corresponding origin keys for the domains. Current supported version:  **v67**
+* [Terminal API](https://docs.adyen.com/api-explorer/#/postfmapi/v1/overview): Endpoints for interacting with POS terminals. **v1**
 
 For more information, refer to our [documentation](https://docs.adyen.com/) or the [API Explorer](https://docs.adyen.com/api-explorer/).
 
@@ -21,7 +22,7 @@ For more information, refer to our [documentation](https://docs.adyen.com/) or t
 
 -   [Adyen test account](https://docs.adyen.com/get-started-with-adyen)
 -   [API key](https://docs.adyen.com/development-resources/api-credentials#generate-api-key). For testing, your API credential needs to have the [API PCI Payments role](https://docs.adyen.com/development-resources/api-credentials#roles).
-- Python 2.7 or 3.6
+- Python 2.7 **(Deprecated)** or 3.6
 - Packages: requests or pycurl ( optional )
 
 

README.md

@@ -3,7 +3,7 @@
 setup(
     name='Adyen',
     packages=['Adyen'],
-    version='7.0.0',
+    version='7.1.0',
     maintainer='Adyen',
     maintainer_email='[email protected]',
     description='Adyen Python Api',