deepl-rb 3.7.0 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ac9df781efec35e22812fb7d998386c19dd2f51afeb020d1850c4b2091e5ba20
-  data.tar.gz: 70db2ae1bd08aa8e1dffb01198225ad29fc5c2514cf4f1a38da948bbe97c51f3
+  metadata.gz: 1e06f20b76b38eff20ef4f3f7c7863f374afe2e314438b0bc021df6c4535f991
+  data.tar.gz: 30ac12887bd80d6e81cf5c815e5bb8bc5725ea50c66edfd7f4c34c1881e5ad5d
 SHA512:
-  metadata.gz: 5c55b0eb6a6ef528eb14f78acfb89591fa99de7c7d8a82fb322e5b189c6663ff5f5f915d46ac4e93fcebc5a1d1f71bcef3d94fb1cac36d5e5fcabec9eb656cb5
-  data.tar.gz: a606b2405448a3598faf0d38e51830437d14019ab6b2cec4a794f93bc47f8329612fc524b1f2d5c71e48063ef4682a12831cada04d8b5c2a9f8ffd1f2012c3e6
+  metadata.gz: 0c5ded1350056aa468d7255ff93eb537dfcf141608a1761651530d5a1d01851bd242a1f205b14626ff8136ec103f38911731242f86e0127e00e75a6fc5c7da08
+  data.tar.gz: 570ce96a8751e4de0116b93cac78d08453df5eaf65bef669f9151b361481ab85bea83f72e8d07ffaac01c7e010d8537fd003b0ef3f762d2cc3b2c29c601bfec0

data/.gitlab-ci.yml

@@ -118,6 +118,9 @@ semgrep-sast:
 .test_base:
     stage: test
     extends: .test
+    variables:
+        VALIDATE_REQUESTS_FOR_DEEPL_MOCK: '1'
+        VALIDATE_RESPONSES_FOR_DEEPL_MOCK: '1'
     parallel:
         matrix:
           - DOCKER_IMAGE: 'ruby:2.7'
@@ -164,7 +167,6 @@ test_manual:
   rules:
     - if: $CI_PIPELINE_SOURCE != "schedule"
 
-
 # stage: publish ----------------------
 
 gitlab release:

data/CHANGELOG.md

@@ -5,6 +5,21 @@ 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]
+### Changed
+- Reworked the test suite to run against the `deepl-mock` server with OpenAPI
+  request and response validation enabled in CI, replacing recorded VCR
+  cassettes. Added live integration and error-path specs across all endpoints,
+  with resource-level unit specs for response field mapping.
+
+### Removed
+- Dropped VCR cassette playback and the `vcr` and `webmock` development
+  dependencies.
+
+## [3.8.0] - 2026-05-27
+### Added
+- Added support for passing additional HTTP headers to `translate()` and
+  `rephrase()`. This can be used to send the `X-DeepL-Reporting-Tag` header
+  for usage reporting.
 
 ## [3.7.0] - 2026-05-14
 ### Added
