stellar-client 0.1.2

A client interface to the stellar Horizon API
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
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
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336

//! Contains the endpoint for all operations.
use super::{Body, Cursor, Direction, IntoRequest, Limit, Order, Records};
use error::Result;
use http::{Request, Uri};
use resources::{Effect, Operation};
use std::str::FromStr;
use uri::{self, TryFromUri, UriWrap};

pub use super::account::Operations as ForAccount;
pub use super::ledger::Operations as ForLedger;
pub use super::transaction::Operations as ForTransaction;

/// This endpoint represents all operations that have resulted from successful transactions in Stellar.
/// The endpoint will return all operations and accepts query params for a cursor, order, and limit.
///
/// <https://www.stellar.org/developers/horizon/reference/endpoints/operations-all.html>
///
/// ## Example
/// ```
/// use stellar_client::sync::Client;
/// use stellar_client::endpoint::operation;
///
/// let client      = Client::horizon_test().unwrap();
/// let endpoint    = operation::All::default();
/// let records     = client.request(endpoint).unwrap();
/// #
/// # assert!(records.records().len() > 0);
/// ```
#[derive(Debug, Default, Clone)]
pub struct All {
    cursor: Option<String>,
    order: Option<Direction>,
    limit: Option<u32>,
}

impl_cursor!(All);
impl_limit!(All);
impl_order!(All);

impl All {
    fn has_query(&self) -> bool {
        self.order.is_some() || self.cursor.is_some() || self.limit.is_some()
    }
}

impl IntoRequest for All {
    type Response = Records<Operation>;

    fn into_request(self, host: &str) -> Result<Request<Body>> {
        let mut uri = format!("{}/operations", host);

        if self.has_query() {
            uri.push_str("?");

            if let Some(order) = self.order {
                uri.push_str(&format!("order={}&", order.to_string()));
            }

            if let Some(cursor) = self.cursor {
                uri.push_str(&format!("cursor={}&", cursor));
            }

            if let Some(limit) = self.limit {
                uri.push_str(&format!("limit={}", limit));
            }
        }

        let uri = Uri::from_str(&uri)?;
        let request = Request::get(uri).body(Body::None)?;
        Ok(request)
    }
}

impl TryFromUri for All {
    fn try_from_wrap(wrap: &UriWrap) -> ::std::result::Result<Self, uri::Error> {
        let params = wrap.params();
        Ok(Self {
            cursor: params.get_parse("cursor").ok(),
            order: params.get_parse("order").ok(),
            limit: params.get_parse("limit").ok(),
        })
    }
}

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

    #[test]
    fn it_leaves_off_the_params_if_not_specified() {
        let ep = All::default();
        let req = ep.into_request("https://www.google.com").unwrap();
        assert_eq!(req.uri().path(), "/operations");
        assert_eq!(req.uri().query(), None);
    }

    #[test]
    fn it_puts_the_query_params_on_the_uri() {
        let ep = All::default()
            .with_cursor("CURSOR")
            .with_limit(123)
            .with_order(Direction::Desc);
        let req = ep.into_request("https://www.google.com").unwrap();
        assert_eq!(req.uri().path(), "/operations");
        assert_eq!(
            req.uri().query(),
            Some("order=desc&cursor=CURSOR&limit=123")
        );
    }

    #[test]
    fn it_parses_query_params_from_uri() {
        let uri: Uri = "/operations?order=desc&cursor=CURSOR&limit=123"
            .parse()
            .unwrap();
        let all = All::try_from(&uri).unwrap();
        assert_eq!(all.order, Some(Direction::Desc));
        assert_eq!(all.cursor, Some("CURSOR".to_string()));
        assert_eq!(all.limit, Some(123));
    }
}

/// The operation details endpoint provides information on a single operation. The operation ID
/// provided in the id argument specifies which operation to load.
///
/// <https://www.stellar.org/developers/horizon/reference/endpoints/operations-single.html>
///
/// ## Example
///
/// ```
/// use stellar_client::sync::Client;
/// use stellar_client::endpoint::{operation, Limit};
///
/// let client = Client::horizon_test().unwrap();
///
/// // Grab an operation so that we know that we can request one from
/// // horizon that actually exists.
/// let all = operation::All::default().with_limit(1);
/// let all = client.request(all).unwrap();
///
/// let operation_id = all.records()[0].id();
///
/// let details = operation::Details::new(operation_id);
/// let operation = client.request(details).unwrap();
///
/// assert_eq!(operation.id(), operation_id);
/// ```
#[derive(Debug, Clone, Copy)]
pub struct Details {
    id: i64,
}

impl Details {
    /// Creates a new endpoint struct for use in requesting details about
    /// an operation.
    ///
    /// ## Example
    /// ```
    /// use stellar_client::endpoint::operation;
    ///
    /// let details = operation::Details::new(123);
    /// ```
    pub fn new(id: i64) -> Details {
        Details { id }
    }
}

