deepl-rb 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47bf797967929a4b7775e21ce7021cdc1871283b3358cbb36d13a8f6f6b5ac6b
-  data.tar.gz: df4399cc6c552fb5c03b79b0566d2370101b58246bfd5e0b05d27c83e994ae6c
+  metadata.gz: ce04c17b4585b9813713f61db8fe35e3a61b777c48ec22011f81b7febe106527
+  data.tar.gz: 3c4432516a14b2fb0e8886f2ff3e6d31c5ba5c88590d4e28a9631fc0a233f724
 SHA512:
-  metadata.gz: 4639c87e107dfa0a13b1bace938e9a3580fb15bb1e2f280267527e3d5d0c9b8913752b841bd095039f1e4f7d15b13813075131c0767216855bf5e7d28a4b81a1
-  data.tar.gz: 19743f57e84c550e5fe35b1d6c39f853df1d0d1d357eb8c0f061a0202831af8a557651f34f50dcad10928b45638a3a09b9ab64652fdadab6d6ad62ec3f2a1242
+  metadata.gz: 8a736f2b2cc257c26cd47e67bdbdcbc89afbb6de444176f0dab5b0a470fe2c713e3c32396391a05c007ddfbfbbc80953b0f6c6afb1fdf9b138c0eca97ae02a52
+  data.tar.gz: 1828bdede7c38bec246302645e39ec7f01950096f3c52fb1b119766bbdf11b6c2b6d3ab881ebdf2875f736ab8f47778e87abcb5f107ca2ef6f4848c66d11d680

data/.gitlab-ci.yml

@@ -1,5 +1,6 @@
 # Note: This GitLab CI configuration is used for internal testing, users can ignore it.
 include:
+  - template: Security/SAST.gitlab-ci.yml
   - project: '${CI_PROJECT_NAMESPACE}/ci-libs-for-client-libraries'
     file:
       - '/${CI_PROJECT_NAME}/.gitlab-ci.yml'
@@ -7,6 +8,7 @@ include:
     file:
       - '/templates/.buildkit.yml'
       - '/templates/.secret-detection.yml'
+      - '/templates/.gitlab-release.yml'
 
 # Global --------------------------
 
@@ -16,11 +18,14 @@ workflow:
     - if: $CI_COMMIT_TAG
     - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
 
+variables:
+  GITLAB_ADVANCED_SAST_ENABLED: 'true'
+
 stages:
   - install
   - check
   - test
-#  - publish
+  - publish # Only for internal tracking
 
 
 before_script:
@@ -82,6 +87,29 @@ license_check:
     - ./license_checker.sh '*.rb' | tee license_check_output.txt
     - '[ ! -s license_check_output.txt ]'
 
+gitlab-advanced-sast:
+  stage: check
+  before_script:
+    - ''
+  rules:
+    - when: always
+  variables:
+    SAST_EXCLUDED_PATHS: '$DEFAULT_SAST_EXCLUDED_PATHS,/spec'
+    GIT_STRATEGY: clone
+    KUBERNETES_HELPER_MEMORY_LIMIT: 8Gi
+    SAST_SCANNER_ALLOWED_CLI_OPTS: --multi-core 8
+
+semgrep-sast:
+  stage: check
+  before_script:
+    - ''
+  rules:
+    - when: always
+  variables:
+    SAST_EXCLUDED_PATHS: '$DEFAULT_SAST_EXCLUDED_PATHS,/spec'
+    GIT_STRATEGY: clone
+    KUBERNETES_MEMORY_LIMIT: 8Gi
+
 
 # stage: test ----------------------
 
@@ -133,3 +161,12 @@ test_manual:
   extends: .test_base
   rules:
     - if: $CI_PIPELINE_SOURCE != "schedule"
+
+
+# stage: publish ----------------------
+
+gitlab release:
+  stage: publish
+  extends: .create_gitlab_release
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'

data/CHANGELOG.md

@@ -4,59 +4,69 @@ 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).
 