@@ -119,7 +134,8 @@ 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.7.0...HEAD
+[Unreleased]: https://github.com/DeepLcom/deepl-rb/compare/v3.8.0...HEAD
+[3.8.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.7.0...v3.8.0
 [3.7.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.6.1...v3.7.0
 [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

data/Gemfile

@@ -19,6 +19,4 @@ group :test do
   gem 'rubocop-rspec'
   gem 'simplecov'
   gem 'simplecov-cobertura'
-  gem 'vcr'
-  gem 'webmock'
 end

data/README.md

@@ -551,6 +551,18 @@ doc_handle = DeepL.document.upload('/path/to/spanish_document.pdf', 'ES', 'EN',
 
 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.
 
+### Sending additional HTTP headers
+
+You can pass additional HTTP headers to `translate`, `rephrase`, and the
+`document` methods. For example, to send the `X-DeepL-Reporting-Tag` header
+for usage reporting (see the [cookbook entry](https://developers.deepl.com/docs/learning-how-tos/cookbook/sending-custom-reporting-tags-from-client-libraries)):
+
+```rb
+additional_headers = { 'X-DeepL-Reporting-Tag' => 'my-tag' }
+translation = DeepL.translate 'Hello, world!', 'EN', 'DE', {}, additional_headers
+rephrased = DeepL.rephrase 'Hello, world!', 'EN', nil, nil, {}, additional_headers
+```
+
 ### Handle exceptions
 
 You can capture and process exceptions that may be raised during API calls. These are all the possible exceptions:
@@ -712,18 +724,6 @@ To run tests (rspec and rubocop), use
 bundle exec rake test
 ```
 
-### Caution: Changing VCR Tests
-
-If you need to rerecord some of the VCR tests, simply setting `record: :new_episodes` and rerunning `rspec` won't be enough in some cases, specifically around document translation (due to its statefulness) and glossaries (since a glossary ID is associated with a specific API account).
-For example, there are document translations tests that split up the `upload`, `get_status` and `download` calls into separate test cases. You need to first rerecord the `upload` call, you can do execute a single test like this (the line should be where the `it` block of the test starts):
-
-```sh
-rspec ./spec/api/deepl_spec.rb:152
-```
-
-This will return a `document_id` and a `document_key`, you will need to update the values in the `get_status` and `download` tests accordingly. You can find examples for this in the git history.
-Similarly, for the glossary tests you will need to delete the recorded HTTP requests for certain glossary IDs so that `rspec` will create the glossaries on your account instead. Feel free to reach out on our discord if you run into any trouble here.
-
 ## Acknowledgements
 
 This library was originally developed by [Daniel Herzog](mailto:info@danielherzog.es), we are grateful for his contributions. Beginning with v3.0.0, DeepL took over development and officially supports and maintains the library together with Daniel.

data/VERSION

@@ -1 +1 @@
-3.7.0
+3.8.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.7.0 ruby lib
+# stub: deepl-rb 3.8.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "3.7.0"
+  s.version = "3.8.0".freeze
 
   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 = "2026-05-14"
+  s.date = "2026-06-18"
   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 = [
@@ -105,25 +105,24 @@ Gem::Specification.new do |s|
     "spec/api/configuration_spec.rb",
     "spec/api/deepl_spec.rb",
     "spec/constants/constants_spec.rb",
-    "spec/fixtures/vcr_cassettes/deepl_document.yml",
-    "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",
-    "spec/fixtures/vcr_cassettes/languages.yml",
-    "spec/fixtures/vcr_cassettes/rephrase_texts.yml",
-    "spec/fixtures/vcr_cassettes/style_rules.yml",
-    "spec/fixtures/vcr_cassettes/style_rules_crud.yml",
-    "spec/fixtures/vcr_cassettes/translate_texts.yml",
-    "spec/fixtures/vcr_cassettes/translation_memories.yml",
-    "spec/fixtures/vcr_cassettes/usage.yml",
     "spec/integration_tests/document_api_spec.rb",
+    "spec/integration_tests/document_error_paths_spec.rb",
+    "spec/integration_tests/glossary_api_spec.rb",
+    "spec/integration_tests/glossary_error_paths_spec.rb",
     "spec/integration_tests/integration_test_utils.rb",
+    "spec/integration_tests/languages_api_spec.rb",
+    "spec/integration_tests/languages_error_paths_spec.rb",
+    "spec/integration_tests/rephrase_api_spec.rb",
+    "spec/integration_tests/rephrase_error_paths_spec.rb",
+    "spec/integration_tests/smoke_test_spec.rb",
     "spec/integration_tests/style_rule_api_spec.rb",
+    "spec/integration_tests/style_rule_error_paths_spec.rb",
+    "spec/integration_tests/translate_api_spec.rb",
+    "spec/integration_tests/translate_error_paths_spec.rb",
     "spec/integration_tests/translation_memory_api_spec.rb",
+    "spec/integration_tests/translation_memory_error_paths_spec.rb",
+    "spec/integration_tests/usage_api_spec.rb",
+    "spec/integration_tests/usage_error_paths_spec.rb",
     "spec/requests/extra_body_parameters_types_spec.rb",
     "spec/requests/glossary/create_spec.rb",
     "spec/requests/glossary/destroy_spec.rb",
@@ -146,22 +145,28 @@ Gem::Specification.new do |s|
     "spec/requests/translate_spec.rb",
     "spec/requests/translation_memory/list_spec.rb",
     "spec/requests/usage_spec.rb",
+    "spec/resources/custom_instruction_spec.rb",
     "spec/resources/glossary_spec.rb",
     "spec/resources/language_pair_spec.rb",
     "spec/resources/language_spec.rb",
+    "spec/resources/style_rule_spec.rb",
     "spec/resources/text_spec.rb",
     "spec/resources/translation_memory_spec.rb",
     "spec/resources/usage_spec.rb",
-    "spec/spec_helper.rb"
+    "spec/spec_helper.rb",
+    "spec/support/live_mock_server.rb",
+    "spec/support/managed_glossary.rb",
+    "spec/support/managed_style_rule.rb",
+    "spec/support/managed_translation_memory.rb"
   ]
   s.homepage = "https://github.com/DeepLcom/deepl-rb".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.4.10".freeze
+  s.rubygems_version = "3.6.2".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"])
-  s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
+  s.add_development_dependency(%q<juwelier>.freeze, [">= 0".freeze])
+  s.add_development_dependency(%q<byebug>.freeze, [">= 0".freeze])
 end
 

data/lib/deepl/requests/rephrase.rb

@@ -8,8 +8,9 @@ module DeepL
     class Rephrase < Base
       attr_reader :text, :target_lang, :writing_style, :tone
 
-      def initialize(api, text, target_lang = nil, writing_style = nil, tone = nil, options = {}) # rubocop:disable Metrics/ParameterLists
-        super(api, options)
+      def initialize(api, text, target_lang = nil, writing_style = nil, tone = nil, options = {}, # rubocop:disable Metrics/ParameterLists
+                     additional_headers = {})
+        super(api, options, additional_headers)
         @text = text
         @target_lang = target_lang
         @writing_style = writing_style

data/lib/deepl/requests/translate.rb

@@ -30,8 +30,8 @@ module DeepL
       attr_reader :text, :source_lang, :target_lang, :ignore_tags, :splitting_tags,
                   :non_splitting_tags, :model_type, :custom_instructions, :tag_handling_version
 
-      def initialize(api, text, source_lang, target_lang, options = {})
-        super(api, options)
+      def initialize(api, text, source_lang, target_lang, options = {}, additional_headers = {})
+        super(api, options, additional_headers)
         @text = text
         @source_lang = source_lang
         @target_lang = target_lang

data/lib/deepl.rb

@@ -100,9 +100,10 @@ module DeepL
     Requests::Languages.new(api, options).request
   end
 
-  def translate(text, source_lang, target_lang, options = {})
+  def translate(text, source_lang, target_lang, options = {}, additional_headers = {})
     configure if @configuration.nil?
-    Requests::Translate.new(api, text, source_lang, target_lang, options).request
+    Requests::Translate.new(api, text, source_lang, target_lang, options,
+                            additional_headers).request
   end
 
   def document(options = {})
@@ -125,9 +126,11 @@ module DeepL
     TranslationMemoryApi.new(api, options)
   end
 
-  def rephrase(text, target_lang = nil, writing_style = nil, tone = nil, options = {}) # rubocop:disable Metrics/ParameterLists
+  def rephrase(text, target_lang = nil, writing_style = nil, tone = nil, options = {}, # rubocop:disable Metrics/ParameterLists
+               additional_headers = {})
     configure if @configuration.nil?
-    Requests::Rephrase.new(api, text, target_lang, writing_style, tone, options).request
+    Requests::Rephrase.new(api, text, target_lang, writing_style, tone, options,
+                           additional_headers).request
   end
 
   def usage(options = {})

data/lib/version.rb

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