Merge pull request #5 from neptulon/router

Add router/logger/echo middleware packages

Author: soygul

build.gradle

@@ -12,8 +12,8 @@ repositories {
 dependencies {
     compile fileTree(dir: 'libs', include: ['*.jar'])
     compile 'com.google.code.gson:gson:2.5'
-    compile 'com.squareup.okhttp3:okhttp:3.0.0-RC1'
-    compile 'com.squareup.okhttp3:okhttp-ws:3.0.0-RC1'
+    compile 'com.squareup.okhttp3:okhttp:3.0.1'
+    compile 'com.squareup.okhttp3:okhttp-ws:3.0.1'
     testCompile 'junit:junit:4.12'
     testCompile 'org.mockito:mockito-core:1.10.19'
     testCompile 'org.hamcrest:hamcrest-library:1.3'

neptulon-client.iml

@@ -14,15 +14,15 @@
     </content>
     <orderEntry type="inheritedJdk" />
     <orderEntry type="sourceFolder" forTests="false" />
-    <orderEntry type="library" name="Gradle: com.google.code.gson:gson:2.5" level="project" />
-    <orderEntry type="library" name="Gradle: com.squareup.okhttp3:okhttp:3.0.0-RC1" level="project" />
-    <orderEntry type="library" name="Gradle: com.squareup.okhttp3:okhttp-ws:3.0.0-RC1" level="project" />
-    <orderEntry type="library" name="Gradle: com.squareup.okio:okio:1.6.0" level="project" />
-    <orderEntry type="library" scope="TEST" name="Gradle: junit:junit:4.12" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.mockito:mockito-core:1.10.19" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.hamcrest:hamcrest-library:1.3" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.hamcrest:hamcrest-core:1.3" level="project" />
     <orderEntry type="library" scope="TEST" name="Gradle: org.objenesis:objenesis:2.1" level="project" />
+    <orderEntry type="library" name="Gradle: com.google.code.gson:gson:2.5" level="project" />
+    <orderEntry type="library" name="Gradle: com.squareup.okio:okio:1.6.0" level="project" />
+    <orderEntry type="library" scope="TEST" name="Gradle: junit:junit:4.12" level="project" />
+    <orderEntry type="library" name="Gradle: com.squareup.okhttp3:okhttp:3.0.1" level="project" />
+    <orderEntry type="library" name="Gradle: com.squareup.okhttp3:okhttp-ws:3.0.1" level="project" />
   </component>
   <component name="org.twodividedbyzero.idea.findbugs">
     <option name="_basePreferences">

src/main/java/neptulon/client/ConnImpl.java

@@ -30,18 +30,15 @@ public class ConnImpl implements Conn, WebSocketListener {
     private final OkHttpClient client;
     private final Request request;
     private final WebSocketCall wsCall;
-    private final List<Middleware> middleware;
-    private final Map<String, ResHandler> resHandlers;
+    private final List<Middleware> middleware = new ArrayList<>();
+    private final Map<String, ResHandler> resHandlers = new HashMap<>();
     private WebSocket ws;
     private boolean connected;
 
     /**
      * Initializes a new connection with given server URL.
      */
     public ConnImpl(String url) {
-        middleware = new ArrayList<>();
-        resHandlers = new HashMap<>();
-
         client = new OkHttpClient.Builder()
                 .connectTimeout(45, TimeUnit.SECONDS)
                 .writeTimeout(300, TimeUnit.SECONDS)
@@ -63,18 +60,20 @@ public ConnImpl() {
         this("ws://10.0.2.2:3000");
     }
 
-    private void send(Object src) {
+    void send(Object src) {
+        String m =  gson.toJson(src);
+        logger.info("Outgoing message: " + m);
         try {
-            ws.sendMessage(RequestBody.create(WebSocket.TEXT, gson.toJson(src)));
+            ws.sendMessage(RequestBody.create(WebSocket.TEXT, m));
         } catch (IOException e) {
             e.printStackTrace();
             close();
         }
     }
 
-    /*
-     * ######## Conn Implementation ########
-     */
+    /***********************
+     * Conn Implementation *
+     ***********************/
 
     @Override
     public void useTLS(byte[] ca, byte[] clientCert, byte[] clientCertKey) {
@@ -98,14 +97,6 @@ public void middleware(Middleware mw) {
 
     @Override
     public void connect() {
-        // add sender middleware as the last middleware in stack
-        middleware.add(new Middleware() {
-            @Override
-            public void handler(ReqCtx req) {
-                send(req);
-            }
-        });
-
         // enqueue this listener implementation to initiate the WebSocket connection
         wsCall.enqueue(this);
     }
@@ -143,9 +134,9 @@ public void close() {
         }
     }
 
-    /*
-     * ######## WebSocketListener Implementation ########
-     */
+    /************************************
+     * WebSocketListener Implementation *
+     ************************************/
 
     @Override
     public void onOpen(WebSocket webSocket, Response response) {
@@ -172,7 +163,7 @@ public void onMessage(ResponseBody message) throws IOException {
         }
 
         // handle request message
-        new ReqCtx(msg.id, msg.method, msg.params, middleware, gson).next();
+        new ReqCtx(this, msg.id, msg.method, msg.params, middleware, gson).next();
     }
 
     @Override

src/main/java/neptulon/client/Middleware.java

@@ -4,6 +4,6 @@
  * Middleware interface definition.
  */
 public interface Middleware {
-    void handler(ReqCtx req);
+    void handler(ReqCtx ctx);
 }
 

src/main/java/neptulon/client/ReqCtx.java

@@ -4,11 +4,14 @@
 import com.google.gson.JsonElement;
 
 import java.util.List;
+import java.util.logging.Logger;
 
 /**
  * Request context.
  */
 public class ReqCtx {
+    private static final Logger logger = Logger.getLogger(ReqCtx.class.getSimpleName());
+    private final ConnImpl conn;
     private final String id;
     private final String method;
     private final JsonElement params;
@@ -18,14 +21,27 @@ public class ReqCtx {
 
     public Response response;
 
-    public ReqCtx(String id, String method, JsonElement params, List<Middleware> middleware, Gson gson) {
+    public ReqCtx(ConnImpl conn, String id, String method, JsonElement params, List<Middleware> middleware, Gson gson) {
+        this.conn = conn;
         this.id = id;
         this.method = method;
         this.params = params;
         this.middleware = middleware;
         this.gson = gson;
     }
 
+    public Conn getConn() {
+        return conn;
+    }
+
+    public String getID() {
+        return id;
+    }
+
+    public String getMethod() {
+        return method;
+    }
+
     public <T> T getParams(Class<T> classOfT) {
         return gson.fromJson(params, classOfT);
     }
@@ -34,7 +50,15 @@ public void next() {
         mwIndex++;
 
         if (mwIndex <= middleware.size()) {
-            middleware.get(mwIndex-1).handler(this);
+            middleware.get(mwIndex - 1).handler(this);
+            return;
+        }
+
+        if (response != null) {
+            conn.send(response);
+            return;
         }
+
+        logger.warning("No response provided for for request: " + getID() + ": " + getMethod());
     }
 }

src/main/java/neptulon/client/Response.java

@@ -8,7 +8,7 @@ public class Response<T> {
     public final T result;
     public final ResError error;
 
-    Response(String id, T result, ResError error) {
+    public Response(String id, T result, ResError error) {
         this.id = id;
         this.result = result;
         this.error = error;

src/main/java/neptulon/client/middleware/Echo.java

@@ -0,0 +1,16 @@
+package neptulon.client.middleware;
+
+import neptulon.client.Middleware;
+import neptulon.client.ReqCtx;
+import neptulon.client.Response;
+
+/**
+ * Echoes request body as response.
+ */
+public class Echo implements Middleware {
+
+    @Override
+    public void handler(ReqCtx ctx) {
+        ctx.response = new Response<>(ctx.getID(), ctx.getParams(Object.class), null);
+    }
+}

src/main/java/neptulon/client/middleware/Logger.java

@@ -1,7 +1,17 @@
 package neptulon.client.middleware;
 
+import neptulon.client.Middleware;
+import neptulon.client.ReqCtx;
+
 /**
- * Neptulon request/response logger middleware.
+ * Request/response logger middleware.
  */
-public class Logger {
+public class Logger implements Middleware {
+    private static final java.util.logging.Logger logger = java.util.logging.Logger.getLogger(Logger.class.getSimpleName());
+
+    @Override
+    public void handler(ReqCtx ctx) {
+        logger.info(ctx.getParams(Object.class).toString());
+        ctx.next();
+    }
 }

src/main/java/neptulon/client/middleware/Router.java

@@ -1,7 +1,31 @@
 package neptulon.client.middleware;
 
+import neptulon.client.Middleware;
+import neptulon.client.ReqCtx;
+
+import java.util.HashMap;
+import java.util.Map;
+
 /**
- * Neptulon router middleware.
+ * Request router middleware.
  */
-public class Router {
+public class Router implements Middleware {
+    private final Map<String, Middleware> routes = new HashMap<>();
+
+    /**
+     * Adds a new request route registry.
+     */
+    public void request(String route, Middleware mw) {
+        routes.put(route, mw);
+    }
+
+    @Override
+    public void handler(ReqCtx ctx) {
+        Middleware mw = routes.get(ctx.getMethod());
+        if (mw != null) {
+            mw.handler(ctx);
+        }
+
+        ctx.next();
+    }
 }

src/test/java/neptulon/client/NeptulonTest.java

@@ -1,67 +1,75 @@
 package neptulon.client;
 
+import neptulon.client.middleware.Echo;
+import neptulon.client.middleware.Logger;
+import neptulon.client.middleware.Router;
 import org.junit.Test;
 
+import java.util.concurrent.CountDownLatch;
+
 import static org.hamcrest.MatcherAssert.assertThat;
 import static org.hamcrest.core.IsEqual.equalTo;
 
 public class NeptulonTest {
-    public static final String URL = "ws://127.0.0.1:3000";
+    private static final String URL = "ws://127.0.0.1:3001";
 
     @Test
-    public void emailValidator_CorrectEmailSimple_ReturnsTrue() {
-        assertThat("hazelnuts", 3, equalTo(3));
-    }
-
-    @Test
-    public void connect() {
+    public void connect() throws InterruptedException {
         if (isTravis()) {
             return;
         }
 
-        class Test {
-            final String message;
-
-            Test(String message) {
-                this.message = message;
-            }
-        }
-
         Conn conn = new ConnImpl(URL);
         conn.connect();
-
-        try {
-            Thread.sleep(1000);
-        } catch (InterruptedException e) {
-            e.printStackTrace();
-        }
-
+        Thread.sleep(100);
         assertThat("Connection was not established in time.", conn.isConnected());
 
-        // todo: add middleware to log the incoming message here and replace logger inside response handler with verifier
-        // and release v0.1 corresponding to Neptulon v0.1
+        conn.middleware(new Logger());
+        Router router = new Router();
+        router.request("echo", new Echo());
+        conn.middleware(router);
+
+        final CountDownLatch counter = new CountDownLatch(2); // todo: add one more for ws.onClose
 
-        conn.middleware(new Middleware() {
+        conn.sendRequest("echo", new EchoMessage("Hello from Java client!"), new ResHandler<Object>() {
             @Override
-            public void handler(ReqCtx req) {
+            public Class<Object> getType() {
+                return Object.class;
+            }
 
+            @Override
+            public void handler(Response<Object> res) {
+                System.out.println("Received 'echo' response: " + res.result);
+                counter.countDown();
             }
         });
 
-        conn.sendRequest("test", new Test("wow"), new ResHandler<String>() {
+        conn.sendRequest("close", new EchoMessage("Bye from Java client!"), new ResHandler<Object>() {
             @Override
-            public Class<String> getType() {
-                return String.class;
+            public Class<Object> getType() {
+                return Object.class;
             }
 
             @Override
-            public void handler(Response<String> res) {
-                System.out.println("Received response: " + res.result);
+            public void handler(Response<Object> res) {
+                System.out.println("Received 'close' response: " + res.result);
+                counter.countDown();
             }
         });
+
+        counter.await();
+        conn.close();
     }
 
     private boolean isTravis() {
         return System.getenv().containsKey("TRAVIS");
     }
+
+    private class EchoMessage {
+        final String message;
+
+        EchoMessage(String message) {
+            this.message = message;
+        }
+    }
 }