From a665dccf9404d6f95d8a4587f05d748b504e1f9d Mon Sep 17 00:00:00 2001
From: J08nY
Date: Thu, 1 Jun 2017 20:53:53 +0200
Subject: Add REST-ability to plugins.

 - Adds the rest_object method to the IPlugin interface. This method
   is called by the REST api to route requests to the plugin's REST
   api. All attributes are proxied, so the object becomes a true
   REST object in the ObjectRouter hierarchy. For example see the
   RESTExample and ExamplePlugin classes in mailman.testing.plugin.
   The plugin might return None from this method, in which case
   all calls to it's REST api route will return 404 NotFound.

 - Adds new routes to the REST api. For version >= 3.1:

   - /3.1/plugins
     Returns a dictionary with plugin names as keys, and their configs
     as values.

   - /3.1/plugins/<plugin_name>
	 Proxies everything to plugin's rest_object, if plugin with such
     name exists and provides a non-null rest_object, else NotFound.
---
 src/mailman/testing/plugin.py | 69 +++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 67 insertions(+), 2 deletions(-)

(limited to 'src/mailman/testing')

diff --git a/src/mailman/testing/plugin.py b/src/mailman/testing/plugin.py
index 75667844a..a8b001406 100644
--- a/src/mailman/testing/plugin.py
+++ b/src/mailman/testing/plugin.py
@@ -15,22 +15,87 @@
 # You should have received a copy of the GNU General Public License along with
 # GNU Mailman.  If not, see <http://www.gnu.org/licenses/>.
 
-"""Example plugin with hooks for testing purposes."""
+"""Example plugin with hooks and REST for testing purposes."""
 
+from mailman.config import config
 from mailman.interfaces.plugin import IPlugin
+from mailman.rest.helpers import bad_request, child, etag, no_content, okay
+from mailman.rest.validator import Validator
 from public import public
 from zope.interface import implementer
 
 
+@public
+class GoodREST:
+
+    def on_get(self, request, response):
+        okay(response, etag({'good': True}))
+
+
+@public
+class BadREST:
+
+    def on_get(self, request, response):
+        bad_request(response, etag({'good': False}))
+
+
+@public
+class CountingREST:
+
+    def __init__(self):
+        self._plugin = config.plugins['example']
+
+    def on_get(self, request, response):
+        okay(response, etag({'count': self._plugin.counter}))
+
+    def on_post(self, request, response):
+        try:
+            counter = Validator(count=int)(request)
+            self._plugin.counter = counter['count']
+        except ValueError as error:
+            bad_request(response, str(error))
+        else:
+            no_content(response)
+
+    def on_delete(self, request, response):
+        self._plugin.counter = 0
+        no_content(response)
+
+
+@public
+class RESTExample:
+
+    def on_get(self, request, response):
+        okay(response, etag({'example-plugin-reply': 'yes'}))
+
+    def on_post(self, request, response):
+        bad_request(response)
+
+    @child()
+    def good(self, context, segments):
+        return GoodREST(), []
+
+    @child()
+    def bad(self, context, segments):
+        return BadREST(), []
+
+    @child()
+    def count(self, context, segments):
+        return CountingREST(), []
+
+
 @public
 @implementer(IPlugin)
 class ExamplePlugin:
 
     def __init__(self):
-        pass
+        self.counter = 0
 
     def pre_hook(self):
         pass
 
     def post_hook(self):
         pass
+
+    def rest_object(self):
+        return RESTExample()
-- 
cgit v1.2.3-70-g09d2