Merge pull request #81 from mailjet/dnefodov/feature/add-dash-contain…

…ed-urls

Add possibility to use dash contained URLs

README.md

@@ -26,6 +26,7 @@ Check out all the resources and Python code examples in the official [Mailjet Do
 - [Client / Call configuration specifics](#client--call-configuration-specifics)
   - [API versioning](#api-versioning)
   - [Base URL](#base-url)
+  - [URL path](#url-path)
 - [Request examples](#request-examples)
   - [POST request](#post-request)
     - [Simple POST request](#simple-post-request)
@@ -148,6 +149,22 @@ mailjet = Client(auth=(api_key, api_secret),api_url="https://api.us.mailjet.com/
 
 If your account has been moved to Mailjet's **US architecture**, the URL value you need to set is `https://api.us.mailjet.com`.
 
+### URL path
+
+According to python special characters limitations we can't use slashes `/` and dashes `-` which is acceptable for URL path building. Instead python client uses another way for path building. You should replase slashes `/` by underscore `_` and dashes `-` by capitalizing next letter in path.
+For example, to reach `statistics/link-click` path you should call `statistics_linkClick` attribute of python client.
+
+```python
+# GET `statistics/link-click`
+mailjet = Client(auth=(api_key, api_secret))
+filters = {
+  'CampaignId': 'xxxxxxx'
+}
+result = mailjet.statistics_linkClick.get(filters=filters)
+print result.status_code
+print result.json()
+``` 
+
 ## Request examples
 
 ### POST request

mailjet_rest/client.py

@@ -3,6 +3,7 @@
 
 import json
 import logging
+import re
 
 import requests
 from requests.compat import urljoin
@@ -11,6 +12,13 @@
 requests.packages.urllib3.disable_warnings()
 
 
+def prepare_url(key: str):
+    """Replaces capital letters to lower one with dash prefix."""
+    char_elem = key.group(0)
+    if char_elem.isupper():
+        return '-' + char_elem.lower()
+
+
 class Config(object):
     DEFAULT_API_URL = 'https://api.mailjet.com/'
     API_REF = 'http://dev.mailjet.com/email-api/v3/'
@@ -79,6 +87,7 @@ def __init__(self, auth=None, **kwargs):
         self.config = Config(version=version, api_url=api_url)
 
     def __getattr__(self, name):
+        name = re.sub(r"[A-Z]", prepare_url, name)
         split = name.split('_')
         #identify the resource
         fname = split[0]