feat(response): possibility of placeholder vars in standard responses to improve error details

Author: KaiSchwarz-cnic

src/main/java/net/hexonet/apiconnector/APIClient.java

@@ -468,11 +468,13 @@ public Response request(Map<String, Object> cmd) {
         // request command to API
         String data = this.getPOSTData(newcmd);
         String secured = this.getPOSTData(newcmd, true);
+        Map<String, String> cfg = new HashMap<String, String>();
+        cfg.put("CONNECTION_URL", this.socketURL);
 
         StringBuilder response;
         try {
             response = new StringBuilder("");
-            URL myurl = new URL(this.socketURL);
+            URL myurl = new URL(cfg.get("CONNECTION_URL"));
             HttpsURLConnection con = (HttpsURLConnection) myurl.openConnection();
             if (this.curlopts.containsKey("PROXY")) {
                 URL proxyurl = new URL(this.curlopts.get("PROXY"));
@@ -515,7 +517,7 @@ public Response request(Map<String, Object> cmd) {
                 System.err.println(e);
             }
         }
-        Response r = new Response(response.toString(), newcmd);
+        Response r = new Response(response.toString(), newcmd, cfg);
         if (this.debugMode) {
             System.out.println(secured);
             System.out.println(newcmd);

src/main/java/net/hexonet/apiconnector/Response.java

@@ -4,6 +4,8 @@
 import java.util.HashMap;
 import java.util.Iterator;
 import java.util.Map;
+import java.util.regex.Pattern;
+import java.util.regex.Matcher;
 
 /**
  * Response covers all functionality to wrap a Backend API Response like accessing data
@@ -41,9 +43,31 @@ public class Response extends ResponseTemplate {
      * @param raw API plain response
      * @param cmd API command used within this request
      */
-    @SuppressWarnings("unchecked") // not really a good way ...
     public Response(String raw, Map<String, String> cmd) {
+        this(raw, cmd, Map.ofEntries());
+    }
+
+    /**
+     * Constructor
+     * 
+     * @param raw API plain response
+     * @param cmd API command used within this request
+     * @param ph  place holder variables replacements
+     */
+    @SuppressWarnings("unchecked") // not really a good way ...
+    public Response(String raw, Map<String, String> cmd, Map<String, String> ph) {
         super(raw);
+
+        String regex = "\\{[^}]+\\}";
+        Pattern pattern = Pattern.compile(regex);
+        Matcher matcher = pattern.matcher(this.raw);
+        if (matcher.find()) {
+            for (Map.Entry<String, String> entry : ph.entrySet()) {
+                this.raw = this.raw.replace("{" + entry.getKey() + "}", entry.getValue());
+            }
+            super.init(this.raw.replaceAll(regex, ""));
+        }
+
         this.command = new HashMap<String, String>(cmd);
         if (this.command.containsKey("PASSWORD")) { // make password no longer accessible
             this.command.replace("PASSWORD", "***");

src/main/java/net/hexonet/apiconnector/ResponseTemplate.java

@@ -25,6 +25,15 @@ public ResponseTemplate(String raw) {
         if (raw.length() == 0) {
             raw = ResponseTemplateManager.getInstance().getTemplate("empty").getPlain();
         }
+        this.init(raw);
+    }
+
+    /**
+     * init hash - workaround for not calling constructor in response class twice (TO DO)
+     * 
+     * @param raw
+     */
+    protected void init(String raw) {
         this.raw = raw;
         this.hash = ResponseParser.parse(raw);
         if (!this.hash.containsKey("CODE") || !this.hash.containsKey("DESCRIPTION")) {

src/main/java/net/hexonet/apiconnector/ResponseTemplateManager.java

@@ -25,7 +25,7 @@ private ResponseTemplateManager() {
         this.templates.put("404", this.generateTemplate("421", "Page not found"));
         this.templates.put("500", this.generateTemplate("500", "Internal server error"));
         this.templates.put("empty", this.generateTemplate("423",
-                "Empty API response. Probably unreachable API end point"));
+                "Empty API response. Probably unreachable API end point {CONNECTION_URL}"));
         this.templates.put("error", this.generateTemplate("421",
                 "Command failed due to server error. Client should try again"));
         this.templates.put("expired", this.generateTemplate("530", "SESSION NOT FOUND"));

src/test/java/net/hexonet/apiconnector/ResponseTemplateTest.java

@@ -15,7 +15,7 @@ public class ResponseTemplateTest {
     public void constructorVars() {
         ResponseTemplate tpl = new ResponseTemplate("");
         assertEquals(423, tpl.getCode());
-        assertEquals("Empty API response. Probably unreachable API end point",
+        assertEquals("Empty API response. Probably unreachable API end point {CONNECTION_URL}",
                 tpl.getDescription());
     }
 
@@ -38,7 +38,7 @@ public void getHash() {
         ResponseTemplate tpl = new ResponseTemplate("");
         Map<String, Object> h = tpl.getHash();
         assertEquals("423", (String) h.get("CODE"));
-        assertEquals("Empty API response. Probably unreachable API end point",
+        assertEquals("Empty API response. Probably unreachable API end point {CONNECTION_URL}",
                 (String) h.get("DESCRIPTION"));
     }
 

src/test/java/net/hexonet/apiconnector/ResponseTest.java

@@ -9,6 +9,8 @@
 import java.util.Arrays;
 import java.util.HashMap;
 import java.util.Map;
+import java.util.regex.Pattern;
+import java.util.regex.Matcher;
 import org.junit.Test;
 
 /**
@@ -44,6 +46,31 @@ public void getCommandPlainSecure() {
         assertEquals(str, r.getCommandPlain());
     }
 
+    /**
+     * Test place holder vars replacement mechanism
+     */
+    @Test
+    public void placeHolderReplacements() {
+        Map<String, String> cmd = new HashMap<String, String>();
+        cmd.put("COMMAND", "StatusAccount");
+
+        // ensure no vars are returned in response, just in case no place holder replacements are
+        // provided
+        Response r = new Response("", cmd);
+        String regex = "\\{[^}]+\\}";
+        Pattern pattern = Pattern.compile(regex);
+        Matcher matcher = pattern.matcher(r.getDescription());
+        assertFalse(matcher.find());
+
+        // ensure variable replacements are correctly handled in case place holder replacements are
+        // provided
+        r = new Response("", cmd, Map.ofEntries(Map.entry("CONNECTION_URL", "123HXPHFOUND123")));
+        regex = "123HXPHFOUND123";
+        pattern = Pattern.compile(regex);
+        matcher = pattern.matcher(r.getDescription());
+        assertTrue(matcher.find());
+    }
+
     /**
      * Test getCurrentPageNumber method #1
      */