deepl-rb 3.6.1 → 3.8.0

data/spec/integration_tests/translate_api_spec.rb

@@ -0,0 +1,98 @@
+# Copyright 2026 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'DeepL.translate' do # rubocop:disable RSpec/DescribeClass
+  include_context 'with a live mock server'
+
+  let(:text) { 'proton beam' }
+
+  describe 'happy path' do
+    it 'translates a single string into a Text resource' do
+      result = DeepL.translate(text, 'EN', 'DE')
+
+      expect(result).to be_a(DeepL::Resources::Text)
+      expect(result.text).to be_a(String)
+      expect(result.text).not_to be_empty
+    end
+
+    it 'translates an array of strings into an array of Text resources' do
+      results = DeepL.translate(%w[Sample Word], 'EN', 'ES')
+
+      expect(results).to be_an(Array)
+      expect(results.size).to eq(2)
+      expect(results).to all(be_a(DeepL::Resources::Text))
+    end
+  end
+
+  describe 'options' do
+    it 'accepts a formality setting' do
+      result = DeepL.translate('How are you?', 'EN', 'DE', { formality: 'more' })
+
+      expect(result).to be_a(DeepL::Resources::Text)
+    end
+
+    it 'translates with XML tag handling and ignored tags' do
+      result = DeepL.translate('<p>Sample <code>x</code></p>', 'EN', 'ES',
+                               { tag_handling: 'xml', ignore_tags: %w[code] })
+
+      expect(result.text).to be_a(String)
+      expect(result.text).not_to be_empty
+    end
+
+    it 'accepts a context option' do
+      result = DeepL.translate('That is hot!', 'EN', 'ES', { context: 'about the weather' })
+
+      expect(result).to be_a(DeepL::Resources::Text)
+    end
+
+    it 'accepts an empty context option' do
+      result = DeepL.translate('That is hot!', 'EN', 'ES', { context: '' })
+
+      expect(result).to be_a(DeepL::Resources::Text)
+    end
+
+    it 'translates an HTML document with split_sentences, outline_detection and splitting_tags' do
+      document = '<document><meta><title>Title</title></meta>' \
+                 '<content><par>First sentence. Second one.</par></content></document>'
+      result = DeepL.translate(document, 'EN', 'ES',
+                               { tag_handling: 'xml', split_sentences: 'nonewlines',
+                                 outline_detection: false, splitting_tags: %w[title par] })
+
+      expect(result).to be_a(DeepL::Resources::Text)
+      expect(result.text).not_to be_empty
+    end
+
+    it 'translates using a glossary' do
+      with_managed_glossary(name: 'Translate Glossary', source_lang: 'en', target_lang: 'de',
+                            entries: [%w[Hello Hallo]]) do |glossary|
+        result = DeepL.translate('Hello', 'EN', 'DE', { glossary_id: glossary.id })
+
+        expect(result).to be_a(DeepL::Resources::Text)
+        expect(result.text).not_to be_empty
+      end
+    end
+
+    %w[quality_optimized latency_optimized prefer_quality_optimized].each do |model_type|
+      it "returns model_type_used for #{model_type}" do
+        result = DeepL.translate(text, 'EN', 'DE', { model_type: model_type })
+
+        expect(result).to be_a(DeepL::Resources::Text)
+        expect(result.model_type_used).not_to be_nil
+      end
+    end
+
+    %w[v1 v2].each do |version|
+      it "translates with tag_handling_version #{version}" do
+        result = DeepL.translate('<p>Hello world</p>', 'EN', 'DE',
+                                 { tag_handling: 'html', tag_handling_version: version })
+
+        expect(result).to be_a(DeepL::Resources::Text)
+        expect(result.text).not_to be_empty
+      end
+    end
+  end
+end

data/spec/integration_tests/translate_error_paths_spec.rb

