Added delete_events method.

Author: stroud109

keen/__init__.py

@@ -403,3 +403,21 @@ def multi_analysis(event_collection, analyses, timeframe=None, interval=None,
     return _client.multi_analysis(event_collection=event_collection, timeframe=timeframe,
                                   interval=interval, timezone=timezone, filters=filters,
                                   group_by=group_by, analyses=analyses, max_age=max_age)
+
+
+def delete_events(*args, **kwargs):
+    """ Performs a delete for events.
+
+    Returns true upon success.
+
+    :param event_collection: string, the event collection from which event are being deleted
+    :param timeframe: string or dict, the timeframe in which the events
+    happened example: "previous_7_days"
+    :param timezone: int, the timezone you'd like to use for the timeframe
+    and interval in seconds
+    :param filters: array of dict, contains the filters you'd like to apply to the data
+    example: [{"property_name":"device", "operator":"eq", "property_value":"iPhone"}]
+
+    """
+    _initialize_client_from_environment()
+    return _client.delete_events(*args, **kwargs)

keen/api.py

@@ -23,6 +23,7 @@ class HTTPMethods(object):
 
     GET = 'get'
     POST = 'post'
+    DELETE = 'delete'
 
 
 class KeenAdapter(HTTPAdapter):
@@ -67,7 +68,7 @@ def __init__(self, project_id, write_key=None, read_key=None,
         version is used
         :param get_timeout: optional, the timeout on GET requests
         :param post_timeout: optional, the timeout on POST requests
-        :param master_key: a Keen IO Master API Key
+        :param master_key: a Keen IO Master API Key, needed for deletes
         """
         # super? recreates the object with values passed into KeenApi
         super(KeenApi, self).__init__()
@@ -161,9 +162,32 @@ def query(self, analysis_type, params):
 
         return response.json()["result"]
 
+    def delete_events(self, event_collection, params):
+        """
+        Deletes events via the Keen IO API. A master key must be set first.
+
+        :param event_collection: string, the event collection from which event are being deleted
+
+        """
+        if not self.master_key:
+            raise exceptions.InvalidEnvironmentError(
+                "The Keen IO API requires a master key to run deletes. "
+                "Please set a 'master_key' when initializing the KeenApi object."
+            )
+
+        url = "{0}/{1}/projects/{2}/events/{3}".format(self.base_url,
+                                                       self.api_version,
+                                                       self.project_id,
+                                                       event_collection)
+        headers = {"Content-Type": "application/json", "Authorization": self.master_key}
+        response = self.fulfill(HTTPMethods.DELETE, url, params=params, headers=headers, timeout=self.post_timeout)
+
+        self.error_handling(response)
+        return True
+
     def error_handling(self, res):
         """
-        Helper function to do the error handling 
+        Helper function to do the error handling
 
         :params res: the response from a request
         """
@@ -172,5 +196,8 @@ def error_handling(self, res):
             try:
                 error = res.json()
             except json.JSONDecodeError:
-                error = {'message': 'The API did not respond with JSON, but: "{0}"'.format(res.text[:1000]), "error_code": "InvalidResponseFormat"}
+                error = {
+                    'message': 'The API did not respond with JSON, but: "{0}"'.format(res.text[:1000]),
+                    "error_code": "InvalidResponseFormat"
+                }
             raise exceptions.KeenApiError(error)

keen/client.py

@@ -155,6 +155,21 @@ def generate_image_beacon(self, event_collection, event_body, timestamp=None):
             self.api.write_key.decode(sys.getdefaultencoding()), self._base64_encode(event_json)
         )
 
+    def delete_events(self, event_collection, timeframe=None, timezone=None, filters=None):
+        """ Deletes events.
+
+        :param event_collection: string, the event collection from which event are being deleted
+        :param timeframe: string or dict, the timeframe in which the events happened
+        example: "previous_7_days"
+        :param timezone: int, the timezone you'd like to use for the timeframe
+        and interval in seconds
+        :param filters: array of dict, contains the filters you'd like to apply to the data
+        example: [{"property_name":"device", "operator":"eq", "property_value":"iPhone"}]
+
+        """
+        params = self.get_params(timeframe=timeframe, timezone=timezone, filters=filters)
+        return self.api.delete_events(event_collection, params)
+
     def _base64_encode(self, string_to_encode):
         """ Base64 encodes a string, with either Python 2 or 3.
 

keen/tests/client_tests.py

@@ -435,6 +435,31 @@ def test_timeout_count(self, get):
         # Make sure the requests library was called with `timeout`.
         self.assert_equals(get.call_args[1]["timeout"], 0.0001)
 
+
+@patch("requests.Session.delete")
+class DeleteTests(BaseTestCase):
+
+    def setUp(self):
+        super(DeleteTests, self).setUp()
+        keen._client = None
+        keen.project_id = "1k4jb23kjbkjkjsd"
+        keen.master_key = "sdofnasofagaergub"
+
+    def tearDown(self):
+        keen._client = None
+        keen.project_id = None
+        keen.master_key = None
+        super(DeleteTests, self).tearDown()
+
+    def test_delete_events(self, delete):
+        delete.return_value = MockedRequest(status_code=204, json_response=[])
+        # Assert that the mocked delete function is called the way we expect.
+        keen.delete_events("foo", filters=[{"property_name": 'username', "operator": 'eq', "property_value": 'Bob'}])
+        # Check that the URL is generated correctly.
+        self.assertEqual("https://api.keen.io/3.0/projects/1k4jb23kjbkjkjsd/events/foo", delete.call_args[0][0])
+        # Check that the master_key is in the Authorization header.
+        self.assertTrue(keen.master_key in delete.call_args[1]["headers"]["Authorization"])
+
 # only need to test unicode separately in python2
 if sys.version_info[0] < 3: