deeprl 0.3.0

DeepL client library with all the things (blocking)
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
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
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324

use super::*;
use std::{env, io::Write, path::PathBuf, str::FromStr, thread, time::Duration};

const KEY: &'static str = env!("DEEPL_API_KEY");

#[test]
fn configure() {
    // test set user client + app agent
    let app = "my-app/1.2.3";
    let client = reqwest::blocking::Client::builder()
        .timeout(Duration::from_secs(21))
        .build()
        .unwrap();

    let mut dl = DeepL::new(KEY);
    dl.client(client);
    dl.set_app_info(app.to_owned());

    let url = format!("{}/usage", dl.url);
    let req = dl.get(url).build().unwrap();
    let headers = req.headers();

    assert_eq!(
        headers.get("User-Agent").unwrap(),
        header::HeaderValue::from_static(app)
    );
    let auth = format!("DeepL-Auth-Key {}", KEY);
    assert_eq!(
        headers.get("Authorization").unwrap(),
        header::HeaderValue::from_str(&auth).unwrap()
    );
}

#[test]
fn usage() {
    let dl = DeepL::new(KEY);

    let resp = dl.usage();
    assert!(resp.is_ok());

    let usage = resp.unwrap();
    assert!(usage.character_limit > 0);
}

#[test]
fn languages() {
    let dl = DeepL::new(KEY);

    // fetch source langs
    let langs = dl.languages(LanguageType::Source).unwrap();

    // fetch target langs, filtering duplicates
    let target_langs = dl.languages(LanguageType::Target).unwrap();
    let target_langs: Vec<LanguageInfo> = target_langs
        .into_iter()
        .filter(|l| {
            let code = &l.language;
            for src_lang in &langs {
                if code == &src_lang.language {
                    return false;
                }
            }
            true
        })
        .collect();

    // test we have modeled all available langs
    // should run with --show-output
    let _: Vec<Language> = langs
        .iter()
        .chain(target_langs.iter())
        .map(|info| {
            let code = &info.language;
            let name = &info.name;
            Language::from_str(code)
                .map_err(|_| println!("Failed to convert lang: {code} {name}"))
                .unwrap()
        })
        .collect();
}

#[test]
fn translate_text() {
    let dl = DeepL::new(KEY);

    let src = Language::EN;

    let text = vec!["good morning".to_string()];
    let opt = TextOptions::new(Language::DE).source_lang(src);

    let resp = dl.translate(opt, text);
    assert!(resp.is_ok());
    let result = resp.unwrap();
    let translation = &result.translations[0];
    assert!(!translation.text.is_empty());
}

#[test]
fn translate_options() {
    let dl = DeepL::new(KEY);

    let opt = TextOptions::new(Language::FR)
        .source_lang(Language::EN)
        .split_sentences(SplitSentences::None)
        .preserve_formatting(true)
        .formality(Formality::PreferLess);

    // newline in the text string
    // lowercase, no punctuation
    // less formal
    let text = vec!["you\nare nice".to_string()];
    let expect = "tu es gentille";

    let resp = dl.translate(opt, text).unwrap();
    let translation = &resp.translations[0];

    assert_eq!(translation.text, expect);
}

#[test]
fn translate_tags() {
    let dl = DeepL::new(KEY);

    let xml = r"
<xml>
    <head>
        <title>My English title</title>
    </head>
    <body>
        <p>Do you speak French?</p>
        <p>The red crab</p>
    </body>
</xml>"
        .to_string();

    let text = vec![xml];
    let split = "p".to_string();
    let ignore = "title".to_string();

    let opt = TextOptions::new(Language::FR)
        .source_lang(Language::EN)
        .tag_handling(TagHandling::Xml)
        .outline_detection(false)
        .splitting_tags(split)
        .ignore_tags(ignore);

    let resp = dl.translate(opt, text).unwrap();
    let text = &resp.translations[0].text;
    assert!(text.contains("<title>My English title</title>"));
    assert!(text.contains("<p>Parlez-vous français ?</p>"));
    assert!(text.contains("<p>Le crabe rouge</p>"));
}