@@ -0,0 +1,48 @@
+# Copyright 2026 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'DeepL.translate error paths' do # rubocop:disable RSpec/DescribeClass
+  include_context 'with a live mock server'
+
+  let(:text) { 'proton beam' }
+
+  describe 'authorization failures' do
+    it 'raises AuthorizationFailed when the auth key is invalid' do
+      request = DeepL::Requests::Translate.new(unauthorized_api, text, 'EN', 'DE')
+
+      expect { request.request }.to raise_error(DeepL::Exceptions::AuthorizationFailed)
+    end
+  end
+
+  describe 'bad request errors' do
+    it 'raises BadRequest for an unsupported target language' do
+      expect { DeepL.translate(text, 'EN', 'ZZ') }
+        .to raise_error(DeepL::Exceptions::BadRequest)
+    end
+
+    it 'raises BadRequest when no target language is given' do
+      expect { DeepL.translate(text, 'EN', nil) }
+        .to raise_error(DeepL::Exceptions::BadRequest)
+    end
+
+    # Real-server only: the mock coerces text:[null] to text:[""] and accepts it,
+    # so it cannot reproduce this; prod rejects [null] with 400.
+    it 'raises BadRequest when the text is nil', :real_server_only do
+      expect { DeepL.translate(nil, 'EN', 'DE') }
+        .to raise_error(DeepL::Exceptions::BadRequest)
+    end
+  end
+
+  describe 'request entity too large errors' do
+    it 'raises RequestEntityTooLarge when too many texts are sent in a single request' do
+      texts = Array.new(10_000) { |i| "This is the sentence number #{i}" }
+
+      expect { DeepL.translate(texts, 'EN', 'DE') }
+        .to raise_error(DeepL::Exceptions::RequestEntityTooLarge)
+    end
+  end
+end

data/spec/integration_tests/translation_memory_api_spec.rb

@@ -0,0 +1,54 @@
+# Copyright 2026 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::TranslationMemoryApi, :mock_server_only do
+  describe '#translate_with_translation_memory' do
+    it 'when performing a request with translation_memory_id' do
+      source_lang = 'DE'
+      target_lang = 'EN'
+      text = 'Protonenstrahl'
+      translation_memory_id = 'a74d88fb-ed2a-4943-a664-a4512398b994'
+
+      result = DeepL.translate(text, source_lang, target_lang,
+                               { translation_memory: translation_memory_id })
+      expect(result).to be_a(DeepL::Resources::Text)
+    end
+
+    it 'when performing a request with translation_memory resource object' do
+      source_lang = 'DE'
+      target_lang = 'EN'
+      text = 'Protonenstrahl'
+      translation_memory = build_test_translation_memory
+
+      result = DeepL.translate(text, source_lang, target_lang,
+                               { translation_memory: translation_memory })
+      expect(result).to be_a(DeepL::Resources::Text)
+    end
+  end
+
+  describe '#list_translation_memories' do
+    it 'when requesting a list of all translation memories' do
+      translation_memories = DeepL.translation_memories.list
+      expect(translation_memories).to be_an(Array)
+      expect(translation_memories).not_to be_empty
+      expect(translation_memories.first).to be_a(DeepL::Resources::TranslationMemory)
+      expect(translation_memories.first.translation_memory_id).not_to be_nil
+      expect(translation_memories.first.name).not_to be_nil
+    end
+  end
+
+  def build_test_translation_memory
+    tm_data = {
+      'translation_memory_id' => 'a74d88fb-ed2a-4943-a664-a4512398b994',
+      'name' => 'Default Translation Memory',
+      'source_language' => 'DE',
+      'target_languages' => %w[EN ES FR],
+      'segment_count' => 3542
+    }
+    DeepL::Resources::TranslationMemory.new(tm_data, nil, nil)
+  end
+end

data/spec/integration_tests/translation_memory_error_paths_spec.rb

@@ -0,0 +1,19 @@
+# Copyright 2026 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::TranslationMemoryApi, :mock_server_only do # rubocop:disable RSpec/SpecFilePathFormat
+  include_context 'with a live mock server'
+
+  describe 'authorization failures' do
+    let(:unauthorized_translation_memories) { described_class.new(unauthorized_api) }
+
+    it 'raises AuthorizationFailed when listing with an invalid auth key' do
+      expect { unauthorized_translation_memories.list }
+        .to raise_error(DeepL::Exceptions::AuthorizationFailed)
+    end
+  end
+end

data/spec/integration_tests/usage_api_spec.rb

@@ -0,0 +1,29 @@
+# Copyright 2026 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'DeepL.usage' do # rubocop:disable RSpec/DescribeClass
+  describe 'happy path' do
+    it 'returns a Usage resource with integer counters where count does not exceed limit' do
+      usage = DeepL.usage
+
+      expect(usage).to be_a(DeepL::Resources::Usage)
+      expect(usage).to respond_to(:character_count, :character_limit)
+      expect(usage.character_count).to be_an(Integer)
+      expect(usage.character_limit).to be_an(Integer)
+      expect(usage.character_count).to be <= usage.character_limit
+    end
+  end
+
+  describe 'resource shape' do
+    it 'exposes quota_exceeded? consistent with character_count vs character_limit' do
+      usage = DeepL.usage
+
+      expect(usage).to respond_to(:quota_exceeded?)
+      expect(usage.quota_exceeded?).to eq(usage.character_count >= usage.character_limit)
+    end
+  end
+end

