keyflux 0.1.11

A CLI tool and library for synchronizing environment secrets across multiple platforms including local files, GitHub Secrets, Supabase Vault, and Vercel Secrets. It facilitates secure management and automation of sensitive data.
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

use reqwest::{Client, Response};
use async_trait::async_trait;
use serde::Serialize;
use std::collections::HashMap;
use std::env;
use crate::api::traits::Fetch;
use crate::api::vercel::VERCEL_ACCESS_TOKEN;
use crate::error::FluxError;



/// Represents a request to retrieve environment variables for a Vercel project.
///
/// This structure encapsulates all necessary parameters for making an API request to Vercel to
/// fetch environment variables associated with a specific project. It includes optional fields
/// for further specification, such as git branch or decryption flag.
#[derive(Serialize)]
pub struct VercelEnvironmentSelect {
    /// Unique identifier or name of the Vercel project.
    pub id_or_name: String,
    /// Optional access token for authentication. If not set, it defaults to the `VERCEL_ACCESS_TOKEN`
    /// environment variable if available.
    pub token: Option<String>,
    /// Optional flag to indicate if the environment variables should be decrypted.
    pub decrypt: Option<bool>,
    /// Optional git branch to filter the environment variables.
    pub git_branch: Option<String>,
    /// Optional slug of the project.
    pub slug: Option<String>,
    /// Optional team ID, useful for requests across different team resources.
    pub team_id: Option<String>,
    /// Optional source string for identifying the request source.
    pub source: Option<String>,
}


// type
//
// string of the following
//
// Required
// The type of environment variable
// Example:
// plain
// Allowed values:
// system
// secret
// encrypted
// plain
// sensitive

#[async_trait]
impl Fetch for VercelEnvironmentSelect {
    /// Asynchronously sends a GET request to retrieve environment variables for a Vercel project.
    ///
    /// Constructs and sends a GET request using the provided HTTP client with authorization,
    /// and necessary query parameters. Manages the response from the API.
    ///
    /// # Arguments
    ///
    /// * `client` - The HTTP client used to send the request.
    ///
    /// # Returns
    ///
    /// This method returns a `Result` containing a `reqwest::Response` if the request
    /// is successful, or a `reqwest::Error` if an error occurs during the request.
    ///
    async fn fetch(&self, client: &Client) -> Result<Response, FluxError> {
        let mut query_params = HashMap::new();
        if let Some(decrypt) = self.decrypt {
            query_params.insert("decrypt", decrypt.to_string());
        }
        if let Some(git_branch) = &self.git_branch {
            query_params.insert("gitBranch", git_branch.clone());
        }
        if let Some(slug) = &self.slug {
            query_params.insert("slug", slug.clone());
        }
        if let Some(team_id) = &self.team_id {
            query_params.insert("teamId", team_id.clone());
        }
        if let Some(source) = &self.source {
            query_params.insert("source", source.clone());
        }

        client.get(&format!("https://api.vercel.com/v9/projects/{}/env", self.id_or_name))
            .bearer_auth(env::var(VERCEL_ACCESS_TOKEN).unwrap_or_else(|_| self.token.clone().unwrap_or_default()))
            .query(&query_params)
            .send()
            .await
            .map_err(FluxError::from_reqwest_error)
    }
}