Merge pull request #14 from Heshmatkhah/master

Fix issues with endpoints that have inputs containing arrays

kavenegar.py

@@ -13,93 +13,137 @@
 class APIException(Exception):
     pass
 
+
 class HTTPException(Exception):
     pass
 
+
 class KavenegarAPI(object):
-    def __init__(self, apikey, timeout=None):
-        self.version = 'v1'
-        self.host = 'api.kavenegar.com'
+    """
+    https://kavenegar.com/rest.html
+    """
+    version = "v1"
+    host = "api.kavenegar.com"
+    headers = {
+        "Accept": "application/json",
+        "Content-Type": "application/x-www-form-urlencoded",
+        "charset": "utf-8",
+    }
+
+    def __init__(self, apikey, timeout=None, proxies=None):
+        """
+        :param str apikey: Kavengera API Key
+        :param int timeout: request timeout, default is 10
+        :param dict proxies: Dictionary mapping protocol to the URL of the proxy:
+            {
+                'http': 'http://192.168.1.10:3128',
+                'https': 'http://192.168.1.10:3129',
+            }
+        """
         self.apikey = apikey
+        self.apikey_mask = f"{apikey[:2]}********{apikey[-2:]}"
         self.timeout = timeout or DEFAULT_TIMEOUT
-        self.headers = {
-	    'Accept': 'application/json',
-	    'Content-Type': 'application/x-www-form-urlencoded',
-	    'charset': 'utf-8'
-            }
-
+        self.proxies = proxies
+
     def __repr__(self):
-        return "kavenegar.KavenegarAPI({!r})".format(self.apikey)
+        return "kavenegar.KavenegarAPI({!r})".format(self.apikey_mask)
 
     def __str__(self):
-        return "kavenegar.KavenegarAPI({!s})".format(self.apikey)
+        return "kavenegar.KavenegarAPI({!s})".format(self.apikey_mask)
+
+    def _pars_params_to_json(self, params):
+        """
+        Kavenegar bug, the api server expects the parameters in a JSON-like array format,
+        but the requests library form-encode each key-value pair
 
-    def _request(self, action, method, params={}):
-        url = 'https://' + self.host + '/' + self.version + '/' + self.apikey + '/' + action + '/' + method + '.json'
+        Params (dict):
+        { sender: ["30002626", "30002627", "30002727", ], }
+
+        request behavior:
+        sender=30002626&sender=30002627&sender=30002727
+
+        Server expectation:
+        sender=["30002626","30002627","30002727"]
+        """
+        # Convert lists to JSON-like strings
+        formatted_params = {}
+        for key, value in params.items():
+            if isinstance(value, (dict, list, tuple)):
+                formatted_params[key] = json.dumps(value)
+            else:
+                formatted_params[key] = value
+        return formatted_params
+
+    def _request(self, action, method, params=None):
+        if params is None:
+            params = {}
+        if isinstance(params, dict):
+            params = self._pars_params_to_json(params)
+        url = "https://{}/{}/{}/{}/{}.json".format(self.host, self.version, self.apikey, action, method)
         try:
-            content = requests.post(url , headers=self.headers,auth=None,data=params, timeout=self.timeout).content
+            content = requests.post(url, headers=self.headers, auth=None, data=params, timeout=self.timeout, proxies=self.proxies, ).content
             try:
                 response = json.loads(content.decode("utf-8"))
-                if (response['return']['status']==200):
-                    response=response['entries']
+                if (response['return']['status'] == 200):
+                    return response['entries']
                 else:
-                    raise APIException('APIException[{}] {}'.format(response['return']['status'],response['return']['message']))
+                    raise APIException('APIException[{}] {}'.format(response['return']['status'], response['return']['message']))
             except ValueError as e:
                 raise HTTPException(e)
-            return (response)
         except requests.exceptions.RequestException as e:
-            raise HTTPException(e)
-
+            message = str(e).replace(self.apikey, self.apikey_mask)
+            raise HTTPException(message) from None
+
     def sms_send(self, params=None):
-        return self._request('sms', 'send',params)
-    
+        return self._request('sms', 'send', params)
+
     def sms_sendarray(self, params=None):
-        return self._request('sms', 'sendarray',params)
-    
+        return self._request('sms', 'sendarray', params)
+
     def sms_status(self, params=None):
-        return self._request('sms', 'status',params)
-    
+        return self._request('sms', 'status', params)
+
     def sms_statuslocalmessageid(self, params=None):
-        return self._request('sms', 'statuslocalmessageid',params)
-    
+        return self._request('sms', 'statuslocalmessageid', params)
+
     def sms_select(self, params=None):
-        return self._request('sms', 'select',params)
-    
+        return self._request('sms', 'select', params)
+
     def sms_selectoutbox(self, params=None):
-        return self._request('sms', 'selectoutbox',params)
-    
+        return self._request('sms', 'selectoutbox', params)
+
     def sms_latestoutbox(self, params=None):
-        return self._request('sms', 'latestoutbox',params)
-    
+        return self._request('sms', 'latestoutbox', params)
+
     def sms_countoutbox(self, params=None):
-        return self._request('sms', 'countoutbox',params)
-    
+        return self._request('sms', 'countoutbox', params)
+
     def sms_cancel(self, params=None):
-        return self._request('sms', 'cancel',params)
-    
+        return self._request('sms', 'cancel', params)
+
     def sms_receive(self, params=None):
-        return self._request('sms', 'receive',params)
-    
+        return self._request('sms', 'receive', params)
+
     def sms_countinbox(self, params=None):
-        return self._request('sms', 'countinbox',params)
-    
+        return self._request('sms', 'countinbox', params)
+
     def sms_countpostalcode(self, params=None):
-        return self._request('sms', 'countpostalcode',params)
-    
+        return self._request('sms', 'countpostalcode', params)
+
     def sms_sendbypostalcode(self, params=None):
-        return self._request('sms', 'sendbypostalcode',params)
-    
+        return self._request('sms', 'sendbypostalcode', params)
+
     def verify_lookup(self, params=None):
-        return self._request('verify', 'lookup',params)
-    
+        return self._request('verify', 'lookup', params)
+
     def call_maketts(self, params=None):
-        return self._request('call', 'maketts',params)   
-		
+        return self._request('call', 'maketts', params)
+
     def call_status(self, params=None):
-        return self._request('call', 'status',params)   
-    
+        return self._request('call', 'status', params)
+
     def account_info(self):
         return self._request('account', 'info')
-    
-    def account_config(self ,params=None):
-        return self._request('account', 'config',params)   
+
+    def account_config(self, params=None):
+        return self._request('account', 'config', params)