Refactor auth method naming, add comments

xhh · xhh · commit e10e1f5249c1 · 2015-05-29T11:29:06.000+08:00
diff --git a/modules/swagger-codegen/src/main/resources/Java/apiInvoker.mustache b/modules/swagger-codegen/src/main/resources/Java/apiInvoker.mustache
@@ -166,7 +166,7 @@ public class ApiInvoker {
   }
 
   public String invokeAPI(String host, String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String contentType, String[] authNames) throws ApiException {
-    processAuthParams(authNames, queryParams, headerParams);
+    updateParamsForAuth(authNames, queryParams, headerParams);
 
     Client client = getClient(host);
 
@@ -266,11 +266,12 @@ public class ApiInvoker {
     }
   }
 
-  private void processAuthParams(String[] authNames, Map<String, String> queryParams, Map<String, String> headerParams) {
+  /* Update hearder and query params based on authentication settings. */
+  private void updateParamsForAuth(String[] authNames, Map<String, String> queryParams, Map<String, String> headerParams) {
     for (String authName : authNames) {
       Authentication auth = Configuration.getAuthentication(authName);
       if (auth == null) throw new RuntimeException("Authentication has not been setup for " + authName);
-      auth.processParams(queryParams, headerParams);
+      auth.applyToParams(queryParams, headerParams);
     }
   }
 
diff --git a/modules/swagger-codegen/src/main/resources/Java/auth/ApiKeyAuth.mustache b/modules/swagger-codegen/src/main/resources/Java/auth/ApiKeyAuth.mustache
@@ -39,7 +39,7 @@ public class ApiKeyAuth implements Authentication {
   }
 
   @Override
-  public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
     String value;
     if (apiKeyPrefix != null) {
       value = apiKeyPrefix + " " + apiKey;
diff --git a/modules/swagger-codegen/src/main/resources/Java/auth/Authentication.mustache b/modules/swagger-codegen/src/main/resources/Java/auth/Authentication.mustache
@@ -3,5 +3,6 @@ package {{invokerPackage}}.auth;
 import java.util.Map;
 
 public interface Authentication {
-  void processParams(Map<String, String> queryParams, Map<String, String> headerParams);
+  /** Apply authentication settings to header and query params. */
+  void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams);
 }
diff --git a/modules/swagger-codegen/src/main/resources/Java/auth/HttpBasicAuth.mustache b/modules/swagger-codegen/src/main/resources/Java/auth/HttpBasicAuth.mustache
@@ -26,7 +26,7 @@ public class HttpBasicAuth implements Authentication {
   }
 
   @Override
-  public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
     try {
       headerParams.put("Authorization", "Basic " + DatatypeConverter.printBase64Binary((username + ":" + password).getBytes("UTF-8")));
     } catch (UnsupportedEncodingException e) {
diff --git a/modules/swagger-codegen/src/main/resources/Java/auth/OAuth.mustache b/modules/swagger-codegen/src/main/resources/Java/auth/OAuth.mustache
@@ -4,7 +4,7 @@ import java.util.Map;
 
 public class OAuth implements Authentication {
   @Override
-  public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
     // TODO: support oauth
   }
 }
diff --git a/samples/client/petstore/java/src/main/java/io/swagger/client/ApiInvoker.java b/samples/client/petstore/java/src/main/java/io/swagger/client/ApiInvoker.java
@@ -166,7 +166,7 @@ public static String serialize(Object obj) throws ApiException {
   }
 
   public String invokeAPI(String host, String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String contentType, String[] authNames) throws ApiException {
-    processAuthParams(authNames, queryParams, headerParams);
+    updateParamsForAuth(authNames, queryParams, headerParams);
 
     Client client = getClient(host);
 
@@ -266,11 +266,12 @@ else if(response.getClientResponseStatus().getFamily() == Family.SUCCESSFUL) {
     }
   }
 
-  private void processAuthParams(String[] authNames, Map<String, String> queryParams, Map<String, String> headerParams) {
+  /* Update hearder and query params based on authentication settings. */
+  private void updateParamsForAuth(String[] authNames, Map<String, String> queryParams, Map<String, String> headerParams) {
     for (String authName : authNames) {
       Authentication auth = Configuration.getAuthentication(authName);
       if (auth == null) throw new RuntimeException("Authentication has not been setup for " + authName);
-      auth.processParams(queryParams, headerParams);
+      auth.applyToParams(queryParams, headerParams);
     }
   }
 
diff --git a/samples/client/petstore/java/src/main/java/io/swagger/client/auth/ApiKeyAuth.java b/samples/client/petstore/java/src/main/java/io/swagger/client/auth/ApiKeyAuth.java
@@ -39,7 +39,7 @@ public void setApiKeyPrefix(String apiKeyPrefix) {
   }
 
   @Override
-  public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
     String value;
     if (apiKeyPrefix != null) {
       value = apiKeyPrefix + " " + apiKey;
diff --git a/samples/client/petstore/java/src/main/java/io/swagger/client/auth/Authentication.java b/samples/client/petstore/java/src/main/java/io/swagger/client/auth/Authentication.java
@@ -3,5 +3,6 @@
 import java.util.Map;
 
 public interface Authentication {
-  void processParams(Map<String, String> queryParams, Map<String, String> headerParams);
+  /** Apply authentication settings to header and query params. */
+  void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams);
 }
diff --git a/samples/client/petstore/java/src/main/java/io/swagger/client/auth/HttpBasicAuth.java b/samples/client/petstore/java/src/main/java/io/swagger/client/auth/HttpBasicAuth.java
@@ -26,7 +26,7 @@ public void setPassword(String password) {
   }
 
   @Override
-  public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
     try {
       headerParams.put("Authorization", "Basic " + DatatypeConverter.printBase64Binary((username + ":" + password).getBytes("UTF-8")));
     } catch (UnsupportedEncodingException e) {
diff --git a/samples/client/petstore/java/src/main/java/io/swagger/client/auth/OAuth.java b/samples/client/petstore/java/src/main/java/io/swagger/client/auth/OAuth.java
@@ -4,7 +4,7 @@
 
 public class OAuth implements Authentication {
   @Override
-  public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {
+  public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {
     // TODO: support oauth
   }
 }
diff --git a/samples/client/petstore/java/src/test/java/io/swagger/client/auth/ApiKeyAuthTest.java b/samples/client/petstore/java/src/test/java/io/swagger/client/auth/ApiKeyAuthTest.java
@@ -8,13 +8,13 @@
 
 public class ApiKeyAuthTest {
   @Test
-  public void testProcessParamsInQuery() {
+  public void testApplyToParamsInQuery() {
     Map<String, String> queryParams = new HashMap<String, String>();
     Map<String, String> headerParams = new HashMap<String, String>();
 
     ApiKeyAuth auth = new ApiKeyAuth("query", "api_key");
     auth.setApiKey("my-api-key");
-    auth.processParams(queryParams, headerParams);
+    auth.applyToParams(queryParams, headerParams);
 
     assertEquals(1, queryParams.size());
     assertEquals("my-api-key", queryParams.get("api_key"));
@@ -23,14 +23,14 @@ public void testProcessParamsInQuery() {
   }
 
   @Test
-  public void testProcessParamsInHeaderWithPrefix() {
+  public void testApplyToParamsInHeaderWithPrefix() {
     Map<String, String> queryParams = new HashMap<String, String>();
     Map<String, String> headerParams = new HashMap<String, String>();
 
     ApiKeyAuth auth = new ApiKeyAuth("header", "X-API-TOKEN");
     auth.setApiKey("my-api-token");
     auth.setApiKeyPrefix("Token");
-    auth.processParams(queryParams, headerParams);
+    auth.applyToParams(queryParams, headerParams);
 
     // no changes to query parameters
     assertEquals(0, queryParams.size());
diff --git a/samples/client/petstore/java/src/test/java/io/swagger/client/auth/HttpBasicAuthTest.java b/samples/client/petstore/java/src/test/java/io/swagger/client/auth/HttpBasicAuthTest.java
@@ -15,13 +15,13 @@ public void setup() {
   }
 
   @Test
-  public void testProcessParams() {
+  public void testApplyToParams() {
     Map<String, String> queryParams = new HashMap<String, String>();
     Map<String, String> headerParams = new HashMap<String, String>();
 
     auth.setUsername("my-username");
     auth.setPassword("my-password");
-    auth.processParams(queryParams, headerParams);
+    auth.applyToParams(queryParams, headerParams);
 
     // no changes to query parameters
     assertEquals(0, queryParams.size());

Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@ public class ApiInvoker {`
`166`	`166`	`}`
`167`	`167`
`168`	`168`	`public String invokeAPI(String host, String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String contentType, String[] authNames) throws ApiException {`
`169`		`- processAuthParams(authNames, queryParams, headerParams);`
	`169`	`+ updateParamsForAuth(authNames, queryParams, headerParams);`
`170`	`170`
`171`	`171`	`Client client = getClient(host);`
`172`	`172`
`@@ -266,11 +266,12 @@ public class ApiInvoker {`
`266`	`266`	`}`
`267`	`267`	`}`
`268`	`268`
`269`		`- private void processAuthParams(String[] authNames, Map<String, String> queryParams, Map<String, String> headerParams) {`
	`269`	`+ /* Update hearder and query params based on authentication settings. */`
	`270`	`+ private void updateParamsForAuth(String[] authNames, Map<String, String> queryParams, Map<String, String> headerParams) {`
`270`	`271`	`for (String authName : authNames) {`
`271`	`272`	`Authentication auth = Configuration.getAuthentication(authName);`
`272`	`273`	`if (auth == null) throw new RuntimeException("Authentication has not been setup for " + authName);`
`273`		`- auth.processParams(queryParams, headerParams);`
	`274`	`+ auth.applyToParams(queryParams, headerParams);`
`274`	`275`	`}`
`275`	`276`	`}`
`276`	`277`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public class ApiKeyAuth implements Authentication {`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`@Override`
`42`		`- public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
	`42`	`+ public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
`43`	`43`	`String value;`
`44`	`44`	`if (apiKeyPrefix != null) {`
`45`	`45`	`value = apiKeyPrefix + " " + apiKey;`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,6 @@ package {{invokerPackage}}.auth;`
`3`	`3`	`import java.util.Map;`
`4`	`4`
`5`	`5`	`public interface Authentication {`
`6`		`- void processParams(Map<String, String> queryParams, Map<String, String> headerParams);`
	`6`	`+ /** Apply authentication settings to header and query params. */`
	`7`	`+ void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams);`
`7`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public class HttpBasicAuth implements Authentication {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`@Override`
`29`		`- public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
	`29`	`+ public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
`30`	`30`	`try {`
`31`	`31`	`headerParams.put("Authorization", "Basic " + DatatypeConverter.printBase64Binary((username + ":" + password).getBytes("UTF-8")));`
`32`	`32`	`} catch (UnsupportedEncodingException e) {`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@ import java.util.Map;`
`4`	`4`
`5`	`5`	`public class OAuth implements Authentication {`
`6`	`6`	`@Override`
`7`		`- public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
	`7`	`+ public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
`8`	`8`	`// TODO: support oauth`
`9`	`9`	`}`
`10`	`10`	`}`
Original file line number	Diff line number	Diff line change
`@@ -166,7 +166,7 @@ public static String serialize(Object obj) throws ApiException {`
`166`	`166`	`}`
`167`	`167`
`168`	`168`	`public String invokeAPI(String host, String path, String method, Map<String, String> queryParams, Object body, Map<String, String> headerParams, Map<String, String> formParams, String contentType, String[] authNames) throws ApiException {`
`169`		`- processAuthParams(authNames, queryParams, headerParams);`
	`169`	`+ updateParamsForAuth(authNames, queryParams, headerParams);`
`170`	`170`
`171`	`171`	`Client client = getClient(host);`
`172`	`172`
`@@ -266,11 +266,12 @@ else if(response.getClientResponseStatus().getFamily() == Family.SUCCESSFUL) {`
`266`	`266`	`}`
`267`	`267`	`}`
`268`	`268`
`269`		`- private void processAuthParams(String[] authNames, Map<String, String> queryParams, Map<String, String> headerParams) {`
	`269`	`+ /* Update hearder and query params based on authentication settings. */`
	`270`	`+ private void updateParamsForAuth(String[] authNames, Map<String, String> queryParams, Map<String, String> headerParams) {`
`270`	`271`	`for (String authName : authNames) {`
`271`	`272`	`Authentication auth = Configuration.getAuthentication(authName);`
`272`	`273`	`if (auth == null) throw new RuntimeException("Authentication has not been setup for " + authName);`
`273`		`- auth.processParams(queryParams, headerParams);`
	`274`	`+ auth.applyToParams(queryParams, headerParams);`
`274`	`275`	`}`
`275`	`276`	`}`
`276`	`277`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ public void setApiKeyPrefix(String apiKeyPrefix) {`
`39`	`39`	`}`
`40`	`40`
`41`	`41`	`@Override`
`42`		`- public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
	`42`	`+ public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
`43`	`43`	`String value;`
`44`	`44`	`if (apiKeyPrefix != null) {`
`45`	`45`	`value = apiKeyPrefix + " " + apiKey;`
Original file line number	Diff line number	Diff line change
`@@ -3,5 +3,6 @@`
`3`	`3`	`import java.util.Map;`
`4`	`4`
`5`	`5`	`public interface Authentication {`
`6`		`- void processParams(Map<String, String> queryParams, Map<String, String> headerParams);`
	`6`	`+ /** Apply authentication settings to header and query params. */`
	`7`	`+ void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams);`
`7`	`8`	`}`
Original file line number	Diff line number	Diff line change
`@@ -26,7 +26,7 @@ public void setPassword(String password) {`
`26`	`26`	`}`
`27`	`27`
`28`	`28`	`@Override`
`29`		`- public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
	`29`	`+ public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
`30`	`30`	`try {`
`31`	`31`	`headerParams.put("Authorization", "Basic " + DatatypeConverter.printBase64Binary((username + ":" + password).getBytes("UTF-8")));`
`32`	`32`	`} catch (UnsupportedEncodingException e) {`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`public class OAuth implements Authentication {`
`6`	`6`	`@Override`
`7`		`- public void processParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
	`7`	`+ public void applyToParams(Map<String, String> queryParams, Map<String, String> headerParams) {`
`8`	`8`	`// TODO: support oauth`
`9`	`9`	`}`
`10`	`10`	`}`