deepl-rb 3.6.1 → 3.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8ea8e9d6cc6601abfadddf2b0b70169a7449e71434a8b695c534789d2263d681
-  data.tar.gz: '029b836b133bbf60d9b4a8acecf90b89d969d991e793db1bf5643f5633895282'
+  metadata.gz: 1e06f20b76b38eff20ef4f3f7c7863f374afe2e314438b0bc021df6c4535f991
+  data.tar.gz: 30ac12887bd80d6e81cf5c815e5bb8bc5725ea50c66edfd7f4c34c1881e5ad5d
 SHA512:
-  metadata.gz: 83070b04ae93261b4524cb5353bdb888c2b9f5a98c9314239ed4ae8c76a53182363bb31ba31f7468a7a5d705162c09fbb69fb0f4a71bc802d8b373d97c46aeaa
-  data.tar.gz: 8ac545b8fb392b31a0e3fa00f4ed7f556bcf92304d8852226e57d099d365554c6eb5f510fe76891c329bdf89851c2bff217417f157947ffb96e41e50ef58b562
+  metadata.gz: 0c5ded1350056aa468d7255ff93eb537dfcf141608a1761651530d5a1d01851bd242a1f205b14626ff8136ec103f38911731242f86e0127e00e75a6fc5c7da08
+  data.tar.gz: 570ce96a8751e4de0116b93cac78d08453df5eaf65bef669f9151b361481ab85bea83f72e8d07ffaac01c7e010d8537fd003b0ef3f762d2cc3b2c29c601bfec0

data/.gitlab-ci.yml

@@ -57,6 +57,8 @@ package:
   image:
     name: ruby:2.7
     entrypoint: ['/builds/deepl/backend/oss-client-libs/deepl-ruby']
+  variables:
+    HOME: /tmp
   script: bundle exec rubocop
 
 rubocop_scheduled:
@@ -116,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'
@@ -162,11 +167,13 @@ test_manual:
   rules:
     - if: $CI_PIPELINE_SOURCE != "schedule"
 
-
 # stage: publish ----------------------
 
 gitlab release:
   stage: publish
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
   extends: .create_gitlab_release
+  before_script:
+    - echo "overriding default before_script..."
   rules:
     - if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'

data/CHANGELOG.md

@@ -5,6 +5,38 @@ 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
+- Added support for listing translation memories via `DeepL.translation_memories.list`.
+- Added `translation_memory` and `translation_memory_threshold` parameters to `translate()`
+  to use a translation memory during text translation. The `translation_memory` parameter
+  accepts a string ID or a `TranslationMemory` object.
+- Added support for style rules CRUD operations via `DeepL.style_rules`:
+  `create()`, `find()`, `update_name()`, `update_configured_rules()`, and `destroy()`.
+- Added support for style rule custom instruction CRUD operations via `DeepL.style_rules`:
+  `create_custom_instruction()`, `find_custom_instruction()`,
+  `update_custom_instruction()`, and `destroy_custom_instruction()`.
+  Please refer to the README for usage instructions.
+
+### Changed
+- Updated unit test to expect the `model_type_used` to now be `quality_optimized`
+- Set explicit `image` for `gitlab release` CI job to avoid missing `$HOME` issues
 
 ## [3.6.1] - 2025-12-19
 ### Fixed
