Add querystring_search get method

news/1616.feature

@@ -0,0 +1 @@
+Add querystring_search get method. @robgietema

src/plone/restapi/services/querystringsearch/configure.zcml

@@ -18,4 +18,20 @@
       permission="zope2.View"
       name="@querystring-search"
       />
+
+  <plone:service
+      method="GET"
+      factory=".get.QuerystringSearchGet"
+      for="Products.CMFPlone.interfaces.IPloneSiteRoot"
+      permission="zope2.View"
+      name="@querystring-search"
+      />
+
+  <plone:service
+      method="GET"
+      factory=".get.QuerystringSearchGet"
+      for="Products.CMFCore.interfaces.IContentish"
+      permission="zope2.View"
+      name="@querystring-search"
+      />
 </configure>

src/plone/restapi/services/querystringsearch/get.py

@@ -4,8 +4,11 @@
 from plone.restapi.deserializer import json_body
 from plone.restapi.interfaces import ISerializeToJson
 from plone.restapi.services import Service
+from urllib import parse
 from zope.component import getMultiAdapter
 
+import json
+
 
 zcatalog_version = get_distribution("Products.ZCatalog").version
 if parse_version(zcatalog_version) >= parse_version("5.1"):
@@ -14,11 +17,14 @@
     SUPPORT_NOT_UUID_QUERIES = False
 
 
-class QuerystringSearchPost(Service):
+class QuerystringSearch:
     """Returns the querystring search results given a p.a.querystring data."""
 
-    def reply(self):
-        data = json_body(self.request)
+    def __init__(self, context, request):
+        self.context = context
+        self.request = request
+
+    def __call__(self, data):
         query = data.get("query", None)
         b_start = int(data.get("b_start", 0))
         b_size = int(data.get("b_size", 25))
@@ -60,3 +66,21 @@ def reply(self):
             fullobjects=fullobjects
         )
         return results
+
+
+class QuerystringSearchPost(Service):
+    """Returns the querystring search results given a p.a.querystring data."""
+
+    def reply(self):
+        querystring_search = QuerystringSearch(self.context, self.request)
+        return querystring_search(data=json_body(self.request))
+
+
+class QuerystringSearchGet(Service):
+    """Returns the querystring search results given a p.a.querystring data."""
+
+    def reply(self):
+        querystring_search = QuerystringSearch(self.context, self.request)
+        return querystring_search(
+            data=json.loads(parse.unquote(self.request.form.get("query", "{}")))
+        )

src/plone/restapi/tests/http-examples/querystringsearch_get.req

@@ -0,0 +1,3 @@
+GET /plone/@querystring-search?query=%257B%2522query%2522%253A%255B%257B%2522i%2522%253A%2522portal_type%2522%252C%2522o%2522%253A%2520%2522plone.app.querystring.operation.selection.any%2522%252C%2522v%2522%253A%255B%2522Document%2522%255D%257D%255D%257D HTTP/1.1
+Accept: application/json
+Authorization: Basic YWRtaW46c2VjcmV0

src/plone/restapi/tests/http-examples/querystringsearch_get.resp

@@ -0,0 +1,23 @@
+HTTP/1.1 200 OK
+Content-Type: application/json
+
+{
+    "@id": "http://localhost:55001/plone/@querystring-search?query=%257B%2522query%2522%253A%255B%257B%2522i%2522%253A%2522portal_type%2522%252C%2522o%2522%253A%2520%2522plone.app.querystring.operation.selection.any%2522%252C%2522v%2522%253A%255B%2522Document%2522%255D%257D%255D%257D",
+    "items": [
+        {
+            "@id": "http://localhost:55001/plone/front-page",
+            "@type": "Document",
+            "description": "Congratulations! You have successfully installed Plone.",
+            "review_state": "private",
+            "title": "Welcome to Plone"
+        },
+        {
+            "@id": "http://localhost:55001/plone/testdocument",
+            "@type": "Document",
+            "description": "",
+            "review_state": "private",
+            "title": "Test Document"
+        }
+    ],
+    "items_total": 2
+}

src/plone/restapi/tests/test_documentation.py

@@ -1686,6 +1686,18 @@ def test_querystringsearch_post(self):
         )
         save_request_and_response_for_docs("querystringsearch_post", response)
 
+    def test_querystringsearch_get(self):
+        query = {
+            "query": "%7B%22query%22%3A%5B%7B%22i%22%3A%22portal_type%22%2C%22o%22%3A%20%22plone.app.querystring.operation.selection.any%22%2C%22v%22%3A%5B%22Document%22%5D%7D%5D%7D"
+        }
+        url = "/@querystring-search"
+
+        self.portal.invokeFactory("Document", "testdocument", title="Test Document")
+        transaction.commit()
+
+        response = self.api_session.get(url, params=query)
+        save_request_and_response_for_docs("querystringsearch_get", response)
+
     def test_system_get(self):
         response = self.api_session.get("/@system")
         save_request_for_docs("system_get", response)

src/plone/restapi/tests/test_services_querystringsearch.py

@@ -52,6 +52,18 @@ def test_querystringsearch_basic(self):
         self.assertEqual(len(response.json()["items"]), 1)
         self.assertNotIn("effective", response.json()["items"][0])
 
+    def test_querystringsearch_basic_get(self):
+        response = self.api_session.get(
+            "/@querystring-search?query=%7B%22query%22%3A%5B%7B%22i%22%3A%22portal_type%22%2C%22o%22%3A%20%22plone.app.querystring.operation.selection.any%22%2C%22v%22%3A%5B%22Document%22%5D%7D%5D%7D"
+        )
+
+        self.assertEqual(response.status_code, 200)
+        self.assertIn("items", response.json())
+        self.assertIn("items_total", response.json())
+        self.assertEqual(response.json()["items_total"], 1)
+        self.assertEqual(len(response.json()["items"]), 1)
+        self.assertNotIn("effective", response.json()["items"][0])
+
     def test_querystringsearch_fullobjects(self):
         response = self.api_session.post(
             "/@querystring-search",