jrpc-types 0.1.0

A simple but super helpful crate for (de)serializing JSON-RPC 2.0 objects.
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144

//! This module implements the response JSON-RPC object.

use crate::{error::Error, id::Id};

pub mod builder;

#[derive(Debug, Clone, PartialEq, serde::Deserialize, serde::Serialize)]
/// The JSON-RPC Response Object
pub struct Response {
    #[serde(deserialize_with = "crate::version::version_deserialize")]
    jsonrpc: String,
    pub id: Id,
    #[serde(flatten)]
    pub status: Status,
}

#[derive(Debug, Clone, PartialEq, serde::Deserialize, serde::Serialize)]
/// The Response Status can be either success or failure.
pub enum Status {
    #[serde(rename = "result")]
    Success(serde_json::Value),
    #[serde(rename = "error")]
    Error {
        code: i32,
        message: String,
        data: Option<serde_json::Value>,
    },
}

impl Response {
    pub fn builder() -> builder::Builder<builder::IdNone> {
        builder::Builder::new()
    }
}

impl TryFrom<&str> for Response {
    type Error = Error;

    fn try_from(value: &str) -> Result<Self, Self::Error> {
        serde_json::from_str(value).map_err(|e| e.into())
    }
}

impl TryFrom<Response> for String {
    type Error = Error;

    fn try_from(value: Response) -> Result<Self, Self::Error> {
        serde_json::to_string(&value).map_err(|e| e.into())
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn deserialize_spec_requests() {
        let req = r#"{"jsonrpc": "2.0", "result": 19, "id": 1}"#;
        let req_obj = TryInto::<Response>::try_into(req);
        assert!(req_obj.is_ok());
        let req_obj = req_obj.unwrap();
        assert_eq!(req_obj.jsonrpc, "2.0");
        assert!(matches!(
            req_obj.status,
            Status::Success(serde_json::Value::Number(_))
        ));

        let req = r#"{"jsonrpc": "2.0", "result": -19, "id": 2}"#;
        let req_obj = TryInto::<Response>::try_into(req);
        assert!(req_obj.is_ok());
        let req_obj = req_obj.unwrap();
        assert_eq!(req_obj.jsonrpc, "2.0");
        assert!(matches!(
            req_obj.status,
            Status::Success(serde_json::Value::Number(_))
        ));

        let req = r#"{"jsonrpc": "2.0", "error": {"code": -32601, "message": "Method not found"}, "id": "1"}"#;
        let req_obj = TryInto::<Response>::try_into(req);
        assert!(req_obj.is_ok());
        let req_obj = req_obj.unwrap();
        assert_eq!(req_obj.jsonrpc, "2.0");
        assert!(matches!(
            req_obj.status,
            Status::Error {
                code: _,
                message: _,
                data: _
            }
        ));

        let req = r#"{"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}, "id": null}"#;
        let req_obj = TryInto::<Response>::try_into(req);
        assert!(req_obj.is_ok());
        let req_obj = req_obj.unwrap();
        assert_eq!(req_obj.jsonrpc, "2.0");
        assert!(matches!(
            req_obj.status,
            Status::Error {
                code: _,
                message: _,
                data: _
            }
        ));
    }

    #[test]
    fn negative_serde_tests() {
        let req = r#"{"jsonrpc": "2.1", "error": {"code": -32600, "message": "Invalid Request"}, "id": null}"#; // invalid version
        let req_obj = TryInto::<Response>::try_into(req);
        assert!(req_obj.is_err());

        let req = r#"{"jsonrpc": 2.1, "error": {"code": -32600, "message": "Invalid Request"}, "id": null}"#; // number version
        let req_obj = TryInto::<Response>::try_into(req);
        assert!(req_obj.is_err());

        let req = r#"{"jsonrpc": "2.0", "id": null}"#; // no result or error
        let req_obj = TryInto::<Response>::try_into(req);
        assert!(req_obj.is_err());

        let req = r#"{"jsonrpc": "2.0", "error": {"code": -32600, "message": "Invalid Request"}}"#; // no id
        let req_obj = TryInto::<Response>::try_into(req);
        assert!(req_obj.is_err());
    }

    #[test]
    fn builder() {
        let params = vec![10, 0];
        let rsp = Response::builder()
            .id(10)
            .success()
            .result(params)
            .unwrap()
            .build();
        let rsp_str = TryInto::<String>::try_into(rsp).unwrap();
        let new_req = TryInto::<Response>::try_into(rsp_str.as_str());
        assert!(new_req.is_ok());

        let rsp = Response::builder().error().invalid_params().id(10).build();
        let rsp_str = TryInto::<String>::try_into(rsp).unwrap();
        let new_req = TryInto::<Response>::try_into(rsp_str.as_str());
        assert!(new_req.is_ok());
    }
}