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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
//! Access Manager module.
//!
//! Manage resource endpoints access token.
//! This access manager module contains the [`GrantTokenRequestBuilder`],
//! [`RevokeTokenRequestBuilder`], [`ChannelPermission`],
//! [`ChannelGroupPermission`] and [`UserIdPermission`] which is used for access
//! token management.
//!
//! This module is accountable for granting and revoking access permissions to
//! resources of the [`PubNub`] network.
//!
//! [`PubNub`]:https://www.pubnub.com/

#[doc(inline)]
pub(crate) use payloads::*;
pub(crate) mod payloads;

#[doc(inline)]
pub use types::MetaValue;
pub mod types;

#[doc(inline)]
pub use result::{
    GrantTokenResponseBody, GrantTokenResult, RevokeTokenResponseBody, RevokeTokenResult,
};
pub mod result;

#[doc(inline)]
pub use builders::*;
pub mod builders;

#[doc(inline)]
pub use permissions::*;
pub mod permissions;

use crate::dx::pubnub_client::PubNubClientInstance;
use crate::lib::alloc::string::String;
#[cfg(feature = "serde")]
use crate::providers::serialization_serde::SerdeSerializer;

impl<T, D> PubNubClientInstance<T, D> {
    /// Create grant token permissions request builder.
    /// This method is used to generate token with required permissions.
    ///
    /// Instance of [`GrantTokenRequestBuilder`] returned.
    ///
    /// # Example
    /// ```rust,no_run
    /// use pubnub::{
    ///     access::*,
    /// #    PubNubClientBuilder, Keyset,
    /// };
    /// # use std::collections::HashMap;
    ///
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let mut pubnub = // PubNubClient
    /// #     PubNubClientBuilder::with_reqwest_transport()
    /// #         .with_keyset(Keyset {
    /// #              subscribe_key: "demo",
    /// #              publish_key: Some("demo"),
    /// #              secret_key: Some("demo")
    /// #          })
    /// #         .with_user_id("uuid")
    /// #         .build()?;
    /// pubnub
    ///     .grant_token(10)
    ///     .resources(&[permissions::channel("test-channel").read().write()])
    ///     .meta(HashMap::from([
    ///          ("role".into(), "administrator".into()),
    ///          ("access-duration".into(), 2800.into()),
    ///          ("ping-interval".into(), 1754.88.into()),
    ///      ]))
    ///     .execute()
    ///     .await?;
    /// #     Ok(())
    /// # }
    /// ```
    #[cfg(feature = "serde")]
    pub fn grant_token(&self, ttl: usize) -> GrantTokenRequestBuilder<T, SerdeSerializer, D> {
        GrantTokenRequestBuilder {
            pubnub_client: Some(self.clone()),
            serializer: Some(SerdeSerializer),
            ttl: Some(ttl),
            ..Default::default()
        }
    }
    /// Create grant token permissions request builder.
    /// This method is used to generate token with required permissions.
    ///
    /// Instance of [`GrantTokenRequestWithSerializerBuilder`] returned.
    ///
    /// # Example
    /// ```rust, no_run
    /// use pubnub::{
    ///     access::*,
    ///     core::{Deserializer, PubNubError, Serializer},
    /// #    PubNubClientBuilder, Keyset,
    /// };
    /// # use std::collections::HashMap;
    ///
    /// struct MySerializer;
    /// struct MyDeserializer;
    ///
    /// impl<'se> Serializer<'se, GrantTokenPayload> for MySerializer {
    ///    fn serialize(&self, object: &'se T) -> Result<Vec<u8>, PubNubError> {
    ///         // ...
    /// #        Ok(vec![])
    ///     }
    /// }
    ///
    /// impl<'de> Deserializer<'de, GrantTokenResponseBody> for MyDeserializer {
    ///     fn deserialize(&self, response: &'de [u8]) -> Result<GrantTokenResult, PubNubError> {
    ///         // ...
    /// #        Ok(GrantTokenResult { token: "<generated token>".into() })
    ///     }
    /// }
    ///
    /// #
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let mut pubnub = // PubNubClient
    /// #     PubNubClientBuilder::with_reqwest_transport()
    /// #         .with_keyset(Keyset {
    /// #              subscribe_key: "demo",
    /// #              publish_key: Some("demo"),
    /// #              secret_key: Some("demo")
    /// #          })
    /// #         .with_user_id("uuid")
    /// #         .build()?;
    /// pubnub
    ///     .grant_token(10)
    ///     .serialize_with(MySerializer)
    ///     .derialize_with(MyDeserializer)
    ///     .resources(&[permissions::channel("test-channel").read().write()])
    ///     .meta(HashMap::from([
    ///          ("role".into(), "administrator".into()),
    ///          ("access-duration".into(), 2800.into()),
    ///          ("ping-interval".into(), 1754.88.into()),
    ///      ]))
    ///     .execute()
    ///     .await?;
    /// #     Ok(())
    /// # }
    /// ```
    #[cfg(not(feature = "serde"))]
    pub fn grant_token(&self, ttl: usize) -> GrantTokenRequestWithSerializerBuilder<T, D> {
        GrantTokenRequestWithSerializerBuilder {
            pubnub_client: self.clone(),
            ttl,
        }
    }

