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
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
use std::collections::btree_map::{BTreeMap, Entry};
use std::collections::{BTreeSet, HashMap};
use std::default::Default;
use std::fmt;
use std::fmt::Display;

use url::form_urlencoded::Serializer;

use graph_error::{AuthorizationFailure, IdentityResult};

use crate::identity::{AsQuery, Prompt, ResponseType};
use crate::strum::IntoEnumIterator;

/// Fields that represent common OAuth credentials.
#[derive(
    Debug, Copy, Clone, Ord, PartialOrd, Eq, PartialEq, Hash, Serialize, Deserialize, EnumIter,
)]
pub enum AuthParameter {
    ClientId,
    ClientSecret,
    RedirectUri,
    AuthorizationCode,
    AccessToken,
    RefreshToken,
    ResponseMode,
    State,
    SessionState,
    ResponseType,
    GrantType,
    Nonce,
    Prompt,
    IdToken,
    Resource,
    DomainHint,
    Scope,
    LoginHint,
    ClientAssertion,
    ClientAssertionType,
    CodeVerifier,
    CodeChallenge,
    CodeChallengeMethod,
    AdminConsent,
    Username,
    Password,
    DeviceCode,
}

impl AuthParameter {
    pub fn alias(self) -> &'static str {
        match self {
            AuthParameter::ClientId => "client_id",
            AuthParameter::ClientSecret => "client_secret",
            AuthParameter::RedirectUri => "redirect_uri",
            AuthParameter::AuthorizationCode => "code",
            AuthParameter::AccessToken => "access_token",
            AuthParameter::RefreshToken => "refresh_token",
            AuthParameter::ResponseMode => "response_mode",
            AuthParameter::ResponseType => "response_type",
            AuthParameter::State => "state",
            AuthParameter::SessionState => "session_state",
            AuthParameter::GrantType => "grant_type",
            AuthParameter::Nonce => "nonce",
            AuthParameter::Prompt => "prompt",
            AuthParameter::IdToken => "id_token",
            AuthParameter::Resource => "resource",
            AuthParameter::DomainHint => "domain_hint",
            AuthParameter::Scope => "scope",
            AuthParameter::LoginHint => "login_hint",
            AuthParameter::ClientAssertion => "client_assertion",
            AuthParameter::ClientAssertionType => "client_assertion_type",
            AuthParameter::CodeVerifier => "code_verifier",
            AuthParameter::CodeChallenge => "code_challenge",
            AuthParameter::CodeChallengeMethod => "code_challenge_method",
            AuthParameter::AdminConsent => "admin_consent",
            AuthParameter::Username => "username",
            AuthParameter::Password => "password",
            AuthParameter::DeviceCode => "device_code",
        }
    }

    fn is_debug_redacted(&self) -> bool {
        matches!(
            self,
            AuthParameter::ClientId
                | AuthParameter::ClientSecret
                | AuthParameter::AccessToken
                | AuthParameter::RefreshToken
                | AuthParameter::IdToken
                | AuthParameter::CodeVerifier
                | AuthParameter::CodeChallenge
                | AuthParameter::Password
        )
    }
}

impl Display for AuthParameter {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        write!(f, "{}", self.alias())
    }
}

impl AsRef<str> for AuthParameter {
    fn as_ref(&self) -> &'static str {
        self.alias()
    }
}

/// Serializer for query/x-www-form-urlencoded OAuth requests.
///
/// OAuth Serializer for query/form serialization that supports the OAuth 2.0 and OpenID
/// Connect protocols on Microsoft identity platform.
///
/// # Example
/// ```
/// use graph_oauth::extensions::AuthSerializer;
/// let oauth = AuthSerializer::new();
/// ```
#[derive(Default, Clone, Eq, PartialEq, Serialize, Deserialize)]
pub struct AuthSerializer {
    scopes: BTreeSet<String>,
    parameters: BTreeMap<String, String>,
    log_pii: bool,
}

impl AuthSerializer {
    /// Create a new OAuth instance.
    ///
    /// # Example
    /// ```
    /// use graph_oauth::extensions::AuthSerializer;
    ///
    /// let mut oauth = AuthSerializer::new();
    /// ```
    pub fn new() -> AuthSerializer {
        AuthSerializer {
            scopes: BTreeSet::new(),
            parameters: BTreeMap::new(),
            log_pii: false,
        }
    }

    /// Insert oauth credentials using the OAuthParameter enum.
    /// This method is used internally for each of the setter methods.
    /// Callers can optionally use this method to set credentials instead
    /// of the individual setter methods.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # use graph_oauth::extensions::AuthParameter;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.insert(AuthParameter::AuthorizationCode, "code");
    /// assert!(oauth.contains(AuthParameter::AuthorizationCode));
    /// println!("{:#?}", oauth.get(AuthParameter::AuthorizationCode));
    /// ```
    pub fn insert<V: ToString>(&mut self, oac: AuthParameter, value: V) -> &mut AuthSerializer {
        self.parameters.insert(oac.to_string(), value.to_string());
        self
    }

