Merge lp:~terrycojones/txfluiddb/add-slash-values-support-821418 into lp:~terrycojones/txfluiddb/add-exists-tests-for-namespaces-and-tags

[Terry Jones]

A simple approach to letting txFluidDB call the /values endpoint in Fluidinfo.

Unmerged revisions

18. By Terry Jones on 2011-08-06

Bumped version number.

17. By Terry Jones on 2011-08-06

Added simple support for GET, PUT, DELETE on /values.

=== modified file 'setup.py'
--- setup.py	2011-07-31 21:38:07 +0000
+++ setup.py	2011-08-06 13:24:39 +0000
@@ -5,7 +5,7 @@
 
 setup(
     name = 'txfluiddb',
-    version = '0.1.1',
+    version = '0.1.2',
     packages = ['txfluiddb'],
     author = 'Tristan Seligmann',
 )
 
=== modified file 'txfluiddb/client.py'
--- txfluiddb/client.py	2011-07-31 21:29:38 +0000
+++ txfluiddb/client.py	2011-08-06 13:24:39 +0000
@@ -436,6 +436,79 @@
     collectionName = u'tag-values'
 
 
+class Values(object):
+    """
+    Provides for operations on sets of tag values using the Fluidinfo
+    /values endpoint.
+    """
+
+
+    def get(self, endpoint, query, tags):
+        """
+        Get the tag values matching a query.
+
+        @type  endpoint: L{Endpoint}
+        @param endpoint: The endpoint to operate through.
+
+        @type  query: C{unicode}
+        @param query: The query specifiying which Fluidinfo
+            objects to operate on.
+
+        @type  tags: C{list} of C{unicode}
+        @param tags: The tags whose values are wanted.
+
+        @rtype: C{Deferred}
+        """
+        url = '%svalues?%s' % (
+            endpoint.getRootURL(),
+            urlencode({
+                'query' : query.encode('utf-8'),
+                'tag' : [tag.encode('utf-8') for tag in tags],
+                }, doseq=True))
+        return endpoint.submit(url=url, method='GET')
+
+
+    def put(self, endpoint, payload):
+        """
+        Delete tag values matching queries.
+
+        @type  endpoint: L{Endpoint}
+        @param endpoint: The endpoint to operate through.
+
+        @type  payload: C{dict}
+        @param payload: A dictionary to be converted to JSON
+            for the request payload to the /values endpoint.
+
+        @rtype: C{Deferred}
+        """
+        return endpoint.submit(url='%svalues' % endpoint.getRootURL(),
+                               method='PUT')
+
+
+    def delete(self, endpoint, query, tags):
+        """
+        Delete the tag values matching a query.
+
+        @type  endpoint: L{Endpoint}
+        @param endpoint: The endpoint to operate through.
+
+        @type  query: C{unicode}
+        @param query: The query specifiying which Fluidinfo
+            objects to operate on.
+
+        @type  tags: C{list} of C{unicode}
+        @param tags: The tags whose values should be deleted.
+
+        @rtype: C{Deferred}
+        """
+        url = '%svalues?%s' % (
+            endpoint.getRootURL(),
+            urlencode({
+                'query' : query.encode('utf-8'),
+                'tag' : [tag.encode('utf-8') for tag in tags],
+                }, doseq=True))
+        return endpoint.submit(url=url, method='DELETE')
+
 
 class BasicCreds(object):
     """
 
=== modified file 'txfluiddb/test/test_client.py'
--- txfluiddb/test/test_client.py	2011-07-31 21:29:38 +0000
+++ txfluiddb/test/test_client.py	2011-08-06 13:24:39 +0000
@@ -1,11 +1,13 @@
 from twisted.trial.unittest import TestCase
 from twisted.internet.defer import succeed, fail
 
+from urllib import splitquery
+
 import simplejson as json
 
 from txfluiddb.errors import InvalidName
-from txfluiddb.client import (
-    Namespace, Tag, Endpoint, _HasPath, Object, Blob, BasicCreds, loads)
+from txfluiddb.client import (Namespace, Tag, Values, Endpoint, _HasPath,
+    Object, Blob, BasicCreds, loads)
 from txfluiddb.http import HTTPError
 
 
@@ -623,6 +625,222 @@
         return d
 
 
+class ValuesTests(TestCase):
+    """
+    Tests for the /values URI endpoint on Fluidinfo.
+    """
+    def setUp(self):
+        self.endpoint = MockEndpoint('http://fluiddb.url/')
+        self.values = Values()
+
+
+    def testGetMethodAndURI(self):
+        """
+        Check that the requested URI for GET starts with the /values
+        endpoint and that the request method is correct.
+        """
+        self.endpoint.response = None
+        d = self.values.get(self.endpoint, u'fake query', [u'fake tag'])
+        self.assertEqual(self.endpoint.method, 'GET')
+        self.assertTrue(
+            self.endpoint.url.startswith('http://fluiddb.url/values'))
+        return d
+
+
+    def testGetTagCountAndContent(self):
+        """
+        Check that the requested URI has the expected number of tag=
+        arguments and that the expected values are all present.
+        """
+        self.endpoint.response = None
+        d = self.values.get(
+            self.endpoint,
+            query=u'has fun/eating',
+            tags=[u'hey/you', u'who/me', u'yes/you'])
+        self.assertEqual(3, self.endpoint.url.count('tag='))
+        self.assertTrue(1, self.endpoint.url.count('tag=hey%2Fyou'))
+        self.assertTrue(1, self.endpoint.url.count('tag=who%2Fme'))
+        self.assertTrue(1, self.endpoint.url.count('tag=yes%2Fyou'))
+        return d
+
+
+    def testGetQueryCount(self):
+        """
+        Check that the requested URI has one query= argument, with the
+        expected value.
+        """
+        self.endpoint.response = None
+        d = self.values.get(
+            self.endpoint,
+            query=u'has fun/eating',
+            tags=[u'hey/you'])
+        self.assertEqual(1, self.endpoint.url.count('query='))
+        self.assertTrue(1, self.endpoint.url.count('query=has+fun%2Feating'))
+        return d
+
+
+    def testGetTagURIEncoding(self):
+        """
+        Check that the requested tag name is properly UTF-8 and %-encoded
+        in the request URI.
+        """
+        self.endpoint.response = None
+        d = self.values.get(
+            self.endpoint,
+            query=u'has fun/eating',
+            tags=[u'hey/y \xF2 u'])
+        _, query = splitquery(self.endpoint.url)
+        args = query.split('&')
+        # Find the argument that starts with tag=
+        if args[0].startswith('tag='):
+            arg = args[0]
+        else:
+            arg = args[1]
+        value = arg.split('=')[1]
+        # The argument value should have its '/' %-encoded, the spaces
+        # converted to '+', and the %-encoded UTF-8 of the unicode
+        # \xF2 char.
+        self.assertEqual('hey%2Fy+%C3%B2+u', value)
+        return d
+
+
+    def testGetQueryURIEncoding(self):
+        """
+        Check that the requested query is properly UTF-8 and %-encoded in
+        the request URI.
+        """
+        response = {}
+        self.endpoint.response = json.dumps(response)
+        d = self.values.get(
+            self.endpoint,
+            query=u'joe/blow = "embedded/slash with \xF1"',
+            tags=[u'hey/you'])
+        _, query = splitquery(self.endpoint.url)
+        args = query.split('&')
+        # Find the argument that starts with query=
+        if args[0].startswith('query='):
+            arg = args[0]
+        else:
+            arg = args[1]
+        value = arg.split('=')[1]
+        # The argument value should have the '/', '=' and '"' %-encoded,
+        # the spaces converted to '+', and the %-encoded UTF-8 of the
+        # unicode \xF1 char.
+        self.assertEqual('joe%2Fblow+%3D+%22embedded%2Fslash+with+%C3%B1%22',
+                         value)
+        return d
+
+
+    def testPutMethodAndURI(self):
+        """
+        Check that the requested URI for PUT has just the /values endpoint
+        (the details of the PUT request are sent in the payload) and that
+        the request method is correct.
+        """
+        self.endpoint.response = None
+        d = self.values.put(self.endpoint, None)
+        self.assertEqual(self.endpoint.method, 'PUT')
+        self.assertEqual(self.endpoint.url, 'http://fluiddb.url/values')
+        return d
+
+
+    def testDeleteMethodAndURI(self):
+        """
+        Check that the requested URI for DELETE starts with the /values
+        endpoint and that the request method is correct.
+        """
+        self.endpoint.response = None
+        d = self.values.delete(self.endpoint, u'fake query', [u'fake tag'])
+        self.assertEqual(self.endpoint.method, 'DELETE')
+        self.assertTrue(
+            self.endpoint.url.startswith('http://fluiddb.url/values'))
+        return d
+
+
+    def testDeleteTagCountAndContent(self):
+        """
+        Check that the requested URI has the expected number of tag=
+        arguments and that the expected values are all present.
+        """
+        self.endpoint.response = None
+        d = self.values.delete(
+            self.endpoint,
+            query=u'has fun/eating',
+            tags=[u'hey/you', u'who/me', u'yes/you'])
+        self.assertEqual(3, self.endpoint.url.count('tag='))
+        self.assertTrue(1, self.endpoint.url.count('tag=hey%2Fyou'))
+        self.assertTrue(1, self.endpoint.url.count('tag=who%2Fme'))
+        self.assertTrue(1, self.endpoint.url.count('tag=yes%2Fyou'))
+        return d
+
+
+    def testDeleteQueryCount(self):
+        """
+        Check that the requested URI has one query= argument, with the
+        expected value.
+        """
+        self.endpoint.response = None
+        d = self.values.delete(
+            self.endpoint,
+            query=u'has fun/eating',
+            tags=[u'hey/you'])
+        self.assertEqual(1, self.endpoint.url.count('query='))
+        self.assertTrue(1, self.endpoint.url.count('query=has+fun%2Feating'))
+        return d
+
+
+    def testDeleteTagURIEncoding(self):
+        """
+        Check that the requested tag name is properly UTF-8 and %-encoded
+        in the request URI.
+        """
+        self.endpoint.response = None
+        d = self.values.delete(
+            self.endpoint,
+            query=u'has fun/eating',
+            tags=[u'hey/y \xF2 u'])
+        _, query = splitquery(self.endpoint.url)
+        args = query.split('&')
+        # Find the argument that starts with tag=
+        if args[0].startswith('tag='):
+            arg = args[0]
+        else:
+            arg = args[1]
+        value = arg.split('=')[1]
+        # The argument value should have its '/' %-encoded, the spaces
+        # converted to '+', and the %-encoded UTF-8 of the unicode
+        # \xF2 char.
+        self.assertEqual('hey%2Fy+%C3%B2+u', value)
+        return d
+
+
+    def testDeleteQueryURIEncoding(self):
+        """
+        Check that the requested query is properly UTF-8 and %-encoded in
+        the request URI.
+        """
+        response = {}
+        self.endpoint.response = json.dumps(response)
+        d = self.values.delete(
+            self.endpoint,
+            query=u'joe/blow = "embedded/slash with \xF1"',
+            tags=[u'hey/you'])
+        _, query = splitquery(self.endpoint.url)
+        args = query.split('&')
+        # Find the argument that starts with query=
+        if args[0].startswith('query='):
+            arg = args[0]
+        else:
+            arg = args[1]
+        value = arg.split('=')[1]
+        # The argument value should have the '/', '=' and '"' %-encoded,
+        # the spaces converted to '+', and the %-encoded UTF-8 of the
+        # unicode \xF1 char.
+        self.assertEqual('joe%2Fblow+%3D+%22embedded%2Fslash+with+%C3%B1%22',
+                         value)
+        return d
+
+
 
 class MockEndpoint(Endpoint):
     """