Use Instabug v3

Author: mhmdnagy

CHANGELOG.md

@@ -1,7 +1,22 @@
 Change Log
 ==========
 
-Version 2.6.0 *(2016-08-03)*
+
+Version 3.0.0 *(2016-10-16)*
+----------------------------
+
+* We have completely redesigned how the SDK looks and given you even more customization options to better fit the style of your app.
+* Added the ability to attach a screen recording to bug reports and conversations.
+* Enhanced our in-app messaging experience to enable users to start conversations with your team right from your app, complete with screenshots, screen recordings and voice notes attachments support.
+* We have localized the SDK into new languages. We now support a total of 20 languages.
+
+Version 2.6.2 *(2016-09-09)*
+----------------------------
+
+ * Bug fixes
+
+
+Version 2.6.1 *(2016-08-03)*
 ----------------------------
 
  * Bug fixes

README.md

@@ -12,57 +12,29 @@ Using Instabug is as easy as "Get ready, Get set, Go".
 1. <b>Determining which Instabug flavour to use</b> (Getting ready)
     * If your `minSdkVersion` is `14+`:
 
-        Use `instabug` flavour
+        Check `Above14` flavour
 
     * If your `minSdkVersion` is `10+`:
-    
-        * If you're using Google support libraries (`com.android.support:*`):
-    
-            Use `instabugcompat` flavour
-        
-        * If you're using [ActionBarSherlock](https://github.com/JakeWharton/ActionBarSherlock):
-    
-            Use `instabugabs` flavour
+
+        Check `belowApi14` flavour
 
 1. <b>Adding Instabug to your dependencies</b> (Getting set)
 
     Grab your desired flavour via Gradle:
     ```groovy
-        compile 'com.instabug.library:instabug:2.6.1'
+        compile 'com.instabug.library:instabug:3.0.0'
     ```
