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 266 267 268 269 270 271
//! # deeprl
//!
//! Access the DeepL translation engine through a quick and reliable interface. We aim to provide the full suite of tools DeepL offers.
//! See the [official docs](https://www.deepl.com/en/docs-api) for detailed resources.
//!
//! ## Note
//! This crate uses a blocking http client, and as such is only suitable for use in synchronous (blocking) applications.
//! If you intend to use the library functions in an async app, there is a [crate](https://docs.rs/deepl/latest/deepl/) for that.
//!
//! ## Examples
//! Create a new client with a valid API token to access the associated methods. For instance, you may wish to translate a simple text string to some target language.
//! ```
//! use deeprl::{DeepL, Language, TextOptions};
//!
//! let key = std::env::var("DEEPL_API_KEY").unwrap();
//! let dl = DeepL::new(&key);
//!
//! // Translate 'good morning' to German
//! let opt = TextOptions::new(Language::DE);
//!
//! let text = vec![
//! "good morning".to_string(),
//! ];
//!
//! let result = dl.translate(opt, text).unwrap();
//! assert!(!result.translations.is_empty());
//!
//! let translation = &result.translations[0];
//! assert_eq!(translation.text, "Guten Morgen");
//! ```
//!
//! As a helpful sanity check, make sure you're able to return account usage statistics.
//! ```
//! use deeprl::DeepL;
//!
//! let dl = DeepL::new(
//! &std::env::var("DEEPL_API_KEY").unwrap()
//! );
//!
//! let usage = dl.usage().unwrap();
//! assert!(usage.character_limit > 0);
//!
//! let count = usage.character_count;
//! let limit = usage.character_limit;
//! println!("Used: {count}/{limit}");
//! // Used: 42/500000
//! ```
//!
//! [`DeepL`] also allows translating documents and creating custom glossaries.
//!
//! # License
//! This project is licenced under MIT license.
#![warn(missing_docs)]
use serde::Deserialize;
use std::io;
use reqwest::header;
use reqwest::StatusCode;
use thiserror::Error;
mod doc;
mod glos;
mod lang;
mod text;
pub use {
doc::{DocState, Document, DocumentOptions, DocumentStatus},
glos::{
GlossariesResult, Glossary, GlossaryEntriesFormat, GlossaryLanguagePair,
GlossaryLanguagePairsResult,
},
lang::{Language, LanguageInfo, LanguageType},
text::{Formality, SplitSentences, TagHandling, TextOptions, TranslateTextResult, Translation},
};
// Sets the user agent request header value, e.g. 'deeprl/0.1.0'
static APP_USER_AGENT: &str = concat!(env!("CARGO_PKG_NAME"), "/", env!("CARGO_PKG_VERSION"),);
/// The `DeepL` client struct
pub struct DeepL {
client: reqwest::blocking::Client,
url: reqwest::Url,
user_agent: Option<String>,
auth: String,
}
/// Crate Result type
type Result<T, E = Error> = std::result::Result<T, E>;
/// Crate error variants
#[derive(Debug, Error)]
pub enum Error {
/// General client side error
#[error("{0}")]
Client(String),
/// Error sent from the server
#[error("{0}: {1}")]
Server(StatusCode, String),
/// Error deserializing response
#[error("error deserializing response")]
Deserialize,
/// Invalid request
#[error("invalid request {0}")]
Reqwest(reqwest::Error),
/// Io
#[error("{0}")]
Io(io::Error),
/// Invalid language
#[error("invalid language")]
InvalidLanguage,
/// Invalid response
#[error("invalid response")]
InvalidResponse,
}
/// Server error type
#[derive(Debug, Deserialize)]
struct ServerError {
message: String,
}
/// API usage & account limits. Currently assumes an individual developer account.
#[derive(Debug, Deserialize)]
pub struct Usage {
/// Characters translated so far in the current billing period
pub character_count: u64,
/// Current maximum number of characters that can be translated per billing period
pub character_limit: u64,
}
/// Self-implementing type builder
#[macro_export]
macro_rules! builder {
(
$name:ident {
@must{
$($must_field:ident: $must_type:ty,)+
};
@optional{
$($opt_field:ident: $opt_type:ty,)+
};
}
) => {
use paste::paste;
paste! {
#[doc = "Options for `" [<$name>] "` translation"]
pub struct [<$name Options>] {
$($must_field: $must_type,)+
$($opt_field: Option<$opt_type>,)+
}
impl [<$name Options>] {
#[must_use]
#[doc = "Construct a new `" [<$name Options>] "`"]
pub fn new($($must_field: $must_type,)+) -> Self {
Self {
$($must_field,)+
$($opt_field: None,)+
}
}
$(
#[doc = "Setter for `" $opt_field "`"]
pub fn $opt_field(mut self, $opt_field: $opt_type) -> Self {
self.$opt_field = Some($opt_field);
self
}
)+
}
}
};
}
impl DeepL {
/// Create a new instance of `DeepL` from an API key.
pub fn new(key: &str) -> Self {
let base = if key.ends_with(":fx") {
"https://api-free.deepl.com/v2"
} else {
"https://api.deepl.com/v2"
};
DeepL {
client: reqwest::blocking::Client::new(),
url: reqwest::Url::parse(base).unwrap(),
user_agent: None,
auth: format!("DeepL-Auth-Key {}", &key),
}
}
/// Sets a user-defined HTTP client
pub fn client(&mut self, client: reqwest::blocking::Client) -> &mut Self {
self.client = client;
self
}
/// Sets app name and version to be used in the User-Agent header, e.g. "my-app/1.2.3"
pub fn set_app_info(&mut self, app: String) -> &mut Self {
self.user_agent = Some(app);
self
}
/// Calls the underlying client POST method
fn post<U>(&self, url: U) -> reqwest::blocking::RequestBuilder
where
U: reqwest::IntoUrl,
{
self.client.post(url).headers(self.default_headers())
}
/// Calls the underlying client GET method
fn get<U>(&self, url: U) -> reqwest::blocking::RequestBuilder
where
U: reqwest::IntoUrl,
{
self.client.get(url).headers(self.default_headers())
}
/// Calls the underlying client DELETE method
fn delete<U>(&self, url: U) -> reqwest::blocking::RequestBuilder
where
U: reqwest::IntoUrl,
{
self.client.delete(url).headers(self.default_headers())
}
/// Construct default headers used in the request (User-Agent, Authorization)
fn default_headers(&self) -> header::HeaderMap {
// user agent
let app = if let Some(s) = &self.user_agent {
s.clone()
} else {
APP_USER_AGENT.to_string()
};
let mut map = reqwest::header::HeaderMap::new();
map.insert(
header::USER_AGENT,
header::HeaderValue::from_str(&app).unwrap(),
);
// auth
map.insert(
header::AUTHORIZATION,
header::HeaderValue::from_str(&self.auth).unwrap(),
);
map
}
/// GET /usage
///
/// Get account usage
pub fn usage(&self) -> Result<Usage> {
let url = format!("{}/usage", self.url);
let resp = self.get(url).send().map_err(Error::Reqwest)?;
let usage: Usage = resp.json().map_err(|_| Error::Deserialize)?;
Ok(usage)
}
}
/// Attempt to parse an error in case of unsuccessful request
fn convert<T>(resp: reqwest::blocking::Response) -> Result<T> {
let code = resp.status();
let resp: ServerError = resp.json().map_err(|_| Error::InvalidResponse)?;
Err(Error::Server(code, resp.message))
}
#[cfg(test)]
mod test;