xapi-rs 0.2.0

A conformant LRS implementation of xAPI 2.0.0
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
145

// SPDX-License-Identifier: GPL-3.0-or-later

#![allow(non_snake_case)]

mod utils;

use rocket::http::{ContentType, Status};
use std::str::FromStr;
use test_context::test_context;
use tracing_test::traced_test;
use utils::{MyTestContext, accept_json, authorization, read_to_string, v2};
use uuid::Uuid;
use xapi_data::{Activity, MyLanguageTag, Statement, Vocabulary, adl_verb};
use xapi_rs::MyError;

#[test_context(MyTestContext)]
#[traced_test]
#[test]
fn test_merge_lmaps(ctx: &mut MyTestContext) -> Result<(), MyError> {
    const S: &str = r#"[
{
  "actor":{"objectType":"Agent","name":"xAPI account","mbox":"a99@xapi.net"},
  "verb":{"id":"http://adlnet.gov/expapi/verbs/attended","display":{"en-GB":"attended"}},
  "object":{
    "objectType":"Activity",
    "id":"http://www.xapi.net/activity/12345",
    "definition":{
      "type":"http://adlnet.gov/expapi/activities/meeting",
      "name":{"en-GB":"meeting","en-US":"meeting"},
      "description":{"en-US":"A past meeting."},
      "moreInfo":"https://somewhere.org/345256",
      "extensions":{
        "http://example.com/profiles/meetings/extension/location":"X:\\\\meetings\\\\minutes\\\\examplemeeting.one",
        "http://example.com/profiles/meetings/extension/reporter":{"name":"James","id":"http://openid.com/342"}
      }
    }
  }
},{
  "actor":{"objectType":"Agent","name":"xAPI account","mbox":"a86@xapi.net"},
  "verb":{"id":"http://adlnet.gov/expapi/verbs/attended","display":{"en-US":"attended"}},
  "object":{
    "objectType":"Activity",
    "id":"http://www.xapi.net/activity/12345",
    "definition":{
      "type":"http://adlnet.gov/expapi/activities/meeting",
      "name":{"en-GB":"meeting","fr-FR":"réunion"},
      "description":{"en-GB":"A past meeting."},
      "moreInfo":"https://somewhere.org/345256",
      "extensions":{
        "http://example.com/profiles/meetings/extension/location":"X:\\\\meetings\\\\minutes\\\\examplemeeting.one",
        "http://example.com/profiles/meetings/extension/editor":{"name":"Ed","id":"http://openid.com/342"}
      }
    }
  }
}]"#;

    let client = &ctx.client;

    // 1. POST 2 statements referencing same Activity IRI but w/ different
    //    ActivityDefinition values
    let req = client
        .post("/statements")
        .body(S)
        .header(ContentType::JSON)
        .header(accept_json())
        .header(v2())
        .header(authorization());

    let resp = req.dispatch();
    assert_eq!(resp.status(), Status::Ok);

    // 2. GET that Activity by its IRI...
    let req = client
        .get("/activities/?activityId=http://www.xapi.net/activity/12345")
        .header(ContentType::JSON)
        .header(accept_json())
        .header(v2())
        .header(authorization());

    let resp = req.dispatch();
    assert_eq!(resp.status(), Status::Ok);
    assert_eq!(resp.content_type(), Some(ContentType::JSON));
    let act = resp
        .into_json::<Activity>()
        .expect("Failed deserializing Activity");

    // ActivityDefinition name, description, and extensions should now reflect
    // merged/combined result...
    let gb = MyLanguageTag::from_str("en-GB")?;
    let us = MyLanguageTag::from_str("en-US")?;
    let fr = MyLanguageTag::from_str("fr-FR")?;

    assert_eq!(act.name(&gb), Some("meeting"));
    assert_eq!(act.name(&us), Some("meeting"));
    assert_eq!(act.name(&fr), Some("réunion"));
    assert_eq!(act.description(&gb), Some("A past meeting."));
    assert_eq!(act.description(&us), Some("A past meeting."));
    assert_eq!(act.extensions().map_or(0, |x| x.len()), 3);

    Ok(())
}

#[test]
fn test_deserialize_extensions() -> Result<(), MyError> {
    // 1. ensure we can correctly deserialize...
    let json = read_to_string("conformance-99", true);

    let s = serde_json::from_str::<Statement>(&json).unwrap();

    assert!(s.id().is_none());

    // let agent = s.actor()?.as_agent()?;
    let agent = s.actor().as_agent()?;
    assert_eq!(agent.name_as_str(), Some("xAPI account"));

    let verb = s.verb();
    assert!(adl_verb(Vocabulary::Attended).equivalent(verb));

    let object = s.object().as_activity()?;
    assert_eq!(
        object.id_as_str(),
        "http://www.example.com/meetings/occurances/34534"
    );

    let ctx = s.context().unwrap();
    assert_eq!(
        ctx.registration().unwrap(),
        &Uuid::from_str("ec531277b57b4c158d91d292c5b2b8f7").unwrap()
    );

    let ctx_act = ctx.context_activities().unwrap();
    assert_eq!(ctx_act.parent().len(), 0);
    assert_eq!(ctx_act.grouping().len(), 0);
    assert_eq!(ctx_act.category().len(), 1);
    assert_eq!(ctx_act.other().len(), 0);

    let cat = &ctx_act.category()[0];
    assert_eq!(
        cat.id_as_str(),
        "http://www.example.com/test/array/statements/pri"
    );
    assert_eq!(cat.extensions().unwrap().len(), 2);

    Ok(())
}