PubNub SDK v4.32.0 release.

Author: client-engineering-bot

.github/CODEOWNERS

@@ -0,0 +1 @@
+*       @kleewho @bartk @budgetpreneur

.pubnub.yml

@@ -1,10 +1,15 @@
 name: java
-version: 4.31.3
+version: 4.32.0
 schema: 1
 scm: github.com/pubnub/java
 files:
-  - build/libs/pubnub-gson-4.31.3-all.jar
+  - build/libs/pubnub-gson-4.32.0-all.jar
 changelog:
+  - version: v4.32.0
+    date: 2020-08-14
+    changes:
+      - type: feature
+        text: "Allows to upload files to channels, download them with optional encryption support."
   - version: v4.31.3
     date: 2020-06-17
     changes:
@@ -537,6 +542,12 @@ features:
     - OBJECTS-REMOVE-MEMBERS
     - OBJECTS-UPDATE-MEMBERS
     - OBJECTS-FILTERING
+  files:
+    - FILES-DELETE-FILE
+    - FILES-DOWNLOAD-FILE
+    - FILES-GET-FILE-URL
+    - FILES-LIST-FILES
+    - FILES-SEND-FILE
   unsubscribe:
     - UNSUBSCRIBE-ALL
     - UNSUBSCRIBE-SUPPRESS-LEAVE-EVENTS

CHANGELOG.md

