Release v4.26.0

.pubnub.yml

@@ -1,10 +1,17 @@
 name: java
-version: 4.25.0
+version: 4.26.0
 schema: 1
 scm: github.com/pubnub/java
 files:
-  - build/libs/pubnub-gson-4.25.0-all.jar
+  - build/libs/pubnub-gson-4.26.0-all.jar
 changelog:
+  - version: v4.26.0
+    date: 2019-08-09
+    changes:
+      - type: feature
+        text: Add Signals support
+      - type: bugfix
+        text: Expose OkHttp logging interceptor library
   - version: v4.25.0
     date: 2019-06-06
     changes:
@@ -407,26 +414,32 @@ features:
     - SUBSCRIBE-WILDCARD
     - SUBSCRIBE-FILTER-EXPRESSION
     - SUBSCRIBE-PUBLISHER-UUID
+    - SUBSCRIBE-SIGNAL-LISTENER
+  signal:
+    - SIGNAL-SEND
 supported-platforms:
   - version: PubNub Java SDK
     platforms:
-      - Windows 10 (7u85 and above)
+      - Windows 10 (8u51 and above)
       - Windows 8.x (Desktop)
       - Windows 7 SP1
       - Windows Vista SP2
-      - Windows Server 2008 SP2 and 2008 R2 SP1 (64-bit)
-      - Windows Server 2012 (64-bit) and 2012 R2 (64-bit)
-      - Intel-based Mac running Mac OS X 10.7.3 (Lion) or later.
+      - Windows Server 2008 R2 SP1 (64-bit)
+      - Windows Server 2012 and 2012 R2 (64-bit)
+      - Intel-based Mac running Mac OS X 10.8.3+, 10.9+
       - Oracle Linux 5.5+
-      - Oracle Linux 6.x (32-bit), 6.x (64-bit)3
-      - Oracle Linux 7.x (64-bit)3 (7u67 and above)
-      - Red Hat Enterprise Linux 5.5+, 6.x (32-bit), 6.x (64-bit)3
-      - Red Hat Enterprise Linux 7.x (64-bit)3 (7u67 and above)
-      - Suse Linux Enterprise Server 10 SP2, 11.x
-      - Suse Linux Enterprise Server 12.x (7u75 and above)
-      - Ubuntu Linux 10.04 and above
+      - Oracle Linux 6.x
+      - Oracle Linux 7.x (64-bit) (8u20 and above)
+      - Red Hat Enterprise Linux 5.5+, 6.x
+      - Red Hat Enterprise Linux 7.x (64-bit) (8u20 and above)
+      - Suse Linux Enterprise Server 10 SP2+, 11.x
+      - Suse Linux Enterprise Server 12.x (64-bit) (8u31 and above)
+      - Ubuntu Linux 12.04 LTS, 13.x
+      - Ubuntu Linux 14.x (8u25 and above)
+      - Ubuntu Linux 15.04 (8u45 and above)
+      - Ubuntu Linux 15.10 (8u65 and above)
     editors:
-      - Java7+
+      - Java8+
   - version: PubNub Android SDK
     platforms:
       - Android 2.3.1+

build.gradle

@@ -11,7 +11,7 @@ plugins {
 }
 group = 'com.pubnub'
 
-version = '4.25.0'
+version = '4.26.0'
 
 description = """"""
 
