deepl-rb 3.9.0 → 3.10.0

data/CHANGELOG.md

@@ -6,6 +6,416 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.10.0] - 2026-11-02
+TL;DR: new `DeepL::Client`, an instance-based client, and `DeepL::AdminClient` for the Admin API.
+New APIs on `DeepL::Client`: multilingual glossaries, style profiles, spoken terms and text correction.
+Read Changed and Deprecated before upgrading; no public API is removed in this release.
+
+### Added
+- Added `DeepL::Resources::DocumentTranslationStatus#done?` (the status is `done`).
+- `DeepL::Resources::DocumentHandle.new(document_id, document_key)` creates a handle from a
+  stored ID and key; the request and response arguments are now optional.
+- `DeepL::Exceptions::DocumentTranslationError` copies `http_status_code` and `should_retry?`
+  from the DeepL error it wraps.
+- `DeepL::Exceptions::Error.new` accepts the keywords `http_status_code:` and `should_retry:`.
+- Added `DeepL::Client#get_usage`, which returns the same `DeepL::Resources::Usage` as
+  `DeepL.usage`. Please refer to the README for usage instructions.
+- Added translation memories to `DeepL::Client`: `list_translation_memories(page: nil,
+  page_size: nil)`, `get_translation_memory(translation_memory)`,
+  `delete_translation_memory(translation_memory)`,
+  `list_translation_memory_segments(translation_memory, page_size: nil, page_cursor: nil,
+  filter_text: nil, filter_case_sensitive: nil)`, `create_translation_memory_import(file_name,
+  content_length, content_type: nil, display_name: nil, **options)`,
+  `upload_translation_memory_file(translation_memory_import, content, content_type: nil)`,
+  `import_translation_memory_from_filepath(input_path, display_name: nil, content_type: nil,
+  timeout_s: nil, **options)`, `create_translation_memory_export(translation_memory)`,
+  `download_translation_memory_export(job, output_path)`,
+  `export_translation_memory_to_filepath(translation_memory, output_path, timeout_s: nil)`,
+  `get_translation_memory_job(job)` and `wait_until_translation_memory_job_done(job,
+  timeout_s: nil)`. Keywords left `nil` are not sent; the delete and download methods return
+  `nil`. Please refer to the README for usage instructions. A missing input file raises
+  `ArgumentError` before any request; other local file failures raise
+  `DeepL::Exceptions::Error` with the original error as `cause`. A non-2xx response from the
+  pre-signed storage URL (upload or export download) raises `DeepL::Exceptions::Error` with
+  `http_status_code`, `should_retry?` true for 429 and 5xx.
+- `DeepL.translation_memories.import_from_filepath` accepts `content_type:`, declared in the
+  import job and sent with the upload, and `extra_body_parameters:`.
+  `DeepL.translation_memories.create_import` accepts `extra_body_parameters:`.
+- Added `DeepL::Resources::TranslationMemoryJob#done?` (the status is `completed`) and `#ok?`
+  (the status is not `failed` or `expired`, also true while the job runs). `finished?` stays
+  true for any terminal status.
+- Added style rule lists (`/v3/style_rules`) to `DeepL::Client`:
+  `get_all_style_rules(page: nil, page_size: nil, detailed: nil)`,
+  `create_style_rule(name, language, configured_rules: nil, custom_instructions: nil,
+  **options)`, `get_style_rule(style_rule)`, `update_style_rule_name(style_rule, name,
+  **options)`, `update_style_rule_configured_rules(style_rule, configured_rules, **options)`,
+  `delete_style_rule(style_rule)`, `create_style_rule_custom_instruction(style_rule, label,
+  prompt, source_language: nil, **options)`, `get_style_rule_custom_instruction(style_rule,
+  instruction_id)`, `update_style_rule_custom_instruction(style_rule, instruction_id, label,
+  prompt, source_language: nil, **options)` and
+  `delete_style_rule_custom_instruction(style_rule, instruction_id)`. Keywords left `nil` are
+  not sent; the delete methods return `nil`. Please refer to the README for usage
+  instructions.
+- The style rule operations, in `DeepL::Client` and in `DeepL.style_rules`, take a style rule
+  list as its ID or a `DeepL::Resources::StyleRule`, and a custom instruction as its ID or a
+  `DeepL::Resources::CustomInstruction`.
+- Added the language operations to `DeepL::Client`: `get_source_languages`,
+  `get_target_languages`, `get_language_resources` and `get_languages_for_resource(resource,
+  include: nil)`. `include:` takes one value or an array and is sent as one `include` query
+  parameter per value; without it none is sent. Source and target languages keep their
+  upper-case codes; `get_languages_for_resource` returns the codes as the API sends them.
+  `get_languages_for_resource` returns `DeepL::Resources::LanguageSupport` objects
+  (source/target usability, status and per-feature support); `get_language_resources` returns
+  `DeepL::Resources::LanguageResource` objects with each feature's source and/or target
+  language requirement.
+- Added `DeepL::Constants::LanguageResourceName` (`TRANSLATE_TEXT`, `TRANSLATE_DOCUMENT`,
+  `GLOSSARY`, `VOICE`, `WRITE`, `STYLE_RULES`, `TRANSLATION_MEMORY`) and
+  `DeepL::Constants::LanguageInclude` (`BETA`, `EXTERNAL`). Other strings are still accepted
+  and sent unchanged.
+- Added document translation to `DeepL::Client`: `translate_document(input_path,
+  output_path, source_lang, target_lang, timeout_s: nil, **options)`,
+  `translate_document_upload(input_path, source_lang, target_lang, **options)`,
+  `translate_document_get_status(handle)`, `translate_document_wait_until_done(handle,
+  timeout_s: nil)` and `translate_document_download(handle, output_path)`. The file name is
+  the `filename:` option. `translate_document` returns the final status and wraps every
+  failure in `DeepL::Exceptions::DocumentTranslationError`; `translate_document_wait_until_done`
+  raises `DeepL::Exceptions::Error` with the API's message when the translation fails, and both
+  raise when `timeout_s` expires. `translate_document` and `translate_document_upload` raise
+  `ArgumentError` for a missing input file before any request; `translate_document` does not
+  wrap it in `DocumentTranslationError`.
+- Added `DeepL::Exceptions::DocumentNotReadyError` (a `ServerError`), raised for HTTP 503 on a
+  document download.
+- Added `DeepL::Exceptions::DocumentTranslationError#document_handle`, the handle of the
+  uploaded document (`nil` if the upload failed).
+- Added `DeepL::Resources::DocumentTranslationStatus#ok?` (the translation has not failed) and
+  `DeepL::Constants::DocumentStatusCode` (`QUEUED`, `TRANSLATING`, `DONE`, `ERROR`).
+- Added `DeepL::Client#translate_text(text, source_lang, target_lang, **options)`. It takes
+  the options of `DeepL.translate` as keyword arguments and returns one
+  `DeepL::Resources::Text` for a string and an array for an array, also for a one-element
+  array.
+- Added `DeepL::Client#rephrase_text(text, target_lang = nil, writing_style: nil, tone: nil,
+  **options)` and `DeepL::Client#correct_text(text, target_lang = nil, **options)`. The
+  writing style and tone are keyword arguments, `extra_body_parameters:` is applied last, and
+  both return one `DeepL::Resources::Text` for a string and an array for an array, also for a
+  one-element array.
+- Added `target_language` (`String`) to `DeepL::Resources::Text` for rephrase and correct
+  results. It is `nil` for text translation results and when the response does not contain
+  it or contains an unexpected value.
+- Added the `glossary` option to text translation and document translation
+  (`DeepL.document.upload` and `translate_document`). It takes a glossary ID or a
+  `DeepL::Resources::Glossary` or `DeepL::Resources::MultilingualGlossary` object and is sent
+  as `glossary_id`.
+- Added `billed_characters` (`Integer`) and `tag_handling_version` (`String`) to
+  `DeepL::Resources::Text` for text translation results. They are `nil` when the response
+  does not contain them or contains an unexpected value.
+- Added `DeepL::Constants::TagHandlingVersion` (`V1`, `V2`) for the `tag_handling_version`
+  option.
+- Added `DeepL::Client`, a client instance that owns its configuration and HTTP connection
+  and reads no environment variables: `DeepL::Client.new(auth_key, server_url:, headers:,
+  max_retries:, timeout:, proxy:, send_platform_info:, app_info:, http_client_options:,
+  logger:)`. Its operations follow in later changes. New public types: `DeepL::Client` and
+  `DeepL::AppInfo` (`app_name`, `app_version`).
+- Added the client options `headers:` (sent with every DeepL API request; a header of the same
+  name, in any casing, replaces the library's, including `Authorization` and `User-Agent`,
+  except `Content-Type`, `Content-Length`, `Transfer-Encoding` and `Host`), `timeout:` (seconds
+  per attempt, default 10, applied to opening, reading and writing) and `proxy:` (a proxy URL,
+  also accepted as the `proxy` of `DeepL::HTTPClientOptions`; its user info never shows in
+  `inspect` output or error messages). The module configuration has `headers` and `timeout`
+  (default 60) attributes too.
+- Added `DeepL::Client.free_account_auth_key?(key)`.
+- Added `DeepL::Exceptions::ConnectionError`, raised by `DeepL::Client` and
+  `DeepL::AdminClient` for network failures without an HTTP response (DNS, connection, TLS,
+  timeout) after the retries; the original exception is its `cause`. The module-level API still
+  raises the original network errors.
+- Added `DeepL::Exceptions::ValidationError`, a `DeepL::Exceptions::Error` raised before any
+  request for an invalid glossary or spoken terms term and an unsupported `DeepL.languages`
+  `type`.
+- Added `http_status_code` (`Integer`, `nil` without a response) to
+  `DeepL::Exceptions::Error`. `RequestError#request` now returns the failed request, and the
+  message of a `RequestError` for an unmapped status contains the status and the API's
+  message instead of `Unknown error.`.
+- Added the `style_profile` option to text translation (`DeepL.translate`) and document
+  translation (`DeepL.document.upload` and `translate_document`). It takes a style profile
+  ID string or a `DeepL::Resources::StyleProfile` object and is sent as `style_profile_id`.
+- Added support for style profiles (`/v3/style_profiles`) to `DeepL::Client`:
+  `create_style_profile(name, **options)`, `list_style_profiles(page:, page_size:)`,
+  `get_style_profile(style_profile)`, `update_style_profile(style_profile, **options)` and
+  `delete_style_profile(style_profile)` (returns `nil`). A style profile links glossaries,
+  style rule lists and translation memories; it is given as its ID or a
+  `DeepL::Resources::StyleProfile`, whose ID is `style_profile_id`. The component lists
+  (`glossary_ids`, `style_rule_ids`, `translation_memory_ids`) take IDs or the
+  `Glossary`, `MultilingualGlossary`, `StyleRule` and `TranslationMemory` objects, which are
+  sent as their IDs. In create and update, keywords left `nil` are not sent; an empty string
+  clears `description` or `industry`, and an empty array unlinks all components of that
+  kind. Please refer to the README for usage instructions.
+- Added support for spoken terms collections (`/v3/spoken-terms`) to `DeepL::Client`:
+  `create_spoken_terms(name, term_lists, **options)`, `list_spoken_terms`,
+  `get_spoken_terms(spoken_terms)`, `update_spoken_terms(spoken_terms, name:, term_lists:,
+  **options)`, `delete_spoken_terms(spoken_terms)`, `get_spoken_terms_entries(spoken_terms,
+  lang)`, `replace_spoken_terms_list(spoken_terms, entries, **options)` and
+  `delete_spoken_terms_list(spoken_terms, lang)`. A collection is given as its ID or a
+  `DeepL::Resources::SpokenTerms` (`spoken_terms_id`, `name`, `creation_time`, `term_lists`);
+  the terms of a language as a `DeepL::Resources::SpokenTermsEntries` or a hash with `:lang`
+  and `:entries`. Terms are arrays of strings and are stripped and checked like glossary terms
+  before they are sent. The delete methods return `nil`. Please refer to the README for usage
+  instructions. Collection IDs are URL-encoded in the request paths. `creation_time` is a UTC
+  `Time` when the timestamp has no offset and `nil` when it is malformed.
+- Added `DeepL::AdminClient` for the Admin API. It must be created with an admin
+  API key, accepts the options of `DeepL::Client` and supports managing developer keys
+  (`create_developer_key(label: nil)`, `list_developer_keys`, `deactivate_developer_key`,
+  `rename_developer_key`, `set_developer_key_usage_limits`) and retrieving usage analytics
+  (`get_usage_analytics`, `get_custom_tag_usage_analytics`). The four methods that send a
+  body accept `extra_body_parameters:`, added to the request body last.
+  `create_developer_key` is retried only when the request was not sent (HTTP 429, DNS
+  resolution errors, refused connections and connection timeouts), and the raised error's
+  `should_retry?` is true only when the request was not sent.
+  `DeveloperKey#label`, `DeveloperKey#usage_limits`, `KeyUsage#api_key_label`,
+  `AdminUsageReport#total_usage`, `#start_date`, `#end_date` and
+  `AdminUsageBreakdown#speech_to_speech_minutes` and
+  `CustomTagUsageBreakdown#speech_to_speech_minutes` are `nil` when the response does not
+  contain them.
+  `set_developer_key_usage_limits` changes only the given limits, including
+  `speech_to_speech_milliseconds`. New public types: `DeepL::AdminClient`,
+  `DeepL::Resources::DeveloperKey`, `DeepL::Resources::DeveloperKeyUsageLimits`,
+  `DeepL::Resources::AdminUsageReport`, `DeepL::Resources::AdminUsageBreakdown`,
+  `DeepL::Resources::KeyUsage`, `DeepL::Resources::CustomTagUsageReport`,
+  `DeepL::Resources::CustomTagUsageBreakdown`, `DeepL::Resources::CustomTagUsage`,
+  `DeepL::Constants::AdminUsageGroupBy` and `DeepL::Constants::CustomTagUsageAggregateBy`.
+  The usage breakdown includes `speech_to_speech_minutes`.
+- Added support for multilingual glossaries (`/v3/glossaries`) to `DeepL::Client`:
+  `create_multilingual_glossary(name, dictionaries, **options)`,
+  `create_multilingual_glossary_from_csv(name, source_lang, target_lang, csv, **options)`,
+  `list_multilingual_glossaries`, `get_multilingual_glossary(glossary)`,
+  `update_multilingual_glossary(glossary, name: nil, dictionaries: nil, **options)` (sends
+  only the keywords given, `{}` without any), `update_multilingual_glossary_name`,
+  `update_multilingual_glossary_dictionary(glossary, dictionary, **options)`,
+  `update_multilingual_glossary_dictionary_from_csv`,
+  `replace_multilingual_glossary_dictionary(glossary, dictionary, **options)`,
+  `replace_multilingual_glossary_dictionary_from_csv`,
+  `get_multilingual_glossary_dictionary_entries(glossary, source_lang, target_lang)`,
+  `delete_multilingual_glossary_dictionary(glossary, source_lang, target_lang)` and
+  `delete_multilingual_glossary(glossary)`. A glossary is given as its ID or a
+  `DeepL::Resources::MultilingualGlossary`; the ID is URL-encoded in the request paths. A
+  dictionary is a `DeepL::Resources::MultilingualGlossaryDictionaryEntries` (`source_lang`,
+  `target_lang` and `entries`, a hash of source term to target term; constructible with
+  `.new` from a hash, source/target pairs or a TSV string) or a hash
+  with the same keys. A source term that appears twice (after stripping) or a pair that is not
+  exactly two strings raises `DeepL::Exceptions::ValidationError` before any request.
+  Entries given as a TSV string are parsed into pairs, and each term is stripped and checked
+  like terms given as pairs; a line that is not exactly two tab-separated terms raises
+  `DeepL::Exceptions::ValidationError`. CSV content is sent as given.
+  Entries given as a hash or pairs are sent as TSV, also with `entries_format: 'csv'`.
+  `get_multilingual_glossary_dictionary_entries` returns one dictionary
+  and raises `DeepL::Exceptions::NotFound` if the glossary has none for the language pair;
+  the delete methods return `nil`. `creation_time` is a UTC `Time`, `nil` when malformed.
+  Please refer to the README for usage instructions.
+- Added the `enable_watermark` option to `DeepL.document.upload` and
+  `DeepL.document.translate_document`. When `true`, the API adds a "Translated by DeepL"
+  watermark to `docx` and `pdf` output. Previously the option was silently dropped.
+- `DeepL.usage` now returns each usage type as a `DeepL::Resources::Usage::Detail` (`count`,
+  `limit`, `limit_reached?`), like the other DeepL client libraries: `character`, `document`,
+  `team_document`, and for API Pro users `api_key_character`, `speech_to_text_minutes` and
+  `speech_to_speech_minutes`. API Pro users also get `start_time` and `end_time` (as `Time`)
+  and `products` (an array of `DeepL::Resources::UsageProduct`). Fields missing from the
+  response are `nil`. The new `any_limit_reached?` checks the character, document and team
+  document limits, not the API Pro ones. `character_count`, `character_limit`,
+  `quota_exceeded?` and `to_s` are unchanged.
+
+### Changed
+- Text translation accepts a glossary without a source language: the `glossary_ids`
+  option no longer requires `source_lang`, and the API detects the source language.
+  Document translation with `glossary_ids` still requires `source_lang`.
+- Text translation now always sends `show_billed_characters: true`, so every result has
+  `billed_characters`; previously it was sent only when set.
+- Requests of the module-level API now time out after `config.timeout` seconds per attempt
+  (default 60, or the backoff interval if longer), applied to opening, reading and writing;
+  previously Net::HTTP's 60-second defaults applied and could not be set. Timeouts given in
+  `DeepL::HTTPClientOptions` still take precedence.
+- `DeepL.languages` and `DeepL.glossaries.language_pairs` now use the `GET /v3/languages`
+  endpoint instead of the deprecated `GET /v2/languages` and `GET /v2/glossary-language-pairs`
+  endpoints. Public method signatures and return types are unchanged. An unsupported `type`
+  option now raises `DeepL::Exceptions::ValidationError` before any request; previously the
+  API answered with `DeepL::Exceptions::BadRequest`.
+- Language lists returned by `DeepL.languages` and `DeepL.glossaries.language_pairs` may now
+  include additional languages that the v2 endpoints did not list.
+- `DeepL.translation_memories.export_to_filepath` now checks the output directory before
+  creating the export job and raises `Errno::ENOENT` if it does not exist; previously the same
+  error came after the export finished. `DeepL::Client#export_translation_memory_to_filepath`
+  raises `DeepL::Exceptions::Error` instead.
+- Glossary terms given as `[source, target]` pairs are now stripped of surrounding whitespace
+  before they are sent; previously they were sent as given.
+- Every 5xx reply is now retried; previously only 429 and 500 were, and 502, 503, 504 and other
+  5xx replies were raised at once.
+- Query values are now encoded per RFC 3986, with a space as `%20`; previously as `+`.
+- `DeepL.document.translate_document` and `DocumentHandle#wait_until_document_translation_finished`
+  now poll until the translation is done or failed; previously they stopped after 11 status
+  requests (about 50 seconds) and `translate_document` then downloaded the unfinished document.
+  A configured `max_doc_status_queries` still limits the requests; `translate_document` then
+  raises `DocumentTranslationError`.
+- A malformed API response (invalid JSON, missing or mistyped fields) now raises
+  `DeepL::Exceptions::Error` for every request; previously `JSON::ParserError`,
+  `NoMethodError`, `TypeError` or `KeyError`.
+- Reworked the test suite so that it no longer needs the `deepl-mock` server. The offline specs
+  assert the exact outgoing requests with WebMock, and one real-API spec per resource calls each
+  endpoint once. `webmock` and `webrick` are test dependencies again.
+
+### Deprecated
+- `DeepL::Resources::DocumentTranslationStatus#successful?`, use `#done?` instead. It prints a
+  deprecation warning once per process when Ruby's deprecation warnings are enabled
+  (`ruby -W:deprecated`) and keeps working unchanged.
+- `DeepL::Resources::Usage#character_count`, `#character_limit` and `#quota_exceeded?`, use
+  `character.count`, `character.limit` and `character.limit_reached?` (or `any_limit_reached?`)
+  instead. Each prints a deprecation warning once per process when Ruby's deprecation warnings
+  are enabled (`ruby -W:deprecated`) and keeps working unchanged. `DeepL.usage` now names
+  `DeepL::Client#get_usage` as its replacement.
+- The methods of `DeepL::TranslationMemoryApi` (`DeepL.translation_memories`), use the
+  translation memory methods of `DeepL::Client` instead (`list` is
+  `list_translation_memories`, `find` is `get_translation_memory`, `segments` is
+  `list_translation_memory_segments`, `find_job` is `get_translation_memory_job`, and so on).
+  They keep working unchanged.
+- The methods of `DeepL::StyleRuleApi` (`DeepL.style_rules`), use the style rule methods of
+  `DeepL::Client` instead (`list` is `get_all_style_rules`, `find` is `get_style_rule`,
+  `update_name` is `update_style_rule_name`, `destroy` is `delete_style_rule`, and so on).
+  They keep working unchanged.
+- `DeepL::Exceptions::NotSupported` is deprecated: only the module-level API raises it, from
+  `DeepL::Resources::Language#supports_formality?` for a source language of `DeepL.languages`;
+  for a source language from `DeepL::Client`, `supports_formality?` returns `nil`. Creating one
+  prints a deprecation warning once per process when Ruby's deprecation warnings are enabled
+  (`ruby -W:deprecated`).
+- The module-level API is deprecated in favour of `DeepL::Client` and will be removed in the
+  next major version: `DeepL.configure`, `DeepL.configuration`, `DeepL.api`, `DeepL.translate`,
+  `DeepL.rephrase`, `DeepL.usage`, `DeepL.languages`, `DeepL.document`, `DeepL.glossaries`,
+  `DeepL.style_rules`,
+  `DeepL.translation_memories`, `DeepL.with_session` and `DeepL.http_client`. Each prints a
+  deprecation warning once per process when Ruby's deprecation warnings are enabled
+  (`ruby -W:deprecated`) and keeps working unchanged.
+- `DeepL::Configuration#version=` (the API version is part of each endpoint).
+- The `glossary_id` option of text and document translation, use `glossary` instead. It prints a
+  deprecation warning once per process when Ruby's deprecation warnings are enabled
+  (`ruby -W:deprecated`) and keeps working unchanged.
+- `DeepL::Resources::DocumentHandle#wait_until_document_translation_finished`, use
+  `DeepL::Client#translate_document_wait_until_done` instead.
+- `DeepL::Configuration#max_doc_status_queries=`, use the `timeout_s:` of
+  `DeepL::Client#translate_document` or `translate_document_wait_until_done` instead.
+
+### Fixed
+- The README's module-level examples for turning off platform information and for setting app
+  information called `DeepL.configure` with arguments, which raises `ArgumentError`. They now
+  use the block form.
+- `get_usage` (and `DeepL.usage`), the glossary and multilingual glossary get, list, entries
+  and delete requests, and the style rule and custom instruction get and delete requests sent a
+  JSON body `{}` with `Content-Type: application/json`. GET and DELETE requests are now sent
+  without a body.
+- A response body shorter than its `Content-Length` (the connection closed mid-body) was
+  returned as complete: `translate_document_download` wrote a truncated document, and JSON
+  calls raised a generic "Unexpected response" error. It is now retried like a reset
+  connection and, after the last retry, raises `DeepL::Exceptions::ConnectionError` with
+  `should_retry?` true (`DeepL::Client`, `DeepL::AdminClient`) or the original `EOFError`
+  (module-level API).
+- An HTTPS proxy that refuses the `CONNECT` request (for example with 407 Proxy Authentication
+  Required) raised a raw `Net::HTTPClientException` or `Net::HTTPFatalError`. It now raises
+  `DeepL::Exceptions::ConnectionError` with `should_retry?` false (`DeepL::Client`,
+  `DeepL::AdminClient`) or the original proxy error (module-level API), without retrying.
+- Net::HTTP re-sent a failed GET, PUT or DELETE request once on its own, so with
+  `max_retries: 0` such a request could still be sent twice. The library's connections now
+  disable Net::HTTP's own retry; only `max_retries:` applies.
+- TLS failures (including certificate verification failures) and malformed HTTP responses were
+  retried like transient network failures. They are now raised at once, as
+  `DeepL::Exceptions::ConnectionError` with `should_retry?` false (`DeepL::Client`,
+  `DeepL::AdminClient`) or as the original TLS or protocol error (module-level API).
+- `DeepL.document.translate_document` raised `NoMethodError` when the output file already
+  exists. It now raises `DeepL::Exceptions::DocumentTranslationError` (without a document
+  handle); the file is kept and nothing is uploaded, as in `DeepL::Client#translate_document`.
+  The doc comment of `DeepL.document.translate_document` no longer claims that an
+  existing file is overwritten.
+- `wait_until_translation_memory_job_done` (and the file helpers) could wait up to five seconds
+  past `timeout_s`; the last wait is now cut to the deadline.
+- Uploads to and downloads from the pre-signed translation memory storage URLs ignored the
+  proxy, SSL verification, certificate file and timeouts set with `proxy:` or
+  `http_client_options:` (or `DeepL.with_session`). They now use the same options as the API
+  connection, still without the `Authorization` header.
+- A malformed timestamp in a translation memory, segment, import or job response raised a raw
+  `ArgumentError`, and a timestamp without a zone offset was read as local time. A malformed
+  timestamp is now `nil`, and one without an offset is read as UTC.
+- `DeepL.translation_memories.list` and `segments` sent an option set to `nil` as an empty
+  query parameter (`page=`). Such options are no longer sent.
+- Translation memory and job IDs were inserted into the request path without URL encoding:
+  an ID containing `/` changed the path and a space raised `URI::InvalidURIError`. They are
+  now URL-encoded.
+- Style rule list and custom instruction IDs were inserted into the request path without
+  URL encoding: an ID containing `/` changed the path and a space raised
+  `URI::InvalidURIError`. They are now URL-encoded.
+- A malformed `creation_time` or `updated_time` of a style rule list raised a raw
+  `ArgumentError`. It now raises `DeepL::Exceptions::Error`.
+- Creating a style rule list removed `configured_rules` and `custom_instructions` from the
+  options hash passed in, so reusing the hash for another create sent neither. The hash is no
+  longer changed.
+- Downloaded documents were written in text mode, which converted newlines on Windows and
+  failed or transcoded the bytes when `Encoding.default_internal` was set. They are now
+  written in binary mode.
+- Document IDs are now URL-encoded in the status and download paths.
+- Text translation sent options set to `nil`, and a `nil` source language, as JSON `null`.
+  They are now treated as unset and not sent.
+- `translation_memory: nil` sent an empty `translation_memory_id`, and
+  `translation_memory_threshold: nil` sent `null` (text) or an empty field (documents). Both
+  are now treated as unset and not sent.
+- Document translation (`DeepL.document.upload` and `translate_document`) treated an option
+  set to `nil` as set: `glossary_ids` with `glossary_id: nil` raised `ArgumentError`. Options
+  set to `nil` are now treated as unset and not sent, as in text translation.
+- A `custom_instructions` string was split at commas into several instructions. It is now
+  sent as one instruction.
+- `DeepL.configure { |c| c.auth_key = '...:fx' }` kept `https://api.deepl.com`, because the
+  default server was chosen before the block set the key. Without a configured host, the
+  server is now chosen from the final key.
+- A Free key with surrounding whitespace (`'abc:fx '`) selected `https://api.deepl.com`
+  although the trimmed key was sent. The Free check now trims the key too.
+- The auth key was sent with surrounding whitespace, and a whitespace-only key passed
+  `DeepL.configure`. The key is now trimmed, and a blank key raises
+  `DeepL::Exceptions::Error`.
+- Refused or reset connections and `EOFError` were not retried. They are now
+  retried like timeouts and DNS failures. `AdminClient#create_developer_key` also retries a
+  refused connection, which shows that the request was not sent.
+- A 400 or 404 reply with a JSON array body raised `TypeError` when its message was read.
+- `extra_body_parameters` were overridden by options of the same name, and a string key next
+  to the SDK's symbol key sent the field twice. They are now applied last and replace the
+  SDK's field.
+- `DeepL.with_session` turned TLS off (instead of certificate verification) when
+  `enable_ssl_verification` was `false`, turned it on for `http://` hosts, and used a proxy
+  with only an address. It now builds its connection like `DeepL::AdminClient`.
+- `DeepL.with_session` opened its connection with Net::HTTP's 60 second open timeout. It now
+  uses the configured `timeout` unless the HTTP client options set `open_timeout`.
+- `DocumentHandle#wait_until_document_translation_finished` polled through the module
+  configuration instead of the connection that created the handle.
+- `DeepL::Configuration#inspect` showed the auth key. It now shows `[REDACTED]`.
+- Glossary entries given as `[source, target]` pairs (`DeepL.glossaries.create`) were sent
+  unchecked, so a term with a tab or newline
+  silently corrupted the entries. An invalid term now raises
+  `DeepL::Exceptions::ValidationError` before any request: after stripping, it must not be empty
+  or contain C0 or C1 control characters, U+2028 or U+2029. Entries given as a TSV or CSV string
+  are still sent as given.
+- Debug logging no longer includes the auth key in the logged request headers.
+- Network errors (timeouts, `SocketError`) were retried without limit. They are now retried at
+  most `max_network_retries` times, like 429 and 500 replies, and then raised.
+- `DeepL.with_session` without client options raised `ArgumentError`, and without a block raised
+  `NoMethodError`. It now runs with default options and raises `ArgumentError` without a block.
+  `HTTPClientOptions.new` now defaults `proxy` to `{}` and `cert_path` to `nil`, so the README
+  example `HTTPClientOptions.new({ 'proxy_addr' => ..., 'proxy_port' => ... })` works.
+- `DeepL.with_session` left its HTTP client, including the proxy, in place after the block, so
+  every later call went through a closed client and the proxy. It now restores the previous
+  client when the block ends or raises.
+- A failed `translate_document` raised `NameError` instead of
+  `DeepL::Exceptions::DocumentTranslationError` when nothing else had loaded `fileutils`. The
+  library now requires it.
+- An option set to `false` with a string key (for example `'split_sentences' => false`) was read as
+  unset, so its conversion was skipped and `false` was sent instead of the API value `'0'`.
+- Document translation (`DeepL.document.upload` and `translate_document`) with source language
+  `nil` raised `TypeError` before sending the request. It now omits `source_lang`, so the API
+  detects the language of the document.
+- `style_rule: nil` sent an empty `style_id` in text and document translation. A `nil` style rule
+  is now treated as unset and sends nothing.
+- `DeepL.rephrase` returned fewer results than texts, or `nil` for a string, when the response
+  contained fewer improvements than texts. It now raises `DeepL::Exceptions::Error`.
+
 ## [3.9.0] - 2026-08-11
 ### Added
 - Added support for using multiple glossaries in text and document translation
