/** * Generated by API Builder - https://www.apibuilder.io * Service version: 0.0.1 * User agent: apibuilder app.apibuilder.io/bml/validation/0.0.1/play_2_6_client */ package org.bml.validation.v0.models { /** * A response object for field 409 conflict errors resulting from trying to create * a resource that already exists. * * @param status The response status. * @param message The response message. */ final case class ConflictResourceExistsResponse( status: Int, message: String ) /** * Error description object for a single field. * * @param path The object path of the field. * @param message A user friendly error message. */ final case class FieldValidationError( path: String, message: String ) /** * A single validation error description. * * @param message A user friendly error message. * @param errors A field validation type. */ final case class FieldValidationErrorEntry( message: String, errors: org.bml.validation.v0.models.FieldValidationErrorType ) /** * A response object for field validation errors. * * @param status The response status. * @param message The response message. * @param errors A set of field validation errors. */ final case class FieldValidationResponse( status: Int, message: String, errors: Seq[org.bml.validation.v0.models.FieldValidationError] ) /** * Error types for field validation. */ sealed trait FieldValidationErrorType extends _root_.scala.Product with _root_.scala.Serializable object FieldValidationErrorType { /** * Field is null or missing. */ case object IsNull extends FieldValidationErrorType { override def toString = "isNull" } /** * Field is empty. */ case object IsEmpty extends FieldValidationErrorType { override def toString = "isEmpty" } /** * Field length is less than the minimum allowed. */ case object MinimumLength extends FieldValidationErrorType { override def toString = "minimumLength" } /** * Field exceeds the maximum allowable length. */ case object MaximumLength extends FieldValidationErrorType { override def toString = "maximumLength" } /** * Field does not match a predefined pattern. */ case object Pattern extends FieldValidationErrorType { override def toString = "pattern" } /** * Field syntax type error. */ case object Syntax extends FieldValidationErrorType { override def toString = "syntax" } /** * UNDEFINED captures values that are sent either in error or * that were added by the server after this library was * generated. We want to make it easy and obvious to users of * this library to handle this case gracefully. * * We use all CAPS for the variable name to avoid collisions * with the camel cased values above. */ final case class UNDEFINED(override val toString: String) extends FieldValidationErrorType /** * all returns a list of all the valid, known values. We use * lower case to avoid collisions with the camel cased values * above. */ val all: scala.List[FieldValidationErrorType] = scala.List(IsNull, IsEmpty, MinimumLength, MaximumLength, Pattern, Syntax) private val byName: Map[String, FieldValidationErrorType] = all.map(x => x.toString.toLowerCase -> x).toMap def apply(value: String): FieldValidationErrorType = fromString(value).getOrElse(UNDEFINED(value)) def fromString(value: String): _root_.scala.Option[FieldValidationErrorType] = byName.get(value.toLowerCase) } } package org.bml.validation.v0.models { package object json { import play.api.libs.json.__ import play.api.libs.json.JsString import play.api.libs.json.Writes import play.api.libs.functional.syntax._ import org.bml.validation.v0.models.json._ private[v0] implicit val jsonReadsUUID: play.api.libs.json.Reads[_root_.java.util.UUID] = __.read[String].map { str => _root_.java.util.UUID.fromString(str) } private[v0] implicit val jsonWritesUUID: play.api.libs.json.Writes[_root_.java.util.UUID] = (x: _root_.java.util.UUID) => play.api.libs.json.JsString(x.toString) private[v0] implicit val jsonReadsJodaDateTime: play.api.libs.json.Reads[_root_.org.joda.time.DateTime] = __.read[String].map { str => _root_.org.joda.time.format.ISODateTimeFormat.dateTimeParser.parseDateTime(str) } private[v0] implicit val jsonWritesJodaDateTime: play.api.libs.json.Writes[_root_.org.joda.time.DateTime] = (x: _root_.org.joda.time.DateTime) => { play.api.libs.json.JsString(_root_.org.joda.time.format.ISODateTimeFormat.dateTime.print(x)) } private[v0] implicit val jsonReadsJodaLocalDate: play.api.libs.json.Reads[_root_.org.joda.time.LocalDate] = __.read[String].map { str => _root_.org.joda.time.format.ISODateTimeFormat.dateTimeParser.parseLocalDate(str) } private[v0] implicit val jsonWritesJodaLocalDate: play.api.libs.json.Writes[_root_.org.joda.time.LocalDate] = (x: _root_.org.joda.time.LocalDate) => { play.api.libs.json.JsString(_root_.org.joda.time.format.ISODateTimeFormat.date.print(x)) } implicit val jsonReadsValidationFieldValidationErrorType: play.api.libs.json.Reads[org.bml.validation.v0.models.FieldValidationErrorType] = new play.api.libs.json.Reads[org.bml.validation.v0.models.FieldValidationErrorType] { def reads(js: play.api.libs.json.JsValue): play.api.libs.json.JsResult[org.bml.validation.v0.models.FieldValidationErrorType] = { js match { case v: play.api.libs.json.JsString => play.api.libs.json.JsSuccess(org.bml.validation.v0.models.FieldValidationErrorType(v.value)) case _ => { (js \ "value").validate[String] match { case play.api.libs.json.JsSuccess(v, _) => play.api.libs.json.JsSuccess(org.bml.validation.v0.models.FieldValidationErrorType(v)) case _: play.api.libs.json.JsError => (js \ "fieldValidationErrorType").validate[String] match { case play.api.libs.json.JsSuccess(v, _) => play.api.libs.json.JsSuccess(org.bml.validation.v0.models.FieldValidationErrorType(v)) case err: play.api.libs.json.JsError => err } } } } } } def jsonWritesValidationFieldValidationErrorType(obj: org.bml.validation.v0.models.FieldValidationErrorType) = { play.api.libs.json.JsString(obj.toString) } def jsObjectFieldValidationErrorType(obj: org.bml.validation.v0.models.FieldValidationErrorType) = { play.api.libs.json.Json.obj("value" -> play.api.libs.json.JsString(obj.toString)) } implicit def jsonWritesValidationFieldValidationErrorType: play.api.libs.json.Writes[FieldValidationErrorType] = { (obj: org.bml.validation.v0.models.FieldValidationErrorType) => { org.bml.validation.v0.models.json.jsonWritesValidationFieldValidationErrorType(obj) } } implicit def jsonReadsValidationConflictResourceExistsResponse: play.api.libs.json.Reads[org.bml.validation.v0.models.ConflictResourceExistsResponse] = { for { status <- (__ \ "status").read[Int] message <- (__ \ "message").read[String] } yield ConflictResourceExistsResponse(status, message) } def jsObjectConflictResourceExistsResponse(obj: org.bml.validation.v0.models.ConflictResourceExistsResponse): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "status" -> play.api.libs.json.JsNumber(obj.status), "message" -> play.api.libs.json.JsString(obj.message) ) } implicit def jsonWritesValidationConflictResourceExistsResponse: play.api.libs.json.Writes[ConflictResourceExistsResponse] = { (obj: org.bml.validation.v0.models.ConflictResourceExistsResponse) => { org.bml.validation.v0.models.json.jsObjectConflictResourceExistsResponse(obj) } } implicit def jsonReadsValidationFieldValidationError: play.api.libs.json.Reads[org.bml.validation.v0.models.FieldValidationError] = { for { path <- (__ \ "path").read[String] message <- (__ \ "message").read[String] } yield FieldValidationError(path, message) } def jsObjectFieldValidationError(obj: org.bml.validation.v0.models.FieldValidationError): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "path" -> play.api.libs.json.JsString(obj.path), "message" -> play.api.libs.json.JsString(obj.message) ) } implicit def jsonWritesValidationFieldValidationError: play.api.libs.json.Writes[FieldValidationError] = { (obj: org.bml.validation.v0.models.FieldValidationError) => { org.bml.validation.v0.models.json.jsObjectFieldValidationError(obj) } } implicit def jsonReadsValidationFieldValidationErrorEntry: play.api.libs.json.Reads[org.bml.validation.v0.models.FieldValidationErrorEntry] = { for { message <- (__ \ "message").read[String] errors <- (__ \ "errors").read[org.bml.validation.v0.models.FieldValidationErrorType] } yield FieldValidationErrorEntry(message, errors) } def jsObjectFieldValidationErrorEntry(obj: org.bml.validation.v0.models.FieldValidationErrorEntry): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "message" -> play.api.libs.json.JsString(obj.message), "errors" -> play.api.libs.json.JsString(obj.errors.toString) ) } implicit def jsonWritesValidationFieldValidationErrorEntry: play.api.libs.json.Writes[FieldValidationErrorEntry] = { (obj: org.bml.validation.v0.models.FieldValidationErrorEntry) => { org.bml.validation.v0.models.json.jsObjectFieldValidationErrorEntry(obj) } } implicit def jsonReadsValidationFieldValidationResponse: play.api.libs.json.Reads[org.bml.validation.v0.models.FieldValidationResponse] = { for { status <- (__ \ "status").read[Int] message <- (__ \ "message").read[String] errors <- (__ \ "errors").read[Seq[org.bml.validation.v0.models.FieldValidationError]] } yield FieldValidationResponse(status, message, errors) } def jsObjectFieldValidationResponse(obj: org.bml.validation.v0.models.FieldValidationResponse): play.api.libs.json.JsObject = { play.api.libs.json.Json.obj( "status" -> play.api.libs.json.JsNumber(obj.status), "message" -> play.api.libs.json.JsString(obj.message), "errors" -> play.api.libs.json.Json.toJson(obj.errors) ) } implicit def jsonWritesValidationFieldValidationResponse: play.api.libs.json.Writes[FieldValidationResponse] = { (obj: org.bml.validation.v0.models.FieldValidationResponse) => { org.bml.validation.v0.models.json.jsObjectFieldValidationResponse(obj) } } } } package org.bml.validation.v0 { object Bindables { import play.api.mvc.{PathBindable, QueryStringBindable} // import models directly for backwards compatibility with prior versions of the generator import Core._ import Models._ object Core { implicit def pathBindableDateTimeIso8601(implicit stringBinder: QueryStringBindable[String]): PathBindable[_root_.org.joda.time.DateTime] = ApibuilderPathBindable(ApibuilderTypes.dateTimeIso8601) implicit def queryStringBindableDateTimeIso8601(implicit stringBinder: QueryStringBindable[String]): QueryStringBindable[_root_.org.joda.time.DateTime] = ApibuilderQueryStringBindable(ApibuilderTypes.dateTimeIso8601) implicit def pathBindableDateIso8601(implicit stringBinder: QueryStringBindable[String]): PathBindable[_root_.org.joda.time.LocalDate] = ApibuilderPathBindable(ApibuilderTypes.dateIso8601) implicit def queryStringBindableDateIso8601(implicit stringBinder: QueryStringBindable[String]): QueryStringBindable[_root_.org.joda.time.LocalDate] = ApibuilderQueryStringBindable(ApibuilderTypes.dateIso8601) } object Models { import org.bml.validation.v0.models._ val fieldValidationErrorTypeConverter: ApibuilderTypeConverter[org.bml.validation.v0.models.FieldValidationErrorType] = new ApibuilderTypeConverter[org.bml.validation.v0.models.FieldValidationErrorType] { override def convert(value: String): org.bml.validation.v0.models.FieldValidationErrorType = org.bml.validation.v0.models.FieldValidationErrorType(value) override def convert(value: org.bml.validation.v0.models.FieldValidationErrorType): String = value.toString override def example: org.bml.validation.v0.models.FieldValidationErrorType = org.bml.validation.v0.models.FieldValidationErrorType.IsNull override def validValues: Seq[org.bml.validation.v0.models.FieldValidationErrorType] = org.bml.validation.v0.models.FieldValidationErrorType.all } implicit def pathBindableFieldValidationErrorType(implicit stringBinder: QueryStringBindable[String]): PathBindable[org.bml.validation.v0.models.FieldValidationErrorType] = ApibuilderPathBindable(fieldValidationErrorTypeConverter) implicit def queryStringBindableFieldValidationErrorType(implicit stringBinder: QueryStringBindable[String]): QueryStringBindable[org.bml.validation.v0.models.FieldValidationErrorType] = ApibuilderQueryStringBindable(fieldValidationErrorTypeConverter) } trait ApibuilderTypeConverter[T] { def convert(value: String): T def convert(value: T): String def example: T def validValues: Seq[T] = Nil def errorMessage(key: String, value: String, ex: java.lang.Exception): String = { val base = s"Invalid value '$value' for parameter '$key'. " validValues.toList match { case Nil => base + "Ex: " + convert(example) case values => base + ". Valid values are: " + values.mkString("'", "', '", "'") } } } object ApibuilderTypes { val dateTimeIso8601: ApibuilderTypeConverter[_root_.org.joda.time.DateTime] = new ApibuilderTypeConverter[_root_.org.joda.time.DateTime] { override def convert(value: String): _root_.org.joda.time.DateTime = _root_.org.joda.time.format.ISODateTimeFormat.dateTimeParser.parseDateTime(value) override def convert(value: _root_.org.joda.time.DateTime): String = _root_.org.joda.time.format.ISODateTimeFormat.dateTime.print(value) override def example: _root_.org.joda.time.DateTime = _root_.org.joda.time.DateTime.now } val dateIso8601: ApibuilderTypeConverter[_root_.org.joda.time.LocalDate] = new ApibuilderTypeConverter[_root_.org.joda.time.LocalDate] { override def convert(value: String): _root_.org.joda.time.LocalDate = _root_.org.joda.time.format.ISODateTimeFormat.dateTimeParser.parseLocalDate(value) override def convert(value: _root_.org.joda.time.LocalDate): String = _root_.org.joda.time.format.ISODateTimeFormat.date.print(value) override def example: _root_.org.joda.time.LocalDate = _root_.org.joda.time.LocalDate.now } } final case class ApibuilderQueryStringBindable[T]( converters: ApibuilderTypeConverter[T] ) extends QueryStringBindable[T] { override def bind(key: String, params: Map[String, Seq[String]]): _root_.scala.Option[_root_.scala.Either[String, T]] = { params.getOrElse(key, Nil).headOption.map { v => try { Right( converters.convert(v) ) } catch { case ex: java.lang.Exception => Left( converters.errorMessage(key, v, ex) ) } } } override def unbind(key: String, value: T): String = { s"$key=${converters.convert(value)}" } } final case class ApibuilderPathBindable[T]( converters: ApibuilderTypeConverter[T] ) extends PathBindable[T] { override def bind(key: String, value: String): _root_.scala.Either[String, T] = { try { Right( converters.convert(value) ) } catch { case ex: java.lang.Exception => Left( converters.errorMessage(key, value, ex) ) } } override def unbind(key: String, value: T): String = { converters.convert(value) } } } } package org.bml.validation.v0 { object Constants { val Namespace = "org.bml.validation.v0" val UserAgent = "apibuilder app.apibuilder.io/bml/validation/0.0.1/play_2_6_client" val Version = "0.0.1" val VersionMajor = 0 } class Client( ws: play.api.libs.ws.WSClient, val baseUrl: String, auth: scala.Option[org.bml.validation.v0.Authorization] = None, defaultHeaders: Seq[(String, String)] = Nil ) extends interfaces.Client { import org.bml.validation.v0.models.json._ private val logger = play.api.Logger("org.bml.validation.v0.Client") logger.info(s"Initializing org.bml.validation.v0.Client for url $baseUrl") def _requestHolder(path: String): play.api.libs.ws.WSRequest = { val holder = ws.url(baseUrl + path).addHttpHeaders( "User-Agent" -> Constants.UserAgent, "X-Apidoc-Version" -> Constants.Version, "X-Apidoc-Version-Major" -> Constants.VersionMajor.toString ).addHttpHeaders(defaultHeaders: _*) auth.fold(holder) { case Authorization.Basic(username, password) => { holder.withAuth(username, password.getOrElse(""), play.api.libs.ws.WSAuthScheme.BASIC) } } } def _logRequest(method: String, req: play.api.libs.ws.WSRequest): play.api.libs.ws.WSRequest = { val queryComponents = for { (name, values) <- req.queryString value <- values } yield s"$name=$value" val url = s"${req.url}${queryComponents.mkString("?", "&", "")}" auth.fold(logger.info(s"curl -X $method '$url'")) { _ => logger.info(s"curl -X $method -u '[REDACTED]:' '$url'") } req } def _executeRequest( method: String, path: String, queryParameters: Seq[(String, String)] = Nil, requestHeaders: Seq[(String, String)] = Nil, body: Option[play.api.libs.json.JsValue] = None ): scala.concurrent.Future[play.api.libs.ws.WSResponse] = { method.toUpperCase match { case "GET" => { _logRequest("GET", _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)).get() } case "POST" => { _logRequest("POST", _requestHolder(path).addHttpHeaders(_withJsonContentType(requestHeaders): _*).addQueryStringParameters(queryParameters: _*)).post(body.getOrElse(play.api.libs.json.Json.obj())) } case "PUT" => { _logRequest("PUT", _requestHolder(path).addHttpHeaders(_withJsonContentType(requestHeaders): _*).addQueryStringParameters(queryParameters: _*)).put(body.getOrElse(play.api.libs.json.Json.obj())) } case "PATCH" => { _logRequest("PATCH", _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)).patch(body.getOrElse(play.api.libs.json.Json.obj())) } case "DELETE" => { _logRequest("DELETE", _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)).delete() } case "HEAD" => { _logRequest("HEAD", _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)).head() } case "OPTIONS" => { _logRequest("OPTIONS", _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)).options() } case _ => { _logRequest(method, _requestHolder(path).addHttpHeaders(requestHeaders: _*).addQueryStringParameters(queryParameters: _*)) sys.error("Unsupported method[%s]".format(method)) } } } /** * Adds a Content-Type: application/json header unless the specified requestHeaders * already contain a Content-Type header */ def _withJsonContentType(headers: Seq[(String, String)]): Seq[(String, String)] = { headers.find { _._1.toUpperCase == "CONTENT-TYPE" } match { case None => headers ++ Seq("Content-Type" -> "application/json; charset=UTF-8") case Some(_) => headers } } } object Client { def parseJson[T]( className: String, r: play.api.libs.ws.WSResponse, f: (play.api.libs.json.JsValue => play.api.libs.json.JsResult[T]) ): T = { f(play.api.libs.json.Json.parse(r.body)) match { case play.api.libs.json.JsSuccess(x, _) => x case play.api.libs.json.JsError(errors) => { throw org.bml.validation.v0.errors.FailedRequest(r.status, s"Invalid json for class[" + className + "]: " + errors.mkString(" ")) } } } } sealed trait Authorization extends _root_.scala.Product with _root_.scala.Serializable object Authorization { final case class Basic(username: String, password: Option[String] = None) extends Authorization } package interfaces { trait Client { def baseUrl: String } } package errors { final case class FailedRequest(responseCode: Int, message: String, requestUri: Option[_root_.java.net.URI] = None) extends _root_.java.lang.Exception(s"HTTP $responseCode: $message") } }