Merge pull request #893 from sudohippie/develop_2.0-fork

Android & Java template modifications to check collectionFormat when creating query parameters

modules/swagger-codegen/src/main/resources/Java/ApiClient.mustache

@@ -22,6 +22,7 @@ import java.util.Map;
 import java.util.Map.Entry;
 import java.util.HashMap;
 import java.util.List;
+import java.util.ArrayList;
 import java.util.Date;
 import java.util.TimeZone;
 
@@ -238,6 +239,62 @@ public class ApiClient {
     }
   }
 
+  /*
+    Format to {@code Pair} objects.
+  */
+  public List<Pair> parameterToPairs(String collectionFormat, String name, Object value){
+    List<Pair> params = new ArrayList<Pair>();
+
+    // preconditions
+    if (name == null || name.isEmpty() || value == null) return params;
+
+    Collection valueCollection = null;
+    if (value instanceof Collection) {
+      valueCollection = (Collection) value;
+    } else {
+      params.add(new Pair(name, parameterToString(value)));
+      return params;
+    }
+
+    if (valueCollection.isEmpty()){
+      return params;
+    }
+
+    // get the collection format
+    collectionFormat = (collectionFormat == null || collectionFormat.isEmpty() ? "csv" : collectionFormat); // default: csv
+
+    // create the params based on the collection format
+    if (collectionFormat.equals("multi")) {
+      for (Object item : valueCollection) {
+        params.add(new Pair(name, parameterToString(item)));
+      }
+
+      return params;
+    }
+
+    String delimiter = ",";
+
+    if (collectionFormat.equals("csv")) {
+      delimiter = ",";
+    } else if (collectionFormat.equals("ssv")) {
+      delimiter = " ";
+    } else if (collectionFormat.equals("tsv")) {
+      delimiter = "\t";
+    } else if (collectionFormat.equals("pipes")) {
+      delimiter = "|";
+    }
+
+    StringBuilder sb = new StringBuilder() ;
+    for (Object item : valueCollection) {
+      sb.append(delimiter);
+      sb.append(parameterToString(item));
+    }
+
+    params.add(new Pair(name, sb.substring(1)));
+
+    return params;
+  }
+
   /**
    * Select the Accept header's value from the given accepts array:
    *   if JSON exists in the given array, use it;
@@ -341,23 +398,25 @@ public class ApiClient {
    * @param authNames The authentications to apply
    * @return The response body in type of string
    */
