Merge pull request d3v-null#9 from norbert-sebok/master

claudiosanches · claudiosanches · commit 10c0002a2cfe · 2015-12-07T18:09:55.000-02:00
Keeps the filter[*] parameters in the original order, closes d3v-null#8
diff --git a/tests.py b/tests.py
@@ -1,6 +1,7 @@
 """ API Tests """
 import unittest
 import woocommerce
+from woocommerce import oauth
 from httmock import all_requests, HTTMock
 
 
@@ -116,3 +117,20 @@ def woo_test_mock(*args, **kwargs):
             # call requests
             status = self.api.delete("products").status_code
         self.assertEqual(status, 200)
+
+    def test_oauth_sorted_params(self):
+        """ Test order of parameters for OAuth signature """
+        def check_sorted(keys, expected):
+            params = oauth.OrderedDict()
+            for key in keys:
+                params[key] = ''
+
+            ordered = list(oauth.OAuth.sorted_params(params).keys())
+            self.assertEqual(ordered, expected)
+
+        check_sorted(['a', 'b'], ['a', 'b'])
+        check_sorted(['b', 'a'], ['a', 'b'])
+        check_sorted(['a', 'b[a]', 'b[b]', 'b[c]', 'c'], ['a', 'b[a]', 'b[b]', 'b[c]', 'c'])
+        check_sorted(['a', 'b[c]', 'b[a]', 'b[b]', 'c'], ['a', 'b[c]', 'b[a]', 'b[b]', 'c'])
+        check_sorted(['d', 'b[c]', 'b[a]', 'b[b]', 'c'], ['b[c]', 'b[a]', 'b[b]', 'c', 'd'])
+        check_sorted(['a1', 'b[c]', 'b[a]', 'b[b]', 'a2'], ['a1', 'a2', 'b[c]', 'b[a]', 'b[b]'])
diff --git a/woocommerce/oauth.py b/woocommerce/oauth.py
@@ -39,7 +39,7 @@ def __init__(self, url, consumer_key, consumer_secret, **kwargs):
 
     def get_oauth_url(self):
         """ Returns the URL with OAuth params """
-        params = {}
+        params = OrderedDict()
 
         if "?" in self.url:
             url = self.url[:self.url.find("?")]
@@ -68,8 +68,8 @@ def generate_oauth_signature(self, params, url):
             del params["oauth_signature"]
 
         base_request_uri = quote(url, "")
+        params = self.sorted_params(params)
         params = self.normalize_parameters(params)
-        params = OrderedDict(sorted(params.items()))
         query_params = ["{param_key}%3D{param_value}".format(param_key=key, param_value=value)
                         for key, value in params.items()]
 
@@ -88,11 +88,23 @@ def generate_oauth_signature(self, params, url):
 
         return b64encode(hash_signature).decode("utf-8").replace("\n", "")
 
+    @staticmethod
+    def sorted_params(params):
+        ordered = OrderedDict()
+        base_keys = sorted(set(k.split('[')[0] for k in params.keys()))
+
+        for base in base_keys:
+            for key in params.keys():
+                if key == base or key.startswith(base + '['):
+                    ordered[key] = params[key]
+
+        return ordered
+
     @staticmethod
     def normalize_parameters(params):
         """ Normalize parameters """
         params = params or {}
-        normalized_parameters = {}
+        normalized_parameters = OrderedDict()
 
         def get_value_like_as_php(val):
             """ Prepare value for quote """