@@ -102,7 +134,9 @@ 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
+[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
 [3.5.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.5.0...v3.5.1

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

@@ -191,8 +191,9 @@ The following parameters will be automatically converted:
 | `ignore_tags`         | Converts arrays to strings joining by commas
 | `formality`           | No conversion applied
 | `glossary_id`         | No conversion applied
-| `style_id`            | No conversion applied
 | `style_rule`          | No conversion applied (can be a string ID or a StyleRule object)
+| `translation_memory`  | No conversion applied (can be a string ID or a TranslationMemory object)
+| `translation_memory_threshold` | No conversion applied (integer 0-100, recommended minimum 75)
 | `context`             | No conversion applied
 | `custom_instructions` | No conversion applied
 | `tag_handling_version` | No conversion applied
@@ -329,28 +330,52 @@ Style rules allow you to customize your translations using a managed, shared lis
 of rules for style, formatting, and more. Multiple style rules can be stored with
 your account, each with a user-specified name and a uniquely-assigned ID.
 
-#### Creating and managing style rules
+#### Creating a style rule
 
-Currently style rules must be created and managed in the DeepL UI via
-https://www.deepl.com/en/custom-rules. Full CRUD functionality via the APIs will
-come shortly.
+Use `create` to create a new style rule with a name and language code. You can
+optionally provide `configured_rules` and `custom_instructions`.
 
-#### Listing all style rules
+```rb
+# Simple creation with just a name and language
+style_rule = DeepL.style_rules.create('My Style Rule', 'en')
+puts "Created: #{style_rule.name} (#{style_rule.style_id})"
+
+# Creation with configured rules and custom instructions
+style_rule = DeepL.style_rules.create(
+  'Formal English',
+  'en',
+  configured_rules: { style_and_tone: { formality: 'formal' } },
+  custom_instructions: [{ label: 'Tone', prompt: 'Always use formal language' }]
+)
+```
+
+#### Retrieving and listing style rules
 
-`style_rules.list` returns a list of `StyleRule` objects
-corresponding to all of your stored style rules. The method accepts optional
-parameters: `page` (page number for pagination, 0-indexed), `page_size` (number
-of items per page), and `detailed` (whether to include detailed configuration
-rules in the `configured_rules` property).
+Use `find` to retrieve a single style rule by ID, or `list` to list all style
+rules.
+
+`list` returns a list of `StyleRule` objects corresponding to all of your stored
+style rules. The method accepts optional parameters: `page` (page number for
+pagination, 0-indexed), `page_size` (number of items per page), and `detailed`.
+When `true`, the response includes `configured_rules` and `custom_instructions`
+for each style rule. When `false` (default), these fields are omitted for faster
+responses.
 
 ```rb
-# Get all style rules
+# Get a single style rule by ID
+style_rule = DeepL.style_rules.find('YOUR_STYLE_ID')
+puts "#{style_rule.name} (#{style_rule.language})"
+
+# List all style rules
 style_rules = DeepL.style_rules.list
 style_rules.each do |rule|
   puts "#{rule.name} (#{rule.style_id})"
 end
 
-# Get style rules with detailed configuration
+# List with pagination
+style_rules = DeepL.style_rules.list(page: 0, page_size: 10)
+
+# List with detailed configuration
 style_rules = DeepL.style_rules.list(detailed: true)
 style_rules.each do |rule|
   if rule.configured_rules
@@ -359,24 +384,130 @@ style_rules.each do |rule|
 end
 ```
 
-Created style rules can be used in the `translate` method by specifying the `style_id` option:
+#### Updating a style rule
+
+Use `update_name` to rename a style rule, and `update_configured_rules` to
+update its configured rules.
 
 ```rb
-translation = DeepL.translate 'Hello World', 'EN', 'ES', style_id: 'dca2e053-8ae5-45e6-a0d2-881156e7f4e4'
+# Update the name
+updated = DeepL.style_rules.update_name('YOUR_STYLE_ID', 'New Name')
 
-puts translation.class
-# => DeepL::Resources::Text
-puts translation.text
-# => 'Hola Mundo'
+# Update configured rules
+updated = DeepL.style_rules.update_configured_rules(
+  'YOUR_STYLE_ID',
+  { style_and_tone: { formality: 'formal' } }
+)
 ```
 
-You can also pass a `StyleRule` object directly:
+The `configured_rules` hash supports the following categories: `dates_and_times`,
+`formatting`, `numbers`, `punctuation`, `spelling_and_grammar`, `style_and_tone`,
+and `vocabulary`.
+
+#### Managing custom instructions
+
+Custom instructions allow you to add free-text prompts to a style rule. Each
+instruction has an `id`, `label`, `prompt`, and `source_language`. Use
+`create_custom_instruction`, `find_custom_instruction`,
+`update_custom_instruction`, and `destroy_custom_instruction` to manage them.
 
 ```rb
+# Create a custom instruction
+instruction = DeepL.style_rules.create_custom_instruction(
+  'YOUR_STYLE_ID', 'Formal tone', 'Always use formal language'
+)
+puts "Created instruction: #{instruction.id}"
+
+# Create with an optional source language
+instruction = DeepL.style_rules.create_custom_instruction(
+  'YOUR_STYLE_ID', 'Formal tone', 'Always use formal language', 'en'
+)
+
+# Get a custom instruction
+instruction = DeepL.style_rules.find_custom_instruction('YOUR_STYLE_ID', instruction.id)
+
+# Update a custom instruction
+updated = DeepL.style_rules.update_custom_instruction(
+  'YOUR_STYLE_ID', instruction.id, 'Updated label', 'Use very formal language'
+)
+
+# Delete a custom instruction
+DeepL.style_rules.destroy_custom_instruction('YOUR_STYLE_ID', instruction.id)
+```
+
+#### Deleting a style rule
+
+Use `destroy` to delete a style rule by ID.
+
+```rb
+DeepL.style_rules.destroy('YOUR_STYLE_ID')
+```
+
+#### Using style rules in translations
+
+Style rules can be used in the `translate` method by specifying the `style_rule` option
+with either a style rule ID string or a `StyleRule` object:
+
+```rb
+# Using a style rule ID
+translation = DeepL.translate 'Hello World', 'EN', 'ES', style_rule: 'dca2e053-8ae5-45e6-a0d2-881156e7f4e4'
+
+# Or using a StyleRule object
 style_rules = DeepL.style_rules.list
-style_rule = style_rules.first
+translation = DeepL.translate 'Hello World', 'EN', 'ES', style_rule: style_rules.first
+```
 
-translation = DeepL.translate 'Hello World', 'EN', 'ES', style_rule: style_rule
+### Translation Memories
+
+Translation memories allow you to store and reuse previously created translations.
+They can be used in text translation requests to improve consistency by matching
+against stored segments. Multiple translation memories can be stored with your
+account, each with a source language and one or more target languages.
+
+#### Uploading and managing translation memories
+
+Currently translation memories must be uploaded and managed in the DeepL UI via
+https://www.deepl.com/translation-memory. Full translation memory management via
+the API will come shortly.
+
+#### Listing translation memories
+
+`translation_memories.list` returns a list of `TranslationMemory` objects
+for your stored translation memories. The method accepts optional parameters:
+`page` (page number for pagination, 0-indexed) and `page_size` (number of items
+per page, max 25).
+
+```rb
+# List translation memories
+translation_memories = DeepL.translation_memories.list
+translation_memories.each do |tm|
+  puts "#{tm.name} (#{tm.translation_memory_id})"
+  puts "  Source: #{tm.source_language}, Targets: #{tm.target_languages.join(', ')}"
+  puts "  Segments: #{tm.segment_count}"
+end
+
+# List with pagination
+translation_memories = DeepL.translation_memories.list(page: 0, page_size: 10)
+```
+
+#### Using a translation memory in translations
+
+Pass the `translation_memory` parameter to `translate` to use a translation
+memory. You can pass either a string containing the translation memory ID, or a
+`TranslationMemory` object. Use `translation_memory_threshold` to control the
+minimum matching percentage for fuzzy matches (0-100, recommended minimum of
+75%).
+
+```rb
+# Using a translation memory ID
+translation = DeepL.translate 'Hello, world!', 'EN', 'DE',
+                              translation_memory: 'YOUR_TM_ID',
+                              translation_memory_threshold: 80
+
+# Or using a TranslationMemory object
+translation_memories = DeepL.translation_memories.list
+translation = DeepL.translate 'Hello, world!', 'EN', 'DE',
+                              translation_memory: translation_memories.first
 ```
 
 ### Monitor usage
@@ -420,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:
@@ -581,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/Rakefile

@@ -33,6 +33,8 @@ Juwelier::Tasks.new do |gem|
     'documentation_uri' => 'https://github.com/DeepLcom/deepl-rb/blob/main/README.md',
     'homepage_uri' => 'https://github.com/DeepLcom/deepl-rb'
   }
+  gem.files.exclude '.bumpversion.toml'
+  gem.files.exclude '.devcontainer/**/*'
   gem.files.exclude '.github'
   gem.files.exclude '.circleci'
   gem.files.exclude 'catalog-info.yaml'

data/VERSION

@@ -1 +1 @@
-3.6.1
+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.6.1 ruby lib
+# stub: deepl-rb 3.8.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "3.6.1"
+  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 = "2025-12-19"
+  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 = [
@@ -71,8 +71,18 @@ Gem::Specification.new do |s|
     "lib/deepl/requests/glossary/list.rb",
     "lib/deepl/requests/languages.rb",
     "lib/deepl/requests/rephrase.rb",
+    "lib/deepl/requests/style_rule/create.rb",
+    "lib/deepl/requests/style_rule/create_custom_instruction.rb",
+    "lib/deepl/requests/style_rule/destroy.rb",
+    "lib/deepl/requests/style_rule/destroy_custom_instruction.rb",
+    "lib/deepl/requests/style_rule/find.rb",
+    "lib/deepl/requests/style_rule/find_custom_instruction.rb",
     "lib/deepl/requests/style_rule/list.rb",
+    "lib/deepl/requests/style_rule/update.rb",
+    "lib/deepl/requests/style_rule/update_configured_rules.rb",
+    "lib/deepl/requests/style_rule/update_custom_instruction.rb",
     "lib/deepl/requests/translate.rb",
+    "lib/deepl/requests/translation_memory/list.rb",
     "lib/deepl/requests/usage.rb",
     "lib/deepl/resources/base.rb",
     "lib/deepl/resources/document_handle.rb",
@@ -82,8 +92,10 @@ Gem::Specification.new do |s|
     "lib/deepl/resources/language_pair.rb",
     "lib/deepl/resources/style_rule.rb",
     "lib/deepl/resources/text.rb",
+    "lib/deepl/resources/translation_memory.rb",
     "lib/deepl/resources/usage.rb",
     "lib/deepl/style_rule_api.rb",
+    "lib/deepl/translation_memory_api.rb",
     "lib/deepl/utils/backoff_timer.rb",
     "lib/deepl/utils/exception_builder.rb",
     "lib/http_client_options.rb",
@@ -93,22 +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/translate_texts.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",
@@ -118,23 +132,41 @@ Gem::Specification.new do |s|
     "spec/requests/glossary/list_spec.rb",
     "spec/requests/languages_spec.rb",
     "spec/requests/rephrase_spec.rb",
+    "spec/requests/style_rule/create_custom_instruction_spec.rb",
+    "spec/requests/style_rule/create_spec.rb",
+    "spec/requests/style_rule/destroy_custom_instruction_spec.rb",
+    "spec/requests/style_rule/destroy_spec.rb",
+    "spec/requests/style_rule/find_custom_instruction_spec.rb",
+    "spec/requests/style_rule/find_spec.rb",
+    "spec/requests/style_rule/list_spec.rb",
+    "spec/requests/style_rule/update_configured_rules_spec.rb",
+    "spec/requests/style_rule/update_custom_instruction_spec.rb",
+    "spec/requests/style_rule/update_spec.rb",
     "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.6".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/base.rb

@@ -143,6 +143,22 @@ module DeepL
         get_req
       end
 
+      def patch_request(payload)
+        apply_extra_body_parameters_to_json(payload)
+        http_headers = add_json_content_type(headers)
+        req = Net::HTTP::Patch.new(uri.path, http_headers)
+        req.body = payload.merge(options_without_extra_params).to_json
+        req
+      end
+
+      def put_request(payload)
+        apply_extra_body_parameters_to_json(payload)
+        http_headers = add_json_content_type(headers)
+        req = Net::HTTP::Put.new(uri.path, http_headers)
+        req.body = payload.merge(options_without_extra_params).to_json
+        req
+      end
+
       def delete_request
         http_headers = add_json_content_type(headers)
         del_req = Net::HTTP::Delete.new(uri.path, http_headers)

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

@@ -21,11 +21,12 @@ module DeepL
         end
 
         def request
-          input_file = File.open(input_file_path, 'rb')
-          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]))
+          File.open(input_file_path, 'rb') do |input_file|
+            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
         end
 
         def details

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/style_rule/create.rb

