[JavaScript] Fix licenseNames (#6605)

* [JavaScript] Fix licenseName in package.mustache * Fix invalid SPDX license expression in resources/2_0 * Update JavaScript samples
swagger-api · Oct 8, 2017 · 1f9f8c5 · 1f9f8c5
1 parent 8a7940f
commit 1f9f8c5
Show file tree

Hide file tree

Showing 57 changed files with 1,820 additions and 87 deletions.
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
@@ -52,7 +52,6 @@ public class JavascriptClientCodegen extends DefaultCodegen implements CodegenCo
     public static final String MODULE_NAME = "moduleName";
     public static final String PROJECT_DESCRIPTION = "projectDescription";
     public static final String PROJECT_VERSION = "projectVersion";
-    public static final String PROJECT_LICENSE_NAME = "projectLicenseName";
     public static final String USE_PROMISES = "usePromises";
     public static final String USE_INHERITANCE = "useInheritance";
     public static final String EMIT_MODEL_METHODS = "emitModelMethods";
@@ -84,7 +83,7 @@ public class JavascriptClientCodegen extends DefaultCodegen implements CodegenCo
     protected String moduleName;
     protected String projectDescription;
     protected String projectVersion;
-    protected String projectLicenseName;
+    protected String licenseName;
 
     protected String invokerPackage;
     protected String sourceFolder = "src";
@@ -179,7 +178,7 @@ public JavascriptClientCodegen() {
                 "description of the project (Default: using info.description or \"Client library of <projectName>\")"));
         cliOptions.add(new CliOption(PROJECT_VERSION,
                 "version of the project (Default: using info.version or \"1.0.0\")"));
