Improve header handling

The User-Agent and proxer-api-key header are now added always to ProxerRequests but not to the OkHttp instance itself. This makes sure that all calls to the Proxer Api have those headers, but the OkHttp is unaffacted and can reused for different things.
This also allows for re-adding the ApiKeyHeaderTest.

Author: rubengees

library/src/androidTest/java/com/proxerme/library/connection/ProxerConnectionTest.java

@@ -50,6 +50,7 @@ public class ProxerConnectionTest {
 
     private static final String API_KEY = "test";
 
+    private static final String API_KEY_HEADER = "proxer-api-key";
     private static final String USER_AGENT_HEADER = "User-Agent";
     private static final String DEFAULT_USER_AGENT = "ProxerLibAndroid/" + BuildConfig.VERSION_NAME;
     private static final String CUSTOM_USER_AGENT = "Test/123";
@@ -70,6 +71,24 @@ public static void tearDownServer() throws IOException {
         server.shutdown();
     }
 
+    @Test
+    public void testApiKeyHeader() throws Exception {
+        server.enqueue(new MockResponse().setBody(loadResponse(R.raw.news)));
+
+        connection.executeSynchronized(new NewsRequest(0)
+                .withCustomHost(buildHostUrl(server.url(URL))));
+
+        assertEquals(API_KEY, server.takeRequest().getHeader(API_KEY_HEADER));
+    }
+
+    @Test
+    public void testApiKey() throws Exception {
+        ProxerConnection testConnection = new ProxerConnection.Builder(API_KEY,
+                InstrumentationRegistry.getContext()).build();
+
+        assertSame(API_KEY, testConnection.getApiKey());
+    }
+
     @Test
     public void testUserAgentHeader() throws Exception {
         server.enqueue(new MockResponse().setBody(loadResponse(R.raw.news)));
@@ -95,14 +114,6 @@ public void testCustomUserAgentHeader() throws Exception {
         assertEquals(CUSTOM_USER_AGENT, server.takeRequest().getHeader(USER_AGENT_HEADER));
     }
 
-    @Test
-    public void testApiKey() throws Exception {
-        ProxerConnection testConnection = new ProxerConnection.Builder(API_KEY,
-                InstrumentationRegistry.getContext()).build();
-
-        assertSame(API_KEY, testConnection.getApiKey());
-    }
-
     @Test
     public void testCustomMoshi() throws Exception {
         Moshi moshi = new Moshi.Builder().build();

library/src/main/java/com/proxerme/library/connection/ProxerConnection.java

@@ -11,7 +11,6 @@
 import com.franmontiel.persistentcookiejar.PersistentCookieJar;
 import com.franmontiel.persistentcookiejar.cache.SetCookieCache;
 import com.proxerme.library.BuildConfig;
-import com.proxerme.library.info.ProxerUrlHolder;
 import com.proxerme.library.util.SaveAllSharedPrefCookiePersistor;
 import com.squareup.moshi.JsonDataException;
 import com.squareup.moshi.Moshi;
@@ -22,8 +21,8 @@
 import okhttp3.Call;
 import okhttp3.Callback;
 import okhttp3.CookieJar;
-import okhttp3.Interceptor;
 import okhttp3.OkHttpClient;
+import okhttp3.Request;
 import okhttp3.Response;
 
 /**
@@ -67,7 +66,11 @@
  */
 public final class ProxerConnection {
 
+    private static final String API_KEY_HEADER = "proxer-api-key";
+    private static final String USER_AGENT_HEADER = "User-Agent";
+
     private String apiKey;
+    private String userAgent;
     private Moshi moshi;
     private OkHttpClient httpClient;
 
@@ -76,9 +79,10 @@ public final class ProxerConnection {
     private Handler handler = new Handler(Looper.getMainLooper());
     private ConcurrentHashMap<Integer, ErrorListener> listenerMap;
 
-    private ProxerConnection(@NonNull String apiKey, Moshi moshi, OkHttpClient httpClient,
-                             boolean deliverCancelledRequests) {
+    private ProxerConnection(@NonNull String apiKey, @NonNull String userAgent, Moshi moshi,
+                             OkHttpClient httpClient, boolean deliverCancelledRequests) {
         this.apiKey = apiKey;
+        this.userAgent = userAgent;
         this.moshi = moshi;
         this.httpClient = httpClient;
         this.deliverCancelledRequests = deliverCancelledRequests;
@@ -99,7 +103,7 @@ private ProxerConnection(@NonNull String apiKey, Moshi moshi, OkHttpClient httpC
     public <T> ProxerCall execute(@NonNull final ProxerRequest<T> request,
                                   @Nullable final ProxerCallback<T> callback,
                                   @Nullable final ProxerErrorCallback errorCallback) {
-        Call call = httpClient.newCall(request.build());
+        Call call = httpClient.newCall(buildRequest(request));
 
         call.enqueue(new Callback() {
             @Override
@@ -148,7 +152,7 @@ public void onFailure(Call call, IOException exception) {
     @RequiresPermission(android.Manifest.permission.INTERNET)
     public <T> T executeSynchronized(@NonNull final ProxerRequest<T> request)
             throws ProxerException {
-        final Call call = httpClient.newCall(request.build());
+        final Call call = httpClient.newCall(buildRequest(request));
         Response response = null;
 
         try {
@@ -297,6 +301,13 @@ private void notifyListener(@NonNull ProxerException exception) {
         }
     }
 
+    private <T> Request buildRequest(ProxerRequest<T> request) {
+        return request.build().newBuilder()
+                .header(API_KEY_HEADER, apiKey)
+                .header(USER_AGENT_HEADER, userAgent)
+                .build();
+    }
+
     public interface ErrorListener {
         void onError(@NonNull ProxerException exception);
     }
@@ -306,9 +317,7 @@ public interface ErrorListener {
      */
     public static class Builder {
 
-        private static final String API_KEY_HEADER = "proxer-api-key";
         private static final String DEFAULT_USER_AGENT = "ProxerLibAndroid";
-        private static final String USER_AGENT_HEADER = "User-Agent";
 
         private String apiKey;
         private Context context;
@@ -354,7 +363,8 @@ public ProxerConnection build() {
             configureUserAgent();
             configureOkHttp();
 
-            return new ProxerConnection(apiKey, moshi, httpClient, deliverCancelledRequests);
+            return new ProxerConnection(apiKey, userAgent, moshi, httpClient,
+                    deliverCancelledRequests);
         }
 
         /**
@@ -435,48 +445,7 @@ private void configureOkHttp() {
                 builder = httpClient.newBuilder();
             }
 
-            httpClient = builder.cookieJar(cookieJar)
-                    .addInterceptor(new ApiKeyInterceptor(apiKey))
-                    .addInterceptor(new UserAgentInterceptor(userAgent))
-                    .build();
-        }
-
-        private class ApiKeyInterceptor implements Interceptor {
-
-            private String apiKey;
-
-            ApiKeyInterceptor(String apiKey) {
-                this.apiKey = apiKey;
-            }
-
-            @Override
-            public Response intercept(Chain chain) throws IOException {
-                if (chain.request().url().host()
-                        .equals(ProxerUrlHolder.getBaseApiHost().host())) {
-                    return chain.proceed(chain.request().newBuilder()
-                            .header(API_KEY_HEADER, apiKey)
-                            .build());
-                } else {
-                    return chain.proceed(chain.request());
-                }
-            }
-        }
-
-        private class UserAgentInterceptor implements Interceptor {
-
-            private String userAgent;
-
-            UserAgentInterceptor(@NonNull String userAgent) {
-                this.userAgent = userAgent;
-            }
-
-            @Override
-            public Response intercept(Chain chain) throws IOException {
-                return chain.proceed(chain.request().newBuilder()
-                        .header(USER_AGENT_HEADER, userAgent)
-                        .build());
-            }
+            httpClient = builder.cookieJar(cookieJar).build();
         }
-
     }
 }