data/spec/integration_tests/usage_error_paths_spec.rb

@@ -0,0 +1,18 @@
+# Copyright 2026 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe 'DeepL.usage error paths' do # rubocop:disable RSpec/DescribeClass
+  include_context 'with a live mock server'
+
+  describe 'authorization failures' do
+    it 'raises AuthorizationFailed when the auth key is invalid' do
+      request = DeepL::Requests::Usage.new(unauthorized_api)
+
+      expect { request.request }.to raise_error(DeepL::Exceptions::AuthorizationFailed)
+    end
+  end
+end

data/spec/requests/glossary/create_spec.rb

@@ -26,7 +26,6 @@ describe DeepL::Requests::Glossary::Create do
       %w[World Mundo]
     ]
   end
-  let(:entries_format) { 'tsv' }
   let(:options) { {} }
 
   describe '#initialize' do
@@ -42,24 +41,4 @@ describe DeepL::Requests::Glossary::Create do
       end
     end
   end
-
-  describe '#request' do
-    around do |example|
-      VCR.use_cassette('glossaries') { example.call }
-    end
-
-    context 'when performing a valid request with two glossary entries' do
-      it 'returns a glossaries object' do
-        glossary = create.request
-        expect(glossary).to be_a(DeepL::Resources::Glossary)
-        expect(glossary.id).to be_a(String)
-        expect(glossary.name).to eq('Mi Glosario')
-        expect(glossary.ready).to be(true).or be(false)
-        expect(glossary.source_lang).to eq('en')
-        expect(glossary.target_lang).to eq('es')
-        expect { Time.iso8601(glossary.creation_time) }.not_to raise_error
-        expect(glossary.entry_count).to eq(2)
-      end
-    end
-  end
 end

data/spec/requests/glossary/destroy_spec.rb

@@ -24,43 +24,4 @@ describe DeepL::Requests::Glossary::Destroy do
       end
     end
   end
-
-  describe '#request' do
-    around do |example|
-      VCR.use_cassette('glossaries') { example.call }
-    end
-
-    context 'when performing a valid request' do
-      subject(:destroy) { described_class.new(api, new_glossary.id) }
-
-      let(:new_glossary) do
-        DeepL::Requests::Glossary::Create.new(api, 'fixture', 'EN', 'ES', [%w[Hello Hola]]).request
-      end
-
-      it 'returns an empty object' do
-        response = destroy.request
-        expect(response).to eq(new_glossary.id)
-      end
-    end
-
-    context 'when deleting a non existing glossary with a valid id' do
-      subject(:destroy) { described_class.new(api, id) }
-
-      let(:id) { '00000000-0000-0000-0000-000000000000' }
-
-      it 'raises a not found error' do
-        expect { destroy.request }.to raise_error(DeepL::Exceptions::NotFound)
-      end
-    end
-
-    context 'when deleting a non existing glossary with an invalid id' do
-      subject(:destroy) { described_class.new(api, id) }
-
-      let(:id) { 'invalid-uuid' }
-
-      it 'raises a bad request error' do
-        expect { destroy.request }.to raise_error(DeepL::Exceptions::BadRequest)
-      end
-    end
-  end
 end

data/spec/requests/glossary/entries_spec.rb

@@ -24,39 +24,4 @@ describe DeepL::Requests::Glossary::Entries do
       end
     end
   end
-
-  describe '#request' do
-    around do |example|
-      VCR.use_cassette('glossaries') { example.call }
-    end
-
-    context 'when performing a valid request' do
-      it 'returns a list of entries in TSV format' do
-        entries = entries_obj.request
-        expect(entries).to be_a(Array)
-        expect(entries).to all(be_a(Array))
-        expect(entries.size).to eq(2)
-      end
-    end
-
-    context 'when requesting entries with a valid but non existing glossary id' do
-      subject(:entries_obj) { described_class.new(api, id) }
-
-      let(:id) { '00000000-0000-0000-0000-000000000000' }
-
-      it 'raises a not found error' do
-        expect { entries_obj.request }.to raise_error(DeepL::Exceptions::NotFound)
-      end
-    end
-
-    context 'when requesting entries with an invalid glossary id' do
-      subject(:entries_obj) { described_class.new(api, id) }
-
-      let(:id) { 'invalid-uuid' }
-
-      it 'raises a bad request error' do
-        expect { entries_obj.request }.to raise_error(DeepL::Exceptions::BadRequest)
-      end
-    end
-  end
 end

