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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97

//! # EVE ESI Industry Scopes
//!
//! This module provides a type-safe way to add industry-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                                                          |
//! | ------------------------------------------- | -------------------------------------------------------------------- |
//! | [`IndustryScopes::new`]                     | Creates a new instance of [`IndustryScopes`]                         |
//! | [`IndustryScopes::all`]                     | Creates a new instance of [`IndustryScopes`] with all scopes applied |
//! | [`IndustryScopes::read_character_jobs`]     | Read access to character industry jobs                               |
//! | [`IndustryScopes::read_character_mining`]   | Read access to character's mining ledger                             |
//! | [`IndustryScopes::read_corporation_jobs`]   | Read access to corporation industry jobs                             |
//! | [`IndustryScopes::read_corporation_mining`] | Read access to corporation mining ledger (moon mining structures)    |

/// Read access to character industry jobs
pub const READ_CHARACTER_JOBS: &str = "esi-industry.read_character_jobs.v1";
/// Read access to character's mining ledger
pub const READ_CHARACTER_MINING: &str = "esi-industry.read_character_mining.v1";
/// Read access to corporation industry jobs
pub const READ_CORPORATION_JOBS: &str = "esi-industry.read_corporation_jobs.v1";
/// Read access to corporation mining ledger (moon mining structures)
pub const READ_CORPORATION_MINING: &str = "esi-industry.read_corporation_mining.v1";

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

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

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

    /// Creates a new instance of [`IndustryScopes`] with all scopes applied
    pub fn all() -> Self {
        IndustryScopes::new()
            .read_character_jobs()
            .read_character_mining()
            .read_corporation_jobs()
            .read_corporation_mining()
    }

    /// Read access to character industry jobs
    ///
    /// Adds the `esi-industry.read_character_jobs.v1` scope
    pub fn read_character_jobs(mut self) -> Self {
        self.scopes.push(READ_CHARACTER_JOBS.to_string());
        self
    }

    /// Read access to character's mining ledger
    ///
    /// Adds the `esi-industry.read_character_mining.v1` scope
    pub fn read_character_mining(mut self) -> Self {
        self.scopes.push(READ_CHARACTER_MINING.to_string());
        self
    }

    /// Read access to corporation industry jobs
    ///
    /// Adds the `esi-industry.read_corporation_jobs.v1` scope
    pub fn read_corporation_jobs(mut self) -> Self {
        self.scopes.push(READ_CORPORATION_JOBS.to_string());
        self
    }

    /// Read access to corporation mining ledger (moon mining structures)
    ///
    /// Adds the `esi-industry.read_corporation_mining.v1` scope
    pub fn read_corporation_mining(mut self) -> Self {
        self.scopes.push(READ_CORPORATION_MINING.to_string());
        self
    }
}

#[cfg(test)]
mod industry_scopes_tests {
    use crate::scope::IndustryScopes;

    /// Tests initializing a default instance of [`IndustryScopes`]
    #[test]
    fn test_industry_scopes_default() {
        let industry_scopes = IndustryScopes::default();

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