j-api 0.1.0

Json api implementation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115

pub(crate) mod data;
use crate::error::JsonApiError;
use crate::link::Links;
use crate::resource::ResourceType;
use crate::{Link, ResourceTrait};
pub use data::Data;
pub use data::DataType;
use serde::{Deserialize, Serialize};

#[derive(Debug, Default, Clone, Deserialize, Serialize)]
#[serde(rename_all = "camelCase")]
pub struct JsonApi {
    #[serde(skip_serializing_if = "Option::is_none")]
    data: Option<Data>,
    #[serde(skip_serializing_if = "Option::is_none")]
    errors: Option<Vec<JsonApiError>>,
    // TODO: Meta
    #[serde(borrow)]
    jsonapi: JsonApiObject<'static>,
    #[serde(skip_serializing_if = "Option::is_none")]
    links: Option<Links>,
    #[serde(skip_serializing_if = "Option::is_none")]
    included: Option<Data>,
}

impl JsonApi {
    pub fn new() -> Self {
        JsonApi {
            ..Default::default()
        }
    }

    pub fn data(resource: impl ResourceTrait) -> Self {
        JsonApi {
            data: Some(Data::Singular(ResourceType::Object(
                resource.to_resource_object(),
            ))),
            ..Default::default()
        }
    }

    pub fn collection(resources: Vec<impl ResourceTrait>) -> Self {
        JsonApi {
            data: Some(Data::Array(
                resources
                    .iter()
                    .map(|resource| ResourceType::Object(resource.to_resource_object()))
                    .collect(),
            )),
            ..Default::default()
        }
    }

    pub fn error(error: JsonApiError) -> Self {
        JsonApi {
            errors: Some(vec![error]),
            ..Default::default()
        }
    }

    pub fn errors(errors: Vec<JsonApiError>) -> Self {
        JsonApi {
            errors: Some(errors),
            ..Default::default()
        }
    }

    pub fn links(&mut self, links: Vec<Link>) -> &mut Self {
        self.links = Some(Links::new(links));
        self
    }

    pub fn to_response(&self) -> Result<Self, Vec<ValidationError>> {
        self.clone().validate()
    }

    fn validate(self) -> Result<Self, Vec<ValidationError>> {
        let mut errors = vec![];
        if self.data.is_none() && self.errors.is_none() {
            errors.push(ValidationError::MissingTopLevelMembers);
        }
        if self.data.is_some() && self.errors.is_some() {
            errors.push(ValidationError::DataErrorCoexist);
        }
        if self.data.is_none() && self.included.is_some() {
            errors.push(ValidationError::MissingDataAndIncluded);
        }
        if errors.is_empty() {
            Ok(self)
        } else {
            Err(errors)
        }
    }
}

#[derive(Debug)]
pub enum ValidationError {
    MissingTopLevelMembers,
    DataErrorCoexist,
    MissingDataAndIncluded,
}

#[derive(Debug, Clone, Deserialize, Serialize)]
struct JsonApiObject<'a> {
    version: &'a str,
    // TODO: Meta
}

impl Default for JsonApiObject<'_> {
    fn default() -> Self {
        JSON_API_OBJECT
    }
}

const JSON_API_OBJECT: JsonApiObject<'static> = { JsonApiObject { version: "1.0" } };