fugle 0.3.8

A Simple, Lightweight, Fast and Safe Fugle Library
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
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

pub mod intraday;
pub mod marketdata;

use serde::de::DeserializeOwned;
use std::time::Duration;

#[cfg(feature = "query")]
use ureq::{Agent, AgentBuilder, OrAnyStatus};

#[cfg(feature = "async-query")]
use reqwest::{Client, ClientBuilder};

use crate::{
    errors::{ErrorResponse, FugleError},
    schema::Result,
};

/// Accumulates options towards building an Restful api instance.
pub struct RestfulBuilder<'a> {
    token: &'a str,
    read_timeout_sec: u64,
}

impl<'a> Default for RestfulBuilder<'a> {
    fn default() -> RestfulBuilder<'a> {
        RestfulBuilder::new()
    }
}

impl<'a> RestfulBuilder<'a> {
    /// Returns a default RestfulBuilder with
    /// * fugle "demo" token
    /// * 3 seconds read timeout
    pub fn new() -> RestfulBuilder<'a> {
        RestfulBuilder {
            token: "demo",
            read_timeout_sec: 3,
        }
    }

    /// Setup your personal fugle token.
    ///
    /// By default the RestfulBuilder using fugle demo token which has limitations on querying,
    /// please login into below web page
    /// https://developer.fugle.tw/
    /// then find your personal token.
    ///
    /// # Example:
    ///
    /// ```
    /// # use fugle::http::RestfulBuilder ;
    /// let client = RestfulBuilder::new()
    ///     .token("b52153ae36747b17c8bdee801da19542")
    ///     .build();
    /// ```
    pub fn token(mut self, token: &'a str) -> RestfulBuilder {
        self.token = token;
        self
    }

    /// Setup http read timeout option.
    ///
    /// # Example:
    ///
    /// ```
    /// # use fugle::http::RestfulBuilder ;
    /// let client = RestfulBuilder::new()
    ///     .read_timeout_sec(10) // set read timeout in 10 seconds
    ///     .build();
    /// ```
    pub fn read_timeout_sec(mut self, sec: u64) -> RestfulBuilder<'a> {
        self.read_timeout_sec = sec;
        self
    }

    /// Create a new Block Request instance.
    ///
    /// # Example:
    ///
    /// ```
    /// # use fugle::http::RestfulBuilder ;
    /// let client = RestfulBuilder::new().build();
    /// ```
    #[cfg(feature = "query")]
    pub fn build(&self) -> Result<BlockRequest<'a>> {
        Ok(BlockRequest {
            token: self.token,
            agent: AgentBuilder::new()
                .timeout_read(Duration::from_secs(self.read_timeout_sec))
                .build(),
        })
    }

    /// Create a new Aync Request instance.
    ///
    /// # Example:
    ///
    /// ```
    /// # use fugle::http::RestfulBuilder ;
    /// let client = RestfulBuilder::new().build_async();
    /// ```
    #[cfg(feature = "async-query")]
    pub fn build_async(&self) -> Result<AsyncRequest<'a>> {
        Ok(AsyncRequest {
            token: self.token,
            client: ClientBuilder::new()
                .timeout(Duration::from_secs(self.read_timeout_sec))
                .build()?,
        })
    }
}

pub struct Query {
    pub param: String,
    pub value: String,
}

pub trait Request {
    const REQUEST_URL: &'static str;
    type Response: DeserializeOwned;

    fn queries(&self) -> Vec<Query>;
}

pub struct BlockRequest<'a> {
    token: &'a str,
    agent: Agent,
}

impl<'a> BlockRequest<'a> {
    pub fn call<R>(&self, request: R) -> Result<R::Response>
    where
        R: Request,
    {
        let mut req = self.agent.get(R::REQUEST_URL).query("apiToken", self.token);

        for r in request.queries() {
            req = req.query(&r.param, &r.value)
        }

        match req.call().or_any_status() {
            Ok(res) => {
                if res.status() != 200 {
                    let err: ErrorResponse = res.into_json()?;
                    return Err(err.into());
                }
                Ok(res.into_json()?)
            }
            Err(e) => Err(FugleError::Ureq(Box::new(e.into()))),
        }
    }
}

pub struct AsyncRequest<'a> {
    token: &'a str,
    client: Client,
}

impl<'a> AsyncRequest<'a> {
    pub async fn call<R>(&self, request: R) -> Result<R::Response>
    where
        R: Request,
    {
        let mut req = self
            .client
            .get(R::REQUEST_URL)
            .query(&[("apiToken", self.token)]);

        for r in request.queries() {
            req = req.query(&[(&r.param, &r.value)])
        }

        match req.send().await {
            Ok(res) => {
                if res.status() != 200 {
                    let err: ErrorResponse = res.json().await?;
                    return Err(err.into());
                }
                Ok(res.json().await?)
            }
            Err(e) => Err(FugleError::Reqwest(e)),
        }
    }
}