ankit 0.1.0

Complete async Rust client for the AnkiConnect API
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
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

//! Tests for statistics actions.

mod common;

use ankit::AnkiClient;
use common::{mock_action, mock_anki_response, setup_mock_server};

#[tokio::test]
async fn test_cards_reviewed_today() {
    let server = setup_mock_server().await;
    let client = AnkiClient::builder().url(server.uri()).build();

    mock_action(
        &server,
        "getNumCardsReviewedToday",
        mock_anki_response(42_i64),
    )
    .await;

    let result = client.statistics().cards_reviewed_today().await.unwrap();
    assert_eq!(result, 42);
}

#[tokio::test]
async fn test_cards_reviewed_by_day() {
    let server = setup_mock_server().await;
    let client = AnkiClient::builder().url(server.uri()).build();

    // AnkiConnect returns an array of [date, count] pairs
    let by_day = vec![("2024-01-15", 30_i64), ("2024-01-16", 25_i64)];

    mock_action(
        &server,
        "getNumCardsReviewedByDay",
        mock_anki_response(by_day),
    )
    .await;

    let result = client.statistics().cards_reviewed_by_day().await.unwrap();
    assert_eq!(result.len(), 2);
    assert_eq!(result[0].0, "2024-01-15");
    assert_eq!(result[0].1, 30);
}

#[tokio::test]
async fn test_collection_html() {
    let server = setup_mock_server().await;
    let client = AnkiClient::builder().url(server.uri()).build();

    mock_action(
        &server,
        "getCollectionStatsHTML",
        mock_anki_response("<html>stats</html>"),
    )
    .await;

    let result = client.statistics().collection_html(true).await.unwrap();
    assert!(result.contains("stats"));
}

#[tokio::test]
async fn test_latest_review_id() {
    let server = setup_mock_server().await;
    let client = AnkiClient::builder().url(server.uri()).build();

    mock_action(
        &server,
        "getLatestReviewID",
        mock_anki_response(1705330000000_i64),
    )
    .await;

    let result = client
        .statistics()
        .latest_review_id("Default")
        .await
        .unwrap();
    assert_eq!(result, 1705330000000);
}

#[tokio::test]
async fn test_reviews_since() {
    let server = setup_mock_server().await;
    let client = AnkiClient::builder().url(server.uri()).build();

    mock_action(
        &server,
        "cardReviews",
        mock_anki_response(serde_json::json!({
            "1234567890": [[1705330000000_i64, 3, 10]],
            "1234567891": [[1705330100000_i64, 2, 5]]
        })),
    )
    .await;

    let result = client
        .statistics()
        .reviews_since("Default", 0)
        .await
        .unwrap();
    assert_eq!(result.len(), 2);
    assert!(result.contains_key("1234567890"));
}

#[tokio::test]
async fn test_reviews_for_cards() {
    let server = setup_mock_server().await;
    let client = AnkiClient::builder().url(server.uri()).build();

    mock_action(
        &server,
        "getReviewsOfCards",
        mock_anki_response(serde_json::json!({
            "1234567890": [{
                "cardId": 1234567890_i64,
                "id": 1705330000000_i64,
                "ease": 3,
                "ivl": 10,
                "lastIvl": 1,
                "factor": 2500,
                "time": 5000,
                "type": 1
            }]
        })),
    )
    .await;

    let result = client
        .statistics()
        .reviews_for_cards(&[1234567890])
        .await
        .unwrap();
    assert_eq!(result.len(), 1);
    let reviews = result.get("1234567890").unwrap();
    assert_eq!(reviews[0].card_id, 1234567890);
    assert_eq!(reviews[0].ease, 3);
}

#[tokio::test]
async fn test_insert_reviews() {
    let server = setup_mock_server().await;
    let client = AnkiClient::builder().url(server.uri()).build();

    mock_action(
        &server,
        "insertReviews",
        wiremock::ResponseTemplate::new(200).set_body_json(serde_json::json!({
            "result": null,
            "error": null
        })),
    )
    .await;

    let reviews = vec![
        ankit::ReviewEntry::new(1234567890, 1705330000000)
            .ease(3)
            .interval(10)
            .time(5000),
    ];

    let result = client.statistics().insert(&reviews).await;
    assert!(result.is_ok());
}