Merge pull request #153 from Adyen/develop

Release 6.0.0

Author: AlexandrosMor

.gitignore

@@ -5,4 +5,5 @@
 releaseguide.md
 venv/
 .idea/
-.coverage
+.coverage
+.vagrant/

Adyen/client.py

@@ -83,6 +83,12 @@ def __init__(
         http_force=None,
         live_endpoint_prefix=None,
         http_timeout=30,
+        api_bin_lookup_version=None,
+        api_checkout_utility_version=None,
+        api_checkout_version=None,
+        api_payment_version=None,
+        api_payout_version=None,
+        api_recurring_version=None,
     ):
         self.username = username
         self.password = password
@@ -103,6 +109,12 @@ def __init__(
         self.http_force = http_force
         self.live_endpoint_prefix = live_endpoint_prefix
         self.http_timeout = http_timeout
+        self.api_bin_lookup_version = api_bin_lookup_version or settings.API_BIN_LOOKUP_VERSION
+        self.api_checkout_utility_version = api_checkout_utility_version or settings.API_CHECKOUT_UTILITY_VERSION
+        self.api_checkout_version = api_checkout_version or settings.API_CHECKOUT_VERSION
+        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
 
     def _determine_api_url(self, platform, service, action):
         """This returns the Adyen API endpoint based on the provided platform,
@@ -121,13 +133,13 @@ def _determine_api_url(self, platform, service, action):
             base_uri = settings.BASE_PAL_URL.format(platform)
 
         if service == "Recurring":
-            api_version = settings.API_RECURRING_VERSION
+            api_version = self.api_recurring_version
         elif service == "Payout":
-            api_version = settings.API_PAYOUT_VERSION
+            api_version = self.api_payout_version
         elif service == "BinLookup":
-            api_version = settings.API_BIN_LOOKUP_VERSION
+            api_version = self.api_bin_lookup_version
         else:
-            api_version = settings.API_PAYMENT_VERSION
+            api_version = self.api_payment_version
         return '/'.join([base_uri, service, api_version, action])
 
     @staticmethod
@@ -153,7 +165,7 @@ def _determine_checkout_url(self, platform, action):
             platform (str): Adyen platform, ie 'live' or 'test'.
             action (str): the API action to perform.
         """
-        api_version = settings.API_CHECKOUT_VERSION
+        api_version = self.api_checkout_version
         if platform == "test":
             base_uri = settings.ENDPOINT_CHECKOUT_TEST
         elif self.live_endpoint_prefix is not None and platform == "live":
@@ -172,7 +184,7 @@ def _determine_checkout_url(self, platform, action):
         if action == "paymentsResult":
             action = "payments/result"
         if action == "originKeys":
-            api_version = settings.API_CHECKOUT_UTILITY_VERSION
+            api_version = self.api_checkout_utility_version
         if action == "paymentMethodsBalance":
             action = "paymentMethods/balance"
         if action == "ordersCancel":
@@ -238,24 +250,18 @@ def call_api(
             /api-idempotency
             request_data (dict): The dictionary of the request to place. This
                 should be in the structure of the Adyen API.
-                https://docs.adyen.com/manuals/api-manual
+                https://docs.adyen.com/api-explorer
             service (str): This is the API service to be called.
             action (str): The specific action of the API service to be called
             idempotency (bool, optional): Whether the transaction should be
                 processed idempotently.
-                https://docs.adyen.com/manuals/api-manual#apiidempotency
+                https://docs.adyen.com/development-resources/api-idempotency
         Returns:
             AdyenResult: The AdyenResult is returned when a request was
                 successful.
         """
         if not self.http_init:
-            self.http_client = HTTPClient(
-                user_agent_suffix=self.USER_AGENT_SUFFIX,
-                lib_version=self.LIB_VERSION,
-                force_request=self.http_force,
-                timeout=self.http_timeout,
-            )
-            self.http_init = True
+            self._init_http_client()
 
         # username at self object has highest priority. fallback to root module
         # and ensure that it is set.
@@ -368,6 +374,15 @@ def call_api(
 
         return adyen_result
 
+    def _init_http_client(self):
+        self.http_client = HTTPClient(
+            user_agent_suffix=self.USER_AGENT_SUFFIX,
+            lib_version=self.LIB_VERSION,
+            force_request=self.http_force,
+            timeout=self.http_timeout,
+        )
+        self.http_init = True
+
     def call_hpp(self, message, action, hmac_key="", **kwargs):
         """This will call the adyen hpp. hmac_key and platform are pulled from
         root module level and or self object.
@@ -377,7 +392,7 @@ def call_hpp(self, message, action, hmac_key="", **kwargs):
         Args:
             request_data (dict): The dictionary of the request to place. This
                 should be in the structure of the Adyen API.
-                https://docs.adyen.com/manuals/api-manual
+                https://docs.adyen.com/online-payments/classic-integrations/hosted-payment-pages/hosted-payment-pages-api
             service (str): This is the API service to be called.
             action (str): The specific action of the API service to be called
         Returns:
@@ -387,10 +402,7 @@ def call_hpp(self, message, action, hmac_key="", **kwargs):
                 :param hmac_key:
         """
         if not self.http_init:
-            self.http_client = HTTPClient(self.USER_AGENT_SUFFIX,
-                                          self.LIB_VERSION,
-                                          self.http_force)
-            self.http_init = True
+            self._init_http_client()
 
         # hmac provided in function has highest priority. fallback to self then
         # root module and ensure that it is set.
@@ -449,15 +461,12 @@ def call_checkout_api(self, request_data, action, idempotency_key=None,
             /api-idempotency
             request_data (dict): The dictionary of the request to place. This
                 should be in the structure of the Adyen API.
-                https://docs.adyen.com/developers/checkout/api-integration
+                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
         """
         if not self.http_init:
-            self.http_client = HTTPClient(self.USER_AGENT_SUFFIX,
-                                          self.LIB_VERSION,
-                                          self.http_force)
-            self.http_init = True
+            self._init_http_client()
 
         # xapi at self object has highest priority. fallback to root module
         # and ensure that it is set.
@@ -497,7 +506,8 @@ def call_checkout_api(self, request_data, action, idempotency_key=None,
             "payments",
             "paymentSession",
             "paymentLinks",
-            "paymentMethodsBalance"
+            "paymentMethodsBalance",
+            "sessions"
         ]
 
         if action in with_app_info:
@@ -535,12 +545,8 @@ def call_checkout_api(self, request_data, action, idempotency_key=None,
         return adyen_result
 
     def hpp_payment(self, request_data, action, hmac_key="", **kwargs):
-
         if not self.http_init:
-            self.http_client = HTTPClient(self.USER_AGENT_SUFFIX,
-                                          self.LIB_VERSION,
-                                          self.http_force)
-            self.http_init = True
+            self._init_http_client()
 
         platform = self.platform
         if not isinstance(platform, str):
@@ -588,7 +594,7 @@ def _handle_response(self, url, raw_response, raw_request,
         Returns:
             AdyenResult: Result object if successful.
         """
-        if status_code != 200:
+        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:

Adyen/services.py

@@ -33,7 +33,7 @@ class AdyenRecurring(AdyenServiceBase):
 
     API calls currently implemented: listRecurringDetails and disable. Please
     refer to the Recurring Manual for specifics around the API.
-    https://docs.adyen.com/developers/recurring-manual
+    https://docs.adyen.com/online-payments/tokenization
 
     Args:
         client (AdyenAPIClient, optional): An API client for the service to
@@ -69,7 +69,7 @@ class AdyenHPP(AdyenServiceBase):
     This currently only implements the directory_lookup request which will
     return the list of payment methods available for given shopper. Please
     refer to the HPP manual and the directory lookup section for the specifics.
-    https://docs.adyen.com/developers/hpp-manual#directorylookup
+    https://docs.adyen.com/online-payments/classic-integrations/hosted-payment-pages/directory-lookup
 
     Args:
         client (AdyenAPIClient, optional): An API client for the service to
@@ -133,8 +133,8 @@ class AdyenPayment(AdyenServiceBase):
         capture
         refund
         cancelOrRefund
-    Please refer to the Recurring Manual for specifics around the API.
-    https://docs.adyen.com/developers/recurring-manual
+    Please refer to our API Explorer for specifics around these APIs.
+    https://docs.adyen.com/api-explorer/
 
     The AdyenPayment class, is accessible as adyen.payment.method(args)
 
@@ -225,9 +225,8 @@ def cancel_or_refund(self, request, idempotency_key=None, **kwargs):
 
 
 class AdyenThirdPartyPayout(AdyenServiceBase):
-    """This represents the Adyen API Third Party Payouts Service.
-
-    https://docs.adyen.com/developers/api-reference/third-party-payouts-api
+    """This represents the Adyen Payouts Service.
+    https://docs.adyen.com/api-explorer/#/Payout/overview
 
     The AdyenThirdPartyPayout class is accessible as adyen.payout.method(args)
 
@@ -281,7 +280,7 @@ class AdyenCheckoutApi(AdyenServiceBase):
         originKeys
 
     Please refer to the checkout documentation for specifics around the API.
-    https://docs.adyen.com/developers/checkout
+    https://docs.adyen.com/online-payments
 
     The AdyenPayment class, is accessible as adyen.payment.method(args)
 
@@ -326,6 +325,9 @@ def origin_keys(self, request=None, **kwargs):
         action = "originKeys"
         return self.client.call_checkout_api(request, action, **kwargs)
 
+    def sessions(self, request=None, **kwargs):
+        action = "sessions"
+        return self.client.call_checkout_api(request, action, **kwargs)
     # Orders endpoints
 
     # /paymentMethods/balance
@@ -349,7 +351,7 @@ class AdyenBinLookup(AdyenServiceBase):
 
     API call currently implemented: getCostEstimate.
     Please refer to the Bin Lookup Manual for specifics around the API.
-    https://docs.adyen.com/api-explorer/#/BinLookup/v50/overview
+    https://docs.adyen.com/api-explorer/#/BinLookup/
 
     Args:
         client (AdyenAPIClient, optional): An API client for the service to

Adyen/settings.py

@@ -7,10 +7,10 @@
 ENDPOINT_CHECKOUT_LIVE_SUFFIX = "https://{}-checkout-live" \
                                 ".adyenpayments.com/checkout"
 API_BIN_LOOKUP_VERSION = "v50"
-API_CHECKOUT_VERSION = "v67"
+API_CHECKOUT_VERSION = "v68"
 API_CHECKOUT_UTILITY_VERSION = "v1"
 API_RECURRING_VERSION = "v49"
 API_PAYMENT_VERSION = "v64"
 API_PAYOUT_VERSION = "v64"
-LIB_VERSION = "5.1.0"
+LIB_VERSION = "6.0.0"
 LIB_NAME = "adyen-python-api-library"

README.md

@@ -1,68 +1,85 @@
 [![Build Status](https://travis-ci.org/Adyen/adyen-python-api-library.svg?branch=master)](https://travis-ci.org/Adyen/adyen-python-api-library)
 [![Coverage Status](https://coveralls.io/repos/github/Adyen/adyen-python-api-library/badge.svg?branch=master)](https://coveralls.io/github/Adyen/adyen-python-api-library?branch=master)
 
-# Adyen APIs Library for Python
-
-This library simplifies working with Adyen APIs and allows you to integrate Adyen
-payments within any Python application.
-
-## Integration
-The Library supports all APIs under the following services:
-
-* checkout
-* checkout utility
-* payments
-* modifications
-* payouts
-* recurring
-
-## Requirements
-
+This is the officially supported Python library for using Adyen's APIs.
+## Integration 
+The library supports all APIs under the following services:
+ 
+* [Checkout API](https://docs.adyen.com/api-explorer/#/CheckoutService/v68/overview): Our latest integration for accepting online payments. Current supported version:  **v68**
+* [Payments API](https://docs.adyen.com/api-explorer/#/Payment/v64/overview): Our classic integration for online payments. Current supported version:  **v64**
+* [Recurring API](https://docs.adyen.com/api-explorer/#/Recurring/v49/overview): Endpoints for managing saved payment details. Current supported version:  **v49**
+* [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**
+ 
+For more information, refer to our [documentation](https://docs.adyen.com/) or the [API Explorer](https://docs.adyen.com/api-explorer/).
+ 
+ 
+## Prerequisites
+ 
+-   [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
 - Packages: requests or pycurl ( optional )
-- Adyen account. If you don't have this you can request it here: https://www.adyen.com/home/discover/test-account-signup#form
+ 
 
-## Installation
+ ## Installation
 
 ### For development propose
 
-Clone this repository and run ```make install```
+Clone this repository and run 
+~~~~ bash 
+make install
+~~~~
 
 ### For usage propose
 
-Use pip command: ```pip install Adyen```
-
-## Usage
-
-Create a class instance of the 'Adyen' class.
-
-```python
+Use pip command: 
+~~~~ bash 
+pip install Adyen
+~~~~
+
+## Using the library
+ 
+ 
+### General use with API key
+ 
+~~~~ python
 import Adyen
 
 ady = Adyen.Adyen()
 
-ady.payment.client.username = "webservice user name"
+ady.payment.client.xapikey = "YourXapikey"
 ady.payment.client.skin_code = "skin code for Hosted Payment pages"
 ady.payment.client.hmac = "HMAC key for skin code"
 ady.payment.client.platform = "test" # Environment to use the library in.
 ady.payment.client.merchant_account = "merchant account name from CA"
-ady.payment.client.password = "webservice user password"
-```
-
-## Documentation
-* https://docs.adyen.com/developers/development-resources/libraries
-* https://docs.adyen.com/developers/checkout
+~~~~
+ 
+### Example integration
+ 
+For a closer look at how our Python library works, clone our [example integration](https://github.com/adyen-examples/adyen-python-online-payments). This includes commented code, highlighting key features and concepts, and examples of API calls that can be made using the library.
 
-## Support
-If you have a feature request, or spotted a bug or a technical problem, create a GitHub issue. For other questions, contact our [support team](https://support.adyen.com/hc/en-us/requests/new?ticket_form_id=360000705420).
 
 ## Contributing
-We strongly encourage you to join us in contributing to this repository so everyone can benefit from:
-* New features and functionality
-* Resolved bug fixes and issues
-* Any general improvements
-
-Read our [**contribution guidelines**](CONTRIBUTING.md) to find out how.
-
+ 
+We encourage you to contribute to this repository, so everyone can benefit from new features, bug fixes, and any other improvements.
+ 
+ 
+Have a look at our [contributing guidelines](https://github.com/Adyen/adyen-python-api-library/blob/develop/CONTRIBUTING.md) to find out how to raise a pull request.
+ 
+ 
+## Support
+If you have a feature request, or spotted a bug or a technical problem, [create an issue here](https://github.com/Adyen/adyen-web/issues/new/choose).
+ 
+For other questions, [contact our Support Team](https://www.adyen.help/hc/en-us/requests/new?ticket_form_id=360000705420).
+ 
+ 
 ## Licence
-MIT license see LICENSE
+This repository is available under the [MIT license](https://github.com/Adyen/adyen-python-api-library/blob/master/LICENSE.md).
+ 
+ 
+## See also
+* [Example integration](https://github.com/adyen-examples/adyen-python-online-payments)
+* [Adyen docs](https://docs.adyen.com/)
+* [API Explorer](https://docs.adyen.com/api-explorer/)