Remove Chuck Interceptor (#327)

* Comment the gradle dependecies
 * Remove code associated with Chuck Interceptor
 * Add directions to re-enable chuck

Closes #322

Author: adi23arora

DEBUG.md

@@ -1,24 +1,63 @@
 # Debugging
 
+## Using a Custom Server
+
 Sometimes you may need to debug with some special purpose server. To do that, add a file like this
 
  src/main/assets/customServers.json
 
 with details of the custom server(s) you need, like this:
 
- ```
-  [
-    {
-      "name": "Test Server 1",
-      "session_token": "12345678901234567",
-      "local_address": "http://192.168.0.11:4563",
-      "remote_address": "http://192.168.12.22:4563"
-    },
-    {
-      "name": "Test Server 2",
-      "session_token": "12345678901234567",
-      "local_address": "http://192.168.0.11:4563",
-      "remote_address": "http://192.168.12.22:4563"
-    }
-  ]
- ```
+```
+[
+  {
+    "name": "Test Server 1",
+    "session_token": "12345678901234567",
+    "local_address": "http://192.168.0.11:4563",
+    "remote_address": "http://192.168.12.22:4563"
+  },
+  {
+    "name": "Test Server 2",
+    "session_token": "12345678901234567",
+    "local_address": "http://192.168.0.11:4563",
+    "remote_address": "http://192.168.12.22:4563"
+  }
+]
+```
+
+
+## Enabling Chuck Interceptor
+
+Some relevant information about Chuck Interceptor can be found [here](https://github.com/jgilfelt/chuck).
+
+We have disabled Chuck Interceptor by default in Amahi App. But if you want to use it for debugging, you can enable it by following these steps :
+
+1. Enable the dependencies in `build.gradle` by uncommenting the following code : 
+
+```
+debugImplementation 'com.readystatesoftware.chuck:library:1.1.0'
+releaseImplementation 'com.readystatesoftware.chuck:library-no-op:1.1.0'
+betaReleaseImplementation 'com.readystatesoftware.chuck:library-no-op:1.1.0'
+```
+
+2. Now modify the `ApIModule.java` file to add the Chuck Interceptor :
+  
+  * Creating an instance for Chuck Interceptor, by uncommenting following block of code:
+  ```
+  @Provides
+  @Singleton
+  ChuckInterceptor provideChuckInterceptor(Context context) {
+    return new ChuckInterceptor(context);
+  }
+  ```
+  
+  * Modify the function definition to pass Chuck Interceptor :
+    ```
+    provideHttpClient(ApiHeaders headers, HttpLoggingInterceptor logging, ChuckInterceptor chuck)
+    ```
+
+    * Add the Chuck interceptor when building OkHttpClient, using:
+  ```
+  clientBuilder.addInterceptor(chuck);
+  ```
+     

README.md

@@ -53,3 +53,9 @@ This is something to keep **private** and you obtain it by asking in the [Amahi
   ```
   $ ./gradlew clean assembleDebug generateDebugJavadoc
   ```
+
+## Debugging
+
+* For debugging the APIs and logging requests and responses you can either use `Logcat` on Android Studio or enable `Chuck Interceptor` (UI based) from the steps given [here](DEBUG.md#enabling-chuck-interceptor).
+
+* To debug with some special purpose server, you can find steps [here](DEBUG.md#using-a-custom-server).

build.gradle

@@ -145,9 +145,14 @@ dependencies {
     androidTestImplementation 'com.android.support:support-annotations:25.4.0'
     compileOnly 'com.squareup.dagger:dagger-compiler:1.2.5'
     implementation 'com.github.wseemann:FFmpegMediaMetadataRetriever:1.0.14'
+
+    // Uncomment the dependencies below to enable Chuck Interceptor for logging
+/*
     debugImplementation 'com.readystatesoftware.chuck:library:1.1.0'
     releaseImplementation 'com.readystatesoftware.chuck:library-no-op:1.1.0'
     betaReleaseImplementation 'com.readystatesoftware.chuck:library-no-op:1.1.0'
+*/
+
 }
 
 task generateWrapper(type: Wrapper) {

src/main/java/org/amahi/anywhere/server/ApiModule.java

@@ -23,7 +23,6 @@
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
-import com.readystatesoftware.chuck.ChuckInterceptor;
 
 import org.amahi.anywhere.BuildConfig;
 import org.amahi.anywhere.util.Time;
@@ -41,18 +40,29 @@
  * API dependency injection module. Provides resources such as HTTP client and JSON converter
  * for possible consumers.
  */
+
 @Module(
     complete = false,
     library = true
 )
 public class ApiModule {
+
+    /**
+     * After enabling the chuck dependencies modify the function definition below to pass ChuckInterceptor:
+     *      provideHttpClient(ApiHeaders headers, HttpLoggingInterceptor logging, ChuckInterceptor chuck)
+     *
+     * Add the Chuck interceptor when building OkHttpClient, using:
+     *      clientBuilder.addInterceptor(chuck);
+     */
+
     @Provides
     @Singleton
-    OkHttpClient provideHttpClient(ApiHeaders headers, HttpLoggingInterceptor logging, ChuckInterceptor chuck) {
+    OkHttpClient provideHttpClient(ApiHeaders headers, HttpLoggingInterceptor logging) {
         OkHttpClient.Builder clientBuilder = new OkHttpClient.Builder();
+
         clientBuilder.addInterceptor(headers);
         clientBuilder.addInterceptor(logging);
-        clientBuilder.addInterceptor(chuck);
+
         return clientBuilder.build();
     }
 
@@ -62,11 +72,17 @@ ApiHeaders provideHeaders(Context context) {
         return new ApiHeaders(context);
     }
 
+    /**
+     * Creating an instance for ChuckInterceptor and providing it with context
+     * Uncomment the code below if using Chuck Interceptor for logging
+     */
+/*
     @Provides
     @Singleton
     ChuckInterceptor provideChuckInterceptor(Context context) {
         return new ChuckInterceptor(context);
     }
+*/
 
     @Provides
     @Singleton