tide-github 0.3.0

Easily process Github webhooks using tide
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

use std::convert::TryInto;
use octocrab::models::{Repository, User, issues::Comment, issues::Issue};
use serde::Deserialize;

/// [`Payload`] represents the (JSON) payload of the webhook Github send us.
///
/// Every webhook includes this payload. The presence of the `Option`al fields
/// depends on the event type this payload was send for.
///
/// For some event types there exists a specialized type with `Option<T>`
/// changed for `T` where possible. Conversion from [`Payload`] to a more
/// specialized type can be done through `TryInto` implementations.
#[derive(Deserialize, Debug)]
pub struct Payload {
    /// The action (created/edited/deleted) that triggered the webhook.
    pub action: Action,
    /// The account that triggered the action that triggered the webhook.
    pub sender: User,
    /// The repository associated with the webhook.
    pub repository: Repository,
    /// The comment involved in the action. Only present for some event types.
    pub comment: Option<Comment>,
    /// The issue involved in the action. Only present for some event types.
    pub issue: Option<Issue>,
}

/// [`IssueCommentPayload`] is a specialized version of [`Payload`] for the
/// `IssueComment` event.
///
/// Notably, the `Option<T>` fields on [`Payload`] that should always be present
/// in the case of this event are now `T`. Because conversion can fail in case
/// the fields on the original [`Payload`] are `None`, conversion happens
/// through the [`TryInto`](::std::convert::TryInto) trait.
pub struct IssueCommentPayload {
    /// The action (created/edited/deleted) that triggered the webhook.
    pub action: Action,
    /// The account that triggered the action that triggered the webhook.
    pub sender: User,
    /// The issue the comment was placed on.
    pub issue: Issue,
    /// The comment involved in the action.
    pub comment: Comment,
    /// The repository the issue belongs to.
    pub repository: Repository,
}

impl TryInto<IssueCommentPayload> for Payload {
    type Error = Error;

    fn try_into(self) -> Result<IssueCommentPayload, Self::Error> {
        let comment = self.comment.ok_or(Error::MissingCommentPayload)?;
        let issue = self.issue.ok_or(Error::MissingIssuePayload)?;

        Ok(IssueCommentPayload {
            action: self.action,
            sender: self.sender,
            repository: self.repository,
            comment,
            issue,
        })
    }

}

/// The errors that can occur interpreting the webhook payload.
#[derive(thiserror::Error, Clone, Debug)]
pub enum Error {
    /// The event type indicated in the `X-Github-Event` header should include
    /// this field in the webhook payload but it didn't.
    #[error("Expected field \"comment\" not found in webhook payload")]
    MissingCommentPayload,
    /// The event type indicated in the `X-Github-Event` header should include
    /// this field in the webhook payload but it didn't.
    #[error("Expected field \"issue\" not found in webhook payload")]
    MissingIssuePayload,
}

/// Action represents the action the Github webhook is send for.
#[derive(Deserialize, Debug)]
#[serde(rename_all = "lowercase")]
pub enum Action {
    /// The something was created.
    Created,
    /// The something has been edited.
    Edited,
    /// The something has been deleted.
    Deleted,
}