Merge pull request #8 from mailjet/api-version-kwargs

Add support for multiple Mailjet API versions.

Author: arnaudbreton

.travis.yml

@@ -2,6 +2,8 @@ language: python
 python:
 - '2.6'
 - '2.7'
+- '3.5'
+- '3.6'
 deploy:
   provider: pypi
   user: api.mailjet

README.md

@@ -36,10 +36,12 @@ import os
 API_KEY = os.environ['MJ_APIKEY_PUBLIC']
 API_SECRET = os.environ['MJ_APIKEY_PRIVATE']
 
-mailjet = Client(auth=(API_KEY, API_SECRET))
+mailjet = Client(auth=(API_KEY, API_SECRET), version='v3')
 
 ```
 
+**NOTE**: `version` reflects the api version in the url (`https://api.mailjet.com/{{ version }}/REST/`). It is `'v3'` by default and can be used to select another api version (for example `v3.1` for the new send API).
+
 ## Make a `GET` request:
 ``` python
 # get every contacts

mailjet_rest/client.py

@@ -9,12 +9,21 @@
 
 requests.packages.urllib3.disable_warnings()
 
+
 class Config(object):
-    API_URL = 'https://api.mailjet.com/v3/'
-    API_DOC = 'http://dev.mailjet.com/email-api/v3/'
+    API_URL = 'https://api.mailjet.com/'
+    API_REF = 'http://dev.mailjet.com/email-api/v3/'
+    version = 'v3'
+
+    def __init__(self, version=None):
+        if version is not None:
+            self.version = version
 
     def __getitem__(self, key):
         url = self.API_URL[0:]
+        # 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'}
         if key.lower() == 'contactslist_csvdata':
             url = urljoin(url, 'DATA/')
@@ -61,8 +70,10 @@ def delete(self, id, **kwargs):
 
 class Client(object):
 
-    def __init__(self, auth=None, config=Config()):
-        self.auth, self.config = auth, config
+    def __init__(self, auth=None, **kwargs):
+        self.auth = auth
+        version = kwargs.get('version', None)
+        self.config = Config(version=version)
 
     def __getattr__(self, name):
         split = name.split('_')

requirements.txt

@@ -1,3 +1 @@
-requests
-urllib3
-chardet2
+requests==2.17.3

test.py

@@ -2,43 +2,57 @@
 from mailjet_rest import Client
 import os
 
-API_KEY = os.environ['MJ_APIKEY_PUBLIC']
-API_SECRET = os.environ['MJ_APIKEY_PRIVATE']
-
-mj = Client(auth=(API_KEY, API_SECRET))
 
 class TestSuite(unittest.TestCase):
 
+    def setUp(self):
+        self.auth = (
+            os.environ['MJ_APIKEY_PUBLIC'],
+            os.environ['MJ_APIKEY_PRIVATE']
+        )
+        self.client = Client(auth=self.auth)
+
     def test_get_no_param(self):
-        result = mj.contact.get().json()
+        result = self.client.contact.get().json()
         self.failUnless(('Data' in result and 'Count' in result))
 
     def test_get_valid_params(self):
-        result = mj.contact.get(filters={'limit': 2}).json()
+        result = self.client.contact.get(filters={'limit': 2}).json()
         self.failUnless('Count' in result)
 
     def test_get_invalid_parameters(self):
         # invalid parameters are ignored
-        result = mj.contact.get(filters={'invalid': 'false'}).json()
+        result = self.client.contact.get(filters={'invalid': 'false'}).json()
         self.failUnless('Count' in result)
 
     def test_get_with_data(self):
         # it shouldn't use data
-        result = mj.contact.get(data={'Email': '[email protected]'})
+        result = self.client.contact.get(data={'Email': '[email protected]'})
         self.failUnless(result.status_code == 200)
 
     def test_get_with_action(self):
-        result = mj.contact_getcontactslists.get(id=5771382).json()
+        result = self.client.contact_getcontactslists.get(id=5771382).json()
         self.failUnless('Count' in result)
 
     def test_get_with_id_filter(self):
-        result = mj.contact.get(filter={'id': 5771382}).json()
+        result = self.client.contact.get(filter={'id': 5771382}).json()
         self.failUnless('Count' in result)
 
     def test_post_with_no_param(self):
-        result = mj.sender.create(data={}).json()
+        result = self.client.sender.create(data={}).json()
         self.failUnless('StatusCode' in result and result['StatusCode'] is not 400)
 
+    def test_client_custom_version(self):
+        self.client = Client(
+            auth=self.auth,
+            version='v3.1'
+        )
+        self.assertEqual(self.client.config.version, 'v3.1')
+        self.assertEqual(
+            self.client.config['send'][0],
+            'https://api.mailjet.com/v3.1/send'
+        )
+
 
 if __name__ == '__main__':
     unittest.main()