feat(responsetranslator): added initial version coming with rewrite/restructuring from scratch

As of known issues, we merged Response and ResponseTemplate classes.

BREAKING CHANGE: Downward incompatible restructuring (Merge of Response/ResponseTemplate, Rewrite
ResponseTemplateManager) and introducing ResponseTranslator

Author: KaiSchwarz-cnic

.releaserc.json

@@ -8,6 +8,12 @@
                 "changelogFile": "HISTORY.md"
             }
         ],
+        [
+            "@semantic-release/exec",
+            {
+                "prepareCmd": "./updateVersion.sh ${nextRelease.version}"
+            }
+        ],
         "@conveyal/maven-semantic-release",
         [
             "@semantic-release/git",

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

@@ -295,7 +295,7 @@ public String getReferer() {
      * @return module version
      */
     public String getVersion() {
-        return "1.3.20";
+        return "3.2.0";
     }
 
     /**
@@ -495,10 +495,10 @@ public Response request(Map<String, Object> cmd) {
         Map<String, String> cfg = new HashMap<String, String>();
         cfg.put("CONNECTION_URL", this.socketURL);
 
-        StringBuilder response;
+        StringBuilder response = new StringBuilder("");
         Response r;
+        String err = null;
         try {
-            response = new StringBuilder("");
             URL myurl = new URL(cfg.get("CONNECTION_URL"));
             HttpsURLConnection con = (HttpsURLConnection) myurl.openConnection();
             if (this.curlopts.containsKey("PROXY")) {
@@ -535,18 +535,14 @@ public Response request(Map<String, Object> cmd) {
                 }
             }
             in.close();
+            con.disconnect();
         } catch (Exception e) {
-            ResponseTemplate tpl = ResponseTemplateManager.getInstance().getTemplate("httperror");
-            response = new StringBuilder(tpl.getPlain());
-            r = new Response(response.toString(), newcmd, cfg);
-            if (this.debugMode) {
-                this.logger.log(secured, r, e.getMessage());
-            }
-            return r;
+            err = e.getMessage();
+            response.append("httperror");
         }
         r = new Response(response.toString(), newcmd, cfg);
         if (this.debugMode) {
-            this.logger.log(secured, r);
+            this.logger.log(secured, r, err);
         }
         return r;
     }

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

@@ -4,8 +4,6 @@
 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
@@ -14,7 +12,12 @@
  * @version %I%, %G%
  * @since 2.0
  */
-public class Response extends ResponseTemplate {
+public class Response {
+    /** backend system plain response data */
+    private String raw;
+    /** backend system parsed response data (hash format) */
+    private Map<String, Object> hash;
+
     /**
      * The API Command used within this request
      */
@@ -37,6 +40,15 @@ public class Response extends ResponseTemplate {
      */
     private ArrayList<Record> records;
 
+    /**
+     * Constructor
+     * 
+     * @param raw API plain response
+     */
+    public Response(String raw) {
+        this(raw, Map.ofEntries(), Map.ofEntries());
+    }
+
     /**
      * Constructor
      * 
@@ -56,22 +68,14 @@ public Response(String raw, Map<String, String> cmd) {
      */
     @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, ""));
+        // secure password for output
+        if (cmd.containsKey("PASSWORD")) {
+            cmd.replace("PASSWORD", "***");
         }
 
+        this.raw = ResponseTranslator.translate(raw, cmd, ph);
+        this.hash = ResponseParser.parse(this.raw);
         this.command = new HashMap<String, String>(cmd);
-        if (this.command.containsKey("PASSWORD")) { // make password no longer accessible
-            this.command.replace("PASSWORD", "***");
-        }
         this.columnkeys = new ArrayList<String>();
         this.columns = new ArrayList<Column>();
         this.recordIndex = 0;
@@ -106,6 +110,112 @@ public Response(String raw, Map<String, String> cmd, Map<String, String> ph) {
         }
     }
 
+    /**
+     * Get API response code
+     * 
+     * @return API response code
+     */
+    public int getCode() {
+        return Integer.parseInt((String) this.hash.get("CODE"));
+    }
+
+    /**
+     * Get API response description
+     * 
+     * @return API response description
+     */
+    public String getDescription() {
+        return (String) this.hash.get("DESCRIPTION");
+    }
+
+    /**
+     * Get Plain API response
+     * 
+     * @return Plain API response
+     */
+    public String getPlain() {
+        return this.raw;
+    }
+
+    /**
+     * Get Queuetime of API response
+     * 
+     * @return Queuetime of API response
+     */
+    public double getQueuetime() {
+        String rt = (String) this.hash.get("QUEUETIME");
+        if (rt != null) {
+            return Double.parseDouble((String) this.hash.get("QUEUETIME"));
+        }
+        return 0.00;
+    }
+
+    /**
+     * Get API response as Hash
+     * 
+     * @return API response hash
+     */
+    public Map<String, Object> getHash() {
+        return this.hash;
+    }
+
+    /**
+     * Get Runtime of API response
+     * 
+     * @return Runtime of API response
+     */
+    public double getRuntime() {
+        String rt = (String) this.hash.get("RUNTIME");
+        if (rt != null) {
+            return Double.parseDouble((String) this.hash.get("RUNTIME"));
+        }
+        return 0.00;
+    }
+
+    /**
+     * Check if current API response represents an error case API response code is an 5xx code
+     * 
+     * @return boolean result
+     */
+    public boolean isError() {
+        String code = (String) this.hash.get("CODE");
+        return code.charAt(0) == '5';
+    }
+
+    /**
+     * Check if current API response represents a success case API response code is an 2xx code
+     * 
+     * @return boolean result
+     */
+    public boolean isSuccess() {
+        String code = (String) this.hash.get("CODE");
+        return code.charAt(0) == '2';
+    }
+
+    /**
+     * Check if current API response represents a temporary error case API response code is an 4xx
+     * code
+     * 
+     * @return boolean result
+     */
+    public boolean isTmpError() {
+        String code = (String) this.hash.get("CODE");
+        return code.charAt(0) == '4';
+    }
+
+    /**
+     * Check if current operation is returned as pending
+     * 
+     * @return boolean result
+     */
+    public boolean isPending() {
+        String pending = (String) this.hash.get("PENDING");
+        if (pending != null) {
+            return pending.equals("1");
+        }
+        return false;
+    }
+
     /**
      * Add a column to the column list
      * 

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

@@ -13,7 +13,7 @@
  * @version %I%, %G%
  * @since 2.0
  */
-public class ResponseParser {
+public final class ResponseParser {
     /**
      * Method to stringify a parsed api response
      *