74946
|
1 |
/* Title: Pure/General/json_api.scala
|
|
2 |
Author: Makarius
|
|
3 |
|
|
4 |
Support for JSON:API: https://jsonapi.org/format
|
|
5 |
*/
|
|
6 |
|
|
7 |
package isabelle
|
|
8 |
|
74962
|
9 |
import java.net.URL
|
|
10 |
|
74946
|
11 |
|
|
12 |
object JSON_API
|
|
13 |
{
|
|
14 |
val mime_type = "application/vnd.api+json"
|
|
15 |
|
|
16 |
def api_error(msg: String): Nothing = error("JSON API error: " + msg)
|
|
17 |
def api_errors(msgs: List[String]): Nothing = error(("JSON API errors:" :: msgs).mkString("\n "))
|
|
18 |
|
74962
|
19 |
class Service(val url: URL)
|
|
20 |
{
|
|
21 |
override def toString: String = url.toString
|
|
22 |
|
|
23 |
def get(route: String): HTTP.Content =
|
|
24 |
HTTP.Client.get(if (route.isEmpty) url else new URL(url, route))
|
|
25 |
|
|
26 |
def get_root(route: String = ""): Root =
|
|
27 |
Root(get(if (route.isEmpty) "" else "/" + route).json)
|
|
28 |
}
|
|
29 |
|
74946
|
30 |
sealed case class Root(json: JSON.T)
|
|
31 |
{
|
|
32 |
def get_links: Option[Links] = JSON.value(json, "links").map(Links)
|
74962
|
33 |
def get_next: Option[Service] = get_links.flatMap(_.get_next)
|
|
34 |
|
74946
|
35 |
def get_included: List[Resource] = JSON.list(json, "included", Resource.some).getOrElse(Nil)
|
|
36 |
def get_data: Option[Data] = JSON.value(json, "data").map(Data(_, get_included))
|
74962
|
37 |
|
74946
|
38 |
def get_errors: Option[List[JSON.T]] = JSON.list(json, "errors", Some(_))
|
|
39 |
|
|
40 |
def ok: Boolean = get_errors.isEmpty
|
|
41 |
def check: Root =
|
|
42 |
get_errors match {
|
|
43 |
case None => this
|
|
44 |
case Some(List(err)) => api_error(JSON.Format(err))
|
|
45 |
case Some(errs) => api_errors(errs.map(JSON.Format.apply))
|
|
46 |
}
|
|
47 |
def check_data: Data = check.get_data getOrElse api_error("missing data")
|
74962
|
48 |
def check_resource: Resource = check_data.resource
|
|
49 |
def check_resources: List[Resource] = check_data.resources
|
74946
|
50 |
|
|
51 |
override def toString: String = "Root(" + (if (ok) "ok" else "errors") + ")"
|
|
52 |
}
|
|
53 |
|
|
54 |
sealed case class Links(json: JSON.T)
|
|
55 |
{
|
74962
|
56 |
def get_next: Option[Service] =
|
|
57 |
for {
|
|
58 |
JSON.Value.String(next) <- JSON.value(json, "next")
|
|
59 |
if Url.is_wellformed(next)
|
|
60 |
} yield new Service(Url(next))
|
74946
|
61 |
|
|
62 |
override def toString: String =
|
|
63 |
if (get_next.isEmpty) "Links()" else "Links(next)"
|
|
64 |
}
|
|
65 |
|
|
66 |
sealed case class Data(data: JSON.T, included: List[Resource])
|
|
67 |
{
|
|
68 |
def is_multi: Boolean = JSON.Value.List.unapply(data, Some(_)).nonEmpty
|
|
69 |
|
|
70 |
def resource: Resource =
|
|
71 |
if (is_multi) api_error("singleton resource expected")
|
|
72 |
else Resource.some(data).get
|
|
73 |
|
|
74 |
def resources: List[Resource] =
|
|
75 |
JSON.Value.List.unapply(data, Resource.some)
|
|
76 |
.getOrElse(api_error("multiple resources expected"))
|
|
77 |
|
|
78 |
override def toString: String =
|
|
79 |
if (is_multi) "Data(resources)" else "Data(resource)"
|
|
80 |
}
|
|
81 |
|
|
82 |
object Resource
|
|
83 |
{
|
|
84 |
def some(json: JSON.T): Some[Resource] = Some(Resource(json))
|
|
85 |
}
|
|
86 |
|
|
87 |
sealed case class Resource(json: JSON.T)
|
|
88 |
{
|
|
89 |
val id: JSON.T = JSON.value(json, "id") getOrElse api_error("missing id")
|
|
90 |
val type_ : JSON.T = JSON.value(json, "type") getOrElse api_error("missing type")
|
|
91 |
val fields: JSON.Object.T =
|
|
92 |
JSON.value(json, "attributes", JSON.Object.unapply).getOrElse(JSON.Object.empty) ++
|
|
93 |
JSON.value(json, "relationships", JSON.Object.unapply).getOrElse(JSON.Object.empty)
|
|
94 |
|
|
95 |
override def toString: String = JSON.Format(json)
|
|
96 |
}
|
|
97 |
}
|