tribufu 1.3.0

REST API to access Tribufu services.
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
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

// Copyright (c) Tribufu. All Rights Reserved.
// SPDX-License-Identifier: MIT

#![allow(unused_imports)]
#![allow(clippy::too_many_arguments)]

use crate::apis::configuration::{ApiKey, Configuration};
use crate::apis::tribufu_generated_api::TribufuGeneratedApiClient;
use reqwest::Client;
use tribufu_constants::{RUSTC_VERSION, TARGET_TRIPLE};
use std::env::{self, consts};
use std::sync::Arc;

pub mod apis;
pub mod models;

/// Use this to interact with the Tribufu API.
pub struct TribufuApi;

impl TribufuApi {
    /// The default base URL for the Tribufu API.
    pub const DEFAULT_BASE_URL: &'static str = "https://api.tribufu.com";

    /// Create a TribufuApi instance.
    pub fn new(api_key: Option<String>) -> TribufuGeneratedApiClient {
        let configuration = Self::create_configuration(api_key);
        let configuration_arc = Arc::new(configuration);
        TribufuGeneratedApiClient::new(configuration_arc)
    }

    /// Create a TribufuApi with the default options.
    pub fn default() -> TribufuGeneratedApiClient {
        Self::new(None)
    }

    /// Create a TribufuApi with the given API key.
    ///
    /// An API key gives you public read only access to the Tribufu API.
    pub fn with_api_key(api_key: String) -> TribufuGeneratedApiClient {
        Self::new(Some(api_key))
    }

    /// Try to create a TribufuApi from environment variables.
    ///
    /// This will only work if the environment variables are set.
    pub fn from_env(prefix: Option<&str>) -> Option<TribufuGeneratedApiClient> {
        let prefix = prefix.unwrap_or("TRIBUFU");
        let api_key_var = format!("{}_API_KEY", prefix);
        if let Ok(api_key) = env::var(api_key_var) {
            if !api_key.trim().is_empty() {
                return Some(Self::with_api_key(api_key));
            }
        }
        None
    }

    /// Create a TribufuApi from environment variables or the default API.
    ///
    /// This will fallback to the default API if the environment variables are not set.
    pub fn from_env_or_default(prefix: Option<&str>) -> TribufuGeneratedApiClient {
        Self::from_env(prefix).unwrap_or_else(Self::default)
    }

    /// Gets the version of the Tribufu API client.
    pub fn get_version() -> String {
        env!("CARGO_PKG_VERSION").to_owned()
    }

    /// Gets the user agent string for the Tribufu API client.
    pub fn get_user_agent() -> String {
        let version = Self::get_version();
        format!("Tribufu/{} (Rust {}; {})", version, RUSTC_VERSION, TARGET_TRIPLE)
    }

    /// Checks if debug mode is enabled.
    pub fn debug_enabled() -> bool {
        cfg!(debug_assertions)
    }

    /// Get the base URL for the Tribufu API.
    fn get_base_url() -> String {
        if let Ok(base_url) = env::var("TRIBUFU_API_URL") {
            if Self::debug_enabled() && !base_url.trim().is_empty() {
                return base_url;
            }
        }

        Self::DEFAULT_BASE_URL.to_string()
    }

    /// Creates a configuration for the Tribufu API client.
    fn create_configuration(api_key: Option<String>) -> Configuration {
        let base_path = Self::get_base_url();
        let user_agent = Some(Self::get_user_agent());

        let api_key_obj = if let Some(api_key) = api_key {
            Some(ApiKey {
                prefix: Some("ApiKey".to_owned()),
                key: api_key,
            })
        } else {
            None
        };

        Configuration {
            base_path,
            user_agent,
            api_key: api_key_obj,
            ..Default::default()
        }
    }
}