Merge pull request #7 from usabilla/increase-test-coverage

Increase test coverage

Author: Teun Zengerink

CHANGES.md

@@ -3,10 +3,15 @@ Changelog
 
 Here you find a full list of changes.
 
+Version 1.2.2
+-------------
+
+- Automatically deploy new versions to PyPI
+
 Version 1.2.1
 -------------
 
-- Add usabilla to PyPi
+- Add usabilla to PyPI
 
 Version 1.2.0
 -------------

requirements.txt

@@ -5,3 +5,4 @@ requests==2.11.1
 sh==1.11
 six==1.10.0
 urllib3==1.17
+mock==2.0.0

tests.py

@@ -1,9 +1,8 @@
-"""Unit tests for the Usabilla API."""
-
 import sys
 import unittest
 import usabilla as ub
 
+from mock import Mock
 from unittest import TestCase, main as unittest_main
 
 
@@ -40,6 +39,18 @@ def test_empty_credentials_exception(self):
             ub.Credentials(2, '')
 
 
+class TestGeneralError(TestCase):
+
+    def setUp(self):
+        self.error = ub.GeneralError('type', 'message')
+
+    def test_str(self):
+        self.assertEqual(str(self.error), 'type (message)')
+
+    def test_repr(self):
+        self.assertEqual(repr(self.error), 'GeneralError(type=type)')
+
+
 class TestClient(TestCase):
 
     def setUp(self):
@@ -75,5 +86,46 @@ def test_query_parameters(self):
         self.client.set_query_parameters(params)
         self.assertEqual(self.client.get_query_parameters(), 'limit=1&since=1235454')
 
+    def test_check_resource_validity(self):
+        with self.assertRaises(ub.GeneralError):
+            self.client.check_resource_validity('nonexisting', 'nonexisting', 'nonexisting')
+        with self.assertRaises(ub.GeneralError):
+            self.client.check_resource_validity('live', 'nonexisting', 'nonexisting')
+        with self.assertRaises(ub.GeneralError):
+            self.client.check_resource_validity('live', 'websites', 'nonexisting')
+        self.assertEqual(self.client.check_resource_validity('live', 'websites', 'button'), '/live/websites/button')
+
+    def test_handle_id(self):
+        url = '/live/websites/button/:id/feedback'
+        with self.assertRaises(ub.GeneralError):
+            self.client.handle_id(url, '')
+        self.assertEqual(self.client.handle_id(url, '*'), '/live/websites/button/%2A/feedback')
+        self.assertEqual(self.client.handle_id(url, 42), '/live/websites/button/42/feedback')
+
+    def test_item_iterator(self):
+        items = ['one', 'two', 'three', 'four']
+        has_more = {'hasMore': True, 'items': items[:2], 'lastTimestamp': 1400000000001}
+        no_more = {'hasMore': False, 'items': items[2:], 'lastTimestamp': 1400000000002}
+        self.client.set_query_parameters = Mock()
+        self.client.send_signed_request = Mock(side_effect=[has_more, no_more])
+        index = 0
+        for item in self.client.item_iterator('/some/url'):
+            self.assertEqual(item, items[index])
+            index += 1
+        self.client.set_query_parameters.assert_called_with({'since': 1400000000002})
+        self.assertEqual(self.client.send_signed_request.call_count, 2)
+        self.client.send_signed_request.side_effect = ub.GeneralError('mocked', 'error')
+        for item in self.client.item_iterator('/some/url'):
+            raise ub.GeneralError('should not', 'come here')
+
+    def test_get_resource(self):
+        self.client.item_iterator = Mock()
+        self.client.send_signed_request = Mock()
+        self.client.get_resource('live', 'websites', 'feedback', 42)
+        self.client.send_signed_request.assert_called_with('/live/websites/button/42/feedback')
+        self.client.get_resource('live', 'websites', 'button', None, True)
+        self.client.item_iterator.assert_called_with('/live/websites/button')
+
+
 if __name__ == '__main__':
     unittest_main()

usabilla.py

@@ -1,5 +1,3 @@
-"""Usabilla API Python Client."""
-
 # Copyright (c) 2016 Usabilla.com
 #
 # Permission is hereby granted, free of charge, to any person obtaining a
@@ -74,7 +72,7 @@ class APIClient(object):
     """
 
     resources = {
-    'scopes' : {
+        'scopes' : {
             'live': {
                 'products': {
                     'websites': {
@@ -104,23 +102,23 @@ class APIClient(object):
             }
         }
     }
-    
+
     """ Scope constants """
     SCOPE_LIVE = 'live'
-    
+
     """ Product contants """
     PRODUCT_WEBSITES = 'websites'
     PRODUCT_EMAIL = 'email'
     PRODUCT_APPS = 'apps'
-    
+
     """ Resource contants """
     RESOURCE_FEEDBACK = 'feedback'
     RESOURCE_APP = 'app'
     RESOURCE_BUTTON = 'button'
-    RESOURCE_CAMPAIGN = 'campaign'    
+    RESOURCE_CAMPAIGN = 'campaign'
     RESOURCE_CAMPAIGN_RESULT = 'campaign_result'
     RESOURCE_CAMPAIGN_STATS = 'campaign_stats'
-    RESOURCE_INPAGE = 'inpage'    
+    RESOURCE_INPAGE = 'inpage'
     RESOURCE_INPAGE_RESULT = 'inpage_result'
 
     method = 'GET'
@@ -148,7 +146,7 @@ def set_query_parameters(self, parameters):
         :param parameters: A `dict` representing the query parameters to be used for the request.
         :type parameters: dict
         """
