Merge pull request #2 from dscottboggs/fix/examples

Pre-release tasks

- chang the name of the project from elefren to mastodon-async
- fix and updates some documentation
- fix the examples

Author: dscottboggs

.cargo-ok

@@ -1,3 +1,19 @@
+<a name="v1.0.0"></a>
+## v1.0.0
+
+#### Breaking Changes
+
+* All functions which interact with the API are now async. As a part of this
+  change, the streaming API now returns a `Stream` instead of an `Iterator`.
+* The crate has been renamed to `mastodon-async`.
+* Search API v1 has been removed.
+
+#### Features
+* Structured logging
+
+#### Bug fixes
+* Streaming API was incomplete, it now works
+
 <a name="v0.18.0"></a>
 ## v0.18.0 (2019-01-05)
 

.clog.toml

@@ -1,5 +1,5 @@
 [package]
-name = "elefren"
+name = "mastodon-async"
 version = "1.0.0"
 authors = ["Aaron Power <[email protected]>", "Paul Woolcock <[email protected]>", "D. Scott Boggs <[email protected]>"]
 description = "A wrapper around the Mastodon API."
@@ -8,7 +8,7 @@ keywords = ["api", "web", "social", "mastodon", "wrapper"]
 categories = ["web-programming", "web-programming::http-client", "api-bindings"]
 license = "MIT/Apache-2.0"
 edition = "2021"
-repository = "https://github.com/dscottboggs/elefren.git"
+repository = "https://github.com/dscottboggs/mastodon-async.git"
 
 [package.metadata.docs.rs]
 features = ["all"]
@@ -70,9 +70,11 @@ features = ["io"]
 tokio-test = "0.4.2"
 futures-util = "0.3.25"
 indoc = "1.0"
-pretty_env_logger = "0.3.0"
 skeptic = "0.13"
 tempfile = "3"
+# for examples:
+femme = "2.2.1"
+html2text = "0.4.4"
 
 [build-dependencies.skeptic]
 version = "0.13"

.travis.yml

@@ -1,4 +1,5 @@
 Copyright 2016 Aaron Power
+Copyright © 2022 D. Scott Boggs
 
 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.

CHANGELOG.md

@@ -1,6 +1,7 @@
 MIT License (MIT)
 
 Copyright (c) 2016 Aaron Power
+Copyright © 2022 D. Scott Boggs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

Cargo.toml

@@ -1,56 +1,53 @@
-# Elefren
+# Async Mastodon client library 
 
-## A Wrapper for the Mastodon API.
+[![Build Status](https://github.com/dscottboggs/mastodon-async/actions/workflows/rust.yml/badge.svg)]
+[![crates.io](https://img.shields.io/crates/v/mastodon-async.svg)](https://crates.io/crates/mastodon-async)
+[![Docs](https://docs.rs/mastodon-async/badge.svg)](https://docs.rs/mastodon-async)
+[![MIT/APACHE-2.0](https://img.shields.io/crates/l/mastodon-async.svg)](https://crates.io/crates/mastodon-async)
 
-[![Build Status](https://github.com/dscottboggs/elefren/actions/workflows/rust.yml/badge.svg)](https://travis-ci.org/pwoolcoc/elefren)
-<!-- [![Coverage Status](https://coveralls.io/repos/github/pwoolcoc/elefren/badge.svg?branch=master&service=github)](https://coveralls.io/github/pwoolcoc/elefren?branch=master) -->
-<!-- [![crates.io](https://img.shields.io/crates/v/elefren.svg)](https://crates.io/crates/elefren) -->
-<!-- [![Docs](https://docs.rs/elefren/badge.svg)](https://docs.rs/elefren) -->
-<!-- [![MIT/APACHE-2.0](https://img.shields.io/crates/l/elefren.svg)](https://crates.io/crates/elefren) -->
+[Documentation](https://docs.rs/mastodon-async/)
 
-[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://botsin.space/)
+A type-safe, async wrapper around the client [API](https://github.com/tootsuite/documentation/blob/master/docs/Using-the-API/API.md#tag)
+for [Mastodon](https://botsin.space/)
 
 ## Installation
 
-To add `elefren` to your project, add the following to the
+To add `mastodon-async` to your project, add the following to the
 `[dependencies]` section of your `Cargo.toml`
 
 ```toml
-elefren = "0.23"
+mastodon-async = "1.0"
 ```
 
 Alternatively, run the following command:
 
 ~~~console
-$ cargo add elefren
+$ cargo add mastodon-async
 ~~~
 
 ## Example
 
 In your `Cargo.toml`, make sure you enable the `toml` feature:
 
 ```toml
-[dependencies]
-elefren = { version = "0.22", features = ["toml"] }
+[dependencies.mastodon-async]
+version = "1.0"
+features = ["toml"]
 ```
 
 ```rust,no_run
 // src/main.rs
 
-use std::error::Error;
-
-use elefren::prelude::*;
-use elefren::helpers::toml; // requires `features = ["toml"]`
-use elefren::helpers::cli;
+use mastodon_async::prelude::*;
+use mastodon_async::helpers::toml; // requires `features = ["toml"]`
+use mastodon_async::{helpers::cli, Result};
 
 #[tokio::main]
-async fn main() -> Result<(), Box<dyn Error>> {
+async fn main() -> Result<()> {
     let mastodon = if let Ok(data) = toml::from_file("mastodon-data.toml") {
         Mastodon::from(data)
     } else {
-        register()?
+        register().await?
     };
 
     let you = mastodon.verify_credentials().await?;
@@ -60,14 +57,15 @@ async fn main() -> Result<(), Box<dyn Error>> {
     Ok(())
 }
 
-fn register() -> Result<Mastodon, Box<dyn Error>> {
+async fn register() -> Result<Mastodon> {
     let registration = Registration::new("https://botsin.space")
-                                    .client_name("elefren-examples")
-                                    .build()?;
-    let mastodon = cli::authenticate(registration)?;
+                                    .client_name("mastodon-async-examples")
+                                    .build()
+                                    .await?;
+    let mastodon = cli::authenticate(registration).await?;
 
     // Save app data for using on the next run.
-    toml::to_file(&*mastodon, "mastodon-data.toml")?;
+    toml::to_file(&mastodon.data, "mastodon-data.toml")?;
 
     Ok(mastodon)
 }
@@ -76,24 +74,23 @@ fn register() -> Result<Mastodon, Box<dyn Error>> {
 It also supports the [Streaming API](https://docs.joinmastodon.org/api/streaming):
 
 ```rust,no_run
-use elefren::prelude::*;
-use elefren::entities::event::Event;
-
-use std::error::Error;
+use mastodon_async::{prelude::*, Result, entities::event::Event};
+use futures_util::TryStreamExt;
 
 #[tokio::main]
-async fn main() -> Result<(), Box<Error>> {
+async fn main() -> Result<()> {
     let client = Mastodon::from(Data::default());
 
     client.stream_user()
         .await?
-        .try_for_each(|event| {
+        .try_for_each(|event| async move {
             match event {
                 Event::Update(ref status) => { /* .. */ },
                 Event::Notification(ref notification) => { /* .. */ },
                 Event::Delete(ref id) => { /* .. */ },
                 Event::FiltersChanged => { /* .. */ },
             }
+            Ok(())
         })
         .await?;
     Ok(())