webmention 0.6.0

Library and a CLI tool for sending and validation webmentions
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

//! # webmention
//!
//! Provides support for sending and receiving webmentions. [Webmention](https://www.w3.org/TR/webmention/)
//! is a W3C recommendation for notifying that a link from one URL to another was published.
//!
//! In short: to receive webmentions you need to process POST requests with `source` and `target`
//! on advertised endpoint URL. There are various ways to advertise your endpoint, the simplest of all
//! is to place `<link rel="webmention" href="endpoint_url">` inside of your document.
//!
//! To send webmentions you need to discover endpoint and send a POST request with
//! `source` and `target` payload.
//!
//! ## CLI tool
//!
//! There is a CLI tool available with support for sending webmentions, and (optionally) a simple endpoint
//! based on Rocket.

pub mod error;
/// Defines document
pub mod html;
/// Defines http_client that is used for GETting and POSTing
pub mod http_client;
/// Defines utility to deal with LINK header
pub mod link_header;

/// Specifies the endpoint discovery algorithm
pub mod endpoint_discovery;
/// Defines interface for webmention storage
#[cfg(feature = "receive")]
pub mod storage;
pub mod webmention;
/// Defines utility to deal with URLs.
pub(crate) mod wm_url;

/// Various error conditions that could happen during processing webmentions
pub use crate::error::WebmentionError;
/// Source URL and target URL combined with some metadata
pub use crate::webmention::Webmention;

#[cfg(feature = "receive")]
pub async fn receive_webmention(
    storage: &impl crate::storage::WebmentionStorage,
    source: &Url,
    target: &Url,
) -> Result<bool, WebmentionError> {
    let mut mention = Webmention::from((source.clone(), target.clone()));
    if mention.check().await? {
        println!("Storing webmention {:?}", mention);
        storage
            .store(mention)
            .map_err(|source| WebmentionError::StorageError {
                source: Box::new(source),
            })?;
        return Ok(true);
    } else {
        Ok(false)
    }
}