Version 1.0rc1

Author: BartoszLitwiniuk

README.md

@@ -1,9 +1,13 @@
 # Backtrace
+<!--
 [![Backtrace@release](https://img.shields.io/badge/Backtrace%40master-2.0.5-blue.svg)](https://www.nuget.org/packages/Backtrace)
-<!-- [![Build status](https://ci.appveyor.com/api/projects/status/o0n9sp0ydgxb3ktu?svg=true)](https://ci.appveyor.com/project/konraddysput/backtrace-csharp) -->
+ [![Build status](https://ci.appveyor.com/api/projects/status/o0n9sp0ydgxb3ktu?svg=true)](https://ci.appveyor.com/project/konraddysput/backtrace-csharp) 
+ -->
 
+<!--
 [![Backtrace@pre-release](https://img.shields.io/badge/Backtrace%40dev-2.0.6-blue.svg)](https://www.nuget.org/packages/Backtrace)
-<!-- [![Build status](https://ci.appveyor.com/api/projects/status/o0n9sp0ydgxb3ktu/branch/dev?svg=true)](https://ci.appveyor.com/project/konraddysput/backtrace-csharp/branch/dev) -->
+[![Build status](https://ci.appveyor.com/api/projects/status/o0n9sp0ydgxb3ktu/branch/dev?svg=true)](https://ci.appveyor.com/project/konraddysput/backtrace-csharp/branch/dev) 
+-->
 
 
 
@@ -13,7 +17,7 @@
 ## Usage
 ```java
 // replace with your endpoint url and token
-BacktraceCredentials credentials = new BacktraceCredentials("https://myserver.sp.backtrace.io:6097/", "4dca18e8769d0f5d10db0d1b665e64b3d716f76bf182fbcdad5d1d8070c12db0");
+BacktraceCredentials credentials = new BacktraceCredentials("<endpoint-url>", "<token>");
 BacktraceClient backtraceClient = new BacktraceClient(getApplicationContext(), credentials);
 
 try {
@@ -51,7 +55,7 @@ TODO
 # Running sample application
 ## Android Studio <a name="sample-app-android-studio"></a>
 
-- Open `MainActivity.java` class in **app\src\main\java\backtraceio\backtraceio** and replace `BacktraceCredential` constructor parameters with with your `Backtrace endpoint URL` (e.g. https://xxx.sp.backtrace.io:6098) and `submission token`:
+- Open `MainActivity.java` class in **app\src\main\java\backtraceio\backtraceio** and replace `BacktraceCredential` constructor parameters with your `Backtrace endpoint URL` (e.g. https://xxx.sp.backtrace.io:6098) and `submission token`:
 
 ```java
 BacktraceCredentials credentials = new BacktraceCredentials("https://myserver.sp.backtrace.io:6097/", "4dca18e8769d0f5d10db0d1b665e64b3d716f76bf182fbcdad5d1d8070c12db0");
@@ -152,7 +156,7 @@ backtraceClient.setOnBeforeSendEventListener(new OnBeforeSendEventListener() {
 ## Reporting unhandled application exceptions
 `BacktraceClient` also supports reporting of unhandled application exceptions not captured by your try-catch blocks. To enable reporting of unhandled exceptions:
 ```java
-new BacktraceExceptionHandler(getApplicationContext(), backtraceClient);
+BacktraceExceptionHandler.enable(backtraceClient);
 ``` 
 
 ## Custom client and report classes <a name="documentation-customization"></a>

backtrace-library/build.gradle

@@ -7,10 +7,8 @@ android {
         minSdkVersion 19
         targetSdkVersion 28
         versionCode 1
-        versionName "1.0"
-
+        versionName "1.0rc1"
         testInstrumentationRunner "android.support.test.runner.AndroidJUnitRunner"
-
     }
 
     buildTypes {

backtrace-library/src/androidTest/java/backtraceio/library/EventsInstrumentedTest.java

@@ -0,0 +1,110 @@
+package backtraceio.library;
+
+import android.content.Context;
+import android.support.test.InstrumentationRegistry;
+import android.support.test.runner.AndroidJUnit4;
+
+import org.junit.Before;
+import org.junit.Test;
+import org.junit.runner.RunWith;
+
+import java.util.ArrayList;
+import java.util.UUID;
+
+import backtraceio.library.events.OnBeforeSendEventListener;
+import backtraceio.library.events.OnServerErrorEventListener;
+import backtraceio.library.events.RequestHandler;
+import backtraceio.library.models.BacktraceData;
+import backtraceio.library.models.BacktraceResult;
+import backtraceio.library.models.types.BacktraceResultStatus;
+
+
+import static org.junit.Assert.assertEquals;
+
+/**
+ * Instrumented test, which will execute on an Android device.
+ *
+ * @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
+ */
+@RunWith(AndroidJUnit4.class)
+public class EventsInstrumentedTest {
+    private Context context;
+    private BacktraceCredentials credentials;
+    private final String resultMessage = "From request handler";
+
+    @Before
+    public void setUp() {
+        context = InstrumentationRegistry.getContext();
+        credentials = new BacktraceCredentials("https://example-endpoint.com/", "");
+    }
+
+    @Test
+    public void useRequestHandler() {
+        // GIVEN
+        BacktraceClient backtraceClient = new BacktraceClient(context, credentials);
+        RequestHandler rh = new RequestHandler() {
+            @Override
+            public BacktraceResult onRequest(BacktraceData data) {
+                return new BacktraceResult(null, resultMessage, BacktraceResultStatus.Ok);
+            }
+        };
+        backtraceClient.setOnRequestHandler(rh);
+
+        // WHEN
+        BacktraceResult result = backtraceClient.send("test");
+
+        // THEN
+        assertEquals(resultMessage, result.message);
+        assertEquals(BacktraceResultStatus.Ok, result.status);
+    }
+
+    @Test
+    public void useBeforeSendAndRequestHandler() {
+        // GIVEN
+        final String attributeKey = UUID.randomUUID().toString();
+
+        BacktraceClient backtraceClient = new BacktraceClient(context, credentials);
+        RequestHandler rh = new RequestHandler() {
+            @Override
+            public BacktraceResult onRequest(BacktraceData data) {
+                return new BacktraceResult(null, data.attributes.get(attributeKey).toString(),
+                        BacktraceResultStatus.Ok);
+            }
+        };
+
+        backtraceClient.setOnRequestHandler(rh);
+        backtraceClient.setOnBeforeSendEventListener(new OnBeforeSendEventListener() {
+            @Override
+            public BacktraceData onEvent(BacktraceData data) {
+                data.attributes.put(attributeKey, resultMessage);
+                return data;
+            }
+        });
+
+        // WHEN
+        BacktraceResult result = backtraceClient.send("test");
+
+        // THEN
+        assertEquals(resultMessage, result.message);
+        assertEquals(BacktraceResultStatus.Ok, result.status);
+    }
+
+    @Test
+    public void useOnServerError() {
+        // GIVEN
+        BacktraceClient backtraceClient = new BacktraceClient(context, credentials);
+        final ArrayList<Exception> exceptions = new ArrayList<>();
+        backtraceClient.setOnServerErrorEventListener(new OnServerErrorEventListener() {
+            @Override
+            public void onEvent(Exception exception) {
+                exceptions.add(exception);
+            }
+        });
+
+        // WHEN
+        backtraceClient.send(new Exception("test"));
+
+        // THEN
+        assertEquals(1, exceptions.size());
+    }
+}

backtrace-library/src/androidTest/java/backtraceio/library/ExampleInstrumentedTest.java

@@ -3,46 +3,82 @@
 import android.content.Context;
 import android.os.AsyncTask;
 
-import backtraceio.library.models.BacktraceData;
+import backtraceio.library.base.BacktraceBase;
 import backtraceio.library.models.BacktraceResult;
-import backtraceio.library.models.base.BacktraceBase;
 import backtraceio.library.models.json.BacktraceReport;
 
+/**
+ * Backtrace Java Android Client
+ */
 public class BacktraceClient extends BacktraceBase {
-    private BacktraceCredentials backtraceCredentials;
 
-    public BacktraceClient(Context context, BacktraceCredentials credentials)
-    {
+    /**
+     * Initializing Backtrace client instance with BacktraceCredentials
+     *
+     * @param context     application context
+     * @param credentials credentials to Backtrace API server
+     */
+    public BacktraceClient(Context context, BacktraceCredentials credentials) {
         super(context, credentials);
     }
 
-    public BacktraceResult send(String message)
-    {
+    /**
+     * Sending a message to Backtrace API
+     *
+     * @param message custom client message
+     * @return server response
+     */
+    public BacktraceResult send(String message) {
         return super.send(message);
     }
 
-    public BacktraceResult send(Exception e)
-    {
-        return super.send(e);
+    /**
+     * Sending an exception to Backtrace API
+     *
+     * @param exception current exception
+     * @return server response
+     */
+    public BacktraceResult send(Exception exception) {
+        return super.send(exception);
     }
 
-    public BacktraceResult send(BacktraceReport report)
-    {
+    /**
+     * Sending a Backtrace report to Backtrace API
+     *
+     * @param report current BacktraceReport
+     * @return server response
+     */
+    public BacktraceResult send(BacktraceReport report) {
         return super.send(report);
     }
 
-    public AsyncTask<Void, Void, BacktraceResult> sendAsync(String message)
-    {
+    /**
+     * Sending asynchronously a message to Backtrace API
+     *
+     * @param message custom client message
+     * @return async task which send data to Backtrace API and return server response
+     */
+    public AsyncTask<Void, Void, BacktraceResult> sendAsync(String message) {
         return super.sendAsync(message);
     }
 
-    public AsyncTask<Void, Void, BacktraceResult> sendAsync(Exception e)
-    {
-        return super.sendAsync(e);
+    /**
+     * Sending asynchronously an Exception to Backtrace API
+     *
+     * @param exception current exception
+     * @return async task which send data to Backtrace API and return server response
+     */
+    public AsyncTask<Void, Void, BacktraceResult> sendAsync(Exception exception) {
+        return super.sendAsync(exception);
     }
 
-    public AsyncTask<Void, Void, BacktraceResult> sendAsync(BacktraceReport report)
-    {
+    /**
+     * Sending asynchronously a Backtrace report to Backtrace API
+     *
+     * @param report current BacktraceReport
+     * @return async task which send data to Backtrace API and return server response
+     */
+    public AsyncTask<Void, Void, BacktraceResult> sendAsync(BacktraceReport report) {
         return super.sendAsync(report);
     }
-}
+}

backtrace-library/src/main/java/backtraceio/library/BacktraceClient.java

@@ -1,24 +1,38 @@
 package backtraceio.library;
 
-import android.util.Log;
-
+/**
+ * Backtrace credentials information
+ */
 public class BacktraceCredentials {
-    private String TAG = "BACKTRACE.IO";
     private String endpointUrl;
     private String submissionToken;
 
+    /**
+     * Get URL to Backtrace server API
+     *
+     * @return endpoint url
+     */
     public String getEndpointUrl() {
         return endpointUrl;
     }
 
+    /**
+     * Get an access token to Backtrace server API
+     *
+     * @return access token
+     */
     public String getSubmissionToken() {
         return submissionToken;
     }
 
-    public BacktraceCredentials(String endpointUrl, String submissionToken)
-    {
+    /**
+     * Initialize Backtrace credentials
+     *
+     * @param endpointUrl
+     * @param submissionToken
+     */
+    public BacktraceCredentials(String endpointUrl, String submissionToken) {
         this.endpointUrl = endpointUrl;
         this.submissionToken = submissionToken;
-        Log.d(TAG, endpointUrl);
     }
 }