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

//! A library to call Toggl Reports API v2 in Rust.
//!
//! This library provide makes it easier to call
//! [Toggl Reports API v2](https://github.com/toggl/toggl_api_docs/blob/master/reports.md) from Rust codes.
//!
//! # examples
//!
//! To get summary reports of Toggl Track,
//! create struct `Query` and pass it to `Toggl.get_summary_report()`.
//!
//! ```no_run
//! use toggl_reports::{Toggl, query::Query, query::GroupingKind, query::OrderKind};
//! use chrono::Utc;
//!
//! #[tokio::main]
//! async fn main() {
//!     let api_token: &str = "00000000000000000000000000000000";  // your api token
//!     let workspace_id: u64 = 264;                               // your workspace id
//!
//!     let toggl = Toggl::new(api_token);
//!     let query = Query::new(workspace_id)
//!         .grouping(GroupingKind::Projects)
//!         .order_field(OrderKind::Description)
//!         .since(Utc::today());
//!
//!     let res = toggl.get_summary_report(&query).await.unwrap();
//!     println!("TOTAL: {}s", res.total_grand.num_seconds());
//! }
//! ```
//!
//! For more details about query parameters and response formst,
//! see [Toggl Reports API v2](https://github.com/toggl/toggl_api_docs/blob/master/reports.md).

#[macro_use]
extern crate enum_display_derive;

pub mod detailed_report;
pub mod query;
pub mod reports;
pub mod summary_report;
pub mod weekly_report;

use anyhow::Result;
use query::Query;
use reqwest::Client;
pub use detailed_report::DetailedReport;
pub use summary_report::SummaryReport;
pub use weekly_report::WeeklyReport;

const DEFAULT_UA: &'static str = "komori-n<ikamat.kmr@gmail.com>";

/// A structure to wrap Toggl Reports API v2.
#[derive(Debug)]
pub struct Toggl {
    api_token: String,
    user_agent: String,
}

impl Toggl {
    pub fn new(api_token: &str) -> Self {
        Self {
            api_token: api_token.to_owned(),
            user_agent: DEFAULT_UA.to_owned(),
        }
    }

    pub fn with_user_agent(api_token: &str, user_agent: &str) -> Self {
        Self {
            api_token: api_token.to_owned(),
            user_agent: user_agent.to_owned(),
        }
    }

    async fn rest_get(&self, endpoint: &str, query: &Query) -> Result<String> {
        let client = Client::new();
        let mut query_vec = query.to_vec();
        query_vec.push(("user_agent", self.user_agent.clone()));

        let req = client
            .get(endpoint)
            .query(&query_vec)
            .basic_auth(&self.api_token, Some("api_token"));

        let res = req
            .send().await?
            .text().await?;

        Ok(res)
    }

    pub async fn get_weekly_report(&self, query: &Query) -> Result<WeeklyReport> {
        const ENDPOINT: &str = "https://api.track.toggl.com/reports/api/v2/weekly";

        let res = self.rest_get(ENDPOINT, query).await?;
        let report: WeeklyReport = serde_json::from_str(&res)?;

        Ok(report)
    }

    pub async fn get_detailed_report(&self, query: &Query) -> Result<DetailedReport> {
        const ENDPOINT: &str = "https://api.track.toggl.com/reports/api/v2/details";

        let res = self.rest_get(ENDPOINT, query).await?;
        let report: DetailedReport = serde_json::from_str(&res)?;

        Ok(report)
    }

    pub async fn get_summary_report(&self, query: &Query) -> Result<SummaryReport> {
        const ENDPOINT: &str = "https://api.track.toggl.com/reports/api/v2/summary";

        let res = self.rest_get(ENDPOINT, query).await?;
        let report: SummaryReport = serde_json::from_str(&res)?;

        Ok(report)
    }
}