Merge branch 'master' of github.com:keenlabs/KeenClient-Python into hotfix-basestring

Author: Sam Gammon

LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2013 Keen Labs
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -95,6 +95,14 @@ Here are some examples of querying.  Let's assume you've added some events to th
 
 ### Changelog
 
+##### 0.2.2
+
++ Added interval to multi_analysis.
+
+##### 0.2.1
+
++ Added stacktrace_id and unique_id to Keen API errors.
+
 ##### 0.2.0
 
 + Added add_events method to keen/__init__.py so it can be used at a module level.

keen/client.py

@@ -353,7 +353,7 @@ def funnel(self, steps, timeframe=None, timezone=None):
         params = self.get_params(steps=steps, timeframe=timeframe, timezone=timezone)
         return self.api.query("funnel", params)
 
-    def multi_analysis(self, event_collection, analyses, timeframe=None, timezone=None, filters=None, group_by=None):
+    def multi_analysis(self, event_collection, analyses, timeframe=None, interval=None, timezone=None, filters=None, group_by=None):
         """ Performs a multi-analysis query
 
         Returns a dictionary of analysis results.
@@ -364,6 +364,8 @@ def multi_analysis(self, event_collection, analyses, timeframe=None, timezone=No
         "average price":{"analysis_type":"average","target_property":"purchase.price"}
         :param timeframe: string or dict, the timeframe in which the events
         happened example: "previous_7_days"
+        :param interval: string, the time interval used for measuring data over
+        time example: "daily"
         :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
@@ -372,8 +374,15 @@ def multi_analysis(self, event_collection, analyses, timeframe=None, timezone=No
         like to group you results by.  example: "customer.id" or ["browser","operating_system"]
 
         """
-        params = self.get_params(event_collection=event_collection, timeframe=timeframe, timezone=timezone,
-                                 filters=filters, group_by=group_by, analyses=analyses)
+        params = self.get_params(
+            event_collection=event_collection,
+            timeframe=timeframe,
+            interval=interval,
+            timezone=timezone,
+            filters=filters,
+            group_by=group_by,
+            analyses=analyses)
+
         return self.api.query("multi_analysis", params)
 
     def get_params(self, event_collection=None, timeframe=None, timezone=None, interval=None, filters=None,
@@ -393,7 +402,7 @@ def get_params(self, event_collection=None, timeframe=None, timezone=None, inter
         if filters:
             params["filters"] = json.dumps(filters)
         if group_by:
-            if type(group_by) is dict:
+            if type(group_by) is list:
                 params["group_by"] = json.dumps(group_by)
             else:
                 params["group_by"] = group_by

keen/exceptions.py

@@ -31,6 +31,10 @@ def __init__(self, api_error):
         self.api_error = api_error
         self._message = "Error from Keen API. Details:\n Message: {0}\nCode: " \
                         "{1}".format(api_error["message"], api_error["error_code"])
+        if "stacktrace_id" in api_error:
+            self._message = "{0}\nStacktrace ID: {1}".format(self._message, api_error["stacktrace_id"])
+        if "unique_id" in api_error:
+            self._message = "{0}\nUnique ID: {1}".format(self._message, api_error["unique_id"])
 
 
 class InvalidEnvironmentError(BaseKeenClientError):

keen/tests/client_tests.py

@@ -204,8 +204,8 @@ def setUp(self):
         api_key = "2e79c6ec1d0145be8891bf668599c79a"
         keen.write_key = scoped_keys.encrypt(api_key, {"allowed_operations": ["write"]})
         keen.read_key = scoped_keys.encrypt(api_key, {"allowed_operations": ["read"]})
-        keen.add_event("query test", {"number": 5})
-        keen.add_event("step2", {"number": 5})
+        keen.add_event("query test", {"number": 5, "string": "foo"})
+        keen.add_event("step2", {"number": 5, "string": "foo"})
 
     def tearDown(self):
         keen.project_id = None
@@ -274,6 +274,11 @@ def test_group_by(self):
         resp = keen.count("query test", timeframe="today", group_by="number")
         assert type(resp) is list
 
+    def test_multi_group_by(self):
+        resp = keen.count("query test", timeframe="today", group_by=["number", "string"])
+        assert type(resp) is list
+        assert len(resp) == 1
+
     def test_interval(self):
         resp = keen.count("query test", timeframe="this_2_days", interval="daily")
         assert type(resp) is list

setup.py

@@ -3,7 +3,7 @@
 from distutils.core import setup
 
 setup(name="keen",
-      version="0.2.0",
+      version="0.2.2",
       description="Python Client for Keen IO",
       author="Keen IO",
       author_email="[email protected]",