params as object

added is_sdk_enabled
adjusted tests
added logs

Author: nevoalm

securenative/__init__.py

@@ -1,5 +1,5 @@
 from securenative.config import sdk_version
 import securenative.event_types
 from securenative.sdk import SecureNative, SecureNativeOptions
-from securenative.event_options import Event, User, CustomParam
+from securenative.event_options import Event, User
 from securenative.singleton import init, flush, track, verify_webhook, verify

securenative/event_manager.py

@@ -22,7 +22,7 @@ def __init__(self, api_key, options=SecureNativeOptions(), http_client=HttpClien
         self.options = options
         self.queue = list()
 
-        if self.options.auto_send:
+        if self.options.auto_send and self.options.is_sdk_enabled:
             interval_seconds = max(options.interval // 1000, 1)
             threading.Timer(interval_seconds, self.flush).start()
 

securenative/event_manager_test.py

@@ -5,14 +5,14 @@
 
 from securenative import Event, event_types
 from securenative.event_manager import EventManager
-from securenative.event_options import User, CustomParam
+from securenative.event_options import User
 
 
 class EventManagerTests(unittest.TestCase):
 
     def build_event(self):
         return Event(event_type=event_types.login, user=User(user_id='1', user_email='1@2.com', user_name='1 2'),
-                     params=[CustomParam('key', 'val')])
+                     params={'key': 'val'})
 
     def test_send_sync(self):
         api_key = 'key'
@@ -35,7 +35,7 @@ def test_send_async(self):
 
         manager = EventManager(api_key=api_key, http_client=client)
         manager.send_async(event, resource)
-        self.assertTrue(wg.wait(manager.options.interval//1000 * 2))
+        self.assertTrue(wg.wait(manager.options.interval // 1000 * 2))
 
     def assert_cb(self, wg, event, url, key, body):
         self.assertEqual(url, 'https://api.securenative.com/my/custom/resource')

securenative/event_options.py

@@ -13,7 +13,7 @@ def __init__(self, user_id=u'', user_email=u'', user_name=u''):
 
 class Event:
     def __init__(self, event_type, user=User(), ip=u'127.0.0.1', remote_ip=u'127.0.0.1', user_agent=u'unknown',
-                 sn_cookie_value=None, params=None):
+                 sn_cookie_value=None, params={}):
         self.event_type = event_type
         self.user = user
         self.remote_ip = remote_ip
@@ -22,20 +22,9 @@ def __init__(self, event_type, user=User(), ip=u'127.0.0.1', remote_ip=u'127.0.0
         self.params = params
         self.cid = ''
         self.fp = ''
-        self.params = list()
-
-        if params is not None:
-            if not isinstance(params, list):
-                raise ValueError(
-                    'custom params should be a list of CustomParams, i.e: [CustomParams(key, value), ...])')
-            if len(params) > 0 and not isinstance(params[0], CustomParam):
-                raise ValueError(
-                    'custom params should be a list of CustomParams, i.e: [CustomParams(key, value), ...])')
-
-        self.params = params
 
         if self.params is None:
-            self.params = list()
+            self.params = {}
 
         if sn_cookie_value is not None:
             self.cid, self.fp = _parse_cookie(sn_cookie_value)
@@ -59,11 +48,5 @@ def as_dict(self):
             "vid": self.vid,
             "userAgent": self.user_agent,
             "device": {},
-            "params": [{p.key: p.value} for p in self.params]
+            "params": self.params
         }
-
-
-class CustomParam:
-    def __init__(self, key, value):
-        self.key = key
-        self.value = value

securenative/integration_test.py

@@ -5,7 +5,7 @@
 
 import securenative
 from securenative import SecureNativeOptions
-from securenative.event_options import CustomParam, User, Event
+from securenative.event_options import  User, Event
 
 
 class IntegrationTest(unittest.TestCase):
@@ -29,5 +29,4 @@ def build_event(self, id, type, ip):
         return Event(event_type=type,
                      ip=ip,
                      user=User(user_id=id, user_email='python-sdk@securenative.com', user_name='python sdk')
-                     # params=[CustomParam('key', 'val')]
                      )

securenative/logger.py

@@ -0,0 +1,8 @@
+import logging
+
+enable_sn_logging = False
+
+
+def sn_logging(msg):
+    if enable_sn_logging:
+        logging.info(msg)

securenative/sdk.py

@@ -2,6 +2,7 @@
 
 from securenative.config import _max_allowed_params
 from securenative.event_manager import EventManager
+from securenative.logger import sn_logging
 from securenative.sdk_options import SecureNativeOptions
 from securenative.utils import verify_signature
 
@@ -14,12 +15,21 @@ def __init__(self, api_key, options=SecureNativeOptions()):
         self._api_key = api_key
         self._options = options
         self._event_manager = EventManager(self._api_key, self._options)
+        if self._options and self._options.debug_mode:
+            enable_sn_logging = self._options.debug_mode
+            sn_logging("sn logging was activated")
 
     def track(self, event):
+        sn_logging("Track event call")
+        if not self._options.is_sdk_enabled:
+            return
         _validate_event(event)
         self._event_manager.send_async(event, 'collector/api/v1/track')
 
     def verify(self, event):
+        sn_logging("Verify event call")
+        if not self._options.is_sdk_enabled:
+            return _default_verify_result()
         _validate_event(event)
 
         try:
@@ -31,10 +41,11 @@ def verify(self, event):
             else:
                 return _default_verify_result()
 
-        except Exception as ex:
+        except Exception:
             return _default_verify_result
 
     def verify_webhook(self, hmac_header, body):
+        sn_logging("Verify webhook was called")
         return verify_signature(self._api_key, body, hmac_header)
 
     def flush(self):

securenative/sdk_options.py

@@ -3,10 +3,13 @@
 
 
 class SecureNativeOptions:
-    def __init__(self, api_url=_securenative_prod, interval=1000, max_events=1000, timeout=1500, auto_send=True):
+    def __init__(self, api_url=_securenative_prod, interval=1000, max_events=1000, timeout=1500, auto_send=True,
+                 is_sdk_enabled=True, debug_mode=False):
         super().__init__()
         self.timeout = timeout
         self.max_events = max_events
         self.api_url = api_url
         self.interval = interval
         self.auto_send = auto_send
+        self.is_sdk_enabled = is_sdk_enabled
+        self.debug_mode = debug_mode

securenative/singleton.py

@@ -1,3 +1,5 @@
+import securenative
+from securenative.logger import sn_logging
 from securenative.sdk import SecureNative
 from securenative.sdk_options import SecureNativeOptions
 
@@ -8,6 +10,11 @@ def init(api_key, options=SecureNativeOptions()):
     global _sn_sdk
     if _sn_sdk is None:
         _sn_sdk = SecureNative(api_key, options)
+        securenative.logger.enable_sn_logging = options.debug_mode
+    else:
+        sn_logging('This SDK was already initialized.')
+        raise ValueError(
+            u'This SDK was already initialized.')
 
 
 def track(event):

securenative/sn_crypto.py

@@ -3,7 +3,6 @@
 from binascii import unhexlify, hexlify
 
 BLOCK_SIZE = 16
-pad = lambda s: s + (BLOCK_SIZE - len(s) % BLOCK_SIZE) * chr(BLOCK_SIZE - len(s) % BLOCK_SIZE)
 
 
 def encrypt(text, cipherKey):
@@ -18,4 +17,8 @@ def decrypt(encrypted, cipherKey):
     iv = content[:BLOCK_SIZE]
     cipherText = content[BLOCK_SIZE:]
     aes = AES.new(cipherKey, AES.MODE_CBC, iv)
-    return aes.decrypt(cipherText).decode('utf-8').strip()
+    return aes.decrypt(cipherText).decode('utf-8').strip()
+
+
+def pad(s):
+    return s + (BLOCK_SIZE - len(s) % BLOCK_SIZE) * chr(BLOCK_SIZE - len(s) % BLOCK_SIZE)