Octocat
Octocat aims to be the GitHub API library for Rust. It was created due to a lack of well-maintained alternatives.
Design Overview
-
There are two modes of operation for Octocat.
-
The first (and most common) one is as a webhook event listener:
Visualization
┌────────────────┐ ┌────────┐
┌──────────────┐ ┌─────┐ ┌─────────────┐◄─┤Result (Message)├──┤ │
│Event Listener├──┤Event├──►│Event Handler│ └────────────────┘ │Executor│
└──────────────┘ └─────┘ └───┬─────────┴─┐ ┌►│ │
│ ▲ └──────────────────┘ └────────┘
│ │
│ ┌───┴───┐
│ │Command│
│ └───┬───┘
▼ │
┌───────┴┐
│ User │
└────────┘
- The second is as a glorified HTTP client wrapper.