Merge pull request #97 from iotaledger/feature/96_findTransactionsChillOutBro

[#96] Do not include null terms in `findTransactions` reqs.

Author: todofixthis

iota/commands/core/find_transactions.py

@@ -3,6 +3,7 @@
   unicode_literals
 
 import filters as f
+from six import iteritems
 
 from iota import Address, Tag, TransactionHash
 from iota.commands import FilterCommand, RequestFilter, ResponseFilter
@@ -45,7 +46,6 @@ def __init__(self):
               | Trytes(result_type=Address)
               | f.Unicode(encoding='ascii', normalize=False)
             )
-          | f.Optional(default=[])
         ),
 
         'approvees': (
@@ -55,7 +55,6 @@ def __init__(self):
               | Trytes(result_type=TransactionHash)
               | f.Unicode(encoding='ascii', normalize=False)
             )
-          | f.Optional(default=[])
         ),
 
         'bundles': (
@@ -65,7 +64,6 @@ def __init__(self):
               | Trytes(result_type=TransactionHash)
               | f.Unicode(encoding='ascii', normalize=False)
             )
-          | f.Optional(default=[])
         ),
 
         'tags': (
@@ -75,7 +73,6 @@ def __init__(self):
               | Trytes(result_type=Tag)
               | f.Unicode(encoding='ascii', normalize=False)
             )
-          | f.Optional(default=[])
         ),
       },
 
@@ -91,16 +88,21 @@ def _apply(self, value):
     if self._has_errors:
       return value
 
+    # Remove null search terms.
+    # Note: We will assume that empty lists are intentional.
+    # https://github.com/iotaledger/iota.lib.py/issues/96
+    search_terms = {
+      term: query
+        for term, query in iteritems(value)
+        if query is not None
+    }
+
     # At least one search term is required.
-    if not any((
-        value['addresses'],
-        value['approvees'],
-        value['bundles'],
-        value['tags'],
-    )):
+    if not search_terms:
+      # Include unfiltered ``value`` in filter error context.
       return self._invalid_value(value, self.CODE_NO_SEARCH_VALUES)
 
-    return value
+    return search_terms
 
 
 class FindTransactionsResponseFilter(ResponseFilter):

test/commands/core/find_transactions_test.py

@@ -139,9 +139,11 @@ def test_pass_bundles_only(self):
           text_type(TransactionHash(self.trytes2)),
         ],
 
-        'addresses':  [],
-        'approvees':  [],
-        'tags':       [],
+        # Null criteria are not included in the request.
+        # https://github.com/iotaledger/iota.lib.py/issues/96
+        # 'addresses':  [],
+        # 'approvees':  [],
+        # 'tags':       [],
       },
     )
 
@@ -168,9 +170,11 @@ def test_pass_addresses_only(self):
           text_type(Address(self.trytes2)),
         ],
 
-        'approvees':  [],
-        'bundles':    [],
-        'tags':       [],
+        # Null criteria are not included in the request.
+        # https://github.com/iotaledger/iota.lib.py/issues/96
+        # 'approvees':  [],
+        # 'bundles':    [],
+        # 'tags':       [],
       },
     )
 
@@ -197,9 +201,11 @@ def test_pass_tags_only(self):
           text_type(Tag(self.trytes3)),
         ],
 
-        'addresses':  [],
-        'approvees':  [],
-        'bundles':    [],
+        # Null criteria are not included in the request.
+        # https://github.com/iotaledger/iota.lib.py/issues/96
+        # 'addresses':  [],
+        # 'approvees':  [],
+        # 'bundles':    [],
       },
     )
 
@@ -226,9 +232,11 @@ def test_pass_approvees_only(self):
           text_type(TransactionHash(self.trytes3)),
         ],
 
-        'addresses':  [],
-        'bundles':    [],
-        'tags':       [],
+        # Null criteria are not included in the request.
+        # https://github.com/iotaledger/iota.lib.py/issues/96
+        # 'addresses':  [],
+        # 'bundles':    [],
+        # 'tags':       [],
       },
     )
 
@@ -244,23 +252,38 @@ def test_fail_empty(self):
       },
     )
 
-  def test_fail_all_parameters_empty(self):
+  def test_fail_all_parameters_null(self):
     """
-    The request contains all parameters, but every one is empty.
+    The request contains all parameters, but every one is null.
     """
     self.assertFilterErrors(
       {
-        'addresses':  [],
-        'approvees':  [],
-        'bundles':    [],
-        'tags':       [],
+        'addresses':  None,
+        'approvees':  None,
+        'bundles':    None,
+        'tags':       None,
       },
 
       {
         '': [FindTransactionsRequestFilter.CODE_NO_SEARCH_VALUES],
       },
     )
 
+  def test_success_all_parameters_empty(self):
+    """
+    All of the parameters are empty lists.
+
+    This is technically valid, though probably not very useful.
+    """
+    self.assertFilterPasses(
+      {
+        'addresses':  [],
+        'approvees':  [],
+        'bundles':    [],
+        'tags':       [],
+      },
+    )
+
   def test_fail_unexpected_parameters(self):
     """
     The request contains unexpected parameters.

test/commands/extended/get_new_addresses_test.py

@@ -438,17 +438,11 @@ def test_get_addresses_online(self):
         {
           'command':    'findTransactions',
           'addresses':  [self.addy_1],
-          'approvees':  [],
-          'bundles':    [],
-          'tags':       [],
         },
 
         {
           'command':    'findTransactions',
           'addresses':  [self.addy_2],
-          'approvees':  [],
-          'bundles':    [],
-          'tags':       [],
         },
       ],
     )