Fix to make shipping address from data passed from PayPal, per spec

paypal/express/urls.py

@@ -14,7 +14,7 @@
     url(r'^place-order/(?P<basket_id>\d+)/$', views.SuccessResponseView.as_view(),
         name='paypal-place-order'),
     # Callback for getting shipping options for a specific basket
-    url(r'^shipping-options/(?P<basket_id>\d+)/',
+    url(r'^shipping-options/(?P<basket_id>\d+)/(?P<country_code>\w+)?',
         csrf_exempt(views.ShippingOptionsView.as_view()),
         name='paypal-shipping-options'),
     # View for using PayPal as a payment method

paypal/express/views.py

@@ -389,6 +389,42 @@ def get_shipping_method(self, basket, shipping_address=None, **kwargs):
 
 class ShippingOptionsView(View):
 
+    def get(self, request, *args, **kwargs):
+        """
+        We use the shipping address given to use by PayPal to
+        determine the available shipping method
+        """
+        # Basket ID is passed within the URL path.  We need to do this as some
+        # shipping options depend on the user and basket contents.  PayPal do
+        # pass back details of the basket contents but it would be royal pain to
+        # reconstitute the basket based on those - easier to just to piggy-back
+        # the basket ID in the callback URL.
+        basket = get_object_or_404(Basket, id=kwargs['basket_id'])
+        user = basket.owner
+        if not user:
+            user = AnonymousUser()
+
+        # Create a shipping address instance using the data passed back
+        country_code = self.request.GET.get(
+            'SHIPTOCOUNTRY', None)
+        try:
+            country = Country.objects.get(iso_3166_1_a2=country_code)
+        except Country.DoesNotExist:
+            country = Country()
+
+        shipping_address = ShippingAddress(
+            line1=self.request.GET.get('SHIPTOSTREET', ''),
+            line2=self.request.GET.get('SHIPTOSTREET2', ''),
+            line4=self.request.GET.get('SHIPTOCITY', ''),
+            state=self.request.GET.get('SHIPTOSTATE', ''),
+            postcode=self.request.GET.get('SHIPTOZIP', ''),
+            country=country
+        )
+        methods = Repository().get_shipping_methods(
+            basket=basket, shipping_addr=shipping_address,
+            request=self.request, user=user)
+        return self.render_to_response(methods, basket)
+
     def post(self, request, *args, **kwargs):
         """
         We use the shipping address given to use by PayPal to
@@ -406,18 +442,18 @@ def post(self, request, *args, **kwargs):
 
         # Create a shipping address instance using the data passed back
         country_code = self.request.POST.get(
-            'PAYMENTREQUEST_0_SHIPTOCOUNTRY', None)
+            'SHIPTOCOUNTRY', None)
         try:
             country = Country.objects.get(iso_3166_1_a2=country_code)
         except Country.DoesNotExist:
             country = Country()
 
         shipping_address = ShippingAddress(
-            line1=self.request.POST.get('PAYMENTREQUEST_0_SHIPTOSTREET', ''),
-            line2=self.request.POST.get('PAYMENTREQUEST_0_SHIPTOSTREET2', ''),
-            line4=self.request.POST.get('PAYMENTREQUEST_0_SHIPTOCITY', ''),
-            state=self.request.POST.get('PAYMENTREQUEST_0_SHIPTOSTATE', ''),
-            postcode=self.request.POST.get('PAYMENTREQUEST_0_SHIPTOZIP', ''),
+            line1=self.request.POST.get('SHIPTOSTREET', ''),
+            line2=self.request.POST.get('SHIPTOSTREET2', ''),
+            line4=self.request.POST.get('SHIPTOCITY', ''),
+            state=self.request.POST.get('SHIPTOSTATE', ''),
+            postcode=self.request.POST.get('SHIPTOZIP', ''),
             country=country
         )
         methods = Repository().get_shipping_methods(
@@ -428,24 +464,29 @@ def post(self, request, *args, **kwargs):
     def render_to_response(self, methods, basket):
         pairs = [
             ('METHOD', 'CallbackResponse'),
+            ('CALLBACKVERSION', '61.0'),
             ('CURRENCYCODE', self.request.POST.get('CURRENCYCODE', 'GBP')),
         ]
-        for index, method in enumerate(methods):
-            charge = method.calculate(basket).incl_tax
-
-            pairs.append(('L_SHIPPINGOPTIONNAME%d' % index,
-                          six.text_type(method.name)))
-            pairs.append(('L_SHIPPINGOPTIONLABEL%d' % index,
-                          six.text_type(method.name)))
-            pairs.append(('L_SHIPPINGOPTIONAMOUNT%d' % index, charge))
-            # For now, we assume tax and insurance to be zero
-            pairs.append(('L_TAXAMT%d' % index, D('0.00')))
-            pairs.append(('L_INSURANCEAMT%d' % index, D('0.00')))
-            # We assume that the first returned method is the default one
-            pairs.append(('L_SHIPPINGOPTIONISDEFAULT%d' % index, 1 if index == 0 else 0))
+        if methods:
+            for index, method in enumerate(methods):
+                charge = method.calculate(basket).incl_tax
+
+                pairs.append(('L_SHIPPINGOPTIONNAME%d' % index,
+                              six.text_type(method.name)))
+                pairs.append(('L_SHIPPINGOPTIONLABEL%d' % index,
+                              six.text_type(method.description)))
+                pairs.append(('L_SHIPPINGOPTIONAMOUNT%d' % index, charge))
+                # For now, we assume tax and insurance to be zero
+                pairs.append(('L_TAXAMT%d' % index, D('0.00')))
+                pairs.append(('L_INSURANCEAMT%d' % index, D('0.00')))
+                # We assume that the first returned method is the default one
+                pairs.append(('L_SHIPPINGOPTIONISDEFAULT%d' % index,
+                              1 if index == 0 else 0))
         else:
             # No shipping methods available - we flag this up to PayPal indicating that we
             # do not ship to the shipping address.
             pairs.append(('NO_SHIPPING_OPTION_DETAILS', 1))
+
         payload = urlencode(pairs)
+        logger.debug("Basket #%s - returning postage costs payload = '%s'", basket.id, payload)
         return HttpResponse(payload)