#[test]
fn document() {
    let dl = DeepL::new(KEY);

    // create file
    let text = "good morning".to_string();
    let path = PathBuf::from("gm.txt");
    std::fs::write(&path, text).unwrap();

    // test upload
    let lang = Language::DE;
    let opt = DocumentOptions::new(lang, path);
    let doc_resp = dl.document_upload(opt);
    assert!(doc_resp.is_ok());
    let doc = doc_resp.unwrap();
    assert!(!doc.document_id.is_empty());

    // test status
    let mut delay = Duration::from_millis(64);
    while !dl.document_status(&doc).unwrap().is_done() {
        // try again after 3 sec
        thread::sleep(delay);
        delay *= 2;
    }

    // test download
    let out_file = PathBuf::from("de.txt");
    let result = dl.document_download(doc, Some(out_file.clone()));
    assert!(result.is_ok());

    let content = std::fs::read_to_string(out_file).unwrap();
    assert_eq!(content, "Guten Morgen");
}

#[test]
fn glossary_pairs() {
    // get supported glossary language pairs
    let dl = DeepL::new(KEY);

    let result = dl.glossary_languages().unwrap();
    let pairs = result.supported_languages;
    assert!(!pairs.is_empty());
    let first = &pairs[0];
    assert!(!first.source_lang.is_empty());
}

#[test]
fn glossaries() {
    // list available glossaries
    let dl = DeepL::new(KEY);

    let result = dl.glossaries().unwrap();
    let glossaries = result.glossaries;
    if !glossaries.is_empty() {
        let glos = &glossaries[0];
        assert!(glos.entry_count > 0);
    }
}

#[test]
fn glossary_all() {
    let dl = DeepL::new(KEY);

    // create csv file with two glossary entries
    let entry = "hello,ciao\n".to_string();
    std::fs::write("glos.csv", entry).unwrap();

    let entry = "goodbye,ciao\n".to_string();
    let _wrote = std::fs::OpenOptions::new()
        .append(true)
        .open("glos.csv")
        .unwrap()
        .write(entry.as_bytes())
        .unwrap();

    // test create glossary
    let name = "my_glossary".to_string();
    let src = Language::EN;
    let trg = Language::IT;
    let entries = std::fs::read_to_string("glos.csv").unwrap();
    let fmt = GlossaryEntriesFormat::Csv;

    let glossary = dl.glossary_new(name, src, trg, entries, fmt).unwrap();
    assert_eq!(glossary.entry_count, 2);
    // TODO: `assert!(glossary.ready);` before attempting to use it

    // test fetch entries
    let glos_id = glossary.glossary_id;
    let resp = dl.glossary_entries(&glos_id);
    assert!(resp.is_ok());
    let entries = resp.unwrap();
    assert_eq!(entries.len(), 2);

    // test translate with glossary
    let opts = TextOptions::new(Language::IT)
        .source_lang(Language::EN)
        .preserve_formatting(true)
        .glossary_id(glos_id.clone());

    let text = vec!["goodbye".to_string()];
    let result = dl.translate(opts, text).unwrap();
    let translations = result.translations;
    assert_eq!(translations[0].text, "ciao");

    // test delete
    let _: () = dl.glossary_delete(&glos_id).unwrap();
    thread::sleep(Duration::from_secs(1));

    // deleted glossary id is 404
    let resp = dl.glossary_info(&glos_id);
    assert!(matches!(
        resp,
        Err(Error::Server(code, ..)) if code == StatusCode::NOT_FOUND,
    ));
}

#[test]
fn test_error() {
    let dl = DeepL::new(KEY);

    // translate using an invalid match
    let res = dl.translate(
        TextOptions::new(
            // bad target lang
            Language::PT,
        )
        // bad source lang
        .source_lang(Language::ENGB),
        vec!["good morning".to_string()],
    );
    assert!(res.is_err());
}

// Doc tests
#[test]
fn doc_text_options() {
    let dl = DeepL::new(KEY);

    let text = vec!["you are nice \nthe red crab".to_string()];
    let target_lang = Language::FR;

    let opt = TextOptions::new(target_lang)
        .split_sentences(SplitSentences::None)
        .preserve_formatting(true)
        .formality(Formality::PreferLess);

    let translations = dl.translate(opt, text).unwrap().translations;

    assert_eq!(&translations[0].text, "tu es gentil le crabe rouge");
}

#[test]
fn doc_text_html() {
    let dl = DeepL::new(KEY);

    let html = r#"
<h2 class="notranslate">good morning</h2>
<p>good morning</p>"#
        .to_string();

    let text = vec![html];
    let opt = TextOptions::new(Language::ES)
        .tag_handling(TagHandling::Html)
        .outline_detection(false);
    let trans = dl.translate(opt, text).unwrap().translations;

    let text = &trans[0].text;
    // dbg!(text);
    assert!(text.contains("good morning"));
    assert!(text.contains("buenos días"));
}