command client reader/writer

.travis.yml

@@ -0,0 +1,12 @@
+language:
+ - java
+dist:
+ - trusty
+jdk:
+ - oraclejdk8
+install:
+  - mvn test-compile -DskipTests=true -Dmaven.javadoc.skip=true -B -V
+script:
+  - mvn verify jacoco:report
+after_success:
+  - mvn coveralls:report

LICENSE

@@ -0,0 +1,13 @@
+Copyright 2017 Adam Zimowski (mrazjava)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

docs/readme.md

@@ -0,0 +1,2 @@
+Miscellaneous docs for improved documentation. For example, contains images 
+which can be linked from the master readme.

moo-api/pom.xml

@@ -3,10 +3,10 @@
   <parent>
     <groupId>pl.zimowski</groupId>
     <artifactId>moo</artifactId>
-    <version>1.1.0-FINAL</version>
+    <version>1.2.0-SNAPSHOT</version>
   </parent>
   <artifactId>moo-api</artifactId>
-  <name>Moo (api)</name>
+  <name>Moo API</name>
   <description>Common data structures, contracts and utilities used for communication by server and client.</description>
 
   <dependencies>
@@ -15,14 +15,8 @@
       <artifactId>commons-io</artifactId>
     </dependency>
     <dependency>
-      <groupId>org.mockito</groupId>
-      <artifactId>mockito-core</artifactId>
-      <scope>test</scope>
-    </dependency>
-    <dependency>
-      <groupId>org.hamcrest</groupId>
-      <artifactId>hamcrest-integration</artifactId>
-      <scope>test</scope>
+    	<groupId>com.github.stefanbirkner</groupId>
+    	<artifactId>system-rules</artifactId>
     </dependency>
   </dependencies>
 

moo-api/readme.md

@@ -1,2 +1,9 @@
-# Moo - common API shared by client and server
-=====================
+# Moo - Chat API
+---------------------
+Common API shared by UI, client and server. Because UI is bound to an 
+API, and client powers UI at runtime, it is easy to build any new UI 
+client by simply implementing this API.
+
+A UI application essentially must inject implementation of `ClientHandling` 
+(which is provided by client runtime), and register `ClientListener` which 
+will process chat events.

moo-api/src/main/java/pl/zimowski/moo/api/ClientAction.java