@@ -103,7 +513,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### 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!
+  * Thanks to [341bms](https://github.com/341bms) in [#14](https://github.com/DeepL/deepl-rb/issues/14) for the report!
 
 ## [3.2.0] - 2025-01-15
 ### Added
@@ -155,20 +565,21 @@ 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.9.0...HEAD
-[3.9.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.8.0...v3.9.0
-[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
-[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
-[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/releases/tag/v2.5.3
+[Unreleased]: https://github.com/DeepL/deepl-rb/compare/v3.10.0...HEAD
+[3.10.0]: https://github.com/DeepL/deepl-rb/compare/v3.9.0...v3.10.0
+[3.9.0]: https://github.com/DeepL/deepl-rb/compare/v3.8.0...v3.9.0
+[3.8.0]: https://github.com/DeepL/deepl-rb/compare/v3.7.0...v3.8.0
+[3.7.0]: https://github.com/DeepL/deepl-rb/compare/v3.6.1...v3.7.0
+[3.6.1]: https://github.com/DeepL/deepl-rb/compare/v3.6.0...v3.6.1
+[3.6.0]: https://github.com/DeepL/deepl-rb/compare/v3.5.1...v3.6.0
+[3.5.1]: https://github.com/DeepL/deepl-rb/compare/v3.5.0...v3.5.1
+[3.5.0]: https://github.com/DeepL/deepl-rb/compare/v3.4.1...v3.5.0
+[3.4.1]: https://github.com/DeepL/deepl-rb/compare/v3.4.0...v3.4.1
+[3.4.0]: https://github.com/DeepL/deepl-rb/compare/v3.3.0...v3.4.0
+[3.3.0]: https://github.com/DeepL/deepl-rb/compare/v3.2.0...v3.3.0
+[3.2.0]: https://github.com/DeepL/deepl-rb/compare/v3.1.0...v3.2.0
+[3.1.0]: https://github.com/DeepL/deepl-rb/compare/v3.0.2...v3.1.0
+[3.0.2]: https://github.com/DeepL/deepl-rb/compare/v3.0.1...v3.0.2
+[3.0.1]: https://github.com/DeepL/deepl-rb/compare/v3.0.0...v3.0.1
+[3.0.0]: https://github.com/DeepL/deepl-rb/compare/v2.5.3...v3.0.0
+[2.5.3]: https://github.com/DeepL/deepl-rb/releases/tag/v2.5.3

data/Gemfile

@@ -5,6 +5,8 @@ source 'https://rubygems.org'
 group :development do
   # Gem management
   gem 'juwelier'
+  # juwelier 2.4.9 calls Git::Repository#lib, which git 6 removed
+  gem 'git', '< 6'
 end
 
 group :test, :development do
@@ -19,4 +21,6 @@ group :test do
   gem 'rubocop-rspec'
   gem 'simplecov'
   gem 'simplecov-cobertura'
+  gem 'webmock', '~> 3.34'
+  gem 'webrick'
 end