fix: handle paypal payment recipt

handle paypal payment recipt url

SONIC-784

commerce_coordinator/apps/commercetools/catalog_info/constants.py

@@ -81,3 +81,5 @@ class Languages:
 STRIPE_PAYMENT_STATUS_INTERFACE_CODE_SUCCEEDED = "succeeded"
 
 EDX_STRIPE_PAYMENT_INTERFACE_NAME = "stripe_edx"
+
+EDX_PAYPAL_PAYMENT_INTERFACE_NAME = "paypal_edx"

commerce_coordinator/apps/commercetools/catalog_info/edx_utils.py

@@ -65,6 +65,11 @@ def get_edx_payment_intent_id(order: CTOrder) -> Union[str, None]:
     return None
 
 
+def get_edx_payment_service_provider(order: CTOrder) -> Union[str, None]:
+    for pr in order.payment_info.payments:
+        return pr.obj.payment_method_info.payment_interface
+
+
 def get_edx_order_workflow_state_key(order: CTOrder) -> Optional[str]:
     order_workflow_state = None
     if order.state and order.state.obj:  # it should never be that we have one and not the other. # pragma no cover

commerce_coordinator/apps/commercetools/pipeline.py

@@ -12,8 +12,10 @@
 from openedx_filters.exceptions import OpenEdxFilterException
 from requests import HTTPError
 
+from commerce_coordinator.apps.commercetools.catalog_info.constants import EDX_STRIPE_PAYMENT_INTERFACE_NAME
 from commerce_coordinator.apps.commercetools.catalog_info.edx_utils import (
     get_edx_payment_intent_id,
+    get_edx_payment_service_provider,
     get_edx_refund_amount
 )
 from commerce_coordinator.apps.commercetools.clients import CommercetoolsAPIClient
@@ -108,20 +110,23 @@ def run_filter(self, active_order_management_system, order_number, **kwargs):  #
             duration = (datetime.now() - start_time).total_seconds()
             log.info(f"[Performance Check] get_order_by_number call took {duration} seconds")
 
+            psp = get_edx_payment_service_provider(ct_order)
+
+            intent_id = None
+            if psp == EDX_STRIPE_PAYMENT_INTERFACE_NAME:
+                intent_id = get_edx_payment_intent_id(ct_order)
+
             ret_val = {
                 "order_data": ct_order,
+                "psp": psp,
+                "payment_intent_id": intent_id
             }
-
-            intent_id = get_edx_payment_intent_id(ct_order)
-
             if intent_id:
                 ct_payment = ct_api_client.get_payment_by_key(intent_id)
-                ret_val['payment_intent_id'] = intent_id
                 ret_val['amount_in_cents'] = get_edx_refund_amount(ct_order)
                 ret_val['has_been_refunded'] = has_refund_transaction(ct_payment)
                 ret_val['payment_data'] = ct_payment
             else:
-                ret_val['payment_intent_id'] = None
                 ret_val['amount_in_cents'] = decimal.Decimal(0.00)
                 ret_val['has_been_refunded'] = False
                 ret_val['payment_data'] = None

commerce_coordinator/apps/paypal/apps.py

@@ -0,0 +1,8 @@
+"""
+App configuration for the Commerce Coordinator stripe app.
+"""
+from django.apps import AppConfig
+
+
+class PaypalConfig(AppConfig):
+    name = 'commerce_coordinator.apps.paypal'

commerce_coordinator/apps/paypal/pipeline.py

@@ -0,0 +1,31 @@
+"""
+Pipelines for paypal app
+"""
+
+import logging
+from urllib.parse import urlencode, urljoin
+
+from django.conf import settings
+from openedx_filters import PipelineStep
+
+from commerce_coordinator.apps.commercetools.catalog_info.constants import EDX_PAYPAL_PAYMENT_INTERFACE_NAME
+
+logger = logging.getLogger(__name__)
+
+
+class GetPayPalPaymentReceipt(PipelineStep):
+    """ Purpare PayPal payment recipt  """
+
+    def run_filter(self, psp=None, **params):
+        if psp == EDX_PAYPAL_PAYMENT_INTERFACE_NAME:
+            base_url = settings.PAYPAL_BASE_URL
+            activities_url = settings.PAYPAL_USER_ACTIVITES_URL
+            query_params = {'free_text_search': params.get('order_number')}
+
+            redirect_url = urljoin(base_url, activities_url) + '?' + urlencode(query_params)
+
+            return {
+                'redirect_url': redirect_url,
+            }
+
+        return None

commerce_coordinator/apps/paypal/tests/__init__.py

@@ -0,0 +1 @@
+"""Constants for PayPal app tests."""

commerce_coordinator/apps/paypal/tests/test_pipeline.py

@@ -0,0 +1,27 @@
+""" PayPal Pipeline Tests"""
+from unittest import TestCase
+
+from django.conf import settings
+from django.test import override_settings
+
+from commerce_coordinator.apps.paypal.pipeline import GetPayPalPaymentReceipt
+
+
+class TestGetPayPalPaymentReceipt(TestCase):
+    """A pytest Test case for the GetPayPalPaymentReceipt Pipeline Step"""
+
+    @override_settings(
+        PAYPAL_BASE_URL="https://paypal.com/",
+        PAYPAL_USER_ACTIVITES_URL="myaccount/activities/"
+    )
+    def test_pipeline_step(self):
+        order_number = '123'
+        paypal_payment_pipe = GetPayPalPaymentReceipt("test_pipe", None)
+
+        result: dict = paypal_payment_pipe.run_filter(
+            edx_lms_user_id=1,
+            psp='paypal_edx',
+            order_number=order_number
+        )
+        redirect_url = f"{settings.PAYPAL_BASE_URL}{settings.PAYPAL_USER_ACTIVITES_URL}?free_text_search={order_number}"
+        self.assertEqual(redirect_url, result['redirect_url'])

