[0.2.0] Pickle compatible objects + python 2 fix + pagination format

Author: santiher

CHANGELOG.md

@@ -2,6 +2,13 @@
 
 All notable changes to this project will be documented here.
 
+## [0.2.0] - 2019-07-01
+### Added
+- Pickle compatible objects
+### Fixed
+- Pagination next link format.
+- Python 2 compatibility.
+
 ## [0.1.0] - 2019-06-28
 ### Added
 - Client to query Help Scout's v2 API.

helpscout/__init__.py

@@ -1,4 +1,4 @@
 from helpscout.client import HelpScout  # noqa
 
 
-__version__ = '0.1.0'
+__version__ = '0.2.0'

helpscout/client.py

@@ -2,7 +2,10 @@
 import time
 
 from functools import partial
-from urllib.parse import urljoin
+try:  # Python 3
+    from urllib.parse import urljoin
+except ImportError:  # Python 2
+    from urlparse import urljoin
 
 import requests
 
@@ -136,13 +139,16 @@ def hit(self, endpoint, method, resource_id=None, data=None):
             yield
         elif ok:
             response = r.json()
-            yield from self._results_with_pagination(response, method)
+            for item in self._results_with_pagination(response, method):
+                yield item
         elif status_code == 401:
             self._authenticate()
-            yield from self.hit(endpoint, method, resource_id, data)
+            for item in self.hit(endpoint, method, resource_id, data):
+                yield item
         elif status_code == 429:
             self._handle_rate_limit_exceeded()
-            yield from self.hit(endpoint, method, resource_id, data)
+            for item in self.hit(endpoint, method, resource_id, data):
+                yield item
         else:
             raise HelpScoutException(r.text)
 
@@ -165,21 +171,25 @@ def _results_with_pagination(self, response, method):
             yield response
             return
         if isinstance(response[EmbeddedKey], list):
-            yield from response[EmbeddedKey]
+            for item in response[EmbeddedKey]:
+                yield item
         else:
             yield response[EmbeddedKey]
-        next_page = response.get('_links', {}).get('next')
+        next_obj = response.get('_links', {}).get('next', {})
+        next_page = None if next_obj is None else next_obj.get('href')
         while next_page:
             headers = self._authentication_headers()
             logger.debug('%s %s' % (method, next_page))
             r = getattr(requests, method)(next_page, headers=headers)
             if r.ok:
                 response = r.json()
                 if isinstance(response[EmbeddedKey], list):
-                    yield from response[EmbeddedKey]
+                    for item in response[EmbeddedKey]:
+                        yield item
                 else:
                     yield response[EmbeddedKey]
-                next_page = response.get('_links', {}).get('next')
+                next_obj = response.get('_links', {}).get('next', {})
+                next_page = None if next_obj is None else next_obj.get('href')
             elif r.status_code == 401:
                 self._authenticate()
             elif r.status_code == 429:

helpscout/exceptions.py

@@ -5,7 +5,8 @@ class HelpScoutException(Exception):
 class HelpScoutAuthenticationException(HelpScoutException):
     def __init__(self, *args):
         text = ' '.join(str(arg) for arg in args)
-        super().__init__('HelpScout authentication failed: ' + text)
+        super(HelpScoutAuthenticationException, self).__init__(
+            'HelpScout authentication failed: ' + text)
 
 
 class HelpScoutRateLimitExceededException(HelpScoutException):

helpscout/model.py

@@ -1,4 +1,4 @@
-class HelpScoutObject:
+class HelpScoutObject(object):
 
     key = ''
 