    /// Create grant token request builder.
    ///
    /// This method is used to revoke token permissions.
    ///
    /// Instance of [`RevokeTokenRequestBuilder`] returned.
    ///
    /// # Example
    /// ```rust,no_run
    /// use pubnub::{
    ///     access::*,
    /// #    PubNubClientBuilder, Keyset,
    /// };
    ///
    /// # #[tokio::main]
    /// # async fn main() -> Result<(), Box<dyn std::error::Error>> {
    /// let mut pubnub = // PubNubClient
    /// #     PubNubClientBuilder::with_reqwest_transport()
    /// #         .with_keyset(Keyset {
    /// #              subscribe_key: "demo",
    /// #              publish_key: Some("demo"),
    /// #              secret_key: Some("demo")
    /// #          })
    /// #         .with_user_id("uuid")
    /// #         .build()?;
    /// pubnub
    ///     .revoke_token("p0F2AkF0Gl043r....Dc3BjoERtZXRhoENzaWdYIGOAeTyWGJI")
    ///     .execute()
    ///     .await?;
    /// #     Ok(())
    /// # }
    /// ```
    pub fn revoke_token<S>(&self, token: S) -> RevokeTokenRequestBuilder<T, D>
    where
        S: Into<String>,
    {
        RevokeTokenRequestBuilder {
            pubnub_client: Some(self.clone()),
            token: Some(token.into()),
        }
    }
}

#[cfg(test)]
mod it_should {
    use super::*;
    use crate::{
        core::{PubNubError, Transport, TransportMethod, TransportRequest, TransportResponse},
        dx::pubnub_client::PubNubClientInstance,
        lib::{
            alloc::{borrow::ToOwned, format, vec, vec::Vec},
            collections::HashMap,
        },
        providers::deserialization_serde::DeserializerSerde,
        transport::middleware::PubNubMiddleware,
        {Keyset, PubNubClientBuilder},
    };

    /// Requests handler function type.
    type RequestHandler = Box<dyn Fn(&TransportRequest) + Send + Sync>;

    #[derive(Default)]
    struct MockTransport {
        ///  Response which mocked transport should return.
        response: Option<TransportResponse>,

        /// Request handler function which will be called before returning
        /// response.
        ///
        /// Use function to verify request parameters.
        request_handler: Option<RequestHandler>,
    }

    #[async_trait::async_trait]
    impl Transport for MockTransport {
        async fn send(&self, req: TransportRequest) -> Result<TransportResponse, PubNubError> {
            // Calling request handler (if provided).
            if let Some(handler) = &self.request_handler {
                handler(&req);
            }

            Ok(self
                .response
                .clone()
                .unwrap_or(transport_response(200, None)))
        }
    }

