Merge pull request #36 from securenative/dev

Dev

Author: inbaltako

README.md

@@ -57,21 +57,21 @@ SecureNative can automatically load your config from *securenative.properties* f
 
 ```java
 // Options 1: Use default config file path
-SecureNative secureNative =  SecureNative.init();
+SecureNative securenative =  SecureNative.init();
 
 // Options 2: Use specific config file path
 Path path = Paths.get("/path/to/securenative.properties");
-SecureNative secureNative =  SecureNative.init(path);
+SecureNative securenative =  SecureNative.init(path);
 ```
 ### Option 2: Initialize via API Key
 
 ```java
-SecureNative secureNative =  SecureNative.init("YOUR_API_KEY");
+SecureNative securenative =  SecureNative.init("YOUR_API_KEY");
 ```
 
 ### Option 3: Initialize via ConfigurationBuilder
 ```java
-SecureNative secureNative = SecureNative.init(SecureNative.configBuilder()
+SecureNative securenative = SecureNative.init(SecureNative.configBuilder()
                                         .withApiKey("API_KEY")
                                         .withMaxEvents(10)
                                         .withLogLevel("error")
@@ -81,7 +81,7 @@ SecureNative secureNative = SecureNative.init(SecureNative.configBuilder()
 ## Getting SecureNative instance
 Once initialized, sdk will create a singleton instance which you can get: 
 ```java
-SecureNative secureNative = SecureNative.getInstance();
+SecureNative securenative = SecureNative.getInstance();
 ```
 
 ## Tracking events
@@ -90,7 +90,7 @@ Once the SDK has been initialized, tracking requests sent through the SDK
 instance. Make sure you build event with the EventBuilder:
 
  ```java
-SecureNative secureNative = SecureNative.getInstance();
+SecureNative securenative = SecureNative.getInstance();
 
 SecureNativeContext context = SecureNative.contextBuilder()
         .withIp("127.0.0.1")
