Merge pull request #36 from securenative/dev

Dev

Author: inbaltako

README.md

@@ -46,7 +46,11 @@ SecureNative can automatically load your config from *securenative.ini* file or
 from securenative.securenative import SecureNative
 
 
+# 1. Config file path is given by environment variable 
 securenative = SecureNative.init()
+
+# 2. Config file path is specified directly
+securenative = SecureNative.init('path/to/securenative.ini')
 ```
 ### Option 2: Initialize via API Key
 
@@ -88,18 +92,8 @@ from securenative.models.user_traits import UserTraits
 
 securenative = SecureNative.get_instance()
 
-context = SecureNative.context_builder().\
-        with_ip("127.0.0.1").\
-        with_client_token("SECURED_CLIENT_TOKEN").\
-        with_headers({"user-agent", "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405"}).\
-        build()
-
-event_options = EventOptionsBuilder(EventTypes.LOG_IN).\
-with_user_id("1234").\
-        with_user_traits(UserTraits("Your Name", "[email protected]", "+1234567890")).\
-        with_context(context).\
-        with_properties({"prop1": "CUSTOM_PARAM_VALUE", "prop2": True, "prop3": 3}).\
-        build()
+context = SecureNative.context_builder().with_ip("127.0.0.1").with_client_token("SECURED_CLIENT_TOKEN").with_headers({"user-agent", "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405"}).build()
+event_options = EventOptionsBuilder(EventTypes.LOG_IN).with_user_id("1234").with_user_traits(UserTraits("Your Name", "[email protected]", "+1234567890")).with_context(context).with_properties({"prop1": "CUSTOM_PARAM_VALUE", "prop2": True, "prop3": 3}).build()
 
 securenative.track(event_options)
  ```
@@ -115,14 +109,9 @@ from securenative.models.user_traits import UserTraits
 
 def track(request):
     securenative = SecureNative.get_instance()
-    context = SecureNative.context_builder().from_http_request(request).build()
 
