Add __version__, improved tests

Author: Arnaud Breton

mailjet_rest/__init__.py

@@ -3,5 +3,5 @@
 
 from .client import Client
 
-__version__ = '0.1.0'
-__all__ = ('Client',)
+from ._version import __version__
+__all__ = (Client,)

mailjet_rest/_version.py

@@ -0,0 +1 @@
+__version__ = "1.3.0"

mailjet_rest/client.py

@@ -6,6 +6,7 @@
 
 import requests
 from requests.compat import urljoin
+from ._version import __version__
 
 requests.packages.urllib3.disable_warnings()
 
@@ -14,6 +15,7 @@ class Config(object):
     API_URL = 'https://api.mailjet.com/'
     API_REF = 'http://dev.mailjet.com/email-api/v3/'
     version = 'v3'
+    user_agent = 'mailjet-apiv3-python/'+ __version__
 
     def __init__(self, version=None):
         if version is not None:
@@ -24,7 +26,7 @@ def __getitem__(self, key):
         # Append version to URL.
         # Forward slash is ignored if present in self.version.
         url = urljoin(url, self.version + '/')
-        headers = {'Content-type': 'application/json', 'User-agent': 'mailjet-apiv3-python'}
+        headers = {'Content-type': 'application/json', 'User-agent': self.user_agent}
         if key.lower() == 'contactslist_csvdata':
             url = urljoin(url, 'DATA/')
             headers['Content-type'] = 'text/plain'

setup.py

@@ -6,18 +6,22 @@
 import re
 from setuptools import setup
 from setuptools.command.test import test as TestCommand
+import re
 
 HERE = os.path.abspath(os.path.dirname(__file__))
 PACKAGE_NAME = 'mailjet_rest'
-VERSION = 'v1.3.0'
+
+__version__ = re.search(
+    r'__version__\s*=\s*[\'"]([^\'"]*)[\'"]',  # It excludes inline comment too
+    open('mailjet_rest/_version.py').read()).group(1)
 
 setup(
     name=PACKAGE_NAME,
-    version=VERSION,
+    version=__version__,
     author='starenka',
     author_email='[email protected]',
-    maintainer='Guillaume Badi',
-    maintainer_email='gbadi@mailjet.com',
+    maintainer='Mailjet',
+    maintainer_email='api@mailjet.com',
     download_url='https://github.com/mailjet/mailjet-apiv3-python/releases/tag/v1.2.2',
     url='https://github.com/mailjet/mailjet-apiv3-python',
     description=('Mailjet V3 API wrapper'),
@@ -33,8 +37,8 @@
                  'Programming Language :: Python :: 3.5',
                  'Programming Language :: Python :: 3.6',
                  'Topic :: Utilities'],
-    license='GPLv3',
-    keywords='mailjet api wrapper email client',
+    license='MIT',
+    keywords='Mailjet API v3 / v3.1 Python Wrapper',
 
     include_package_data=True,
     install_requires=['requests>=2.4.3'],

test.py

@@ -1,5 +1,5 @@
 import unittest
-from mailjet_rest import Client
+from mailjet_rest import Client, __version__
 import os
 
 
@@ -18,7 +18,7 @@ def test_get_no_param(self):
 
     def test_get_valid_params(self):
         result = self.client.contact.get(filters={'limit': 2}).json()
-        self.failUnless('Count' in result)
+        self.failUnless('Count' >= 0 or Count <= 2)
 
     def test_get_invalid_parameters(self):
         # invalid parameters are ignored
@@ -27,16 +27,19 @@ def test_get_invalid_parameters(self):
 
     def test_get_with_data(self):
         # it shouldn't use data
-        result = self.client.contact.get(data={'Email': 'gbadi@mailjet.com'})
+        result = self.client.contact.get(data={'Email': 'api@mailjet.com'})
         self.failUnless(result.status_code == 200)
 
     def test_get_with_action(self):
-        result = self.client.contact_getcontactslists.get(id=5771382).json()
+        result_cl = self.client.contactslist.get(filters={'limit': 1}).json()
+        self.failUnless(result_cl['Count'] > 0 )
+        result = self.client.contact_getcontactslists.get(result_cl['Data'][0]['ID']).json()
         self.failUnless('Count' in result)
 
     def test_get_with_id_filter(self):
-        result = self.client.contact.get(filter={'id': 5771382}).json()
-        self.failUnless('Count' in result)
+        result_contact = self.client.contact.get(filters={'limit': 1}).json()
+        result_contact_with_id = self.client.contact.get(filter={'Email': result_contact['Data'][0]['Email']}).json()
+        self.failUnless(result_contact_with_id['Data'][0]['Email'] == result_contact['Data'][0]['Email'])
 
     def test_post_with_no_param(self):
         result = self.client.sender.create(data={}).json()
@@ -53,6 +56,12 @@ def test_client_custom_version(self):
             'https://api.mailjet.com/v3.1/send'
         )
 
+    def test_user_agent(self):
+        self.client = Client(
+            auth=self.auth,
+            version='v3.1'
+        )
+        self.assertEqual(self.client.config.user_agent, 'mailjet-apiv3-python/'+__version__)
 
 if __name__ == '__main__':
     unittest.main()