deepl-rb 3.1.0 → 3.3.0

data/spec/fixtures/vcr_cassettes/rephrase_texts.yml

@@ -0,0 +1,401 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["As Gregor Samsa awoke one morning from uneasy dreams he found
+        himself transformed."],"target_lang":"EN"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.3.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 10 Jan 2025 07:00:45 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Trace-Id:
+      - '09daf98547c94050b68e39cf38b0fe7d'
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=95, l7_lb_idle;dur=3, l7_lb_receive;dur=0, l7_lb_total;dur=378
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+    body:
+      encoding: ASCII-8BIT
+      string: '{"improvements":[{"text":"When Gregor Samsa awoke one morning from
+        troubled dreams, he found himself transformed.","detected_source_language":"en","target_language":"en-US"}]}'
+  recorded_at: Fri, 10 Jan 2025 07:00:45 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["As Gregor Samsa awoke one morning from uneasy dreams he found
+        himself transformed.","He lay on his armour-like back, and if he lifted his
+        head a little"],"target_lang":"EN"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.3.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 10 Jan 2025 07:00:45 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Trace-Id:
+      - df25db169c5f4c198ff7b5a319a16669
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=95, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=423
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+    body:
+      encoding: ASCII-8BIT
+      string: '{"improvements":[{"text":"When Gregor Samsa awoke one morning from
+        troubled dreams, he found himself transformed.","detected_source_language":"en","target_language":"en-US"},{"text":"He
+        lay on his armor-like back, and when he lifted his head a little","detected_source_language":"en","target_language":"en-US"}]}'
+  recorded_at: Fri, 10 Jan 2025 07:00:45 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["As Gregor Samsa awoke one morning from uneasy dreams he found
+        himself transformed."],"target_lang":"EN","tone":"friendly"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.3.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 10 Jan 2025 07:00:46 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Trace-Id:
+      - 14fdbaa36544495a993136451b65e52b
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=94, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=460
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+    body:
+      encoding: ASCII-8BIT
+      string: '{"improvements":[{"text":"One morning, Gregor Samsa woke up from restless
+        dreams to find himself in a strange new form.","detected_source_language":"en","target_language":"en-US"}]}'
+  recorded_at: Fri, 10 Jan 2025 07:00:46 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["As Gregor Samsa awoke one morning from uneasy dreams he found
+        himself transformed.","He lay on his armour-like back, and if he lifted his
+        head a little"],"target_lang":"EN","tone":"friendly"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.3.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 10 Jan 2025 07:00:46 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Trace-Id:
+      - a31d9cca4073414c9be843fffed914c3
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=93, l7_lb_idle;dur=1, l7_lb_receive;dur=0, l7_lb_total;dur=413
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+    body:
+      encoding: ASCII-8BIT
+      string: '{"improvements":[{"text":"One morning, Gregor Samsa woke up from restless
+        dreams to find himself in a strange new form.","detected_source_language":"en","target_language":"en-US"},{"text":"He
+        was lying on his armor-like back, and if he lifted his head just a little
+        bit...","detected_source_language":"en","target_language":"en-US"}]}'
+  recorded_at: Fri, 10 Jan 2025 07:00:47 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["As Gregor Samsa awoke one morning from uneasy dreams he found
+        himself transformed."],"target_lang":"EN","writing_style":"business"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.3.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 10 Jan 2025 07:00:47 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Trace-Id:
+      - 58d0bbf1167f40b2a62f87c2a6d7dda3
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=98, l7_lb_idle;dur=1, l7_lb_receive;dur=0, l7_lb_total;dur=385
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+    body:
+      encoding: ASCII-8BIT
+      string: '{"improvements":[{"text":"Gregor Samsa awoke one morning, having had
+        disturbing dreams, to find himself transformed.","detected_source_language":"en","target_language":"en-US"}]}'
+  recorded_at: Fri, 10 Jan 2025 07:00:47 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["As Gregor Samsa awoke one morning from uneasy dreams he found
+        himself transformed.","He lay on his armour-like back, and if he lifted his
+        head a little"],"target_lang":"EN","writing_style":"business"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.3.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 10 Jan 2025 07:00:48 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Trace-Id:
+      - 37a69ff78833465cbc9ddadd4f9aca36
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=96, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=374
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+    body:
+      encoding: ASCII-8BIT
+      string: '{"improvements":[{"text":"Gregor Samsa awoke one morning, having had
+        disturbing dreams, to find himself transformed.","detected_source_language":"en","target_language":"en-US"},{"text":"He
+        was positioned on his back, which was similar to armor. If he lifted his head
+        slightly,","detected_source_language":"en","target_language":"en-US"}]}'
+  recorded_at: Fri, 10 Jan 2025 07:00:48 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["As Gregor Samsa awoke one morning from uneasy dreams he found
+        himself transformed."],"target_lang":"EN","writing_style":"angry"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.3.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Date:
+      - Fri, 10 Jan 2025 07:00:48 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      X-Trace-Id:
+      - b406cc026c004d4c80d76131df636d8a
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=98, l7_lb_idle;dur=1, l7_lb_receive;dur=0, l7_lb_total;dur=109
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+    body:
+      encoding: UTF-8
+      string: '{"message":"Bad request. Reason: Unsupported value for field writing_style."}'
+  recorded_at: Fri, 10 Jan 2025 07:00:48 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["As Gregor Samsa awoke one morning from uneasy dreams he found
+        himself transformed."],"target_lang":"EN","writing_style":"business","tone":"friendly"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.3.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Date:
+      - Fri, 10 Jan 2025 07:00:48 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      X-Trace-Id:
+      - 1b7680d714c24de49ded702b382c69b0
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=98, l7_lb_idle;dur=1, l7_lb_receive;dur=0, l7_lb_total;dur=105
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+    body:
+      encoding: UTF-8
+      string: '{"message":"Bad request. Reason: Both writing_style and tone defined.
+        Currently only style OR tone can be chosen for a single request.."}'
+  recorded_at: Fri, 10 Jan 2025 07:00:48 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["As Gregor Samsa awoke one morning from uneasy dreams he found
+        himself transformed."],"target_lang":"EN"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key invalid
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.3.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 403
+      message: Forbidden
+    headers:
+      Date:
+      - Fri, 10 Jan 2025 07:00:48 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      X-Trace-Id:
+      - 568ef89e665f499ebcbc62b90ba09019
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=121, l7_lb_idle;dur=1, l7_lb_receive;dur=0, l7_lb_total;dur=132
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+    body:
+      encoding: ASCII-8BIT
+      string: '{"message":"Invalid API key."}'
+  recorded_at: Fri, 10 Jan 2025 07:00:48 GMT
+recorded_with: VCR 6.3.1

data/spec/fixtures/vcr_cassettes/translate_texts.yml

@@ -10369,4 +10369,47 @@ http_interactions:
       encoding: ASCII-8BIT
       string: '{"translations":[{"detected_source_language":"EN","text":"Beispieltext","model_type_used":"latency_optimized"}]}'
   recorded_at: Fri, 15 Nov 2024 11:35:22 GMT
-recorded_with: VCR 6.2.0
+- request:
+    method: post
+    uri: https://api-free.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["Sample text"],"source_lang":"EN","target_lang":"FR","debug":"1"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin24) ruby/3.3.3
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json
+      Date:
+      - Tue, 28 Oct 2025 12:50:22 GMT
+      X-Trace-Id:
+      - b146de80d79542e8bd5d8f50c1410e3a
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=71, l7_lb_idle;dur=2, l7_lb_receive;dur=0, l7_lb_total;dur=101
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJ0cmFuc2xhdGlvbnMiOlt7ImRldGVjdGVkX3NvdXJjZV9sYW5ndWFnZSI6IkVOIiwidGV4dCI6IlRleHRlIG1vZMOobGUifV19
+  recorded_at: Tue, 28 Oct 2025 12:50:23 GMT
+recorded_with: VCR 6.3.1

data/spec/integration_tests/document_api_spec.rb

@@ -152,4 +152,26 @@ describe DeepL::DocumentApi do
     )
     expect(doc_status.status).to eq('done')
   end
+
+  it 'Translates a document with extra_body_parameters' do # rubocop:disable RSpec/ExampleLength
+    File.unlink(output_document_path)
+    source_lang = default_lang_args[:source_lang]
+    target_lang = default_lang_args[:target_lang]
+    example_doc_path = example_document_path(source_lang)
+
+    handle = DeepL.document.upload(example_doc_path, source_lang, target_lang,
+                                   File.basename(example_doc_path),
+                                   {
+                                     extra_body_parameters: {
+                                       target_lang: 'FR',
+                                       debug: '1'
+                                     }
+                                   })
+    doc_status = handle.wait_until_document_translation_finished
+    DeepL.document.download(handle, output_document_path) if doc_status.status != 'error'
+    output_file_contents = File.read(output_document_path)
+
+    expect(example_document_translation('FR')).to eq(output_file_contents)
+    expect(doc_status.status).to eq('done')
+  end
 end

data/spec/requests/rephrase_spec.rb

@@ -0,0 +1,172 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::Requests::Rephrase do
+  subject(:rephrase) { described_class.new(api, text, target_lang, writing_style, tone, options) }
+
+  around do |tests|
+    tmp_env = replace_env_preserving_deepl_vars_except_mock_server
+    tests.call
+    ENV.replace(tmp_env)
+  end
+
+  let(:api) { build_deepl_api }
+  let(:text) do
+    'As Gregor Samsa awoke one morning from uneasy dreams he found himself transformed.'
+  end
+  let(:target_lang) { 'EN' }
+  let(:writing_style) { nil }
+  let(:tone) { nil }
+  let(:options) { {} }
+
+  describe '#request' do
+    around do |example|
+      VCR.use_cassette('rephrase_texts') { example.call }
+    end
+
+    context 'without a style or tone applied' do
+      context 'with a string as input' do
+        it 'returns a valid response as a DeepL Text resource' do
+          original_length = text.length
+          response_text = rephrase.request
+
+          expect(response_text).to be_a(DeepL::Resources::Text)
+          expect(response_text.text.length).not_to eq(original_length)
+          expect(response_text.detected_source_language.upcase).to eq('EN')
+        end
+      end
+
+      context 'with an array of texts as input' do
+        let(:text) do
+          [
+            'As Gregor Samsa awoke one morning from uneasy dreams he found himself transformed.',
+            'He lay on his armour-like back, and if he lifted his head a little'
+          ]
+        end
+
+        it 'returns a valid response as an array of DeepL Text resources' do
+          response_texts = rephrase.request
+
+          expect(response_texts).to all(be_a(DeepL::Resources::Text))
+          response_texts.each_with_index do |response_text, index|
+            expect(response_text.text.length).not_to eq(text[index].length)
+            expect(response_text.detected_source_language.upcase).to eq('EN')
+          end
+        end
+      end
+    end
+
+    context 'with a valid tone applied' do
+      let(:tone) { 'friendly' }
+
+      context 'with a string as input' do
+        it 'returns a valid response with a string as text input' do
+          original_length = text.length
+          response_text = rephrase.request
+
+          expect(response_text).to be_a(DeepL::Resources::Text)
+          expect(response_text.text.length).not_to eq(original_length)
+          expect(response_text.detected_source_language.upcase).to eq('EN')
+        end
+      end
+
+      context 'with an array of texts as input' do
+        let(:text) do
+          [
+            'As Gregor Samsa awoke one morning from uneasy dreams he found himself transformed.',
+            'He lay on his armour-like back, and if he lifted his head a little'
+          ]
+        end
+
+        it 'returns an array of valid text objects' do
+          response_texts = rephrase.request
+
+          expect(response_texts).to all(be_a(DeepL::Resources::Text))
+          response_texts.each_with_index do |response_text, index|
+            expect(response_text.text.length).not_to eq(text[index].length)
+            expect(response_text.detected_source_language.upcase).to eq('EN')
+          end
+        end
+      end
+    end
+
+    context 'with a valid writing style applied' do
+      let(:writing_style) { 'business' }
+
+      context 'with a string as input' do
+        it 'returns a valid response with a string as text input' do
+          original_length = text.length
+          response_text = rephrase.request
+
+          expect(response_text).to be_a(DeepL::Resources::Text)
+          expect(response_text.text.length).not_to eq(original_length)
+          expect(response_text.detected_source_language.upcase).to eq('EN')
+        end
+      end
+
+      context 'with an array of texts as input' do
+        let(:text) do
+          [
+            'As Gregor Samsa awoke one morning from uneasy dreams he found himself transformed.',
+            'He lay on his armour-like back, and if he lifted his head a little'
+          ]
+        end
+
+        it 'returns an array of valid text objects' do
+          response_texts = rephrase.request
+
+          expect(response_texts).to all(be_a(DeepL::Resources::Text))
+          response_texts.each_with_index do |response_text, index|
+            expect(response_text.text.length).not_to eq(text[index].length)
+            expect(response_text.detected_source_language.upcase).to eq('EN')
+          end
+        end
+      end
+    end
+
+    context 'with a writing style or tone from the provided constants applied' do
+      let(:writing_style) { DeepL::Constants::WritingStyle::BUSINESS }
+      let(:tone) { DeepL::Constants::Tone::FRIENDLY }
+
+      it 'has the correct writing style and tone applied' do
+        expect(rephrase.writing_style).to eq('business')
+        expect(rephrase.tone).to eq('friendly')
+      end
+    end
+
+    context 'with an invalid writing style applied' do
+      let(:writing_style) { 'angry' }
+
+      it 'raises a bad request error' do
+        expect { rephrase.request }.to raise_error(DeepL::Exceptions::BadRequest)
+      end
+    end
+
+    context 'when both writing style and tone are applied' do
+      let(:writing_style) { 'business' }
+      let(:tone) { 'friendly' }
+
+      it 'raises a bad request error' do
+        expect { rephrase.request }.to raise_error(DeepL::Exceptions::BadRequest)
+      end
+    end
+
+    context 'when performing a bad request' do
+      context 'when using an invalid token' do
+        let(:api) do
+          api = build_deepl_api
+          api.configuration.auth_key = 'invalid'
+          api
+        end
+
+        it 'raises an unauthorized error' do
+          expect { rephrase.request }.to raise_error(DeepL::Exceptions::AuthorizationFailed)
+        end
+      end
+    end
+  end
+end