-    event_options = EventOptionsBuilder(EventTypes.LOG_IN).\
-        with_user_id("1234").\
-        with_user_traits(UserTraits("Your Name", "[email protected]", "+1234567890")).\
-        with_context(context).\
-        with_properties({"prop1": "CUSTOM_PARAM_VALUE", "prop2": True, "prop3": 3}).\
-        build()
+    context = SecureNative.context_builder().from_http_request(request).build()
+    event_options = EventOptionsBuilder(EventTypes.LOG_IN).with_user_id("1234").with_user_traits(UserTraits("Your Name", "[email protected]", "+1234567890")).with_context(context).with_properties({"prop1": "CUSTOM_PARAM_VALUE", "prop2": True, "prop3": 3}).build()
 
     securenative.track(event_options)
 ```
@@ -142,12 +131,7 @@ def track(request):
     securenative = SecureNative.get_instance()
     context = SecureNative.context_builder().from_http_request(request).build()
 
-    event_options = EventOptionsBuilder(EventTypes.LOG_IN).\
-        with_user_id("1234").\
-        with_user_traits(UserTraits("Your Name", "[email protected]", "+1234567890")).\
-        with_context(context).\
-        with_properties({"prop1": "CUSTOM_PARAM_VALUE", "prop2": True, "prop3": 3}).\
-        build()
+    event_options = EventOptionsBuilder(EventTypes.LOG_IN).with_user_id("1234").with_user_traits(UserTraits("Your Name", "[email protected]", "+1234567890")).with_context(context).with_properties({"prop1": "CUSTOM_PARAM_VALUE", "prop2": True, "prop3": 3}).build()
 
     verify_result = securenative.verify(event_options)
     verify_result.risk_level  # Low, Medium, High

VERSION

@@ -1 +1 @@
-0.2.4
+0.2.5

securenative/config/configuration_manager.py

@@ -1,7 +1,8 @@
 import os
-from configparser import ConfigParser, NoSectionError
+from configparser import ConfigParser
 
 from securenative.config.configuration_builder import ConfigurationBuilder
+from securenative.exceptions.securenative_config_exception import SecureNativeConfigException
 
 
 class ConfigurationManager(object):
@@ -11,7 +12,10 @@ class ConfigurationManager(object):
 
     @classmethod
     def read_resource_file(cls, resource_path):
-        cls.config.read(resource_path)
+        try:
+            cls.config.read(resource_path)
+        except Exception as e:
+            raise SecureNativeConfigException("Invalid config file; %s", e)
 
         properties = {}
         for key, value in cls.config.defaults().items():
@@ -41,11 +45,10 @@ def _get_env_or_default(cls, properties, key, default):
         return default
 
     @classmethod
-    def load_config(cls):
+    def load_config(cls, resource_path):
         options = ConfigurationBuilder().get_default_securenative_options()
 
-        resource_path = cls.DEFAULT_CONFIG_FILE
-        if os.environ.get(cls.CUSTOM_CONFIG_FILE_ENV_NAME):
+        if not resource_path:
             resource_path = os.environ.get(cls.CUSTOM_CONFIG_FILE_ENV_NAME)
 
         properties = cls.read_resource_file(resource_path)

securenative/event_manager.py

@@ -129,23 +129,23 @@ def stop_event_persist(self):
     def serialize(obj):
         return {
             "rid": obj.rid,
-            "eventType": obj.event_type,
+            "eventType": obj.event_type if isinstance(obj.event_type, str) else obj.event_type.value,
             "userId": obj.user_id,
             "userTraits": {
-                "name": obj.user_traits.name,
-                "email": obj.user_traits.email,
-                "phone": obj.user_traits.phone,
-                "createdAt": obj.user_traits.created_at,
+                "name": obj.user_traits.name if obj.user_traits else "",
+                "email": obj.user_traits.email if obj.user_traits else "",
+                "phone": obj.user_traits.phone if obj.user_traits else "",
+                "createdAt": obj.user_traits.created_at if obj.user_traits else "",
             },
             "request": {
-                "cid": obj.request.cid,
-                "vid": obj.request.vid,
-                "fp": obj.request.fp,
-                "ip": obj.request.ip,
-                "remoteIp": obj.request.remote_ip,
-                "method": obj.request.method,
-                "url": obj.request.url,
-                "headers": obj.request.headers
+                "cid": obj.request.cid if obj.request else "",
+                "vid": obj.request.vid if obj.request else "",
+                "fp": obj.request.fp if obj.request else "",
+                "ip": obj.request.ip if obj.request else "",
+                "remoteIp": obj.request.remote_ip if obj.request else "",
+                "method": obj.request.method if obj.request else "",
+                "url": obj.request.url if obj.request else "",
+                "headers": obj.request.headers if obj.request else None
             },
             "timestamp": obj.timestamp,
             "properties": obj.properties,

securenative/models/sdk_event.py

@@ -2,6 +2,7 @@
 
 from securenative.context.context_builder import ContextBuilder
 from securenative.models.request_context import RequestContextBuilder
+from securenative.models.user_traits import UserTraits
 from securenative.utils.date_utils import DateUtils
 from securenative.utils.encryption_utils import EncryptionUtils
 
@@ -14,21 +15,34 @@ def __init__(self, event_options, securenative_options):
         else:
             self.context = ContextBuilder.default_context_builder().build()
 
-        client_token = EncryptionUtils.decrypt(self.context.client_token, securenative_options.api_key)
+        if self.context.client_token:
+            client_token = EncryptionUtils.decrypt(self.context.client_token, securenative_options.api_key)
+        else:
+            client_token = None
+
+        if event_options.user_traits and isinstance(event_options.user_traits, dict):
+            user_traits = UserTraits(event_options.user_traits.get("name", ""),
+                                     event_options.user_traits.get("email", ""),
+                                     event_options.user_traits.get("phone", ""),
+                                     event_options.user_traits.get("created_at", ""))
+        elif event_options.user_traits:
+            user_traits = event_options.user_traits
+        else:
+            user_traits = UserTraits()
 
         self.rid = str(uuid.uuid4())
-        self.event_type = event_options.event.value
-        self.user_id = event_options.user_id
-        self.user_traits = event_options.user_traits
+        self.event_type = event_options.event if event_options.event else ""
+        self.user_id = event_options.user_id if event_options.user_id else ""
+        self.user_traits = user_traits
         self.request = RequestContextBuilder() \
             .with_cid(client_token.cid if client_token else "") \
             .with_vid(client_token.vid if client_token else "") \
             .with_fp(client_token.fp if client_token else "") \
-            .with_ip(self.context.ip) \
-            .with_remote_ip(self.context.remote_ip) \
-            .with_method(self.context.method) \
-            .with_url(self.context.url) \
-            .with_headers(self.context.headers) \
+            .with_ip(self.context.ip if self.context.ip else "") \
+            .with_remote_ip(self.context.remote_ip if self.context.remote_ip else "") \
+            .with_method(self.context.method if self.context.method else "") \
+            .with_url(self.context.url if self.context.url else "") \
+            .with_headers(self.context.headers if self.context.headers else None) \
             .build()
 
         self.timestamp = DateUtils.to_timestamp(event_options.timestamp)

securenative/securenative.py

@@ -54,8 +54,8 @@ def init_with_api_key(cls, api_key):
             raise SecureNativeSDKException(u'This SDK was already initialized.')
 
     @classmethod
-    def init(cls):
-        options = ConfigurationManager.load_config()
+    def init(cls, resource_path=None):
+        options = ConfigurationManager.load_config(resource_path)
         return cls.init_with_options(options)
 
     @classmethod

securenative/utils/date_utils.py

@@ -5,6 +5,9 @@ class DateUtils(object):
 
     @staticmethod
     def to_timestamp(date):
-        if not date:
-            return datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%S.%f')[:-3] + 'Z'
-        return datetime.strptime(date, '%Y-%m-%dT%H:%M:%S.%f'[:-3] + 'Z')
+        try:
+            if not date or date is "":
+                return datetime.utcnow().strftime('%Y-%m-%dT%H:%M:%S.%f')[:-3] + 'Z'
+            return datetime.strptime(date, '%Y-%m-%dT%H:%M:%S.%f'[:-3] + 'Z')
+        except Exception:
+            return ""

securenative/utils/version_utils.py

@@ -2,4 +2,4 @@ class VersionUtils(object):
 
     @staticmethod
     def get_version():
-        return "0.2.4"
+        return "0.2.5"

setup.py

@@ -23,7 +23,7 @@
     long_description_content_type="text/markdown",
     install_requires=[
         "requests",
-        "pycrypto",
+        "pycryptodome",
     ],
     classifiers=[
         'Development Status :: 5 - Production/Stable',

tests/api_manager_test.py

@@ -19,7 +19,6 @@ class ApiManagerTest(unittest.TestCase):
     def setUp(self):
         self.context = ContextBuilder(). \
             with_ip("127.0.0.1"). \
-            with_client_token("SECURED_CLIENT_TOKEN"). \
             with_headers(
             {
                 "user-agent": "Mozilla/5.0 (iPad; U; CPU OS 3_2_1 like Mac OS X; en-us) AppleWebKit/531.21.10 (KHTML, like Gecko) Mobile/7B405"