Merge pull request #69 from mixer/feat/identifier

feat(*): require client-id header when requesting interactive endpoints

Author: pahimar

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>com.mixer</groupId>
     <artifactId>api</artifactId>
-    <version>5.0.4-SNAPSHOT</version>
+    <version>6.0.0-SNAPSHOT</version>
 
     <licenses>
         <license>

src/main/java/com/mixer/api/MixerAPI.java

@@ -27,15 +27,15 @@ public class MixerAPI {
 
     private static final URI DEFAULT_BASE_PATH = URI.create("https://mixer.com/api/v1/");
 
-    public MixerAPI() {
-        this(null);
+    public MixerAPI(String clientId) {
+        this(clientId, null);
     }
 
-    public MixerAPI(String oauthToken) {
-        this(DEFAULT_BASE_PATH, oauthToken);
+    public MixerAPI(String clientId, String oauthToken) {
+        this(clientId, DEFAULT_BASE_PATH, oauthToken);
     }
 
-    public MixerAPI(URI basePath, String oauthToken) {
+    public MixerAPI(String clientId, URI basePath, String oauthToken) {
         if (basePath != null) {
             this.basePath = basePath;
         } else {
@@ -49,7 +49,7 @@ public MixerAPI(URI basePath, String oauthToken) {
                 .create();
 
         this.executor = MoreExecutors.listeningDecorator(Executors.newFixedThreadPool(10));
-        this.http = new MixerHttpClient(this, oauthToken);
+        this.http = new MixerHttpClient(this, clientId, oauthToken);
         this.services = new ServiceManager<>();
 
         this.register(new UsersService(this));

src/main/java/com/mixer/api/http/MixerHttpClient.java

@@ -47,6 +47,7 @@ public class MixerHttpClient {
 
     private String userAgent;
     private String oauthToken;
+    private String clientId;
 
     public static final String X_JWT_HEADER = "X-JWT";
     private JSONWebToken jwt;
@@ -57,18 +58,20 @@ public class MixerHttpClient {
     public static final int CSRF_STATUS_CODE = 461;
     private String csrfToken;
 
-    public MixerHttpClient(MixerAPI mixer) {
-        this(mixer, null);
+    public MixerHttpClient(MixerAPI mixer, String clientId) {
+        this(mixer, null, clientId);
     }
 
-    public MixerHttpClient(MixerAPI mixer, String oauthToken) {
+    public MixerHttpClient(MixerAPI mixer, String oauthToken, String clientId) {
         this.mixer = mixer;
         this.cookieStore = new BasicCookieStore();
         this.http = this.buildHttpClient();
 
         if (oauthToken != null) {
             this.oauthToken = oauthToken;
         }
+
+        this.clientId = clientId;
     }
 
     protected HttpClient buildHttpClient() {
@@ -105,8 +108,7 @@ public ListenableFuture<T> apply(Object o) throws Exception {
 
 
     public <T> ListenableFuture<T> get(String path, Class<T> type, Map<String, Object> args) {
-        return this.baseSubmit(this.makeCallable(this.makeRequest(RequestType.GET,
-                this.buildFromRelativePath(path, args)), type));
+        return this.baseSubmit(this.makeCallable(this.makeRequest(RequestType.GET, this.buildFromRelativePath(path, args)), type));
     }
 
     public <T> ListenableFuture<T> post(String path, Class<T> type, Object... args) {
@@ -155,6 +157,10 @@ private HttpUriRequest makeRequest(RequestType requestType, URI uri, Object... a
         if (this.jwt != null) {
             requestBuilder.addHeader("Authorization", "JWT " + this.jwtString);
         }
+
+        if (this.oauthToken == null && this.jwt == null) {
+            requestBuilder.addHeader("Client-Id", clientId);
+        }
         if (this.csrfToken != null) {
             requestBuilder.addHeader(CSRF_TOKEN_HEADER, this.csrfToken);
         }

src/test/java/com/mixer/api/test/unit/api/MixerAPITest.java

@@ -11,7 +11,7 @@
 public class MixerAPITest {
     @Test
     public void itConstructsWithoutParameters() {
-        MixerAPI mixer = new MixerAPI();
+        MixerAPI mixer = new MixerAPI("clientId");
 
         Assert.assertEquals(mixer.basePath, URI.create("https://mixer.com/api/v1/"));
         Assert.assertNotNull(mixer.gson);
@@ -22,14 +22,14 @@ public void itConstructsWithoutParameters() {
     @Test
     public void itConstructsWithParameters() {
         URI basePath = URI.create("https://localhost:1337/api/v1/");
-        MixerAPI mixer = new MixerAPI(basePath, "oauthToken");
+        MixerAPI mixer = new MixerAPI("clientId", basePath, "oauthToken");
 
         Assert.assertEquals(mixer.basePath, basePath);
     }
 
     @Test public void itDelegatesToTheServiceManager() {
         AbstractMixerService service = Mockito.mock(AbstractMixerService.class);
-        MixerAPI mixer = new MixerAPI();
+        MixerAPI mixer = new MixerAPI("clientId");
 
         mixer.register(service);
 

src/test/java/com/mixer/api/test/unit/http/MixerHttpClientTest.java

@@ -44,14 +44,14 @@ public void setup() {
 
     @Test
     public void itHandlesCSRF() {
-        mixerAPI = new MixerAPI();
+        mixerAPI = new MixerAPI("clientId");
         defaultHttpClient = mock(HttpClient.class);
 
         // This is done because Mockito is not able to mock methods that are called within the class'
         // Constructor.
         class MockableMixerHttpClient extends MixerHttpClient {
             private MockableMixerHttpClient(MixerAPI mixer) {
-                super(mixer);
+                super(mixer, "clientId");
             }
 
             @Override
@@ -105,7 +105,7 @@ private HttpResponse prepareResponse(int expectedResponseStatus, String expected
 
     @Test
     public void itHandlesJWT() {
-        mixerAPI = new MixerAPI();
+        mixerAPI = new MixerAPI("clientId");
         defaultHttpClient = mock(HttpClient.class);
 
         final String jwtString = "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOjU3NDk5NSwiYnR5cCI6ImdyYW50IiwiZ3JvdXBzIjpbeyJpZCI6MSwibmFtZSI6IlVzZXIiLCJVc2VyR3JvdXAiOnsiZ3JvdXBJZCI6MSwidXNlcklkIjo1NzQ5OTV9fV0sImlhdCI6MTQ4MTE0NDQ0NywiZXhwIjoxNTEyNjgwNDQ3LCJpc3MiOiJCZWFtIiwianRpIjoiVGhpcyBpc24ndCBhIHJlYWwgc2Vzc2lvbi4ifQ==.HkL5xq-eivwCk5OgczgIu5s_NFFxdQAKH9Jfb906aT4";
@@ -127,7 +127,7 @@ public void itHandlesJWT() {
         // Constructor.
         class MockableMixerHttpClient extends MixerHttpClient {
             private MockableMixerHttpClient(MixerAPI mixer) {
-                super(mixer);
+                super(mixer, "clientId");
             }
 
             @Override

src/test/java/com/mixer/api/test/unit/services/AbstractHTTPServiceTest.java

@@ -9,7 +9,7 @@
 
 public class AbstractHTTPServiceTest {
     @Test public void itFormatsRelativePathNames() {
-        MixerAPI mixer = new MixerAPI(URI.create("http://localhost:1337/api/v1/"), "oauthToken");
+        MixerAPI mixer = new MixerAPI("clientId", URI.create("http://localhost:1337/api/v1/"), "oauthToken");
         AbstractHTTPService httpService = new SimpleHTTPService(mixer, "foo");
 
         String path = httpService.path("bar");
@@ -18,7 +18,7 @@ public class AbstractHTTPServiceTest {
     }
 
     @Test public void itRelativizesAbsolutePaths() {
-        MixerAPI mixer = new MixerAPI(URI.create("http://localhost:1337/api/v1/"), "oauthToken");
+        MixerAPI mixer = new MixerAPI("clientId", URI.create("http://localhost:1337/api/v1/"), "oauthToken");
         AbstractHTTPService httpService = new SimpleHTTPService(mixer, "foo");
 
         String path = httpService.path("/bar");