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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
//! Interfaces for accessing and managing components
use serde::{Deserialize, Serialize};
// Ours
use crate::{Component, Jira, Result};
#[derive(Deserialize, Serialize, Debug)]
pub struct CreateComponent {
pub name: String,
pub description: Option<String>,
pub project: String,
}
#[derive(Deserialize, Serialize, Debug)]
pub struct CreateComponentResponse {
pub id: String,
pub name: String,
pub description: Option<String>,
pub project: String,
#[serde(rename = "self")]
pub url: String,
}
#[derive(Debug)]
pub struct Components {
jira: Jira,
}
impl Components {
pub fn new(jira: &Jira) -> Components {
Components { jira: jira.clone() }
}
/// Get a single component
///
/// See this [jira docs](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/component-getComponent)
/// for more information
pub fn get<I>(&self, id: I) -> Result<Component>
where
I: Into<String>,
{
self.jira.get("api", &format!("/component/{}", id.into()))
}
/// Create a new component
///
/// See this [jira docs](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/component-createComponent)
/// for more information
pub fn create(&self, data: CreateComponent) -> Result<CreateComponentResponse> {
self.jira.post("api", "/component", data)
}
/// Update a component
///
/// See this [jira docs](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/component-updateComponent)
/// for more information
pub fn update<I>(&self, id: I, data: CreateComponent) -> Result<CreateComponentResponse>
where
I: Into<String>,
{
self.jira
.put("api", &format!("/component/{}", id.into()), data)
}
/// Edit a component
///
/// # Deprecated
///
/// Use [`Components::update`] instead. This method will be removed in a future version.
///
/// See this [jira docs](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/component-updateComponent)
/// for more information
#[deprecated(
since = "0.16.0",
note = "Use `update` instead for consistency with REST conventions"
)]
pub fn edit<I>(&self, id: I, data: CreateComponent) -> Result<CreateComponentResponse>
where
I: Into<String>,
{
self.update(id, data)
}
/// Returns all components of a project
///
/// See this [jira docs](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/project-getProjectComponents)
/// for more information
pub fn list<I>(&self, project_id_or_key: I) -> Result<Vec<Component>>
where
I: Into<String>,
{
let path = format!("/project/{}/components", project_id_or_key.into());
self.jira.get::<Vec<Component>>("api", &path)
}
/// Delete a component
///
/// See this [jira docs](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-components/#api-rest-api-2-component-id-delete)
/// for more information
pub fn delete<I>(&self, id: I) -> Result<()>
where
I: Into<String>,
{
self.jira
.delete::<crate::EmptyResponse>("api", &format!("/component/{}", id.into()))?;
Ok(())
}
}
#[cfg(feature = "async")]
use crate::r#async::Jira as AsyncJira;
#[cfg(feature = "async")]
#[derive(Debug)]
pub struct AsyncComponents {
jira: AsyncJira,
}
#[cfg(feature = "async")]
impl AsyncComponents {
pub fn new(jira: &AsyncJira) -> AsyncComponents {
AsyncComponents { jira: jira.clone() }
}
/// Get a single component
///
/// See this [jira docs](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/component-getComponent)
/// for more information
pub async fn get<I>(&self, id: I) -> Result<Component>
where
I: Into<String>,
{
self.jira
.get("api", &format!("/component/{}", id.into()))
.await
}
/// Create a new component
///
/// See this [jira docs](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/component-createComponent)
/// for more information
pub async fn create(&self, data: CreateComponent) -> Result<CreateComponentResponse> {
self.jira.post("api", "/component", data).await
}
/// Update a component
///
/// See this [jira docs](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/component-updateComponent)
/// for more information
pub async fn update<I>(&self, id: I, data: CreateComponent) -> Result<CreateComponentResponse>
where
I: Into<String>,
{
self.jira
.put("api", &format!("/component/{}", id.into()), data)
.await
}
/// Edit a component
///
/// # Deprecated
///
/// Use [`AsyncComponents::update`] instead. This method will be removed in a future version.
///
/// See this [jira docs](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/component-updateComponent)
/// for more information
#[deprecated(
since = "0.16.0",
note = "Use `update` instead for consistency with REST conventions"
)]
pub async fn edit<I>(&self, id: I, data: CreateComponent) -> Result<CreateComponentResponse>
where
I: Into<String>,
{
self.update(id, data).await
}
/// Returns all components of a project
///
/// See this [jira docs](https://docs.atlassian.com/software/jira/docs/api/REST/latest/#api/2/project-getProjectComponents)
/// for more information
pub async fn list<I>(&self, project_id_or_key: I) -> Result<Vec<Component>>
where
I: Into<String>,
{
let path = format!("/project/{}/components", project_id_or_key.into());
self.jira.get::<Vec<Component>>("api", &path).await
}
/// Delete a component
///
/// See this [jira docs](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-project-components/#api-rest-api-2-component-id-delete)
/// for more information
pub async fn delete<I>(&self, id: I) -> Result<()>
where
I: Into<String>,
{
self.jira
.delete::<crate::EmptyResponse>("api", &format!("/component/{}", id.into()))
.await?;
Ok(())
}
}