-    or
-    ```groovy
-        compile 'com.instabug.library:instabugcompat:2.6.1'
-    ```
-    or
-    ```groovy
-        compile 'com.instabug.library:instabugabs:2.6.1'
+  
     ```
     or via Maven: (if you're that kind of person :bowtie:)
     ```xml
         <dependency>
           <groupId>com.instabug.library</groupId>
           <artifactId>instabug</artifactId>
-          <version>2.6.1</version>
-        </dependency>
-    ```
-    or 
-    ```xml
-        <dependency>
-          <groupId>com.instabug.library</groupId>
-          <artifactId>instabugcompat</artifactId>
-          <version>2.6.1</version>
-        </dependency>
-    ```
-    or
-    ```xml
-        <dependency>
-          <groupId>com.instabug.library</groupId>
-          <artifactId>instabugabs</artifactId>
-          <version>2.6.1</version>
+          <version>3.0.0</version>
         </dependency>
     ```
-
+   
 1. <b>Using Instabug</b> (Good to go!)
     
     * Initializing Instabug:
@@ -74,28 +46,11 @@ Using Instabug is as easy as "Get ready, Get set, Go".
                     super.onCreate();
                     // ...
                     new Instabug.Builder(this, "<YOUR_APP_TOKEN>")
-                            .setInvocationEvent(IBGInvocationEvent.IBGInvocationEventFloatingButton)
+                            .setInvocationEvent(InstabugInvocationEvent.InstabugInvocationEventFloatingButton)
                             .build();
                     // ...
                 }
         ```
-    * Extending Instabug Activities:
-        
-        **ONLY** if your `minSdkVersion` is **`10+`** should you extend `Instabug*Activity`
-        * If you're using `instabugcompat`:
-            * `InstabugAppCompatActivity`: extends `android.support.v7.app.AppCompatActivity`
-            * `InstabugActionBarActivity`: extends `android.support.v7.app.ActionBarActivity`
-            * `InstabugActivity`: extends `android.app.activity`
-            * `InstabugFragmentActivity`: extends `android.support.v4.app.FragmentActivity`
-            * `InstabugExpandableListActivity`: extends `android.app.ExpandableListActivity`
-            * `InstabugListActivity`: extends `android.app.ListActivity`
-            * `InstabugPreferenceActivity`: extends `android.preference.PreferenceActivity`
-        * If you're using `instabugabs`:
-            * `InstabugSherlockActivity`: extends `com.actionbarsherlock.app.SherlockActivity`
-            * `InstabugSherlockFragmentActivity`: extends `com.actionbarsherlock.app.SherlockFragmentActivity`
-            * `InstabugSherlockExpandableListActivity`: extends `com.actionbarsherlock.app.SherlockExpandableListActivity`
-            * `InstabugSherlockListActivity`: extends `com.actionbarsherlock.app.SherlockListActivity`
-            * `InstabugSherlockPreferenceActivity`: extends `com.actionbarsherlock.app.SherlockPreferenceActivity`
     
 For technical documentation and FAQs check the [wiki][wiki]
 

app/build.gradle

@@ -18,6 +18,19 @@ android {
             proguardFiles getDefaultProguardFile('proguard-android.txt'), 'proguard-rules.pro'
         }
     }
+
+    productFlavors {
+        aboveApi14{
+            minSdkVersion 15
+            applicationId "com.example.instabug.above4"
+            versionName "1.0-aboveApi14"
+        }
+        belowApi14 {
+            minSdkVersion 10
+            applicationId "com.example.instabug.below14"
+            versionName "1.0-belowApi14"
+        }
+    }
 }
 
 repositories {
@@ -30,7 +43,6 @@ repositories {
 
 dependencies {
     compile fileTree(dir: 'libs', include: ['*.jar'])
-    testCompile 'junit:junit:4.12'
     compile 'com.android.support:multidex:1.0.1'
     compile 'com.jakewharton:butterknife:7.0.1'
     compile 'com.android.support:design:23.2.0'
@@ -40,13 +52,12 @@ dependencies {
     // TODO add the following 2 lines if you exclude io.reactivex from Instabug
 //    compile 'io.reactivex:rxjava:1.0.13'
 //    compile 'io.reactivex:rxandroid:1.0.1'
-    compile('com.instabug.library:instabug:2.6.1') {
+    compile('com.instabug.library:instabug:3.0.0') {
         // TODO uncomment this line to exclude RxJava from Instabug and use your own version
 //        exclude group: 'io.reactivex'
 
-        exclude group: 'com.android.support'
         // TODO uncomment next line if you're facing compilation issue in build.gradle about gms different versions
-//        exclude group: 'com.google.android.gms'
+        exclude group: 'com.android.support'
     }
 
 

app/src/aboveApi14/java/com.example.instabug/BaseActivity.java

@@ -0,0 +1,21 @@
+package com.example.instabug;
+
+import android.support.v7.app.AppCompatActivity;
+import android.view.MotionEvent;
+
+import com.instabug.library.InstabugTrackingDelegate;
+
+/**
+ * Created by vezikon on 10/15/16.
+ */
+
+public class BaseActivity extends AppCompatActivity {
+
+    @Override
+    public boolean dispatchTouchEvent(MotionEvent ev) {
+        //To allow instabug to track user steps
+        // and also add touches to screen recording
+        InstabugTrackingDelegate.notifyActivityGotTouchEvent(ev, this);
+        return super.dispatchTouchEvent(ev);
+    }
+}

app/src/belowApi14/java/com/example/instabug/BaseActivity.java

@@ -0,0 +1,58 @@
+package com.example.instabug;
+
+import android.os.Bundle;
+import android.support.v7.app.AppCompatActivity;
+import android.view.MotionEvent;
+
+import com.instabug.library.InstabugTrackingDelegate;
+
+
+/**
+ * For below API 14 support you need to manually track
+ * the lifecycle of the activity
+ */
+public class BaseActivity extends AppCompatActivity {
+    @Override
+    protected void onCreate(Bundle savedInstanceState) {
+        super.onCreate(savedInstanceState);
+        InstabugTrackingDelegate.notifyActivityCreated(this);
+    }
+
+    @Override
+    protected void onStart() {
+        super.onStart();
+        InstabugTrackingDelegate.notifyActivityStarted(this);
+    }
+
+    @Override
+    protected void onResume() {
+        super.onResume();
+        InstabugTrackingDelegate.notifyActivityResumed(this);
+    }
+
+    @Override
+    protected void onPause() {
+        super.onPause();
+        InstabugTrackingDelegate.notifyActivityPaused(this);
+    }
+
+    @Override
+    protected void onStop() {
+        super.onStop();
+        InstabugTrackingDelegate.notifyActivityCreated(this);
+    }
+
+    @Override
+    protected void onDestroy() {
+        super.onDestroy();
+        InstabugTrackingDelegate.notifyActivityDestroyed(this);
+    }
+
+    @Override
+    public boolean dispatchTouchEvent(MotionEvent ev) {
+        //To allow instabug to track user steps
+        // and also add touches to screen recording
+        InstabugTrackingDelegate.notifyActivityGotTouchEvent(ev, this);
+        return super.dispatchTouchEvent(ev);
+    }
+}

app/src/main/java/com/example/instabug/SampleApplication.java

@@ -7,7 +7,10 @@
 import com.instabug.library.IBGCustomTextPlaceHolder;
 import com.instabug.library.IBGInvocationEvent;
 import com.instabug.library.Instabug;
+import com.instabug.library.InstabugColorTheme;
+import com.instabug.library.InstabugCustomTextPlaceHolder;
 import com.instabug.library.internal.module.InstabugLocale;
+import com.instabug.library.invocation.InstabugInvocationEvent;
 
 import java.security.KeyFactory;
 import java.util.Locale;
@@ -21,22 +24,24 @@ public void onCreate() {
         super.onCreate();
         MultiDex.install(this);
         new Instabug.Builder(this, "f501f761142981d54b1fdea93963a934")
-                .setDebugEnabled(true)
                 .setEmailFieldRequired(false)
                 .setFloatingButtonOffsetFromTop(400)
-                .setColorTheme(IBGColorTheme.IBGColorThemeLight)
-                .setShouldShowIntroDialog(false)
-                .setInvocationEvent(IBGInvocationEvent.IBGInvocationEventShake)
+                .setTheme(InstabugColorTheme.InstabugColorThemeLight)
+                .setIntroMessageEnabled(false)
+                .setInvocationEvent(InstabugInvocationEvent.SHAKE)
+                .setAttachmentTypesEnabled(true, true, true, true, true)
                         // TODO the following are 3 acceptable ways to force Locale in Instabug (last one is the only 1 applied)
                 .setLocale(new Locale(InstabugLocale.SIMPLIFIED_CHINESE.getCode(), InstabugLocale.SIMPLIFIED_CHINESE.getCountry()))
                 .setLocale(new Locale(InstabugLocale.FRENCH.getCode()))
                 .setLocale(Locale.GERMAN)
                 .build();
 
+        Instabug.setDebugEnabled(true);
+
         //Settings custom strings to replace instabug's strings
-        IBGCustomTextPlaceHolder placeHolder = new IBGCustomTextPlaceHolder();
-        placeHolder.set(IBGCustomTextPlaceHolder.Key.REPORT_FEEDBACK, "Send Feedback");
-        placeHolder.set(IBGCustomTextPlaceHolder.Key.REPORT_BUG, "Send Bug Report");
+        InstabugCustomTextPlaceHolder placeHolder = new InstabugCustomTextPlaceHolder();
+        placeHolder.set(InstabugCustomTextPlaceHolder.Key.REPORT_FEEDBACK, "Send Feedback");
+        placeHolder.set(InstabugCustomTextPlaceHolder.Key.REPORT_BUG, "Send Bug Report");
 
         Instabug.setCustomTextPlaceHolders(placeHolder);
     }

app/src/main/java/com/example/instabug/ui/activities/GoogleMapsActivity.java

@@ -2,20 +2,19 @@
 
 import android.net.Uri;
 import android.os.Bundle;
-import android.support.v7.app.AppCompatActivity;
 import android.view.View;
 import android.widget.Toast;
 
+import com.example.instabug.BaseActivity;
 import com.example.instabug.R;
-import com.example.instabug.ui.views.CustomGoogleMap;
 import com.google.android.gms.maps.GoogleMap;
 import com.google.android.gms.maps.OnMapReadyCallback;
 import com.google.android.gms.maps.SupportMapFragment;
 import com.google.android.gms.maps.model.LatLng;
 import com.google.android.gms.maps.model.MarkerOptions;
 import com.instabug.library.Instabug;
 
-public class GoogleMapsActivity extends AppCompatActivity implements OnMapReadyCallback {
+public class GoogleMapsActivity extends BaseActivity implements OnMapReadyCallback {
 
     private GoogleMap mMap; // Might be null if Google Play services APK is not available.
     private SupportMapFragment mapFragment;
@@ -50,10 +49,6 @@ private void setUpMap() {
     @Override
     public void onMapReady(GoogleMap googleMap) {
         mMap = googleMap;
-        CustomGoogleMap customGoogleMap = new CustomGoogleMap(mapFragment.getView(), mMap);
-        // TODO add this so that instabug recognizes you have a map and show it in the screenshot
-        Instabug.addCapturableView(customGoogleMap);
-
         setUpMap();
     }
 }

app/src/main/java/com/example/instabug/ui/activities/MainActivity.java

@@ -9,14 +9,14 @@
 import android.support.v4.view.GravityCompat;
 import android.support.v4.widget.DrawerLayout;
 import android.support.v7.app.ActionBarDrawerToggle;
-import android.support.v7.app.AppCompatActivity;
 import android.support.v7.widget.Toolbar;
 import android.view.Menu;
 import android.view.MenuItem;
 import android.view.View;
 import android.widget.ImageView;
 import android.widget.Toast;
 
+import com.example.instabug.BaseActivity;
 import com.example.instabug.R;
 import com.example.instabug.gcm.RegistrationIntentService;
 import com.instabug.library.Instabug;
@@ -25,7 +25,7 @@
 import butterknife.ButterKnife;
 import butterknife.OnClick;
 
-public class MainActivity extends AppCompatActivity
+public class MainActivity extends BaseActivity
         implements NavigationView.OnNavigationItemSelectedListener {
 
     @Bind(R.id.drawer_layout)

app/src/main/java/com/example/instabug/ui/activities/OpenGLActivity.java

@@ -5,13 +5,12 @@
 import android.opengl.GLSurfaceView;
 import android.opengl.Matrix;
 import android.os.Bundle;
-import android.support.v7.app.ActionBarActivity;
 import android.util.Log;
 import android.view.MotionEvent;
 import android.widget.FrameLayout;
 
+import com.example.instabug.BaseActivity;
 import com.example.instabug.R;
-import com.instabug.library.Instabug;
 
 import java.nio.ByteBuffer;
 import java.nio.ByteOrder;
@@ -22,7 +21,7 @@
 import javax.microedition.khronos.opengles.GL10;
 
 
-public class OpenGLActivity extends ActionBarActivity {
+public class OpenGLActivity extends BaseActivity {
 
     private GLSurfaceView mGLView;
 
@@ -37,7 +36,6 @@ public void onCreate(Bundle savedInstanceState) {
         // as the ContentView for this Activity
         mGLView = new MyGLSurfaceView(this);
         // TODO add this so that instabug recognizes you have an OpenGL surface and show it in the screenshot
-        Instabug.setGLSurfaceView(mGLView);
         mainLayout.addView(mGLView, 0);
     }