    /// Insert and OAuth credential using the entry trait and
    /// returning the credential. This internally calls
    /// `entry.(OAuthParameter).or_insret_with(value)`.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # use graph_oauth::extensions::AuthParameter;
    /// # let mut oauth = AuthSerializer::new();
    /// let entry = oauth.entry_with(AuthParameter::AuthorizationCode, "code");
    /// assert_eq!(entry, "code")
    /// ```
    pub fn entry_with<V: ToString>(&mut self, oac: AuthParameter, value: V) -> &mut String {
        self.parameters
            .entry(oac.alias().to_string())
            .or_insert_with(|| value.to_string())
    }

    /// A view into a single entry in a map, which may either be vacant or occupied.
    ///
    /// This `enum` is constructed from the [`entry`] method on [`BTreeMap`].
    ///
    /// [`entry`]: BTreeMap::entry
    pub fn entry<V: ToString>(&mut self, oac: AuthParameter) -> Entry<String, String> {
        self.parameters.entry(oac.alias().to_string())
    }

    /// Get a previously set credential.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # use graph_oauth::extensions::AuthParameter;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.authorization_code("code");
    /// let code = oauth.get(AuthParameter::AuthorizationCode);
    /// assert_eq!("code", code.unwrap().as_str());
    /// ```
    pub fn get(&self, oac: AuthParameter) -> Option<String> {
        self.parameters.get(oac.alias()).cloned()
    }

    /// Check if an OAuth credential has already been set.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # use graph_oauth::extensions::AuthParameter;
    /// # let mut oauth = AuthSerializer::new();
    /// println!("{:#?}", oauth.contains(AuthParameter::Nonce));
    /// ```
    pub fn contains(&self, t: AuthParameter) -> bool {
        if t == AuthParameter::Scope {
            return !self.scopes.is_empty();
        }
        self.parameters.contains_key(t.alias())
    }

    pub fn contains_key(&self, key: &str) -> bool {
        self.parameters.contains_key(key)
    }

    /// Remove a field from OAuth.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # use graph_oauth::extensions::AuthParameter;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.client_id("client_id");
    ///
    /// assert_eq!(oauth.contains(AuthParameter::ClientId), true);
    /// oauth.remove(AuthParameter::ClientId);
    ///
    /// assert_eq!(oauth.contains(AuthParameter::ClientId), false);
    /// ```
    pub fn remove(&mut self, oac: AuthParameter) -> &mut AuthSerializer {
        self.parameters.remove(oac.alias());
        self
    }

