Merge pull request #22 from smsapi/sms-api

Sms API

Author: maciejlew

CHANGELOG.md

@@ -8,6 +8,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 - new Contacts API
 - Subusers API
 - `pl.smsapi.exception.SmsapiErrorException` to handle API error responses
+- `date_sent` to SMS/MMS send action responses
+- `time_restriction` parameter for SMS send action
 
 ### Changed
 - `pl.smsapi.api.UserFactory.actionAdd` marked as deprecated, use `pl.smsapi.api.action.subusers.SubusersFactory.actionAdd` instead
@@ -30,6 +32,12 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 - `pl.smsapi.api.action.vms.VMSDelete` without parameters marked as deprecated
 - `pl.smsapi.api.action.vms.VMSGet` without parameters marked as deprecated
 - `pl.smsapi.api.action.vms.VMSSend` without parameters marked as deprecated
+- `pl.smsapi.api.SmsFactory.actionSend` without parameters marked as deprecated
+- `pl.smsapi.api.action.sms.SMSSend` without parameters marked as deprecated
+- `pl.smsapi.api.SmsFactory.actionGet` without parameters marked as deprecated
+- `pl.smsapi.api.action.sms.SMSGet` without parameters marked as deprecated
+- `pl.smsapi.api.SmsFactory.actionDelete` without parameters marked as deprecated
+- `pl.smsapi.api.action.sms.SMSDelete` without parameters marked as deprecated
 
 ### Removed
 - legacy `phonebook.do` contacts API support

README.md

