Adds HLR check number with IDX support

Author: maciejlew

CHANGELOG.md

@@ -11,6 +11,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) a
 - `date_sent` to SMS/MMS send action responses
 - `time_restriction` parameter for SMS send action
 - HLR action factory, `HlrFactory`
+- HLR with IDX support
 
 ### Changed
 - `pl.smsapi.api.UserFactory.actionAdd` marked as deprecated, use `pl.smsapi.api.action.subusers.SubusersFactory.actionAdd` instead

src/main/java/pl/smsapi/api/action/hlr/HLRCheckNumber.java

@@ -28,6 +28,14 @@ public HLRCheckNumber setNumber(String number) {
         return this;
     }
 
+    /**
+     * Set optional custom value sent with HLR and sent back in CALLBACK.
+     */
+    public HLRCheckNumber setIDx(String idx) {
+        params.put("idx", idx);
+        return this;
+    }
+
     protected CheckNumberResponse createResponse(String data) {
         JSONObject jsonObject = new JSONObject(data);
         return new CheckNumberResponse(jsonObject.getInt("count"), jsonObject.getJSONArray("list"));

src/test/java/pl/smsapi/api/action/hlr/HLRCheckNumberTest.java

@@ -28,4 +28,23 @@ public void executeCheckNumberRequest() throws SmsapiException {
         expectedRequestPayload.put("format", "json");
         assertEquals(expectedRequestPayload, requestStub.requestPayload);
     }
+
+    @Test
+    public void executeCheckNumberWithOptionalFieldsRequest() throws SmsapiException {
+        ProxyRequestSpy requestStub = new ProxyRequestSpy(StatusJsonMother.create());
+        HLRCheckNumber action = new HLRCheckNumber("500600700");
+        action.client(new ClientStub());
+        action.proxy(requestStub);
+        action.setIDx("example-user-provided-id-123");
+
+        action.execute();
+
+        assertEquals("POST", requestStub.requestMethod);
+        assertEquals("hlrsync.do", requestStub.requestEndpoint);
+        HashMap<String, String> expectedRequestPayload = new HashMap<>();
+        expectedRequestPayload.put("number", "500600700");
+        expectedRequestPayload.put("format", "json");
+        expectedRequestPayload.put("idx", "example-user-provided-id-123");
+        assertEquals(expectedRequestPayload, requestStub.requestPayload);
+    }
 }

src/test/java/pl/smsapi/api/action/hlr/HlrFactoryTest.java

@@ -22,8 +22,9 @@ public void setUp() {
 
     @Test
     public void checkNumberTest() throws SmsapiException {
-
-        HLRCheckNumber actionCheckNumber = apiFactory.actionCheckNumber("500600700");
+        HLRCheckNumber actionCheckNumber = apiFactory
+            .actionCheckNumber("500600700")
+            .setIDx("example-user-provided-id-123");
 
         CheckNumberResponse responseCheckNumber = actionCheckNumber.execute();