Added support to create manual ident URLs

Author: MarkusH

CHANGELOG.md

@@ -5,6 +5,13 @@
 * Added explicit support for the `muid` argument to `get_add_url()`,
   `get_buy_url()` and `get_subscribe_url()`.
 
+* Added function to create manual ident URLs. A user can visit these URLs to
+  regain access to previous purchased or bought content.
+
+* Added [PyJWT](https://pyjwt.readthedocs.io/en/latest/) >= 1.4.2 to the
+  installation requirements as it's required for the added manual ident URLs
+  feature.
+
 ## 5.2.0
 
 * Added constants outlining expiration and duration time bases for purchases

laterpay/__init__.py

@@ -14,12 +14,13 @@
 import string
 import time
 
+import jwt
 import requests
 
 import six
 from six.moves.urllib.parse import quote_plus
 
-from . import constants, signing, utils
+from . import compat, constants, signing, utils
 
 
 _logger = logging.getLogger(__name__)
@@ -396,3 +397,20 @@ def get_access_data(self, article_ids, lptoken=None):
         response.raise_for_status()
 
         return response.json()
+
+    def get_manual_ident_url(self, article_url, article_ids):
+        """
+        Return a URL to allow users to claim previous purchase content.
+        """
+        token = self._get_manual_ident_token(article_url, article_ids)
+        return '%s/ident/%s/%s/' % (self.web_root, self.cp_key, token)
+
+    def _get_manual_ident_token(self, article_url, article_ids):
+        """
+        Return the token data for ``get_manual_ident_url()``.
+        """
+        data = {
+            'back': compat.stringify(article_url),
+            'ids': [compat.stringify(article_id) for article_id in article_ids],
+        }
+        return jwt.encode(data, self.shared_secret).decode()

setup.py

@@ -29,6 +29,7 @@
     packages=_packages,
 
     install_requires=[
+        'PyJWT>=1.4.2',
         'requests',
         'six',
     ],

tests/test_client.py

@@ -3,6 +3,7 @@
 import json
 import unittest
 
+import jwt
 import mock
 import responses
 
@@ -509,6 +510,53 @@ def test_get_controls_balance_url_all_set(self, time_mock):
             'ts': ['12345678'],
         })
 
+    def test_get_manual_ident_url(self):
+        article_url = u'http://example.com/news?id=10&emoji=😄'
+        article_ids = ['aid≠1', b'aid\xe2\x89\xa02']
+
+        url = self.lp.get_manual_ident_url(article_url, article_ids)
+
+        url_info = urlparse(url)
+
+        self.assertEqual(url_info.scheme, 'https')
+        self.assertEqual(url_info.netloc, 'web.laterpay.net')
+        self.assertEqual(url_info.hostname, 'web.laterpay.net')
+        self.assertEqual(url_info.params, '')
+        self.assertEqual(url_info.query, '')
+        self.assertEqual(url_info.fragment, '')
+        self.assertIsNone(url_info.username)
+        self.assertIsNone(url_info.password)
+        self.assertIsNone(url_info.port)
+
+        path_segments = url_info.path.split('/')
+
+        self.assertEqual(len(path_segments), 5)
+        self.assertEqual(path_segments[0], '')
+        self.assertEqual(path_segments[1], 'ident')
+        self.assertEqual(path_segments[2], self.lp.cp_key)
+        self.assertEqual(path_segments[4], '')
+
+        token = path_segments[3]
+
+        data = jwt.decode(token, self.lp.shared_secret)
+
+        self.assertEqual(data, {
+            'back': u'http://example.com/news?id=10&emoji=\U0001f604',
+            'ids': [u'aid\u22601', u'aid\u22602'],
+        })
+
+    def test_get_manual_ident_token(self):
+        article_url = u'http://example.com/news?id=10&emoji=😄'
+        article_ids = ['aid≠1', b'aid\xe2\x89\xa02']
+
+        token = self.lp._get_manual_ident_token(article_url, article_ids)
+        data = jwt.decode(token, self.lp.shared_secret)
+
+        self.assertEqual(data, {
+            'back': u'http://example.com/news?id=10&emoji=\U0001f604',
+            'ids': [u'aid\u22601', u'aid\u22602'],
+        })
+
 
 if __name__ == '__main__':
     unittest.main()