@@ -60,16 +60,31 @@ def cls(cls, entity_name, key):
         -------
         type: The object's class
         """
-        existing_class = classes.get(entity_name)
-        if existing_class is not None:
-            return existing_class
         plural_letters = (-2 if entity_name.endswith('es') else
                           -1 if entity_name.endswith('s') else
                           None)
         class_name = entity_name.capitalize()[:plural_letters]
-        classes[entity_name] = cls = type(class_name, (cls,), {'key': key})
+        existing_class = globals().get(class_name)
+        if existing_class is not None:
+            return existing_class
+        globals()[class_name] = cls = type(class_name, (cls,), {'key': key})
         return cls
 
+    def __reduce__(self):
+        """For pickling with HelpScoutObject."""
+        class_attributes = self.__class__.__name__, self.key
+        return get_subclass_instance, class_attributes, self.__getstate__()
+
+    def __getstate__(self):
+        """Pickle dump implementation."""
+        return self._attrs, tuple(getattr(self, attr) for attr in self._attrs)
+
+    def __setstate__(self, state):
+        """Pickle load implementation."""
+        self._attrs = state[0]
+        for attr, value in zip(self._attrs, state[1]):
+            setattr(self, attr, value)
+
     def __eq__(self, other):
         """Equality comparison."""
         if self.__class__ is not other.__class__:
@@ -107,4 +122,20 @@ def __repr__(self):
     __str__ = __repr__
 
 
-classes = {}
+def get_subclass_instance(class_name, key):
+    """Gets a dynamic class from a class name for unpickling.
+
+    Parameters
+    ----------
+    name: str
+        A class name, expected to start with Upper case.
+
+    Returns
+    -------
+    A helpscout object subclass.
+    """
+    cls = globals().get(class_name)
+    if cls is None:
+        cls = type(class_name, (HelpScoutObject,), {'key': key})
+        globals()[class_name] = cls
+    return cls.__new__(cls)

tests/helpscout/test_client.py

@@ -345,14 +345,15 @@ def test_pagination_embedded_next_page_ok(self):
                 {'msg': 'hello'},
                 {'msg': 'bye'},
             ],
-            '_links': {'next': 'http://helpscout.com/next_page/110'}
+            '_links': {'next': {'href': 'http://helpscout.com/next_page/110'}}
         }
         responses_values = [
             {EmbeddedKey: [
                 {'msg': 'blink 1'},
                 {'msg': 'blink 2'},
                 ],
-             '_links': {'next': 'http://helpscout.com/next_page/111'}},
+             '_links': {'next':
+                        {'href': 'http://helpscout.com/next_page/111'}}},
             {EmbeddedKey: [
                 {'msg': 'see ya'},
                 ],
@@ -384,12 +385,15 @@ def test_pagination_embedded_next_page_ok(self):
             self.assertEqual(auth_headers.call_count, 2)
             self.assertEqual(
                 logger.debug.call_args_list,
-                [call(method + ' ' + response_value['_links']['next']),
-                 call(method + ' ' + responses_values[0]['_links']['next'])])
+                [call(method + ' ' + response_value['_links']['next']['href']),
+                 call(method + ' ' + responses_values[0]['_links']['next'][
+                     'href'])])
             self.assertEqual(
                 requests.get.call_args_list,
-                [call(response_value['_links']['next'], headers=headers),
-                 call(responses_values[0]['_links']['next'], headers=headers)
+                [call(response_value['_links']['next']['href'],
+                      headers=headers),
+                 call(responses_values[0]['_links']['next']['href'],
+                      headers=headers)
                  ])
             responses[0].json.assert_called_once()
             responses[1].json.assert_called_once()
@@ -403,14 +407,15 @@ def test_pagination_embedded_next_page_token_expired(self):
                 {'msg': 'hello'},
                 {'msg': 'bye'},
             ],
-            '_links': {'next': 'http://helpscout.com/next_page/110'}
+            '_links': {'next': {'href': 'http://helpscout.com/next_page/110'}}
         }
         responses_values = [
             {EmbeddedKey: [
                 {'msg': 'blink 1'},
                 {'msg': 'blink 2'},
                 ],
-             '_links': {'next': 'http://helpscout.com/next_page/111'}},
+             '_links': {'next':
+                        {'href': 'http://helpscout.com/next_page/111'}}},
             {EmbeddedKey: [
                 {'msg': 'see ya'},
                 ],
@@ -444,14 +449,18 @@ def test_pagination_embedded_next_page_token_expired(self):
             self.assertEqual(auth_headers.call_count, 3)
             self.assertEqual(
                 logger.debug.call_args_list,
-                [call(method + ' ' + response_value['_links']['next']),
-                 call(method + ' ' + response_value['_links']['next']),
-                 call(method + ' ' + responses_values[0]['_links']['next'])])
+                [call(method + ' ' + response_value['_links']['next']['href']),
+                 call(method + ' ' + response_value['_links']['next']['href']),
+                 call(method + ' ' + responses_values[0]['_links']['next'][
+                     'href'])])
             self.assertEqual(
                 requests.get.call_args_list,
-                [call(response_value['_links']['next'], headers=headers),
-                 call(response_value['_links']['next'], headers=headers),
-                 call(responses_values[0]['_links']['next'], headers=headers)
+                [call(response_value['_links']['next']['href'],
+                      headers=headers),
+                 call(response_value['_links']['next']['href'],
+                      headers=headers),
+                 call(responses_values[0]['_links']['next']['href'],
+                      headers=headers)
                  ])
             responses[1].json.assert_called_once()
             responses[2].json.assert_called_once()
@@ -465,14 +474,15 @@ def test_pagination_embedded_next_page_rate_limit_exceeded(self):
                 {'msg': 'hello'},
                 {'msg': 'bye'},
             ],
-            '_links': {'next': 'http://helpscout.com/next_page/110'}
+            '_links': {'next': {'href': 'http://helpscout.com/next_page/110'}}
         }
         responses_values = [
             {EmbeddedKey: [
                 {'msg': 'blink 1'},
                 {'msg': 'blink 2'},
                 ],
-             '_links': {'next': 'http://helpscout.com/next_page/111'}},
+             '_links': {'next':
+                        {'href': 'http://helpscout.com/next_page/111'}}},
             {EmbeddedKey: [
                 {'msg': 'see ya'},
                 ],
@@ -506,14 +516,18 @@ def test_pagination_embedded_next_page_rate_limit_exceeded(self):
             self.assertEqual(auth_headers.call_count, 3)
             self.assertEqual(
                 logger.debug.call_args_list,
-                [call(method + ' ' + response_value['_links']['next']),
-                 call(method + ' ' + response_value['_links']['next']),
-                 call(method + ' ' + responses_values[0]['_links']['next'])])
+                [call(method + ' ' + response_value['_links']['next']['href']),
+                 call(method + ' ' + response_value['_links']['next']['href']),
+                 call(method + ' ' + responses_values[0]['_links']['next'][
+                     'href'])])
             self.assertEqual(
                 requests.get.call_args_list,
-                [call(response_value['_links']['next'], headers=headers),
-                 call(response_value['_links']['next'], headers=headers),
-                 call(responses_values[0]['_links']['next'], headers=headers)
+                [call(response_value['_links']['next']['href'],
+                      headers=headers),
+                 call(response_value['_links']['next']['href'],
+                      headers=headers),
+                 call(responses_values[0]['_links']['next']['href'],
+                      headers=headers)
                  ])
             responses[0].json.assert_not_called()
             responses[1].json.assert_called_once()
@@ -528,14 +542,15 @@ def test_pagination_exception(self):
                 {'msg': 'hello'},
                 {'msg': 'bye'},
             ],
-            '_links': {'next': 'http://helpscout.com/next_page/110'}
+            '_links': {'next': {'href': 'http://helpscout.com/next_page/110'}}
         }
         responses_values = [
             {EmbeddedKey: [
                 {'msg': 'blink 1'},
                 {'msg': 'blink 2'},
                 ],
-             '_links': {'next': 'http://helpscout.com/next_page/111'}},
+             '_links': {'next':
+                        {'href': 'http://helpscout.com/next_page/111'}}},
             {EmbeddedKey: [
                 {'msg': 'see ya'},
                 ],