deepl-rb 3.6.0 → 3.7.0

data/spec/resources/glossary_spec.rb

@@ -0,0 +1,38 @@
+# Copyright 2022 Daniel Herzog
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::Resources::Glossary do
+  subject(:glossary) do
+    described_class.new({
+                          'glossary_id' => 'def3a26b-3e84-45b3-84ae-0c0aaf3525f7',
+                          'name' => 'Mein Glossar',
+                          'ready' => true,
+                          'source_lang' => 'EN',
+                          'target_lang' => 'DE',
+                          'creation_time' => '2021-08-03T14:16:18.329Z',
+                          'entry_count' => 1
+                        }, nil, nil)
+  end
+
+  describe '#initialize' do
+    context 'when building a basic object' do
+      it 'creates a resource' do
+        expect(glossary).to be_a(described_class)
+      end
+
+      it 'assigns the attributes' do
+        expect(glossary.id).to eq('def3a26b-3e84-45b3-84ae-0c0aaf3525f7')
+        expect(glossary.name).to eq('Mein Glossar')
+        expect(glossary.ready).to be(true)
+        expect(glossary.source_lang).to eq('EN')
+        expect(glossary.target_lang).to eq('DE')
+        expect(glossary.creation_time).to eq('2021-08-03T14:16:18.329Z')
+        expect(glossary.entry_count).to eq(1)
+      end
+    end
+  end
+end

data/spec/resources/language_pair_spec.rb

@@ -0,0 +1,23 @@
+# Copyright 2022 Daniel Herzog
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::Resources::LanguagePair do
+  subject(:language_pair) { described_class.new('en', 'de', nil, nil) }
+
+  describe '#initialize' do
+    context 'when building a basic object' do
+      it 'creates a resource' do
+        expect(language_pair).to be_a(described_class)
+      end
+
+      it 'assigns the attributes' do
+        expect(language_pair.source_lang).to eq('en')
+        expect(language_pair.target_lang).to eq('de')
+      end
+    end
+  end
+end

data/spec/resources/language_spec.rb

@@ -0,0 +1,45 @@
+# Copyright 2021 Daniel Herzog
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::Resources::Language do
+  subject(:language) { described_class.new('EN', 'English', nil, nil, nil) }
+
+  describe '#initialize' do
+    context 'when building a basic object' do
+      it 'creates a resource' do
+        expect(language).to be_a(described_class)
+      end
+
+      it 'assigns the attributes' do
+        expect(language.code).to eq('EN')
+        expect(language.name).to eq('English')
+      end
+
+      it 'does not define the supports formality method' do
+        expect { language.supports_formality? }.to raise_error(DeepL::Exceptions::NotSupported)
+      end
+    end
+
+    context 'when building a target language object' do
+      subject(:language) { described_class.new('EN', 'English', true, nil, nil) }
+
+      it 'creates a resource' do
+        expect(language).to be_a(described_class)
+      end
+
+      it 'assigns the attributes' do
+        expect(language.code).to eq('EN')
+        expect(language.name).to eq('English')
+      end
+
+      it 'includes the supports formality method' do
+        expect { language.supports_formality? }.not_to raise_error
+        expect(language).to be_supports_formality
+      end
+    end
+  end
+end

data/spec/resources/text_spec.rb

@@ -0,0 +1,23 @@
+# Copyright 2018 Daniel Herzog
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::Resources::Text do
+  subject(:text) { described_class.new('Target', 'es', nil, nil, nil) }
+
+  describe '#initialize' do
+    context 'when building a basic object' do
+      it 'creates a resource' do
+        expect(text).to be_a(described_class)
+      end
+
+      it 'assigns the attributes' do
+        expect(text.text).to eq('Target')
+        expect(text.detected_source_language).to eq('es')
+      end
+    end
+  end
+end

data/spec/resources/translation_memory_spec.rb

@@ -0,0 +1,35 @@
+# 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
+
+require 'spec_helper'
+
+describe DeepL::Resources::TranslationMemory do
+  subject(:translation_memory) do
+    described_class.new({
+                          'translation_memory_id' => 'a74d88fb-ed2a-4943-a664-a4512398b994',
+                          'name' => 'Legal',
+                          'source_language' => 'en',
+                          'target_languages' => %w[es de],
+                          'segment_count' => 3542
+                        }, nil, nil)
+  end
+
+  describe '#initialize' do
+    context 'when building a basic object' do
+      it 'creates a resource' do
+        expect(translation_memory).to be_a(described_class)
+      end
+
+      it 'assigns the attributes' do
+        expect(translation_memory.translation_memory_id)
+          .to eq('a74d88fb-ed2a-4943-a664-a4512398b994')
+        expect(translation_memory.name).to eq('Legal')
+        expect(translation_memory.source_language).to eq('en')
+        expect(translation_memory.target_languages).to eq(%w[es de])
+        expect(translation_memory.segment_count).to eq(3542)
+      end
+    end
+  end
+end

data/spec/resources/usage_spec.rb