commerce_coordinator/apps/stripe/pipeline.py

@@ -7,6 +7,7 @@
 from openedx_filters import PipelineStep
 from stripe.error import StripeError
 
+from commerce_coordinator.apps.commercetools.catalog_info.constants import EDX_STRIPE_PAYMENT_INTERFACE_NAME
 from commerce_coordinator.apps.core.constants import PaymentMethod, PipelineCommand
 from commerce_coordinator.apps.stripe.clients import StripeAPIClient
 from commerce_coordinator.apps.stripe.constants import Currency
@@ -214,26 +215,29 @@ class GetPaymentIntentReceipt(PipelineStep):
     """ Pull the receipt if the payment_intent is set """
 
     # pylint: disable=unused-argument
-    def run_filter(self, payment_intent_id=None, **params):
+    def run_filter(self, payment_intent_id=None, psp=None, **params):
         tag = type(self).__name__
 
-        if payment_intent_id is None:
+        if psp == EDX_STRIPE_PAYMENT_INTERFACE_NAME and payment_intent_id is None:
             logger.debug(f'[{tag}] payment_intent_id not set, skipping.')
             return PipelineCommand.CONTINUE.value
 
-        stripe_api_client = StripeAPIClient()
-
-        payment_intent = stripe_api_client.retrieve_payment_intent(
-            payment_intent_id,
-            ["latest_charge"]
-        )
-
-        receipt_url = payment_intent.latest_charge.receipt_url
+        elif psp == EDX_STRIPE_PAYMENT_INTERFACE_NAME:
+            stripe_api_client = StripeAPIClient()
+            payment_intent = stripe_api_client.retrieve_payment_intent(
+                payment_intent_id,
+                ["latest_charge"]
+            )
+            receipt_url = payment_intent.latest_charge.receipt_url
 
-        return {
-            'payment_intent': payment_intent,
-            'redirect_url': receipt_url
-        }
+            return {
+                'payment_intent': payment_intent,
+                'redirect_url': receipt_url
+            }
+        else:
+            return {
+                'psp': psp
+            }
 
 
 class RefundPaymentIntent(PipelineStep):

commerce_coordinator/settings/base.py

@@ -53,6 +53,7 @@ def root(*path_fragments):
     'commerce_coordinator.apps.frontend_app_payment.apps.FrontendAppPaymentConfig',
     'commerce_coordinator.apps.lms.apps.LmsConfig',
     'commerce_coordinator.apps.stripe.apps.StripeConfig',
+    'commerce_coordinator.apps.paypal.apps.PaypalConfig',
     'commerce_coordinator.apps.titan.apps.TitanConfig',
     'commerce_coordinator.apps.commercetools',
 )
@@ -374,7 +375,8 @@ def root(*path_fragments):
             'commerce_coordinator.apps.ecommerce.pipeline.GetLegacyEcommerceReceiptRedirectUrl',
             'commerce_coordinator.apps.rollout.pipeline.HaltIfRedirectUrlProvided',
             'commerce_coordinator.apps.commercetools.pipeline.FetchOrderDetailsByOrderNumber',
-            'commerce_coordinator.apps.stripe.pipeline.GetPaymentIntentReceipt'
+            'commerce_coordinator.apps.stripe.pipeline.GetPaymentIntentReceipt',
+            'commerce_coordinator.apps.paypal.pipeline.GetPayPalPaymentReceipt'
         ]
     },
     "org.edx.coordinator.lms.order.refund.requested.v1": {
@@ -474,3 +476,7 @@ def root(*path_fragments):
 SEGMENT_KEY = None
 
 FAVICON_URL = "https://edx-cdn.org/v3/prod/favicon.ico"
+
+# PAYPAL SETTINIS
+PAYPAL_BASE_URL = ""
+PAYPAL_USER_ACTIVITES_URL = ""

docs/commerce_coordinator.apps.paypal.migrations.rst

@@ -0,0 +1,10 @@
+commerce\_coordinator.apps.paypal.migrations package
+====================================================
+
+Module contents
+---------------
+
+.. automodule:: commerce_coordinator.apps.paypal.migrations
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/commerce_coordinator.apps.paypal.rst

@@ -0,0 +1,38 @@
+commerce\_coordinator.apps.paypal package
+=========================================
+
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   commerce_coordinator.apps.paypal.migrations
+   commerce_coordinator.apps.paypal.tests
+
+Submodules
+----------
+
+commerce\_coordinator.apps.paypal.apps module
+---------------------------------------------
+
+.. automodule:: commerce_coordinator.apps.paypal.apps
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+commerce\_coordinator.apps.paypal.pipeline module
+-------------------------------------------------
+
+.. automodule:: commerce_coordinator.apps.paypal.pipeline
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: commerce_coordinator.apps.paypal
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/commerce_coordinator.apps.paypal.tests.rst

@@ -0,0 +1,21 @@
+commerce\_coordinator.apps.paypal.tests package
+===============================================
+
+Submodules
+----------
+
+commerce\_coordinator.apps.paypal.tests.test\_pipeline module
+-------------------------------------------------------------
+
+.. automodule:: commerce_coordinator.apps.paypal.tests.test_pipeline
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: commerce_coordinator.apps.paypal.tests
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/commerce_coordinator.apps.rst

@@ -17,6 +17,7 @@ Subpackages
    commerce_coordinator.apps.lms
    commerce_coordinator.apps.rollout
    commerce_coordinator.apps.stripe
+   commerce_coordinator.apps.paypal
    commerce_coordinator.apps.titan
 
 Module contents