mini_exercism 8.0.0

Minimalistic Rust library to interact with the Exercism.org APIs
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

//! Core types used across the [mini_exercism](crate) library.

use derive_builder::UninitializedFieldError;
use thiserror::Error;

use crate::http;

/// Credentials used to access the [Exercism](https://exercism.org) APIs.
///
/// # Examples
///
/// ```
/// use mini_exercism::core::Credentials;
///
/// let api_token = "some_token";
/// let credentials = Credentials::from_api_token(api_token);
///
/// assert_eq!(credentials.api_token(), api_token);
/// ```
#[derive(Debug, Clone, PartialEq, Eq)]
pub struct Credentials {
    api_token: String,
}

impl Credentials {
    /// Creates a new [Exercism](https://exercism.org) credentials wrapper from the given API token.
    pub fn from_api_token<T: Into<String>>(api_token: T) -> Self {
        Self { api_token: api_token.into() }
    }

    /// Accesses the [Exercism](https://exercism.org) API token.
    pub fn api_token(&self) -> &str {
        self.api_token.as_str()
    }
}

/// Result type used by the [mini_exercism](crate) library when an error can occur.
pub type Result<T, E = Error> = core::result::Result<T, E>;

/// Error type used by the [mini_exercism](crate) library.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum Error {
    /// CLI config file could not be found (see [`get_cli_credentials`](crate::cli::get_cli_credentials))
    #[cfg(feature = "cli")]
    #[error(
        "Exercism CLI config file not found - perhaps CLI application is not installed or configured?"
    )]
    ConfigNotFound,

    /// I/O error reading CLI config file (see [`get_cli_credentials`](crate::cli::get_cli_credentials))
    #[cfg(feature = "cli")]
    #[error("could not read Exercism CLI config file: {0:?}")]
    ConfigReadError(#[from] std::io::Error),

    /// JSON error parsing CLI config file (see [`get_cli_credentials`](crate::cli::get_cli_credentials))
    #[cfg(feature = "cli")]
    #[error("failed to parse Exercism CLI config file: {0:?}")]
    ConfigParseError(#[from] serde_json::Error),

    /// CLI config file did not contain an API token (see [`get_cli_credentials`](crate::cli::get_cli_credentials))
    #[cfg(feature = "cli")]
    #[error("Exercism CLI config file did not contain an API token")]
    ApiTokenNotFoundInConfig,

    /// A call to a builder's `build` method failed
    #[error(transparent)]
    BuildFailed(#[from] BuildError),

    /// Error encountered while performing a request to an [Exercism](https://exercism.org) API
    #[error("error while performing API request: {0:?}")]
    ApiError(#[from] http::Error),

    /// Error encountered while performing a request to an [Exercism](https://exercism.org) API
    /// which persisted even after retried have been exhausted
    #[error("error while performing API request with retries: {0:?}")]
    ApiRetryError(anyhow::Error),
}

impl From<UninitializedFieldError> for Error {
    #[cfg_attr(coverage_nightly, coverage(off))]
    fn from(_value: UninitializedFieldError) -> Self {
        // This cannot occur in the crate's current code.
        unreachable!("all fields should have had default values")
    }
}

/// Type used when a builder error occurs.
#[derive(Debug, Error)]
#[non_exhaustive]
pub enum BuildError {
    /// Creation of an [HTTP client](http::Client) failed.
    #[error("http client creation failed: {0:?}")]
    HttpClientCreationFailed(#[from] http::Error),
}

impl From<http::middleware::Error> for Error {
    fn from(value: http::middleware::Error) -> Self {
        match value {
            http::middleware::Error::Middleware(err) => Self::ApiRetryError(err),
            http::middleware::Error::Reqwest(err) => err.into(),
        }
    }
}