You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
108 lines
2.9 KiB
108 lines
2.9 KiB
# Elefren
|
|
|
|
## A Wrapper for the Mastodon API.
|
|
|
|
[](https://travis-ci.org/pwoolcoc/elefren)
|
|
[](https://ci.appveyor.com/project/pwoolcoc/elefren)
|
|
[](https://coveralls.io/github/pwoolcoc/elefren?branch=master)
|
|
[](https://crates.io/crates/elefren)
|
|
[](https://docs.rs/elefren)
|
|
[](https://crates.io/crates/elefren)
|
|
|
|
[Documentation](https://docs.rs/elefren/)
|
|
|
|
A wrapper around the [API](https://github.com/tootsuite/documentation/blob/master/docs/Using-the-API/API.md#tag) for [Mastodon](https://mastodon.social/)
|
|
|
|
## Installation
|
|
|
|
To add `elefren` to your project, add the following to the
|
|
`[dependencies]` section of your `Cargo.toml`
|
|
|
|
```toml
|
|
elefren = "0.19"
|
|
```
|
|
|
|
## Usage
|
|
|
|
To use this crate in your project, add this to your crate root (lib.rs, main.rs, etc):
|
|
|
|
```rust,ignore
|
|
extern crate elefren;
|
|
```
|
|
|
|
## Example
|
|
|
|
In your `Cargo.toml`, make sure you enable the `toml` feature:
|
|
|
|
```toml
|
|
[dependencies]
|
|
elefren = { version = "0.19", features = ["toml"] }
|
|
```
|
|
|
|
```rust,no_run
|
|
// src/main.rs
|
|
extern crate elefren;
|
|
|
|
use std::error::Error;
|
|
|
|
use elefren::prelude::*;
|
|
use elefren::helpers::toml; // requires `features = ["toml"]`
|
|
use elefren::helpers::cli;
|
|
|
|
fn main() -> Result<(), Box<Error>> {
|
|
let mastodon = if let Ok(data) = toml::from_file("mastodon-data.toml") {
|
|
Mastodon::from(data)
|
|
} else {
|
|
register()?
|
|
};
|
|
|
|
let you = mastodon.verify_credentials()?;
|
|
|
|
println!("{:#?}", you);
|
|
|
|
Ok(())
|
|
}
|
|
|
|
fn register() -> Result<Mastodon, Box<Error>> {
|
|
let registration = Registration::new("https://mastodon.social")
|
|
.client_name("elefren-examples")
|
|
.build()?;
|
|
let mastodon = cli::authenticate(registration)?;
|
|
|
|
// Save app data for using on the next run.
|
|
toml::to_file(&*mastodon, "mastodon-data.toml")?;
|
|
|
|
Ok(mastodon)
|
|
}
|
|
```
|
|
|
|
It also supports the [Streaming API](https://docs.joinmastodon.org/api/streaming):
|
|
|
|
```no_run
|
|
use elefren::prelude::*;
|
|
use elefren::entities::event::Event;
|
|
|
|
use std::error::Error;
|
|
|
|
fn main() -> Result<(), Box<Error>> {
|
|
let data = Data {
|
|
base: "".into(),
|
|
client_id: "".into(),
|
|
client_secret: "".into(),
|
|
redirect: "".into(),
|
|
token: "".into(),
|
|
};
|
|
|
|
let client = Mastodon::from(data);
|
|
|
|
for event in client.streaming_user()? {
|
|
match event {
|
|
Event::Update(ref status) => { /* .. */ },
|
|
Event::Notification(ref notification) => { /* .. */ },
|
|
Event::Delete(ref id) => { /* .. */ },
|
|
Event::FiltersChanged => { /* .. */ },
|
|
}
|
|
}
|
|
Ok(())
|
|
}
|
|
```
|
|
|