merged from master

Author: fehguy

modules/swagger-core/src/test/scala/converter/CovariantGetterTest.scala

@@ -0,0 +1,28 @@
+package converter
+
+import converter.models._
+
+import com.wordnik.swagger.model._
+import com.wordnik.swagger.converter._
+
+import org.junit.runner.RunWith
+import org.scalatest.junit.JUnitRunner
+import org.scalatest.FlatSpec
+import org.scalatest.matchers.ShouldMatchers
+import converter.models.JCovariantGetter
+
+@RunWith(classOf[JUnitRunner])
+class CovariantGetterTest extends FlatSpec with ShouldMatchers {
+  implicit val formats = SwaggerSerializers.formats
+
+  it should "read a getter with covariant return type" in {
+    val model = ModelConverters.read(classOf[JCovariantGetter.Sub]).getOrElse(fail("no model found"))
+    val myProperty = model.properties.get("myProperty")
+    myProperty should not be (None)
+    myProperty.get.qualifiedType should be ("java.lang.Integer")
+    val myOtherProperty = model.properties.get("myOtherProperty")
+    myOtherProperty should not be (None)
+    myOtherProperty.get.qualifiedType should be ("java.lang.Integer")
+  }
+
+}

modules/swagger-core/src/test/scala/converter/HiddenFieldTest.scala

@@ -0,0 +1,48 @@
+package converter
+
+import converter.models._
+
+import com.wordnik.swagger.converter._
+import com.wordnik.swagger.core.util._
+import com.wordnik.swagger.model._
+import com.wordnik.swagger.annotations._
+
+import java.util.Date
+
+import scala.reflect.BeanProperty
+
+import org.junit.runner.RunWith
+import org.scalatest.junit.JUnitRunner
+import org.scalatest.FlatSpec
+import org.scalatest.matchers.ShouldMatchers
+
+@RunWith(classOf[JUnitRunner])
+class HiddenFieldTest extends FlatSpec with ShouldMatchers {
+  it should "ignore a hidden field" in {
+    val model = ModelConverters.read(classOf[ModelWithHiddenFields]).getOrElse(fail("no model found"))
+    model.id should be ("ModelWithHiddenFields")
+    model.properties.size should be (2)
+
+    val idValue = model.properties("id")
+    idValue.`type` should be ("long")
+    idValue.required should be (true)
+
+    val nameValue = model.properties("name")
+    nameValue.`type` should be ("string")
+    nameValue.required should be (true)
+  }
+}
+
+class ModelWithHiddenFields {
+  @BeanProperty
+  @ApiModelProperty(required=true)
+  var id: Long = _
+
+  @BeanProperty
+  @ApiModelProperty(required=true, hidden=false)
+  var name: String = _
+
+  @BeanProperty
+  @ApiModelProperty(hidden=true)
+  var password: String = _
+}

modules/swagger-core/src/test/scala/converter/JsonPropertyModelTest.scala

@@ -0,0 +1,20 @@
+package converter
+
+import models._
+
+import com.wordnik.swagger.converter._
+
+import com.wordnik.swagger.core.util._
+
+import java.util.Date
+
+import org.junit.runner.RunWith
+import org.scalatest.junit.JUnitRunner
+import org.scalatest.FlatSpec
+import org.scalatest.matchers.ShouldMatchers
+
+@RunWith(classOf[JUnitRunner])
+class JsonPropertyModelTest extends FlatSpec with ShouldMatchers {
+  val models = ModelConverters.readAll(classOf[ModelWithJsonProperty])
+  JsonSerializer.asJson(models) should be ("""[{"id":"ModelWithJsonProperty","properties":{"theCount":{"type":"integer","format":"int32"}}}]""")
+}

modules/swagger-core/src/test/scala/converter/PropertyAnnotationTest.scala

@@ -0,0 +1,45 @@
+package converter
+
+import converter.models._
+
+import com.wordnik.swagger.converter._
+import com.wordnik.swagger.model._
+
+import com.wordnik.swagger.annotations._
+import com.wordnik.swagger.converter._
+import com.wordnik.swagger.core.util._
+import com.wordnik.swagger.model._
+
+import scala.reflect.BeanProperty
+import scala.collection.mutable.LinkedHashMap
+
+import org.junit.runner.RunWith
+import org.scalatest.junit.JUnitRunner
+import org.scalatest.FlatSpec
+import org.scalatest.matchers.ShouldMatchers
+
+import javax.xml.bind.annotation._
+
+@RunWith(classOf[JUnitRunner])
+class PropertyAnnotationTest extends FlatSpec with ShouldMatchers {
+  it should "read annotations on a property" in {
+    val a = ModelConverters.readAll(classOf[ModelWithAnnotationOnProperty])
+    JsonSerializer.asJson(a) should be ("""[{"id":"ModelWithAnnotationOnProperty","description":"my annotated model","properties":{"count":{"type":"integer","format":"int32","description":"the count of items"}}}]""")
+
+/*
+[
+  {
+    "id": "ModelWithAnnotationOnProperty",
+    "description": "my annotated model",
+    "properties": {
+      "count": {
+        "type": "integer",
+        "format": "int32",
+        "description": "the count of items"
+      }
+    }
+  }
+]
+*/
+  }
+}

modules/swagger-core/src/test/scala/converter/XMLGregorianCalendarTest.scala

