Fixed protocol breach with message format; removed Clojars dependency.

Also cleaned up some remnants of the merge in the example client.

Author: forresthopkinsa

README.md

@@ -32,7 +32,7 @@ You can use this library two ways:
 - Using the new Native Java 8 support
   - As of this writing, you must be using Android Studio Beta to use this feature.
   - Has been tested in the following environments:
-    - Beta 1-9, Gradle plugin v3.0.0-beta(1-9)
+    - Beta 1-6, Gradle plugin v3.0.0-beta(1-6)
     - Canary 8-9, Gradle plugin v3.0.0-alpha(8-9)
   - It *should* work in all 3.0.0+ versions
   - You can find more info on the [Releases Page](https://github.com/forresthopkinsa/StompProtocolAndroid/releases)
@@ -267,6 +267,10 @@ These are the possible changes you need to make to your code for this branch, if
 - Rudimentary heartbeat mechanism
   - You can use `StompClient.setHeartbeat(ms interval)` to send a heartbeat header to the server
   - WIP; currently we don't deal with those heartbeats in any way other than printing them to console
+- Better adherence to STOMP spec
+  - According to the [spec](http://stomp.github.io/stomp-specification-1.2.html#STOMP_Frames), the end of the message body should be immediately followed by a NULL octet, marking the end of the frame.
+  - Before, we were adding an extra two newlines between the body and NULL octet, which was breaking compatibility with picky servers.
+  - This shouldn't make any difference, but if it does, you can revert to legacy formatting with `client.setLegacyWhitespace(true)`.
 
 ## Additional Reading
 

build.gradle

@@ -20,7 +20,6 @@ allprojects {
     repositories {
         jcenter()
         maven { url "https://jitpack.io" }
-        maven { url "http://clojars.org/repo" }
     }
 }
 

example-client/build.gradle

@@ -28,7 +28,7 @@ dependencies {
     compile fileTree(dir: 'libs', include: ['*.jar'])
     testCompile 'junit:junit:4.12'
     compile 'com.android.support:appcompat-v7:25.2.0'
-    compile 'org.java-websocket:java-websocket:1.3.2'
+    compile 'org.java-websocket:Java-WebSocket:1.3.4'
     compile 'com.android.support:recyclerview-v7:25.2.0'
     compile 'io.reactivex:rxandroid:1.2.1'
     compile 'com.squareup.retrofit2:converter-gson:2.3.0'

example-client/src/main/java/ua/naiksoftware/stompclientexample/ExampleRepository.java

@@ -1,14 +1,14 @@
 package ua.naiksoftware.stompclientexample;
 
-import io.reactivex.Flowable;
 import retrofit2.http.POST;
 import retrofit2.http.Query;
+import rx.Observable;
 
 /**
  * Created by Naik on 24.02.17.
  */
 public interface ExampleRepository {
 
     @POST("hello-convert-and-send")
-    Flowable<Void> sendRestEcho(@Query("msg") String message);
+    Observable<Void> sendRestEcho(@Query("msg") String message);
 }

example-client/src/main/java/ua/naiksoftware/stompclientexample/RestClient.java

@@ -1,7 +1,7 @@
 package ua.naiksoftware.stompclientexample;
 
 import retrofit2.Retrofit;
-import retrofit2.adapter.rxjava2.RxJava2CallAdapterFactory;
+import retrofit2.adapter.rxjava.RxJavaCallAdapterFactory;
 import retrofit2.converter.gson.GsonConverterFactory;
 
 /**
@@ -33,7 +33,7 @@ public static RestClient getInstance() {
     private RestClient() {
         Retrofit retrofit = new Retrofit.Builder().baseUrl("http://" + ANDROID_EMULATOR_LOCALHOST + ":" + SERVER_PORT + "/")
                 .addConverterFactory(GsonConverterFactory.create())
-                .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
+                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                 .build();
         mExampleRepository = retrofit.create(ExampleRepository.class);
     }

lib/build.gradle

@@ -35,7 +35,7 @@ dependencies {
     compile 'net.sourceforge.streamsupport:streamsupport:1.5.5'
     compile 'net.sourceforge.streamsupport:streamsupport-cfuture:1.5.5'
     // Supported transports
-    compile 'org.java-websocket:java-websocket:1.3.2'
+    compile 'org.java-websocket:Java-WebSocket:1.3.4'
     compile 'com.squareup.okhttp3:okhttp:3.8.1'
     implementation 'com.android.support:support-annotations:24.2.0'
 }

lib/src/main/java/ua/naiksoftware/stomp/client/StompClient.java

@@ -36,6 +36,7 @@ public class StompClient {
     private ConcurrentHashMap<String, String> mTopics;
     private boolean mConnected;
     private boolean isConnecting;
+    private boolean legacyWhitespace;
 
     private PublishSubject<StompMessage> mMessageStream;
     private CompletableFuture<Boolean> mConnectionFuture;
@@ -115,7 +116,7 @@ public void connect(@Nullable List<StompHeader> _headers) {
                             headers.add(new StompHeader(StompHeader.VERSION, SUPPORTED_VERSIONS));
                             headers.add(new StompHeader(StompHeader.HEART_BEAT, "0," + heartbeat));
                             if (_headers != null) headers.addAll(_headers);
-                            mConnectionProvider.send(new StompMessage(StompCommand.CONNECT, headers, null).compile())
+                            mConnectionProvider.send(new StompMessage(StompCommand.CONNECT, headers, null).compile(legacyWhitespace))
                                     .subscribe();
                             break;
 
@@ -163,7 +164,7 @@ public Completable send(String destination, String data) {
     }
 
     public Completable send(@NonNull StompMessage stompMessage) {
-        Completable completable = mConnectionProvider.send(stompMessage.compile());
+        Completable completable = mConnectionProvider.send(stompMessage.compile(legacyWhitespace));
         return completable.startWith(mConnectionComplete);
     }
 
@@ -199,6 +200,21 @@ else if (!mStreamMap.containsKey(destPath))
         return mStreamMap.get(destPath);
     }
 
+    /**
+     * Reverts to the old frame formatting, which included two newlines between the message body
+     * and the end-of-frame marker.
+     * <p>
+     * Before: Body\n\n^@
+     * <p>
+     * After: Body^@
+     *
+     * @param legacyWhitespace whether to append an extra two newlines
+     * @see <a href="http://stomp.github.io/stomp-specification-1.2.html#STOMP_Frames">The STOMP spec</a>
+     */
+    public void setLegacyWhitespace(boolean legacyWhitespace) {
+        this.legacyWhitespace = legacyWhitespace;
+    }
+
     private boolean matches(String path, StompMessage msg) {
         String dest = msg.findHeader(StompHeader.DESTINATION);
         if (dest == null) return false;

lib/src/main/java/ua/naiksoftware/stomp/client/StompMessage.java

@@ -54,14 +54,20 @@ public String findHeader(String key) {
 
     @NonNull
     public String compile() {
+        return compile(false);
+    }
+
+    @NonNull
+    public String compile(boolean legacyWhitespace) {
         StringBuilder builder = new StringBuilder();
         builder.append(mStompCommand).append('\n');
         for (StompHeader header : mStompHeaders) {
             builder.append(header.getKey()).append(':').append(header.getValue()).append('\n');
         }
         builder.append('\n');
         if (mPayload != null) {
-            builder.append(mPayload).append("\n\n");
+            builder.append(mPayload);
+            if (legacyWhitespace) builder.append("\n\n");
         }
         builder.append(TERMINATE_MESSAGE_SYMBOL);
         return builder.toString();