data/spec/requests/glossary/find_spec.rb

@@ -25,44 +25,4 @@ describe DeepL::Requests::Glossary::Find do
       end
     end
   end
-
-  describe '#request' do
-    around do |example|
-      VCR.use_cassette('glossaries') { example.call }
-    end
-
-    context 'when performing a valid request' do
-      it 'returns a glossary object' do
-        glossary = glossary_find.request
-        expect(glossary).to be_a(DeepL::Resources::Glossary)
-        expect(glossary.id).to eq('9ab5dac2-b7b2-4b4a-808a-e8e305df5ecb')
-        expect(glossary.name).to eq('Mi Glosario')
-        expect(glossary.ready).to be(true).or be(false)
-        expect(glossary.source_lang).to eq('en')
-        expect(glossary.target_lang).to eq('es')
-        expect { Time.iso8601(glossary.creation_time) }.not_to raise_error
-        expect(glossary.entry_count).to eq(2)
-      end
-    end
-
-    context 'when requesting a non existing glossary with a valid id' do
-      subject(:glossary_find) { described_class.new(api, id, options) }
-
-      let(:id) { 'a0af40e1-d81b-4aab-a95c-7cafbcfd1eb1' }
-
-      it 'raises a not found error' do
-        expect { glossary_find.request }.to raise_error(DeepL::Exceptions::NotFound)
-      end
-    end
-
-    context 'when requesting a non existing glossary with an invalid id' do
-      subject(:glossary_find) { described_class.new(api, id, options) }
-
-      let(:id) { 'invalid-uuid' }
-
-      it 'raises a bad request error' do
-        expect { glossary_find.request }.to raise_error(DeepL::Exceptions::BadRequest)
-      end
-    end
-  end
 end

data/spec/requests/glossary/language_pairs_spec.rb

@@ -24,17 +24,4 @@ describe DeepL::Requests::Glossary::LanguagePairs do
       end
     end
   end
-
-  describe '#request' do
-    around do |example|
-      VCR.use_cassette('glossaries') { example.call }
-    end
-
-    context 'when requesting a list of all language pairs supported by glossaries' do
-      it 'returns a language pairs object' do
-        language_pairs = language_pairs_obj.request
-        expect(language_pairs).to be_an(Array)
-      end
-    end
-  end
 end

data/spec/requests/glossary/list_spec.rb

@@ -24,31 +24,4 @@ describe DeepL::Requests::Glossary::List do
       end
     end
   end
-
-  describe '#request' do
-    around do |example|
-      VCR.use_cassette('glossaries') { example.call }
-    end
-
-    context 'when requesting a list of all glossaries' do
-      it 'returns a glossaries object' do
-        glossaries = glossary_list.request
-        expect(glossaries).to be_an(Array)
-      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 { glossary_list.request }.to raise_error(DeepL::Exceptions::AuthorizationFailed)
-        end
-      end
-    end
-  end
 end

data/spec/requests/languages_spec.rb

@@ -24,45 +24,4 @@ describe DeepL::Requests::Languages do
       end
     end
   end
-
-  describe '#request' do
-    around do |example|
-      VCR.use_cassette('languages') { example.call }
-    end
-
-    context 'when requesting source languages' do
-      it 'returns a valid list of source languages' do
-        languages = languages_obj.request
-
-        expect(languages).to be_an(Array)
-        expect(languages.size).to eq(29)
-        expect(languages).to(be_any { |l| l.code == 'EN' && l.name == 'English' })
-        expect(languages).to(be_any { |l| l.code == 'ES' && l.name == 'Spanish' })
-      end
-    end
-
-    context 'when requesting target languages' do
-      let(:options) { { type: :target } }
-
-      it 'returns a valid list of target languages' do
-        languages = languages_obj.request
-
-        expect(languages).to be_an(Array)
-        expect(languages.size).to eq(31)
-        expect(languages).not_to(be_any { |l| l.code == 'EN' && l.name == 'English' })
-        expect(languages).to(be_any { |l| l.code == 'ES' && l.name == 'Spanish' })
-        expect(languages)
-          .to(be_any { |l| l.code == 'EN-US' && l.name == 'English (American)' })
-      end
-    end
-
-    context 'when using an invalid type' do
-      let(:options) { { type: :invalid } }
-
-      it 'returns an usage object' do
-        message = "Parameter 'type' is invalid. 'source' and 'target' are valid values."
-        expect { languages_obj.request }.to raise_error(DeepL::Exceptions::BadRequest, message)
-      end
-    end
-  end
 end