Merge pull request #1 from swagger-api/master

Update our fork

Author: andylowry

.dockerignore

@@ -30,7 +30,7 @@ samples/client/petstore/qt5cpp/build-*
 samples/client/petstore/qt5cpp/PetStore/PetStore
 samples/client/petstore/qt5cpp/PetStore/Makefile
 samples/client/petstore/java/hello.txt
-samples/client/petstore/android-java/hello.txt
+samples/client/petstore/android/default/hello.txt
 samples/client/petstore/objc/Build
 samples/client/petstore/objc/Pods
 samples/server/petstore/nodejs/node_modules

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,46 @@
+<!--
+Please follow the issue template below for bug reports and feature requests.
+Also please indicate in the issue title which language/library is concerned. Eg:  [JAVA] Bug generating foo with bar 
+-->
+
+##### Description
+
+<!-- describe what is the issue and why this is a problem for you. -->
+
+##### Swagger-codegen version
+
+<!-- which version of swagger-codegen are you using, is it a regression? -->
+
+##### Swagger declaration file content or url
+
+<!-- if it is a bug, a json or yaml that produces it.
+    If you post the code inline, please wrap it with
+    ```yaml
+    (here your code)
+    ```
+    (for YAML code) or
+    ```json
+    (here your code)
+    ```
+    (for JSON code), so it becomes more readable. If it is longer than about ten lines,
+    please create a Gist (https://gist.github.com) or upload it somewhere else and
+    link it here.
+  -->
+
+##### Command line used for generation
+
+<!-- including the language, libraries and various options -->
+
+##### Steps to reproduce
+
+<!-- unambiguous set of steps to reproduce the bug.-->
+
+##### Related issues
+
+<!-- has a similar issue been reported before? -->
+
+##### Suggest a Fix
+
+<!-- if you can't fix the bug yourself, perhaps you can point to what might be
+  causing the problem (line of code or commit) -->
+

.gitignore

@@ -13,55 +13,130 @@ generated-sources/*
 generated-code/*
 *.swp
 *.swo
-*.csproj.user
+target
+.idea
+.lib
+atlassian-ide-plugin.xml
+.DS_Store
+packages/
+.pub
+.packages
+.vagrant/
+
+.settings
+
+*.mustache~
+*.java~
+*.pm~
+*.xml~
+*.t~
 
 /target
 /generated-files
 /nbactions.xml
-*.pyc
-__pycache__
+
+# scalatra
 samples/server-generator/scalatra/output
-samples/server-generator/node/output/node_modules
 samples/server-generator/scalatra/target
 samples/server-generator/scalatra/output/.history
+
+# nodejs
+**/node_modules
+samples/server-generator/node/output/node_modules
+samples/server/petstore/nodejs/node_modules
+samples/server/petstore/nodejs-server/node_modules
+
+# qt5 cpp
 samples/client/petstore/qt5cpp/PetStore/moc_*
 samples/client/petstore/qt5cpp/PetStore/*.o
-samples/client/petstore/objc/PetstoreClient.xcworkspace/xcuserdata
 samples/client/petstore/qt5cpp/build-*
 samples/client/petstore/qt5cpp/PetStore/PetStore
 samples/client/petstore/qt5cpp/PetStore/Makefile
+
+#Java/Android
+**/.gradle
 samples/client/petstore/java/hello.txt
-samples/client/petstore/android-java/hello.txt
-samples/client/petstore/objc/SwaggerClientTests/Build
-samples/client/petstore/objc/SwaggerClientTests/Pods
-samples/client/petstore/objc/SwaggerClientTests/SwaggerClient.xcworkspace
-samples/client/petstore/objc/SwaggerClientTests/Podfile.lock
-samples/server/petstore/nodejs/node_modules
-samples/client/petstore/csharp/SwaggerClientTest/.vs
-samples/client/petstore/csharp/SwaggerClientTest/obj
-samples/client/petstore/csharp/SwaggerClientTest/bin
-target
-.idea
-.lib
-atlassian-ide-plugin.xml
-.DS_Store
-packages/
-.pub
-.packages
+samples/client/petstore/java/okhttp-gson/hello.txt
+samples/client/petstore/java/jersey2-java8/hello.txt
+samples/client/petstore/android/default/hello.txt
+samples/client/petstore/android/volley/.gradle/
+samples/client/petstore/android/volley/build/
+samples/client/petstore/java/jersey2/.gradle/
+samples/client/petstore/java/jersey2/build/
+samples/client/petstore/java/okhttp-gson/.gradle/
+samples/client/petstore/java/okhttp-gson/build/
+samples/client/petstore/java/feign/build/
+samples/client/petstore/java/retrofit/build/
+samples/client/petstore/java/retrofit2/build/
+samples/client/petstore/java/retrofit2rx/build/
+samples/client/petstore/java/default/build/
+samples/client/petstore/scala/build/
 
+#PHP
 samples/client/petstore/php/SwaggerClient-php/composer.lock
 samples/client/petstore/php/SwaggerClient-php/vendor/
-
 samples/client/petstore/silex/SwaggerServer/composer.lock
 samples/client/petstore/silex/SwaggerServer/venodr/
+**/vendor/
+**/composer.lock
+
+# Perl
+samples/client/petstore/perl/deep_module_test/
+
+# Objc
+samples/client/petstore/objc/default/SwaggerClientTests/SwaggerClient.xcodeproj/xcuserdata
+samples/client/petstore/objc/default/SwaggerClientTests/Build
+samples/client/petstore/objc/default/SwaggerClientTests/Pods
+samples/client/petstore/objc/default/SwaggerClientTests/SwaggerClient.xcworkspace
+samples/client/petstore/objc/default/SwaggerClientTests/Podfile.lock
+
+samples/client/petstore/objc/core-data/SwaggerClientTests/SwaggerClient.xcodeproj/xcuserdata
+samples/client/petstore/objc/core-data/SwaggerClientTests/Build
+samples/client/petstore/objc/core-data/SwaggerClientTests/Pods
+samples/client/petstore/objc/core-data/SwaggerClientTests/SwaggerClient.xcworkspace
+samples/client/petstore/objc/core-data/SwaggerClientTests/Podfile.lock
 
+# Swift
+samples/client/petstore/swift/SwaggerClientTests/SwaggerClient.xcodeproj/xcuserdata
+samples/client/petstore/swift/SwaggerClientTests/SwaggerClient.xcworkspace/xcuserdata
+samples/client/petstore/swift/SwaggerClientTests/Pods/Pods.xcodeproj/xcuserdata
+samples/client/petstore/swift/SwaggerClientTests/Pods/Pods.xcodeproj/xcshareddata/xcschemes
+samples/client/petstore/swift/**/SwaggerClientTests/Podfile.lock 
+
+# C#
+*.csproj.user
+samples/client/petstore/csharp/SwaggerClient/IO.Swagger.userprefs
+samples/client/petstore/csharp/SwaggerClientTest/.vs
+samples/client/petstore/csharp/SwaggerClientTest/obj
+samples/client/petstore/csharp/SwaggerClientTest/bin
+samples/client/petstore/csharp/SwaggerClientTest/packages
+samples/client/petstore/csharp/SwaggerClientTest/bin/Debug/
+samples/client/petstore/csharp/SwaggerClientTest/obj/Debug/
+samples/client/petstore/csharp/SwaggerClientTest/TestResult.xml
+samples/client/petstore/csharp/SwaggerClientTest/nuget.exe
+samples/client/petstore/csharp/SwaggerClientTest/testrunner/
+samples/client/petstore/csharp/SwaggerClient/.vs
+samples/client/petstore/csharp/SwaggerClient/nuget.exe
+samples/client/petstore/csharp/SwaggerClient/obj
+samples/client/petstore/csharp/SwaggerClient/bin
+samples/client/petstore/csharp/SwaggerClient/obj/Debug/
+samples/client/petstore/csharp/SwaggerClient/bin/Debug/
+samples/client/petstore/csharp/SwaggerClient/packages
+samples/client/petstore/csharp/SwaggerClient/TestResult.xml
+
+# Python
+*.pyc
+__pycache__
+samples/client/petstore/python/dev-requirements.txt.log
+samples/client/petstore/python/swagger_client.egg-info/SOURCES.txt
+samples/client/petstore/python/.coverage
 samples/client/petstore/python/.projectile
 samples/client/petstore/python/.venv/
 
-.settings
+# ts
+samples/client/petstore/typescript-node/npm/node_modules
+samples/client/petstore/typescript-node/**/typings
+samples/client/petstore/typescript-angular/**/typings
+samples/client/petstore/typescript-fetch/**/dist/
+samples/client/petstore/typescript-fetch/**/typings
 
-*.mustache~
-*.java~
-*.pm~
-*.xml~
-*.t~

.travis.yml

@@ -1,5 +1,41 @@
-sudo: false
+sudo: required
 language: java
-script: mvn verify -Psamples
 jdk:
   - oraclejdk7
+  - oraclejdk8
+
+cache:
+  directories:
+  - $HOME/.m2
+
+services:
+  - docker
+
+addons:
+  hosts:
+    - petstore.swagger.io
+
+before_install:
+  # required when sudo: required for the Ruby petstore tests
+  - gem install bundler
+  - npm install -g typescript
+  - sudo pip install virtualenv
+  # to run petstore server locally via docker
+  - docker pull swaggerapi/petstore
+  - docker run -d -e SWAGGER_HOST=http://petstore.swagger.io -e SWAGGER_BASE_PATH=/v2 -p 80:8080 swaggerapi/petstore
+  - docker ps -a
+  # show host table to confirm petstore.swagger.io is mapped to localhost
+  - cat /etc/hosts
+
+install:
+  # Add Godeps dependencies to GOPATH and PATH
+   - eval "$(curl -sL https://raw.githubusercontent.com/travis-ci/gimme/master/gimme | GIMME_GO_VERSION=1.4 bash)"
+   - export GOPATH="${TRAVIS_BUILD_DIR}/Godeps/_workspace"
+   - export PATH="${TRAVIS_BUILD_DIR}/Godeps/_workspace/bin:$PATH"
+
+script:
+  - mvn verify -Psamples
+  - if [ $DOCKER_HUB_USERNAME ]; then docker login --email=$DOCKER_HUB_EMAIL --username=$DOCKER_HUB_USERNAME --password=$DOCKER_HUB_PASSWORD && docker build -t $DOCKER_IMAGE_NAME ./modules/swagger-generator && if [ ! -z "$TRAVIS_TAG" ]; then docker tag $DOCKER_IMAGE_NAME:latest $DOCKER_IMAGE_NAME:$TRAVIS_TAG; fi && docker push $DOCKER_IMAGE_NAME; fi
+
+env:
+  - DOCKER_IMAGE_NAME=swaggerapi/swagger-generator

CONTRIBUTING.md

@@ -2,17 +2,16 @@
 
 ## Before submitting an issue
 
- - Before submitting an issue, search the [open issue](https://github.com/swagger-api/swagger-codegen/issues) and [closed issue](https://github.com/swagger-api/swagger-codegen/issues?q=is%3Aissue+is%3Aclosed) to ensure no one else has reported something similar before.
- - The issue should contain details on how to repeat the issue, e.g. 
-   - the Swagger spec for reproducing the issue (:bulb: use [Gist](https://gist.github.com) to share). If the Swagger spec cannot be shared publicly, it will be hard for the community to help
-   - version of Swagger Codegen
-   - language (`-l` in the command line, e.g. java, csharp, php)
- - You can also make a suggestion or ask a question by opening an "issue"
+ - If you're not using the latest master to generate API clients or server stubs, please give it another try by pulling the latest master as the issue may have already been addressed. Ref: [Getting Started](https://github.com/swagger-api/swagger-codegen#getting-started)
+ - Search the [open issue](https://github.com/swagger-api/swagger-codegen/issues) and [closed issue](https://github.com/swagger-api/swagger-codegen/issues?q=is%3Aissue+is%3Aclosed) to ensure no one else has reported something similar before.
+ - File an [issue ticket](https://github.com/swagger-api/swagger-codegen/issues/new) by providing all the required information. 
+ - You can also make a suggestion or ask a question by opening an "issue".
 
 ## Before submitting a PR
 
  - Search the [open issue](https://github.com/swagger-api/swagger-codegen/issues) to ensure no one else has reported something similar and no one is actively working on similar proposed change.
  - If no one has suggested something similar, open an ["issue"](https://github.com/swagger-api/swagger-codegen/issues) with your suggestion to gather feedback from the community.
+ - It's recommended to **create a new git branch** for the change so that the merge commit message looks nicer in the commit history.
 
 ## How to contribute
 
@@ -29,25 +28,38 @@ For a list of variables available in the template, please refer to this [page](h
 
 ### Style guide
 Code change should conform to the programming style guide of the respective langauages:
+- Android: https://source.android.com/source/code-style.html
 - C#: https://msdn.microsoft.com/en-us/library/vstudio/ff926074.aspx
+- C++: https://google.github.io/styleguide/cppguide.html
+- Haskell: https://github.com/tibbe/haskell-style-guide/blob/master/haskell-style.md
 - Java: https://google.github.io/styleguide/javaguide.html
+- JavaScript: https://github.com/airbnb/javascript/tree/master/es5
+- Groovy: http://groovy-lang.org/style-guide.html
+- Go: https://github.com/golang/go/wiki/CodeReviewComments
 - ObjC: https://github.com/NYTimes/objective-c-style-guide
+- Perl: http://perldoc.perl.org/perlstyle.html
 - PHP: https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md
 - Python: https://www.python.org/dev/peps/pep-0008/
 - Ruby: https://github.com/bbatsov/ruby-style-guide
+- Scala: http://docs.scala-lang.org/style/
+- Swift: https://developer.apple.com/library/prerelease/ios/documentation/Swift/Conceptual/Swift_Programming_Language/TheBasics.html
 - TypeScript: https://github.com/Microsoft/TypeScript/wiki/Coding-guidelines
 
-
 For other languages, feel free to suggest.
 
 You may find the current code base not 100% conform to the coding style and we welcome contributions to fix those.
 
+For [Vendor Extensions](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#vendorExtensions), please follow the naming convention below:
+- For general vendor extension, use lower case and hyphen. e.g. `x-is-unique`, `x-content-type`
+- For language-specified vendor extension, put it in the form of `x-{lang}-{extension-name}`. e.g. `x-objc-operation-id`, `x-java-feign-retry-limit` 
+- For a list of existing vendor extensions in use, please refer to https://github.com/swagger-api/swagger-codegen/wiki/Vendor-Extensions. If you've addaed new vendor extensions as part of your PR, please update the wiki page.
+
 ### Testing
 
 To add test cases (optional) covering the change in the code generator, please refer to [modules/swagger-codegen/src/test/java/io/swagger/codegen](https://github.com/swagger-api/swagger-codegen/tree/master/modules/swagger-codegen/src/test/java/io/swagger/codegen)
 
 To test the templates, please perform the following:
-- Update the [Petstore](http://petstore.swagger.io/) sample by running the shell script under `bin` folder. For example, run `./bin/ruby-petstore.sh` to update the Ruby PetStore API client under [`samples/client/petstore/ruby`](https://github.com/swagger-api/swagger-codegen/tree/master/samples/client/petstore/ruby) (For Windows, the batch files can be found under `bin\windows` folder)
+- Update the [Petstore](http://petstore.swagger.io/) sample by running the shell script under `bin` folder. For example, run `./bin/ruby-petstore.sh` to update the Ruby PetStore API client under [`samples/client/petstore/ruby`](https://github.com/swagger-api/swagger-codegen/tree/master/samples/client/petstore/ruby) For Windows, the batch files can be found under `bin\windows` folder. (If you find that there are new files generated or unexpected changes as a result of the update, that's not unusual as the test cases are added to the OpenAPI/Swagger spec from time to time. If you've questions or concerns, please open a ticket to start a discussion)
 - Run the tests in the sample folder, e.g. in `samples/client/petstore/ruby`, run `mvn integration-test -rf :RubyPetstoreClientTests`. (some languages may not contain unit testing for Petstore and we're looking for contribution from the community to implement those tests)
 - Finally, git commit the updated samples files: `git commit -a`
   (`git add -A` if added files with new test cases)
@@ -56,7 +68,7 @@ To start the CI tests, you can run `mvn verify -Psamples` (assuming you've all t
 
 ### Tips
 - Smaller changes are easier to review
-- [Optional] For bug fixes, provide a Swagger spec to repeat the issue so that the reviewer can use it to confirm the fix
+- [Optional] For bug fixes, provide a OpenAPI Spec to repeat the issue so that the reviewer can use it to confirm the fix
 - Add test case(s) to cover the change
 - Document the fix in the code to make the code more readable
 - Make sure test cases passed after the change (one way is to leverage https://travis-ci.org/ to run the CI tests)

LICENSE

@@ -1,4 +1,4 @@
-Copyright 2015 SmartBear Software
+Copyright 2016 SmartBear Software
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.