Implement exact string search in REST API

Now with ':=' instead of '=' an exact string match is requested.
In addition we now support '~=' for a substring search.
The old semantics of '=' is kept. The new syntax works for all
types of properties but only makes a difference for String properties.

Note that this is not yet documented, pending discussion if we want to
keep this syntax.

Author: schlatterbeck

roundup/rest.py

@@ -644,6 +644,7 @@ def get_collection(self, class_name, input):
 
         # Handle filtering and pagination
         filter_props = {}
+        exact_props  = {}
         page = {
             'size': None,
             'index': 1   # setting just size starts at page 1
@@ -696,6 +697,12 @@ def get_collection(self, class_name, input):
                 # like @apiver
                 pass
             else: # serve the filter purpose
+                exact = False
+                if key.endswith (':') :
+                    exact = True
+                    key = key [:-1]
+                elif key.endswith ('~') :
+                    key = key [:-1]
                 p = key.split('.', 1)[0]
                 try: 
                     prop = class_obj.getprops()[p]
@@ -731,17 +738,24 @@ def get_collection(self, class_name, input):
                             vals.append(linkcls.lookup(p))
                     filter_props[key] = vals
                 else:
-                    if key in filter_props:
-                        if isinstance(filter_props[key], list):
-                            filter_props[key].append(value)
+                    if not isinstance (prop, hyperdb.String):
+                        exact = False
+                    props = filter_props
+                    if exact:
+                        props = exact_props
+                    if key in props:
+                        if isinstance(props[key], list):
+                            props[key].append(value)
                         else:
-                            filter_props[key]=[filter_props[key],value]
+                            props[key] = [props[key],value]
                     else:
-                        filter_props[key] = value
+                        props[key] = value
         l = [filter_props]
         kw = {}
         if sort:
             l.append(sort)
+        if exact_props:
+            kw ['exact_match_spec'] = exact_props
         if page ['size'] is not None and page ['size'] > 0:
             kw ['limit'] = page ['size']
             if page ['index'] is not None and page ['index'] > 1:

test/rest_common.py

@@ -241,6 +241,34 @@ def testGetTransitive(self):
         results = self.server.get_collection('issue', form)
         self.assertDictEqual(expected, results)
 
+    def testGetExactMatch(self):
+        """ Retrieve all issues with an exact title
+        """
+        base_path = self.db.config['TRACKER_WEB'] + 'rest/data/'
+        #self.maxDiff=None
+        self.create_sampledata()
+        self.db.issue.set('2', title='This is an exact match')
+        self.db.issue.set('3', title='This is an exact match')
+        self.db.issue.set('1', title='This is AN exact match')
+        expected={'data':
+                   {'@total_size': 2,
+                    'collection': [
+                      { 'id': '2',
+                        'link': base_path + 'issue/2',
+                      },
+                      { 'id': '3',
+                        'link': base_path + 'issue/3',
+                      },
+                    ]}
+                 }
+        form = cgi.FieldStorage()
+        form.list = [
+            cgi.MiniFieldStorage('title:', 'This is an exact match'),
+            cgi.MiniFieldStorage('@sort', 'status.name'),
+        ]
+        results = self.server.get_collection('issue', form)
+        self.assertDictEqual(expected, results)
+
     def testOutputFormat(self):
         """ test of @fields and @verbose implementation """