    /// Set the client id for an OAuth request.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # use graph_oauth::extensions::AuthParameter;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.client_id("client_id");
    /// ```
    pub fn client_id(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::ClientId, value)
    }

    /// Set the state for an OAuth request.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # use graph_oauth::extensions::AuthParameter;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.state("1234");
    /// ```
    pub fn state(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::State, value)
    }

    /// Set the client secret for an OAuth request.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.client_secret("client_secret");
    /// ```
    pub fn client_secret(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::ClientSecret, value)
    }

    /// Set the redirect url of a request
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.redirect_uri("https://localhost:8888/redirect");
    /// ```
    pub fn redirect_uri(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::RedirectUri, value)
    }

    /// Set the access code.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut serializer = AuthSerializer::new();
    /// serializer.authorization_code("LDSF[POK43");
    /// ```
    pub fn authorization_code(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::AuthorizationCode, value)
    }

    /// Set the response mode.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut serializer = AuthSerializer::new();
    /// serializer.response_mode("query");
    /// ```
    pub fn response_mode(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::ResponseMode, value)
    }

    /// Set the response type.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.response_type("token");
    /// ```
    pub fn response_type<T: ToString>(&mut self, value: T) -> &mut AuthSerializer {
        self.insert(AuthParameter::ResponseType, value)
    }

    pub fn response_types(
        &mut self,
        value: std::collections::btree_set::Iter<'_, ResponseType>,
    ) -> &mut AuthSerializer {
        self.insert(AuthParameter::ResponseType, value.as_query())
    }

    /// Set the nonce.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    ///
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.nonce("1234");
    /// ```
    pub fn nonce(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::Nonce, value)
    }

    /// Set the prompt for open id.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    ///
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.prompt("login");
    /// ```
    pub fn prompt(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::Prompt, value)
    }

    pub fn prompts(&mut self, value: &[Prompt]) -> &mut AuthSerializer {
        self.insert(AuthParameter::Prompt, value.to_vec().as_query())
    }

    /// Set the session state.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.session_state("session-state");
    /// ```
    pub fn session_state(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::SessionState, value)
    }

    /// Set the grant_type.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.grant_type("token");
    /// ```
    pub fn grant_type(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::GrantType, value)
    }

    /// Set the resource.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.resource("resource");
    /// ```
    pub fn resource(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::Resource, value)
    }

    /// Set the code verifier.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.code_verifier("code_verifier");
    /// ```
    pub fn code_verifier(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::CodeVerifier, value)
    }

    /// Set the domain hint.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.domain_hint("domain_hint");
    /// ```
    pub fn domain_hint(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::DomainHint, value)
    }

    /// Set the code challenge.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.code_challenge("code_challenge");
    /// ```
    pub fn code_challenge(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::CodeChallenge, value)
    }

    /// Set the code challenge method.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.code_challenge_method("code_challenge_method");
    /// ```
    pub fn code_challenge_method(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::CodeChallengeMethod, value)
    }

    /// Set the login hint.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.login_hint("login_hint");
    /// ```
    pub fn login_hint(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::LoginHint, value)
    }

    /// Set the client assertion.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.client_assertion("client_assertion");
    /// ```
    pub fn client_assertion(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::ClientAssertion, value)
    }

    /// Set the client assertion type.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.client_assertion_type("client_assertion_type");
    /// ```
    pub fn client_assertion_type(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::ClientAssertionType, value)
    }

    /// Set the redirect uri that user will be redirected to after logging out.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::{AuthSerializer, AuthParameter};
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.username("user");
    /// assert!(oauth.contains(AuthParameter::Username))
    /// ```
    pub fn username(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::Username, value)
    }

    /// Set the redirect uri that user will be redirected to after logging out.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::{AuthSerializer, AuthParameter};
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.password("user");
    /// assert!(oauth.contains(AuthParameter::Password))
    /// ```
    pub fn password(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::Password, value)
    }

    pub fn refresh_token(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::RefreshToken, value)
    }

    /// Set the device code for the device authorization flow.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::{AuthSerializer, AuthParameter};
    /// # let mut oauth = AuthSerializer::new();
    /// oauth.device_code("device_code");
    /// assert!(oauth.contains(AuthParameter::DeviceCode))
    /// ```
    pub fn device_code(&mut self, value: &str) -> &mut AuthSerializer {
        self.insert(AuthParameter::DeviceCode, value)
    }

    /// Add a scope' for the OAuth URL.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    ///
    /// oauth.add_scope("Sites.Read")
    ///     .add_scope("Sites.ReadWrite")
    ///     .add_scope("Sites.ReadWrite.All");
    /// assert_eq!(oauth.join_scopes(" "), "Sites.Read Sites.ReadWrite Sites.ReadWrite.All");
    /// ```
    pub fn add_scope<T: ToString>(&mut self, scope: T) -> &mut AuthSerializer {
        self.scopes.insert(scope.to_string());
        self
    }

    /// Get the scopes.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// let mut oauth = AuthSerializer::new();
    /// oauth.add_scope("Files.Read");
    /// oauth.add_scope("Files.ReadWrite");
    ///
    /// let scopes = oauth.get_scopes();
    /// assert!(scopes.contains("Files.Read"));
    /// assert!(scopes.contains("Files.ReadWrite"));
    /// ```
    pub fn get_scopes(&self) -> &BTreeSet<String> {
        &self.scopes
    }

    /// Join scopes.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    ///
    /// // the scopes take a separator just like Vec join.
    ///  let s = oauth.join_scopes(" ");
    /// println!("{:#?}", s);
    /// ```
    pub fn join_scopes(&self, sep: &str) -> String {
        self.scopes
            .iter()
            .map(|s| &**s)
            .collect::<Vec<&str>>()
            .join(sep)
    }

    /// Set scope. Overriding all previous scope values.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # use std::collections::HashSet;
    /// # let mut oauth = AuthSerializer::new();
    ///
    /// let scopes = vec!["Files.Read", "Files.ReadWrite"];
    /// oauth.extend_scopes(&scopes);
    ///
    /// assert_eq!(oauth.join_scopes(" "), "Files.Read Files.ReadWrite");
    /// ```
    pub fn set_scope<T: ToString, I: IntoIterator<Item = T>>(&mut self, iter: I) -> &mut Self {
        self.scopes = iter.into_iter().map(|s| s.to_string()).collect();
        self
    }

    /// Extend scopes.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # use std::collections::HashSet;
    /// # let mut oauth = AuthSerializer::new();
    ///
    /// let scopes = vec!["Files.Read", "Files.ReadWrite"];
    /// oauth.extend_scopes(&scopes);
    ///
    /// assert_eq!(oauth.join_scopes(" "), "Files.Read Files.ReadWrite");
    /// ```
    pub fn extend_scopes<T: ToString, I: IntoIterator<Item = T>>(&mut self, iter: I) -> &mut Self {
        self.scopes.extend(iter.into_iter().map(|s| s.to_string()));
        self
    }

    /// Check if OAuth contains a specific scope.
    ///
    /// # Example
    /// ```
    /// # use graph_oauth::extensions::AuthSerializer;
    /// # let mut oauth = AuthSerializer::new();
    ///
    /// oauth.add_scope("Files.Read");
    /// assert_eq!(oauth.contains_scope("Files.Read"), true);
    ///
    /// // Or using static scopes
    /// oauth.add_scope("File.ReadWrite");
    /// assert!(oauth.contains_scope("File.ReadWrite"));
    /// ```
    pub fn contains_scope<T: ToString>(&self, scope: T) -> bool {
        self.scopes.contains(&scope.to_string())
    }
}

