steamr 0.4.0

HTTP client library to communicate with Valve's Steam API
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
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

//! Apps on Steam and news about them.

use serde::Deserialize;

use crate::{client::SteamClient, errors::SteamError};

/// The Steam API "GetNewsForApp (v0002)" endpoint
const ENDPOINT_GAME_NEWS: &str = "https://api.steampowered.com/ISteamNews/GetNewsForApp/v0002";

/// Helper struct used during deserializing the API response.
#[derive(Debug, Deserialize)]
struct GameNewsResponse {
    #[serde(rename(deserialize = "appnews"))]
    response: Option<GameNews>,
}

/// Response from the GetNewsForApp API
#[derive(Debug, Default, Deserialize)]
pub struct GameNews {
    /// List of [`News`] for a given game ID
    #[serde(rename(deserialize = "newsitems"))]
    pub game_news: Vec<News>,
    /// The total number of available news for the given game ID
    pub count: i16,
}

impl From<GameNewsResponse> for GameNews {
    fn from(value: GameNewsResponse) -> Self {
        let v = value.response.unwrap_or_default();
        Self {
            game_news: v.game_news,
            count: v.count,
        }
    }
}

/// A Steam news object
#[derive(Debug, Deserialize)]
pub struct News {
    /// News ID
    #[serde(rename(deserialize = "gid"))]
    pub news_id: String,
    /// Title
    pub title: String,
    /// URL
    pub url: String,
    /// News author
    pub author: String,
    /// News content
    pub contents: String,
    /// Date as UNIX timestamp
    pub date: i64,
    /// Name of the feed
    #[serde(rename(deserialize = "feedname"))]
    pub feed_name: String,
}

impl SteamClient {
    /// Returns the news for a game.
    ///
    /// You can control both the number of news that you want to fetch and
    /// the maximum length of the news content (although this does not work strictly, for example when
    /// it contains hyperlinks, so this is not a number to rely on!)
    ///
    /// This endpoint doesn't necessarily require an API key.
    ///
    /// Example:
    ///
    /// ```
    /// # use steamr::client::SteamClient;
    /// # use steamr::errors::SteamError;
    /// fn main() -> Result<(), SteamError> {
    ///     let steam_client = SteamClient::from("an-api-key".to_string());
    ///     let app_id ="10";  // This is CS:GO
    ///     let news = steam_client.get_game_news(app_id, 5, 100)?;
    ///
    ///     news.game_news.iter()
    ///         .for_each(|n| println!("The article '{}' was written by '{}'", n.title, n.author));
    ///
    ///     Ok(())
    /// }
    /// ```
    pub fn get_game_news(
        &self,
        app_id: &str,
        news_count: u16,
        max_length: u16,
    ) -> Result<GameNews, SteamError> {
        let response = self.get_request(
            ENDPOINT_GAME_NEWS,
            vec![
                ("appid", app_id),
                ("count", &news_count.to_string()),
                ("maxlength", &max_length.to_string()),
            ],
        )?;

        let news = self
            .parse_response::<GameNewsResponse, GameNews>(response)
            .unwrap();
        Ok(news)
    }
}