Support boolean type for key, endkey, and startkey in view requests (#504)

Author: mojito317

CHANGES.md

@@ -6,6 +6,7 @@
 - [FIXED] Incorrect use of username as account name in `Cloudant.bluemix()`.
 - [IMPROVED] Documented use of None account name and url override for `Cloudant.iam()`.
 - [FIXED] Use custom encoder (if provided) for all view `key` params not just `keys`.
+- [FIXED] Support boolean type for `key`, `endkey`, and `startkey` in view requests.
 
 # 2.14.0 (2020-08-17)
 

src/cloudant/_common_util.py

@@ -56,20 +56,20 @@
 
 RESULT_ARG_TYPES = {
     'descending': (bool,),
-    'endkey': (int, LONGTYPE, STRTYPE, Sequence,),
+    'endkey': (int, LONGTYPE, STRTYPE, Sequence, bool,),
     'endkey_docid': (STRTYPE,),
     'group': (bool,),
     'group_level': (int, LONGTYPE, NONETYPE,),
     'include_docs': (bool,),
     'inclusive_end': (bool,),
-    'key': (int, LONGTYPE, STRTYPE, Sequence,),
+    'key': (int, LONGTYPE, STRTYPE, Sequence, bool,),
     'keys': (list,),
     'limit': (int, LONGTYPE, NONETYPE,),
     'reduce': (bool,),
     'skip': (int, LONGTYPE, NONETYPE,),
     'stable': (bool,),
     'stale': (STRTYPE,),
-    'startkey': (int, LONGTYPE, STRTYPE, Sequence,),
+    'startkey': (int, LONGTYPE, STRTYPE, Sequence, bool,),
     'startkey_docid': (STRTYPE,),
     'update': (STRTYPE,),
 }
@@ -191,12 +191,13 @@ def py_to_couch_validate(key, val):
     # Validate argument values and ensure that a boolean is not passed in
     # if an integer is expected
     if (not isinstance(val, RESULT_ARG_TYPES[key]) or
-            (type(val) is bool and int in RESULT_ARG_TYPES[key])):
+            (type(val) is bool and bool not in RESULT_ARG_TYPES[key] and
+             int in RESULT_ARG_TYPES[key])):
         raise CloudantArgumentError(117, key, RESULT_ARG_TYPES[key])
     if key == 'keys':
         for key_list_val in val:
             if (not isinstance(key_list_val, RESULT_ARG_TYPES['key']) or
-                    type(key_list_val) is bool):
+                    isinstance(key_list_val, bool)):
                 raise CloudantArgumentError(134, RESULT_ARG_TYPES['key'])
     if key == 'stale':
         if val not in ('ok', 'update_after'):

tests/unit/param_translation_tests.py

@@ -55,6 +55,10 @@ def test_valid_endkey(self):
             python_to_couch({'endkey': ['foo', 10]}),
             {'endkey': '["foo", 10]'}
         )
+        self.assertEqual(
+            python_to_couch({'endkey': True}),
+            {'endkey': 'true'}
+        )
 
     def test_valid_endkey_docid(self):
         """
@@ -128,6 +132,10 @@ def test_valid_key(self):
             python_to_couch({'key': ['foo', 10]}),
             {'key': '["foo", 10]'}
         )
+        self.assertEqual(
+            python_to_couch({'key': True}),
+            {'key': 'true'}
+        )
 
     def test_valid_keys(self):
         """
@@ -205,6 +213,10 @@ def test_valid_startkey(self):
             python_to_couch({'startkey': ['foo', 10]}),
             {'startkey': '["foo", 10]'}
         )
+        self.assertEqual(
+            python_to_couch({'startkey': True}),
+            {'startkey': 'true'}
+        )
 
     def test_valid_startkey_docid(self):
         """
@@ -247,7 +259,7 @@ def test_invalid_endkey(self):
         """
         msg = 'Argument endkey not instance of expected type:'
         with self.assertRaises(CloudantArgumentError) as cm:
-            python_to_couch({'endkey': True})
+            python_to_couch({'endkey': {'foo': 'bar'}})
         self.assertTrue(str(cm.exception).startswith(msg))
 
     def test_invalid_endkey_docid(self):
@@ -302,7 +314,7 @@ def test_invalid_key(self):
         """
         msg = 'Argument key not instance of expected type:'
         with self.assertRaises(CloudantArgumentError) as cm:
-            python_to_couch({'key': True})
+            python_to_couch({'key': {'foo': 'bar'}})
         self.assertTrue(str(cm.exception).startswith(msg))
 
     def test_invalid_keys_not_list(self):
@@ -372,7 +384,7 @@ def test_invalid_startkey(self):
         """
         msg = 'Argument startkey not instance of expected type:'
         with self.assertRaises(CloudantArgumentError) as cm:
-            python_to_couch({'startkey': True})
+            python_to_couch({'startkey': {'foo': 'bar'}})
         self.assertTrue(str(cm.exception).startswith(msg))
 
     def test_invalid_startkey_docid(self):