traduora 0.4.0

REST API bindings for Traduora, an open-source translation management platform
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

use http::Method;
use serde::{Deserialize, Serialize};

use crate::{auth::Unauthenticated, query::DefaultModel, Endpoint};

/// List available external auth providers.
///
/// The exact result depends on what external authentication
/// providers are configured in the Traduora instance.
/// By default there are none.
///
/// **Endpoint** `GET /api/v1/auth/providers`
///
/// **Default model** [`AuthProvider`]
///
/// # Examples
/// ```
/// # use traduora::{TestClient as Traduora, TraduoraError};
/// use traduora::{api::auth::Providers, Query};
///
/// let client = Traduora::new("localhost:8080")?;
/// let providers = Providers.query(&client)?;
///
/// assert_eq!(providers[0].slug, "google");
/// assert_eq!(providers[0].client_id, "1234567890-abc123def456.apps.googleusercontent.com");
/// assert_eq!(providers[0].url.as_str(), "https://accounts.google.com/o/oauth2/v2/auth");
/// assert_eq!(providers[0].redirect_url.as_str(), "https://www.traduora.example/auth/callback");
/// # Ok::<(), TraduoraError>(())
/// ```
#[derive(Clone, Debug, Eq, Ord, Hash, PartialEq, PartialOrd, Serialize)]
pub struct Providers;

impl Endpoint for Providers {
    type AccessControl = Unauthenticated;

    fn method(&self) -> Method {
        Method::GET
    }

    fn endpoint(&self) -> std::borrow::Cow<'static, str> {
        "auth/providers".into()
    }
}

impl DefaultModel for Providers {
    type Model = Vec<AuthProvider>;

    fn map(data: serde_json::Value) -> Result<Self::Model, serde_json::Error> {
        serde_json::from_value(data)
    }
}

/// Default model.
///
/// **Endpoint** `GET /api/v1/auth/providers`
#[derive(Clone, Debug, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct AuthProvider {
    /// Name of the authentication provider
    pub slug: String,
    /// The id of the traduora instance in the authentication
    /// provider.
    pub client_id: String,
    /// URL where the authentication with this external provider happens.
    pub url: url::Url,
    /// URL that is called after the authentication finishes to
    /// return back to the Traduora instance.
    pub redirect_url: url::Url,
}