eve_esi 0.4.9

Thread-safe, asynchronous client for EVE Online's ESI & OAuth2
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

//! # EVE ESI Calendar Scopes
//!
//! This module provides a type-safe way to add calendar-related scopes for OAuth2 to the [`super::ScopeBuilder`]
//!
//! See [module-level documentation](super) for an overview & usage of scopes for the esi_crate
//!
//! ## Methods
//! | Method                                      | Description                                                          |
//! | ------------------------------------------- | -------------------------------------------------------------------- |
//! | [`CalendarScopes::new`]                     | Creates a new instance of [`CalendarScopes`]                         |
//! | [`CalendarScopes::all`]                     | Creates a new instance of [`CalendarScopes`] with all scopes applied |
//! | [`CalendarScopes::read_calendar_events`]    | Read access to calendar events                                       |
//! | [`CalendarScopes::respond_calendar_events`] | Access to respond to calendar events on behalf of the character      |

/// Read access to calendar events
pub const READ_CALENDAR_EVENTS: &str = "esi-calendar.read_calendar_events.v1";
/// Access to respond to calendar events on behalf of the character
pub const RESPOND_CALENDAR_EVENTS: &str = "esi-calendar.respond_calendar_events.v1";

/// Struct with methods for listing calendar scopes to request for OAuth2
pub struct CalendarScopes {
    pub(super) scopes: Vec<String>,
}

impl Default for CalendarScopes {
    /// Create a default instance of [`CalendarScopes`]
    fn default() -> Self {
        Self::new()
    }
}

impl CalendarScopes {
    /// Create a new instance of [`CalendarScopes`]
    pub fn new() -> Self {
        CalendarScopes { scopes: Vec::new() }
    }

    /// Creates a new instance of [`CalendarScopes`] with all scopes applied
    pub fn all() -> Self {
        CalendarScopes::new()
            .read_calendar_events()
            .respond_calendar_events()
    }

    /// Read access to calendar events
    ///
    /// Adds the `esi-calendar.read_calendar_events.v1` scope
    pub fn read_calendar_events(mut self) -> Self {
        self.scopes.push(READ_CALENDAR_EVENTS.to_string());
        self
    }

    /// Access to respond to calendar events on behalf of the character
    ///
    /// Adds the `esi-calendar.respond_calendar_events.v1` scope
    pub fn respond_calendar_events(mut self) -> Self {
        self.scopes.push(RESPOND_CALENDAR_EVENTS.to_string());
        self
    }
}

#[cfg(test)]
mod calendar_scopes_tests {
    use crate::scope::CalendarScopes;

    /// Tests initializing a default instance of [`CalendarScopes`]
    #[test]
    fn test_calendar_scopes_default() {
        let calendar_scopes = CalendarScopes::default();

        assert_eq!(calendar_scopes.scopes.len(), 0)
    }
}