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 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265
//! This crate is a simple Gitea API client. It's goal is to give you the ability to write
//! exactly as much code as you need to interact with the specific parts of the Gitea API you need,
//! but no more.
//!
//! # Usage
//! The main way to interact with the Gitea API is through the `Client` struct. You can create a
//! new [Client] by calling [Client::new] with the base URL of your Gitea instance and a personal
//! token. The crate does currently not support basic HTML or OAuth2 authentication.
//!
//! Once you have obtained a [Client], you can interact with the Gitea API by calling the various
//! methods the instance provides. For example, to create a new repository for the currently
//! authenticated user, you can call:
//! ```
//! # use gitea_sdk::{Client, Auth};
//! # async fn create_repo() {
//! let client = Client::new("https://gitea.example.com", Auth::Token("your-token"));
//! let repo = client
//! .user()
//! .create_repo("my-new-repo")
//! // Optional fields
//! .description("This is my new repo".to_string())
//! .private(true)
//! // Send the request
//! .send(&client)
//! .await
//! .unwrap();
//! # }
//! ```
//!
//! Similarly, to get a list of commits for a repository, you can call:
//! ```
//! # use gitea_sdk::{Client, Auth};
//! # async fn get_commits() {
//! let client = Client::new("https://gitea.example.com", Auth::Token("your-token"));
//! let commits = client
//! .repos("owner", "repo-name")
//! .get_commits()
//! // Optional fields
//! .page(2)
//! .send(&client)
//! .await
//! .unwrap();
//! # }
//! ```
//!
//! If you want to create a new access token for a user, you can call:
//! ```
//! # use gitea_sdk::{Client, CreateAccessTokenOption, Auth};
//! # async fn create_access_token() {
//! let basic = Auth::Basic("username", "password");
//! let client = Client::new("https://gitea.example.com", basic);
//! let token = client
//! .user()
//! .create_access_token("username", "my-new-token", vec!["write:repo"])
//! .send(&client)
//! .await
//! .unwrap();
//! println!("Token {} created: {}", token.name, token.sha1);
//! // You can now create a new client with the token and use it to interact with the API.
//! let new_client = Client::new("https://gitea.example.com", Auth::Token(token.sha1));
//! # }
//!
//!
use base64::engine::{GeneralPurpose, GeneralPurposeConfig};
use base64::{alphabet, Engine};
use error::{Result, TeatimeError};
use std::fmt::Display;
use reqwest::header::{self, HeaderMap, HeaderValue};
use reqwest::{Method, Response};
use serde::{de::DeserializeOwned, Deserialize, Serialize};
pub mod error;
pub mod api;
pub mod model;
#[derive(Default, Debug, Clone, Serialize, Deserialize)]
pub struct CreateAccessTokenOption {
/// Access token name.
pub name: String,
/// Optional scopes for the access token.
pub scopes: Option<Vec<String>>,
}
/// Represents the authentication method to use with the Gitea API.
pub enum Auth<D: ToString> {
Token(D),
Basic(D, D),
None,
}
/// Represents a Gitea client.
///
/// This struct is the main way to interact with the Gitea API.
/// It provides methods for creating repositories, getting repositories, deleting repositories,
/// and listing a repo's commits.
pub struct Client {
cli: reqwest::Client,
base_url: String,
}
impl Client {
/// Creates a new Gitea client with the given base URL and personal token.
/// NOTE: The base URL MUST not include the `/api/v1` path and should not contain any trailing
/// slashes. For example, `https://gitea.example.com` is a valid base URL, but
/// `https://gitea.example.com/` or `https://gitea.example.com/api/v1` are not.
pub fn new(base_url: impl ToString, auth: Auth<impl ToString>) -> Self {
let mut headers = HeaderMap::new();
match auth {
Auth::Token(token) => {
let token = HeaderValue::from_str(&format!("token {}", token.to_string()))
.expect("token error");
headers.insert(header::AUTHORIZATION, token);
}
Auth::Basic(user, pass) => {
let engine = GeneralPurpose::new(&alphabet::STANDARD, GeneralPurposeConfig::new());
let base = engine.encode(format!("{}:{}", user.to_string(), pass.to_string()));
let basic =
HeaderValue::from_str(&format!("Basic {base}")).expect("basic auth error");
headers.insert(header::AUTHORIZATION, basic);
}
Auth::None => {}
};
headers.insert(header::ACCEPT, HeaderValue::from_static("application/json"));
let cli = reqwest::ClientBuilder::new()
.default_headers(headers)
.user_agent(format!(
"{}/{}",
env!("CARGO_PKG_NAME"),
env!("CARGO_PKG_VERSION")
))
.build()
.expect("client build error");
Self {
cli,
base_url: base_url.to_string(),
}
}
pub fn repos(&self, owner: impl ToString, repo: impl ToString) -> api::repos::Repos {
api::repos::Repos {
owner: owner.to_string(),
repo: repo.to_string(),
}
}
/// Migrates a repository from another service to Gitea.
///
/// This will create a new repository in Gitea with the same name as the repository in the
/// source service and copy all the data from the source repository to the new repository.
/// The source repository will not be modified.
///
/// Gitea supports pull-mirrors, which will keep the new repository in sync with the source
/// repository. This is useful if you want to keep the new repository up-to-date with the
/// source repository.
///
/// # Example
///
/// ```
/// # use gitea_sdk::{Client, Auth};
/// # async fn migrate_repo() {
/// let client = Client::new("https://gitea.example.com", Auth::Token("your-token"));
/// let repo = client
/// .migrate_repo("https://example.git.com/owner/repo", "repo")
/// .mirror(true)
/// .mirror_interval("1h".to_string())
/// .send(&client)
/// .await
/// .unwrap();
/// # }
/// ```
/// This will create a new repository in Gitea with the name `repo` and copy all the data from
/// the repository at `https://example.git.com/owner/repo` to the new repository. The new
/// repository will be kept in sync with the source repository every hour.
pub fn migrate_repo(
&self,
clone_addr: impl ToString,
repo_name: impl ToString,
) -> api::migrate::MigrateRepoBuilder {
api::migrate::MigrateRepoBuilder::new(clone_addr, repo_name)
}
pub fn issues(&self, owner: impl ToString, repo: impl ToString) -> api::issues::Issues {
api::issues::Issues {
owner: owner.to_string(),
repo: repo.to_string(),
}
}
pub fn search(&self) -> api::search::Search {
api::search::Search
}
pub fn user(&self) -> api::user::User {
api::user::User
}
/// Creates a new DELETE-request builder with the given path.
/// You may use this method to talk to the Gitea API directly if you need to.
/// `path` will be prefixed with `{base_url}/api/v1/` before the request is sent.
pub fn delete(&self, path: impl Display) -> reqwest::RequestBuilder {
self.request_base(Method::DELETE, path)
}
/// Creates a new PATCH-request builder with the given path.
/// You may use this method to talk to the Gitea API directly if you need to.
/// `path` will be prefixed with `{base_url}/api/v1/` before the request is sent.
pub fn patch(&self, path: impl Display) -> reqwest::RequestBuilder {
self.request_base(Method::PATCH, path)
}
/// Creates a new POST-request builder with the given path.
/// You may use this method to talk to the Gitea API directly if you need to.
/// `path` will be prefixed with `{base_url}/api/v1/` before the request is sent.
pub fn post(&self, path: impl Display) -> reqwest::RequestBuilder {
self.request_base(Method::POST, path)
}
/// Creates a new POST-request builder with the given path.
/// You may use this method to talk to the Gitea API directly if you need to.
/// `path` will be prefixed with `{base_url}/api/v1/` before the request is sent.
pub fn get(&self, path: impl Display) -> reqwest::RequestBuilder {
self.request_base(Method::GET, path)
}
/// Creates a new request builder with the given method and path.
/// You may use this method to talk to the Gitea API directly if you need to.
/// `path` will be prefixed with `{base_url}/api/v1/` before the request is sent.
pub fn request_base(&self, method: Method, path: impl Display) -> reqwest::RequestBuilder {
self.cli
.request(method, format!("{}/api/v1/{}", self.base_url, path))
}
/// Sends a request and checks the response for errors.
/// You may use this method to talk to the Gitea API directly if you need to.
/// This method will return a [TeatimeError] if the request fails.
/// /// NOTE: This method is not recommended for general use. Use the more specific methods
/// provided by the [Client] struct if they exist.
/// You are responsible for providing the correct Model for the response.
pub async fn make_request(&self, req: reqwest::Request) -> Result<Response> {
let res = self.cli.execute(req).await?;
let status = res.status();
if status.is_client_error() || status.is_server_error() {
return Err(TeatimeError {
message: res.text().await.unwrap_or_default(),
kind: error::TeatimeErrorKind::HttpError,
status_code: status,
});
}
Ok(res)
}
/// Parses a json response into a given model.
/// You may use this method to talk to the Gitea API directly if you need to.
/// This method will return a [TeatimeError] if the response cannot be deserialized.
/// /// NOTE: This method is not recommended for general use. Use the more specific methods
/// provided by the [Client] struct if they exist.
/// You are responsible for providing the correct Model for the response.
pub async fn parse_response<T: DeserializeOwned>(&self, res: reqwest::Response) -> Result<T> {
let status_code = res.status();
let text = res.text().await?;
serde_json::from_str(&text).map_err(|e| TeatimeError {
message: format!("Error parsing response: {}", e),
kind: error::TeatimeErrorKind::SerializationError,
status_code,
})
}
}