@@ -0,0 +1,46 @@
+# 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.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Requests
+    module StyleRule
+      class Create < Base
+        def initialize(api, name, language, options = {})
+          super(api, options)
+          @name = name
+          @language = language
+          @configured_rules = delete_option(:configured_rules)
+          @custom_instructions = delete_option(:custom_instructions)
+        end
+
+        def request
+          payload = { name: @name, language: @language }
+          payload[:configured_rules] = @configured_rules if @configured_rules
+          payload[:custom_instructions] = @custom_instructions if @custom_instructions
+          build_style_rule(*execute_request_with_retries(post_request(payload)))
+        end
+
+        def to_s
+          "POST #{uri.request_uri}"
+        end
+
+        private
+
+        def build_style_rule(request, response)
+          data = JSON.parse(response.body)
+          DeepL::Resources::StyleRule.new(data, request, response)
+        end
+
+        def uri
+          @uri ||= URI("#{host}/v3/#{path}")
+        end
+
+        def path
+          'style_rules'
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/style_rule/create_custom_instruction.rb

@@ -0,0 +1,45 @@
+# 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.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Requests
+    module StyleRule
+      class CreateCustomInstruction < Base
+        def initialize(api, style_id, label, prompt, source_language = nil, options = {})
+          super(api, options)
+          @style_id = style_id
+          @label = label
+          @prompt = prompt
+          @source_language = source_language
+        end
+
+        def request
+          payload = { label: @label, prompt: @prompt }
+          payload[:source_language] = @source_language if @source_language
+          build_custom_instruction(*execute_request_with_retries(post_request(payload)))
+        end
+
+        def to_s
+          "POST #{uri.request_uri}"
+        end
+
+        private
+
+        def build_custom_instruction(_request, response)
+          data = JSON.parse(response.body)
+          DeepL::Resources::CustomInstruction.new(data)
+        end
+
+        def uri
+          @uri ||= URI("#{host}/v3/#{path}")
+        end
+
+        def path
+          "style_rules/#{@style_id}/custom_instructions"
+        end
+      end
+    end
+  end
+end