From c2041a01644dff0b59ef4413d74120d99e57124f Mon Sep 17 00:00:00 2001 From: Barry Warsaw Date: Wed, 1 Apr 2009 19:02:49 -0500 Subject: Checkpointing more REST stuff --- src/mailman/interfaces/rest.py | 36 +++++++++++++++++++++++++++++ src/mailman/rest/__init__.py | 0 src/mailman/rest/root.py | 46 +++++++++++++++++++++++++++++++++++++ src/mailman/rest/traverse.py | 52 ++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 134 insertions(+) create mode 100644 src/mailman/interfaces/rest.py create mode 100644 src/mailman/rest/__init__.py create mode 100644 src/mailman/rest/root.py create mode 100644 src/mailman/rest/traverse.py diff --git a/src/mailman/interfaces/rest.py b/src/mailman/interfaces/rest.py new file mode 100644 index 000000000..697c81da4 --- /dev/null +++ b/src/mailman/interfaces/rest.py @@ -0,0 +1,36 @@ +# Copyright (C) 2009 by the Free Software Foundation, Inc. +# +# This file is part of GNU Mailman. +# +# GNU Mailman is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, either version 3 of the License, or (at your option) +# any later version. +# +# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +# more details. +# +# You should have received a copy of the GNU General Public License along with +# GNU Mailman. If not, see . + +"""Interfaces for the RESTful admin server.""" + +from __future__ import absolute_import, unicode_literals + +__metaclass__ = type +__all__ = [ + 'IHasGet', + ] + + +from zope.interface import Interface + + + +class IHasGet(Interface): + """A marker interface objects that implement traversal with get().""" + + def get(name): + """Traverse to a contained object.""" diff --git a/src/mailman/rest/__init__.py b/src/mailman/rest/__init__.py new file mode 100644 index 000000000..e69de29bb diff --git a/src/mailman/rest/root.py b/src/mailman/rest/root.py new file mode 100644 index 000000000..5b2949b3e --- /dev/null +++ b/src/mailman/rest/root.py @@ -0,0 +1,46 @@ +# Copyright (C) 2009 by the Free Software Foundation, Inc. +# +# This file is part of GNU Mailman. +# +# GNU Mailman is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, either version 3 of the License, or (at your option) +# any later version. +# +# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +# more details. +# +# You should have received a copy of the GNU General Public License along with +# GNU Mailman. If not, see . + +"""The RESTful service root.""" + +from __future__ import absolute_import, unicode_literals + +__metaclass__ = type +__all__ = [ + 'AdminServiceRootResource', + ] + + +from lazr.restful import ServiceRootResource +from zope.interface import implements + +from mailman.core.system import system +from mailman.interfaces.rest import IHasGet + + + +class AdminServiceRootResource(ServiceRootResource): + """The root of the Mailman RESTful admin web service.""" + + implements(IHasGet) + + def get(self, name): + """See `IHasGet`.""" + top_level = { + 'sys': system, + } + return top_level.get(name) diff --git a/src/mailman/rest/traverse.py b/src/mailman/rest/traverse.py new file mode 100644 index 000000000..df0dc288c --- /dev/null +++ b/src/mailman/rest/traverse.py @@ -0,0 +1,52 @@ +# Copyright (C) 2009 by the Free Software Foundation, Inc. +# +# This file is part of GNU Mailman. +# +# GNU Mailman is free software: you can redistribute it and/or modify it under +# the terms of the GNU General Public License as published by the Free +# Software Foundation, either version 3 of the License, or (at your option) +# any later version. +# +# GNU Mailman is distributed in the hope that it will be useful, but WITHOUT +# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or +# FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for +# more details. +# +# You should have received a copy of the GNU General Public License along with +# GNU Mailman. If not, see . + +"""Traversal rules for the Mailman RESTful admin web service.""" + +from __future__ import absolute_import, unicode_literals + +__metaclass__ = type +__all__ = [ + 'Traverse', + ] + + +from urllib import unquote + +from zope.component import adapts +from zope.interface import implements +from zope.publisher.interfaces import IPublishTraverse, NotFound +from zope.publisher.interfaces.browser import IDefaultBrowserLayer + + + +class Traverse: + """An implementation of `IPublishTraverse` that uses the get() method.""" + + implements(IPublishTraverse) + adapts(IHasGet, IDefaultBrowserLayer) + + def __init__(self, context, request): + self.context = context + + def publishTraverse(self, request, name): + """See `IPublishTraverse`.""" + name = unquote(name) + value = self.context.get(name) + if value is None: + raise NotFound(self, name) + return value -- cgit v1.2.3-70-g09d2