@@ -32,7 +32,7 @@ repositories {
 
 dependencies {
     implementation group: 'com.squareup.retrofit2', name: 'retrofit', version: '2.5.0'
-    implementation group: 'com.squareup.okhttp3', name: 'logging-interceptor', version: '3.12.1'
+    api group: 'com.squareup.okhttp3', name: 'logging-interceptor', version: '3.12.1'
 
     implementation group: 'org.slf4j', name: 'slf4j-api', version: '1.7.25'
 

src/main/java/com/pubnub/api/PubNub.java

@@ -22,6 +22,7 @@
 import com.pubnub.api.endpoints.presence.SetState;
 import com.pubnub.api.endpoints.presence.WhereNow;
 import com.pubnub.api.endpoints.pubsub.Publish;
+import com.pubnub.api.endpoints.pubsub.Signal;
 import com.pubnub.api.endpoints.push.AddChannelsToPush;
 import com.pubnub.api.endpoints.push.ListPushProvisions;
 import com.pubnub.api.endpoints.push.RemoveAllPushChannelsForDevice;
@@ -63,7 +64,7 @@ public class PubNub {
     private static final int TIMESTAMP_DIVIDER = 1000;
     private static final int MAX_SEQUENCE = 65535;
 
-    private static final String SDK_VERSION = "4.25.0";
+    private static final String SDK_VERSION = "4.26.0";
 
     public PubNub(PNConfiguration initialConfig) {
         this.configuration = initialConfig;
@@ -170,6 +171,10 @@ public Publish publish() {
         return new Publish(this, publishSequenceManager, this.telemetryManager, this.retrofitManager);
     }
 
+    public Signal signal() {
+        return new Signal(this, this.telemetryManager, this.retrofitManager);
+    }
+
     public ListAllChannelGroup listAllChannelGroups() {
         return new ListAllChannelGroup(this, this.telemetryManager, this.retrofitManager);
     }

src/main/java/com/pubnub/api/callbacks/SubscribeCallback.java

@@ -11,4 +11,6 @@ public abstract class SubscribeCallback {
     public abstract void message(PubNub pubnub, PNMessageResult message);
 
     public abstract void presence(PubNub pubnub, PNPresenceEventResult presence);
+
+    public abstract void signal(PubNub pubnub, PNMessageResult signal);
 }

src/main/java/com/pubnub/api/endpoints/pubsub/Signal.java

@@ -0,0 +1,101 @@
+package com.pubnub.api.endpoints.pubsub;
+
+import com.pubnub.api.PubNub;
+import com.pubnub.api.PubNubException;
+import com.pubnub.api.PubNubUtil;
+import com.pubnub.api.builder.PubNubErrorBuilder;
+import com.pubnub.api.endpoints.Endpoint;
+import com.pubnub.api.enums.PNOperationType;
+import com.pubnub.api.managers.MapperManager;
+import com.pubnub.api.managers.RetrofitManager;
+import com.pubnub.api.managers.TelemetryManager;
+import com.pubnub.api.models.consumer.PNPublishResult;
+import lombok.Setter;
+import lombok.experimental.Accessors;
+import retrofit2.Call;
+import retrofit2.Response;
+
+import java.util.Collections;
+import java.util.List;
+import java.util.Map;
+
+@Accessors(chain = true, fluent = true)
+public class Signal extends Endpoint<List<Object>, PNPublishResult> {
+
+    @Setter
+    private Object message;
+
+    @Setter
+    private String channel;
+
+    public Signal(PubNub pubnub, TelemetryManager telemetryManager, RetrofitManager retrofit) {
+        super(pubnub, telemetryManager, retrofit);
+    }
+
+    @Override
+    protected List<String> getAffectedChannels() {
+        return Collections.singletonList(channel);
+    }
+
+    @Override
+    protected List<String> getAffectedChannelGroups() {
+        return null;
+    }
+
+    @Override
+    protected void validateParams() throws PubNubException {
+        if (message == null) {
+            throw PubNubException.builder().pubnubError(PubNubErrorBuilder.PNERROBJ_MESSAGE_MISSING).build();
+        }
+        if (channel == null || channel.isEmpty()) {
+            throw PubNubException.builder().pubnubError(PubNubErrorBuilder.PNERROBJ_CHANNEL_MISSING).build();
+        }
+        if (this.getPubnub().getConfiguration().getSubscribeKey() == null || this.getPubnub()
+                .getConfiguration()
+                .getSubscribeKey()
+                .isEmpty()) {
+            throw PubNubException.builder().pubnubError(PubNubErrorBuilder.PNERROBJ_SUBSCRIBE_KEY_MISSING).build();
+        }
+        if (this.getPubnub().getConfiguration().getPublishKey() == null || this.getPubnub()
+                .getConfiguration()
+                .getPublishKey()
+                .isEmpty()) {
+            throw PubNubException.builder().pubnubError(PubNubErrorBuilder.PNERROBJ_PUBLISH_KEY_MISSING).build();
+        }
+    }
+
+    @Override
+    protected Call<List<Object>> doWork(Map<String, String> params) throws PubNubException {
+        MapperManager mapper = this.getPubnub().getMapper();
+
+        String stringifiedMessage = mapper.toJson(message);
+
+        params.putAll(encodeParams(params));
+
+        stringifiedMessage = PubNubUtil.urlEncode(stringifiedMessage);
+
+        return this.getRetrofit().getSignalService().signal(this.getPubnub().getConfiguration().getPublishKey(),
+                this.getPubnub().getConfiguration().getSubscribeKey(),
+                channel, stringifiedMessage, params);
+
+    }
+
+    @Override
+    protected PNPublishResult createResponse(Response<List<Object>> input) throws PubNubException {
+        PNPublishResult.PNPublishResultBuilder pnPublishResult = PNPublishResult.builder();
+        pnPublishResult.timetoken(Long.valueOf(input.body().get(2).toString()));
+
+        return pnPublishResult.build();
+    }
+
+    @Override
+    protected PNOperationType getOperationType() {
+        return PNOperationType.PNSignalOperation;
+    }
+
+    @Override
+    protected boolean isAuthRequired() {
+        return true;
+    }
+
+}

src/main/java/com/pubnub/api/enums/PNOperationType.java

@@ -8,6 +8,7 @@ public enum PNOperationType {
     PNUnsubscribeOperation,
 
     PNPublishOperation,
+    PNSignalOperation,
 
     PNHistoryOperation,
     PNFetchMessagesOperation,

src/main/java/com/pubnub/api/managers/ListenerManager.java

@@ -50,9 +50,13 @@ public void announce(PNStatus status) {
         }
     }
 
-    public void announce(PNMessageResult message) {
+    public void announce(PNMessageResult message, Integer type) {
         for (SubscribeCallback subscribeCallback : getListeners()) {
-            subscribeCallback.message(this.pubnub, message);
+            if (type == null) {
+                subscribeCallback.message(this.pubnub, message);
+            } else if (type == 1) {
+                subscribeCallback.signal(this.pubnub, message);
+            }
         }
     }
 

src/main/java/com/pubnub/api/managers/RetrofitManager.java

@@ -42,6 +42,9 @@ public class RetrofitManager {
     private PublishService publishService;
     @Getter
     private SubscribeService subscribeService;
+    @Getter
+    private SignalService signalService;
+
 
     @Getter
     private Retrofit transactionInstance;
@@ -76,6 +79,7 @@ public RetrofitManager(PubNub pubNubInstance) {
         this.publishService = transactionInstance.create(PublishService.class);
         this.subscribeService = subscriptionInstance.create(SubscribeService.class);
         this.timeService = transactionInstance.create(TimeService.class);
+        this.signalService = transactionInstance.create(SignalService.class);
 
     }
 

src/main/java/com/pubnub/api/managers/TelemetryManager.java

@@ -143,6 +143,12 @@ private static String endpointNameForOperation(PNOperationType type) {
             case PNAccessManagerGrant:
                 endpoint = "pam";
                 break;
+            case PNMessageCountOperation:
+                endpoint = "mc";
+                break;
+            case PNSignalOperation:
+                endpoint = "sig";
+                break;
             default:
                 endpoint = "time";
                 break;

src/main/java/com/pubnub/api/models/server/SubscribeMessage.java

@@ -49,4 +49,8 @@ public class SubscribeMessage {
 
     //@SerializedName("w")
     //private String waypointList;
+
+    @SerializedName("e")
+    private Integer type;
+
 }

src/main/java/com/pubnub/api/services/SignalService.java

@@ -0,0 +1,20 @@
+package com.pubnub.api.services;
+
+import retrofit2.Call;
+import retrofit2.http.GET;
+import retrofit2.http.Path;
+import retrofit2.http.QueryMap;
+
+import java.util.List;
+import java.util.Map;
+
+public interface SignalService {
+
+    @GET("/signal/{pubKey}/{subKey}/0/{channel}/0/{payload}")
+    Call<List<Object>> signal(@Path("pubKey") String pubKey,
+                              @Path("subKey") String subKey,
+                              @Path("channel") String channel,
+                              @Path(value = "payload", encoded = true) String message,
+                              @QueryMap(encoded = true) Map<String, String> options);
+
+}

src/main/java/com/pubnub/api/workers/SubscribeMessageWorker.java

@@ -193,8 +193,7 @@ private void processIncomingPayload(SubscribeMessage message) {
                     .userMetadata(message.getUserMetadata())
                     .build();
 
-
-            listenerManager.announce(pnMessageResult);
+            listenerManager.announce(pnMessageResult, message.getType());
         }
     }
 

src/test/java/com/pubnub/api/PubNubTest.java

@@ -98,7 +98,7 @@ public void getVersionAndTimeStamp() {
         pubnub = new PubNub(pnConfiguration);
         String version = pubnub.getVersion();
         int timeStamp = pubnub.getTimestamp();
-        Assert.assertEquals("4.25.0", version);
+        Assert.assertEquals("4.26.0", version);
         Assert.assertTrue(timeStamp > 0);
     }