(TK-29) Add query params to Java client

Add query params back into the Java client, along with tests
to validate this functionality is working.

src/java/com/puppetlabs/http/client/RequestOptions.java

@@ -23,6 +23,7 @@ public class RequestOptions {
     private Object body;
     private boolean decompressBody = true;
     private ResponseBodyType as = ResponseBodyType.STREAM;
+    private Map<String, String> queryParams;
 
     public RequestOptions(String url) {
         this.url = url;
@@ -121,4 +122,12 @@ public class RequestOptions {
         this.as = as;
         return this;
     }
+
+    public Map<String, String> getQueryParams() {
+        return queryParams;
+    }
+    public RequestOptions setQueryParams(Map<String, String> queryParams) {
+        this.queryParams = queryParams;
+        return this;
+    }
 }

src/java/com/puppetlabs/http/client/impl/JavaClient.java

@@ -22,6 +22,7 @@ import java.security.KeyManagementException;
 import java.security.NoSuchAlgorithmException;
 import java.security.cert.CertificateException;
 import java.security.cert.X509Certificate;
+import java.net.URLEncoder;
 import java.util.HashMap;
 import java.util.Map;
 
@@ -29,6 +30,25 @@ public class JavaClient {
 
     private static final String PROTOCOL = "TLS";
 
+    private static String buildQueryString(Map<String, String> params) {
+        StringBuilder sb = new StringBuilder();
+        boolean first = true;
+        for (Map.Entry<String, String> entry : params.entrySet()) {
+            if (!first) {
+                sb.append("&");
+            }
+            first = false;
+            try {
+                sb.append(URLEncoder.encode(entry.getKey(), "utf8"));
+                sb.append("=");
+                sb.append(URLEncoder.encode(entry.getValue(), "utf8"));
+            } catch (UnsupportedEncodingException e) {
+                throw new RuntimeException("Error while url-encoding query string", e);
+            }
+        }
+        return sb.toString();
+    }
+
     private static Header[] prepareHeaders(RequestOptions options) {
         Map<String, Header> result = new HashMap<String, Header>();
         Map<String, String> origHeaders = options.getHeaders();
@@ -46,7 +66,17 @@ public class JavaClient {
     }
 
     private static CoercedRequestOptions coerceRequestOptions(RequestOptions options) {
-        String url = options.getUrl();
+        String url;
+
+        if (options.getQueryParams() != null) {
+            if (options.getUrl().indexOf('?') == -1) {
+                url = options.getUrl() + "?" + buildQueryString(options.getQueryParams());
+            } else {
+                url = options.getUrl() + "&" + buildQueryString(options.getQueryParams());
+            }
+        } else {
+            url = options.getUrl();
+        }
 
         SSLContext sslContext = null;
         if (options.getSslContext() != null) {

test/puppetlabs/http/client/async_plaintext_test.clj

@@ -2,6 +2,7 @@
   (:import (com.puppetlabs.http.client AsyncHttpClient RequestOptions)
            (org.apache.http.impl.nio.client HttpAsyncClients))
   (:require [clojure.test :refer :all]
+            [puppetlabs.http.client.test-common :refer :all]
             [puppetlabs.trapperkeeper.core :as tk]
             [puppetlabs.trapperkeeper.testutils.bootstrap :as testutils]
             [puppetlabs.trapperkeeper.testutils.logging :as testlogging]
@@ -134,4 +135,16 @@
           (let [response (async/request-with-client opts nil client)]
             (is (= 200 (:status @response)))
             (is (= "Hello, World!" (slurp (:body @response))))))
-        (.close client)))))
+        (.close client)))))
+
+(deftest query-params-test-async
+  (testlogging/with-test-logging
+    (testutils/with-app-with-config app
+      [jetty9/jetty9-service test-params-web-service]
+      {:webserver {:port 8080}}
+      (testing "URL Query Parameters work with the Java client"
+        (let [options (RequestOptions. "http://localhost:8080/params")]
+          (.setQueryParams options queryparams)
+          (let [response (AsyncHttpClient/get options)]
+            (is (= 200 (.getStatus (.deref response))))
+            (is (= (str queryparams) (slurp (.getBody (.deref response)))))))))))

test/puppetlabs/http/client/sync_plaintext_test.clj

@@ -6,6 +6,7 @@
            (java.nio.charset Charset)
            (org.apache.http.impl.nio.client HttpAsyncClients))
   (:require [clojure.test :refer :all]
+            [puppetlabs.http.client.test-common :refer :all]
             [puppetlabs.trapperkeeper.core :as tk]
             [puppetlabs.trapperkeeper.testutils.bootstrap :as testutils]
             [puppetlabs.trapperkeeper.testutils.logging :as testlogging]
@@ -299,3 +300,15 @@
 (deftest sync-client-decompression-disabled-test
   (test-compression "explicit disable" {:headers {"accept-encoding" "gzip"}
                                         :decompress-body false} "gzip" "gzip" false))
+
+(deftest query-params-test-sync
+  (testlogging/with-test-logging
+    (testutils/with-app-with-config app
+      [jetty9/jetty9-service test-params-web-service]
+      {:webserver {:port 8080}}
+      (testing "URL Query Parameters work with the Java client"
+        (let [options (RequestOptions. "http://localhost:8080/params")]
+          (.setQueryParams options queryparams)
+          (let [response (SyncHttpClient/get options)]
+            (is (= 200 (.getStatus response)))
+            (is (= (str queryparams) (slurp (.getBody response))))))))))

test/puppetlabs/http/client/test_common.clj

@@ -0,0 +1,20 @@
+(ns puppetlabs.http.client.test-common
+  (:require [ring.middleware.params :as ring-params]
+            [puppetlabs.trapperkeeper.core :as tk]))
+
+(defn query-params-test
+  [req]
+  {:status 200
+   :body (str (:params req))})
+
+(def app-wrapped
+  (ring-params/wrap-params query-params-test))
+
+(tk/defservice test-params-web-service
+  [[:WebserverService add-ring-handler]]
+  (init [this context]
+        (add-ring-handler app-wrapped "/params")
+        context))
+
+(def queryparams {"yellow"  "submarine"
+                  "eleanor" "rigby"})