feat(apiclient): allow to specify additional libraries via setUserAgent

Author: KaiSchwarz-cnic

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

@@ -166,12 +166,31 @@ public String getURL() {
      * @return Current APIClient instance for method chaining
      */
     public APIClient setUserAgent(String str, String rv) {
+        return this.setUserAgent(str, rv, new ArrayList<String>());
+    }
+
+    /**
+     * Set a custom user agent header (useful for tools that use our SDK)
+     * 
+     * @param str     user agent label
+     * @param rv      user agent revision
+     * @param modules further modules to add to user agent string ["<module>/<version>"]
+     * @return Current APIClient instance for method chaining
+     */
+    public APIClient setUserAgent(String str, String rv, ArrayList<String> modules) {
+        StringBuilder mods = new StringBuilder(" ");
+        if (modules.size() > 0) {
+            for (int i = 0; i < modules.size(); i++) {
+                mods.append(modules.get(i));
+                mods.append(" ");
+            }
+        }
         String jv = System.getProperty("java.vm.name").toLowerCase().replaceAll(" .+", "");
         String jrv = System.getProperty("java.version");
         String arch = System.getProperty("os.arch");
         String os = System.getProperty("os.name");
-        this.ua = (str + " (" + os + "; " + arch + "; rv:" + rv + ") java-sdk/" + this.getVersion()
-                + " " + jv + "/" + jrv);
+        this.ua = (str + " (" + os + "; " + arch + "; rv:" + rv + ")" + mods + "java-sdk/"
+                + this.getVersion() + " " + jv + "/" + jrv);
         return this;
     }
 

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

@@ -143,6 +143,30 @@ public void setUserAgent() {
         assertEquals(cl.getUserAgent(), uaexpected);
     }
 
+    /**
+     * Test setUserAgent method by including additional modules
+     */
+    @Test
+    public void setUserAgentModules() {
+        String pid = "WHMCS";
+        String rv = "7.7.0";
+        ArrayList<String> mods = new ArrayList<String>();
+        mods.add("reg/2.6.2");
+        mods.add("ssl/7.2.2");
+        mods.add("dc/8.2.2");
+
+        APIClient cl = new APIClient();
+        cl.setUserAgent(pid, rv, mods);
+        String jv = System.getProperty("java.vm.name").toLowerCase().replaceAll(" .+", "");
+        String jrv = System.getProperty("java.version");
+        String arch = System.getProperty("os.arch");
+        String os = System.getProperty("os.name");
+        String uaexpected = (pid + " (" + os + "; " + arch + "; rv:" + rv
+                + ") reg/2.6.2 ssl/7.2.2 dc/8.2.2 java-sdk/" + cl.getVersion() + " " + jv + "/"
+                + jrv);
+        assertEquals(cl.getUserAgent(), uaexpected);
+    }
+
     /**
      * Test setURL method
      */