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

//! This is my beginning of a crate for Bugsnag alerting
//! right now it is very minimal and just for my testing use.
//!
//! See [Client] for examples
use std::fmt;
use std::fmt::Display;

/// A Bugsnag event has three severity levels, defined as follows:
/// error - The default for unhandled errors.
/// warning - The default when Bugsnag.notify is called.
/// info - Can be used in manual Bugsnag.notify calls
///
/// In our library the severity level is just based on what function
/// the user chooses
enum SeverityLevel {
    Error,
    Warning,
    Info,
}
/// Converts our SeverityLevel enum to the expected string
impl Display for SeverityLevel {
    fn fmt(&self, f: &mut ::std::fmt::Formatter) -> Result<(), ::std::fmt::Error> {
        match *self {
            SeverityLevel::Error => f.write_str("error"),
            SeverityLevel::Warning => f.write_str("warning"),
            SeverityLevel::Info => f.write_str("info"),
        }
    }
}

/// The Bugsnag api specifies that requests are processed asynchornously.
/// Therefore, a 'bad' request does not necessarily return an error status
/// Errors returned from the api are likely formatting, structure or low-level
/// network issues
pub struct BugsnagError {
    /// Default of 0, future use
    code: usize,
    message: String,
}

/// Implement std::fmt::Display for AppError
impl fmt::Display for BugsnagError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        let err_msg = match self.code {
            0 => "An error occured posting to bugsnag",
            _ => "Some unknown error occured",
        };
        write!(f, "{}", err_msg)
    }
}

/// Implement std::fmt::Debug for AppError
impl fmt::Debug for BugsnagError {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(
            f,
            "BugsnagError {{ code: {}, message: {} }}",
            self.code, self.message
        )
    }
}

/// The [Client] is our connection to the bugsnag api.  This uses the builder pattern for configuration.
/// See examples below.
///
/// # API Documentation
///
/// <https://bugsnagerrorreportingapi.docs.apiary.io/#reference/0/notify/send-error-reports>
///
///
/// # Examples
///
/// ## Informational message
/// ```
/// use mobugsnag::Client;
/// let snag = Client::new("MYAPIKEY".to_string()).build();
/// snag.info("My Class", "My actual Message").unwrap();
/// ```
///
/// ## Warning message
/// ```
/// use mobugsnag::Client;
/// let snag = Client::new("MYAPIKEY".to_string()).build();
/// snag.warning("My Class", "My actual Message").unwrap();
/// ```
///
/// ## Error message
/// ```
/// use mobugsnag::Client;
/// let snag = Client::new("MYAPIKEY".to_string()).build();
/// snag.error("An Error Type", "My error message").unwrap();
/// ```
#[derive(Debug, PartialEq)]
pub struct Client {
    api_key: String,
}
impl Client {
    pub fn new(api_key: String) -> Self {
        Client { api_key }
    }
    pub fn build(&self) -> Self {
        Client {
            api_key: self.api_key.to_owned(),
        }
    }
    fn notify(&self, level: SeverityLevel, class: &str, msg: &str) -> Result<(), BugsnagError> {
        let resp = ureq::post("http://notify.bugsnag.com/")
            .set("Content-Type", "application/json")
            .set("Bugsnag-Api-Key", &self.api_key)
            .set("Bugsnag-Payload-Version", "5")
            .send_json(ureq::json!({
                "notifier": {
                    "name": "mobugsnag - my own bugsnag",
                    "version": "0.0.1",
                    "url": "http://bcianswers.com"
                },
                "events": [
                {"exceptions":[
                    {
                        "errorClass": class,
                        "message": msg
                    }
                ]}
                ],
                "severity": level.to_string()
            }));
        match resp {
            Ok(_) => Ok(()),
            Err(e) => Err(BugsnagError {
                code: 0,
                message: format!("{:?}", e),
            }),
        }
    }
    pub fn info(&self, class: &str, msg: &str) -> Result<(), BugsnagError> {
        self.notify(SeverityLevel::Info, class, msg)
    }
    pub fn warning(&self, class: &str, msg: &str) -> Result<(), BugsnagError> {
        self.notify(SeverityLevel::Warning, class, msg)
    }
    pub fn error(&self, class: &str, msg: &str) -> Result<(), BugsnagError> {
        self.notify(SeverityLevel::Error, class, msg)
    }
}

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

    #[test]
    fn severity_levels() {
        let s1 = SeverityLevel::Error;
        let s2 = SeverityLevel::Warning;
        let s3 = SeverityLevel::Info;
        assert_eq!(format!("{}", s1), "error");
        assert_eq!(format!("{}", s2), "warning");
        assert_eq!(format!("{}", s3), "info");
    }

    #[test]
    fn test_basic_client() {
        let input_api_key = String::from("this is my api key");
        let expected = String::from("this is my api key");

        let result = Client::new(input_api_key).build();

        assert_eq!(result.api_key, expected);
    }
}