-        
+
         self.query_parameters = urllib.urlencode(OrderedDict(sorted(parameters.items())))
 
     def get_query_parameters(self):
@@ -169,7 +167,7 @@ def send_signed_request(self, scope):
         :type scope: str
 
         :returns: A `dict` of the data.
-        :rtype: dict 
+        :rtype: dict
         """
         if self.credentials.client_key is None or self.credentials.secret_key is None:
             raise GeneralError('Invalid Access Key.', 'The Access Key supplied is invalid.')
@@ -194,7 +192,7 @@ def send_signed_request(self, scope):
 
         # Create payload hash (hash of the request body content).
         payload_hash = hashlib.sha256(''.encode('utf-8')).hexdigest()
-        
+
         # Combine elements to create canonical request.
         canonical_request = '{method}\n{uri}\n{query}\n{can_headers}\n{signed_headers}\n{hash}'.format(
             method=self.method,
@@ -234,52 +232,52 @@ def send_signed_request(self, scope):
         )
 
         headers = {'date': usbldate, 'Authorization': authorization_header}
-        
+
         # Send the request.
-        request_url = self.host + scope + '?' + canonical_querystring        
+        request_url = self.host + scope + '?' + canonical_querystring
         r = requests.get(self.host_protocol + request_url, headers=headers)
-        
-       
+
+
         if r.status_code != 200:
             return r
         else:
             return r.json()
-            
 
-    def check_resource_validity(self,scope,product,resource):
-        """Checks whether the resource exists 
-        
+
+    def check_resource_validity(self, scope, product, resource):
+        """Checks whether the resource exists
+
         :param scope: A `string` that specifies the resource scope
         :param product: A `string` that specifies the product type
         :param resource: A `string` that specifies the resource type
-        
+
         :type scope: str
         :type product: str
         :type resource: str
-        
+
         :returns: An `string` that represents the resource request url
         :rtype: string
         """
         if scope not in self.resources['scopes'].keys():
             raise GeneralError('invalid scope', 'Invalid scope name')
         if product not in self.resources['scopes'][scope]['products'].keys():
-            raise GeneralError('invalid product', 'Invalid product name')            
+            raise GeneralError('invalid product', 'Invalid product name')
         if resource not in self.resources['scopes'][scope]['products'][product]['resources'].keys():
-            raise GeneralError('invalid resource', 'Invalid resource name')    
-        
+            raise GeneralError('invalid resource', 'Invalid resource name')
+
         url = '/' + scope + '/' + product + self.resources['scopes'][scope]['products'][product]['resources'][resource]
-        
+
         return url
-        
-    def handle_id(self,url,resource_id):
+
+    def handle_id(self, url, resource_id):
         """Replaces the :id pattern in the url
-        
+
         :param url: A `string` that specifies the resource request url
         :param resource_id: A `string` that specifies the resource id
-        
+
         :type url: str
         :type resource_id: str
-        
+
         :returns: An `string` that represents the resource request url
         :rtype: string
         """
@@ -288,18 +286,18 @@ def handle_id(self,url,resource_id):
                 raise GeneralError('invalid id', 'Invalid resource ID')
             if resource_id == '*':
                resource_id = '%2A'
-    
+
             url = url.replace(':id', str(resource_id))
-           
+
         return url
-            
+
     def item_iterator(self, url):
         """Get items using an iterator.
-        
+
         :param url: A `string` that specifies the resource request url
-        
+
         :type url: str
-        
+
         :returns: An `generator` that yeilds the requested data.
         :rtype: generator
         """
@@ -313,32 +311,29 @@ def item_iterator(self, url):
                 self.set_query_parameters({'since': results['lastTimestamp']})
             except:
                 return
-        
-        
+
+
     def get_resource(self, scope, product, resource, resource_id=None, iterate=False):
         """Retrieves resources of the specified type
-        
+
         :param scope: A `string` that specifies the resource scope
         :param product: A `string` that specifies the product type
         :param resource: A `string` that specifies the resource type
         :param resource_id: A `string` that specifies the resource id
-        :param iterate: A `boolean` that specifies whether the you want to use an iterator    
-        
+        :param iterate: A `boolean` that specifies whether the you want to use an iterator
+
         :type scope: str
         :type product: str
         :type resource: str
         :type resource_id: str
-        :type iterate: bool        
-        
+        :type iterate: bool
+
         :returns: An `generator` that yeilds the requested data or a single resource
         :rtype: generator or single resource
         """
         url = self.handle_id(self.check_resource_validity(scope, product, resource), resource_id)
-                
+
         if iterate:
             return self.item_iterator(url)
         else:
             return self.send_signed_request(url)
-
-
-