deepl-rb 2.5.0 → 2.5.2

data/spec/requests/translate_spec.rb

@@ -3,7 +3,7 @@
 require 'spec_helper'
 
 describe DeepL::Requests::Translate do
-  let(:tags_str) { 'p, strong, span' }
+  let(:tags_str) { 'p,strong,span' }
   let(:tags_array) { %w[p strong span] }
 
   let(:api) { build_deepl_api }
@@ -11,6 +11,7 @@ describe DeepL::Requests::Translate do
   let(:source_lang) { 'EN' }
   let(:target_lang) { 'ES' }
   let(:options) { {} }
+
   subject { DeepL::Requests::Translate.new(api, text, source_lang, target_lang, options) }
 
   describe '#initialize' do
@@ -20,6 +21,33 @@ describe DeepL::Requests::Translate do
       end
     end
 
+    context 'when using `splitting_tags` options' do
+      it 'should work with a nil values' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, splitting_tags: nil)
+        expect(request.options[:splitting_tags]).to eq(nil)
+      end
+
+      it 'should work with a blank list' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, splitting_tags: '')
+        expect(request.options[:splitting_tags]).to eq('')
+      end
+
+      it 'should work with a comma-separated list' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, splitting_tags: tags_str)
+        expect(request.options[:splitting_tags]).to eq(tags_str)
+      end
+
+      it 'should convert arrays to strings' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, splitting_tags: tags_array)
+        expect(request.options[:splitting_tags]).to eq(tags_str)
+      end
+
+      it 'should leave strings as they are' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, splitting_tags: tags_str)
+        expect(request.options[:splitting_tags]).to eq(tags_str)
+      end
+    end
+
     context 'when using `non_splitting_tags` options' do
       it 'should work with a nil values' do
         request = DeepL::Requests::Translate.new(api, nil, nil, nil, non_splitting_tags: nil)
@@ -215,7 +243,7 @@ describe DeepL::Requests::Translate do
 
     context 'When performing a valid request and passing a variable' do
       let(:text) { 'Welcome and <code>Hello great World</code> Good Morning!' }
-      let(:options) { { tag_handling: 'xml', ignore_tags: 'code,span' } }
+      let(:options) { { tag_handling: 'xml', ignore_tags: %w[code span] } }
 
       it 'should return a text object' do
         text = subject.request
@@ -226,6 +254,50 @@ describe DeepL::Requests::Translate do
       end
     end
 
+    context 'When performing a valid request with an HTML document' do
+      let(:text) do
+        <<~XML
+          <document>
+            <meta>
+              <title>A document's title</title>
+            </meta>
+            <content>
+              <par>This is the first sentence. Followed by a second one.</par>
+              <par>This is the third sentence.</par>
+            </content>
+          </document>
+        XML
+      end
+      let(:options) do
+        {
+          tag_handling: 'xml',
+          split_sentences: 'nonewlines',
+          outline_detection: false,
+          splitting_tags: %w[title par]
+        }
+      end
+
+      it 'should return a text object' do
+        text = subject.request
+
+        expect(text).to be_a(DeepL::Resources::Text)
+        expect(text.text).to eq(
+          <<~XML
+            <document>
+              <meta>
+                <title>El título de un documento</title>
+              </meta>
+              <content>
+                <par>Es la primera frase. Seguido de una segunda.</par>
+                <par>Esta es la tercera frase.</par>
+              </content>
+            </document>
+          XML
+        )
+        expect(text.detected_source_language).to eq('EN')
+      end
+    end
+
     context 'When performing a bad request' do
       context 'When using an invalid token' do
         let(:api) do
@@ -257,5 +329,14 @@ describe DeepL::Requests::Translate do
         end
       end
     end
+
+    context 'When performing a request with too many texts' do
+      let(:text) { Array.new(10_000) { |i| "This is the sentence number #{i}" } }
+
+      it 'should raise a request entity too large error' do
+        expect { subject.request }.to raise_error(DeepL::Exceptions::RequestEntityTooLarge,
+                                                  /request size has reached the supported limit/)
+      end
+    end
   end
 end

data/spec/spec_helper.rb

@@ -18,7 +18,7 @@ require 'vcr'
 VCR.configure do |config|
   config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
   config.hook_into :webmock
-  config.filter_sensitive_data('VALID_TOKEN') { ENV['DEEPL_AUTH_KEY'] }
+  config.filter_sensitive_data('VALID_TOKEN') { ENV.fetch('DEEPL_AUTH_KEY', nil) }
   config.default_cassette_options = {
     # record: :new_episodes,
     match_requests_on: %i[method uri body headers]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.5.2
 platform: ruby
 authors:
 - Daniel Herzog
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-06 00:00:00.000000000 Z
+date: 2022-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -65,6 +65,7 @@ files:
 - lib/deepl/exceptions/not_found.rb
 - lib/deepl/exceptions/not_supported.rb
 - lib/deepl/exceptions/quota_exceeded.rb
+- lib/deepl/exceptions/request_entity_too_large.rb
 - lib/deepl/exceptions/request_error.rb
 - lib/deepl/glossary_api.rb
 - lib/deepl/requests/base.rb
@@ -83,6 +84,7 @@ files:
 - lib/deepl/resources/language_pair.rb
 - lib/deepl/resources/text.rb
 - lib/deepl/resources/usage.rb
+- lib/deepl/utils/exception_builder.rb
 - spec/api/api_spec.rb
 - spec/api/configuration_spec.rb
 - spec/api/deepl_spec.rb