xesite/lib/jsonfeed/src/lib.rs

//! JSON Feed is a syndication format similar to ATOM and RSS, using JSON
//! instead of XML
//!
//! This crate can serialize and deserialize between JSON Feed strings
//! and Rust data structures. It also allows for programmatically building 
//! a JSON Feed
//!
//! Example:
//!
//! ```rust
//! extern crate jsonfeed;
//!
//! use jsonfeed::{Feed, Item};
//!
//! fn run() -> Result<(), jsonfeed::Error> {
//!     let j = r#"{
//!         "title": "my feed",
//!         "version": "https://jsonfeed.org/version/1",
//!         "items": []
//!     }"#;
//!     let feed = jsonfeed::from_str(j).unwrap();
//!
//!     let new_feed = Feed::builder()
//!                         .title("some other feed")
//!                         .item(Item::builder()
//!                                 .title("some item title")
//!                                 .content_html("<p>Hello, World</p>")
//!                                 .build()?)
//!                         .item(Item::builder()
//!                                 .title("some other item title")
//!                                 .content_text("Hello, World!")
//!                                 .build()?)
//!                         .build();
//!     println!("{}", jsonfeed::to_string(&new_feed).unwrap());
//!     Ok(())
//! }
//! fn main() {
//!     let _ = run();
//! }
//! ```

extern crate serde;
#[macro_use] extern crate error_chain;
#[macro_use] extern crate serde_derive;
extern crate serde_json;

mod errors;
mod item;
mod feed;
mod builder;

pub use errors::*;
pub use item::*;
pub use feed::{Feed, Author, Attachment};

use std::io::Write;

/// Attempts to convert a string slice to a Feed object
///
/// Example
///
/// ```rust
/// # extern crate jsonfeed;
/// # use jsonfeed::Feed;
/// # use std::default::Default;
/// # fn main() {
/// let json = r#"{"version": "https://jsonfeed.org/version/1", "title": "", "items": []}"#;
/// let feed: Feed = jsonfeed::from_str(&json).unwrap();
///
/// assert_eq!(feed, Feed::default());
/// # }
/// ```
pub fn from_str(s: &str) -> Result<Feed> {
    Ok(serde_json::from_str(s)?)
}

/// Deserialize a Feed object from an IO stream of JSON
pub fn from_reader<R: ::std::io::Read>(r: R) -> Result<Feed> {
    Ok(serde_json::from_reader(r)?)
}

/// Deserialize a Feed object from bytes of JSON text
pub fn from_slice<'a>(v: &'a [u8]) -> Result<Feed> {
    Ok(serde_json::from_slice(v)?)
}

/// Convert a serde_json::Value type to a Feed object
pub fn from_value(value: serde_json::Value) -> Result<Feed> {
    Ok(serde_json::from_value(value)?)
}

/// Serialize a Feed to a JSON Feed string
pub fn to_string(value: &Feed) -> Result<String> {
    Ok(serde_json::to_string(value)?)
}

/// Pretty-print a Feed to a JSON Feed string
pub fn to_string_pretty(value: &Feed) -> Result<String> {
    Ok(serde_json::to_string_pretty(value)?)
}

/// Convert a Feed to a serde_json::Value
pub fn to_value(value: Feed) -> Result<serde_json::Value> {
    Ok(serde_json::to_value(value)?)
}

/// Convert a Feed to a vector of bytes of JSON
pub fn to_vec(value: &Feed) -> Result<Vec<u8>> {
    Ok(serde_json::to_vec(value)?)
}

/// Convert a Feed to a vector of bytes of pretty-printed JSON
pub fn to_vec_pretty(value: &Feed) -> Result<Vec<u8>> {
    Ok(serde_json::to_vec_pretty(value)?)
}

/// Serialize a Feed to JSON and output to an IO stream
pub fn to_writer<W>(writer: W, value: &Feed) -> Result<()>
        where W: Write
{
    Ok(serde_json::to_writer(writer, value)?)
}

