[Client] Fix object creation single object + hit resource with url params

Author: santiher

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 All notable changes to this project will be documented here.
 
+## [0.2.1] - 2019-07-08
+### Fixed
+- Object creation when requesting a single object.
+- Hit an endpoint with a resource_id and url parameters.
+
 ## [0.2.0] - 2019-07-01
 ### Added
 - Pickle compatible objects

README.md

@@ -136,3 +136,13 @@ User(id=12391,
 > conversation_id = 10
 > hs.conversations.delete(resource_id=conversation_id)
 ```
+
+### Requesting a pre-made report
+
+```python
+> from helpscout.client import HelpScout
+> hs = HelpScout(app_id='asdon123', app_secret='asdoin1')
+> report_url = 'reports/happiness?start=2019-06-01T00:00:00Z&end=2019-06-15:00:00Z'
+> next(hs.hit(report_url, 'get'))
+...
+```

helpscout/__init__.py

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

helpscout/client.py

@@ -95,16 +95,14 @@ def get_objects(self, endpoint, resource_id=None, params=None):
         [HelpScoutObject]
             A list of objects returned by the api.
         """
-        if params:
-            if isinstance(params, dict):
-                params = '&'.join('%s=%s' % (k, v) for k, v in params.items())
-            url = '%s?%s' % (endpoint, params)
-        else:
-            url = endpoint
         cls = HelpScoutObject.cls(endpoint, endpoint)
-        return cls.from_results(self.hit(url, 'get', resource_id))
+        results = cls.from_results(
+            self.hit(endpoint, 'get', resource_id, params=params))
+        if resource_id is not None:
+            return results[0]
+        return results
 
-    def hit(self, endpoint, method, resource_id=None, data=None):
+    def hit(self, endpoint, method, resource_id=None, data=None, params=None):
         """Hits the api and yields the data.
 
         Parameters
@@ -114,12 +112,15 @@ def hit(self, endpoint, method, resource_id=None, data=None):
         method: str
             The http method to hit the endpoint with.
             One of {'get', 'post', 'put', 'patch', 'delete', 'head', 'options'}
-        data: dict or None
-            A dictionary with the data to send to the API.
         resource_id: int or str or None
             The id of the resource in the endpoint to query.
             E.g.: in "GET /v2/conversations/123 HTTP/1.1" the id would be 123.
             If None is provided, nothing will be done
+        data: dict or None
+            A dictionary with the data to send to the API as json.
+        params: dict or str or None
+            Dictionary with the parameters to send to the url.
+            Or the parameters already un url format.
 
         Yields
         -------
@@ -131,6 +132,10 @@ def hit(self, endpoint, method, resource_id=None, data=None):
         url = urljoin(self.base_url, endpoint)
         if resource_id is not None:
             url = urljoin(url + '/', str(resource_id))
+        if params:
+            if isinstance(params, dict):
+                params = '&'.join('%s=%s' % (k, v) for k, v in params.items())
+            url = '%s?%s' % (url, params)
         headers = self._authentication_headers()
         r = getattr(requests, method)(url, headers=headers, data=data)
         logger.debug('%s %s' % (method, url))

helpscout/model.py

@@ -29,7 +29,7 @@ def from_results(cls, api_results):
 
         Parameters
         ----------
-        api_results: generator({cls.key: [dict]})
+        api_results: generator({cls.key: [dict]}) or generator(dict)
             A generator returning API responses that cointain a list of
             objects each under the class key.
 
@@ -39,8 +39,9 @@ def from_results(cls, api_results):
         """
         results = []
         for api_result in api_results:
-            for object_data in api_result.get(cls.key, []):
-                results.append(cls(object_data))
+            for object_data in api_result.get(cls.key, [api_result]):
+                if len(object_data) > 0:
+                    results.append(cls(object_data))
         return results
 
     @classmethod

pypi_upload.sh

@@ -0,0 +1,5 @@
+#!/bin/bash
+
+rm -rf build dist
+python setup.py sdist bdist_wheel
+twine upload -r pypi dist/python*

tests/helpscout/test_client.py

@@ -40,7 +40,7 @@ def test_get_objects_dict_params(self):
             hit.return_value = hit_return = 9
             hs.get_objects(endpoint, params=params)
             HelpScoutObject.cls.assert_called_with(endpoint, endpoint)
-            hit.assert_called_with(endpoint + '?id=10&name=Mike', 'get', None)
+            hit.assert_called_with(endpoint, 'get', None, params=params)
             cls.from_results.assert_called_with(hit_return)
 
     def test_get_objects_str_params(self):
@@ -52,7 +52,7 @@ def test_get_objects_str_params(self):
             hit.return_value = hit_return = 9
             hs.get_objects(endpoint, params=params)
             HelpScoutObject.cls.assert_called_with(endpoint, endpoint)
-            hit.assert_called_with(endpoint + '?id=10&name=Mike', 'get', None)
+            hit.assert_called_with(endpoint, 'get', None, params=params)
             cls.from_results.assert_called_with(hit_return)
 
     def test_get_objects_no_params(self):
@@ -64,9 +64,24 @@ def test_get_objects_no_params(self):
             hit.return_value = hit_return = 9
             hs.get_objects(endpoint, params)
             HelpScoutObject.cls.assert_called_with(endpoint, endpoint)
-            hit.assert_called_with(endpoint, 'get', None)
+            hit.assert_called_with(endpoint, 'get', None, params=params)
             cls.from_results.assert_called_with(hit_return)
 
+    def test_get_objects_resource_id(self):
+        user = {'id': '10', 'name': 'Mike'}
+        endpoint, resource_id = 'users', 10
+        hs = self._get_client()
+        with patch('helpscout.client.HelpScoutObject') as HelpScoutObject, \
+                patch('helpscout.client.HelpScout.hit') as hit:
+            HelpScoutObject.cls.return_value = cls = MagicMock()
+            cls.from_results.return_value = [user]
+            hit.return_value = hit_return = user
+            data = hs.get_objects(endpoint, resource_id=resource_id)
+            HelpScoutObject.cls.assert_called_with(endpoint, endpoint)
+            hit.assert_called_with(endpoint, 'get', 10, params=None)
+            cls.from_results.assert_called_with(hit_return)
+            self.assertEqual(data, user)
+
     def test_hit_no_access_token_ok(self):
         endpoint, method = 'users', 'get'
         full_url = self.url + endpoint
@@ -142,6 +157,85 @@ def test_hit_resource_id_ok(self):
             response.json.assert_called_once()
             pages.assert_called_once_with(json_response, method)
 
+    def test_hit_params_dict_ok(self):
+        params, params_str = {'embed': 'threads'}, '?embed=threads'
+        endpoint, method = 'users', 'get'
+        full_url = self.url + endpoint + params_str
+        hs_path = 'helpscout.client.HelpScout.'
+        hs = self._get_client(token='abc')
+        with patch('helpscout.client.requests') as requests, \
+                patch('helpscout.client.logger') as logger, \
+                patch(hs_path + '_authenticate') as auth, \
+                patch(hs_path + '_authentication_headers') as auth_headers, \
+                patch(hs_path + '_results_with_pagination') as pages:
+            # Setup
+            auth_headers.return_value = headers = {'token': 'abc'}
+            response = requests.get.return_value = MagicMock()
+            response.ok = True
+            response.json.return_value = json_response = {'a': 'b'}
+            list(hs.hit(endpoint, method, None, params=params))
+            # Asserts
+            auth.assert_not_called()
+            auth_headers.assert_called_once()
+            logger.debug.assert_called_once_with(method + ' ' + full_url)
+            requests.get.assert_called_once_with(
+                full_url, headers=headers, data=None)
+            response.json.assert_called_once()
+            pages.assert_called_once_with(json_response, method)
+
+    def test_hit_resource_id_with_params_dict_ok(self):
+        params, params_str = {'embed': 'threads'}, '?embed=threads'
+        endpoint, method, resource_id = 'users', 'get', 4
+        full_url = self.url + endpoint + '/' + str(resource_id) + params_str
+        hs_path = 'helpscout.client.HelpScout.'
+        hs = self._get_client(token='abc')
+        with patch('helpscout.client.requests') as requests, \
+                patch('helpscout.client.logger') as logger, \
+                patch(hs_path + '_authenticate') as auth, \
+                patch(hs_path + '_authentication_headers') as auth_headers, \
+                patch(hs_path + '_results_with_pagination') as pages:
+            # Setup
+            auth_headers.return_value = headers = {'token': 'abc'}
+            response = requests.get.return_value = MagicMock()
+            response.ok = True
+            response.json.return_value = json_response = {'a': 'b'}
+            list(hs.hit(endpoint, method, resource_id, params=params))
+            # Asserts
+            auth.assert_not_called()
+            auth_headers.assert_called_once()
+            logger.debug.assert_called_once_with(method + ' ' + full_url)
+            requests.get.assert_called_once_with(
+                full_url, headers=headers, data=None)
+            response.json.assert_called_once()
+            pages.assert_called_once_with(json_response, method)
+
+    def test_hit_resource_id_with_params_str_ok(self):
+        params_str = 'embed=threads'
+        endpoint, method, resource_id = 'users', 'get', 4
+        full_url = (self.url + endpoint + '/' + str(resource_id) + '?' +
+                    params_str)
+        hs_path = 'helpscout.client.HelpScout.'
+        hs = self._get_client(token='abc')
+        with patch('helpscout.client.requests') as requests, \
+                patch('helpscout.client.logger') as logger, \
+                patch(hs_path + '_authenticate') as auth, \
+                patch(hs_path + '_authentication_headers') as auth_headers, \
+                patch(hs_path + '_results_with_pagination') as pages:
+            # Setup
+            auth_headers.return_value = headers = {'token': 'abc'}
+            response = requests.get.return_value = MagicMock()
+            response.ok = True
+            response.json.return_value = json_response = {'a': 'b'}
+            list(hs.hit(endpoint, method, resource_id, params=params_str))
+            # Asserts
+            auth.assert_not_called()
+            auth_headers.assert_called_once()
+            logger.debug.assert_called_once_with(method + ' ' + full_url)
+            requests.get.assert_called_once_with(
+                full_url, headers=headers, data=None)
+            response.json.assert_called_once()
+            pages.assert_called_once_with(json_response, method)
+
     def test_hit_post_ok(self):
         endpoint, method = 'users', 'post'
         full_url = self.url + endpoint
@@ -660,7 +754,7 @@ def test_getattr_requester_get(self):
             hit.return_value = hit_return = 9
             getattr(hs, endpoint).get(params=params)
             HelpScoutObject.cls.assert_called_with(endpoint, endpoint)
-            hit.assert_called_with(endpoint + '?id=10&name=Mike', 'get', None)
+            hit.assert_called_with(endpoint, 'get', None, params=params)
             cls.from_results.assert_called_with(hit_return)
 
     def test_getattr_requester_delete_resource_id(self):

tests/helpscout/test_model.py

@@ -36,6 +36,14 @@ def test_from_results_empty(self):
         self.assertTrue(isinstance(users, list))
         self.assertEqual(len(users), 0)
 
+    def test_from_results_single(self):
+        data = {'id': 9}
+        data_generator = (data for _ in range(1))
+        cls = HelpScoutObject.cls('users', 'users')
+        users = cls.from_results(data_generator)
+        self.assertTrue(isinstance(users, list))
+        self.assertEqual(len(users), 1)
+
     def test_entity_class_name(self):
         cls = HelpScoutObject.cls('users', 'users')
         self.assertEqual(cls.__name__, 'User')