omnitrack 0.3.0

Universal issue-tracker provider contracts and clients (Linear, Jira, ...) for Rust, in one crate.
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
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

use super::errors::error;
use super::models::{
    Comment, CommentId, Cycle, CycleId, Issue, IssueDraft, IssueFilter, IssueId, IssuePatch, Label,
    LabelId, Milestone, MilestoneId, Project, ProjectId, StatusCategory, Team, TeamId, User,
    UserId, issue_patch,
};
use super::pagination::{Page, PageRequest};
use super::{BoxFuture, IssueResult};

#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash, Ord, PartialOrd)]
pub enum Capability {
    Issues,
    Projects,
    Milestones,
    Cycles,
    Teams,
    Users,
    Labels,
    Viewer,
    Comments,
}

macro_rules! capability {
    ($trait_name:ident, $entity:ty, $id:ty, $not_configured:ident) => {
        pub trait $trait_name: Send + Sync {
            fn get(&self, id: $id) -> BoxFuture<'_, IssueResult<$entity>>;

            fn list(&self, page: Option<PageRequest>) -> BoxFuture<'_, IssueResult<Page<$entity>>>;
        }

        #[derive(Clone, Copy, Debug, Default)]
        pub struct $not_configured;

        impl $trait_name for $not_configured {
            fn get(&self, _id: $id) -> BoxFuture<'_, IssueResult<$entity>> {
                Box::pin(async { Err(error().transport_not_configured()) })
            }

            fn list(
                &self,
                _page: Option<PageRequest>,
            ) -> BoxFuture<'_, IssueResult<Page<$entity>>> {
                Box::pin(async { Err(error().transport_not_configured()) })
            }
        }
    };
}

pub trait Issues: Send + Sync {
    fn get(&self, id: IssueId) -> BoxFuture<'_, IssueResult<Issue>>;

    fn list(
        &self,
        filter: IssueFilter,
        page: Option<PageRequest>,
    ) -> BoxFuture<'_, IssueResult<Page<Issue>>>;

    fn create(&self, draft: IssueDraft) -> BoxFuture<'_, IssueResult<Issue>>;

    fn update(&self, id: IssueId, patch: IssuePatch) -> BoxFuture<'_, IssueResult<Issue>>;

    fn delete(&self, id: IssueId) -> BoxFuture<'_, IssueResult<()>>;

    fn close(&self, id: IssueId) -> BoxFuture<'_, IssueResult<Issue>> {
        self.update(
            id,
            issue_patch().category(StatusCategory::Completed).build(),
        )
    }
}

#[derive(Clone, Copy, Debug, Default)]
pub struct TransportNotConfiguredIssues;

impl Issues for TransportNotConfiguredIssues {
    fn get(&self, _id: IssueId) -> BoxFuture<'_, IssueResult<Issue>> {
        Box::pin(async { Err(error().transport_not_configured()) })
    }

    fn list(
        &self,
        _filter: IssueFilter,
        _page: Option<PageRequest>,
    ) -> BoxFuture<'_, IssueResult<Page<Issue>>> {
        Box::pin(async { Err(error().transport_not_configured()) })
    }

    fn create(&self, _draft: IssueDraft) -> BoxFuture<'_, IssueResult<Issue>> {
        Box::pin(async { Err(error().transport_not_configured()) })
    }

    fn update(&self, _id: IssueId, _patch: IssuePatch) -> BoxFuture<'_, IssueResult<Issue>> {
        Box::pin(async { Err(error().transport_not_configured()) })
    }

    fn delete(&self, _id: IssueId) -> BoxFuture<'_, IssueResult<()>> {
        Box::pin(async { Err(error().transport_not_configured()) })
    }
}

pub trait Viewer: Send + Sync {
    fn current_user(&self) -> BoxFuture<'_, IssueResult<User>>;
}

#[derive(Clone, Copy, Debug, Default)]
pub struct TransportNotConfiguredViewer;

impl Viewer for TransportNotConfiguredViewer {
    fn current_user(&self) -> BoxFuture<'_, IssueResult<User>> {
        Box::pin(async { Err(error().transport_not_configured()) })
    }
}

pub trait Comments: Send + Sync {
    fn list_comments(
        &self,
        issue: IssueId,
        page: Option<PageRequest>,
    ) -> BoxFuture<'_, IssueResult<Page<Comment>>>;

    fn post_comment(&self, issue: IssueId, body: String) -> BoxFuture<'_, IssueResult<Comment>>;

    fn delete_comment(&self, id: CommentId) -> BoxFuture<'_, IssueResult<()>>;
}

#[derive(Clone, Copy, Debug, Default)]
pub struct TransportNotConfiguredComments;

impl Comments for TransportNotConfiguredComments {
    fn list_comments(
        &self,
        _issue: IssueId,
        _page: Option<PageRequest>,
    ) -> BoxFuture<'_, IssueResult<Page<Comment>>> {
        Box::pin(async { Err(error().transport_not_configured()) })
    }

    fn post_comment(&self, _issue: IssueId, _body: String) -> BoxFuture<'_, IssueResult<Comment>> {
        Box::pin(async { Err(error().transport_not_configured()) })
    }

    fn delete_comment(&self, _id: CommentId) -> BoxFuture<'_, IssueResult<()>> {
        Box::pin(async { Err(error().transport_not_configured()) })
    }
}

capability!(Projects, Project, ProjectId, TransportNotConfiguredProjects);
capability!(
    Milestones,
    Milestone,
    MilestoneId,
    TransportNotConfiguredMilestones
);
capability!(Cycles, Cycle, CycleId, TransportNotConfiguredCycles);
capability!(Teams, Team, TeamId, TransportNotConfiguredTeams);
capability!(Users, User, UserId, TransportNotConfiguredUsers);
capability!(Labels, Label, LabelId, TransportNotConfiguredLabels);