    /// Service response payload.
    fn transport_response(status: u16, token: Option<String>) -> TransportResponse {
        let error = "\"error\":{{\"message\":\"Overall error\",\"source\":\"test\",\
        \"details\":[{{\"message\":\"Error\",\"location\":\"signature\",\"locationType\":\"query\"}}]}}";
        let data = format!(
            "\"data\":{{\"message\":\"Success\"{}}}}}",
            token.map_or(String::new(), |t| format!(",\"token\":\"{}\"", t))
        );

        TransportResponse {
            status,
            body: Some(Vec::from(format!(
                "{{\"status\":{},\"service\":\"Access Manager\",{}",
                status,
                if status < 400 { data } else { error.to_owned() }
            ))),
            ..Default::default()
        }
    }

    /// List of default permissions.
    fn permissions() -> Vec<Box<dyn permissions::Permission>> {
        vec![
            permissions::channel("channel").read().update(),
            permissions::user_id("id").get().delete(),
        ]
    }

    /// Construct test client with mocked transport.
    fn client(
        with_subscribe_key: bool,
        with_secret_key: bool,
        with_auth_key: Option<String>,
        with_auth_token: Option<String>,
        transport: Option<MockTransport>,
    ) -> PubNubClientInstance<PubNubMiddleware<MockTransport>, DeserializerSerde> {
        let mut builder = PubNubClientBuilder::with_transport(transport.unwrap_or(MockTransport {
            response: None,
            request_handler: None,
        }))
        .with_keyset(Keyset {
            subscribe_key: if with_subscribe_key { "demo" } else { "" },
            publish_key: Some(""),
            secret_key: with_secret_key.then_some("demo"),
        })
        .with_user_id("user");

        if let Some(auth_key) = with_auth_key {
            builder = builder.with_auth_key(auth_key);
        }

        let client = builder.build().unwrap();

        if let Some(auth_token) = with_auth_token {
            client.set_token(auth_token);
        }

        client
    }

    #[test]
    fn not_grant_token_when_subscribe_key_missing() {
        let permissions = permissions();
        let client = client(false, true, None, None, None);
        let request = client.grant_token(10).resources(&permissions).build();

        assert!(&client.config.subscribe_key.is_empty());
        assert!(request.is_err());
    }

    #[test]
    fn not_grant_token_when_secret_key_missing() {
        let permissions = permissions();
        let client = client(true, false, None, None, None);
        let request = client.grant_token(10).resources(&permissions).build();

        assert!(client
            .config
            .secret_key
            .as_deref()
            .unwrap_or_default()
            .is_empty());
        assert!(request.is_err());
    }

    #[tokio::test]
    async fn grant_token() {
        let permissions = permissions();
        let transport = MockTransport {
            response: Some(transport_response(200, Some("test-token".into()))),
            ..Default::default()
        };
        let client = client(true, true, None, None, Some(transport));
        let result = client
            .grant_token(10)
            .resources(&permissions)
            .execute()
            .await;

        match result {
            Ok(response) => assert_eq!(response.token, "test-token"),
            Err(err) => panic!("Request should not fail: {}", err),
        }
    }

    #[tokio::test]
    async fn include_timestamp_in_query_for_grant_token() {
        let permissions = permissions();
        let transport = MockTransport {
            response: None,
            request_handler: Some(Box::new(|req| {
                assert!(req.query_parameters.contains_key("timestamp"));
                assert!(req.query_parameters.get("timestamp").is_some());
            })),
        };

        let _ = client(true, true, None, None, Some(transport))
            .grant_token(10)
            .resources(&permissions)
            .execute()
            .await;
    }

    #[tokio::test]
    async fn include_signature_in_query_for_grant_token() {
        let permissions = permissions();
        let transport = MockTransport {
            response: None,
            request_handler: Some(Box::new(|req| {
                assert!(req.query_parameters.contains_key("signature"));
                assert!(req.query_parameters.get("signature").is_some());
                assert!(req
                    .query_parameters
                    .get("signature")
                    .unwrap()
                    .contains("v2."));
            })),
        };

        let _ = client(true, true, None, None, Some(transport))
            .grant_token(10)
            .resources(&permissions)
            .execute()
            .await;
    }