-        cliOptions.add(new CliOption(PROJECT_LICENSE_NAME,
+        cliOptions.add(new CliOption(CodegenConstants.LICENSE_NAME,
                 "name of the license the project uses (Default: using info.license.name)"));
         cliOptions.add(new CliOption(USE_PROMISES,
                 "use Promises as return values from the client API, instead of superagent callbacks")
@@ -244,8 +243,8 @@ public void processOpts() {
         if (additionalProperties.containsKey(PROJECT_VERSION)) {
             setProjectVersion(((String) additionalProperties.get(PROJECT_VERSION)));
         }
-        if (additionalProperties.containsKey(PROJECT_LICENSE_NAME)) {
-            setProjectLicenseName(((String) additionalProperties.get(PROJECT_LICENSE_NAME)));
+        if (additionalProperties.containsKey(CodegenConstants.LICENSE_NAME)) {
+            setLicenseName(((String) additionalProperties.get(CodegenConstants.LICENSE_NAME)));
         }
         if (additionalProperties.containsKey(CodegenConstants.LOCAL_VARIABLE_PREFIX)) {
             setLocalVariablePrefix((String) additionalProperties.get(CodegenConstants.LOCAL_VARIABLE_PREFIX));
@@ -291,12 +290,11 @@ public void preprocessSwagger(Swagger swagger) {
                 // when projectDescription is not specified, use info.description
                 projectDescription = sanitizeName(info.getDescription());
             }
-            if (additionalProperties.get(PROJECT_LICENSE_NAME) == null) {
-                // when projectLicense is not specified, use info.license
-                if (info.getLicense() != null) {
-                    License license = info.getLicense();
-                    additionalProperties.put(PROJECT_LICENSE_NAME, sanitizeName(license.getName()));
-                }
+
+            // when licenceName is not specified, use info.license
+            if (additionalProperties.get(CodegenConstants.LICENSE_NAME) == null && info.getLicense() != null) {
+                License license = info.getLicense();
+                licenseName = license.getName();
             }
         }
 
@@ -313,11 +311,15 @@ public void preprocessSwagger(Swagger swagger) {
         if (projectDescription == null) {
             projectDescription = "Client library of " + projectName;
         }
+        if (StringUtils.isBlank(licenseName)) {
+            licenseName = "Unlicense";
+        }
 
         additionalProperties.put(PROJECT_NAME, projectName);
         additionalProperties.put(MODULE_NAME, moduleName);
         additionalProperties.put(PROJECT_DESCRIPTION, escapeText(projectDescription));
         additionalProperties.put(PROJECT_VERSION, projectVersion);
+        additionalProperties.put(CodegenConstants.LICENSE_NAME, licenseName);
         additionalProperties.put(CodegenConstants.API_PACKAGE, apiPackage);
         additionalProperties.put(CodegenConstants.INVOKER_PACKAGE, invokerPackage);
         additionalProperties.put(CodegenConstants.LOCAL_VARIABLE_PREFIX, localVariablePrefix);
@@ -422,8 +424,8 @@ public void setProjectVersion(String projectVersion) {
         this.projectVersion = projectVersion;
     }
 
-    public void setProjectLicenseName(String projectLicenseName) {
-        this.projectLicenseName = projectLicenseName;
+    public void setLicenseName(String licenseName) {
+        this.licenseName = licenseName;
     }
 
     public void setUsePromises(boolean usePromises) {

diff --git a/modules/swagger-codegen/src/main/resources/Javascript/es6/package.mustache b/modules/swagger-codegen/src/main/resources/Javascript/es6/package.mustache
@@ -2,7 +2,7 @@
   "name": "{{{projectName}}}",
   "version": "{{{projectVersion}}}",
   "description": "{{{projectDescription}}}",
-  "license": "Unlicense",
+  "license": "{{licenseName}}",
   "main": "{{sourceFolder}}{{#invokerPackage}}/{{invokerPackage}}{{/invokerPackage}}/index.js",
   "scripts": {
     "test": "mocha --compilers js:babel-core/register --recursive"

diff --git a/modules/swagger-codegen/src/main/resources/Javascript/package.mustache b/modules/swagger-codegen/src/main/resources/Javascript/package.mustache
@@ -2,7 +2,7 @@
   "name": "{{{projectName}}}",
   "version": "{{{projectVersion}}}",
   "description": "{{{projectDescription}}}",
-  "license": "Unlicense",
+  "license": "{{licenseName}}",
   "main": "{{sourceFolder}}{{#invokerPackage}}/{{invokerPackage}}{{/invokerPackage}}/index.js",
   "scripts": {
     "test": "./node_modules/mocha/bin/mocha --recursive"

diff --git a/...gger-codegen/src/test/java/io/swagger/codegen/javascript/JavaScriptClientOptionsTest.java b/...gger-codegen/src/test/java/io/swagger/codegen/javascript/JavaScriptClientOptionsTest.java
@@ -58,7 +58,7 @@ protected void setExpectations() {
             times = 1;
             clientCodegen.setProjectVersion(JavaScriptOptionsProvider.PROJECT_VERSION_VALUE);
             times = 1;
-            clientCodegen.setProjectLicenseName(JavaScriptOptionsProvider.PROJECT_LICENSE_NAME_VALUE);
+            clientCodegen.setLicenseName(JavaScriptOptionsProvider.PROJECT_LICENSE_NAME_VALUE);
             times = 1;
             clientCodegen.setUsePromises(Boolean.valueOf(JavaScriptOptionsProvider.USE_PROMISES_VALUE));
             times = 1;

diff --git a/...s/swagger-codegen/src/test/java/io/swagger/codegen/options/JavaScriptOptionsProvider.java b/...s/swagger-codegen/src/test/java/io/swagger/codegen/options/JavaScriptOptionsProvider.java
@@ -1,7 +1,6 @@
 package io.swagger.codegen.options;
 
 import io.swagger.codegen.CodegenConstants;
-import io.swagger.codegen.options.OptionsProvider;
 import io.swagger.codegen.languages.JavascriptClientCodegen;
 
 import com.google.common.collect.ImmutableMap;
@@ -56,7 +55,7 @@ public JavaScriptOptionsProvider() {
                 .put(JavascriptClientCodegen.MODULE_NAME, MODULE_NAME_VALUE)
                 .put(JavascriptClientCodegen.PROJECT_DESCRIPTION, PROJECT_DESCRIPTION_VALUE)
                 .put(JavascriptClientCodegen.PROJECT_VERSION, PROJECT_VERSION_VALUE)
-                .put(JavascriptClientCodegen.PROJECT_LICENSE_NAME, PROJECT_LICENSE_NAME_VALUE)
+                .put(CodegenConstants.LICENSE_NAME, PROJECT_LICENSE_NAME_VALUE)
                 .put(JavascriptClientCodegen.USE_PROMISES, USE_PROMISES_VALUE)
                 .put(JavascriptClientCodegen.USE_INHERITANCE, USE_INHERITANCE_VALUE)
                 .put(JavascriptClientCodegen.EMIT_MODEL_METHODS, EMIT_MODEL_METHODS_VALUE)

diff --git a/modules/swagger-codegen/src/test/resources/2_0/binaryDataTest.json b/modules/swagger-codegen/src/test/resources/2_0/binaryDataTest.json
@@ -6,7 +6,7 @@
     "title": "Swagger Petstore",
     "termsOfService": "http://helloreverb.com/terms/",
     "license": {
-      "name": "Apache 2.0",
+      "name": "Apache-2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     }
   },

diff --git a/modules/swagger-codegen/src/test/resources/2_0/datePropertyTest.json b/modules/swagger-codegen/src/test/resources/2_0/datePropertyTest.json
@@ -6,7 +6,7 @@
     "title": "Swagger Petstore",
     "termsOfService": "http://helloreverb.com/terms/",
     "license": {
-      "name": "Apache 2.0",
+      "name": "Apache-2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     }
   },

diff --git a/modules/swagger-codegen/src/test/resources/2_0/fileResponseTest.json b/modules/swagger-codegen/src/test/resources/2_0/fileResponseTest.json
@@ -4,7 +4,7 @@
     "version": "1.0.0",
     "title": "File Response Test",
     "license": {
-      "name": "Apache 2.0",
+      "name": "Apache-2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     }
   },

diff --git a/modules/swagger-codegen/src/test/resources/2_0/globalConsumesAndProduces.json b/modules/swagger-codegen/src/test/resources/2_0/globalConsumesAndProduces.json
@@ -9,7 +9,7 @@
       "email": "[email protected]"
     },
     "license": {
-      "name": "Apache 2.0",
+      "name": "Apache-2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     }
   },

diff --git a/modules/swagger-codegen/src/test/resources/2_0/globalSecurity.json b/modules/swagger-codegen/src/test/resources/2_0/globalSecurity.json
@@ -9,7 +9,7 @@
       "email": "[email protected]"
     },
     "license": {
-      "name": "Apache 2.0",
+      "name": "Apache-2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     }
   },

diff --git a/modules/swagger-codegen/src/test/resources/2_0/petstore-bash.json b/modules/swagger-codegen/src/test/resources/2_0/petstore-bash.json
@@ -9,7 +9,7 @@
          "email":"[email protected]"
       },
       "license":{  
-         "name":"Apache 2.0",
+         "name":"Apache-2.0",
          "url":"http://www.apache.org/licenses/LICENSE-2.0.html"
       }
    },
@@ -1053,4 +1053,4 @@
       "description":"Find out more about Swagger",
       "url":"http://swagger.io"
    }
-}
+}
diff --git a/modules/swagger-codegen/src/test/resources/2_0/petstore-orig.json b/modules/swagger-codegen/src/test/resources/2_0/petstore-orig.json
@@ -9,7 +9,7 @@
       "email": "[email protected]"
     },
     "license": {
-      "name": "Apache 2.0",
+      "name": "Apache-2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     }
   },

diff --git a/modules/swagger-codegen/src/test/resources/2_0/petstore-security-test.yaml b/modules/swagger-codegen/src/test/resources/2_0/petstore-security-test.yaml
@@ -7,7 +7,7 @@ info:
   contact:
     email: [email protected] */ ' " =end -- \r\n \n \r
   license:
-    name: Apache 2.0 */ ' " =end -- \r\n \n \r
+    name: Apache-2.0 */ ' " =end -- \r\n \n \r
     url: http://www.apache.org/licenses/LICENSE-2.0.html */ ' " =end -- \r\n \n \r
 host: petstore.swagger.io */ ' " =end -- \r\n \n \r
 basePath: /v2 */ ' " =end -- \r\n \n \r

diff --git a/modules/swagger-codegen/src/test/resources/2_0/petstore-vendor-mime.yaml b/modules/swagger-codegen/src/test/resources/2_0/petstore-vendor-mime.yaml
@@ -7,7 +7,7 @@ info:
   contact:
     email: [email protected] 
   license:
-    name: Apache 2.0 
+    name: Apache-2.0
     url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
 host: petstore.swagger.io 
 basePath: /v2 

diff --git a/...agger-codegen/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml b/...agger-codegen/src/test/resources/2_0/petstore-with-fake-endpoints-models-for-testing.yaml
@@ -7,7 +7,7 @@ info:
   contact:
     email: [email protected]
   license:
-    name: Apache 2.0
+    name: Apache-2.0
     url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
 host: petstore.swagger.io:80
 basePath: /v2

diff --git a/modules/swagger-codegen/src/test/resources/2_0/petstore.json b/modules/swagger-codegen/src/test/resources/2_0/petstore.json
@@ -9,7 +9,7 @@
       "email": "[email protected]"
     },
     "license": {
-      "name": "Apache 2.0",
+      "name": "Apache-2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     }
   },

diff --git a/modules/swagger-codegen/src/test/resources/2_0/petstore.yaml b/modules/swagger-codegen/src/test/resources/2_0/petstore.yaml
@@ -7,7 +7,7 @@ info:
   contact:
     email: [email protected]
   license:
-    name: Apache 2.0
+    name: Apache-2.0
     url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
 host: petstore.swagger.io
 basePath: /v2

diff --git a/modules/swagger-codegen/src/test/resources/2_0/postBodyTest.json b/modules/swagger-codegen/src/test/resources/2_0/postBodyTest.json
@@ -9,7 +9,7 @@
       "name": "[email protected]"
     },
     "license": {
-      "name": "Apache 2.0",
+      "name": "Apache-2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     }
   },
@@ -99,4 +99,4 @@
       }
     }
   }
