deepl-rb 3.5.1 → 3.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a72aff32a39743d19e811efa5a3e9d5687b90c0f3f06e1545b3746143a7478b7
-  data.tar.gz: 02b0f280c59a81c24771a2c2d4248d9fb4d32bcb3a635dc9e8a0a8cf6ce8db71
+  metadata.gz: 8ea8e9d6cc6601abfadddf2b0b70169a7449e71434a8b695c534789d2263d681
+  data.tar.gz: '029b836b133bbf60d9b4a8acecf90b89d969d991e793db1bf5643f5633895282'
 SHA512:
-  metadata.gz: c292502b6e5c35a73f79ddacbe7f44ea2c1ba51d12eb137a795e44f6f10c56f397277eea272faf193a4fb14c6f639fe597c0c066feca1cce03ad5584cf2d3224
-  data.tar.gz: 31f9cfdd8e9f762f30ff37e5de3aa3466527330e14aa6378d0c1bc2454c9f78249a74546998bfbf90ba56ef46e77fe4c09885cc82d489db615ab7a2ff89f3f7e
+  metadata.gz: 83070b04ae93261b4524cb5353bdb888c2b9f5a98c9314239ed4ae8c76a53182363bb31ba31f7468a7a5d705162c09fbb69fb0f4a71bc802d8b373d97c46aeaa
+  data.tar.gz: 8ac545b8fb392b31a0e3fa00f4ed7f556bcf92304d8852226e57d099d365554c6eb5f510fe76891c329bdf89851c2bff217417f157947ffb96e41e50ef58b562

data/CHANGELOG.md

@@ -4,6 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [Unreleased]
+
+## [3.6.1] - 2025-12-19
+### Fixed
+- Fixed broken 3.6.0 release
+
+## [3.6.0] - 2025-12-10
+### Added
+- Added `tag_handling_version` parameter to `translate()` to specify which version of the tag handling algorithm to use. Options are `v1` and `v2`.
+
+### Fixed
+- `extra_body_parameters` will no longer cast values to string, as this library sends JSON-encoded requests
+  (allows e.g. sending booleans)
+
 ## [3.5.1] - 2025-12-19
 ### Fixed
 - Fixed broken 3.5.0 release
@@ -17,6 +31,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   model type as the default. Requests combining `custom_instructions` and the
   `latency_optimized` model type will be rejected.
 
+## [3.4.1] - 2025-12-19
+### Fixed
+- Fixed broken 3.4.0 release
+
 ## [3.4.0] - 2025-11-17
 ### Added
 - Added support for the `GET /v3/style_rules` endpoint in the client library, the
@@ -84,8 +102,12 @@ The change in major version is only due to the change in maintainership, there i
 ### Fixed
 - Make RequestEntityTooLarge error message more clear
 