    #[test]
    fn include_body_for_grant_token() {
        let permissions = permissions();
        let request = client(true, true, None, None, None)
            .grant_token(10)
            .resources(&permissions)
            .meta(HashMap::from([
                ("string".into(), "string-value".into()),
                ("integer".into(), 465.into()),
                ("float".into(), 15.89.into()),
                ("boolean".into(), true.into()),
                ("null".into(), ().into()),
            ]))
            .build()
            .unwrap()
            .transport_request();

        // Serialization order is not constant. so ensure thar required
        // key/value pairs is present in body.
        let body = String::from_utf8(request.body.unwrap()).unwrap_or("".into());
        assert!(body.contains("\"string\":\"string-value\""));
        assert!(body.contains("\"boolean\":true"));
        assert!(body.contains("\"null\":null"));
        assert!(body.contains("\"integer\":465"));
        assert!(body.contains("\"float\":15.89"));
        assert!(body.contains("\"channels\":{\"channel\":65}"));
        assert!(body.contains("\"uuids\":{\"id\":40}"));
        assert!(matches!(&request.method, TransportMethod::Post));
    }

    #[test]
    fn not_revoke_token_when_subscribe_key_missing() {
        let client = client(false, true, None, None, None);
        let request = client.revoke_token("test/to+en==").build();

        assert!(&client.config.subscribe_key.is_empty());
        assert!(request.is_err());
    }

    #[test]
    fn not_revoke_token_when_secret_key_missing() {
        let client = client(true, false, None, None, None);
        let request = client.revoke_token("test/to+en==").build();

        assert!(client
            .config
            .secret_key
            .as_deref()
            .unwrap_or_default()
            .is_empty());
        assert!(request.is_err());
    }

    #[tokio::test]
    async fn revoke_token() {
        let client = client(true, true, None, None, None);
        let result = client.revoke_token("test/to+en==").execute().await;

        assert!(result.is_ok());
    }

    #[tokio::test]
    async fn include_encoded_token_in_path_for_revoke_token() {
        let request = client(true, true, None, None, None)
            .revoke_token("test/to+en==")
            .build()
            .unwrap()
            .transport_request();
        dbg!(&request.path);
        assert!(request.path.ends_with("test%2Fto%2Ben%3D%3D"));
        assert!(matches!(&request.method, TransportMethod::Delete));
    }

    #[tokio::test]
    async fn include_auth_key_in_query_for_revoke_token() {
        let transport = MockTransport {
            response: None,
            request_handler: Some(Box::new(|req| {
                assert!(req.query_parameters.contains_key("auth"));
                assert_eq!(req.query_parameters.get("auth").unwrap(), "auth-key");
            })),
        };
        let client = client(true, true, Some("auth-key".into()), None, Some(transport));

        let _ = client.revoke_token("test/to+en==").execute().await;
    }

    #[tokio::test]
    async fn include_auth_token_in_query_for_revoke_token() {
        let transport = MockTransport {
            response: None,
            request_handler: Some(Box::new(|req| {
                assert!(req.query_parameters.contains_key("auth"));
                assert_eq!(req.query_parameters.get("auth").unwrap(), "auth-token");
            })),
        };

        let client = client(true, true, None, Some("auth-token".into()), Some(transport));

        let _ = client.revoke_token("test/to+en==").execute().await;
    }

    #[tokio::test]
    async fn include_auth_token_when_auth_key_present_in_query_for_revoke_token() {
        let transport = MockTransport {
            response: None,
            request_handler: Some(Box::new(|req| {
                assert!(req.query_parameters.contains_key("auth"));
                assert_eq!(req.query_parameters.get("auth").unwrap(), "auth-token");
            })),
        };
        let client = client(
            true,
            true,
            Some("auth-key".into()),
            Some("auth-token".into()),
            Some(transport),
        );

        let _ = client.revoke_token("test/to+en==").execute().await;
    }
}