Removed type hint suffixes from unstructured events (snowplow#36)

Author: fblundun

CHANGES.txt

@@ -4,12 +4,13 @@ Added callbacks for flushing
 Added Python-logging
 Added Redis and gevent based async approach (#75)
 Added thread-based AsyncBufferedConsumer (#74)
-Improved test coverage up to 50% (73)
+Improved test coverage up to 50% (#73)
 Added ability to specify port for collector (#72) (TODO)
 Added POST support to tracker (#70)
 Added Redis-based queue (#45)
 Added Buffered Consumer (#44)
 Changed user_id to be set on a per-event basis (#39)
+Removed type hint suffixes from unstructured events (#36)
 
 Version 0.3.0 (2014-04-25)
 --------------------------

snowplow_tracker/payload.py

@@ -63,49 +63,6 @@ def add_dict(self, dict_, base64=False):
         for f in dict_:
             self.add(f, dict_[f])
 
-    @contract
-    def add_unstruct(self, dict_, encode_base64,
-                     type_when_encoded, type_when_not_encoded):
-        """
-            Add an encoded or unencoded JSON to the payload after verifying
-            the contents of the dict
-
-            :param  dict_:      Dictionary of the payload to be generated
-            :type   dict_:      dict(str:*)
-            :param  encode_base64:      If the payload is base64 encoded
-            :type   encode_base64:      bool
-            :param  type_when_encoded:  Name of the field when encode_base64 is set
-            :type   type_when_encoded:  str
-            :param  type_when_not_encoded:  Name of the field when encode_base64 is not set
-            :type   type_when_not_encoded:  str
-        """
-        def raise_error(f, type_):
-            raise RuntimeError("".join([f, " in dict is not a ", type_]))
-
-        types = ["int", "flt", "geo", "dt", "ts", "tms"]
-
-        for f in dict_:
-            parts = f.split("$")
-            if parts[-1] in types:
-                type_ = parts[-1]
-                if ((type_ == "int" and not isinstance(dict_[f], int)) or
-                    (type_ == "flt" and not isinstance(dict_[f], float)) or
-                    (type_ == "geo" and not isinstance(dict_[f], tuple)) or
-                    (type_ == "dt" and not isinstance(dict_[f], int)) or
-                    (type_ == "ts" and not isinstance(dict_[f], int)) or
-                    (type_ == "tms" and not isinstance(dict_[f], int))):
-                    raise_error(f, type_)
-        json_dict = json.dumps(dict_)
-
-        if encode_base64:
-                encoded_dict = base64.urlsafe_b64encode(json_dict.encode("ascii"))
-                if not isinstance(encoded_dict, str):
-                    encoded_dict = encoded_dict.decode("utf-8")
-                self.add(type_when_encoded, encoded_dict)                
-
-        else:
-            self.add(type_when_not_encoded, json_dict)
-
     @contract
     def add_json(self, dict_, encode_base64, type_when_encoded, type_when_not_encoded):
         """

snowplow_tracker/test/integration/test_integration.py

@@ -131,31 +131,6 @@ def test_integration_unstruct_event_base64(self):
             for key in expected_fields:
                 self.assertEquals(from_querystring(key, querystrings[-1]), expected_fields[key])
 
-    def test_integration_unstruct_event_non_base64_error(self):
-        t = tracker.Tracker(default_consumer, default_subject, encode_base64=False)
-        try:
-            t.track_unstruct_event("com.example_company", "viewed_product",
-                               {
-                                   "product_id": "ASO01043",
-                                   "price$flt": 49,                 # ERROR
-                                   "walrus$tms": int(time.time() * 1000),
-                               })
-        except RuntimeError as e:
-            self.assertEquals("price$flt in dict is not a flt", str(e))
-
-
-    def test_integration_unstruct_event_base64_error(self):
-        t = tracker.Tracker(default_consumer, default_subject)
-        try:
-            t.track_unstruct_event("com.example_company", "viewed_product",
-                                         {
-                                              "product_id": "ASO01043",
-                                              "price$flt": 49.95,
-                                              "walrus$tms": "hello",           # ERROR
-                                         })
-        except RuntimeError as e:
-            self.assertEquals("walrus$tms in dict is not a tms", str(e))
-
     def test_integration_standard_nv_pairs(self):
         t = tracker.Tracker(default_consumer, default_subject, "cf", app_id="angry-birds-android", context_vendor="com.example")
         default_subject.set_platform("mob")

snowplow_tracker/test/unit/test_payload.py

@@ -67,23 +67,3 @@ def test_add_dict(self):
         p.add_dict({"name4": 4, "name3": 3})            # Order doesn't matter
         output = {"n1": "v1", "n2": "v2", "name3": 3, "name4": 4}
         self.assertTrue(is_subset(output, p.nv_pairs))
-
-    def test_add_unstruct_1(self):
-        p = payload.Payload()
-        try:
-            p.add_unstruct({"product_id": "ASO01043",
-                        "price$flt": 33,                 # ERROR
-                        "walrus$tms": int(time.time() * 1000),
-                       }, False, "ue_px", "ue_pe")
-        except RuntimeError as e:
-            self.assertEquals("price$flt in dict is not a flt", str(e))
-
-    def test_add_unstruct_2(self):
-        p = payload.Payload()
-        try:
-            p.add_unstruct({"product_id": "ASO01043",
-                        "price$flt": 33.3,
-                        "walrus$tms": "hello world!",   # ERROR
-                       }, True, "ue_px", "ue_pe")
-        except RuntimeError as e:
-            self.assertEquals("walrus$tms in dict is not a tms", str(e))

snowplow_tracker/tracker.py

@@ -349,7 +349,7 @@ def track_unstruct_event(self, event_vendor, event_name, dict_, context=None, ts
 
         pb.add("e", "ue")
         pb.add("ue_na", event_name)
-        pb.add_unstruct(dict_, self.encode_base64, "ue_px", "ue_pr")
+        pb.add_json(dict_, self.encode_base64, "ue_px", "ue_pr")
         pb.add("evn", event_vendor)
 
         dtm = Tracker.get_timestamp(tstamp)