Added explicit support for merchant defined user IDs

Author: MarkusH

CHANGELOG.md

@@ -2,7 +2,8 @@
 
 ## 5.3.0 (under development)
 
-* ...
+* Added explicit support for the `muid` argument to `get_add_url()`,
+  `get_buy_url()` and `get_subscribe_url()`.
 
 ## 5.2.0
 

laterpay/__init__.py

@@ -246,6 +246,7 @@ def _get_web_url(self,
                      consumable=False,
                      return_url=None,
                      failure_url=None,
+                     muid=None,
                      **kwargs):
 
         # filter out params with None value.
@@ -282,6 +283,9 @@ def _get_web_url(self,
         if failure_url:
             data['failure_url'] = failure_url
 
+        if muid:
+            data['muid'] = muid
+
         data.update(kwargs)
 
         base_url = "%s/%s" % (prefix, page_type)

tests/test_client.py

@@ -184,6 +184,19 @@ def test_web_url_failure_url(self):
         url = self.lp._get_web_url(self.item, 'PAGE_TYPE', failure_url=None)
         self.assertFalse(self.assertQueryString(url, 'failure_url'))
 
+    def test_web_url_muid(self):
+        # Default
+        url = self.lp._get_web_url(self.item, 'PAGE_TYPE')
+        self.assertFalse(self.assertQueryString(url, 'muid'))
+
+        # Given
+        url = self.lp._get_web_url(self.item, 'PAGE_TYPE', muid='0zA9-aZ09-0A9z')
+        self.assertQueryString(url, 'muid', value='0zA9-aZ09-0A9z')
+
+        # Omitted
+        url = self.lp._get_web_url(self.item, 'PAGE_TYPE', muid=None)
+        self.assertFalse(self.assertQueryString(url, 'muid'))
+
     def test_get_add_url(self):
         item = ItemDefinition(1, 'EUR20', 'http://example.net/t', 'title')
         url = self.lp.get_add_url(
@@ -195,6 +208,7 @@ def test_get_add_url(self):
             consumable=True,
             return_url='http://return.url/foo?bar=buz&lorem=ipsum',
             failure_url='http://failure.url/FOO?BAR=BUZ&LOREM=IPSUM',
+            muid='someone',
             something='else',
             BLUB=[u'u2', b'b1', b'b2', u'u1'],
         )
@@ -209,6 +223,7 @@ def test_get_add_url(self):
         self.assertQueryString(url, 'consumable', value='1')
         self.assertQueryString(url, 'return_url', value='http://return.url/foo?bar=buz&lorem=ipsum')
         self.assertQueryString(url, 'failure_url', value='http://failure.url/FOO?BAR=BUZ&LOREM=IPSUM')
+        self.assertQueryString(url, 'muid', value='someone')
         self.assertQueryString(url, 'something', value='else')
         self.assertQueryString(url, 'BLUB', value=[b'b1', 'b2', u'u1', 'u2'])
 
@@ -223,6 +238,7 @@ def test_get_buy_url(self):
             consumable=True,
             return_url='http://return.url/foo?bar=buz&lorem=ipsum',
             failure_url='http://failure.url/FOO?BAR=BUZ&LOREM=IPSUM',
+            muid='someone',
             something='else',
             BLUB=[u'u2', b'b1', b'b2', u'u1'],
         )
@@ -237,6 +253,7 @@ def test_get_buy_url(self):
         self.assertQueryString(url, 'consumable', value='1')
         self.assertQueryString(url, 'return_url', value='http://return.url/foo?bar=buz&lorem=ipsum')
         self.assertQueryString(url, 'failure_url', value='http://failure.url/FOO?BAR=BUZ&LOREM=IPSUM')
+        self.assertQueryString(url, 'muid', value='someone')
         self.assertQueryString(url, 'something', value='else')
         self.assertQueryString(url, 'BLUB', value=[b'b1', 'b2', u'u1', 'u2'])
 
@@ -248,6 +265,7 @@ def test_get_subscribe_url(self):
             dialog=False,
             return_url='http://return.url/foo?bar=buz&lorem=ipsum',
             failure_url='http://failure.url/FOO?BAR=BUZ&LOREM=IPSUM',
+            muid='someone',
             something='else',
             period=12345,
             BLUB=[u'u2', b'b1', b'b2', u'u1'],
@@ -261,6 +279,7 @@ def test_get_subscribe_url(self):
         self.assertTrue(url.startswith('https://web.laterpay.net/subscribe?'))
         self.assertQueryString(url, 'return_url', value='http://return.url/foo?bar=buz&lorem=ipsum')
         self.assertQueryString(url, 'failure_url', value='http://failure.url/FOO?BAR=BUZ&LOREM=IPSUM')
+        self.assertQueryString(url, 'muid', value='someone')
         self.assertQueryString(url, 'something', value='else')
         self.assertQueryString(url, 'period', value='12345')
         self.assertQueryString(url, 'BLUB', value=[b'b1', 'b2', u'u1', 'u2'])