firebase_app_sdk/

lib.rs

//! # Firebase App SDK
//! The Firebase App SDK for Rust provides a Rust API for integrating Firebase services into your Rust applications. This SDK allows you to easily access Firebase features such as authentication, real-time database, storage, and more.
//! ## Usage
//! To interact with Firebase services, you need to create an `App` instance with the required options. Here's an example:
//! ```rust
//! use firebase_app::{App,DEFAULT,Options};
//! 
//! fn main() {
//!     let options = Options::new("YOUR_APPLICATION_ID", "YOUR_API_KEY")
//!         .with_database_url("YOUR_DATABASE_URL")
//!         .with_storage_bucket("YOUR_STORAGE_BUCKET");
//!     
//!     let app = App::new(DEFAULT, options);
//! }
//! ```
//! Once you have created an App instance, you can pass it to other Firebase services for further interactions. Here's an example of using the app instance with the Firebase Authentication service:
//!
//! ```rust
//! use firebase_app::App;
//! use firebase_app::Options;
//! use firebase_auth::auth::Authentication;
//! 
//! const DEFAULT: &str = "DEFAULT";
//! 
//! fn main() {
//!     let options = Options::new("YOUR_APPLICATION_ID", "YOUR_API_KEY")
//!         .with_auth_domain("YOUR_AUTH_DOMAIN");
//!     
//!     let app = App::new(DEFAULT, options);
//!     
//!     // Use the app instance with the Firebase Authentication service
//!     let auth = Authentication::new(&app);
//!     
//!     // Perform authentication operations using the `auth` instance
//!    // ...
//! }
//! ```
//! Please note that the above examples are simplified and serve as a starting point. Refer to the documentation of each Firebase service for detailed usage instructions.

///Represents a default value or identifier in the context of the Firebase application.
pub const DEFAULT : &str = "DEFAULT";

/// Represents an application with its associated options.
pub struct App<'a> {
    /// The name of the application.
    pub name: &'a str,
    /// The options for the application.
    pub options: Options<'a>,
}

/// Represents the configurable options for an application.
pub struct Options<'a> {
    /// The application ID.
    pub application_id: &'a str,
    /// The API key for accessing the application.
    pub api_key: &'a str,
    /// The URL of the database (optional).
    pub database_url: Option<&'a str>,
    /// The Google Analytics tracking ID (optional).
    pub ga_tracking_id: Option<&'a str>,
    /// The storage bucket (optional).
    pub storage_bucket: Option<&'a str>,
    /// The project ID (optional).
    pub project_id: Option<&'a str>,
    /// The Google Cloud Messaging (GCM) sender ID (optional).
    pub gcm_sender_id: Option<&'a str>,
    /// The authentication domain (optional).
    pub auth_domain: Option<&'a str>,
}

impl<'a> App<'a> {
    /// Creates a new instance of the `App` struct.
    ///
    /// # Arguments
    ///
    /// * `name` - The name of the application.
    /// * `options` - The options for the application.
    ///
    /// # Returns
    ///
    /// A new `App` instance.
    pub fn new(name: &'a str, options: Options<'a>) -> Self {
        /*let db : Database = open_database(DATABASE_NAME).unwrap();

        if name != DEFAULT && db.contains_key(DEFAULT).unwrap_or(false) {
            return Err("Error: Database does not contain default value".to_string());
        };

        if db.contains_key(name).unwrap_or(false) {
            return Err(format!("Error: Database already contains app named [{}] ",name));
        };

        let app = App {
            name,
            options,
        };

        let serialized = serde_json::to_string(&app).expect("Error serializing app");
        let bytes = serialized.as_bytes();

        db.insert(name,SledVector::from(bytes)).expect("Error writing app instance to database");*/
        App {
            name,
            options,
        }
    }
}

impl<'a> Options<'a> {
    /// Creates a new instance of the `Options` struct.
    ///
    /// # Arguments
    ///
    /// * `application_id` - The application ID.
    /// * `api_key` - The API key for accessing the application.
    ///
    /// # Returns
    ///
    /// A new `Options` instance.
    pub const fn new(application_id: &'a str, api_key: &'a str) -> Self {
        Options {
            application_id,
            api_key,
            database_url: None,
            ga_tracking_id: None,
            storage_bucket: None,
            project_id: None,
            gcm_sender_id: None,
            auth_domain: None,
        }
    }

    /// Sets the database URL for the options.
    ///
    /// # Arguments
    ///
    /// * `database_url` - The URL of the database.
    ///
    /// # Returns
    ///
    /// The modified `Options` instance.
    pub const fn with_database_url(mut self, database_url: &'a str) -> Self {
        self.database_url = Some(database_url);
        self
    }

    /// Sets the Google Analytics tracking ID for the options.
    ///
    /// # Arguments
    ///
    /// * `ga_tracking_id` - The Google Analytics tracking ID.
    ///
    /// # Returns
    ///
    /// The modified `Options` instance.
    pub const fn with_ga_tracking_id(mut self, ga_tracking_id: &'a str) -> Self {
        self.ga_tracking_id = Some(ga_tracking_id);
        self
    }

    /// Sets the storage bucket for the options.
    ///
    /// # Arguments
    ///
    /// * `storage_bucket` - The storage bucket.
    ///
    /// # Returns
    ///
    /// The modified `Options` instance.
    pub const fn with_storage_bucket(mut self, storage_bucket: &'a str) -> Self {
        self.storage_bucket = Some(storage_bucket);
        self
    }

    /// Sets the project ID for the options.
    ///
    /// # Arguments
    ///
    /// * `project_id` - The project ID.
    ///
    /// # Returns
    ///
    /// The modified `Options` instance.
    pub const fn with_project_id(mut self, project_id: &'a str) -> Self {
        self.project_id = Some(project_id);
        self
    }

    /// Sets the Google Cloud Messaging (GCM) sender ID for the options.
    ///
    /// # Arguments
    ///
    /// * `gcm_sender_id` - The GCM sender ID.
    ///
    /// # Returns
    ///
    /// The modified `Options` instance.
    pub const fn with_gcm_sender_id(mut self, gcm_sender_id: &'a str) -> Self {
        self.gcm_sender_id = Some(gcm_sender_id);
        self
    }

    /// Sets the authentication domain for the options.
    ///
    /// # Arguments
    ///
    /// * `auth_domain` - The authentication domain.
    ///
    /// # Returns
    ///
    /// The modified `Options` instance.
    pub const fn with_auth_domain(mut self, auth_domain: &'a str) -> Self {
        self.auth_domain = Some(auth_domain);
        self
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn create_app_instance(){
        App::new(DEFAULT,Options::new("..","..."));
    }
}