Added /dialog/subscribe API

Author: MarkusH

CHANGELOG.md

@@ -4,6 +4,7 @@
 
 * Ignored HMAC character capitalization
   ([#93](https://github.com/laterpay/laterpay-client-python/issues/93))
+* Added support for ``/dialog/subscribe`` and LaterPay's subscription system
 
 ## 5.0.0
 

laterpay/__init__.py

@@ -26,6 +26,7 @@
 
 _PRICING_RE = re.compile(r'[A-Z]{3}\d+')
 _EXPIRY_RE = re.compile(r'^(\+?\d+)$')
+_SUB_ID_RE = re.compile(r'^[a-zA-Z0-9_-]{1,128}$')
 
 
 class InvalidTokenException(Exception):
@@ -62,7 +63,7 @@ class ItemDefinition(object):
     For Single item purchases: http://docs.laterpay.net/platform/dialogs/buy/
     """
 
-    def __init__(self, item_id, pricing, url, title, expiry=None):
+    def __init__(self, item_id, pricing, url, title, expiry=None, sub_id=None, period=None):
 
         for price in pricing.split(','):
             if not _PRICING_RE.match(price):
@@ -79,6 +80,22 @@ def __init__(self, item_id, pricing, url, title, expiry=None):
             'title': title,
             'expiry': expiry,
         }
+        if sub_id is not None:
+            if _SUB_ID_RE.match(sub_id):
+                self.data['sub_id'] = sub_id
+            else:
+                raise InvalidItemDefinition(
+                    "Invalid sub_id value '%s'. It can be any string consisting of lowercase or "
+                    "uppercase ASCII characters, digits, underscore and hyphen, the length of "
+                    "which is between 1 and 128 characters." % sub_id
+                )
+            if isinstance(period, int) and 3600 <= period <= 31536000:
+                self.data['period'] = period
+            else:
+                raise InvalidItemDefinition(
+                    "Period not set or invalid value '%s' for period. The subscription period "
+                    "must be an int in the range [3600, 31536000] (including)." % period
+                )
 
 
 class LaterPayClient(object):
@@ -282,6 +299,14 @@ def get_add_url(self, item_definition, *args, **kwargs):
         """
         return self._get_web_url(item_definition, 'add', *args, **kwargs)
 
+    def get_subscribe_url(self, item_definition, *args, **kwargs):
+        """
+        Get the URL at which a user can subscribe to an item.
+
+        http://docs.laterpay.net/platform/dialogs/subscribe/
+        """
+        return self._get_web_url(item_definition, 'subscribe', *args, **kwargs)
+
     def has_token(self):
         """
         Do we have an identifier token.

tests/test_client.py

@@ -19,14 +19,32 @@
 
 class TestItemDefinition(unittest.TestCase):
 
-    def test_item_definition(self):
+    def test_invalid_pricing(self):
         with self.assertRaises(InvalidItemDefinition):
             ItemDefinition(1, '', '', 'title')
+
+    def test_invalid_expiry(self):
         with self.assertRaises(InvalidItemDefinition):
             ItemDefinition(1, 'EUR20', 'http://foo.invalid', 'title', expiry="illegal123")
 
-        it = ItemDefinition(1, 'EUR20', 'http://example.com/t', 'title', expiry='+100')
+    def test_invalid_sub_id(self):
+        with self.assertRaisesRegexp(InvalidItemDefinition, r'^Invalid sub_id value '):
+            ItemDefinition(1, 'EUR20', 'http://example.com', 'title', sub_id='', period=3600)
+        with self.assertRaisesRegexp(InvalidItemDefinition, r'^Invalid sub_id value '):
+            ItemDefinition(1, 'EUR20', 'http://example.com', 'title', sub_id='a' * 129, period=3600)
+        with self.assertRaisesRegexp(InvalidItemDefinition, r'^Invalid sub_id value '):
+            ItemDefinition(1, 'EUR20', 'http://example.com', 'title', sub_id='ä', period=3600)
+
+    def test_invalid_period(self):
+        with self.assertRaisesRegexp(InvalidItemDefinition, r'Period not set or invalid value'):
+            ItemDefinition(1, 'EUR20', 'http://example.com/t', 'title', sub_id='a', period=3599)
+        with self.assertRaisesRegexp(InvalidItemDefinition, r'Period not set or invalid value'):
+            ItemDefinition(1, 'EUR20', 'http://example.com/t', 'title', sub_id='a', period=31536001)
+        with self.assertRaisesRegexp(InvalidItemDefinition, r'Period not set or invalid value'):
+            ItemDefinition(1, 'EUR20', 'http://example.com/t', 'title', sub_id='a', period='12345')
 
+    def test_item_definition(self):
+        it = ItemDefinition(1, 'EUR20', 'http://example.com/t', 'title', expiry='+100')
         self.assertEqual(it.data, {
             'article_id': 1,
             'expiry': '+100',
@@ -35,6 +53,22 @@ def test_item_definition(self):
             'url': 'http://example.com/t',
         })
 
+    def test_sub_id(self):
+        # Test sub_id_bounds
+        ItemDefinition(1, 'EUR20', 'http://example.com/t', 'title', sub_id='a', period=3600)
+        ItemDefinition(1, 'EUR20', 'http://example.com/t', 'title', sub_id='a' * 128, period=31536000)
+
+        it = ItemDefinition(1, 'EUR20', 'http://example.com/t', 'title', sub_id='abc', period=12345)
+        self.assertEqual(it.data, {
+            'article_id': 1,
+            'expiry': None,
+            'period': 12345,
+            'pricing': 'EUR20',
+            'sub_id': 'abc',
+            'title': 'title',
+            'url': 'http://example.com/t',
+        })
+
 
 class TestLaterPayClient(unittest.TestCase):
 
@@ -206,6 +240,31 @@ def test_get_buy_url(self):
         self.assertQueryString(url, 'something', value='else')
         self.assertQueryString(url, 'BLUB', value=[b'b1', 'b2', u'u1', 'u2'])
 
+    def test_get_subscribe_url(self):
+        item = ItemDefinition(1, 'EUR20', 'http://example.net/t', 'title', sub_id='a0_-9Z', period=12345)
+        url = self.lp.get_subscribe_url(
+            item,
+            product_key='some-product-key',
+            dialog=False,
+            return_url='http://return.url/foo?bar=buz&lorem=ipsum',
+            failure_url='http://failure.url/FOO?BAR=BUZ&LOREM=IPSUM',
+            something='else',
+            period=12345,
+            BLUB=[u'u2', b'b1', b'b2', u'u1'],
+        )
+        self.assertFalse(
+            self.assertQueryString(url, 'expiry'),
+            'expiry url param is "None". Should be omitted.'
+        )
+        self.assertQueryString(url, 'sub_id', value='a0_-9Z')
+        self.assertQueryString(url, 'product_key', value='some-product-key')
+        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, 'something', value='else')
+        self.assertQueryString(url, 'period', value='12345')
+        self.assertQueryString(url, 'BLUB', value=[b'b1', 'b2', u'u1', 'u2'])
+
     def test_get_login_dialog_url_with_use_dialog_api_false(self):
         url = self.lp.get_login_dialog_url('http://example.org')
         self.assertEqual(str(furl(url).path), '/account/dialog/login')