mlb-api 1.0.3

Endpoints for MLB's public Statcast 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
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129

//! An award, such as the Cy Young, MVP, etc.
//! 
//! There are over a thousand awards for pretty much every organized league you can think of.

use crate::league::LeagueId;
use crate::request::RequestURL;
use crate::season::SeasonId;
use crate::sport::SportId;
use crate::Copyright;
use bon::Builder;
use serde::Deserialize;
use std::fmt::{Display, Formatter};
use crate::cache::Requestable;

#[cfg(feature = "cache")]
use crate::{rwlock_const_new, RwLock, cache::CacheTable};

/// Response from the `awards` endpoint.
/// Returns a [`Vec`] of [`Award`]s
///
/// Example: <http://statsapi.mlb.com/api/v1/awards>
#[derive(Debug, Deserialize, PartialEq, Clone)]
pub struct AwardsResponse {
	pub copyright: Copyright,
	pub awards: Vec<Award>,
}

/// An award, such as the Cy Young or MVP.
#[derive(Debug, Deserialize, Clone)]
pub struct Award {
	/// Name of the award
	pub name: String,
	/// Description of the award
	pub description: Option<String>,
	/// Sport associated with the award
	pub sport: Option<SportId>,
	/// League associated with the award
	pub league: Option<LeagueId>,
	/// Notes (if necessary)
	pub notes: Option<String>,
	#[serde(flatten)]
	pub id: AwardId,
}

id_only_eq_impl!(Award, id);
id!(#[doc = "A string representing an award, ID of award, used in [`AwardRequest`]"] AwardId { id: String });

/// Returns [`AwardResponse`]
#[derive(Builder)]
#[builder(derive(Into))]
pub struct AwardRequest {
	#[builder(into)]
	award_id: Option<AwardId>,
	#[builder(into)]
	sport_id: Option<SportId>,
	#[builder(into)]
	league_id: Option<LeagueId>,
	#[builder(into)]
	season: Option<SeasonId>,
}

impl<S: award_request_builder::State + award_request_builder::IsComplete> crate::request::RequestURLBuilderExt for AwardRequestBuilder<S> {
    type Built = AwardRequest;
}

impl Display for AwardRequest {
	fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
		write!(
			f,
			"http://statsapi.mlb.com/api/v1/awards{}",
			gen_params! { "awardId"?: self.award_id.as_ref(), "sportId"?: self.sport_id, "leagueId"?: self.league_id, "season"?: self.season }
		)
	}
}

impl RequestURL for AwardRequest {
	type Response = AwardsResponse;
}

#[cfg(feature = "cache")]
static CACHE: RwLock<CacheTable<Award>> = rwlock_const_new(CacheTable::new());

impl Requestable for Award {
	type Identifier = AwardId;
	type URL = AwardRequest;

	fn id(&self) -> &Self::Identifier {
		&self.id
	}

	#[cfg(feature = "aggressive_cache")]
	fn url_for_id(_id: &Self::Identifier) -> Self::URL {
		AwardRequest::builder().build()
	}

	#[cfg(not(feature = "aggressive_cache"))]
	fn url_for_id(id: &Self::Identifier) -> Self::URL {
		AwardRequest::builder().award_id(id.clone()).build()
	}

	fn get_entries(response: <Self::URL as RequestURL>::Response) -> impl IntoIterator<Item=Self>
	where
		Self: Sized
	{
		response.awards
	}

	#[cfg(feature = "cache")]
	fn get_cache_table() -> &'static RwLock<CacheTable<Self>>
	where
		Self: Sized
	{
		&CACHE
	}
}

entrypoint!(AwardId => Award);
entrypoint!(Award.id => Award);

#[cfg(test)]
mod tests {
	use crate::awards::AwardRequest;
	use crate::request::RequestURLBuilderExt;

	#[tokio::test]
	async fn parse_this_season() {
		let _response = AwardRequest::builder().build_and_get().await.unwrap();
	}
}