doido-cable 0.0.13

Action Cable analogue: channels, broadcasts, Turbo-friendly pub/sub backends for Doido.
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

//! Cable connection identity + authorization (Rails `identified_by` /
//! `reject_unauthorized_connection`).
//!
//! A connection carries named identifiers (e.g. `current_user`) and is rejected
//! until it is authorized (e.g. after verifying a token in `connect`).

use std::collections::BTreeMap;

/// The identity of one WebSocket connection.
#[derive(Debug, Default, Clone)]
pub struct CableConnection {
    identifiers: BTreeMap<String, String>,
    authorized: bool,
}

impl CableConnection {
    pub fn new() -> Self {
        Self::default()
    }

    /// Attach an identifier (Rails `self.current_user = ...`).
    pub fn identify(&mut self, key: &str, value: &str) -> &mut Self {
        self.identifiers.insert(key.to_string(), value.to_string());
        self
    }

    /// Read an identifier.
    pub fn identifier(&self, key: &str) -> Option<&str> {
        self.identifiers.get(key).map(String::as_str)
    }

    /// Mark the connection authorized (accept it).
    pub fn authorize(&mut self) -> &mut Self {
        self.authorized = true;
        self
    }

    /// Reject the connection (Rails `reject_unauthorized_connection`).
    pub fn reject(&mut self) -> &mut Self {
        self.authorized = false;
        self
    }

    /// Whether the connection has been authorized.
    pub fn is_authorized(&self) -> bool {
        self.authorized
    }
}