-}
+}
diff --git a/modules/swagger-codegen/src/test/resources/2_0/requiredTest.json b/modules/swagger-codegen/src/test/resources/2_0/requiredTest.json
@@ -9,7 +9,7 @@
       "email": "[email protected]"
     },
     "license": {
-      "name": "Apache 2.0",
+      "name": "Apache-2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     }
   },
@@ -92,4 +92,4 @@
       }
     }
   }
-}
+}
diff --git a/modules/swagger-codegen/src/test/resources/2_0/responseHeaderTest.yaml b/modules/swagger-codegen/src/test/resources/2_0/responseHeaderTest.yaml
@@ -4,7 +4,7 @@ info:
   version: 1.0.0
   title: Response header test
   license:
-    name: Apache 2.0
+    name: Apache-2.0
     url: 'http://www.apache.org/licenses/LICENSE-2.0.html'
 basePath: /
 schemes:
@@ -38,4 +38,4 @@ paths:
               type: "integer"
               description: "I am the error code"
         '400':
-          description: Invalid ID supplied
+          description: Invalid ID supplied
diff --git a/modules/swagger-codegen/src/test/resources/2_0/responseSelectionTest.json b/modules/swagger-codegen/src/test/resources/2_0/responseSelectionTest.json
@@ -9,7 +9,7 @@
       "email": "[email protected]"
     },
     "license": {
-      "name": "Apache 2.0",
+      "name": "Apache-2.0",
       "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
     }
   },
