Merge pull request #17 from TinaTiel/topic-replace-sout-with-logging

Topic replace sout with logging (#7)

Author: Laraakaa

.gitignore

@@ -0,0 +1,24 @@
+# Filesystem Stuff
+**.DS_Store
+
+# Maven output directory
+**/target
+
+### Maven Plugins ###
+.flattened-pom.xml
+
+### Intellij ###
+**/.idea
+**/*.iml
+
+### react ###
+.DS_*
+*.log
+**logs
+**/*.backup.*
+**/*.back.*
+
+**node_modules
+**bower_components
+
+*.sublime*

README.md

@@ -31,7 +31,7 @@ If you don't want your program to wait for a connection you could alternatively
 ```java
 controller.registerConnectCallback(response -> {
 	GetVersionResponse version = (GetVersionResponse) response;
-	System.out.println(version.getObsStudioVersion());
+	log.debug(version.getObsStudioVersion());
 
 	// Other requests...
 });
@@ -47,7 +47,7 @@ OBSRemoteController controller = new OBSRemoteController("ws://localhost:4444",
 Catch any authentication errors by registering a callback for this:
 ```java
 controller.registerConnectionFailedCallback(message -> {
-    System.err.println("Failed to connect: " + message);
+    log.error("Failed to connect: " + message);
 })
 ```
 
@@ -66,6 +66,36 @@ A description of every request and event can be found in the plugin's [**Protoco
 Examples can be found [**here**](src/test/java/net/twasi/obsremotejava/test/OBSRemoteControllerTest.java). Just uncomment the requests you want to test or copy.
 
 ---
+
+## Logging
+This project ships with SLF4J, and uses the SLF4J-Simple binding by default so logs are printed directly to the console. 
+
+If you wish to override this, for example with Logback, you must exclude SLF4J in your POM and add the dependency to the
+binding you want (depends on the vendor)
+```
+<dependencies>
+    <dependency>
+        <groupId>net.twasi</groupId>
+        <artifactId>obs-websocket-java</artifactId>
+        <version>1.0.6-tinatiel-1-0-0</version>
+        <!-- Exclude the default logging implementation -->
+        <exclusions>
+            <exclusion>
+                <groupId>org.slf4j</groupId>
+                <artifactId>slf4j-simple</artifactId>
+            </exclusion>
+        </exclusions>
+    </dependency>
+    
+    <!-- Add your desired logging implementation -->
+    <dependency>
+        <groupId>ch.qos.logback</groupId>
+        <artifactId>logback-classic</artifactId>
+        <version>1.1.7</version>
+    </dependency>
+</dependencies>
+```
+
 ## Contribution
 
 If you miss an endpoint feel free to make a pull request. Any help is appreciated.

pom.xml

@@ -6,7 +6,7 @@
     <name>obs-websocket-java</name>
     <groupId>net.twasi</groupId>
     <artifactId>obs-websocket-java</artifactId>
-    <version>1.0.6-snapshot</version>
+    <version>1.0.7</version>
 
     <description>Library to connect to the OBS WebSocket interface.</description>
     <url>https://github.com/Twasi/obs-websocket-java</url>
@@ -36,14 +36,37 @@
         <tag>HEAD</tag>
     </scm>
 
+    <properties>
+        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <java.version>8</java.version>
+        <slf4j.version>1.7.30</slf4j.version>
+        <junit.version>5.0.0</junit.version>
+    </properties>
     <build>
         <plugins>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-surefire-plugin</artifactId>
+                <version>2.22.2</version>
+                <configuration>
+                    <excludes>
+
+                        <exclude>**/*IT.java</exclude>
+                    </excludes>
+                </configuration>
+            </plugin>
+            <plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-failsafe-plugin</artifactId>
+                <version>2.22.2</version>
+            </plugin>
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-compiler-plugin</artifactId>
+                <version>3.8.1</version>
                 <configuration>
-                    <source>8</source>
-                    <target>8</target>
+                    <source>${java.version}</source>
+                    <target>${java.version}</target>
                 </configuration>
             </plugin>
             <plugin>
@@ -164,21 +187,50 @@
     </distributionManagement>
 
     <dependencies>
+        <!-- Bot dependencies -->
         <dependency>
             <groupId>org.eclipse.jetty.websocket</groupId>
             <artifactId>websocket-client</artifactId>
             <version>9.4.8.v20171121</version>
         </dependency>
+        <dependency>
+            <groupId>com.google.code.gson</groupId>
+            <artifactId>gson</artifactId>
+            <version>2.8.2</version>
+        </dependency>
+
+        <!-- Logging dependencies -->
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-api</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+        <dependency>
+            <groupId>org.slf4j</groupId>
+            <artifactId>slf4j-simple</artifactId>
+            <version>${slf4j.version}</version>
+        </dependency>
+
+        <!-- Test dependencies -->
         <dependency>
             <groupId>org.junit.jupiter</groupId>
             <artifactId>junit-jupiter-api</artifactId>
-            <version>5.0.0</version>
+            <version>${junit.version}</version>
+            <scope>test</scope>
         </dependency>
         <dependency>
-            <groupId>com.google.code.gson</groupId>
-            <artifactId>gson</artifactId>
-            <version>2.8.2</version>
+            <groupId>org.junit.jupiter</groupId>
+            <artifactId>junit-jupiter-engine</artifactId>
+            <version>${junit.version}</version>
+            <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.assertj</groupId>
+            <artifactId>assertj-core</artifactId>
+            <version>3.18.1</version>
+            <scope>test</scope>
+        </dependency>
+
     </dependencies>
 
 </project>