@@ -0,0 +1,46 @@
+package converter
+
+import model._
+
+import com.wordnik.swagger.annotations._
+import com.wordnik.swagger.converter._
+import com.wordnik.swagger.core.util._
+import com.wordnik.swagger.model._
+
+import org.joda.time.DateTime
+
+import scala.collection.mutable.LinkedHashMap
+import scala.annotation.target.field
+import javax.xml.datatype.XMLGregorianCalendar
+
+import org.junit.runner.RunWith
+import org.scalatest.junit.JUnitRunner
+import org.scalatest.FlatSpec
+import org.scalatest.matchers.ShouldMatchers
+
+@RunWith(classOf[JUnitRunner])
+class XMLGregorianCalendarTest extends FlatSpec with ShouldMatchers {
+  it should "read a model with XMLGregorianCalendar" in {
+    val models = ModelConverters.readAll(classOf[ModelWithCalendar])
+    models.size should be (1) // don't create a Joda DateTime object
+
+    val model = models.head
+    val nameProperty = model.properties("name")
+    nameProperty.`type` should be ("string")
+    nameProperty.position should be (2)
+    nameProperty.description should be (Some("name of the model"))
+
+    val dateTimeProperty = model.properties("createdAt")
+    dateTimeProperty.`type` should be ("Date")
+    dateTimeProperty.position should be (1)
+    dateTimeProperty.required should be (true)
+    dateTimeProperty.description should be (Some("creation timestamp"))
+
+    println(JsonSerializer.asJson(models.head))
+  }
+}
+
+
+case class ModelWithCalendar (
+  @(ApiModelProperty @field)(value = "name of the model", position = 2) name: String,
+  @(ApiModelProperty @field)(value = "creation timestamp", required = true, position = 1) createdAt: XMLGregorianCalendar)

modules/swagger-core/src/test/scala/converter/models/JCovariantGetter.java

@@ -0,0 +1,27 @@
+package converter.models;
+
+public abstract class JCovariantGetter {
+
+    public Object getMyProperty() {
+        return "42";
+    }
+
+    public Object getMyOtherProperty() {
+        return "42";
+    }
+
+    public static class Sub extends JCovariantGetter {
+
+        @Override
+        public Integer getMyProperty() {
+            return 42;
+        }
+
+        @Override
+        public Integer getMyOtherProperty() {
+            return 42;
+        }
+
+    }
+
+}

modules/swagger-core/src/test/scala/converter/models/ModelWithAnnotationOnProperty.java

@@ -0,0 +1,17 @@
+package converter.models;
+
+import com.wordnik.swagger.annotations.*;
+
+@ApiModel(description = "my annotated model")
+public class ModelWithAnnotationOnProperty {
+  @ApiModelProperty(value = "the count of items", position = 1)
+  private Integer count;
+
+  public void setCount(Integer count) {
+    this.count = count;
+  }
+
+  public Integer getCount() {
+    return count;
+  }
+}

modules/swagger-core/src/test/scala/converter/models/ModelWithJsonProperty.java

@@ -0,0 +1,15 @@
+package converter.models;
+
+import com.fasterxml.jackson.annotation.*;
+public class ModelWithJsonProperty {
+  @JsonProperty("theCount")
+  private Integer count;
+
+  public void setCount(Integer count) {
+    this.count = count;
+  }
+
+  public Integer getCount() {
+    return count;
+  }
+}

modules/swagger-jaxrs/src/main/scala/com/wordnik/swagger/jaxrs/json/JacksonJsonProvider.java

@@ -0,0 +1,58 @@
+/**
+ *  Copyright 2013 Wordnik, Inc.
+ *
+ *  Licensed under the Apache License, Version 2.0 (the "License");
+ *  you may not use this file except in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing, software
+ *  distributed under the License is distributed on an "AS IS" BASIS,
+ *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *  See the License for the specific language governing permissions and
+ *  limitations under the License.
+ */
+
+package com.wordnik.swagger.jaxrs.json;
+
+import javax.ws.rs.Produces;
+
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.ext.Provider;
+
+import com.wordnik.swagger.core.util.JsonUtil;
+import com.fasterxml.jackson.jaxrs.json.JacksonJaxbJsonProvider;
+import com.fasterxml.jackson.databind.*;
+
+
+
+import com.fasterxml.jackson.module.scala.DefaultScalaModule;
+
+import com.fasterxml.jackson.core.JsonGenerator.Feature;
+import com.fasterxml.jackson.databind.*;
+import com.fasterxml.jackson.annotation.*;
+import com.fasterxml.jackson.databind.annotation.JsonSerialize;
+
+
+@Provider
+@Produces(MediaType.APPLICATION_JSON)
+public class JacksonJsonProvider extends JacksonJaxbJsonProvider {
+  private static ObjectMapper commonMapper = null;
+
+  public JacksonJsonProvider() {
+    if(commonMapper == null){
+        ObjectMapper mapper = new ObjectMapper();
+
+        mapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);
+        mapper.setSerializationInclusion(JsonInclude.Include.NON_DEFAULT);
+        mapper.configure(SerializationFeature.WRITE_DATES_AS_TIMESTAMPS, false);
+        mapper.configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false);
+        
+        commonMapper = mapper;
+    }
+    super.setMapper(commonMapper);
+  }
+  
+  
+}