@@ -138,4 +138,4 @@
       }
     }
   }
-}
+}
diff --git a/samples/client/petstore/javascript-es6/README.md b/samples/client/petstore/javascript-es6/README.md
@@ -70,11 +70,10 @@ Please follow the [installation](#installation) instruction and execute the foll
 ```javascript
 var SwaggerPetstore = require('swagger_petstore');
 
-var api = new SwaggerPetstore.FakeApi()
+var api = new SwaggerPetstore.AnotherFakeApi()
+
+var body = new SwaggerPetstore.Client(); // {Client} client model
 
-var opts = { 
-  'body': new SwaggerPetstore.OuterBoolean() // {OuterBoolean} Input boolean as post body
-};
 
 var callback = function(error, data, response) {
   if (error) {
@@ -83,7 +82,7 @@ var callback = function(error, data, response) {
     console.log('API called successfully. Returned data: ' + data);
   }
 };
-api.fakeOuterBooleanSerialize(opts, callback);
+api.testSpecialTags(body, callback);
 
 ```
 
@@ -93,6 +92,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
 
 Class | Method | HTTP request | Description
 ------------ | ------------- | ------------- | -------------
+*SwaggerPetstore.AnotherFakeApi* | [**testSpecialTags**](docs/AnotherFakeApi.md#testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags
 *SwaggerPetstore.FakeApi* | [**fakeOuterBooleanSerialize**](docs/FakeApi.md#fakeOuterBooleanSerialize) | **POST** /fake/outer/boolean | 
 *SwaggerPetstore.FakeApi* | [**fakeOuterCompositeSerialize**](docs/FakeApi.md#fakeOuterCompositeSerialize) | **POST** /fake/outer/composite | 
 *SwaggerPetstore.FakeApi* | [**fakeOuterNumberSerialize**](docs/FakeApi.md#fakeOuterNumberSerialize) | **POST** /fake/outer/number | 
@@ -101,7 +101,7 @@ Class | Method | HTTP request | Description
 *SwaggerPetstore.FakeApi* | [**testEndpointParameters**](docs/FakeApi.md#testEndpointParameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 
 *SwaggerPetstore.FakeApi* | [**testEnumParameters**](docs/FakeApi.md#testEnumParameters) | **GET** /fake | To test enum parameters
 *SwaggerPetstore.FakeApi* | [**testJsonFormData**](docs/FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data
-*SwaggerPetstore.Fake_classname_tags123Api* | [**testClassname**](docs/Fake_classname_tags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case
+*SwaggerPetstore.FakeClassnameTags123Api* | [**testClassname**](docs/FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case
 *SwaggerPetstore.PetApi* | [**addPet**](docs/PetApi.md#addPet) | **POST** /pet | Add a new pet to the store
 *SwaggerPetstore.PetApi* | [**deletePet**](docs/PetApi.md#deletePet) | **DELETE** /pet/{petId} | Deletes a pet
 *SwaggerPetstore.PetApi* | [**findPetsByStatus**](docs/PetApi.md#findPetsByStatus) | **GET** /pet/findByStatus | Finds Pets by status