summaryrefslogtreecommitdiff
path: root/src/mailman/core/api.py
diff options
context:
space:
mode:
authorBarry Warsaw2016-01-13 11:16:38 -0500
committerBarry Warsaw2016-01-13 11:16:38 -0500
commit98c074f19492d81ebf5b5c3f4d4f2210aa56230d (patch)
tree8a04bc455fe21065c38ccd05e3141d3f24d0d816 /src/mailman/core/api.py
parentd75a7ebb46279f341b498bf517d07e9ae4c27f0a (diff)
downloadmailman-98c074f19492d81ebf5b5c3f4d4f2210aa56230d.tar.gz
mailman-98c074f19492d81ebf5b5c3f4d4f2210aa56230d.tar.zst
mailman-98c074f19492d81ebf5b5c3f4d4f2210aa56230d.zip
Diffstat (limited to 'src/mailman/core/api.py')
-rw-r--r--src/mailman/core/api.py82
1 files changed, 82 insertions, 0 deletions
diff --git a/src/mailman/core/api.py b/src/mailman/core/api.py
new file mode 100644
index 000000000..d23a9ec67
--- /dev/null
+++ b/src/mailman/core/api.py
@@ -0,0 +1,82 @@
+# Copyright (C) 2016 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/>.
+
+"""REST web service API contexts."""
+
+__all__ = [
+ 'API30',
+ 'API31',
+ ]
+
+
+from lazr.config import as_boolean
+from mailman.config import config
+from mailman.interfaces.api import IAPI
+from uuid import UUID
+from zope.interface import implementer
+
+
+@implementer(IAPI)
+class API30:
+ version = '3.0'
+
+ @classmethod
+ def path_to(cls, resource):
+ """See `IAPI`."""
+ return '{}://{}:{}/{}/{}'.format(
+ ('https' if as_boolean(config.webservice.use_https) else 'http'),
+ config.webservice.hostname,
+ config.webservice.port,
+ cls.version,
+ (resource[1:] if resource.startswith('/') else resource),
+ )
+
+ @staticmethod
+ def from_uuid(uuid):
+ """See `IAPI`."""
+ return uuid.int
+
+ @staticmethod
+ def to_uuid(uuid_repr):
+ """See `IAPI`."""
+ return UUID(int=int(uuid_repr))
+
+
+@implementer(IAPI)
+class API31:
+ version = '3.1'
+
+ @classmethod
+ def path_to(cls, resource):
+ """See `IAPI`."""
+ return '{}://{}:{}/{}/{}'.format(
+ ('https' if as_boolean(config.webservice.use_https) else 'http'),
+ config.webservice.hostname,
+ config.webservice.port,
+ cls.version,
+ (resource[1:] if resource.startswith('/') else resource),
+ )
+
+ @staticmethod
+ def from_uuid(uuid):
+ """See `IAPI`."""
+ return uuid.hex
+
+ @staticmethod
+ def to_uuid(uuid_repr):
+ """See `IAPI`."""
+ return UUID(hex=uuid_repr)