+[Unreleased]: https://github.com/DeepLcom/deepl-rb/compare/v3.6.1...HEAD
+[3.6.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.6.0...v3.6.1
+[3.6.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.5.1...v3.6.0
 [3.5.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.5.0...v3.5.1
-[3.5.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.4.0...v3.5.0
+[3.5.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.4.1...v3.5.0
+[3.4.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.4.0...v3.4.1
 [3.4.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.3.0...v3.4.0
 [3.3.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.2.0...v3.3.0
 [3.2.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.1.0...v3.2.0

data/README.md

@@ -127,6 +127,18 @@ puts translation.text
 # => "<p>Una muestra</p>"
 ```
 
+To specify which version of the tag handling algorithm to use, you can use the `tag_handling_version` parameter:
+
+```rb
+translation = DeepL.translate '<p>A sample</p>', 'EN', 'ES',
+                              tag_handling: 'xml', tag_handling_version: 'v2'
+
+puts translation.text
+# => "<p>Una muestra</p>"
+```
+
+The available values are `'v1'` and `'v2'`.
+
 To translate with context, simply supply the `context` parameter:
 
 ```rb
@@ -183,6 +195,7 @@ The following parameters will be automatically converted:
 | `style_rule`          | No conversion applied (can be a string ID or a StyleRule object)
 | `context`             | No conversion applied
 | `custom_instructions` | No conversion applied
+| `tag_handling_version` | No conversion applied
 | `extra_body_parameters` | Hash of extra parameters to pass in the body of the HTTP request. Can be used to access beta features, or to override built-in parameters for testing purposes. Extra parameters can override keys explicitly set by the client.
 
 ### Rephrase Text

data/VERSION

@@ -1 +1 @@
-3.5.1
+3.6.1

data/deepl-rb.gemspec

@@ -2,11 +2,11 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: deepl-rb 3.5.1 ruby lib
+# stub: deepl-rb 3.6.1 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "3.5.1"
+  s.version = "3.6.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.metadata = { "bug_tracker_uri" => "https://github.com/DeepLcom/deepl-rb/issues", "changelog_uri" => "https://github.com/DeepLcom/deepl-rb/blob/main/CHANGELOG.md", "documentation_uri" => "https://github.com/DeepLcom/deepl-rb/blob/main/README.md", "homepage_uri" => "https://github.com/DeepLcom/deepl-rb" } if s.respond_to? :metadata=
@@ -109,6 +109,7 @@ Gem::Specification.new do |s|
     "spec/integration_tests/document_api_spec.rb",
     "spec/integration_tests/integration_test_utils.rb",
     "spec/integration_tests/style_rule_api_spec.rb",
+    "spec/requests/extra_body_parameters_types_spec.rb",
     "spec/requests/glossary/create_spec.rb",
     "spec/requests/glossary/destroy_spec.rb",
     "spec/requests/glossary/entries_spec.rb",

data/lib/deepl/requests/base.rb

@@ -61,7 +61,7 @@ module DeepL
 
         extra_params = option(:extra_body_parameters)
         extra_params.each do |key, value|
-          payload[key] = value.to_s
+          payload[key] = value
         end
       end
 

data/lib/deepl/requests/translate.rb

@@ -28,7 +28,7 @@ module DeepL
       }.freeze
 
       attr_reader :text, :source_lang, :target_lang, :ignore_tags, :splitting_tags,
-                  :non_splitting_tags, :model_type, :custom_instructions
+                  :non_splitting_tags, :model_type, :custom_instructions, :tag_handling_version
 
       def initialize(api, text, source_lang, target_lang, options = {})
         super(api, options)

data/lib/version.rb

@@ -4,5 +4,5 @@
 # frozen_string_literal: true
 
 module DeepL
-  VERSION = '3.5.1'
+  VERSION = '3.6.1'
 end

data/spec/fixtures/vcr_cassettes/translate_texts.yml

@@ -10455,4 +10455,176 @@ http_interactions:
       encoding: ASCII-8BIT
       string: '{"translations":[{"text":"Sehr geehrte Damen und Herren","detected_source_language":"EN"}]}'
   recorded_at: Wed, 03 Dec 2025 06:07:36 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: text=%3Cp%3EHello+world%3C%2Fp%3E&source_lang=EN&target_lang=DE&tag_handling=html&tag_handling_version=v1
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.5.0 (darwin24) ruby/3.2.2
+      Content-Type:
+      - application/x-www-form-urlencoded
+      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, 10 Dec 2025 12:00:00 GMT
+      X-Trace-Id:
+      - a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=80, l7_lb_idle;dur=3, l7_lb_receive;dur=0, l7_lb_total;dur=150
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '{"translations":[{"detected_source_language":"EN","text":"<p>Hallo Welt</p>"}]}'
+  recorded_at: Tue, 10 Dec 2025 12:00:00 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: text=%3Cp%3EHello+world%3C%2Fp%3E&source_lang=EN&target_lang=DE&tag_handling=html&tag_handling_version=v2
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.5.0 (darwin24) ruby/3.2.2
+      Content-Type:
+      - application/x-www-form-urlencoded
+      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, 10 Dec 2025 12:00:01 GMT
+      X-Trace-Id:
+      - b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6q7
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=82, l7_lb_idle;dur=2, l7_lb_receive;dur=0, l7_lb_total;dur=155
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: UTF-8
+      string: '{"translations":[{"detected_source_language":"EN","text":"<p>Hallo Welt</p>"}]}'
+  recorded_at: Tue, 10 Dec 2025 12:00:01 GMT
+- request:
+    method: post
+    uri: https://api-free.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["<p>Hello world</p>"],"source_lang":"EN","target_lang":"DE","tag_handling":"html","tag_handling_version":"v1"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.5.0 (darwin24) ruby/3.2.2
+      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, 10 Dec 2025 13:05:30 GMT
+      X-Trace-Id:
+      - c1d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=75, l7_lb_idle;dur=2, l7_lb_receive;dur=0, l7_lb_total;dur=145
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"translations":[{"detected_source_language":"EN","text":"<p>Hallo Welt</p>"}]}'
+  recorded_at: Tue, 10 Dec 2025 13:05:30 GMT
+- request:
+    method: post
+    uri: https://api-free.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["<p>Hello world</p>"],"source_lang":"EN","target_lang":"DE","tag_handling":"html","tag_handling_version":"v2"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.5.0 (darwin24) ruby/3.2.2
+      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, 10 Dec 2025 13:05:31 GMT
+      X-Trace-Id:
+      - d2e3f4a5b6c7d8e9f0a1b2c3d4e5f6a7
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=78, l7_lb_idle;dur=3, l7_lb_receive;dur=0, l7_lb_total;dur=148
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"translations":[{"detected_source_language":"EN","text":"<p>Hallo Welt</p>"}]}'
+  recorded_at: Tue, 10 Dec 2025 13:05:31 GMT
 recorded_with: VCR 6.3.1

data/spec/requests/extra_body_parameters_types_spec.rb

@@ -0,0 +1,82 @@
+# 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::Base extra_body_parameters type preservation' do
+  let(:api) { build_deepl_api }
+
+  around do |tests|
+    tmp_env = replace_env_preserving_deepl_vars_except_mock_server
+    tests.call
+    ENV.replace(tmp_env)
+  end
+
+  describe 'apply_extra_body_parameters_to_json' do
+    it 'preserves boolean true' do
+      request = DeepL::Requests::Translate.new(
+        api, 'test', 'EN', 'ES',
+        extra_body_parameters: { enable_beta_languages: true }
+      )
+
+      payload = {}
+      request.send(:apply_extra_body_parameters_to_json, payload)
+
+      expect(payload[:enable_beta_languages]).to be(true)
+      expect(payload[:enable_beta_languages]).to be_a(TrueClass)
+    end
+
+    it 'preserves boolean false' do
+      request = DeepL::Requests::Translate.new(
+        api, 'test', 'EN', 'ES',
+        extra_body_parameters: { some_flag: false }
+      )
+
+      payload = {}
+      request.send(:apply_extra_body_parameters_to_json, payload)
+
+      expect(payload[:some_flag]).to be(false)
+      expect(payload[:some_flag]).to be_a(FalseClass)
+    end
+
+    it 'preserves integers' do
+      request = DeepL::Requests::Translate.new(
+        api, 'test', 'EN', 'ES',
+        extra_body_parameters: { some_number: 42 }
+      )
+
+      payload = {}
+      request.send(:apply_extra_body_parameters_to_json, payload)
+
+      expect(payload[:some_number]).to eq(42)
+      expect(payload[:some_number]).to be_a(Integer)
+    end
+
+    it 'preserves strings' do
+      request = DeepL::Requests::Translate.new(
+        api, 'test', 'EN', 'ES',
+        extra_body_parameters: { some_string: 'hello' }
+      )
+
+      payload = {}
+      request.send(:apply_extra_body_parameters_to_json, payload)
+
+      expect(payload[:some_string]).to eq('hello')
+      expect(payload[:some_string]).to be_a(String)
+    end
+
+    it 'allows overriding standard parameters' do
+      request = DeepL::Requests::Translate.new(
+        api, 'test', 'EN', 'ES',
+        extra_body_parameters: { target_lang: 'FR' }
+      )
+
+      payload = { target_lang: 'ES' }
+      request.send(:apply_extra_body_parameters_to_json, payload)
+
+      expect(payload[:target_lang]).to eq('FR')
+    end
+  end
+end

data/spec/requests/translate_spec.rb

@@ -208,6 +208,23 @@ describe DeepL::Requests::Translate do
       end
     end
 
+    context 'when using `tag_handling_version` options' do
+      it 'works with a nil value' do
+        request = described_class.new(api, nil, nil, nil, tag_handling_version: nil)
+        expect(request.options[:tag_handling_version]).to be_nil
+      end
+
+      it 'works with v1' do
+        request = described_class.new(api, nil, nil, nil, tag_handling_version: 'v1')
+        expect(request.options[:tag_handling_version]).to eq('v1')
+      end
+
+      it 'works with v2' do
+        request = described_class.new(api, nil, nil, nil, tag_handling_version: 'v2')
+        expect(request.options[:tag_handling_version]).to eq('v2')
+      end
+    end
+
     context 'when using `model_type` options' do
       it 'works with a nil value' do
         request = described_class.new(api, nil, nil, nil, model_type: nil)
@@ -415,6 +432,23 @@ describe DeepL::Requests::Translate do
       end
     end
 
+    context 'when performing a request with tag_handling_version' do
+      let(:text) { '<p>Hello world</p>' }
+      let(:target_lang) { 'DE' }
+
+      %w[v1 v2].each do |version|
+        it "translates correctly with tag_handling_version #{version}" do
+          options = { tag_handling: 'html', tag_handling_version: version }
+          translate = described_class.new(api, text, source_lang, target_lang, options)
+          res = translate.request
+
+          expect(res).to be_a(DeepL::Resources::Text)
+          expect(res.text).not_to be_nil
+          expect(res.text).not_to be_empty
+        end
+      end
+    end
+
     context 'when performing a bad request' do
       context 'when using an invalid token' do
         let(:api) do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.6.1
 platform: ruby
 authors:
 - DeepL SE
@@ -136,6 +136,7 @@ files:
 - spec/integration_tests/document_api_spec.rb
 - spec/integration_tests/integration_test_utils.rb
 - spec/integration_tests/style_rule_api_spec.rb
+- spec/requests/extra_body_parameters_types_spec.rb
 - spec/requests/glossary/create_spec.rb
 - spec/requests/glossary/destroy_spec.rb
 - spec/requests/glossary/entries_spec.rb