@@ -1,3 +1,10 @@
+## [v4.32.0](https://github.com/pubnub/java/releases/tag/v4.32.0)
+August-14-2020
+
+[Full Changelog](https://github.com/pubnub/java/compare/v4.31.3...v4.32.0)
+
+- 🌟️ Allows to upload files to channels, download them with optional encryption support. 
+
 ## [v4.31.3](https://github.com/pubnub/java/releases/tag/v4.31.3)
 June-17-2020
 

build.gradle

@@ -11,7 +11,7 @@ plugins {
 }
 group = 'com.pubnub'
 
-version = '4.31.3'
+version = '4.32.0'
 
 description = """"""
 
@@ -57,6 +57,7 @@ dependencies {
     testImplementation group: 'junit', name: 'junit', version: '4.12'
     testImplementation group: 'com.github.tomakehurst', name: 'wiremock', version: '2.25.0'
     testImplementation group: 'org.awaitility', name: 'awaitility', version: '4.0.1'
+    testImplementation group: 'org.mockito', name: 'mockito-core', version: '3.4.0'
     implementation group: 'org.json', name: 'json', version: '20190722'
 }
 

gradle/wrapper/gradle-wrapper.properties

@@ -1,6 +1,5 @@
-#Fri Apr 19 09:14:42 CEST 2019
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
+distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-bin.zip
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-4.10.2-all.zip

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

@@ -17,6 +17,12 @@
 import com.pubnub.api.endpoints.channel_groups.DeleteChannelGroup;
 import com.pubnub.api.endpoints.channel_groups.ListAllChannelGroup;
 import com.pubnub.api.endpoints.channel_groups.RemoveChannelChannelGroup;
+import com.pubnub.api.endpoints.files.DeleteFile;
+import com.pubnub.api.endpoints.files.DownloadFile;
+import com.pubnub.api.endpoints.files.GetFileUrl;
+import com.pubnub.api.endpoints.files.ListFiles;
+import com.pubnub.api.endpoints.files.PublishFileMessage;
+import com.pubnub.api.endpoints.files.SendFile;
 import com.pubnub.api.endpoints.message_actions.AddMessageAction;
 import com.pubnub.api.endpoints.message_actions.GetMessageActions;
 import com.pubnub.api.endpoints.message_actions.RemoveMessageAction;
@@ -54,17 +60,17 @@
 import com.pubnub.api.managers.token_manager.TokenManager;
 import com.pubnub.api.managers.token_manager.TokenManagerProperties;
 import com.pubnub.api.vendor.Crypto;
-
+import com.pubnub.api.vendor.FileEncryptionUtil;
+import lombok.Getter;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.annotations.Nullable;
 
+import java.io.InputStream;
 import java.util.Date;
 import java.util.HashMap;
 import java.util.List;
 import java.util.UUID;
 
-import lombok.Getter;
-
 
 public class PubNub {
 
@@ -91,7 +97,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.31.3";
+    private static final String SDK_VERSION = "4.32.0";
 
     public PubNub(@NotNull PNConfiguration initialConfig) {
         this.configuration = initialConfig;
@@ -341,6 +347,43 @@ public RemoveMessageAction removeMessageAction() {
 
     // End Message Actions API
 
+    @NotNull
+    public SendFile.Builder sendFile() {
+        return SendFile.builder(this, telemetryManager, retrofitManager);
+    }
+
+    public ListFiles.Builder listFiles() {
+        return new ListFiles.Builder(this, telemetryManager, retrofitManager);
+    }
+
+    public GetFileUrl.Builder getFileUrl() {
+        return GetFileUrl.builder(
+                this,
+                telemetryManager,
+                retrofitManager);
+    }
+
+    public DownloadFile.Builder downloadFile() {
+        return DownloadFile.builder(
+                this,
+                telemetryManager,
+                retrofitManager);
+    }
+
+    public DeleteFile.Builder deleteFile() {
+        return DeleteFile.builder(
+                this,
+                telemetryManager,
+                retrofitManager);
+    }
+
+    public PublishFileMessage.Builder publishFileMessage() {
+        return PublishFileMessage.builder(
+                this,
+                telemetryManager,
+                retrofitManager);
+    }
+
     // public methods
 
     /**
@@ -375,6 +418,14 @@ public String decrypt(String inputString, String cipherKey) throws PubNubExcepti
         return new Crypto(cipherKey).decrypt(inputString);
     }
 
+    public InputStream decryptInputStream(InputStream inputStream) throws PubNubException {
+        return decryptInputStream(inputStream, this.getConfiguration().getCipherKey());
+    }
+
+    public InputStream decryptInputStream(InputStream inputStream, String cipherKey) throws PubNubException {
+        return FileEncryptionUtil.decrypt(cipherKey, inputStream);
+    }
+
     /**
      * Perform Cryptographic encryption of an input string and the cipher key provided by PNConfiguration
      *
@@ -407,6 +458,14 @@ public String encrypt(String inputString, String cipherKey) throws PubNubExcepti
         return new Crypto(cipherKey).encrypt(inputString);
     }
 
+    public InputStream encryptInputSteram(InputStream inputStream) throws PubNubException {
+        return encryptInputSteram(inputStream, this.getConfiguration().getCipherKey());
+    }
+
+    public InputStream encryptInputSteram(InputStream inputStream, String cipherKey) throws PubNubException {
+        return FileEncryptionUtil.encrypt(cipherKey, inputStream);
+    }
+
     public int getTimestamp() {
         return (int) ((new Date().getTime()) / TIMESTAMP_DIVIDER);
     }

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

@@ -1,6 +1,5 @@
 package com.pubnub.api;
 
-
 import com.pubnub.api.builder.PubNubErrorBuilder;
 import com.pubnub.api.vendor.Base64;
 import lombok.extern.java.Log;
@@ -16,11 +15,7 @@
 import java.net.URLEncoder;
 import java.security.InvalidKeyException;
 import java.security.NoSuchAlgorithmException;
-import java.util.HashMap;
-import java.util.List;
-import java.util.Map;
-import java.util.Set;
-import java.util.TreeSet;
+import java.util.*;
 
 @Log
 public class PubNubUtil {
@@ -244,5 +239,4 @@ private static String requestBodyToString(final Request request) {
         }
         return "";
     }
-
 }

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

@@ -5,6 +5,7 @@
 import com.pubnub.api.models.consumer.pubsub.PNMessageResult;
 import com.pubnub.api.models.consumer.pubsub.PNPresenceEventResult;
 import com.pubnub.api.models.consumer.pubsub.PNSignalResult;
+import com.pubnub.api.models.consumer.pubsub.files.PNFileEventResult;
 import com.pubnub.api.models.consumer.pubsub.message_actions.PNMessageActionResult;
 import com.pubnub.api.models.consumer.pubsub.objects.PNMembershipResult;
 import com.pubnub.api.models.consumer.pubsub.objects.PNSpaceResult;
@@ -28,4 +29,7 @@ public abstract class SubscribeCallback {
     public abstract void membership(@NotNull PubNub pubnub, @NotNull PNMembershipResult pnMembershipResult);
 
     public abstract void messageAction(@NotNull PubNub pubnub, @NotNull PNMessageActionResult pnMessageActionResult);
+
+    public abstract void file(@NotNull PubNub pubnub, @NotNull PNFileEventResult pnFileEventResult);
+
 }

src/main/java/com/pubnub/api/endpoints/Endpoint.java

@@ -7,6 +7,7 @@
 import com.pubnub.api.PubNubUtil;
 import com.pubnub.api.builder.PubNubErrorBuilder;
 import com.pubnub.api.callbacks.PNCallback;
+import com.pubnub.api.endpoints.remoteaction.RemoteAction;
 import com.pubnub.api.enums.PNOperationType;
 import com.pubnub.api.enums.PNStatusCategory;
 import com.pubnub.api.managers.MapperManager;
@@ -21,6 +22,7 @@
 import org.jetbrains.annotations.Nullable;
 
 import java.io.IOException;
+import java.net.HttpURLConnection;
 import java.net.SocketException;
 import java.net.SocketTimeoutException;
 import java.net.UnknownHostException;
@@ -41,7 +43,7 @@
 import retrofit2.Response;
 
 @Log
-public abstract class Endpoint<Input, Output> {
+public abstract class Endpoint<Input, Output> implements RemoteAction<Output> {
 
     @Getter(AccessLevel.PROTECTED)
     private PubNub pubnub;
@@ -68,10 +70,6 @@ public abstract class Endpoint<Input, Output> {
     @Getter(AccessLevel.NONE)
     private boolean silenceFailures;
 
-    private static final int SERVER_RESPONSE_SUCCESS = 200;
-    private static final int SERVER_RESPONSE_FORBIDDEN = 403;
-    private static final int SERVER_RESPONSE_BAD_REQUEST = 400;
-
     private MapperManager mapper;
 
     public Endpoint(PubNub pubnubInstance, TelemetryManager telemetry, RetrofitManager retrofitInstance) {
@@ -81,6 +79,7 @@ public Endpoint(PubNub pubnubInstance, TelemetryManager telemetry, RetrofitManag
         this.telemetryManager = telemetry;
     }
 
+    @Override
     @Nullable
     public Output sync() throws PubNubException {
         this.validateParams();
@@ -99,7 +98,7 @@ public Output sync() throws PubNubException {
                     .build();
         }
 
-        if (!serverResponse.isSuccessful() || serverResponse.code() != SERVER_RESPONSE_SUCCESS) {
+        if (isError(serverResponse)) {
             String responseBodyText;
             JsonElement responseBody;
 
@@ -130,6 +129,7 @@ public Output sync() throws PubNubException {
         return response;
     }
 
+    @Override
     public void async(@NotNull final PNCallback<Output> callback) {
         cachedCallback = callback;
 
@@ -149,7 +149,7 @@ public void async(@NotNull final PNCallback<Output> callback) {
             public void onResponse(Call<Input> performedCall, Response<Input> response) {
                 Output callbackResponse;
 
-                if (!response.isSuccessful() || response.code() != SERVER_RESPONSE_SUCCESS) {
+                if (isError(response)) {
 
                     String responseBodyText;
                     JsonElement responseBody;
@@ -182,7 +182,7 @@ public void onResponse(Call<Input> performedCall, Response<Input> response) {
                             .statusCode(response.code())
                             .build();
 
-                    if (response.code() == SERVER_RESPONSE_FORBIDDEN) {
+                    if (response.code() == HttpURLConnection.HTTP_FORBIDDEN) {
                         pnStatusCategory = PNStatusCategory.PNAccessDeniedCategory;
 
                         if (responseBodyPayload != null && mapper.hasField(responseBodyPayload, "channels")) {
@@ -207,7 +207,7 @@ public void onResponse(Call<Input> performedCall, Response<Input> response) {
 
                     }
 
-                    if (response.code() == SERVER_RESPONSE_BAD_REQUEST) {
+                    if (response.code() == HttpURLConnection.HTTP_BAD_REQUEST) {
                         pnStatusCategory = PNStatusCategory.PNBadRequestCategory;
                     }
 
@@ -271,6 +271,7 @@ public void onFailure(Call<Input> performedCall, Throwable throwable) {
         });
     }
 
+    @Override
     public void retry() {
         silenceFailures = false;
         async(cachedCallback);
@@ -279,13 +280,18 @@ public void retry() {
     /**
      * cancel the operation but do not alert anybody, useful for restarting the heartbeats and subscribe loops.
      */
+    @Override
     public void silentCancel() {
         if (call != null && !call.isCanceled()) {
             this.silenceFailures = true;
             call.cancel();
         }
     }
 
+    protected boolean isError(Response<Input> response) {
+        return response.code() != HttpURLConnection.HTTP_OK;
+    }
+
     private PNStatus createStatusResponse(PNStatusCategory category, Response<Input> response, Exception throwable,
                                           ArrayList<String> errorChannels, ArrayList<String> errorChannelGroups) {
         PNStatus.PNStatusBuilder pnStatus = PNStatus.builder();

src/main/java/com/pubnub/api/endpoints/FetchMessages.java

@@ -47,6 +47,10 @@ public class FetchMessages extends Endpoint<FetchMessagesEnvelope, PNFetchMessag
     private Boolean includeMeta;
     @Setter
     private Boolean includeMessageActions;
+    @Setter
+    private boolean includeMessageType = true;
+    @Setter
+    private boolean includeUUID = true;
 
     public FetchMessages(PubNub pubnub, TelemetryManager telemetryManager, RetrofitManager retrofit) {
         super(pubnub, telemetryManager, retrofit);
@@ -113,6 +117,8 @@ protected Call<FetchMessagesEnvelope> doWork(Map<String, String> params) throws
         if (includeMeta) {
             params.put("include_meta", String.valueOf(includeMeta));
         }
+        params.put("include_uuid", Boolean.toString(includeUUID));
+        params.put("include_message_type", Boolean.toString(includeMessageType));
 
         if (!includeMessageActions) {
             return this.getRetrofit().getHistoryService().fetchMessages(
@@ -141,19 +147,17 @@ protected PNFetchMessagesResult createResponse(Response<FetchMessagesEnvelope> i
             List<PNFetchMessageItem> items = new ArrayList<>();
 
             for (PNFetchMessageItem item : entry.getValue()) {
-                PNFetchMessageItem.PNFetchMessageItemBuilder messageItemBuilder = PNFetchMessageItem.builder();
-                messageItemBuilder.message(processMessage(item.getMessage()));
-                messageItemBuilder.timetoken(item.getTimetoken());
-                messageItemBuilder.meta(item.getMeta());
+                PNFetchMessageItem.PNFetchMessageItemBuilder messageItemBuilder = item.toBuilder();
 
                 if (includeMessageActions) {
                     if (item.getActions() != null) {
                         messageItemBuilder.actions(item.getActions());
                     } else {
                         messageItemBuilder.actions(new HashMap<>());
                     }
+                } else {
+                    messageItemBuilder.actions(null);
                 }
-
                 items.add(messageItemBuilder.build());
             }