Merge lp:~eday/burrow/cleanup into lp:burrow

[Eric Day]

Added client API interfaces (Account and Queue), modified HTTP response formatting, misc doc/code cleanup.

=== modified file '.bzrignore'
--- .bzrignore	2011-04-20 05:14:30 +0000
+++ .bzrignore	2011-04-20 18:31:01 +0000
@@ -1,4 +1,6 @@
+.coverage
 burrow.egg-info
 ChangeLog
+coverage
 dist
 doc/build/*

=== modified file 'burrow/__init__.py'
--- burrow/__init__.py	2011-04-20 05:14:30 +0000
+++ burrow/__init__.py	2011-04-20 18:31:01 +0000
@@ -17,7 +17,7 @@
 
 import gettext
 
-from burrow.client import Client
+from burrow.client import Client, Account, Queue
 from burrow.server import Server
 
 __version__ = '2011.2'

=== modified file 'burrow/backend/http.py'
--- burrow/backend/http.py	2011-04-18 20:07:11 +0000
+++ burrow/backend/http.py	2011-04-20 18:31:01 +0000
@@ -15,6 +15,7 @@
 '''HTTP backend for burrow using httplib.'''
 
 import httplib
+import json
 
 import burrow.backend
 
@@ -29,52 +30,52 @@
 
     def delete_accounts(self, filters={}):
         url = self._add_parameters('', filters=filters)
-        self._request('DELETE', url)
+        return self._request('DELETE', url)
 
     def get_accounts(self, filters={}):
         url = self._add_parameters('', filters=filters)
-        self._request('GET', url)
+        return self._request('GET', url)
 
     def delete_queues(self, account, filters={}):
         url = self._add_parameters('/%s' % account, filters=filters)
-        self._request('DELETE', url)
+        return self._request('DELETE', url)
 
     def get_queues(self, account, filters={}):
         url = self._add_parameters('/%s' % account, filters=filters)
-        self._request('GET', url)
+        return self._request('GET', url)
 
     def delete_messages(self, account, queue, filters={}):
         url = '/%s/%s' % (account, queue)
         url = self._add_parameters(url, filters=filters)
-        self._request('DELETE', url)
+        return self._request('DELETE', url)
 
     def get_messages(self, account, queue, filters={}):
         url = '/%s/%s' % (account, queue)
         url = self._add_parameters(url, filters=filters)
-        self._request('GET', url)
+        return self._request('GET', url)
 
     def update_messages(self, account, queue, attributes={}, filters={}):
         url = '/%s/%s' % (account, queue)
         url = self._add_parameters(url, attributes, filters)
-        self._request('POST', url)
+        return self._request('POST', url)
 
     def create_message(self, account, queue, message, body, attributes={}):
         url = '/%s/%s/%s' % (account, queue, message)
         url = self._add_parameters(url, attributes)
-        self._request('PUT', url, body=body)
+        return self._request('PUT', url, body=body)
 
     def delete_message(self, account, queue, message):
         url = '/%s/%s/%s' % (account, queue, message)
-        self._request('DELETE', url)
+        return self._request('DELETE', url)
 
     def get_message(self, account, queue, message):
         url = '/%s/%s/%s' % (account, queue, message)
-        self._request('GET', url)
+        return self._request('GET', url)
 
     def update_message(self, account, queue, message, attributes={}):
         url = '/%s/%s/%s' % (account, queue, message)
         url = self._add_parameters(url, attributes)
-        self._request('POST', url)
+        return self._request('POST', url)
 
     def clean(self):
         pass
@@ -98,6 +99,6 @@
         connection.request(method, '/v1.0' + url, *args, **kwargs)
         response = connection.getresponse()
         if response.status == 200:
-            print response.read()
+            return json.loads(response.read())
         if response.status >= 400:
-            print response.reason
+            raise Exception(response.reason)

=== modified file 'burrow/client.py'
--- burrow/client.py	2011-04-20 05:14:30 +0000
+++ burrow/client.py	2011-04-20 18:31:01 +0000
@@ -43,3 +43,64 @@
         backend = self.config.get('backend', DEFAULT_BACKEND)
         config = (self._config, backend)
         return burrow.common.import_class(backend, 'Backend')(config)
+
+    def __getattr__(self, name):
+        return getattr(self.backend, name)
+
+
+class Account(object):
+    '''Convenience wrapper around the Client class that saves the
+    account setting. This allows you to use methods without specifying
+    the 'account' parameter every time.'''
+
+    account_methods = [
+        'delete_queues',
+        'get_queues',
+        'delete_messages',
+        'get_messages',
+        'update_messages',
+        'create_message',
+        'delete_message',
+        'get_message',
+        'update_message']
+
+    def __init__(self, account, client=None, **kwargs):
+        self.account = account
+        if client is None:
+            self.client = Client(**kwargs)
+        else:
+            self.client = client
+
+    def __getattr__(self, name):
+        '''If the requested method is an account method, return a
+        wrapper with the given account parameters.'''
+        if name not in self.account_methods:
+            return getattr(self.client, name)
+
+        def function(*args, **kwargs):
+            '''Call the client method with the account.'''
+            return getattr(self.client, name)(self.account, *args, **kwargs)
+        return function
+
+
+class Queue(Account):
+    '''Convenience wrapper around the Client class that saves the
+    account and queue setting. This allows you to use methods without
+    specifying the 'account' and 'queue' parameter every time.'''
+
+    def __init__(self, account, queue, **kwargs):
+        super(Queue, self).__init__(account, **kwargs)
+        self.queue = queue
+        self.queue_methods = self.account_methods[2:]
+
+    def __getattr__(self, name):
+        '''If the requested method is a queue method, return a wrapper
+        with the given account and queue parameters.'''
+        if name not in self.queue_methods:
+            return super(Queue, self).__getattr__(name)
+
+        def function(*args, **kwargs):
+            '''Call the client method with the account and queue.'''
+            return getattr(self.client, name)(self.account, self.queue, *args,
+                **kwargs)
+        return function

=== modified file 'burrow/frontend/wsgi.py'
--- burrow/frontend/wsgi.py	2011-04-20 05:14:30 +0000
+++ burrow/frontend/wsgi.py	2011-04-20 18:31:01 +0000
@@ -226,8 +226,7 @@
             detail = req.params['detail']
         message = self._filter_message(detail, message)
         if message is not None:
-            body = {account: {queue: [message]}}
-            return webob.exc.HTTPOk(body=json.dumps(body, indent=2))
+            return webob.exc.HTTPOk(body=json.dumps(message, indent=2))
         return webob.exc.HTTPNoContent()
 
     def _return_messages(self, req, account, queue, messages, detail):
@@ -242,8 +241,7 @@
                 filtered_messages.append(message)
         if len(filtered_messages) == 0:
             return webob.exc.HTTPNoContent()
-        body = {account: {queue: filtered_messages}}
-        return webob.exc.HTTPOk(body=json.dumps(body, indent=2))
+        return webob.exc.HTTPOk(body=json.dumps(filtered_messages, indent=2))
 
     def _parse_filters(self, req):
         filters = {}

=== modified file 'burrow/shell.py'
--- burrow/shell.py	2011-04-20 05:14:30 +0000
+++ burrow/shell.py	2011-04-20 18:31:01 +0000
@@ -100,6 +100,7 @@
         (self.options, self.args) = self.parser.parse_args()
         if self.options.commands:
             self.print_help()
+            sys.exit(1)
         if self.options.files is None:
             files = []
         else:
@@ -136,6 +137,9 @@
             command = command.split()
             if len(command) == 0:
                 continue
+            if command[0] == 'help':
+                self.print_help(print_options_help=False)
+                continue
             if command[0] == 'exit' or command[0] == 'quit':
                 break
             yield command
@@ -147,29 +151,24 @@
             print _('Command not found: %s') % command
             return
         if len(args) != len(section['args']):
-            print _('Wrong number of arguments')
+            for arg in section['args']:
+                command += ' <%s>' % arg
+            print _('Wrong number of arguments: %s') % command
             return
         if section.get('account', None):
             args.insert(0, self.options.account)
         if command in self.stdin_commands:
             args.append(sys.stdin.read())
         if command in self.attribute_commands:
-            attributes = {}
-            if self.options.ttl is not None:
-                attributes['ttl'] = self.options.ttl
-            if self.options.hide is not None:
-                attributes['hide'] = self.options.hide
-            args.append(attributes)
+            args.append(self._pack_attributes())
         if section.get('filters', None):
-            filters = {}
-            if self.options.limit is not None:
-                filters['limit'] = self.options.limit
-            if self.options.marker is not None:
-                filters['marker'] = self.options.marker
-            if self.options.all is not None:
-                filters['match_hidden'] = self.options.all
-            args.append(filters)
-        getattr(self.client.backend, command)(*args)
+            args.append(self._pack_filters())
+        try:
+            result = getattr(self.client, command)(*args)
+        except Exception, exception:
+            print exception
+            return
+        self._print_result(result)
 
     def _get_section(self, command):
         '''Lookup command in the defined command sections.'''
@@ -178,13 +177,51 @@
                 return section
         return None
 
-    def print_help(self, message=None):
+    def _pack_attributes(self):
+        '''Pack attributes given in command line options.'''
+        attributes = {}
+        if self.options.ttl is not None:
+            attributes['ttl'] = self.options.ttl
+        if self.options.hide is not None:
+            attributes['hide'] = self.options.hide
+        return attributes
+
+    def _pack_filters(self):
+        '''Pack filters given in command line options.'''
+        filters = {}
+        if self.options.limit is not None:
+            filters['limit'] = self.options.limit
+        if self.options.marker is not None:
+            filters['marker'] = self.options.marker
+        if self.options.all is not None:
+            filters['match_hidden'] = self.options.all
+        return filters
+
+    def _print_result(self, result):
+        '''Format and print the result.'''
+        if isinstance(result, list):
+            for item in result:
+                if isinstance(item, dict):
+                    self._print_message(item)
+                else:
+                    print item
+        elif isinstance(result, dict):
+            self._print_message(result)
+        elif result is not None:
+            print result
+
+    def _print_message(self, item):
+        '''Format and print message.'''
+        print 'id =', item['id']
+        for key, value in item.iteritems():
+            if key != 'id':
+                print '    ', key, '=', value
+
+    def print_help(self, print_options_help=True):
         '''Print the parser generated help along with burrow command help.'''
-        if message:
-            print message
+        if print_options_help:
+            self.parser.print_help()
             print
-        self.parser.print_help()
-        print
         for section in self.sections:
             print '%s commands:' % section['name']
             for command in section['commands']:
@@ -197,7 +234,6 @@
                     help_string += ' <%s>' % arg
                 print '    %s%s' % (command, help_string)
             print
-        sys.exit(1)
 
 
 if __name__ == '__main__':

=== modified file 'doc/source/index.rst'
--- doc/source/index.rst	2011-04-18 20:07:11 +0000
+++ doc/source/index.rst	2011-04-20 18:31:01 +0000
@@ -61,6 +61,6 @@
     server
     frontends
     backends
-    common
+    misc
 
 * :ref:`modindex`

=== renamed file 'doc/source/common.rst' => 'doc/source/misc.rst'
--- doc/source/common.rst	2011-04-08 02:31:30 +0000
+++ doc/source/misc.rst	2011-04-20 18:31:01 +0000
@@ -13,13 +13,13 @@
   See the License for the specific language governing permissions and
   limitations under the License.
 
+Miscellaneous
+*************
+
 Common
-******
-
-Core
-====
-
-.. automodule:: burrow
+======
+
+.. automodule:: burrow.common
     :members:
     :undoc-members:
     :show-inheritance:

=== modified file 'test/frontend/test_wsgi.py'
--- test/frontend/test_wsgi.py	2011-04-18 20:07:11 +0000
+++ test/frontend/test_wsgi.py	2011-04-20 18:31:01 +0000
@@ -45,30 +45,30 @@
 
     def test_account(self):
         self._put_url('/a/q/1')
-        accounts = self._get_url('')
-        self.assertEquals(accounts, ['a'])
+        result = self._get_url('')
+        self.assertEquals(result, ['a'])
         self._delete_url('/a')
 
     def test_queue(self):
         self._put_url('/a/q/1')
-        accounts = self._get_url('/a')
-        self.assertEquals(accounts, ['q'])
+        result = self._get_url('/a')
+        self.assertEquals(result, ['q'])
         self._delete_url('/a/q')
 
     def test_message(self):
         self._put_url('/a/q/1', body='b')
-        accounts = self._get_url('/a/q')
-        self.assertMessages(accounts, 'a', 'q', [self.message('1', body='b')])
+        result = self._get_url('/a/q')
+        self.assertMessages(result, [self.message('1', body='b')])
         self._delete_url('/a/q/1')
 
     def test_message_post(self):
         self._put_url('/a/q/1', body='b')
         for x in range(0, 3):
-            accounts = self._post_url('/a/q/1?ttl=%d&hide=%d' % (x, x))
-            self.assertEquals(accounts, {'a': {'q': [{'id': '1'}]}})
-            accounts = self._get_url('/a/q?hidden=true')
+            result = self._post_url('/a/q/1?ttl=%d&hide=%d' % (x, x))
+            self.assertEquals(result, {'id': '1'})
+            result = self._get_url('/a/q?hidden=true')
             message = self.message('1', x, x, body='b')
-            self.assertMessages(accounts, 'a', 'q', [message])
+            self.assertMessages(result, [message])
         self._delete_url('/a/q/1')
 
     def test_message_put(self):
@@ -76,151 +76,151 @@
             url = '/a/q/1?ttl=%d&hide=%d' % (x, x)
             status = 201 if x == 0 else 204
             self._put_url(url, body=str(x), status=status)
-            accounts = self._get_url('/a/q?hidden=true')
+            result = self._get_url('/a/q?hidden=true')
             message = self.message('1', x, x, body=str(x))
-            self.assertMessages(accounts, 'a', 'q', [message])
+            self.assertMessages(result, [message])
         self._delete_url('/a/q/1')
 
     def test_message_delete_limit(self):
         [self._put_url('/a/q/%d' % x) for x in range(1, 5)]
-        accounts = self._delete_url('/a/q?limit=3&detail=all', status=200)
+        result = self._delete_url('/a/q?limit=3&detail=all', status=200)
         messages = []
         messages.append(self.message('1'))
         messages.append(self.message('2'))
         messages.append(self.message('3'))
-        self.assertMessages(accounts, 'a', 'q', messages)
-        accounts = self._delete_url('/a/q?limit=3&detail=all', status=200)
+        self.assertMessages(result, messages)
+        result = self._delete_url('/a/q?limit=3&detail=all', status=200)
         message = self.message('4')
-        self.assertMessages(accounts, 'a', 'q', [message])
+        self.assertMessages(result, [message])
 
     def test_message_get_limit(self):
         [self._put_url('/a/q/%d' % x) for x in range(1, 5)]
         for x in range(0, 4):
-            accounts = self._get_url('/a/q?limit=3')
+            result = self._get_url('/a/q?limit=3')
             messages = []
             for y in range(x, 4)[:3]:
                 messages.append(self.message(str(y + 1)))
-            self.assertMessages(accounts, 'a', 'q', messages)
+            self.assertMessages(result, messages)
             self._delete_url('/a/q/%d' % (x + 1))
 
     def test_message_post_limit(self):
         [self._put_url('/a/q/%d' % x) for x in range(1, 5)]
         for x in range(0, 4):
-            accounts = self._post_url('/a/q?limit=3&ttl=%d&detail=all' % x)
+            result = self._post_url('/a/q?limit=3&ttl=%d&detail=all' % x)
             messages = []
             for y in range(x, 4)[:3]:
                 messages.append(self.message(str(y + 1), x))
-            self.assertMessages(accounts, 'a', 'q', messages)
+            self.assertMessages(result, messages)
             self._delete_url('/a/q/%d' % (x + 1))
 
     def test_message_delete_marker(self):
         [self._put_url('/a/q/%d' % x) for x in range(1, 5)]
-        accounts = self._delete_url('/a/q?marker=2&detail=all', status=200)
+        result = self._delete_url('/a/q?marker=2&detail=all', status=200)
         messages = []
         messages.append(self.message('3'))
         messages.append(self.message('4'))
-        self.assertMessages(accounts, 'a', 'q', messages)
-        accounts = self._delete_url('/a/q?marker=5&detail=all', status=200)
+        self.assertMessages(result, messages)
+        result = self._delete_url('/a/q?marker=5&detail=all', status=200)
         messages = []
         messages.append(self.message('1'))
         messages.append(self.message('2'))
-        self.assertMessages(accounts, 'a', 'q', messages)
+        self.assertMessages(result, messages)
 
     def test_message_get_marker(self):
         [self._put_url('/a/q/%d' % x) for x in range(1, 5)]
         for x in range(0, 4):
-            accounts = self._get_url('/a/q?marker=%d' % x)
+            result = self._get_url('/a/q?marker=%d' % x)
             messages = []
             for y in range(x, 4):
                 messages.append(self.message(str(y + 1)))
-            self.assertMessages(accounts, 'a', 'q', messages)
+            self.assertMessages(result, messages)
             self._delete_url('/a/q/%d' % (x + 1))
 
     def test_message_post_marker(self):
         [self._put_url('/a/q/%d' % x) for x in range(1, 5)]
         for x in range(0, 4):
             url = '/a/q?marker=%d&ttl=%d&detail=all' % (x, x)
-            accounts = self._post_url(url)
+            result = self._post_url(url)
             messages = []
             for y in range(x, 4):
                 messages.append(self.message(str(y + 1), x))
-            self.assertMessages(accounts, 'a', 'q', messages)
+            self.assertMessages(result, messages)
             self._delete_url('/a/q/%d' % (x + 1))
 
     def test_message_delete_limit_marker(self):
         [self._put_url('/a/q/%d' % x) for x in range(1, 5)]
         url = '/a/q?limit=2&marker=1&detail=all'
-        accounts = self._delete_url(url, status=200)
+        result = self._delete_url(url, status=200)
         messages = []
         messages.append(self.message('2'))
         messages.append(self.message('3'))
-        self.assertMessages(accounts, 'a', 'q', messages)
+        self.assertMessages(result, messages)
         url = '/a/q?limit=2&marker=5&detail=all'
-        accounts = self._delete_url(url, status=200)
+        result = self._delete_url(url, status=200)
         messages = []
         messages.append(self.message('1'))
         messages.append(self.message('4'))
-        self.assertMessages(accounts, 'a', 'q', messages)
+        self.assertMessages(result, messages)
 
     def test_message_get_limit_marker(self):
         [self._put_url('/a/q/%d' % x) for x in range(1, 5)]
         for x in range(0, 4):
-            accounts = self._get_url('/a/q?limit=2&marker=%d' % x)
+            result = self._get_url('/a/q?limit=2&marker=%d' % x)
             messages = []
             for y in range(x, 4)[:2]:
                 messages.append(self.message(str(y + 1)))
-            self.assertMessages(accounts, 'a', 'q', messages)
+            self.assertMessages(result, messages)
             self._delete_url('/a/q/%d' % (x + 1))
 
     def test_message_post_limit_marker(self):
         [self._put_url('/a/q/%d' % x) for x in range(1, 5)]
         for x in range(0, 4):
             url = '/a/q?limit=2&marker=%d&ttl=%d&detail=all' % (x, x)
-            accounts = self._post_url(url)
+            result = self._post_url(url)
             messages = []
             for y in range(x, 4)[:2]:
                 messages.append(self.message(str(y + 1), x))
-            self.assertMessages(accounts, 'a', 'q', messages)
+            self.assertMessages(result, messages)
             self._delete_url('/a/q/%d' % (x + 1))
 
     def test_message_ttl(self):
         self._put_url('/a/q/1?ttl=1')
-        accounts = self._get_url('/a/q/1')
+        result = self._get_url('/a/q/1')
         message = self.message('1', 1)
-        self.assertMessages(accounts, 'a', 'q', [self.message('1', 1)])
+        self.assertMessages([result], [self.message('1', 1)])
         time.sleep(1)
         self.backend.clean()
         self._get_url('/a/q/1', status=404)
         self._put_url('/a/q/1')
-        accounts = self._get_url('/a/q/1')
-        self.assertMessages(accounts, 'a', 'q', [self.message('1')])
+        result = self._get_url('/a/q/1')
+        self.assertMessages([result], [self.message('1')])
         self._post_url('/a/q/1?ttl=1')
-        accounts = self._get_url('/a/q/1')
-        self.assertMessages(accounts, 'a', 'q', [self.message('1', 1)])
+        result = self._get_url('/a/q/1')
+        self.assertMessages([result], [self.message('1', 1)])
         time.sleep(1)
         self.backend.clean()
         self._get_url('/a/q/1', status=404)
 
     def test_message_hide(self):
         self._put_url('/a/q/1?hide=1')
-        accounts = self._get_url('/a/q/1')
-        self.assertMessages(accounts, 'a', 'q', [self.message('1', hide=1)])
+        result = self._get_url('/a/q/1')
+        self.assertMessages([result], [self.message('1', hide=1)])
         time.sleep(1)
         self.backend.clean()
-        accounts = self._get_url('/a/q/1')
-        self.assertMessages(accounts, 'a', 'q', [self.message('1')])
+        result = self._get_url('/a/q/1')
+        self.assertMessages([result], [self.message('1')])
         self._post_url('/a/q/1?hide=1')
-        accounts = self._get_url('/a/q/1')
-        self.assertMessages(accounts, 'a', 'q', [self.message('1', hide=1)])
+        result = self._get_url('/a/q/1')
+        self.assertMessages([result], [self.message('1', hide=1)])
         time.sleep(1)
         self.backend.clean()
-        accounts = self._get_url('/a/q/1')
-        self.assertMessages(accounts, 'a', 'q', [self.message('1')])
+        result = self._get_url('/a/q/1')
+        self.assertMessages([result], [self.message('1')])
         self._delete_url('/a/q/1')
 
     def _message_wait(self):
-        accounts = self._get_url('/a/q?wait=2')
-        self.assertMessages(accounts, 'a', 'q', [self.message('1')])
+        result = self._get_url('/a/q?wait=2')
+        self.assertMessages(result, [self.message('1')])
         self.success = True
 
     def test_message_put_wait(self):
@@ -270,22 +270,20 @@
     def message(self, id, ttl=0, hide=0, body=''):
         return dict(id=id, ttl=ttl, hide=hide, body=body)
 
-    def assertMessages(self, accounts, account, queue, messages):
-        self.assertEquals(len(accounts), 1)
-        self.assertEquals(len(accounts['a']), 1)
-        self.assertEquals(len(accounts['a']['q']), len(messages))
-        for x in range(0, len(messages)):
-            self.assertEquals(accounts['a']['q'][x]['id'], messages[x]['id'])
-            ttl = messages[x]['ttl']
+    def assertMessages(self, first, second):
+        self.assertEquals(len(first), len(second))
+        for x in xrange(0, len(second)):
+            self.assertEquals(first[x]['id'], second[x]['id'])
+            ttl = second[x]['ttl']
             if ttl > 0:
                 ttl += int(time.time())
-            self.assertAlmostEquals(accounts['a']['q'][0]['ttl'], ttl)
-            hide = messages[x]['hide']
+            self.assertAlmostEquals(first[x]['ttl'], ttl)
+            hide = second[x]['hide']
             if hide > 0:
                 hide += int(time.time())
-            self.assertAlmostEquals(accounts['a']['q'][0]['hide'], hide)
-            body = messages[x]['body']
-            self.assertEquals(accounts['a']['q'][x]['body'], body)
+            self.assertAlmostEquals(first[x]['hide'], hide)
+            body = second[x]['body']
+            self.assertEquals(first[x]['body'], body)
 
     def _delete_url(self, url, status=204, **kwargs):
         return self._url('DELETE', url, status=status, **kwargs)