Merge pull request #245 from Microsoft/develop

0.3.1

Author: guperrot

.gitignore

@@ -35,7 +35,6 @@ captures/
 
 # Intellij
 *.iml
-.idea/workspace.xml
 .idea/
 
 # Keystore files

LICENSE.md

@@ -1,5 +1,8 @@
 [![Build Status](https://www.bitrise.io/app/78891228f9c6e6dc.svg?token=KQ6kVAci490XBjulCcQuGQ&branch=develop)](https://www.bitrise.io/app/78891228f9c6e6dc)
 [![codecov](https://codecov.io/gh/Microsoft/MobileCenter-SDK-Android/branch/develop/graph/badge.svg?token=YwMZRPnYK3)](https://codecov.io/gh/Microsoft/MobileCenter-SDK-Android)
+[![GitHub Release](https://img.shields.io/github/release/Microsoft/MobileCenter-SDK-Android.svg)](https://github.com/Microsoft/MobileCenter-SDK-Android/releases/latest)
+[![Bintray](https://img.shields.io/bintray/v/mobilecenter/mobilecenter/mobile-center.svg)](https://bintray.com/mobilecenter/mobilecenter)
+[![license](https://img.shields.io/badge/license-MIT%20License-yellow.svg)](https://github.com/Microsoft/MobileCenter-SDK-Android/blob/develop/license.txt)
 
 # Mobile Center SDK for Android
 
@@ -40,46 +43,32 @@ The Mobile Center SDK is designed with a modular approach – a developer only n
 
 Below are the steps on how to integrate our compiled libraries in your application using Android Studio and Gradle.
 
-1. Open your app level build.gradle file (app/build.gradle) and add the following lines after `apply plugin`. During the private beta, you need to include these credentials in order to get the libraries.
-
-    ```groovy
-    repositories {
-        maven {
-            url  'http://mobilecenter.bintray.com/mobilecenter'
-            credentials {
-                username 'mobile-center'
-                password '9263658ba66b541c798b704723cc020cb40c6f78'
-            }
-        }
-    }
-    ```
-
-2. In the same file, include the dependencies that you want in your project. Each SDK module needs to be added as a separate dependency in this section. If you would want to use both Analytics and Crashes, add the following lines:
+1. Open your app level build.gradle file (app/build.gradle) and include the dependencies that you want in your project. Each SDK module needs to be added as a separate dependency in this section. If you would want to use both Analytics and Crashes, add the following lines:
 
     ```groovy
     dependencies {
-        def mobileCenterSdkVersion = '0.3.0'
+        def mobileCenterSdkVersion = '0.3.1'
         compile "com.microsoft.azure.mobile:mobile-center-analytics:${mobileCenterSdkVersion}"
         compile "com.microsoft.azure.mobile:mobile-center-crashes:${mobileCenterSdkVersion}"
     }
     ```
 
-3. Save your build.gradle file and make sure to trigger a Gradle sync in Android Studio.
+2. Save your build.gradle file and make sure to trigger a Gradle sync in Android Studio.
 
 Now that you've integrated the SDK in your application, it's time to start the SDK and make use of Mobile Center services.
 
 ## 3. Start the SDK
 
 To start the Mobile Center SDK in your app, follow these steps:
 
-1. **Start the SDK:**  Mobile Center provides developers with two modules to get started – Analytics and Crashes. In order to use these modules, you need to opt in for the module(s) that you'd like, meaning by default no modules are started and you will have to explicitly call each of them when starting the SDK. Insert the following line inside your app's main activity class' `onCreate` callback.
+1. **Start the SDK:**  Mobile Center provides developers with two services to get started – Analytics and Crashes. In order to use these services, you need to opt in for the service(s) that you'd like, meaning by default no services are started and you will have to explicitly call each of them when starting the SDK. Insert the following line inside your app's main activity class' `onCreate` callback.
 
     ```Java
     MobileCenter.start(getApplication(), "{Your App Secret}", Analytics.class, Crashes.class);
     ```
     You can also copy paste the `start` method call from the Overview page on Mobile Center portal once your app is selected. It already includes the App Secret so that all the data collected by the SDK corresponds to your application. Make sure to replace {Your App Secret} text with the actual value for your application.
     
-    The example above shows how to use the `start()` method and include both the Analytics and Crashes module. If you wish not to use Analytics, remove the parameter from the method call above. Note that, unless you explicitly specify each module as parameters in the start method, you can't use that Mobile Center service. Also, the `start()` API can be used only once in the lifecycle of your app – all other calls will log a warning to the console and only the modules included in the first call will be available.
+    The example above shows how to use the `start()` method and include both the Analytics and Crashes services. If you wish not to use Analytics, remove the parameter from the method call above. Note that, unless you explicitly specify each service as parameters in the start method, you can't use that Mobile Center service. Also, the `start()` API can be used only once in the lifecycle of your app – all other calls will log a warning to the console and only the services included in the first call will be available.
 
     Android Studio will automatically suggest the required import statements once you insert the `start()` method-call, but if you see an error that the class names are not recognized, add the following lines to the import statements in your activity class:
     
@@ -91,7 +80,7 @@ To start the Mobile Center SDK in your app, follow these steps:
 
 ## 4. Analytics APIs
 
-* **Track Session, Device Properties:**  Once the Analytics module is included in your app and the SDK is started, it will automatically track sessions, device properties like OS Version, model, manufacturer etc. and you don’t need to add any additional code.
+* **Track Session, Device Properties:**  Once the Analytics service is included in your app and the SDK is started, it will automatically track sessions, device properties like OS Version, model, manufacturer etc. and you don’t need to add any additional code.
     Look at the section above on how to [Start the SDK](#3-start-the-sdk) if you haven't started it yet.
 
 * **Custom Events:** You can track your own custom events with specific properties to know what's happening in your app, understand user actions, and see the aggregates in the Mobile Center portal. Once you have started the SDK, use the `trackEvent()` method to track your events with properties.
@@ -110,21 +99,21 @@ To start the Mobile Center SDK in your app, follow these steps:
     Analytics.trackEvent("Video clicked");
     ```
 
-* **Enable or disable Analytics:**  You can change the enabled state of the Analytics module at runtime by calling the `Analytics.setEnabled()` method. If you disable it, the SDK will not collect any more analytics information for the app. To re-enable it, pass `true` as a parameter in the same method.
+* **Enable or disable Analytics:**  You can change the enabled state of the Analytics service at runtime by calling the `Analytics.setEnabled()` method. If you disable it, the SDK will not collect any more analytics information for the app. To re-enable it, pass `true` as a parameter in the same method.
 
     ```Java
     Analytics.setEnabled(false);
     ```
 
-    You can also check, if the module is enabled or not using the `isEnabled()` method:
+    You can also check if the service is enabled or not using the `isEnabled()` method:
 
     ```Java
     Analytics.isEnabled();
     ```
 
 ## 5. Crashes APIs
 
-Once you set up and start the Mobile Center SDK to use the Crashes module in your application, the SDK will automatically start logging any crashes in the device's local storage. When the user opens the application again, all pending crash logs will automatically be forwarded to Mobile Center and you can analyze the crash along with the stack trace on the Mobile Center portal. Refer to the section to [Start the SDK](#3-start-the-sdk) if you haven't done so already.
+Once you set up and start the Mobile Center SDK to use the Crashes service in your application, the SDK will automatically start logging any crashes in the device's local storage. When the user opens the application again, all pending crash logs will automatically be forwarded to Mobile Center and you can analyze the crash along with the stack trace on the Mobile Center portal. Refer to the section to [Start the SDK](#3-start-the-sdk) if you haven't done so already.
 
 * **Generate a test crash:** The SDK provides you with a static API to generate a test crash for easy testing of the SDK:
 
@@ -146,19 +135,19 @@ Once you set up and start the Mobile Center SDK to use the Crashes module in you
     ErrorReport crashReport = Crashes.getLastSessionCrashReport();
     ```
 
-* **Enable or disable the Crashes module:**  You can disable and opt out of using the Crashes module by calling the `setEnabled()` API and the SDK will collect no crashes for your app. Use the same API to re-enable it by passing `true` as a parameter.
+* **Enable or disable Crashes:**  You can disable and opt out of using Crashes by calling the `setEnabled()` API and the SDK will collect no crashes for your app. Use the same API to re-enable it by passing `true` as a parameter.
 
     ```Java
     Crashes.setEnabled(false);
     ```
 
-    You can also check if the module is enabled or not using the `isEnabled()` method:
+    You can also check if the service is enabled or not using the `isEnabled()` method:
 
     ```Java
     Crashes.isEnabled();
     ```
 
-* **Advanced Scenarios:**  The Crashes module provides callbacks for developers to perform additional actions before and when sending crash reports to Mobile Center. This gives you added flexibility on the crash reports that will be sent.
+* **Advanced Scenarios:**  The Crashes service provides callbacks for developers to perform additional actions before and when sending crash reports to Mobile Center. This gives you added flexibility on the crash reports that will be sent.
 To handle the callbacks, you must either implement all methods in the `CrashesListener` interface, or override the `AbstractCrashesListener` class and pick only the ones you're interested in.
 You create your own Crashes listener and assign it like this:
 
@@ -181,7 +170,7 @@ You create your own Crashes listener and assign it like this:
         ```
 
     * **User Confirmation:** If user privacy is important to you as a developer, you might want to get user confirmation before sending a crash report to Mobile Center. The SDK exposes a callback where you can tell it to await user confirmation before sending any crash reports.
-    Your app is then responsible for obtaining confirmation, e.g. through a dialog prompt with one of these options - "Always Send", "Send", and "Don't send". Based on the user input, you will tell the SDK and the crash will then respectively be forwarded to Mobile Center or not.
+    Your app is then responsible for obtaining confirmation, e.g. through a dialog prompt with one of these options - "Always Send", "Send", and "Don't Send". Based on the user input, you will tell the SDK and the crash will then respectively be forwarded to Mobile Center or not.
 
         ```Java
         boolean CrashesListener.shouldAwaitUserConfirmation() {
@@ -259,7 +248,7 @@ You create your own Crashes listener and assign it like this:
     You only include the modules for the services you want to use. They all have a dependency on the Mobile Center module, so this will be included once you pull down the dependencies.
 
 * **Debugging steps, when you can't see crash reports on the portal:**
-    1. Make sure the SDK `start()` API is used correctly and the Crashes module is configured. Also, you need to restart the app after a crash – our SDK will forward the crash log only after it's restarted.
+    1. Make sure the SDK `start()` API is used correctly and the Crashes service is configured. Also, you need to restart the app after a crash – our SDK will forward the crash log only after it's restarted.
     2. Make sure your device is connected to the internet.
     3. Check if the App Secret used to start the SDK matches the App Secret in the Mobile Center portal.
     4. Disable any other SDK that provides Crash Reporting functionality, as those might interfere with the Mobile Center SDK.
@@ -271,13 +260,4 @@ You create your own Crashes listener and assign it like this:
     Depending on the services you use, the following permissions are required:
     - Analytics, Crashes: `INTERNET`, `ACCESS_NETWORK_STATE`
 
-    Required permissions will automatically be merged into your app's manifest by the SDK. Where possible, the SDK will use [Run Time permissions](https://developer.android.com/training/permissions/requesting.html).
-
-* **Any privacy information tracked by SDK?**
-
-## 8. List of available libraries
-
- Gradle Dependency                                            | Service          
- ------------------------------------------------------------ | ---------------
- com.microsoft.azure.mobile:mobile-center-analytics:0.3.0     | Analytics    
- com.microsoft.azure.mobile:mobile-center-crashes:0.3.0       | Crashes
+    Required permissions are automatically merged into your app's manifest by the SDK.

README.md

@@ -4,20 +4,6 @@
 
 evaluationDependsOn(':apps')
 
-/*
- * Not a secret, will be shared with private beta customers, git repo itself is private.
- * This account is read only, we use different secret credentials to publish.
- */
-repositories {
-    maven {
-        url 'http://mobilecenter.bintray.com/mobilecenter'
-        credentials {
-            username 'mobile-center'
-            password '9263658ba66b541c798b704723cc020cb40c6f78'
-        }
-    }
-}
-
 android {
     productFlavors {
         projectDependency {
@@ -30,7 +16,7 @@ android {
 }
 
 dependencies {
-    def version = "0.2.0"
+    def version = "0.3.0"
     compile "com.android.support:appcompat-v7:${rootProject.ext.supportLibVersion}"
     projectDependencyCompile project(':sdk:mobile-center-analytics')
     projectDependencyCompile project(':sdk:mobile-center-crashes')

apps/sasquatch/build.gradle

@@ -24,7 +24,7 @@
     </PreferenceCategory>
 
     <PreferenceCategory
-        android:key="application_info_key"
+        android:key="@string/application_info_key"
         android:title="@string/application_info_title">
         <Preference
             android:key="@string/install_id_key"

apps/sasquatch/src/main/res/xml/settings.xml

@@ -148,6 +148,7 @@ subprojects {
         }
     }
 
+    //noinspection GroovyMissingReturnStatement
     install {
         afterEvaluate {
             repositories.mavenInstaller {

codecov.yml

@@ -54,7 +54,7 @@ public class Analytics extends AbstractMobileCenterService {
     private static Analytics sInstance = null;
 
     /**
-     * Log factories managed by this module.
+     * Log factories managed by this service.
      */
     private final Map<String, LogFactory> mFactories;
 
@@ -103,7 +103,7 @@ static synchronized void unsetInstance() {
     }
 
     /**
-     * Check whether Analytics module is enabled or not.
+     * Check whether Analytics service is enabled or not.
      *
      * @return <code>true</code> if enabled, <code>false</code> otherwise.
      */
@@ -112,7 +112,7 @@ public static boolean isEnabled() {
     }
 
     /**
-     * Enable or disable Analytics module.
+     * Enable or disable Analytics service.
      *
      * @param enabled <code>true</code> to enable, <code>false</code> to disable.
      */
@@ -139,7 +139,7 @@ static boolean isAutoPageTrackingEnabled() {
      *
      * TODO the backend does not support that service yet, will be public method later.
      *
-     * @param autoPageTrackingEnabled true to let the module track pages automatically, false otherwise (default state is true).
+     * @param autoPageTrackingEnabled true to let the service track pages automatically, false otherwise (default state is true).
      */
     static void setAutoPageTrackingEnabled(boolean autoPageTrackingEnabled) {
         getInstance().setInstanceAutoPageTrackingEnabled(autoPageTrackingEnabled);
@@ -214,6 +214,11 @@ protected String getServiceName() {
         return SERVICE_NAME;
     }
 
+    @Override
+    protected String getLoggerTag() {
+        return LOG_TAG;
+    }
+
     @Override
     public Map<String, LogFactory> getLogFactories() {
         return mFactories;

sdk/build.gradle

@@ -191,7 +191,7 @@ public void wrapperSdkOverrideLog() throws InterruptedException {
             public Object answer(InvocationOnMock invocationOnMock) throws Throwable {
                 ManagedErrorLog errorLog = (ManagedErrorLog) invocationOnMock.getArguments()[0];
                 errorLog.setErrorThreadName("ReplacedErrorThreadName");
-                Crashes.getInstance().saveWrapperSdkErrorLog(errorLog);
+                WrapperSdkExceptionManager.saveWrapperSdkErrorLog(errorLog);
                 return null;
             }
         }).when(wrapperSdkListener).onCrashCaptured(notNull(ManagedErrorLog.class));