@@ -0,0 +1,35 @@
+# Copyright 2018 Daniel Herzog
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::Resources::Usage do
+  subject(:usage) { described_class.new(3, 5, nil, nil) }
+
+  describe '#initialize' do
+    context 'when building a basic object' do
+      it 'creates a resource' do
+        expect(usage).to be_a(described_class)
+      end
+
+      it 'assigns the attributes' do
+        expect(usage.character_count).to eq(3)
+        expect(usage.character_limit).to eq(5)
+      end
+
+      it 'does not exceed the quota' do
+        expect(usage).not_to be_quota_exceeded
+      end
+    end
+
+    context 'when building a quota exceeded object' do
+      subject(:usage) { described_class.new(5, 5, nil, nil) }
+
+      it 'exceeds the quota' do
+        expect(usage).to be_quota_exceeded
+      end
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,92 @@
+# Copyright 2018 Daniel Herzog
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+# Coverage
+require 'simplecov'
+SimpleCov.start
+
+require 'simplecov-cobertura'
+SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+
+# Load lib
+require_relative '../lib/deepl'
+require_relative 'integration_tests/integration_test_utils'
+
+# Lib config
+ENV['DEEPL_AUTH_KEY'] ||= 'TEST-TOKEN'
+
+# General helpers
+def build_deepl_api
+  DeepL::API.new(DeepL::Configuration.new)
+end
+
+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
+  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
+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]
+  }
+end
+
+# Test helpers
+
+def replace_env_preserving_deepl_vars
+  env_auth_key = ENV.fetch('DEEPL_AUTH_KEY', false)
+  env_server_url = ENV.fetch('DEEPL_SERVER_URL', false)
+  env_mock_server_port = ENV.fetch('DEEPL_MOCK_SERVER_PORT', false)
+  tmp_env = ENV.to_hash
+  ENV.clear
+  ENV['DEEPL_AUTH_KEY'] = (env_auth_key || 'VALID')
+  ENV['DEEPL_SERVER_URL'] = (env_server_url || '')
+  ENV['DEEPL_MOCK_SERVER_PORT'] = (env_mock_server_port || '')
+  tmp_env
+end
+
+def replace_env_preserving_deepl_vars_except_mock_server
+  env_auth_key = ENV.fetch('DEEPL_AUTH_KEY', false)
+  tmp_env = ENV.to_hash
+  ENV.clear
+  ENV['DEEPL_AUTH_KEY'] = (env_auth_key || 'VALID')
+  tmp_env
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 3.6.0
+  version: 3.7.0
 platform: ruby
 authors:
 - DeepL SE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-18 00:00:00.000000000 Z
+date: 2026-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -49,10 +49,137 @@ extra_rdoc_files:
 - README.md
 - license_checker.sh
 files:
+- ".circleci/config.yml"
+- ".github/workflows/add_issues_to_kanban.yml"
+- ".gitlab-ci.yml"
+- ".rubocop.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- CONTRIBUTING.md
+- Gemfile
 - LICENSE.md
 - README.md
+- Rakefile
+- SECURITY.md
+- VERSION
+- deepl-rb.gemspec
+- lib/deepl.rb
+- lib/deepl/api.rb
+- lib/deepl/configuration.rb
+- lib/deepl/constants/base_constant.rb
+- lib/deepl/constants/formality.rb
+- lib/deepl/constants/model_type.rb
+- lib/deepl/constants/split_sentences.rb
+- lib/deepl/constants/tag_handling.rb
+- lib/deepl/constants/tone.rb
+- lib/deepl/constants/writing_style.rb
+- lib/deepl/document_api.rb
+- lib/deepl/exceptions/authorization_failed.rb
+- lib/deepl/exceptions/bad_request.rb
+- lib/deepl/exceptions/document_translation_error.rb
+- lib/deepl/exceptions/error.rb
+- lib/deepl/exceptions/limit_exceeded.rb
+- lib/deepl/exceptions/not_found.rb
+- lib/deepl/exceptions/not_supported.rb
+- lib/deepl/exceptions/quota_exceeded.rb
+- lib/deepl/exceptions/request_entity_too_large.rb
+- lib/deepl/exceptions/request_error.rb
+- lib/deepl/exceptions/server_error.rb
+- lib/deepl/glossary_api.rb
+- lib/deepl/requests/base.rb
+- lib/deepl/requests/document/download.rb
+- lib/deepl/requests/document/get_status.rb
+- lib/deepl/requests/document/upload.rb
+- lib/deepl/requests/glossary/create.rb
+- lib/deepl/requests/glossary/destroy.rb
+- lib/deepl/requests/glossary/entries.rb
+- lib/deepl/requests/glossary/find.rb
+- lib/deepl/requests/glossary/language_pairs.rb
+- 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
+- lib/deepl/resources/document_translation_status.rb
+- lib/deepl/resources/glossary.rb
+- lib/deepl/resources/language.rb
+- 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
+- lib/version.rb
 - license_checker.sh
+- spec/api/api_spec.rb
+- 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/integration_test_utils.rb
+- spec/integration_tests/style_rule_api_spec.rb
+- spec/integration_tests/translation_memory_api_spec.rb
+- spec/requests/extra_body_parameters_types_spec.rb
+- spec/requests/glossary/create_spec.rb
+- spec/requests/glossary/destroy_spec.rb
+- spec/requests/glossary/entries_spec.rb
+- spec/requests/glossary/find_spec.rb
+- spec/requests/glossary/language_pairs_spec.rb
+- 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/glossary_spec.rb
+- spec/resources/language_pair_spec.rb
+- spec/resources/language_spec.rb
+- spec/resources/text_spec.rb
+- spec/resources/translation_memory_spec.rb
+- spec/resources/usage_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/DeepLcom/deepl-rb
 licenses:
 - MIT
@@ -76,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Official Ruby library for the DeepL language translation API.