Better configuration defaults

Set PAYMENT_PROCESSORS to better defaults.
overhangio · Jul 11, 2019 · 5fdf566 · 5fdf566
1 parent 7638766
commit 5fdf566
Show file tree

Hide file tree

Showing 3 changed files with 57 additions and 3 deletions.
diff --git a/README.rst b/README.rst
@@ -51,7 +51,7 @@ Configuration
 ~~~~~~~~~~~~~
 
 - ``ECOMMERCE_HOST`` (default: ``"ecommerce.{{ LMS_HOST }}"``)
-- ``ECOMMERCE_PAYMENT_PROCESSORS`` (default: ``{cybersource: {}, paypal: {}}``)
+- ``ECOMMERCE_PAYMENT_PROCESSORS`` (default: ``{cybersource: {...}, paypal: {...}}`` See below for details.)
 - ``ECOMMERCE_ENABLED_PAYMENT_PROCESSORS``: (default: ``["cybersource", "paypal"]``)
 - ``ECOMMERCE_ENABLED_CLIENT_SIDE_PAYMENT_PROCESSORS`` (default: ``["cybersource"]``)
 - ``ECOMMERCE_EXTRA_PAYMENT_PROCESSOR_CLASSES`` (default: ``[]``)
@@ -69,6 +69,35 @@ Configuration
 - ``ECOMMERCE_WORKER_JWT_ISSUER`` (default: ``"ecommerce_worker"``)
 - ``ECOMMERCE_EXTRA_PIP_REQUIREMENTS`` (default: ``[]``)
 
+You will need to modify the ``ECOMMERCE_PAYMENT_PROCESSORS`` parameter to configure your payment providers credentials. By default, it is equal to::
+  
+  cybersource:
+    access_key: SET-ME-PLEASE
+    cancel_page_url: /checkout/cancel-checkout/
+    merchant_id: SET-ME-PLEASE
+    payment_page_url: https://testsecureacceptance.cybersource.com/pay
+    profile_id: SET-ME-PLEASE
+    receipt_page_url: /checkout/receipt/
+    secret_key: SET-ME-PLEASE
+    send_level_2_3_details: true
+    soap_api_url: https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor/CyberSourceTransaction_1.140.wsdl
+    sop_access_key: SET-ME-PLEASE
+    sop_payment_page_url: https://testsecureacceptance.cybersource.com/silent/pay
+    sop_profile_id: SET-ME-PLEASE
+    sop_secret_key: SET-ME-PLEASE
+    transaction_key: SET-ME-PLEASE
+  paypal:
+    cancel_url: /checkout/cancel-checkout/
+    client_id: SET-ME-PLEASE
+    client_secret: SET-ME-PLEASE
+    error_url: /checkout/error/
+    mode: sandbox
+    receipt_url: /checkout/receipt/
+    
+We suggest you modify this configuration, save it to ``ecommerce-config.yml`` and then load it with::
+  
+  tutor config save --set "ECOMMERCE_PAYMENT_PROCESSORS=$(cat ecommerce-config.yml)"
+
 Image customisation
 ~~~~~~~~~~~~~~~~~~~
 

diff --git a/setup.py b/setup.py
@@ -10,7 +10,7 @@
 
 setup(
     name="tutor-ecommerce",
-    version="0.1.0",
+    version="0.1.1",
     url="https://docs.tutor.overhang.io/",
     project_urls={
         "Documentation": "https://docs.tutor.overhang.io/",

diff --git a/tutorecommerce/plugin.py b/tutorecommerce/plugin.py
@@ -11,7 +11,32 @@
         "SECRET_KEY": "{{ 20|random_string }}",
         "OAUTH2_SECRET": "{{ 8|random_string }}",
         "API_KEY": "{{ 20|random_string }}",
-        "PAYMENT_PROCESSORS": {"cybersource": {}, "paypal": {}},
+        "PAYMENT_PROCESSORS": {
+            "cybersource": {
+                "merchant_id": "SET-ME-PLEASE",
+                "profile_id": "SET-ME-PLEASE",
+                "access_key": "SET-ME-PLEASE",
+                "secret_key": "SET-ME-PLEASE",
+                "transaction_key": "SET-ME-PLEASE",
+                "payment_page_url": "https://testsecureacceptance.cybersource.com/pay",
+                "receipt_page_url": "/checkout/receipt/",
+                "cancel_page_url": "/checkout/cancel-checkout/",
+                "soap_api_url": "https://ics2wstest.ic3.com/commerce/1.x/transactionProcessor/CyberSourceTransaction_1.140.wsdl",
+                "send_level_2_3_details": True,
+                "sop_profile_id": "SET-ME-PLEASE",
+                "sop_access_key": "SET-ME-PLEASE",
+                "sop_secret_key": "SET-ME-PLEASE",
+                "sop_payment_page_url": "https://testsecureacceptance.cybersource.com/silent/pay",
+            },
+            "paypal": {
+                "mode": "sandbox",
+                "client_id": "SET-ME-PLEASE",
+                "client_secret": "SET-ME-PLEASE",
+                "receipt_url": "/checkout/receipt/",
+                "cancel_url": "/checkout/cancel-checkout/",
+                "error_url": "/checkout/error/",
+            },
+        },
         "ENABLED_PAYMENT_PROCESSORS": ["cybersource", "paypal"],
         "ENABLED_CLIENT_SIDE_PAYMENT_PROCESSORS": ["cybersource"],
         "EXTRA_PAYMENT_PROCESSOR_CLASSES": [],