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
//! bullettrain create provides client for bullet-train.io API.
//!
//! # Example
//!
//! ```rust
//! # const API_KEY: &str = "MgfUaRCvvZMznuQyqjnQKt";
//! use bullettrain::{Client,Value};
//!
//! let client = Client::new(API_KEY);
//! if client.feature_enabled("test_feature")? {
//!     if let Some(Value::Int(i)) = client.get_value("integer_feature")? {
//!         println!("integer value: {}", i);
//!         # assert!(i == 200);
//!     }
//!     // ...
//! }
//! # Ok::<(), bullettrain::error::Error>(())
//! ```

pub mod error;
use serde::{Deserialize, Serialize};

/// Default address of BulletTrain API.
pub const DEFAULT_BASE_URI: &str = "https://api.bullet-train.io/api/v1/";

/// Contains core information about feature.
#[derive(Serialize, Deserialize)]
pub struct Feature {
    pub name: String,
    #[serde(rename = "type")]
    pub kind: String,
    pub description: Option<String>,
}

/// Represents remote config value.
///
/// Currently there are three possible types of values: booleans, integers and strings.
#[derive(Serialize, Deserialize)]
#[serde(untagged)]
pub enum Value {
    Bool(bool),
    Int(i64),
    String(String),
}

/// Contains information about Feature and it's value.
#[derive(Serialize, Deserialize)]
pub struct Flag {
    pub feature: Feature,
    #[serde(rename = "feature_state_value")]
    pub state_value: Option<Value>,
    pub enabled: bool,
}

/// Holds identity information.
#[derive(Serialize, Deserialize)]
pub struct User {
    pub identifier: String,
}

/// Holds information about User's trait.
#[derive(Serialize, Deserialize)]
pub struct Trait {
    pub identity: Option<User>,
    #[serde(rename = "trait_key")]
    pub key: String,
    #[serde(rename = "trait_value")]
    pub value: String,
}

/// Provides various methods to interact with BulletTrain API.
///
/// Static method new can be used to create instance configured with default API address.
/// To use custom API address, use struct constructor.
///
/// # Example
///
/// ```rust
/// let client = bullettrain::Client {
///     api_key: String::from("secret key"),
///     base_uri: String::from("https://features.on.my.own.server/api/v1/"),
/// };
/// # match client.get_features() {
/// #    Err(e) => println!("{}", e),
/// #    Ok(f) => assert!(false),
/// # }
/// ```
pub struct Client {
    pub api_key: String,
    pub base_uri: String,
}

/// Internal structure used for deserialization.
#[derive(Serialize, Deserialize)]
struct TraitResponse {
    traits: Vec<Trait>,
}

impl Client {
    /// Returns Client instance configured to use default API address and given API key.
    pub fn new(api_key: &str) -> Client {
        return Client {
            api_key: String::from(api_key),
            base_uri: String::from(DEFAULT_BASE_URI),
        };
    }

    /// Returns all features available in given environment.
    pub fn get_features(&self) -> Result<Vec<Flag>, error::Error> {
        let resp = self
            .build_request(vec!["flags/"])?
            .send()?
            .json::<Vec<Flag>>()?;
        Ok(resp)
    }

    /// Returns all features as defined for given user.
    pub fn get_user_features(&self, user: &User) -> Result<Vec<Flag>, error::Error> {
        let resp = self
            .build_request(vec!["flags/", &user.identifier])?
            .send()?
            .json::<Vec<Flag>>()?;
        Ok(resp)
    }

    /// Returns information whether given feature is defined.
    pub fn has_feature(&self, name: &str) -> Result<bool, error::Error> {
        let flag = self.get_flag(self.get_features()?, name);
        match flag {
            Some(_) => Ok(true),
            None => Ok(false),
        }
    }

    /// Returns information whether given feature is defined for given user.
    pub fn has_user_feature(&self, user: &User, name: &str) -> Result<bool, error::Error> {
        let flag = self.get_flag(self.get_user_features(user)?, name);
        match flag {
            Some(_) => Ok(true),
            None => Ok(false),
        }
    }

