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 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375
#![deny(missing_docs)] /*! Rust API client for the instances.social API ```no_run use instances_social::Client; const TOKEN: &'static str = "..."; fn main() { let client = Client::new(TOKEN); // all the API calls are available like this: // // client.instances().list() // client.instances().sample() // client.instances().search() // client.instances().show() // client.versions().list() // client.versions().show() } ``` */ #[macro_use] extern crate serde_derive; use std::error::Error; use serde::{Deserialize, Serialize}; use tap_reader::Tap; use url::{ParseError, Url}; pub mod instances; pub mod versions; fn url(path: &str) -> Result<Url, ParseError> { let url = format!("https://instances.social/api/1.0/{}", path); Url::parse(&url) } /// Instances.social client /// /// requires an API token pub struct Client { token: String, client: reqwest::Client, } impl Client { /// Create a new client from a token pub fn new(token: &str) -> Client { Client { token: token.into(), client: reqwest::Client::new(), } } fn token(&self) -> String { format!("Bearer {}", self.token) } /// Access the /versions/* API calls pub fn versions(&self) -> Versions { Versions(self) } /// Access the /instances/* API calls pub fn instances(&self) -> Instances { Instances(self) } fn get_qs<S: Serialize>(&self, path: &str, data: S) -> Result<reqwest::RequestBuilder, Box<Error>> { let mut url = url(path)?; let qs = serde_qs::to_string(&data)?; url.set_query(Some(qs.as_ref())); Ok(self.client.get(url.as_str()).header(reqwest::header::AUTHORIZATION, &self.token()[..])) } fn send<D>(&self, req: reqwest::RequestBuilder) -> Result<D, Box<Error>> where for<'de> D: Deserialize<'de>, { let resp = req.send()?; let mut reader = Tap::new(resp); Ok(match serde_json::from_reader(&mut reader) { Ok(r) => r, Err(e) => { let err = String::from_utf8_lossy(&reader.bytes); eprintln!("error: {:?}\nsource: {}", e, err); return Err(e.into()); } }) } } /// Container for the /versions/* API calls /// /// # List versions /// /// ```no_run /// use instances_social::Client; /// /// const TOKEN: &'static str = "..."; /// /// fn main() -> Result<(), Box<std::error::Error>> { /// let client = Client::new(TOKEN); /// /// let result = client.versions() /// .list() // returns this builder /// .count(100) // sets the ?count=100 querystring param /// // ...etc /// .send()?; // actually sends the request /// Ok(()) /// } /// ``` /// /// # Show version /// /// ```no_run /// use instances_social::Client; /// /// const TOKEN: &'static str = "..."; /// /// fn main() -> Result<(), Box<std::error::Error>> { /// let client = Client::new(TOKEN); /// /// let result = client.versions() /// .show("2.7.0") // returns this builder /// // ...etc /// .send()?; // actually sends the request /// Ok(()) /// } /// ``` pub struct Versions<'a>(&'a Client); impl<'a> Versions<'a> { /// Starts build a versions/list call pub fn list(&self) -> versions::ListRequestBuilder { versions::ListRequestBuilder::new(self.0) } /// Starts building a versions/show call pub fn show(&self, name: &str) -> versions::ShowRequestBuilder { versions::ShowRequestBuilder::new(self.0, name) } } /// Container for the /instances/* API calls /// /// # Sample instances /// /// ```no_run /// use instances_social::Client; /// /// const TOKEN: &'static str = "..."; /// /// fn main() -> Result<(), Box<std::error::Error>> { /// let client = Client::new(TOKEN); /// /// let result = client.instances() /// .sample() // returns this builder /// .count(100) // sets the ?count=100 querystring param /// // ...etc /// .send()?; // actually sends the request /// Ok(()) /// } /// ``` /// /// # Show instance /// /// /// ```no_run /// use instances_social::Client; /// /// const TOKEN: &'static str = "..."; /// /// fn main() -> Result<(), Box<std::error::Error>> { /// let client = Client::new(TOKEN); /// /// let result = client.instances() /// .show("mastodon.social") // returns this builder /// .send()?; // actually sends the request /// Ok(()) /// } /// ``` /// /// # List instances /// /// ```no_run /// use instances_social::Client; /// /// const TOKEN: &'static str = "..."; /// /// fn main() -> Result<(), Box<std::error::Error>> { /// let client = Client::new(TOKEN); /// /// let result = client.instances() /// .list() // returns this builder /// .count(100) // sets the ?count=100 querystring param /// // ...etc /// .send()?; // actually sends the request /// Ok(()) /// } /// ``` /// /// # Search instances /// /// ```no_run /// use instances_social::Client; /// /// const TOKEN: &'static str = "..."; /// /// fn main() -> Result<(), Box<std::error::Error>> { /// let client = Client::new(TOKEN); /// /// let result = client.instances() /// .search("some-query") // returns this builder /// .count(100) // sets the ?count=100 querystring param /// // ...etc /// .send()?; // actually sends the request /// Ok(()) /// } /// ``` pub struct Instances<'a>(&'a Client); impl<'a> Instances<'a> { /// Represents a request to the https://instances.social/api/1.0/instances/sample endpoint /// /// ```no_run /// use instances_social::Client; /// /// const TOKEN: &'static str = "..."; /// /// fn main() -> Result<(), Box<std::error::Error>> { /// let client = Client::new(TOKEN); /// /// let result = client.instances() /// .sample() // returns this builder /// .count(100) // sets the ?count=100 querystring param /// // ...etc /// .send()?; // actually sends the request /// Ok(()) /// } /// ``` pub fn sample(&self) -> instances::SampleRequestBuilder { instances::SampleRequestBuilder::new(self.0) } /// Request builder for the instances/list call /// /// ```no_run /// use instances_social::Client; /// /// const TOKEN: &'static str = "..."; /// /// fn main() -> Result<(), Box<std::error::Error>> { /// let client = Client::new(TOKEN); /// /// let result = client.instances() /// .list() // returns this builder /// .count(100) // sets the ?count=100 querystring param /// // ...etc /// .send()?; // actually sends the request /// Ok(()) /// } /// ``` pub fn list(&self) -> instances::ListRequestBuilder { instances::ListRequestBuilder::new(self.0) } /// Represents a request to the https://instances.social/api/1.0/instances/search endpoint /// /// ```no_run /// use instances_social::Client; /// /// const TOKEN: &'static str = "..."; /// /// fn main() -> Result<(), Box<std::error::Error>> { /// let client = Client::new(TOKEN); /// /// let result = client.instances() /// .search("some-query") // returns this builder /// .count(100) // sets the ?count=100 querystring param /// // ...etc /// .send()?; // actually sends the request /// Ok(()) /// } /// ``` pub fn search(&self, q: &str) -> instances::SearchRequestBuilder { instances::SearchRequestBuilder::new(self.0, q) } /// Represents a request to the https://instances.social/api/1.0/instances/show endpoint /// /// ```no_run /// use instances_social::Client; /// /// const TOKEN: &'static str = "..."; /// /// fn main() -> Result<(), Box<std::error::Error>> { /// let client = Client::new(TOKEN); /// /// let result = client.instances() /// .show("mastodon.social") // returns this builder /// .send()?; // actually sends the request /// Ok(()) /// } /// ``` pub fn show(&self, name: &str) -> instances::ShowRequestBuilder { instances::ShowRequestBuilder::new(self.0, name) } } pub(crate) trait Resp { type Item: Clone; fn items(&self) -> &Vec<Self::Item>; fn next(&self) -> Option<String>; } pub(crate) trait ItemIter { type Response: Resp; fn get_page(&mut self, token: Option<&String>) -> Result<Self::Response, Box<Error>>; } pub(crate) struct ItemIterator<I: ItemIter> { source: I, token: Option<String>, init: bool, buffer: Vec<<I::Response as Resp>::Item>, } impl<I: ItemIter> ItemIterator<I> { pub(crate) fn new(source: I) -> ItemIterator<I> { ItemIterator { source, token: None, init: false, buffer: Vec::new(), } } fn fill_buffer(&mut self) -> Result<(), Box<Error>> { if !self.init { let page = self.source.get_page(None)?; self.buffer.extend_from_slice(page.items()); self.token = page.next(); self.init = true; } if let Some(ref t) = self.token { let page = self.source.get_page(Some(t))?; self.buffer.extend_from_slice(page.items()); self.token = page.next(); } Ok(()) } } impl<I> Iterator for ItemIterator<I> where I: ItemIter, { type Item = <<I as ItemIter>::Response as Resp>::Item; fn next(&mut self) -> Option<Self::Item> { if self.buffer.is_empty() { if self.fill_buffer().is_err() { return None; } } self.buffer.pop() } }