/// Serialize a Feed to pretty-printed JSON and output to an IO stream
pub fn to_writer_pretty<W>(writer: W, value: &Feed) -> Result<()>
        where W: Write
{
    Ok(serde_json::to_writer_pretty(writer, value)?)
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Cursor;

    #[test]
    fn from_str() {
        let feed = r#"{"version": "https://jsonfeed.org/version/1","title":"","items":[]}"#;
        let expected = Feed::default();
        assert_eq!(
                super::from_str(&feed).unwrap(),
                expected
        );
    }
    #[test]
    fn from_reader() {
        let feed = r#"{"version": "https://jsonfeed.org/version/1","title":"","items":[]}"#;
        let feed = feed.as_bytes();
        let feed = Cursor::new(feed);
        let expected = Feed::default();
        assert_eq!(
                super::from_reader(feed).unwrap(),
                expected
        );
    }
    #[test]
    fn from_slice() {
        let feed = r#"{"version": "https://jsonfeed.org/version/1","title":"","items":[]}"#;
        let feed = feed.as_bytes();
        let expected = Feed::default();
        assert_eq!(
                super::from_slice(&feed).unwrap(),
                expected
        );
    }
    #[test]
    fn from_value() {
        let feed = r#"{"version": "https://jsonfeed.org/version/1","title":"","items":[]}"#;
        let feed: serde_json::Value = serde_json::from_str(&feed).unwrap();
        let expected = Feed::default();
        assert_eq!(
                super::from_value(feed).unwrap(),
                expected
        );
    }
    #[test]
    fn to_string() {
        let feed = Feed::default();
        let expected = r#"{"version":"https://jsonfeed.org/version/1","title":"","items":[]}"#;
        assert_eq!(
                super::to_string(&feed).unwrap(),
                expected
        );
    }
    #[test]
    fn to_string_pretty() {
        let feed = Feed::default();
        let expected = r#"{
  "version": "https://jsonfeed.org/version/1",
  "title": "",
  "items": []
}"#;
        assert_eq!(
                super::to_string_pretty(&feed).unwrap(),
                expected
        );
    }
    #[test]
    fn to_value() {
        let feed = r#"{"version":"https://jsonfeed.org/version/1","title":"","items":[]}"#;
        let expected: serde_json::Value = serde_json::from_str(&feed).unwrap();
        assert_eq!(
                super::to_value(Feed::default()).unwrap(),
                expected
        );
    }
    #[test]
    fn to_vec() {
        let feed = r#"{"version":"https://jsonfeed.org/version/1","title":"","items":[]}"#;
        let expected = feed.as_bytes();
        assert_eq!(
                super::to_vec(&Feed::default()).unwrap(),
                expected
        );
    }
    #[test]
    fn to_vec_pretty() {
        let feed = r#"{
  "version": "https://jsonfeed.org/version/1",
  "title": "",
  "items": []
}"#;
        let expected = feed.as_bytes();
        assert_eq!(
                super::to_vec_pretty(&Feed::default()).unwrap(),
                expected
        );
    }
    #[test]
    fn to_writer() {
        let feed = r#"{"version":"https://jsonfeed.org/version/1","title":"","items":[]}"#;
        let feed = feed.as_bytes();
        let mut writer = Cursor::new(Vec::with_capacity(feed.len()));
        super::to_writer(&mut writer, &Feed::default()).expect("Could not write to writer");
        let result = writer.into_inner();
        assert_eq!(result, feed);
    }
    #[test]
    fn to_writer_pretty() {
        let feed = r#"{
  "version": "https://jsonfeed.org/version/1",
  "title": "",
  "items": []
}"#;
        let feed = feed.as_bytes();
        let mut writer = Cursor::new(Vec::with_capacity(feed.len()));
        super::to_writer_pretty(&mut writer, &Feed::default()).expect("Could not write to writer");
        let result = writer.into_inner();
        assert_eq!(result, feed);
    }
}