    /// Returns information whether given feature flag is enabled.
    pub fn feature_enabled(&self, name: &str) -> Result<bool, error::Error> {
        let flag = self.get_flag(self.get_features()?, name);
        match flag {
            Some(f) => Ok(f.enabled),
            None => Err(error::Error::from(format!("unknown feature {}", name))),
        }
    }

    /// Returns information whether given feature flag is enabled for given user.
    pub fn user_feature_enabled(&self, user: &User, name: &str) -> Result<bool, error::Error> {
        let flag = self.get_flag(self.get_user_features(user)?, name);
        match flag {
            Some(f) => Ok(f.enabled),
            None => Err(error::Error::from(format!("unknown feature {}", name))),
        }
    }

    /// Returns value of given feature (remote config).
    ///
    /// Returned value can have one of following types: boolean, integer, string.
    pub fn get_value(&self, name: &str) -> Result<Option<Value>, error::Error> {
        let flag = self.get_flag(self.get_features()?, name);
        match flag {
            Some(f) => Ok(f.state_value),
            None => Err(error::Error::from(format!("unknown feature {}", name))),
        }
    }

    /// Returns value of given feature (remote config) as defined for given user.
    ///
    /// Returned value can have one of following types: boolean, integer, string.
    pub fn get_user_value(&self, user: &User, name: &str) -> Result<Option<Value>, error::Error> {
        let flag = self.get_flag(self.get_user_features(user)?, name);
        match flag {
            Some(f) => Ok(f.state_value),
            None => Err(error::Error::from(format!("unknown feature {}", name))),
        }
    }

    /// Returns trait defined for given user.
    pub fn get_trait(&self, user: &User, key: &str) -> Result<Trait, error::Error> {
        let mut traits = self.get_traits(user, vec![key])?;
        match traits.len() {
            1 => Ok(traits.remove(0)),
            _ => Err(error::Error::from(format!(
                "unknown trait {} for user {}",
                key, &user.identifier
            ))),
        }
    }

    /// Returns all traits defined for given user.
    ///
    /// If keys are provided, get_traits returns only corresponding traits,
    /// otherwise all traits for given user are returned.
    pub fn get_traits(&self, user: &User, keys: Vec<&str>) -> Result<Vec<Trait>, error::Error> {
        let resp = self
            .build_request(vec!["identities/"])?
            .query(&[("identifier", &user.identifier)])
            .send()?
            .json::<TraitResponse>()?;

        let mut traits = resp.traits;
        if keys.is_empty() {
            return Ok(traits);
        }

        traits.retain(|t| {
            let tk: &String = &t.key;
            keys.iter().any(|k| tk == k)
        });

        Ok(traits)
    }

    /// Updates trait value for given user, returns updated trait.
    pub fn update_trait(&self, user: &User, to_update: &Trait) -> Result<Trait, error::Error> {
        let update = Trait {
            identity: Some(User {
                identifier: user.identifier.clone(),
            }),
            key: to_update.key.clone(),
            value: to_update.value.clone(),
        };
        let url = reqwest::Url::parse(&self.base_uri)?.join("traits/")?;
        let client = reqwest::blocking::Client::new();
        let resp = client
            .post(url)
            .header("X-Environment-Key", &self.api_key)
            .json(&update)
            .send()?
            .json::<Trait>()?;

        Ok(resp)
    }

    /// Builds get request, using API URL and API key.
    fn build_request(
        &self,
        parts: Vec<&str>,
    ) -> Result<reqwest::blocking::RequestBuilder, error::Error> {
        let mut url = reqwest::Url::parse(&self.base_uri)?;
        for p in parts {
            url = url.join(p)?;
        }
        let client = reqwest::blocking::Client::new();
        Ok(client.get(url).header("X-Environment-Key", &self.api_key))
    }

    /// Returns flag by name.
    fn get_flag(&self, features: Vec<Flag>, name: &str) -> Option<Flag> {
        for f in features {
            if f.feature.name == name {
                return Some(f);
            }
        }
        None
    }
}