summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBarry Warsaw2009-04-01 19:02:49 -0500
committerBarry Warsaw2009-04-01 19:02:49 -0500
commitc2041a01644dff0b59ef4413d74120d99e57124f (patch)
tree0d13b0eacf3fde8374e50526c588c99395001ed5
parentc33b7e899e02e3c274b077b17caa016257580b37 (diff)
downloadmailman-c2041a01644dff0b59ef4413d74120d99e57124f.tar.gz
mailman-c2041a01644dff0b59ef4413d74120d99e57124f.tar.zst
mailman-c2041a01644dff0b59ef4413d74120d99e57124f.zip
-rw-r--r--src/mailman/interfaces/rest.py36
-rw-r--r--src/mailman/rest/__init__.py0
-rw-r--r--src/mailman/rest/root.py46
-rw-r--r--src/mailman/rest/traverse.py52
4 files changed, 134 insertions, 0 deletions
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 <http://www.gnu.org/licenses/>.
+
+"""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
--- /dev/null
+++ b/src/mailman/rest/__init__.py
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 <http://www.gnu.org/licenses/>.
+
+"""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 <http://www.gnu.org/licenses/>.
+
+"""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