@@ -63,9 +63,7 @@ public class Example {
 
             SmsFactory smsApi = new SmsFactory(client, proxy);
 
-            SMSSend action = smsApi.actionSend()
-                    .setTo("000000000")
-                    .setText("test");
+            SMSSend action = smsApi.actionSend("000000000", "test message");
 
             StatusResponse result = action.execute();
 
@@ -114,9 +112,7 @@ public class Example {
 
             String[] to = {"000000000", "000000001"};
 
-            SMSSend action = smsApi.actionSend()
-                    .setTo(to)
-                    .setText("test");
+            SMSSend action = smsApi.actionSend(to, "test message");
 
             StatusResponse result = action.execute();
 

src/main/java/pl/smsapi/api/SmsFactory.java

@@ -20,6 +20,10 @@ public SmsFactory(Client client, Proxy proxy) {
         super(client, proxy);
     }
 
+    /**
+     * @deprecated use {@link #actionSend(String, String)} or {@link #actionSend(String[], String)} instead
+     */
+    @Deprecated
     public SMSSend actionSend() {
         SMSSend action = new SMSSend();
         action.client(client);
@@ -28,18 +32,23 @@ public SMSSend actionSend() {
     }
 
     public SMSSend actionSend(String to, String text) {
-        String[] tos = new String[]{to};
-        return actionSend(tos, text);
+        SMSSend action = new SMSSend(to, text);
+        action.client(client);
+        action.proxy(proxy);
+        return action;
     }
 
     public SMSSend actionSend(String[] to, String text) {
-        SMSSend action = actionSend();
-        action.setTo(to);
-        action.setText(text);
-
+        SMSSend action = new SMSSend(to, text);
+        action.client(client);
+        action.proxy(proxy);
         return action;
     }
 
+    /**
+     * @deprecated use {@link #actionGet(String)} instead
+     */
+    @Deprecated
     public SMSGet actionGet() {
         SMSGet action = new SMSGet();
         action.client(client);
@@ -48,11 +57,16 @@ public SMSGet actionGet() {
     }
 
     public SMSGet actionGet(String id) {
-        SMSGet action = actionGet();
-        action.id(id);
+        SMSGet action = new SMSGet(id);
+        action.client(client);
+        action.proxy(proxy);
         return action;
     }
 
+    /**
+     * @deprecated use {@link #actionDelete(String)} instead
+     */
+    @Deprecated
     public SMSDelete actionDelete() {
         SMSDelete action = new SMSDelete();
         action.client(client);
@@ -61,8 +75,9 @@ public SMSDelete actionDelete() {
     }
 
     public SMSDelete actionDelete(String id) {
-        SMSDelete action = actionDelete();
-        action.id(id);
+        SMSDelete action = new SMSDelete(id);
+        action.client(client);
+        action.proxy(proxy);
         return action;
     }
 }

src/main/java/pl/smsapi/api/action/sms/SMSDelete.java

@@ -7,15 +7,26 @@
 
 public class SMSDelete extends AbstractAction<CountableResponse> {
 
+    /**
+     * @deprecated use {@link SMSDelete(String)} instead
+     */
+    @Deprecated
     public SMSDelete() {
         setJson(true);
         id("");
     }
 
+    public SMSDelete(String id) {
+        setJson(true);
+        params.put("sch_del", id);
+    }
+
     /**
      * Set ID of message to delete.
      * <p/>
      * This id was returned after sending message.
+     *
+     * @deprecated use {@link SMSDelete(String)} instead
      */
     public SMSDelete id(String id) {
         params.put("sch_del", id);

src/main/java/pl/smsapi/api/action/sms/SMSGet.java

@@ -7,16 +7,33 @@
 
 public class SMSGet extends AbstractAction<StatusResponse> {
 
+    /**
+     * @deprecated use {@link SMSGet(String)} or {@link SMSGet(String[])} instead
+     */
+    @Deprecated
     public SMSGet() {
         setJson(true);
         id("");
     }
 
+    public SMSGet(String id) {
+        setJson(true);
+        params.put("status", id);
+    }
+
+    public SMSGet(String[] ids) {
+        setJson(true);
+        params.put("status", StringUtils.join(ids, '|'));
+    }
+
     /**
      * Set ID of message to check.
      * <p/>
      * This id was returned after sending message.
+     *
+     * @deprecated use {@link SMSGet(String)} instead
      */
+    @Deprecated
     public SMSGet id(String id) {
         params.put("status", id);
         return this;
@@ -26,7 +43,10 @@ public SMSGet id(String id) {
      * Set IDs of messages to check.
      * <p/>
      * This id was returned after sending message.
+     *
+     * @deprecated use {@link SMSGet(String[])} instead
      */
+    @Deprecated
     public SMSGet ids(String[] ids) {
         params.put("status", StringUtils.join(ids, '|'));
         return this;

src/main/java/pl/smsapi/api/action/sms/SMSSend.java

@@ -9,11 +9,30 @@
 
 public class SMSSend extends AbstractSendAction<SMSSend, SendStatusResponse> {
 
+    /**
+     * @deprecated use {@link SMSSend(String, String)} or {@link SMSSend(String[], String)} instead
+     */
+    @Deprecated
     public SMSSend() {
+        setJson(true);
+        params.put("encoding", "utf-8");
+        params.put("details", "1");
+    }
 
+    public SMSSend(String to, String text) {
         setJson(true);
         params.put("encoding", "utf-8");
         params.put("details", "1");
+        setTo(to);
+        setText(text);
+    }
+
+    public SMSSend(String[] to, String text) {
+        setJson(true);
+        params.put("encoding", "utf-8");
+        params.put("details", "1");
+        setTo(to);
+        setText(text);
     }
 
     @Override
@@ -25,7 +44,10 @@ protected String endPoint() {
      * Set SMS text message.
      * <p/>
      * Content of one message is normally 160 characters per single SMS or 70 in case of using at least one special character
+     *
+     * @deprecated use {@link SMSSend(String, String)} or {@link SMSSend(String[], String)} instead
      */
+    @Deprecated
     public SMSSend setText(String text) {
         params.put("message", text);
         return this;
@@ -153,6 +175,14 @@ public SMSSend setParam(int i, String text) {
 
         return this;
     }
+    
+    /**
+     * Set time restriction mode.
+     */
+    public SMSSend setTimeRestriction(String timeRestriction) {
+        params.put("time_restriction", timeRestriction);
+        return this;
+    }
 
     public SMSSend setDiscountGroup(String $discountGroupName)
     {

src/main/java/pl/smsapi/api/response/MessageResponse.java

@@ -8,6 +8,7 @@ public class MessageResponse implements Response {
     private String status;
     private String error;
     private String idx;
+    private Integer toBeSentAtTimestamp;
 
     public MessageResponse(String id, String points, String number, String status, String error, String idx) {
         this.id = id;
@@ -18,6 +19,10 @@ public MessageResponse(String id, String points, String number, String status, S
         this.idx = idx;
     }
 
+    public void setToBeSentAtTimestamp(int toBeSentAtTimestamp) {
+        this.toBeSentAtTimestamp = toBeSentAtTimestamp;
+    }
+
     public String getId() {
         return id;
     }
@@ -42,6 +47,10 @@ public String getIdx() {
         return idx;
     }
 
+    public Integer getToBeSentAtTimestamp() {
+        return toBeSentAtTimestamp;
+    }
+
     public boolean isError() {
         if (id == null || id.length() == 0) {
             return true;

src/main/java/pl/smsapi/api/response/SendStatusResponse.java

@@ -1,6 +1,7 @@
 package pl.smsapi.api.response;
 
 import org.json.JSONArray;
+import org.json.JSONObject;
 
 public class SendStatusResponse extends StatusResponse {
 
@@ -11,6 +12,13 @@ public SendStatusResponse(int count, int parts, JSONArray jsonArray) {
         this.parts = parts;
     }
 
+    @Override
+    protected MessageResponse buildItem(JSONObject jsonObject) {
+        MessageResponse response = super.buildItem(jsonObject);
+        response.setToBeSentAtTimestamp(jsonObject.optInt("date_sent"));
+        return response;
+    }
+
     public int getParts() {
         return parts;
     }

src/test/java/pl/smsapi/api/action/sms/DeletedStatusJsonMother.java

@@ -0,0 +1,16 @@
+package pl.smsapi.api.action.sms;
+
+public class DeletedStatusJsonMother {
+
+    public static String create() {
+        return
+            "{" +
+            "   \"count\":1," +
+            "   \"list\":[" +
+            "       {" +
+            "           \"id\":\"0f0f0f0f0f0f0f0f0f0f0f0f\"," +
+            "       }" +
+            "   ]" +
+            "}";
+    }
+}

src/test/java/pl/smsapi/api/action/sms/SMSDeleteTest.java

@@ -0,0 +1,30 @@
+package pl.smsapi.api.action.sms;
+
+import org.junit.Test;
+import pl.smsapi.exception.SmsapiException;
+import pl.smsapi.test.doubles.ClientStub;
+import pl.smsapi.test.doubles.ProxyRequestSpy;
+
+import java.util.HashMap;
+
+import static org.junit.Assert.assertEquals;
+
+public class SMSDeleteTest {
+
+    @Test
+    public void executeDeleteSmsRequest() throws SmsapiException {
+        ProxyRequestSpy requestStub = new ProxyRequestSpy(DeletedStatusJsonMother.create());
+        SMSDelete action = new SMSDelete("0f0f0f0f0f0f0f0f0f0f0f0f");
+        action.client(new ClientStub());
+        action.proxy(requestStub);
+
+        action.execute();
+
+        assertEquals("POST", requestStub.requestMethod);
+        assertEquals("sms.do", requestStub.requestEndpoint);
+        HashMap<String, String> expectedRequestPayload = new HashMap<>();
+        expectedRequestPayload.put("sch_del", "0f0f0f0f0f0f0f0f0f0f0f0f");
+        expectedRequestPayload.put("format", "json");
+        assertEquals(expectedRequestPayload, requestStub.requestPayload);
+    }
+}