@@ -13,6 +13,11 @@ public enum ClientAction {
      * After this operation user is ready to chat.
      */
     Signin,
+
+    /**
+     * Client would like server to randomly generate user nick name.
+     */
+    GenerateNick,
 
     /**
      * Client emitted a chat message to a server on behalf of end user.

moo-api/src/main/java/pl/zimowski/moo/api/ClientHandling.java

@@ -0,0 +1,16 @@
+package pl.zimowski.moo.api;
+
+/**
+ * @since 1.2.0
+ * @author Adam Zimowski (<a href="mailto:mrazjava@yandex.com">mrazjava</a>)
+ */
+public interface ClientHandling {
+
+	boolean connect(ClientListener listener);
+
+	boolean isConnected();
+
+	void disconnect();
+
+	void send(ClientEvent event);
+}

moo-api/src/main/java/pl/zimowski/moo/api/ClientListener.java

@@ -0,0 +1,10 @@
+package pl.zimowski.moo.api;
+
+public interface ClientListener {
+
+	void onEvent(ServerEvent event);
+
+	void onBeforeServerConnect(String host, int port);
+
+	void onConnectToServerError(String error);
+}

moo-api/src/main/java/pl/zimowski/moo/api/ServerAction.java

@@ -8,9 +8,24 @@
  */
 public enum ServerAction {
 
+    /**
+     * Upon client request to establish connection with the server, server confirmed 
+     * successful connection. Broadcast only to the thread that established 
+     * connection.
+     */
     ConnectionEstablished,
 
+    /**
+     * Upon client request to generate a random nick name, server generated 
+     * the nick name. Broadcast only to thread that generated {@link ClientAction#GenerateNick}.
+     */
     NickGenerated,
+
+    /**
+     * Confirmation of a successful user sign in. Broadcast only to thread that 
+     * generated {@link ClientAction#Signin}.
+     */
+    SigninConfirmed,
 
     /**
      * report count of online users due to change to client collection (login,
@@ -22,9 +37,19 @@ public enum ServerAction {
      * server aborted client connection due to inactivity
      */
     ConnectionTimeOut,
+
+    /**
+     * Client voluntarily chose to disconnect.
+     */
+    ClientDisconnected,
 
     /**
      * chat message from another user
      */
-    Message
+    Message,
+
+    /**
+     * Server process terminated and all client connections were aborted
+     */
+    ServerExit
 }

moo-api/src/main/java/pl/zimowski/moo/api/ServerEvent.java

@@ -11,6 +11,11 @@
  */
 public class ServerEvent implements Serializable {
 
+	/**
+	 * Name reported for messages authored by the server.
+	 */
+	public static final String AUTHOR = "server";
+
     private static final long serialVersionUID = -6175363790070655216L;
 
     private long timestamp;
@@ -21,7 +26,14 @@ public class ServerEvent implements Serializable {
 
     private String message;
 
-    private String author = ApiUtils.APP_NAME;
+    /**
+     * Author which caused this event. Not every server event is caused by 
+     * the server. In fact, most events are caused by clients and server 
+     * simply echoes them back by broadcasting equivalent server event. 
+     */
+    private String author = ServerEvent.AUTHOR;
+
+    private String note;
 
     private int participantCount;
 
@@ -46,6 +58,17 @@ public ServerEvent withAuthor(String author) {
         return this;
     }
 
+    /**
+     * Additional data associated with this an event. Often empty.
+     * 
+     * @param note free text that could mean different things depending on the context
+     * @return metadata (note) associated with an event
+     */
+    public ServerEvent withNote(String note) {
+    	this.note = note;
+    	return this;
+    }
+
     public ServerEvent withParticipantCount(int count) {
         participantCount = count;
         return this;
@@ -84,7 +107,15 @@ public String getAuthor() {
         return author;
     }
 
-    /**
+    public String getNote() {
+		return note;
+	}
+
+	public void setNote(String note) {
+		this.note = note;
+	}
+
+	/**
      * @return id of a client which triggered this server event; may be
      *  {@code null} if server itself triggered the event
      */
@@ -95,6 +126,6 @@ public String getClientId() {
     @Override
     public String toString() {
         return "ServerEvent [timestamp=" + timestamp + ", action=" + action + ", clientId=" + clientId + ", author=" + author
-                + ", message=" + message + ", participantCount=" + participantCount + "]";
+                + ", message=" + message + ", note=" + note + ", participantCount=" + participantCount + "]";
     }
 }

moo-api/src/test/java/pl/zimowski/moo/api/ApiUtilsTest.java

@@ -2,7 +2,15 @@
 
 import static org.junit.Assert.assertEquals;
 
+import java.nio.charset.Charset;
+
+import org.junit.Rule;
 import org.junit.Test;
+import org.junit.contrib.java.lang.system.SystemOutRule;
+import org.junit.runners.model.Statement;
+import org.mockito.Mock;
+import org.mockito.junit.MockitoJUnit;
+import org.mockito.junit.MockitoRule;
 
 /**
  * Ensures that {@link ApiUtils} operates as expected.
@@ -12,6 +20,13 @@
  */
 public class ApiUtilsTest {
 
+    @Rule
+    public MockitoRule mockito = MockitoJUnit.rule();
+
+    @Mock
+    private Charset charset;
+
+
     @Test
     public void shouldFetchResource() {
 
@@ -20,4 +35,23 @@ public void shouldFetchResource() {
 
         assertEquals(expectedContent, fetchedContent);
     }
-}
+
+    @Test
+    public void shouldNotFetchResource() {
+
+        ApiUtils.fetchResource("/blah-blah");
+    }
+
+    @Test
+    public void shouldPrintPrompt() {
+
+        SystemOutRule  systemOutMock = new SystemOutRule().mute().enableLog();
+        systemOutMock.apply(new Statement() {
+            @Override
+            public void evaluate() throws Throwable {
+                ApiUtils.printPrompt();
+                assertEquals("> ", systemOutMock.getLog());
+            }
+        }, null);
+    }
+}

moo-api/src/test/java/pl/zimowski/moo/api/ClientEventTest.java

@@ -21,8 +21,10 @@ public void shouldProduceEventVia1ArgConstructor() {
 
         assertTrue(event.getTimestamp() > 0);
         assertEquals(ClientAction.Signin, event.getAction());
+        assertEquals(ClientAction.Signin, ClientAction.valueOf("Signin"));
         assertNull(event.getAuthor());
         assertNull(event.getMessage());
+        assertNull(event.getId());
 
         event.withAuthor("foo").withMessage("bar");