updated to 1.2.6-SNAPSHOT, play 2.2

fehguy · fehguy · commit 6b2336b9b3b4 · 2013-10-02T14:38:58.000-07:00
diff --git a/samples/java-play2/README.md b/samples/java-play2/README.md
@@ -15,7 +15,7 @@ The swagger-play2 module lives in maven central:
 ```scala
 val appDependencies: Seq[sbt.ModuleID] = Seq(
   /* your other dependencies */
-  "com.wordnik" %% "swagger-play2" % "1.2.2"
+  "com.wordnik" %% "swagger-play2" % "1.2.6-SNAPSHOT"
 )
 ```
 
diff --git a/samples/java-play2/app/controllers/BaseApiController.java b/samples/java-play2/app/controllers/BaseApiController.java
@@ -2,7 +2,7 @@
 
 
 import play.mvc.*;
-import play.data.*;
+//import play.data.*;
 import play.*;
 
 import com.wordnik.swagger.core.util.JsonUtil;
diff --git a/samples/java-play2/app/controllers/PetApiController.java b/samples/java-play2/app/controllers/PetApiController.java
@@ -23,17 +23,17 @@ public class PetApiController extends BaseApiController {
 	@Path("/{petId}")
 	@ApiOperation(value = "Find pet by ID", notes = "Returns a pet when ID < 10. "
 			+ "ID > 10 or nonintegers will simulate API error conditions", responseClass = "models.Pet")
-	@ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid ID supplied"),
-			@ApiResponse(code = 404, message = "Pet not found") })
+	@ApiErrors(value = { @ApiError(code = 400, reason = "Invalid ID supplied"),
+			@ApiError(code = 404, reason = "Pet not found") })
 	public static Result getPetById(
 			@ApiParam(value = "ID of pet that needs to be fetched", allowableValues = "range[1,5]", required = true) @PathParam("petId") String petId) {
 		return JsonResponse(petData.getPetbyId(Long.parseLong(petId)));
 	}
 
 	@POST
 	@ApiOperation(value = "Add a new pet to the store")
