deepl-rb 3.7.0 → 3.8.0

data/spec/spec_helper.rb

@@ -14,59 +14,29 @@ SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
 require_relative '../lib/deepl'
 require_relative 'integration_tests/integration_test_utils'
 
+# Auto-load test helpers under spec/support
+Dir[File.expand_path('support/**/*.rb', __dir__)].sort.each { |f| require f }
+
 # Lib config
 ENV['DEEPL_AUTH_KEY'] ||= 'TEST-TOKEN'
 
-# General helpers
-def build_deepl_api
-  DeepL::API.new(DeepL::Configuration.new)
-end
+RSpec.configure do |config|
+  config.include ManagedGlossary
+  config.include ManagedStyleRule
+  config.include ManagedTranslationMemory
 
-uri_ignoring_deepl_api_subdomain = lambda do |request1, request2|
-  deepl_api_regexp = %r{https?://api.*\.deepl\.com/}
-  uri1 = request1.uri
-  uri2 = request2.uri
-  uri1_match = uri1.match(deepl_api_regexp)
-  uri2_match = uri2.match(deepl_api_regexp)
-  if uri1_match && uri2_match
-    uri1_without_deepl_domain = uri1.gsub(uri1_match[0], '')
-    uri2_without_deepl_domain = uri2.gsub(uri2_match[0], '')
-    uri1_without_deepl_domain == uri2_without_deepl_domain
-  else
-    uri1 == uri2
+  config.before(:each, :mock_server_only) do
+    skip 'Only runs on mock server' unless ENV.key?('DEEPL_MOCK_SERVER_PORT')
   end
-end
-
-headers_ignoring_user_agent = lambda do |request1, request2|
-  user_agent_key = 'User-Agent'
-  # Pass by reference, so we need to use a copy of the headers
-  headers1 = request1.headers.dup
-  headers2 = request2.headers.dup
-  headers1_has_user_agent = headers1.key?(user_agent_key)
-  headers2_has_user_agent = headers2.key?(user_agent_key)
-  return false if headers1_has_user_agent != headers2_has_user_agent
 
-  headers1.delete(user_agent_key)
-  headers2.delete(user_agent_key)
-  headers1 == headers2
+  config.before(:each, :real_server_only) do
+    skip 'Only runs on real server' if ENV.key?('DEEPL_MOCK_SERVER_PORT')
+  end
 end
 
-# VCR tapes configuration
-require 'vcr'
-VCR.configure do |config|
-  config.cassette_library_dir = 'spec/fixtures/vcr_cassettes'
-  config.hook_into :webmock
-  config.filter_sensitive_data('VALID_TOKEN') { ENV.fetch('DEEPL_AUTH_KEY', nil) }
-
-  # to record new or missing VCR cassettes, call rspec like this:
-  # $ VCR_RECORD_MODE=new_episodes bundle exec rspec
-
-  record_mode = ENV['VCR_RECORD_MODE'] ? ENV['VCR_RECORD_MODE'].to_sym : :none
-  config.default_cassette_options = {
-    record: record_mode,
-    match_requests_on: [:method, uri_ignoring_deepl_api_subdomain, :body,
-                        headers_ignoring_user_agent]
-  }
+# General helpers
+def build_deepl_api
+  DeepL::API.new(DeepL::Configuration.new)
 end
 
 # Test helpers

data/spec/support/live_mock_server.rb

@@ -0,0 +1,12 @@
+# 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 file.
+# frozen_string_literal: true
+
+# Shared setup for integration specs that hit the live mock server: expose an
+# API the server rejects as unauthorized without mutating global DeepL state.
+RSpec.shared_context 'with a live mock server' do
+  let(:unauthorized_api) do
+    DeepL::API.new(DeepL::Configuration.new(auth_key: 'invalid'))
+  end
+end

data/spec/support/managed_glossary.rb

@@ -0,0 +1,17 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+module ManagedGlossary
+  def with_managed_glossary(name:, source_lang:, target_lang:, entries:, options: {})
+    glossary = DeepL.glossaries.create(name, source_lang, target_lang, entries, options)
+    yield glossary
+  ensure
+    begin
+      DeepL.glossaries.destroy(glossary.id) if glossary
+    rescue StandardError
+      nil
+    end
+  end
+end

data/spec/support/managed_style_rule.rb

@@ -0,0 +1,17 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+module ManagedStyleRule
+  def with_managed_style_rule(name:, language:, options: {})
+    style_rule = DeepL.style_rules.create(name, language, options)
+    yield style_rule
+  ensure
+    begin
+      DeepL.style_rules.destroy(style_rule.style_id) if style_rule
+    rescue StandardError
+      nil
+    end
+  end
+end

data/spec/support/managed_translation_memory.rb

@@ -0,0 +1,7 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+module ManagedTranslationMemory
+end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 3.7.0
+  version: 3.8.0
 platform: ruby
 authors:
 - DeepL SE
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-14 00:00:00.000000000 Z
+date: 2026-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -132,25 +131,24 @@ files:
 - 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
@@ -173,13 +171,19 @@ files:
 - 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/support/live_mock_server.rb
+- spec/support/managed_glossary.rb
+- spec/support/managed_style_rule.rb
+- spec/support/managed_translation_memory.rb
 homepage: https://github.com/DeepLcom/deepl-rb
 licenses:
 - MIT
@@ -188,7 +192,6 @@ metadata:
   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
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -203,8 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Official Ruby library for the DeepL language translation API.
 test_files: []

data/spec/fixtures/vcr_cassettes/deepl_document.yml

@@ -1,95 +0,0 @@
----
-http_interactions:
-- request:
-    method: post
-    uri: https://api.deepl.com/v2/document
-    body:
-      encoding: US-ASCII
-      string: ''
-    headers:
-      Authorization:
-      - DeepL-Auth-Key VALID_TOKEN
-      User-Agent:
-      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
-      Content-Type:
-      - multipart/form-data
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      Fake-Header:
-      - fake_value
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Date:
-      - Tue, 09 Jul 2024 02:02:17 GMT
-      Content-Type:
-      - application/json; charset=utf-8
-      Transfer-Encoding:
-      - chunked
-      Vary:
-      - Accept-Encoding
-      Access-Control-Allow-Origin:
-      - "*"
-      X-Trace-Id:
-      - cdde031b7a5e48d7a8c4a5a2f1b9dc6e
-      Strict-Transport-Security:
-      - max-age=63072000; includeSubDomains; preload
-      Server-Timing:
-      - l7_lb_tls;dur=100, l7_lb_idle;dur=2, l7_lb_receive;dur=0, l7_lb_total;dur=192
-      Access-Control-Expose-Headers:
-      - Server-Timing, X-Trace-ID
-    body:
-      encoding: ASCII-8BIT
-      string: '{"document_id":"9B7CB9418DCDEBF2C4C519F65A32B99F","document_key":"EA637EA43BB3F8A52A2A25B76EF3E0C72CE9CD00C881148D1236CB584CB34815"}'
-  recorded_at: Tue, 09 Jul 2024 02:02:17 GMT
-- request:
-    method: post
-    uri: https://api.deepl.com/v2/document/9B7CB9418DCDEBF2C4C519F65A32B99F
-    body:
-      encoding: UTF-8
-      string: '{"document_key":"EA637EA43BB3F8A52A2A25B76EF3E0C72CE9CD00C881148D1236CB584CB34815","param":"fake"}'
-    headers:
-      Authorization:
-      - DeepL-Auth-Key VALID_TOKEN
-      User-Agent:
-      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
-      Content-Type:
-      - application/json
-      Accept-Encoding:
-      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
-      Accept:
-      - "*/*"
-      Fake-Header:
-      - fake_value
-  response:
-    status:
-      code: 200
-      message: OK
-    headers:
-      Date:
-      - Tue, 09 Jul 2024 02:03:49 GMT
-      Content-Type:
-      - application/json; charset=utf-8
-      Transfer-Encoding:
-      - chunked
-      Vary:
-      - Accept-Encoding
-      Access-Control-Allow-Origin:
-      - "*"
-      X-Trace-Id:
-      - 73fc4be8f3964b4080f89ee686c090be
-      Strict-Transport-Security:
-      - max-age=63072000; includeSubDomains; preload
-      Server-Timing:
-      - l7_lb_tls;dur=152, l7_lb_idle;dur=9, l7_lb_receive;dur=0, l7_lb_total;dur=166
-      Access-Control-Expose-Headers:
-      - Server-Timing, X-Trace-ID
-    body:
-      encoding: ASCII-8BIT
-      string: '{"document_id":"9B7CB9418DCDEBF2C4C519F65A32B99F","status":"done","billed_characters":256}'
-  recorded_at: Tue, 09 Jul 2024 02:03:49 GMT
-recorded_with: VCR 6.2.0