aspero-json 0.5.0

aspero's JSON contract: works, lookups, verdicts and claims as agents and apps see them
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

//! Verdicts.

use aspero_engine::{Reason, Verification};
use serde_json::{Value, json};

use crate::{merged, work};

/// A claim that couldn't be read, after its echo.
pub fn invalid_claim(echo: Value, reason: &str) -> Value {
    merged(echo, json!({"verdict": "invalid", "reason": reason}))
}

/// One verification, after the claim's echo (input, key, claim).
pub fn verification(echo: Value, v: &Verification, full: bool) -> Value {
    let mut item = merged(
        echo,
        json!({
            "verdict": v.verdict.as_str(),
            "reason": v.reason,
            "why": why(v, full),
        }),
    );
    if let Some(best) = v.best {
        item["match"] = work::candidate(&v.report.candidates[best], full);
    }
    let failures = v.report.failures();
    if !failures.is_empty() {
        let errors: Vec<String> = failures.iter().map(ToString::to_string).collect();
        item["errors"] = json!(errors);
        let kinds: Vec<&str> = failures.iter().map(|e| e.kind().as_str()).collect();
        item["error_kinds"] = json!(kinds);
    }
    if full {
        let all: Vec<Value> = v
            .report
            .candidates
            .iter()
            .map(|c| work::candidate(c, true))
            .collect();
        item["candidates"] = json!(all);
    }
    item
}

/// The reason as data: `{"code", "differs": [{"field", "actual"}], "cited":
/// candidate}`, so a front end can word it itself.
fn why(v: &Verification, full: bool) -> Value {
    let mut out = json!({"code": v.why.as_str()});
    let differs: Vec<Value> = v
        .why
        .differs()
        .iter()
        .map(|d| match &d.actual {
            Some(actual) => json!({"field": d.field.as_str(), "actual": actual}),
            None => json!({"field": d.field.as_str()}),
        })
        .collect();
    if !differs.is_empty() {
        out["differs"] = json!(differs);
    }
    if let Reason::IdElsewhere { cited } = v.why {
        out["cited"] = work::candidate(&v.report.candidates[cited], full);
    }
    out
}