impl IntoRequest for Details {
    type Response = Operation;

    fn into_request(self, host: &str) -> Result<Request<Body>> {
        let uri = format!("{}/operations/{}", host, self.id);
        let uri = Uri::from_str(&uri)?;
        let request = Request::get(uri).body(Body::None)?;
        Ok(request)
    }
}

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

    #[test]
    fn it_builds_a_uri_without_params() {
        let ep = Details::new(123);
        let req = ep.into_request("https://www.google.com").unwrap();
        assert_eq!(req.uri().path(), "/operations/123");
        assert_eq!(req.uri().query(), None);
    }
}

/// The operation effects endpoint provides a set of effects that are associated with a single
/// operation. The operation ID provided in the id argument specifies which operation to load.
///
/// <https://www.stellar.org/developers/horizon/reference/endpoints/effects-for-operation.html>
///
/// ## Example
///
/// ```
/// use stellar_client::sync::Client;
/// use stellar_client::endpoint::{operation, Limit};
///
/// let client = Client::horizon_test().unwrap();
///
/// // Grab an operation so that we know that we can request one from
/// // horizon that actually exists.
/// let all = operation::All::default().with_limit(1);
/// let all = client.request(all).unwrap();
///
/// let operation_id = all.records()[0].id();
///
/// let effects = operation::Effects::new(operation_id);
/// let effects = client.request(effects).unwrap();
///
/// # assert!(effects.records().len() > 0);
/// ```
#[derive(Debug, Clone)]
pub struct Effects {
    id: i64,
    cursor: Option<String>,
    order: Option<Direction>,
    limit: Option<u32>,
}

impl_cursor!(Effects);
impl_limit!(Effects);
impl_order!(Effects);

impl Effects {
    /// Creates a new endpoint struct for use in requesting the effects for
    /// an operation.
    ///
    /// ## Example
    /// ```
    /// use stellar_client::endpoint::operation;
    ///
    /// let details = operation::Effects::new(123);
    /// ```
    pub fn new(id: i64) -> Effects {
        Effects {
            id,
            cursor: None,
            order: None,
            limit: None,
        }
    }

    fn has_query(&self) -> bool {
        self.order.is_some() || self.cursor.is_some() || self.limit.is_some()
    }
}

impl IntoRequest for Effects {
    type Response = Records<Effect>;

    fn into_request(self, host: &str) -> Result<Request<Body>> {
        let mut uri = format!("{}/operations/{}/effects", host, self.id);

        if self.has_query() {
            uri.push_str("?");

            if let Some(order) = self.order {
                uri.push_str(&format!("order={}&", order.to_string()));
            }

            if let Some(cursor) = self.cursor {
                uri.push_str(&format!("cursor={}&", cursor));
            }

            if let Some(limit) = self.limit {
                uri.push_str(&format!("limit={}", limit));
            }
        }

        let uri = Uri::from_str(&uri)?;
        let request = Request::get(uri).body(Body::None)?;
        Ok(request)
    }
}

impl TryFromUri for Effects {
    fn try_from_wrap(wrap: &UriWrap) -> ::std::result::Result<Self, uri::Error> {
        match wrap.path() {
            ["operations", id, "effects"] => {
                let params = wrap.params();
                Ok(Self {
                    id: id.parse()?,
                    cursor: params.get_parse("cursor").ok(),
                    order: params.get_parse("order").ok(),
                    limit: params.get_parse("limit").ok(),
                })
            }
            _ => Err(uri::Error::invalid_path()),
        }
    }
}

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

    #[test]
    fn it_leaves_off_the_params_if_not_specified() {
        let ep = Effects::new(123);
        let req = ep.into_request("https://www.google.com").unwrap();
        assert_eq!(req.uri().path(), "/operations/123/effects");
        assert_eq!(req.uri().query(), None);
    }

    #[test]
    fn it_puts_the_query_params_on_the_uri() {
        let ep = Effects::new(123)
            .with_cursor("CURSOR")
            .with_limit(123)
            .with_order(Direction::Desc);
        let req = ep.into_request("https://www.google.com").unwrap();
        assert_eq!(req.uri().path(), "/operations/123/effects");
        assert_eq!(
            req.uri().query(),
            Some("order=desc&cursor=CURSOR&limit=123")
        );
    }

    #[test]
    fn it_parses_query_params_from_uri() {
        let uri: Uri = "/operations/123/effects?order=desc&cursor=CURSOR&limit=123"
            .parse()
            .unwrap();

        let effects = Effects::try_from(&uri).unwrap();
        assert_eq!(effects.id, 123);
        assert_eq!(effects.order, Some(Direction::Desc));
        assert_eq!(effects.cursor, Some("CURSOR".to_string()));
        assert_eq!(effects.limit, Some(123));
    }
}