impl AuthSerializer {
    fn try_as_tuple(&self, oac: &AuthParameter) -> IdentityResult<(String, String)> {
        if oac.eq(&AuthParameter::Scope) {
            if self.scopes.is_empty() {
                return Err(AuthorizationFailure::required(oac));
            }
            Ok((oac.alias().to_owned(), self.join_scopes(" ")))
        } else {
            Ok((
                oac.alias().to_owned(),
                self.get(*oac).ok_or(AuthorizationFailure::required(oac))?,
            ))
        }
    }

    pub fn encode_query(
        &mut self,
        optional_fields: Vec<AuthParameter>,
        required_fields: Vec<AuthParameter>,
    ) -> IdentityResult<String> {
        let mut serializer = Serializer::new(String::new());
        for parameter in required_fields {
            if parameter.alias().eq("scope") {
                if self.scopes.is_empty() {
                    return AuthorizationFailure::result::<String>(parameter.alias());
                } else {
                    serializer.append_pair("scope", self.join_scopes(" ").as_str());
                }
            } else {
                let value = self
                    .get(parameter)
                    .ok_or(AuthorizationFailure::required(parameter))?;

                serializer.append_pair(parameter.alias(), value.as_str());
            }
        }

        for parameter in optional_fields {
            if parameter.alias().eq("scope") && !self.scopes.is_empty() {
                serializer.append_pair("scope", self.join_scopes(" ").as_str());
            } else if let Some(val) = self.get(parameter) {
                serializer.append_pair(parameter.alias(), val.as_str());
            }
        }

        Ok(serializer.finish())
    }

    pub fn as_credential_map(
        &mut self,
        optional_fields: Vec<AuthParameter>,
        required_fields: Vec<AuthParameter>,
    ) -> IdentityResult<HashMap<String, String>> {
        let mut required_map = required_fields
            .iter()
            .map(|oac| self.try_as_tuple(oac))
            .collect::<IdentityResult<HashMap<String, String>>>()?;

        let optional_map: HashMap<String, String> = optional_fields
            .iter()
            .flat_map(|oac| self.try_as_tuple(oac))
            .collect();

        required_map.extend(optional_map);
        Ok(required_map)
    }
}

/// Extend the OAuth credentials.
///
/// # Example
/// ```
/// # use graph_oauth::extensions::{AuthSerializer, AuthParameter};
/// # use std::collections::HashMap;
/// # let mut oauth = AuthSerializer::new();
/// let mut map: HashMap<AuthParameter, &str> = HashMap::new();
/// map.insert(AuthParameter::ClientId, "client_id");
/// map.insert(AuthParameter::ClientSecret, "client_secret");
///
/// oauth.extend(map);
/// # assert_eq!(oauth.get(AuthParameter::ClientId), Some("client_id".to_string()));
/// # assert_eq!(oauth.get(AuthParameter::ClientSecret), Some("client_secret".to_string()));
/// ```
impl<V: ToString> Extend<(AuthParameter, V)> for AuthSerializer {
    fn extend<I: IntoIterator<Item = (AuthParameter, V)>>(&mut self, iter: I) {
        iter.into_iter().for_each(|entry| {
            self.insert(entry.0, entry.1);
        });
    }
}

impl fmt::Debug for AuthSerializer {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        let mut map_debug: BTreeMap<&str, &str> = BTreeMap::new();
        for (key, value) in self.parameters.iter() {
            if self.log_pii {
                map_debug.insert(key.as_str(), value.as_str());
            } else if let Some(oac) = AuthParameter::iter()
                .find(|oac| oac.alias().eq(key.as_str()) && oac.is_debug_redacted())
            {
                map_debug.insert(oac.alias(), "[REDACTED]");
            } else {
                map_debug.insert(key.as_str(), value.as_str());
            }
        }

        f.debug_struct("OAuthSerializer")
            .field("credentials", &map_debug)
            .field("scopes", &self.scopes)
            .finish()
    }
}