-	@ApiResponses(value = { @ApiResponse(code = 405, message = "Invalid input") })
-	@ApiImplicitParams({ @ApiImplicitParam(value = "Pet object that needs to be added to the store", required = true, dataType = "Pet", paramType = "body") })
+	@ApiErrors(value = { @ApiError(code = 405, reason = "Invalid input") })
+	@ApiParamsImplicit({ @ApiParamImplicit(value = "Pet object that needs to be added to the store", required = true, dataType = "Pet", paramType = "body") })
 	public static Result addPet() {
 		Object o = request().body().asJson();
 		try {
@@ -47,10 +47,10 @@ public static Result addPet() {
 
 	@PUT
 	@ApiOperation(value = "Update an existing pet")
-	@ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid ID supplied"),
-			@ApiResponse(code = 404, message = "Pet not found"),
-			@ApiResponse(code = 405, message = "Validation exception") })
-	@ApiImplicitParams({ @ApiImplicitParam(value = "Pet object that needs to be updated in the store", required = true, dataType = "Pet", paramType = "body") })
+	@ApiErrors(value = { @ApiError(code = 400, reason = "Invalid ID supplied"),
+			@ApiError(code = 404, reason = "Pet not found"),
+			@ApiError(code = 405, reason = "Validation exception") })
+	@ApiParamsImplicit({ @ApiParamImplicit(value = "Pet object that needs to be updated in the store", required = true, dataType = "Pet", paramType = "body") })
 	public static Result updatePet() {
 		Object o = request().body().asJson();
 		try {
@@ -65,7 +65,7 @@ public static Result updatePet() {
 	@GET
 	@Path("/findByStatus")
 	@ApiOperation(value = "Finds Pets by status", notes = "Multiple status values can be provided with comma seperated strings", responseClass = "models.Pet", multiValueResponse = true)
-	@ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid status value") })
+	@ApiErrors(value = { @ApiError(code = 400, reason = "Invalid status value") })
 	public static Result findPetsByStatus(
 			@ApiParam(value = "Status values that need to be considered for filter", required = true, defaultValue = "available", allowableValues = "available,pending,sold", allowMultiple = true) @QueryParam("status") String status) {
 		return JsonResponse(petData.findPetByStatus(status));
@@ -74,7 +74,7 @@ public static Result findPetsByStatus(
 	@GET
 	@Path("/findByTags")
 	@ApiOperation(value = "Finds Pets by tags", notes = "Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.", responseClass = "models.Pet", multiValueResponse = true)
-	@ApiResponses(value = { @ApiResponse(code = 400, message = "Invalid tag value") })
+	@ApiErrors(value = { @ApiError(code = 400, reason = "Invalid tag value") })
 	public static Result findPetsByTags(
 			@ApiParam(value = "Tags to filter by", required = true, allowMultiple = true) @QueryParam("tags") String tags) {
 		return JsonResponse(petData.findPetByTags(tags));
diff --git a/samples/java-play2/app/controllers/StoreApiController.java b/samples/java-play2/app/controllers/StoreApiController.java
@@ -23,8 +23,8 @@ public class StoreApiController extends BaseApiController {
 	@Path("/order/{orderId}")
 	@ApiOperation(value = "Find purchase order by ID", notes = "For valid response try integer IDs with value <= 5. "
 			+ "Anything above 5 or nonintegers will generate API errors", responseClass = "models.Order", httpMethod = "GET")
-	@ApiResponses({ @ApiResponse(code = 400, message = "Invalid ID supplied"),
-			@ApiResponse(code = 404, message = "Order not found") })
+	@ApiErrors({ @ApiError(code = 400, reason = "Invalid ID supplied"),
+			@ApiError(code = 404, reason = "Order not found") })
 	public static Result getOrderById(
 			@ApiParam(value = "ID of order to fetch", required = true) @PathParam("orderId") String orderId) {
 		Order order = storeData.findOrderById(ru.getLong(0, 10000, 0, orderId));
@@ -37,8 +37,8 @@ public static Result getOrderById(
 
 	@Path("/order")
 	@ApiOperation(value = "Place an order for a pet", responseClass = "void", httpMethod = "POST")
-	@ApiResponses(@ApiResponse(code = 400, message = "Invalid order"))
-	@ApiImplicitParams(@ApiImplicitParam(name = "body", value = "order placed for purchasing the pet", required = true, dataType = "Order", paramType = "body"))
+	@ApiErrors(@ApiError(code = 400, reason = "Invalid order"))
+	@ApiParamsImplicit(@ApiParamImplicit(name = "body", value = "order placed for purchasing the pet", required = true, dataType = "Order", paramType = "body"))
 	public static Result placeOrder() {
 		Object o = request().body().asJson();
 		try {
@@ -53,8 +53,8 @@ public static Result placeOrder() {
 	@Path("/order/{orderId}")
 	@ApiOperation(value = "Delete purchase order by ID", notes = "For valid response try integer IDs with value < 1000. "
 			+ "Anything above 1000 or nonintegers will generate API errors", responseClass = "void", httpMethod = "DELETE")
-	@ApiResponses({ @ApiResponse(code = 400, message = "Invalid ID supplied"),
-			@ApiResponse(code = 404, message = "Order not found") })
+	@ApiErrors({ @ApiError(code = 400, reason = "Invalid ID supplied"),
+			@ApiError(code = 404, reason = "Order not found") })
 	public static Result deleteOrder(
 			@ApiParam(value = "ID of the order that needs to be deleted", required = true) @PathParam("orderId") String orderId) {
 		storeData.deleteOrder(ru.getLong(0, 10000, 0, orderId));
diff --git a/samples/java-play2/app/controllers/UserApiController.java b/samples/java-play2/app/controllers/UserApiController.java
@@ -23,7 +23,7 @@ public class UserApiController extends BaseApiController {
 
 	@POST
 	@ApiOperation(value = "Create user", notes = "This can only be done by the logged in user.")
-	@ApiImplicitParams(@ApiImplicitParam(name = "body", value = "Created user object", required = true, dataType = "User", paramType = "body"))
+	@ApiParamsImplicit(@ApiParamImplicit(name = "body", value = "Created user object", required = true, dataType = "User", paramType = "body"))
 	public static Result createUser() {
 		Object o = request().body().asJson();
 		try {
@@ -40,7 +40,7 @@ public static Result createUser() {
 	@POST
 	@Path("/createWithArray")
 	@ApiOperation(value = "Creates list of users with given input array", responseClass = "void")
-	@ApiImplicitParams(@ApiImplicitParam(name = "body", value = "List of user object", required = true, dataType = "Array[User]", paramType = "body"))
+	@ApiParamsImplicit(@ApiParamImplicit(name = "body", value = "List of user object", required = true, dataType = "Array[User]", paramType = "body"))
 	public static Result createUsersWithArrayInput() {
 		Object o = request().body().asJson();
 		try {
@@ -59,7 +59,7 @@ public static Result createUsersWithArrayInput() {
 	@POST
 	@Path("/createWithList")
 	@ApiOperation(value = "Creates list of users with given list input", responseClass = "void")
-	@ApiImplicitParams(@ApiImplicitParam(name = "body", value = "List of user object", required = true, dataType = "List[User]", paramType = "body"))
+	@ApiParamsImplicit(@ApiParamImplicit(name = "body", value = "List of user object", required = true, dataType = "List[User]", paramType = "body"))
 	public static Result createUsersWithListInput() {
 		Object o = request().body().asJson();
 		try {
@@ -78,11 +78,11 @@ public static Result createUsersWithListInput() {
 	@GET
 	@Path("/{username}")
 	@ApiOperation(value = "Fetch a user", notes = "This can only be done by the logged in user.")
-	@ApiResponses({ @ApiResponse(code = 400, message = "Invalid username supplied"),
-			@ApiResponse(code = 404, message = "User not found") })
-	@ApiImplicitParams({
-			@ApiImplicitParam(name = "username", value = "name that need to be updated", required = true, dataType = "String", paramType = "path"),
-			@ApiImplicitParam(name = "body", value = "Updated user object", required = true, dataType = "User", paramType = "body") })
+	@ApiErrors({ @ApiError(code = 400, reason = "Invalid username supplied"),
+			@ApiError(code = 404, reason = "User not found") })
+	@ApiParamsImplicit({
+			@ApiParamImplicit(name = "username", value = "name that need to be updated", required = true, dataType = "string", paramType = "path"),
+			@ApiParamImplicit(name = "body", value = "Updated user object", required = true, dataType = "User", paramType = "body") })
 	public static Result updateUser(String username) {
 		Object o = request().body().asJson();
 		try {
@@ -99,8 +99,8 @@ public static Result updateUser(String username) {
 	@DELETE
 	@Path("/{username}")
 	@ApiOperation(value = "Delete user", notes = "This can only be done by the logged in user.")
-	@ApiResponses({ @ApiResponse(code = 400, message = "Invalid username supplied"),
-			@ApiResponse(code = 404, message = "User not found") })
+	@ApiErrors({ @ApiError(code = 400, reason = "Invalid username supplied"),
+			@ApiError(code = 404, reason = "User not found") })
 	public static Result deleteUser(
 			@ApiParam(value = "The name that needs to be deleted", required = true) String username) {
 		userData.removeUser(username);
@@ -110,8 +110,8 @@ public static Result deleteUser(
 	@GET
 	@Path("/{username}")
 	@ApiOperation(value = "Get user by user name", responseClass = "models.User")
-	@ApiResponses({ @ApiResponse(code = 400, message = "Invalid username supplied"),
-			@ApiResponse(code = 404, message = "User not found") })
+	@ApiErrors({ @ApiError(code = 400, reason = "Invalid username supplied"),
+			@ApiError(code = 404, reason = "User not found") })
 	public static Result getUserByName(
 			@ApiParam(value = "The name that needs to be fetched. Use user1 for testing. ", required = true) @PathParam("username") String username) {
 		User user = userData.findUserByName(username);
@@ -123,8 +123,8 @@ public static Result getUserByName(
 
 	@GET
 	@Path("/login")
-	@ApiOperation(value = "Logs user into the system", responseClass = "String")
-	@ApiResponses(@ApiResponse(code = 400, message = "Invalid username and password combination"))
+	@ApiOperation(value = "Logs user into the system", responseClass = "string")
+	@ApiErrors(@ApiError(code = 400, reason = "Invalid username and password combination"))
 	public static Result loginUser(
 			@ApiParam(value = "The user name for login", required = true) @QueryParam("username") String username,
 			@ApiParam(value = "The password for login in clear text", required = true) @QueryParam("password") String password) {
diff --git a/samples/java-play2/app/models/Order.java b/samples/java-play2/app/models/Order.java
@@ -68,7 +68,7 @@ public void setQuantity(int quantity) {
 	}
 
 	@XmlElement(name = "status")
-	@ApiModelProperty(value = "Order Status", allowableValues = "placed, approved, delivered")
+    @ApiProperty(value = "Order Status", allowableValues = "placed,approved,delivered")
 	public String getStatus() {
 		return status;
 	}
diff --git a/samples/java-play2/app/models/Pet.java b/samples/java-play2/app/models/Pet.java
@@ -80,8 +80,8 @@ public void setTags(List<Tag> tags) {
 	}
 
 	@XmlElement(name = "status")
-	@ApiModelProperty(value = "pet status in the store", allowableValues = "available,pending,sold")
-	public String getStatus() {
+    @ApiProperty(value = "pet status in the store", allowableValues = "available,pending,sold")
+    public String getStatus() {
 		return status;
 	}
 
diff --git a/samples/java-play2/app/models/User.java b/samples/java-play2/app/models/User.java
@@ -95,7 +95,7 @@ public void setPhone(String phone) {
 	}
 
 	@XmlElement(name = "userStatus")
-	@ApiModelProperty(value = "User Status", allowableValues = "1-registered,2-active,3-closed")
+    @ApiProperty(value = "User Status", allowableValues = "1-registered,2-active,3-closed")
 	public int getUserStatus() {
 		return userStatus;
 	}
diff --git a/samples/java-play2/app/security/AuthorizationFilter.scala b/samples/java-play2/app/security/AuthorizationFilter.scala
@@ -12,26 +12,26 @@ import scala.collection.mutable.ListBuffer
 import scala.collection.JavaConversions._
 
 class AuthorizationFilter extends ApiAuthorizationFilter {
-  val methodSecurityAnotations = Map(
+  val resourceAccess = Map(
     "/user.{format}" -> false,
     "/pet.{format}" -> false,
     "/store.{format}" -> true)
 
-  val classSecurityAnotations = Map(
+  val operationAccess = Map(
     "GET:/pet.{format}/{petId}" -> false,
     "POST:/pet.{format}" -> true,
     "PUT:/pet.{format}" -> true,
     "GET:/pet.{format}/findByStatus" -> false,
     "GET:/pet.{format}/findByTags" -> false,
 
-
+    "GET:/store.{format}/order" -> true,
     "GET:/store.{format}/order/{orderId}" -> true,
     "DELETE:/store.{format}/order/{orderId}" -> true,
     "POST:/store.{format}/order" -> true,
 
-    "POST:/user.{format}" -> false,
-    "POST:/user.{format}/createWithArray" -> false,
-    "POST:/user.{format}/createWithList" -> false,
+    "POST:/user.{format}" -> true,
+    "POST:/user.{format}/createWithArray" -> true,
+    "POST:/user.{format}/createWithList" -> true,
     "PUT:/user.{format}/{username}" -> true,
     "DELETE:/user.{format}/{username}" -> true,
     "GET:/user.{format}/{username}" -> false,
@@ -41,32 +41,28 @@ class AuthorizationFilter extends ApiAuthorizationFilter {
   var securekeyId = "special-key"
   var unsecurekeyId = "default-key"
 
-  def authorize(apiPath: String)(implicit requestHeader: RequestHeader): Boolean = {
-    Logger.debug("authorizing path " + apiPath)
+  def authorize(apiPath: String, httpMethod: String)(implicit requestHeader: RequestHeader): Boolean = {
   	val isAuthorized = if(requestHeader != null) {
-	    if (isPathSecure(requestHeader.method.toUpperCase + ":" + apiPath, false)) {
-	      if (apiKey == securekeyId) 
-          return true
-	      else 
-          return false
-	    }
-	    else 
-        true
+      isPathSecure(httpMethod.toUpperCase + ":" + apiPath, false) match {
+        case true => apiKey == securekeyId
+        case false => true
+      }
   	} else {
-  		Logger.debug("no header to authroize path " + apiPath)
+  		Logger.debug("no header to authorize path " + apiPath)
   		false
   	}
 
+    Logger.debug("authorizing path " + httpMethod + ":" + apiPath + ", " + isAuthorized)
+
     isAuthorized
   }
 
-  def authorizeResource(apiPath: String)(implicit requestHeader: RequestHeader): Boolean = {
-    Logger.debug("authorizing resource " + apiPath)
-    if (isPathSecure(apiPath, true)) {
-      if (apiKey == securekeyId) return true
-      else return false
-    } else
-      true
+  def authorizeResource(resourcePath: String)(implicit requestHeader: RequestHeader): Boolean = {
+    Logger.debug("authorizing resource " + resourcePath)
+    isPathSecure(resourcePath, true) match {
+      case true => apiKey.equals(securekeyId)
+      case false => true
+    }
   }
 
   private def apiKey()(implicit requestHeader: RequestHeader): String = {
@@ -78,10 +74,9 @@ class AuthorizationFilter extends ApiAuthorizationFilter {
   }
 
   private def isPathSecure(apiPath: String, isResource: Boolean): Boolean = {
-    Logger.debug("checking security on path " + apiPath + ", " + isResource)
     isResource match {
-      case true => methodSecurityAnotations.getOrElse(apiPath, false)
-      case false => classSecurityAnotations.getOrElse(apiPath, false)
+      case true => resourceAccess.getOrElse(apiPath, false)
+      case false => operationAccess.getOrElse(apiPath, false)
     }
   }
 }
diff --git a/samples/java-play2/conf/routes b/samples/java-play2/conf/routes
@@ -5,12 +5,20 @@
 # Swagger - Root Resources Listing
 GET     /api-docs.json               controllers.ApiHelpController.getResources
 
+# OPTIONS to support hosting UI off domain
+
+# OPTIONS /*wholepath            	     controllers.PetApiController.getOptions(wholepath)
+
+GET     /api-docs.json/admin         controllers.ApiHelpController.getResource(path = "/api-docs.json/admin")
+GET     /admin.json/health           controllers.HealthController.getHealth
+GET     /admin.json/ping             controllers.HealthController.ping
+
 GET     /api-docs.json/pet           controllers.ApiHelpController.getResource(path = "/api-docs.json/pet")
 POST    /pet.json                    controllers.PetApiController.addPet
 PUT     /pet.json                    controllers.PetApiController.updatePet
 GET     /pet.json/findByStatus       controllers.PetApiController.findPetsByStatus(status)
 GET     /pet.json/findByTags         controllers.PetApiController.findPetsByTags(tags)
-GET     /pet.json/:petId             controllers.PetApiController.getPetById(petId)
+GET     /pet.json/:id                controllers.PetApiController.getPetById(id)
 
 GET     /api-docs.json/store         controllers.ApiHelpController.getResource(path = "/api-docs.json/store")
 POST    /store.json/order            controllers.StoreApiController.placeOrder
diff --git a/samples/java-play2/project/Build.scala b/samples/java-play2/project/Build.scala
@@ -1,16 +1,17 @@
 import sbt._
 import Keys._
-import PlayProject._
+import play.Project._
 
 object ApplicationBuild extends Build {
 
   val appName = "petstore"
-  val appVersion = "1.2.2"
+  val appVersion = "1.2.6-SNAPSHOT"
 
   val appDependencies: Seq[sbt.ModuleID] = Seq(
-    "com.wordnik" %% "swagger-play2" % "1.2.2")
+    "com.wordnik" %% "swagger-play2-utils" % "1.2.6-SNAPSHOT"
+  )
 
-  val main = PlayProject(appName, appVersion, appDependencies, mainLang = JAVA).settings(
+  val main = play.Project(appName, appVersion, appDependencies).settings(
     resolvers := Seq(
       "Local Maven Repository" at "file://"+Path.userHome.absolutePath+"/.m2/repository",
       "sonatype-snapshots" at "https://oss.sonatype.org/content/repositories/snapshots",
diff --git a/samples/java-play2/project/build.properties b/samples/java-play2/project/build.properties
@@ -1 +1 @@
-sbt.version=0.11.3
+sbt.version=0.13.0
diff --git a/samples/java-play2/project/plugins.sbt b/samples/java-play2/project/plugins.sbt
@@ -1,7 +1,8 @@
-resolvers ++= Seq(
-  DefaultMavenRepository,
-  Resolver.url("Play", url("http://download.playframework.org/ivy-releases/"))(Resolver.ivyStylePatterns),
-  "Typesafe Repository" at "http://repo.typesafe.com/typesafe/releases/"
-)
+// Comment to get more information during initialization
+logLevel := Level.Warn
 
-addSbtPlugin("play" % "sbt-plugin" % "2.1.0")
+// The Typesafe repository
+resolvers += "Typesafe repository" at "http://repo.typesafe.com/typesafe/releases/"
+
+// Use the Play sbt plugin for Play projects
+addSbtPlugin("com.typesafe.play" % "sbt-plugin" % "2.2.0")

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ The swagger-play2 module lives in maven central:`
`15`	`15`	```scala
`16`	`16`	`val appDependencies: Seq[sbt.ModuleID] = Seq(`
`17`	`17`	`/* your other dependencies */`
`18`		`- "com.wordnik" %% "swagger-play2" % "1.2.2"`
	`18`	`+ "com.wordnik" %% "swagger-play2" % "1.2.6-SNAPSHOT"`
`19`	`19`	`)`
`20`	`20`	```
`21`	`21`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ public void setQuantity(int quantity) {`
`68`	`68`	`}`
`69`	`69`
`70`	`70`	`@XmlElement(name = "status")`
`71`		`- @ApiModelProperty(value = "Order Status", allowableValues = "placed, approved, delivered")`
	`71`	`+ @ApiProperty(value = "Order Status", allowableValues = "placed,approved,delivered")`
`72`	`72`	`public String getStatus() {`
`73`	`73`	`return status;`
`74`	`74`	`}`
Original file line number	Diff line number	Diff line change
`@@ -80,8 +80,8 @@ public void setTags(List<Tag> tags) {`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`@XmlElement(name = "status")`
`83`		`- @ApiModelProperty(value = "pet status in the store", allowableValues = "available,pending,sold")`
`84`		`- public String getStatus() {`
	`83`	`+ @ApiProperty(value = "pet status in the store", allowableValues = "available,pending,sold")`
	`84`	`+ public String getStatus() {`
`85`	`85`	`return status;`
`86`	`86`	`}`
`87`	`87`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ public void setPhone(String phone) {`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`@XmlElement(name = "userStatus")`
`98`		`- @ApiModelProperty(value = "User Status", allowableValues = "1-registered,2-active,3-closed")`
	`98`	`+ @ApiProperty(value = "User Status", allowableValues = "1-registered,2-active,3-closed")`
`99`	`99`	`public int getUserStatus() {`
`100`	`100`	`return userStatus;`
`101`	`101`	`}`