New feature: push validate API

Author: Javen

src/cn/jpush/api/JPushClient.java

@@ -60,6 +60,9 @@ public JPushClient(String masterSecret, String appKey, boolean apnsProduction, l
         _pushClient = new PushClient(masterSecret, appKey, apnsProduction, timeToLive);
         _reportClient = new ReportClient(masterSecret, appKey);
     }
+    
+    
+    // ----------------------------- Push API
 
     /**
      * Send a push with PushPayload object.
@@ -88,6 +91,25 @@ public PushResult sendPush(PushPayload pushPayload) throws APIConnectionExceptio
     public PushResult sendPush(String payloadString) throws APIConnectionException, APIRequestException {
         return _pushClient.sendPush(payloadString);
     }
+    
+    /**
+     * Validate a push action, but do NOT send it actually.
+     * 
+     * @param paylaod
+     * @return
+     * @throws APIConnectionException
+     * @throws APIRequestException
+     */
+    public PushResult sendPushValidate(PushPayload paylaod) throws APIConnectionException, APIRequestException {
+    	return _pushClient.sendPushValidate(paylaod);
+    }
+
+    public PushResult sendPushValidate(String payloadString) throws APIConnectionException, APIRequestException {
+    	return _pushClient.sendPushValidate(payloadString);
+    }
+
+    
+    // ------------------------------- Report API
 
     /**
      * Get received report. 

src/cn/jpush/api/push/PushClient.java

@@ -27,6 +27,7 @@
 public class PushClient {
     public static final String HOST_NAME_SSL = "https://api.jpush.cn";
     public static final String PUSH_PATH = "/v3/push";
+    public static final String PUSH_VALIDATE_PATH = "/v3/push/validate";
 
     private final NativeHttpClient _httpClient;
     private JsonParser _jsonParser = new JsonParser();
@@ -66,7 +67,7 @@ public PushClient(String masterSecret, String appKey, int maxRetryTimes, HttpPro
         ServiceHelper.checkBasic(appKey, masterSecret);
 
         String authCode = ServiceHelper.getBasicAuthorization(appKey, masterSecret);
-        this._baseUrl = HOST_NAME_SSL + PUSH_PATH;
+        this._baseUrl = HOST_NAME_SSL;
         this._httpClient = new NativeHttpClient(authCode, maxRetryTimes, proxy);
 	}
 
@@ -106,7 +107,20 @@ public PushResult sendPush(PushPayload pushPayload) throws APIConnectionExceptio
             pushPayload.resetOptionsApnsProduction(_apnsProduction);
         }
 
-        ResponseWrapper response = _httpClient.sendPost(_baseUrl, pushPayload.toString());
+        ResponseWrapper response = _httpClient.sendPost(_baseUrl + PUSH_PATH, pushPayload.toString());
+        
+        return PushResult.fromResponse(response);
+    }
+    
+    public PushResult sendPushValidate(PushPayload pushPayload) throws APIConnectionException, APIRequestException {
+        Preconditions.checkArgument(! (null == pushPayload), "pushPayload should not be null");
+        
+        if (_globalSettingEnabled) {
+            pushPayload.resetOptionsTimeToLive(_timeToLive);
+            pushPayload.resetOptionsApnsProduction(_apnsProduction);
+        }
+        
+        ResponseWrapper response = _httpClient.sendPost(_baseUrl + PUSH_VALIDATE_PATH, pushPayload.toString());
 
         return PushResult.fromResponse(response);
     }
@@ -120,11 +134,26 @@ public PushResult sendPush(String payloadString) throws APIConnectionException,
             Preconditions.checkArgument(false, "payloadString should be a valid JSON string.");
         }
 
-        ResponseWrapper response = _httpClient.sendPost(_baseUrl, payloadString);
+        ResponseWrapper response = _httpClient.sendPost(_baseUrl + PUSH_PATH, payloadString);
+        
+        return PushResult.fromResponse(response);
+    }
+    
+    public PushResult sendPushValidate(String payloadString) throws APIConnectionException, APIRequestException {
+        Preconditions.checkArgument(StringUtils.isNotEmpty(payloadString), "pushPayload should not be empty");
+        
+        try {
+            _jsonParser.parse(payloadString);
+        } catch (JsonParseException e) {
+            Preconditions.checkArgument(false, "payloadString should be a valid JSON string.");
+        }
+        
+        ResponseWrapper response = _httpClient.sendPost(_baseUrl + PUSH_VALIDATE_PATH, payloadString);
 
         return PushResult.fromResponse(response);
     }
 
+
 }
 
 

test/cn/jpush/api/push/PushClientTest.java

@@ -1,10 +1,14 @@
 package cn.jpush.api.push;
 
+import static org.junit.Assert.assertTrue;
+import static org.junit.Assert.fail;
+
 import org.junit.Test;
 
 import cn.jpush.api.common.APIConnectionException;
 import cn.jpush.api.common.APIRequestException;
 import cn.jpush.api.common.HttpProxy;
+import cn.jpush.api.push.model.PushPayload;
 
 public class PushClientTest {
     private static final String appKey ="dd1066407b044738b6479275";
@@ -34,14 +38,26 @@ public void test_empty_string() {
         } catch (APIRequestException e) {
             e.printStackTrace();
         }
-    }    
+    }
 
     @Test(expected = IllegalArgumentException.class)
     public void test_empty_password() {
         new HttpProxy("127.0.0.1", 8080, "", null);
     }    
 
-    
+    @Test
+    public void test_validate() {
+    	PushClient pushClient = new PushClient(masterSecret, appKey);
+    	
+    	try {
+    		PushResult result = pushClient.sendPushValidate(PushPayload.alertAll("alert"));
+    		assertTrue("", result.isResultOK());
+    	} catch (APIRequestException e) {
+    		fail("Should not fail");
+    	} catch (APIConnectionException e) {
+    		e.printStackTrace();
+    	}
+    }