Merge pull request #1928 from ergon/feature/retrofit2-rx

Feature/retrofit2 rx
swagger-api · Jan 26, 2016 · afd451e · afd451e
2 parents fc88cb9 + e347063
commit afd451e
Show file tree

Hide file tree

Showing 41 changed files with 2,906 additions and 103 deletions.
diff --git a/bin/java-petstore-retrofit2rx.json b/bin/java-petstore-retrofit2rx.json
@@ -0,0 +1,4 @@
+{
+  "library": "retrofit2",
+  "artifactId": "swagger-petstore-retrofit2-rx"
+}
diff --git a/bin/java-petstore-retrofit2rx.sh b/bin/java-petstore-retrofit2rx.sh
@@ -0,0 +1,31 @@
+#!/bin/sh
+
+SCRIPT="$0"
+
+while [ -h "$SCRIPT" ] ; do
+  ls=`ls -ld "$SCRIPT"`
+  link=`expr "$ls" : '.*-> \(.*\)$'`
+  if expr "$link" : '/.*' > /dev/null; then
+    SCRIPT="$link"
+  else
+    SCRIPT=`dirname "$SCRIPT"`/"$link"
+  fi
+done
+
+if [ ! -d "${APP_DIR}" ]; then
+  APP_DIR=`dirname "$SCRIPT"`/..
+  APP_DIR=`cd "${APP_DIR}"; pwd`
+fi
+
+executable="./modules/swagger-codegen-cli/target/swagger-codegen-cli.jar"
+
+if [ ! -f "$executable" ]
+then
+  mvn clean package
+fi
+
+# if you've executed sbt assembly previously it will use that instead.
+export JAVA_OPTS="${JAVA_OPTS} -XX:MaxPermSize=256M -Xmx1024M -DloggerPath=conf/log4j.properties"
+ags="$@ generate -i modules/swagger-codegen/src/test/resources/2_0/petstore.json -l java -c bin/java-petstore-retrofit2rx.json -o samples/client/petstore/java/retrofit2rx -DuseRxJava=true"
+
+java $JAVA_OPTS -jar $executable $ags
diff --git a/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavaClientCodegen.java b/modules/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavaClientCodegen.java
@@ -1,27 +1,56 @@
 package io.swagger.codegen.languages;
 
 import com.google.common.base.Strings;
-import io.swagger.codegen.*;
+
+import org.apache.commons.lang.StringUtils;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.File;
+import java.util.ArrayList;
+import java.util.Arrays;
+import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Iterator;
+import java.util.List;
+import java.util.Map;
+
+import io.swagger.codegen.CliOption;
+import io.swagger.codegen.CodegenConfig;
+import io.swagger.codegen.CodegenConstants;
+import io.swagger.codegen.CodegenModel;
+import io.swagger.codegen.CodegenOperation;
+import io.swagger.codegen.CodegenParameter;
+import io.swagger.codegen.CodegenProperty;
+import io.swagger.codegen.CodegenType;
+import io.swagger.codegen.DefaultCodegen;
+import io.swagger.codegen.SupportingFile;
 import io.swagger.models.Model;
 import io.swagger.models.Operation;
 import io.swagger.models.Path;
 import io.swagger.models.Swagger;
 import io.swagger.models.parameters.FormParameter;
 import io.swagger.models.parameters.Parameter;
