anylist_rs 0.4.0

Interact with the grocery list management app AnyList's undocumented API. Unofficial.
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

/// Events that can be received via real-time sync
#[derive(Debug, Clone, PartialEq, Eq)]
pub enum SyncEvent {
    /// Shopping lists have changed - re-fetch with get_lists()
    ShoppingListsChanged,

    /// Categorized items have changed
    CategorizedItemsChanged,

    /// List folders have changed
    ListFoldersChanged,

    /// List settings have changed
    ListSettingsChanged,

    /// Starter lists (Today's/Weekly) have changed
    StarterListsChanged,

    /// Starter list order has changed
    StarterListOrderChanged,

    /// Starter list settings have changed
    StarterListSettingsChanged,

    /// Mobile app settings have changed
    MobileAppSettingsChanged,

    /// User categories have changed
    UserCategoriesChanged,

    /// Recipe data has changed
    RecipeDataChanged,

    /// Meal plan calendar has changed
    MealPlanCalendarChanged,

    /// Account info has changed
    AccountInfoChanged,

    /// Subscription info has changed
    SubscriptionInfoChanged,

    /// User account has been deleted - should logout
    AccountDeleted,

    /// Heartbeat received (internal, usually not exposed to consumers)
    Heartbeat,
}

impl SyncEvent {
    /// Parse a WebSocket message into a SyncEvent
    pub fn from_message(msg: &str) -> Option<Self> {
        match msg {
            "--heartbeat--" => Some(SyncEvent::Heartbeat),
            "refresh-shopping-lists" => Some(SyncEvent::ShoppingListsChanged),
            "refresh-categorized-items" => Some(SyncEvent::CategorizedItemsChanged),
            "refresh-list-folders" => Some(SyncEvent::ListFoldersChanged),
            "refresh-list-settings" => Some(SyncEvent::ListSettingsChanged),
            "refresh-starter-lists" => Some(SyncEvent::StarterListsChanged),
            "refresh-ordered-starter-list-ids" => Some(SyncEvent::StarterListOrderChanged),
            "refresh-starter-list-settings" => Some(SyncEvent::StarterListSettingsChanged),
            "refresh-mobile-app-settings" => Some(SyncEvent::MobileAppSettingsChanged),
            "refresh-user-categories" => Some(SyncEvent::UserCategoriesChanged),
            "refresh-user-recipe-data" => Some(SyncEvent::RecipeDataChanged),
            "refresh-meal-plan-calendar" => Some(SyncEvent::MealPlanCalendarChanged),
            "refresh-account-info" => Some(SyncEvent::AccountInfoChanged),
            "refresh-subscription-info" => Some(SyncEvent::SubscriptionInfoChanged),
            "did-delete-account" => Some(SyncEvent::AccountDeleted),
            _ => None,
        }
    }
}

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

    #[test]
    fn test_parse_heartbeat() {
        assert_eq!(
            SyncEvent::from_message("--heartbeat--"),
            Some(SyncEvent::Heartbeat)
        );
    }

    #[test]
    fn test_parse_shopping_lists_changed() {
        assert_eq!(
            SyncEvent::from_message("refresh-shopping-lists"),
            Some(SyncEvent::ShoppingListsChanged)
        );
    }

    #[test]
    fn test_parse_account_deleted() {
        assert_eq!(
            SyncEvent::from_message("did-delete-account"),
            Some(SyncEvent::AccountDeleted)
        );
    }

    #[test]
    fn test_parse_unknown_message() {
        assert_eq!(SyncEvent::from_message("unknown-message"), None);
    }

    #[test]
    fn test_all_known_messages() {
        let messages = vec![
            ("--heartbeat--", SyncEvent::Heartbeat),
            ("refresh-shopping-lists", SyncEvent::ShoppingListsChanged),
            (
                "refresh-categorized-items",
                SyncEvent::CategorizedItemsChanged,
            ),
            ("refresh-list-folders", SyncEvent::ListFoldersChanged),
            ("refresh-list-settings", SyncEvent::ListSettingsChanged),
            ("refresh-starter-lists", SyncEvent::StarterListsChanged),
            (
                "refresh-ordered-starter-list-ids",
                SyncEvent::StarterListOrderChanged,
            ),
            (
                "refresh-starter-list-settings",
                SyncEvent::StarterListSettingsChanged,
            ),
            (
                "refresh-mobile-app-settings",
                SyncEvent::MobileAppSettingsChanged,
            ),
            ("refresh-user-categories", SyncEvent::UserCategoriesChanged),
            ("refresh-user-recipe-data", SyncEvent::RecipeDataChanged),
            (
                "refresh-meal-plan-calendar",
                SyncEvent::MealPlanCalendarChanged,
            ),
            ("refresh-account-info", SyncEvent::AccountInfoChanged),
            (
                "refresh-subscription-info",
                SyncEvent::SubscriptionInfoChanged,
            ),
            ("did-delete-account", SyncEvent::AccountDeleted),
        ];

        for (msg, expected) in messages {
            assert_eq!(
                SyncEvent::from_message(msg),
                Some(expected),
                "Failed to parse: {}",
                msg
            );
        }
    }
}