-  public String invokeAPI(String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String accept, String contentType, String[] authNames) throws ApiException {
+  public String invokeAPI(String path, String method, List<Pair> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String accept, String contentType, String[] authNames) throws ApiException {
     updateParamsForAuth(authNames, queryParams, headerParams);
 
     Client client = getClient();
 
     StringBuilder b = new StringBuilder();
-    for(String key : queryParams.keySet()) {
-      String value = queryParams.get(key);
-      if (value != null){
-        if(b.toString().length() == 0)
-          b.append("?");
-        else
+    b.append("?");
+    if (queryParams != null){
+      for (Pair queryParam : queryParams){
+        if (!queryParam.getName().isEmpty()) {
+          b.append(escapeString(queryParam.getName()));
+          b.append("=");
+          b.append(escapeString(queryParam.getValue()));
           b.append("&");
-        b.append(escapeString(key)).append("=").append(escapeString(value));
+        }
       }
     }
-    String querystring = b.toString();
+
+    String querystring = b.substring(0, b.length() - 1);
 
     Builder builder;
     if (accept == null)
@@ -457,7 +516,7 @@ public class ApiClient {
    *
    * @param authNames The authentications to apply
    */
-  private void updateParamsForAuth(String[] authNames, Map<String, String> queryParams, Map<String, String> headerParams) {
+  private void updateParamsForAuth(String[] authNames, List<Pair> queryParams, Map<String, String> headerParams) {
     for (String authName : authNames) {
       Authentication auth = authentications.get(authName);
       if (auth == null) throw new RuntimeException("Authentication undefined: " + authName);

modules/swagger-codegen/src/main/resources/Java/Pair.mustache

@@ -0,0 +1,38 @@
+package {{invokerPackage}};
+
+public class Pair {
+    private String name = "";
+    private String value = "";
+
+    public Pair (String name, String value) {
+        setName(name);
+        setValue(value);
+    }
+
+    private void setName(String name) {
+        if (!isValidString(name)) return;
+
+        this.name = name;
+    }
+
+    private void setValue(String value) {
+        if (!isValidString(value)) return;
+
+        this.value = value;
+    }
+
+    public String getName() {
+        return this.name;
+    }
+
+    public String getValue() {
+        return this.value;
+    }
+
+    private boolean isValidString(String arg) {
+        if (arg == null) return false;
+        if (arg.trim().isEmpty()) return false;
+
+        return true;
+    }
+}

modules/swagger-codegen/src/main/resources/Java/api.mustache

@@ -3,6 +3,7 @@ package {{package}};
 import {{invokerPackage}}.ApiException;
 import {{invokerPackage}}.ApiClient;
 import {{invokerPackage}}.Configuration;
+import {{invokerPackage}}.Pair;
 
 import {{modelPackage}}.*;
 
@@ -61,16 +62,16 @@ public class {{classname}} {
       .replaceAll("\\{" + "{{paramName}}" + "\\}", apiClient.escapeString({{{paramName}}}.toString())){{/pathParams}};
 
     // query params
-    Map<String, String> queryParams = new HashMap<String, String>();
+    List<Pair> queryParams = new ArrayList<Pair>();
     Map<String, String> headerParams = new HashMap<String, String>();
     Map<String, String> formParams = new HashMap<String, String>();
 
-    {{#queryParams}}if ({{paramName}} != null)
-      queryParams.put("{{baseName}}", apiClient.parameterToString({{paramName}}));
+    {{#queryParams}}
+    queryParams.addAll(apiClient.parameterToPairs("{{#collectionFormat}}{{{collectionFormat}}}{{/collectionFormat}}", "{{baseName}}", {{paramName}}));
     {{/queryParams}}
 
     {{#headerParams}}if ({{paramName}} != null)
-      headerParams.put("{{baseName}}", apiClient.parameterToString({{paramName}}));
+    headerParams.put("{{baseName}}", apiClient.parameterToString({{paramName}}));
     {{/headerParams}}
 
     final String[] accepts = {

modules/swagger-codegen/src/main/resources/Java/auth/ApiKeyAuth.mustache

@@ -1,6 +1,9 @@
 package {{invokerPackage}}.auth;
 
+import {{invokerPackage}}.Pair;
+
 import java.util.Map;
+import java.util.List;
 
 public class ApiKeyAuth implements Authentication {
   private final String location;
@@ -39,7 +42,7 @@ public class ApiKeyAuth implements Authentication {
   }
 
   @Override
-  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+  public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
     String value;
     if (apiKeyPrefix != null) {
       value = apiKeyPrefix + " " + apiKey;
@@ -47,7 +50,7 @@ public class ApiKeyAuth implements Authentication {
       value = apiKey;
     }
     if (location == "query") {
-      queryParams.put(paramName, value);
+      queryParams.add(new Pair(paramName, value));
     } else if (location == "header") {
       headerParams.put(paramName, value);
     }

modules/swagger-codegen/src/main/resources/Java/auth/Authentication.mustache

@@ -1,8 +1,11 @@
 package {{invokerPackage}}.auth;
 
+import {{invokerPackage}}.Pair;
+
 import java.util.Map;
+import java.util.List;
 
 public interface Authentication {
   /** Apply authentication settings to header and query params. */
-  void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams);
+  void applyToParams(List<Pair> queryParams, Map<String, String> headerParams);
 }

modules/swagger-codegen/src/main/resources/Java/auth/HttpBasicAuth.mustache

@@ -1,6 +1,9 @@
 package {{invokerPackage}}.auth;
 
+import {{invokerPackage}}.Pair;
+
 import java.util.Map;
+import java.util.List;
 
 import java.io.UnsupportedEncodingException;
 import javax.xml.bind.DatatypeConverter;
@@ -26,7 +29,7 @@ public class HttpBasicAuth implements Authentication {
   }
 
   @Override
-  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+  public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
     String str = (username == null ? "" : username) + ":" + (password == null ? "" : password);
     try {
       headerParams.put("Authorization", "Basic " + DatatypeConverter.printBase64Binary(str.getBytes("UTF-8")));

modules/swagger-codegen/src/main/resources/Java/auth/OAuth.mustache

@@ -1,10 +1,13 @@
 package {{invokerPackage}}.auth;
 
+import {{invokerPackage}}.Pair;
+
 import java.util.Map;
+import java.util.List;
 
 public class OAuth implements Authentication {
   @Override
-  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+  public void applyToParams(List<Pair> queryParams, Map<String, String> headerParams) {
     // TODO: support oauth
   }
 }