-import io.swagger.models.properties.*;
-import org.apache.commons.lang.StringUtils;
-import org.slf4j.Logger;
-import org.slf4j.LoggerFactory;
-
-import java.io.File;
-import java.util.*;
+import io.swagger.models.properties.ArrayProperty;
+import io.swagger.models.properties.BooleanProperty;
+import io.swagger.models.properties.DoubleProperty;
+import io.swagger.models.properties.FloatProperty;
+import io.swagger.models.properties.IntegerProperty;
+import io.swagger.models.properties.LongProperty;
+import io.swagger.models.properties.MapProperty;
+import io.swagger.models.properties.Property;
+import io.swagger.models.properties.StringProperty;
 
 public class JavaClientCodegen extends DefaultCodegen implements CodegenConfig {
     @SuppressWarnings("hiding")
     private static final Logger LOGGER = LoggerFactory.getLogger(JavaClientCodegen.class);
     public static final String FULL_JAVA_UTIL = "fullJavaUtil";
     public static final String DEFAULT_LIBRARY = "<default>";
     public static final String DATE_LIBRARY = "dateLibrary";
+    public static final String USE_RX_JAVA = "useRxJava";
+
+    public static final String RETROFIT_1 = "retrofit";
+    public static final String RETROFIT_2 = "retrofit2";
 
     protected String dateLibrary = "default";
     protected String invokerPackage = "io.swagger.client";
@@ -35,6 +64,7 @@ public class JavaClientCodegen extends DefaultCodegen implements CodegenConfig {
     protected String javaUtilPrefix = "";
     protected Boolean serializableModel = false;
     protected boolean serializeBigDecimalAsString = false;
+    protected boolean useRxJava = false;
 
     public JavaClientCodegen() {
         super();
@@ -88,13 +118,15 @@ public JavaClientCodegen() {
         cliOptions.add(CliOption.newBoolean(CodegenConstants.SERIALIZE_BIG_DECIMAL_AS_STRING, CodegenConstants
                 .SERIALIZE_BIG_DECIMAL_AS_STRING_DESC));
         cliOptions.add(CliOption.newBoolean(FULL_JAVA_UTIL, "whether to use fully qualified name for classes under java.util"));
+        cliOptions.add(CliOption.newBoolean(USE_RX_JAVA, "Whether to use the RxJava adapter with the retrofit2 library."));
 
         supportedLibraries.put(DEFAULT_LIBRARY, "HTTP client: Jersey client 1.18. JSON processing: Jackson 2.4.2");
         supportedLibraries.put("feign", "HTTP client: Netflix Feign 8.1.1");
         supportedLibraries.put("jersey2", "HTTP client: Jersey client 2.6");
         supportedLibraries.put("okhttp-gson", "HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1");
-        supportedLibraries.put("retrofit", "HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 (Retrofit 1.9.0)");
-        supportedLibraries.put("retrofit2", "HTTP client: OkHttp 2.5.0. JSON processing: Gson 2.4 (Retrofit 2.0.0-beta2)");
+        supportedLibraries.put(RETROFIT_1, "HTTP client: OkHttp 2.4.0. JSON processing: Gson 2.3.1 (Retrofit 1.9.0)");
+        supportedLibraries.put(RETROFIT_2, "HTTP client: OkHttp 2.5.0. JSON processing: Gson 2.4 (Retrofit 2.0.0-beta2). Enable the RxJava adapter using '-DuseRxJava=true'.");
+
         CliOption library = new CliOption(CodegenConstants.LIBRARY, "library template (sub-template) to use");
         library.setDefault(DEFAULT_LIBRARY);
         library.setEnum(supportedLibraries);
@@ -183,6 +215,10 @@ public void processOpts() {
         if (additionalProperties.containsKey(FULL_JAVA_UTIL)) {
             this.setFullJavaUtil(Boolean.valueOf(additionalProperties.get(FULL_JAVA_UTIL).toString()));
         }
+
+        if (additionalProperties.containsKey(USE_RX_JAVA)) {
+            this.setUseRxJava(Boolean.valueOf(additionalProperties.get(USE_RX_JAVA).toString()));
+        }
         if (fullJavaUtil) {
             javaUtilPrefix = "java.util.";
         }
@@ -240,7 +276,7 @@ public void processOpts() {
         supportingFiles.add(new SupportingFile("auth/OAuth.mustache", authFolder, "OAuth.java"));
         supportingFiles.add(new SupportingFile("auth/OAuthFlow.mustache", authFolder, "OAuthFlow.java"));
 
-        if (!("feign".equals(getLibrary()) || "retrofit".equals(getLibrary()) || "retrofit2".equals(getLibrary()))) {
+        if (!("feign".equals(getLibrary()) || usesAnyRetrofitLibrary())) {
             supportingFiles.add(new SupportingFile("apiException.mustache", invokerFolder, "ApiException.java"));
             supportingFiles.add(new SupportingFile("Configuration.mustache", invokerFolder, "Configuration.java"));
             supportingFiles.add(new SupportingFile("Pair.mustache", invokerFolder, "Pair.java"));
@@ -257,7 +293,7 @@ public void processOpts() {
             supportingFiles.add(new SupportingFile("ProgressResponseBody.mustache", invokerFolder, "ProgressResponseBody.java"));
             // "build.sbt" is for development with SBT
             supportingFiles.add(new SupportingFile("build.sbt.mustache", "", "build.sbt"));
-        } else if ("retrofit".equals(getLibrary()) || "retrofit2".equals(getLibrary())) {
+        } else if (usesAnyRetrofitLibrary()) {
             supportingFiles.add(new SupportingFile("auth/OAuthOkHttpClient.mustache", authFolder, "OAuthOkHttpClient.java"));
             supportingFiles.add(new SupportingFile("CollectionFormats.mustache", invokerFolder, "CollectionFormats.java"));
         } else if("jersey2".equals(getLibrary())) {
@@ -285,6 +321,14 @@ else if ("java8".equals(dateLibrary)) {
         }
     }
 
+    private boolean usesAnyRetrofitLibrary() {
+        return getLibrary() != null && getLibrary().contains(RETROFIT_1);
+    }
+
+    private boolean usesRetrofit2Library() {
+        return getLibrary() != null && getLibrary().contains(RETROFIT_2);
+    }
+
     private void sanitizeConfig() {
         // Sanitize any config options here. We also have to update the additionalProperties because
         // the whole additionalProperties object is injected into the main object passed to the mustache layer
@@ -598,7 +642,7 @@ public Map<String, Object> postProcessModels(Map<String, Object> objs) {
 
     @Override
     public Map<String, Object> postProcessOperations(Map<String, Object> objs) {
-        if("retrofit".equals(getLibrary()) || "retrofit2".equals(getLibrary())) {
+        if(usesAnyRetrofitLibrary()) {
             Map<String, Object> operations = (Map<String, Object>) objs.get("operations");
             if (operations != null) {
                 List<CodegenOperation> ops = (List<CodegenOperation>) operations.get("operation");
@@ -614,7 +658,7 @@ public Map<String, Object> postProcessOperations(Map<String, Object> objs) {
                     if (operation.returnType == null) {
                         operation.returnType = "Void";
                     }
-                    if ("retrofit2".equals(getLibrary()) && StringUtils.isNotEmpty(operation.path) && operation.path.startsWith("/"))
+                    if (usesRetrofit2Library() && StringUtils.isNotEmpty(operation.path) && operation.path.startsWith("/"))
                     	operation.path = operation.path.substring(1);
                 }
             }
@@ -792,6 +836,10 @@ public void setFullJavaUtil(boolean fullJavaUtil) {
         this.fullJavaUtil = fullJavaUtil;
     }
 
+    public void setUseRxJava(boolean useRxJava) {
+        this.useRxJava = useRxJava;
+    }
+
     public void setDateLibrary(String library) {
         this.dateLibrary = library;
     }

diff --git a/...s/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavascriptClientCodegen.java b/...s/swagger-codegen/src/main/java/io/swagger/codegen/languages/JavascriptClientCodegen.java
@@ -419,25 +419,6 @@ public Map<String, Object> postProcessModels(Map<String, Object> objs) {
 
     @Override
     public Map<String, Object> postProcessOperations(Map<String, Object> objs) {
-        if("retrofit".equals(getLibrary())) {
-            Map<String, Object> operations = (Map<String, Object>) objs.get("operations");
-            if (operations != null) {
-                List<CodegenOperation> ops = (List<CodegenOperation>) operations.get("operation");
-                for (CodegenOperation operation : ops) {
-                    if (operation.hasConsumes == Boolean.TRUE) {
-                        Map<String, String> firstType = operation.consumes.get(0);
-                        if (firstType != null) {
-                            if ("multipart/form-data".equals(firstType.get("mediaType"))) {
-                                operation.isMultipart = Boolean.TRUE;
-                            }
-                        }
-                    }
-                    if (operation.returnType == null) {
-                        operation.returnType = "Void";
-                    }
-                }
-            }
-        }
         return objs;
     }
 

diff --git a/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/ApiClient.mustache b/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/ApiClient.mustache
@@ -13,6 +13,7 @@ import org.apache.oltu.oauth2.client.request.OAuthClientRequest.TokenRequestBuil
 import retrofit.Converter;
 import retrofit.Retrofit;
 import retrofit.GsonConverterFactory;
+{{#useRxJava}}import retrofit.RxJavaCallAdapterFactory;{{/useRxJava}}
 
 import com.google.gson.Gson;
 import com.google.gson.GsonBuilder;
@@ -22,6 +23,7 @@ import com.squareup.okhttp.OkHttpClient;
 import com.squareup.okhttp.RequestBody;
 import com.squareup.okhttp.ResponseBody;
 
+
 import {{invokerPackage}}.auth.HttpBasicAuth;
 import {{invokerPackage}}.auth.ApiKeyAuth;
 import {{invokerPackage}}.auth.OAuth;
@@ -117,6 +119,7 @@ public class ApiClient {
                 .Builder()
                 .baseUrl(baseUrl)
                 .client(okClient)
+                {{#useRxJava}}.addCallAdapterFactory(RxJavaCallAdapterFactory.create()){{/useRxJava}}
                 .addConverterFactory(GsonCustomConverterFactory.create(gson));
     }
 

diff --git a/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/api.mustache b/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/api.mustache
@@ -2,8 +2,10 @@ package {{package}};
 
 import {{invokerPackage}}.CollectionFormats.*;
 
-import retrofit.Call;
+{{#useRxJava}}import rx.Observable;{{/useRxJava}}
+{{^useRxJava}}import retrofit.Call;{{/useRxJava}}
 import retrofit.http.*;
+
 import com.squareup.okhttp.RequestBody;
 
 {{#imports}}import {{import}};
@@ -25,7 +27,7 @@ public interface {{classname}} {
   {{#formParams}}{{#-first}}
   {{#isMultipart}}@Multipart{{/isMultipart}}{{^isMultipart}}@FormUrlEncoded{{/isMultipart}}{{/-first}}{{/formParams}}
   @{{httpMethod}}("{{path}}")
-  Call<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Object{{/returnType}}> {{operationId}}({{^allParams}});{{/allParams}}
+  {{#useRxJava}}Observable{{/useRxJava}}{{^useRxJava}}Call{{/useRxJava}}<{{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}Object{{/returnType}}> {{operationId}}({{^allParams}});{{/allParams}}
     {{#allParams}}{{>libraries/retrofit2/queryParams}}{{>libraries/retrofit2/pathParams}}{{>libraries/retrofit2/headerParams}}{{>libraries/retrofit2/bodyParams}}{{>libraries/retrofit2/formParams}}{{#hasMore}}, {{/hasMore}}{{^hasMore}}
   );{{/hasMore}}{{/allParams}}
 

diff --git a/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/build.gradle.mustache b/modules/swagger-codegen/src/main/resources/Java/libraries/retrofit2/build.gradle.mustache
@@ -20,7 +20,7 @@ if(hasProperty('target') && target == 'android') {
 
 	apply plugin: 'com.android.library'
 	apply plugin: 'com.github.dcendents.android-maven'
-	
+
 	android {
 	    compileSdkVersion 22
 	    buildToolsVersion '22.0.0'
@@ -32,7 +32,7 @@ if(hasProperty('target') && target == 'android') {
 	        sourceCompatibility JavaVersion.VERSION_1_7
 	        targetCompatibility JavaVersion.VERSION_1_7
 	    }
-	
+
 	    // Rename the aar correctly
 	    libraryVariants.all { variant ->
 	        variant.outputs.each { output ->
@@ -44,7 +44,7 @@ if(hasProperty('target') && target == 'android') {
 	        }
 	    }
 	}
-	
+
 	afterEvaluate {
 	    android.libraryVariants.all { variant ->
 	        def task = project.tasks.create "jar${variant.name.capitalize()}", Jar
@@ -56,12 +56,12 @@ if(hasProperty('target') && target == 'android') {
 	        artifacts.add('archives', task);
 	    }
 	}
-	
+
 	task sourcesJar(type: Jar) {
 	    from android.sourceSets.main.java.srcDirs
 	    classifier = 'sources'
 	}
-	
+
 	artifacts {
 	    archives sourcesJar
 	}
@@ -70,16 +70,16 @@ if(hasProperty('target') && target == 'android') {
 
 	apply plugin: 'java'
 	apply plugin: 'maven'
-	
-	sourceCompatibility = JavaVersion.VERSION_1_7
-	targetCompatibility = JavaVersion.VERSION_1_7
-	
+
+sourceCompatibility = JavaVersion.VERSION_1_7
+targetCompatibility = JavaVersion.VERSION_1_7
+
 	install {
 	    repositories.mavenInstaller {
 	        pom.artifactId = '{{artifactId}}'
 	    }
 	}
-	
+
 	task execute(type:JavaExec) {
 	   main = System.getProperty('mainClass')
 	   classpath = sourceSets.main.runtimeClasspath
@@ -93,14 +93,26 @@ ext {
     gson_version = "2.4"
     swagger_annotations_version = "1.5.0"
     junit_version = "4.12"
+{{#useRxJava}}
+    rx_java_version = "1.0.15"
+{{/useRxJava}}
+{{^useRxJava}}{{/useRxJava}}
 }
 
 dependencies {
     compile "com.squareup.okhttp:okhttp:$okhttp_version"
+
     compile "com.squareup.retrofit:retrofit:$retrofit_version"
-    compile "com.google.code.gson:gson:$gson_version"
     compile "com.squareup.retrofit:converter-gson:$retrofit_version"
+{{#useRxJava}}
+    compile "com.squareup.retrofit:adapter-rxjava:$retrofit_version"
+    compile "io.reactivex:rxjava:$rx_java_version"
+{{/useRxJava}}
+{{^useRxJava}}{{/useRxJava}}
+
+    compile "com.google.code.gson:gson:$gson_version"
     compile "io.swagger:swagger-annotations:$swagger_annotations_version"
     compile "org.apache.oltu.oauth2:org.apache.oltu.oauth2.client:$oltu_version"
+
     testCompile "junit:junit:$junit_version"
 }