@@ -136,7 +136,7 @@ public void track(HttpServletRequest request, HttpServletResponse response) {
             .timestamp(new Date())
             .build();
 
-    secureNative.track(eventOptions);
+    securenative.track(eventOptions);
 }
 ```
 
@@ -163,7 +163,7 @@ public void verify(HttpServletRequest request, HttpServletResponse response) {
             .timestamp(new Date())
             .build();
 
-    VerifyResult verifyResult = secureNative.verify(eventOptions);
+    VerifyResult verifyResult = securenative.verify(eventOptions);
     verifyResult.getRiskLevel(); // Low, Medium, High
     verifyResult.score(); // Risk score: 0 -1 (0 - Very Low, 1 - Very High)
     verifyResult.getTriggers(); // ["TOR", "New IP", "New City"]
@@ -177,9 +177,9 @@ Apply our filter to verify the request is from us, example in spring:
 ```java
 @RequestMapping("/webhook")
 public void webhookEndpoint(HttpServletRequest request, HttpServletResponse response) {
-    SecureNative secureNative = SecureNative.getInstance();
+    SecureNative securenative = SecureNative.getInstance();
 
     // Checks if request is verified
-    Boolean isVerified = secureNative.verifyRequestPayload(request);
+    Boolean isVerified = securenative.verifyRequestPayload(request);
 }
  ```

pom.xml

@@ -6,7 +6,7 @@
     <groupId>com.securenative.java</groupId>
     <artifactId>securenative-java</artifactId>
     <packaging>jar</packaging>
-    <version>0.5.4</version>
+    <version>0.5.5</version>
     <url>https://github.com/securenative/securenative-java</url>
 
     <name>${project.groupId}:${project.artifactId}:${project.version}</name>

src/main/java/com/securenative/ApiManager.java

@@ -1,10 +1,11 @@
 package com.securenative;
 
+import com.securenative.exceptions.SecureNativeInvalidOptionsException;
 import com.securenative.models.EventOptions;
 import com.securenative.models.VerifyResult;
 
 public interface ApiManager {
-    void track(EventOptions eventOptions);
+    void track(EventOptions eventOptions) throws SecureNativeInvalidOptionsException;
 
-    VerifyResult verify(EventOptions eventOptions);
+    VerifyResult verify(EventOptions eventOptions) throws SecureNativeInvalidOptionsException;
 }

src/main/java/com/securenative/ApiManagerImpl.java

@@ -4,6 +4,7 @@
 import com.securenative.enums.ApiRoute;
 import com.securenative.enums.FailoverStrategy;
 import com.securenative.enums.RiskLevel;
+import com.securenative.exceptions.SecureNativeInvalidOptionsException;
 import com.securenative.exceptions.SecureNativeSDKException;
 import com.securenative.models.Event;
 import com.securenative.models.EventOptions;
@@ -21,14 +22,14 @@ public ApiManagerImpl(EventManager eventManager, SecureNativeOptions options) th
     }
 
     @Override
-    public void track(EventOptions eventOptions) {
+    public void track(EventOptions eventOptions) throws SecureNativeInvalidOptionsException {
         logger.info("Track event call");
         Event event = new SDKEvent(eventOptions, this.options);
         this.eventManager.sendAsync(event, ApiRoute.TRACK.getApiRoute(), true);
     }
 
     @Override
-    public VerifyResult verify(EventOptions eventOptions) {
+    public VerifyResult verify(EventOptions eventOptions) throws SecureNativeInvalidOptionsException {
         logger.info("Verify event call");
         Event event = new SDKEvent(eventOptions, this.options);
         try {

src/main/java/com/securenative/SecureNative.java

@@ -5,6 +5,7 @@
 import com.securenative.config.SecureNativeOptions;
 import com.securenative.context.SecureNativeContextBuilder;
 import com.securenative.exceptions.SecureNativeConfigException;
+import com.securenative.exceptions.SecureNativeInvalidOptionsException;
 import com.securenative.exceptions.SecureNativeSDKException;
 import com.securenative.exceptions.SecureNativeSDKIllegalStateException;
 import com.securenative.http.SecureNativeHTTPClient;
@@ -95,12 +96,12 @@ public boolean verifyRequestPayload(HttpServletRequest request) throws IOExcepti
     }
 
     @Override
-    public void track(EventOptions eventOptions) {
+    public void track(EventOptions eventOptions) throws SecureNativeInvalidOptionsException {
         this.apiManager.track(eventOptions);
     }
 
     @Override
-    public VerifyResult verify(EventOptions eventOptions) {
+    public VerifyResult verify(EventOptions eventOptions) throws SecureNativeInvalidOptionsException {
         return this.apiManager.verify(eventOptions);
     }
 }

src/main/java/com/securenative/models/SDKEvent.java

@@ -6,6 +6,7 @@
 import com.securenative.config.SecureNativeOptions;
 import com.securenative.context.SecureNativeContext;
 import com.securenative.context.SecureNativeContextBuilder;
+import com.securenative.exceptions.SecureNativeInvalidOptionsException;
 import com.securenative.utils.DateUtils;
 import com.securenative.utils.EncryptionUtils;
 
@@ -21,7 +22,15 @@ public class SDKEvent implements Event {
     public Map<Object, Object> properties;
     public static final Logger logger = Logger.getLogger(SecureNative.class);
 
-    public SDKEvent(EventOptions event, SecureNativeOptions options) {
+    public SDKEvent(EventOptions event, SecureNativeOptions options) throws SecureNativeInvalidOptionsException {
+        if (event.getUserId() == null || event.getUserId().length() <= 0 || event.getUserId().equals("")) {
+            throw new SecureNativeInvalidOptionsException("Invalid event structure; User Id is missing");
+        }
+
+        if (event.getEvent() == null || event.getEvent().length() <= 0 || event.getEvent().equals("")) {
+            throw new SecureNativeInvalidOptionsException("Invalid event structure; Event Type is missing");
+        }
+
         SecureNativeContext context = event.getContext() != null ? event.getContext() : SecureNativeContextBuilder.defaultContextBuilder().build();
 
         ClientToken clientToken = decryptToken(context.getClientToken(), options.getApiKey());

src/test/java/com/securenative/ApiManagerImplTest.java

@@ -80,6 +80,7 @@ public void ShouldCallTrackEventTest() throws SecureNativeSDKException, Interrup
             JSONAssert.assertEquals(expected, body, false);
             assertThat(new JSONObject(body).has("rid")).isTrue();
             assertThat(new JSONObject(body).has("timestamp")).isTrue();
+        } catch (SecureNativeInvalidOptionsException ignored) {
         } finally {
             eventManager.stopEventsPersist();
         }
@@ -114,8 +115,6 @@ public void ShouldThrowWhenSendingMoreThan10CustomPropertiesToTrackEventTest() t
         }
     }
 
-    ;
-
 
     @Test
     @Timeout(value = 1000, unit = TimeUnit.MILLISECONDS)
@@ -131,7 +130,10 @@ public void ShouldNotCallTrackEventWhenAutomaticPersistenceDisabledTest() throws
         ApiManager apiManager = new ApiManagerImpl(eventManager, options);
 
         // track async event
-        apiManager.track(eventOptions);
+        try {
+            apiManager.track(eventOptions);
+        } catch (SecureNativeInvalidOptionsException ignored) {
+        }
 
         // ensure event to be sent
         RecordedRequest lastRequest = server.takeRequest(10 * options.getInterval(), TimeUnit.MILLISECONDS);
@@ -156,7 +158,10 @@ public void ShouldNotRetryUnauthorizedTrackEventCallTest() throws SecureNativeSD
         ApiManager apiManager = new ApiManagerImpl(eventManager, options);
 
         // track async event
-        apiManager.track(eventOptions);
+        try {
+            apiManager.track(eventOptions);
+        } catch (SecureNativeInvalidOptionsException ignored) {
+        }
 
         try {
             // ensure event to be sent
@@ -191,8 +196,13 @@ public void ShouldCallVerifyEventTest() throws SecureNativeSDKException, JsonPro
 
 
         // call verify event
-        VerifyResult result = apiManager.verify(eventOptions);
+        VerifyResult result = null;
+        try {
+            result = apiManager.verify(eventOptions);
+        } catch (SecureNativeInvalidOptionsException ignored) {
+        }
 
+        assert result != null;
         assertThat(result.getRiskLevel()).isEqualTo(verifyResult.getRiskLevel());
         assertThat(result.getScore()).isEqualTo(verifyResult.getScore());
         assertThat(result.getTriggers().length).isEqualTo(verifyResult.getTriggers().length);
@@ -220,7 +230,13 @@ public void ShouldFailVerifyEventCallWhenUnauthorizedTest() throws SecureNativeS
         ApiManager apiManager = new ApiManagerImpl(eventManager, options);
 
         // call verify event
-        VerifyResult verifyResult = apiManager.verify(eventOptions);
+        VerifyResult verifyResult = null;
+        try {
+            verifyResult = apiManager.verify(eventOptions);
+        } catch (SecureNativeInvalidOptionsException ignored) {
+        }
+
+        assert verifyResult != null;
         assertThat(verifyResult.getRiskLevel()).isEqualTo(RiskLevel.LOW);
         assertThat(verifyResult.getScore()).isEqualTo(0);
         assertThat(verifyResult.getTriggers().length).isEqualTo(0);
@@ -230,8 +246,6 @@ public void ShouldFailVerifyEventCallWhenUnauthorizedTest() throws SecureNativeS
         RecordedRequest lastRequest = server.takeRequest(10 * options.getInterval(), TimeUnit.MILLISECONDS);
         String lastRequestBody = lastRequest != null ? lastRequest.getBody().readUtf8() : null;
 
-        String expected = "{\"eventType\":\"sn.user.login\",\"userId\":\"USER_ID\",\"userTraits\":{\"name\":\"USER_NAME'\",\"email\":\"USER_EMAIL'\",\"createdAt\":null},\"request\":{\"cid\":null,\"vid\":null,\"fp\":null,\"ip\":\"127.0.0.1\",\"remoteIp\":null,\"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\"},\"url\":null,\"method\":null},\"properties\":{\"prop2\":true,\"prop1\":\"CUSTOM_PARAM_VALUE\",\"prop3\":3}}";
         assertThat(lastRequestBody).isNotNull();
-
     }
 }