fix bugs with params transformation

Author: Akop Kesheshyan

bitrix24/bitrix24.py

@@ -31,30 +31,38 @@ def __init__(self, domain, timeout=60):
         self.domain = self._prepare_domain(domain)
         self.timeout = timeout
 
-    def _prepare_domain(string):    
+    def _prepare_domain(self, string):
         """Normalize user passed domain to a valid one."""
         o = urlparse(string)
         user_id, code = o.path.split('/')[2:4]
         return "{0}://{1}/rest/{2}/{3}".format(o.scheme, o.netloc, user_id, code)
 
-    def _prepare_params(self, params, prev = ''):
+    def _prepare_params(self, params, prev=''):
         """Transforms list of params to a valid bitrix array."""
+        ret = ''
         if isinstance(params, dict):
-            ret = ''
             for key, value in params.items():
                 if isinstance(value, dict):
                     if prev:
                         key = "{0}[{1}]".format(prev, key)
                     ret += self._prepare_params(value, key)
                 elif (isinstance(value, list) or isinstance(value, tuple)) and len(value) > 0:
                     for offset, val in enumerate(value):
-                        ret += "{0}[{1}][{2}]={3}&".format(prev, key, offset, val)
+                        if isinstance(val, dict):
+                            ret += self._prepare_params(
+                                val, "{0}[{1}][{2}]".format(prev, key, offset))
+                        else:
+                            if prev:
+                                ret += "{0}[{1}][{2}]={3}&".format(
+                                    prev, key, offset, val)
+                            else:
+                                ret += "{0}[{1}]={2}&".format(key, offset, val)
                 else:
                     if prev:
                         ret += "{0}[{1}]={2}&".format(prev, key, value)
                     else:
                         ret += "{0}={1}&".format(key, value)
-            return ret
+        return ret
 
     def callMethod(self, method, **params):
         """Calls a REST method with specified parameters.
@@ -79,7 +87,7 @@ def callMethod(self, method, **params):
             # Looks like we need to wait until expires limitation time by Bitrix24 API
             sleep(2)
             return self.callMethod(method, **params)
-        
+
         if 'error' in r:
             raise BitrixError(r)
         if 'start' not in params:

tests/test_bitrix24.py

@@ -27,5 +27,55 @@ def test_call_non_exists_method(self):
             self.b24.callMethod('hello.world')
 
 
+class ParamsPreparationTest(unittest.TestCase):
+
+    def setUp(self):
+        self.b24 = Bitrix24('http://example.bitrix24.com/rest/1/123456789')
+
+    def test_one_level(self):
+        params = {"fruit": "apple"}
+        param_string = self.b24._prepare_params(params)        
+        self.assertEqual(param_string, "fruit=apple&")
+
+    def test_one_level_several_items(self):
+        params = {"fruit": "apple", "vegetable":"broccoli"}
+        param_string = self.b24._prepare_params(params)        
+        self.assertEqual(param_string, "fruit=apple&vegetable=broccoli&")
+
+    def test_multi_level(self):
+        params = {"fruit": {"citrus":"lemon"}}
+        param_string = self.b24._prepare_params(params)        
+        self.assertEqual(param_string, "fruit[citrus]=lemon&")
+    
+    def test_multi_level_deep(self):
+        params = {"root": {"level 1":{"level 2":{"level 3":"value"}}}}
+        param_string = self.b24._prepare_params(params)        
+        self.assertEqual(param_string, "root[level 1][level 2][level 3]=value&")
+    
+    def test_list_dict_mixed(self):
+        params = {"root":{"level 1":[{"list_dict 1": "value 1"}, {"list_dict 2": "value 2"}]}}
+        param_string = self.b24._prepare_params(params)        
+        self.assertEqual(param_string, "root[level 1][0][list_dict 1]=value 1&root[level 1][1][list_dict 2]=value 2&")
+    
+    def test_multi_level_several_items(self):
+        params = {"fruit": {"citrus":"lemon", "sweet": "apple"}}
+        param_string = self.b24._prepare_params(params)        
+        self.assertEqual(param_string, "fruit[citrus]=lemon&fruit[sweet]=apple&")
+
+    def test_list(self):
+        params = {"fruit": ["lemon", "apple"]}
+        param_string = self.b24._prepare_params(params)        
+        self.assertEqual(param_string, "fruit[0]=lemon&fruit[1]=apple&")
+
+    def test_tuple(self):
+        params = {"fruit": ("lemon", "apple")}
+        param_string = self.b24._prepare_params(params)        
+        self.assertEqual(param_string, "fruit[0]=lemon&fruit[1]=apple&")
+    
+    def test_string(self):
+        param_string = self.b24._prepare_params('')        
+        self.assertEqual(param_string, "")
+
+
 if __name__ == '__main__':
     unittest.main()