Add support for EventService API flush endpoint (#118)

Author: sserrata

bin/summit.py

@@ -447,6 +447,10 @@ def nack(api, options):
         k = 'EventService.nack'
         generic(api, options, api.nack, k)
 
+    def flush(api, options):
+        k = 'EventService.flush'
+        generic(api, options, api.flush, k)
+
     k = 'EventService'
 
     R = options['R']
@@ -481,6 +485,9 @@ def nack(api, options):
     if options['nack']:
         nack(api, options)
 
+    if options['flush']:
+        flush(api, options)
+
     setters(options, api)
     methods(options, api)
 
@@ -973,6 +980,7 @@ def parse_opts():
         'get': False,
         'ack': False,
         'nack': False,
+        'flush': False,
         'follow': False,
         'count': False,
         'domains': False,
@@ -1049,8 +1057,8 @@ def _options_print(opt, last_c, last_m, arg):
         'delete', 'poll', 'xpoll', 'query', 'write',
         'start=', 'midpoint=', 'end=', 'window=',
         'id=', 'seq=',
-        'set', 'get', 'ack', 'nack', 'follow',
-        'count', 'domains', 'attributes',
+        'set', 'get', 'ack', 'nack', 'flush',
+        'follow', 'count', 'domains', 'attributes',
         'R0=', 'R1=', 'R2=',
         'debug=', 'version', 'help',
     ]
@@ -1144,6 +1152,9 @@ def _options_print(opt, last_c, last_m, arg):
         elif opt == '--nack':
             options['nack'] = True
             last_m = 'nack'
+        elif opt == '--flush':
+            options['flush'] = True
+            last_m = 'flush'
         elif opt == '--follow':
             options['follow'] = True
         elif opt == '--count':
@@ -1295,6 +1306,8 @@ def usage():
                           (sets ack point = read point)
       --nack              negative acknowledgement for events read
                           (sets read point = ack point)
+      --flush             discard unread events 
+                          (set read and ack point to end of channel)
       --poll              read events
       --xpoll             poll all events until drained
                           (use --ack to ack after each poll)

examples/event_flush.py

@@ -0,0 +1,32 @@
+#!/usr/bin/env python
+# -*- coding: utf-8 -*-
+
+"""Example interaction with Event Service using flush."""
+
+import os
+import sys
+
+curpath = os.path.dirname(os.path.abspath(__file__))
+sys.path[:0] = [os.path.join(curpath, os.pardir)]
+
+from pancloud import EventService, Credentials
+
+url = 'https://api.us.paloaltonetworks.com'
+
+c = Credentials()
+
+# Create Event Service instance
+es = EventService(
+    url=url,
+    credentials=c
+)
+
+channel_id = 'EventFilter'
+
+# Flush event channel
+a = es.flush(channel_id)
+
+# Print results
+print(
+    "\nSTATUS_CODE: {}, RESULT: \n\n{}\n".format(a.status_code, a.text)
+)

pancloud/event.py

@@ -87,6 +87,33 @@ def ack(self, channel_id=None, **kwargs):  # pragma: no cover
         )
         return r
 
+    def flush(self, channel_id=None, **kwargs):  # pragma: no cover
+        """Discard all existing events from the event channel.
+
+        This endpoint removes all events from the channel. Use this
+        endpoint only if you currently have unread events in your
+        channel that you never intend to process.
+
+        Args:
+            channel_id (str): The channel ID.
+            **kwargs: Supported :meth:`~pancloud.httpclient.HTTPClient.request` parameters.
+
+        Returns:
+            requests.Response: Requests Response() object.
+
+        Examples:
+            Refer to ``event_flush.py`` example.
+
+        """
+        path = "/event-service/v1/channels/{}/flush".format(channel_id)
+        r = self._httpclient.request(
+            method="POST",
+            url=self.url,
+            path=path,
+            **kwargs
+        )
+        return r
+
     def get_filters(self, channel_id=None, **kwargs):  # pragma: no cover
         """Retrieve the filters currently set on the channel.
 

tests/test_event.py

@@ -31,6 +31,7 @@ def test_entry_points(self):
         EventService(url=TARPIT).poll
         EventService(url=TARPIT).ack
         EventService(url=TARPIT).nack
+        EventService(url=TARPIT).flush
 
     def test_unexpected_kwargs(self):
         with pytest.raises(UnexpectedKwargsError):