-## [3.2.0]
+## [Unreleased]
+
+## [3.3.0] - 2025-11-04
+### Added
+- Added `extra_body_parameters` option to text and document translation methods to pass arbitrary parameters in the request body. This can be used to access beta features or override built-in parameters (such as `target_lang`, `source_lang`, etc.).
+- Added `rephrase` functionality to the top-level `DeepL` module for convenience.
+  * Thanks to [341bms](https://github.com/341bms) in [#14](https://github.com/DeepLcom/deepl-rb/issues/14) for the report!
+
+## [3.2.0] - 2025-01-15
 ### Added
-* Added `rephrase` functionality to get a new version of submitted text with various possible styles or tones applied
-* Added `DeepL::Constants` namespace and associated constant values for options possibilities
+- Added `rephrase` functionality to get a new version of submitted text with various possible styles or tones applied
+- Added `DeepL::Constants` namespace and associated constant values for options possibilities
 
-## [3.1.0]
+## [3.1.0] - 2024-11-15
 ### Added
-* Added `model_type` option to `translate()` to use models with higher
+- Added `model_type` option to `translate()` to use models with higher
   translation quality (available for some language pairs), or better latency.
   Options are `'quality_optimized'`, `'latency_optimized'`, and  `'prefer_quality_optimized'`
-* Added the `model_type_used` field to the `translate()` response, that
+- Added the `model_type_used` field to the `translate()` response, that
   indicates the translation model used when the `model_type` option is
   specified.
 
-
 ## [3.0.2] - 2024-10-02
 ### Added
-* Added doc example and tests for context parameter
+- Added doc example and tests for context parameter
+
 ### Fixed
-* Fix metadata displayed on RubyGems.org for this library.
-* Fixed library version sent in the `User-Agent` string.
+- Fix metadata displayed on RubyGems.org for this library.
+- Fixed library version sent in the `User-Agent` string.
 
 ## [3.0.1] - 2024-09-23
 ### Fixed
-* `document.translate_document` required a filename, this is now optional. The example in the README now works.
+- `document.translate_document` required a filename, this is now optional. The example in the README now works.
 
 ## [3.0.0] - 2024-09-20
 Beginning with version 3, deepl-rb is officially supported by DeepL, and maintained together with [Daniel Herzog](mailto:info@danielherzog.es) the developer of earlier versions of this library.
 The change in major version is only due to the change in maintainership, there is no migration necessary from v2 to v3.
+
 ### Added
-* Added rubocop-rspec linting for rspec test files
-* Added document translation to the ruby CL
-* Added possibility to use one HTTP session for multiple calls
-* Added platform and ruby version information to the user-agent string that is sent with API calls, along with an opt-out
-* Added support for logging of HTTP requests
-* Added support for using a proxy and a custom certificate file
-* Added a gitlab CI pipeline
+- Added rubocop-rspec linting for rspec test files
+- Added document translation to the ruby CL
+- Added possibility to use one HTTP session for multiple calls
+- Added platform and ruby version information to the user-agent string that is sent with API calls, along with an opt-out
+- Added support for logging of HTTP requests
+- Added support for using a proxy and a custom certificate file
+- Added a gitlab CI pipeline
+
 ### Changed
-* HTTP requests to the DeepL API now use `application/json`, rather than `application/www-form-unencoded`
-* HTTP requests now automatically retry on transient failures, using exponential backoff
-### Deprecated
+- HTTP requests to the DeepL API now use `application/json`, rather than `application/www-form-unencoded`
+- HTTP requests now automatically retry on transient failures, using exponential backoff
+
 ### Removed
-* Removed CircleCI and CodeCov upload
-### Fixed
-### Security
+- Removed CircleCI and CodeCov upload
 
 ## [2.5.3] - 2022-09-26
 ### Fixed
-* Make RequestEntityTooLarge error message more clear
+- Make RequestEntityTooLarge error message more clear
 
-[3.2.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.1.0...3.2.0
+[Unreleased]: https://github.com/DeepLcom/deepl-rb/compare/v3.3.0...HEAD
+[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
 [3.1.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.0.2...v3.1.0
 [3.0.2]: https://github.com/DeepLcom/deepl-rb/compare/v3.0.1...v3.0.2
 [3.0.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.0.0...v3.0.1
 [3.0.0]: https://github.com/DeepLcom/deepl-rb/compare/v2.5.3...v3.0.0
-[2.5.3]: https://github.com/DeepLcom/deepl-rb/compare/v2.5.2...v2.5.3
+[2.5.3]: https://github.com/DeepLcom/deepl-rb/releases/tag/v2.5.3

data/README.md

@@ -167,6 +167,7 @@ The following parameters will be automatically converted:
 | `formality`           | No conversion applied
 | `glossary_id`         | No conversion applied
 | `context`             | 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
 
@@ -322,6 +323,18 @@ doc_status = doc_handle.wait_until_document_translation_finished # alternatively
 DeepL.document.download(doc_handle, '/path/to/translated_document.pdf') unless doc_status.error?
 ```
 
+You can also pass additional options to document translation methods, including `extra_body_parameters`:
+
+```rb
+options = {
+  formality: 'more',
+  extra_body_parameters: { example_param: 'true' }
+}
+doc_handle = DeepL.document.upload('/path/to/spanish_document.pdf', 'ES', 'EN', nil, options)
+```
+
+The `extra_body_parameters` option allows you to pass arbitrary parameters in the request body. This can be used to access beta features by adding new parameters, or to override built-in parameters (such as `target_lang`, `source_lang`, etc.) for testing purposes.
+
 ### Handle exceptions
 
 You can capture and process exceptions that may be raised during API calls. These are all the possible exceptions:

data/Rakefile

@@ -33,6 +33,7 @@ Juwelier::Tasks.new do |gem|
   }
   gem.files.exclude '.github'
   gem.files.exclude '.circleci'
+  gem.files.exclude 'catalog-info.yaml'
 end
 
 Juwelier::RubygemsDotOrgTasks.new

data/VERSION

@@ -1 +1 @@
-3.2.0
+3.3.0

data/deepl-rb.gemspec

@@ -2,17 +2,17 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: deepl-rb 3.2.0 ruby lib
+# stub: deepl-rb 3.3.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "3.2.0".freeze
+  s.version = "3.3.0"
 
   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=
   s.require_paths = ["lib".freeze]
   s.authors = ["DeepL SE".freeze]
-  s.date = "2025-01-15"
+  s.date = "2025-11-04"
   s.description = "Official Ruby library for the DeepL language translation API (v2). For more information, check this: https://www.deepl.com/docs/api-reference.html".freeze
   s.email = "open-source@deepl.com".freeze
   s.extra_rdoc_files = [
@@ -93,6 +93,7 @@ Gem::Specification.new do |s|
     "spec/fixtures/vcr_cassettes/deepl_document_download.yml",
     "spec/fixtures/vcr_cassettes/deepl_glossaries.yml",
     "spec/fixtures/vcr_cassettes/deepl_languages.yml",
+    "spec/fixtures/vcr_cassettes/deepl_rephrase.yml",
     "spec/fixtures/vcr_cassettes/deepl_translate.yml",
     "spec/fixtures/vcr_cassettes/deepl_usage.yml",
     "spec/fixtures/vcr_cassettes/glossaries.yml",
@@ -121,12 +122,12 @@ Gem::Specification.new do |s|
   ]
   s.homepage = "https://github.com/DeepLcom/deepl-rb".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.5.3".freeze
+  s.rubygems_version = "3.4.6".freeze
   s.summary = "Official Ruby library for the DeepL language translation API.".freeze
 
   s.specification_version = 4
 
-  s.add_development_dependency(%q<juwelier>.freeze, [">= 0".freeze])
-  s.add_development_dependency(%q<byebug>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
+  s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
 end
 

data/lib/deepl/exceptions/authorization_failed.rb

@@ -6,7 +6,7 @@
 module DeepL
   module Exceptions
     class AuthorizationFailed < RequestError
-      def message
+      def to_s
         'Authorization failed. Please supply a valid auth_key parameter.'
       end
     end

data/lib/deepl/exceptions/bad_request.rb

@@ -6,7 +6,7 @@
 module DeepL
   module Exceptions
     class BadRequest < RequestError
-      def message
+      def to_s
         JSON.parse(response.body)['message']
       rescue JSON::ParserError
         response.body

data/lib/deepl/exceptions/limit_exceeded.rb

@@ -6,7 +6,7 @@
 module DeepL
   module Exceptions
     class LimitExceeded < RequestError
-      def message
+      def to_s
         'Limit exceeded. Please wait and send your request once again.'
       end
 

data/lib/deepl/exceptions/not_found.rb

@@ -6,7 +6,7 @@
 module DeepL
   module Exceptions
     class NotFound < RequestError
-      def message
+      def to_s
         JSON.parse(response.body)['message']
       rescue JSON::ParserError
         response.body

data/lib/deepl/exceptions/quota_exceeded.rb

@@ -6,7 +6,7 @@
 module DeepL
   module Exceptions
     class QuotaExceeded < RequestError
-      def message
+      def to_s
         'Quota exceeded. The character limit has been reached.'
       end
     end

data/lib/deepl/exceptions/request_entity_too_large.rb

@@ -6,7 +6,7 @@
 module DeepL
   module Exceptions
     class RequestEntityTooLarge < RequestError
-      def message
+      def to_s
         'The request size has reached the supported limit. ' \
           "Make sure that you're not sending more than 50 text parts."
       end

data/lib/deepl/exceptions/request_error.rb

@@ -13,7 +13,7 @@ module DeepL
         @response = response
       end
 
-      def message
+      def to_s
         'Unknown error.'
       end
     end

data/lib/deepl/exceptions/server_error.rb

@@ -6,7 +6,7 @@
 module DeepL
   module Exceptions
     class ServerError < RequestError
-      def message
+      def to_s
         'An internal server error occured. Try again after waiting a short period.'
       end
 

data/lib/deepl/requests/base.rb

@@ -46,6 +46,40 @@ module DeepL
         end
       end
 
+      # Returns options excluding extra_body_parameters
+      # extra_body_parameters are applied separately via apply_extra_body_parameters_* methods
+      def options_without_extra_params
+        options.reject do |k, _|
+          k.to_s == 'extra_body_parameters' || k.to_sym == :extra_body_parameters
+        end
+      end
+
+      # Apply extra body parameters to a hash payload (for JSON/form-encoded requests)
+      # Extra parameters will override existing keys
+      def apply_extra_body_parameters_to_json(payload)
+        return unless option?(:extra_body_parameters)
+
+        extra_params = option(:extra_body_parameters)
+        extra_params.each do |key, value|
+          payload[key] = value.to_s
+        end
+      end
+
+      # Apply extra body parameters to multipart form data array
+      # Extra parameters will override existing keys
+      def apply_extra_body_parameters_to_form(form_data)
+        return unless option?(:extra_body_parameters)
+
+        extra_params = option(:extra_body_parameters)
+        extra_params.each do |key, value|
+          key_str = key.to_s
+          # Remove existing key if present to allow override.
+          # Required for form data as it would be duplicated otherwise
+          form_data.reject! { |field| field[0].to_s == key_str }
+          form_data.push([key_str, value.to_s])
+        end
+      end
+
       # Files to reset: list of file objects to rewind when retrying the request
       def execute_request_with_retries(req, files_to_reset = []) # rubocop:disable all
         api.configuration.logger&.info("Request to the DeepL API: #{self}")
@@ -88,17 +122,16 @@ module DeepL
       end
 
       def post_request(payload)
+        apply_extra_body_parameters_to_json(payload)
         http_headers = add_json_content_type(headers)
         post_req = Net::HTTP::Post.new(uri.path, http_headers)
-        post_req.body = payload.merge(options).to_json
+        post_req.body = payload.merge(options_without_extra_params).to_json
         post_req
       end
 
       def post_request_with_file(form_data)
         http_headers = add_multipart_form_content_type(headers)
         post_req = Net::HTTP::Post.new(uri.request_uri, http_headers)
-        # options are passed in `form_data`
-        form_data += options.map { |key, value| [key.to_s, value.to_s] }
         post_req.set_form(form_data, 'multipart/form-data')
         post_req
       end
@@ -106,14 +139,14 @@ module DeepL
       def get_request # rubocop:disable Naming/AccessorMethodName
         http_headers = add_json_content_type(headers)
         get_req = Net::HTTP::Get.new(uri.path, http_headers)
-        get_req.body = options.to_json
+        get_req.body = options_without_extra_params.to_json
         get_req
       end
 
       def delete_request
         http_headers = add_json_content_type(headers)
         del_req = Net::HTTP::Delete.new(uri.path, http_headers)
-        del_req.body = options.to_json
+        del_req.body = options_without_extra_params.to_json
         del_req
       end
 

data/lib/deepl/requests/document/upload.rb

@@ -20,18 +20,10 @@ module DeepL
           @filename = filename
         end
 
-        def request # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        def request
           input_file = File.open(input_file_path, 'rb')
-          form_data = [
-            ['file', input_file], ['source_lang', source_lang],
-            ['target_lang', target_lang]
-          ]
-          filename_param = filename || File.basename(input_file_path)
-          form_data.push(['filename', filename_param]) unless filename_param.nil?
-          # Manually add options due to multipart/form-data request
-          SUPPORTED_OPTIONS.each do |option|
-            form_data.push([option, options[option]]) unless options[option].nil?
-          end
+          form_data = build_base_form_data(input_file)
+          apply_extra_body_parameters_to_form(form_data)
           build_doc_handle(*execute_request_with_retries(post_request_with_file(form_data),
                                                          [input_file]))
         end
@@ -49,6 +41,24 @@ module DeepL
 
         private
 
+        def build_base_form_data(input_file)
+          form_data = [
+            ['file', input_file], ['source_lang', source_lang],
+            ['target_lang', target_lang]
+          ]
+          filename_param = filename || File.basename(input_file_path)
+          form_data.push(['filename', filename_param]) unless filename_param.nil?
+          add_supported_options_to_form(form_data)
+          form_data
+        end
+
+        def add_supported_options_to_form(form_data)
+          SUPPORTED_OPTIONS.each do |option_name|
+            option_value = option(option_name)
+            form_data.push([option_name, option_value]) unless option_value.nil?
+          end
+        end
+
         def build_doc_handle(request, response)
           parsed_response = JSON.parse(response.body)
           Resources::DocumentHandle.new(parsed_response['document_id'],

data/lib/deepl/requests/rephrase.rb

@@ -8,7 +8,7 @@ module DeepL
     class Rephrase < Base
       attr_reader :text, :target_lang, :writing_style, :tone
 
-      def initialize(api, text, target_lang, writing_style = nil, tone = nil, options = {})
+      def initialize(api, text, target_lang = nil, writing_style = nil, tone = nil, options = {}) # rubocop:disable Metrics/ParameterLists
         super(api, options)
         @text = text
         @target_lang = target_lang
@@ -16,9 +16,10 @@ module DeepL
         @tone = tone
       end
 
-      def request
+      def request # rubocop:disable Metrics/AbcSize
         text_arrayified = text.is_a?(Array) ? text : [text]
-        payload = { text: text_arrayified, target_lang: target_lang }
+        payload = { text: text_arrayified }
+        payload[:target_lang] = target_lang unless target_lang.nil?
         payload[:writing_style] = writing_style unless writing_style.nil?
         payload[:tone] = tone unless tone.nil?
         build_texts(*execute_request_with_retries(post_request(payload)))

data/lib/deepl.rb

@@ -97,6 +97,11 @@ module DeepL
     GlossaryApi.new(api, options)
   end
 
+  def rephrase(text, target_lang = nil, writing_style = nil, tone = nil, options = {}) # rubocop:disable Metrics/ParameterLists
+    configure if @configuration.nil?
+    Requests::Rephrase.new(api, text, target_lang, writing_style, tone, options).request
+  end
+
   def usage(options = {})
     configure if @configuration.nil?
     Requests::Usage.new(api, options).request

data/spec/api/deepl_spec.rb

@@ -428,4 +428,33 @@ describe DeepL do
       end
     end
   end
+
+  describe '#rephrase' do
+    let(:text) { 'Ih bin ei beispielsatz.' }
+    let(:target_lang) { 'DE' }
+    let(:options) { {} }
+
+    around do |example|
+      deepl.configure
+      VCR.use_cassette('deepl_rephrase') { example.call }
+    end
+
+    context 'when rephrasing text' do
+      it 'creates and call a request object' do
+        expect(DeepL::Requests::Rephrase).to receive(:new)
+          .with(deepl.api, text, nil, nil, nil, {}).and_call_original
+
+        rephrased_text = deepl.rephrase(text)
+        expect(rephrased_text).to be_a(DeepL::Resources::Text)
+      end
+
+      it 'creates and call a request object when passing options' do
+        expect(DeepL::Requests::Rephrase).to receive(:new)
+          .with(deepl.api, text, target_lang, nil, nil, options).and_call_original
+
+        rephrased_text = deepl.rephrase(text, target_lang, nil, nil, options)
+        expect(rephrased_text).to be_a(DeepL::Resources::Text)
+      end
+    end
+  end
 end

data/spec/fixtures/vcr_cassettes/deepl_rephrase.yml

@@ -0,0 +1,87 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["Ih bin ei beispielsatz."]}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin22) ruby/3.2.1
+      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; charset=utf-8
+      Date:
+      - Tue, 04 Nov 2025 09:49:46 GMT
+      X-Trace-Id:
+      - 55e4d15b3b5f43d5911ddd20e43e4853
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=39, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=122
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: '{"improvements":[{"text":"Ich bin ein Beispiel.","detected_source_language":"de","target_language":"de"}]}'
+  recorded_at: Tue, 04 Nov 2025 09:49:47 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["Ih bin ei beispielsatz."],"target_lang":"DE"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin22) ruby/3.2.1
+      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; charset=utf-8
+      Date:
+      - Tue, 04 Nov 2025 09:49:47 GMT
+      X-Trace-Id:
+      - bdeb8592514b40b8a16068b3cff1a4ed
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=40, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=138
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: '{"improvements":[{"text":"Ich bin ein Beispiel.","detected_source_language":"de","target_language":"de"}]}'
+  recorded_at: Tue, 04 Nov 2025 09:49:47 GMT
+recorded_with: VCR 6.2.0

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/translate_spec.rb

@@ -366,6 +366,18 @@ describe DeepL::Requests::Translate do
       end
     end
 
+    context 'when performing a request with extra_body_parameters' do
+      it 'allows extra parameters to override standard parameters' do
+        extra_options = { extra_body_parameters: { target_lang: 'FR', debug: '1' } }
+        translate = described_class.new(api, text, source_lang, target_lang, extra_options)
+        res = translate.request
+
+        expect(res).to be_a(DeepL::Resources::Text)
+        expect(res.text).to eq('Texte modèle')
+        expect(res.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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - DeepL SE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -120,6 +120,7 @@ files:
 - spec/fixtures/vcr_cassettes/deepl_document_download.yml
 - spec/fixtures/vcr_cassettes/deepl_glossaries.yml
 - spec/fixtures/vcr_cassettes/deepl_languages.yml
+- spec/fixtures/vcr_cassettes/deepl_rephrase.yml
 - spec/fixtures/vcr_cassettes/deepl_translate.yml
 - spec/fixtures/vcr_cassettes/deepl_usage.yml
 - spec/fixtures/vcr_cassettes/glossaries.yml
@@ -168,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Official Ruby library for the DeepL language translation API.