deepl-rb 3.6.0 → 3.7.0

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' }]
+)
+```
 
-`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).
+#### Retrieving and listing style rules
+
+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' } }
+)
+```
+
+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')
 ```
 
-You can also pass a `StyleRule` object directly:
+#### 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 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).
 
-translation = DeepL.translate 'Hello World', 'EN', 'ES', style_rule: style_rule
+```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

data/Rakefile

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  warn e.message
+  warn 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'rake'
+require 'juwelier'
+require_relative 'lib/version'
+
+Juwelier::Tasks.new do |gem|
+  gem.name = 'deepl-rb'
+  gem.homepage = 'https://github.com/DeepLcom/deepl-rb'
+  gem.license = 'MIT'
+  gem.summary = 'Official Ruby library for the DeepL language translation API.'
+  gem.description =
+    'Official Ruby library for the DeepL language translation API (v2). ' \
+    'For more information, check this: https://www.deepl.com/docs/api-reference.html'
+  gem.version = DeepL::VERSION
+
+  gem.email = 'open-source@deepl.com'
+  gem.authors = ['DeepL SE']
+  gem.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'
+  }
+  gem.files.exclude '.bumpversion.toml'
+  gem.files.exclude '.devcontainer/**/*'
+  gem.files.exclude '.github'
+  gem.files.exclude '.circleci'
+  gem.files.exclude 'catalog-info.yaml'
+end
+
+Juwelier::RubygemsDotOrgTasks.new
+
+# Tests
+require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+desc 'Run all tests.'
+task :test do
+  Rake::Task['spec'].invoke
+  Rake::Task['rubocop'].invoke
+end
+
+task default: :test

data/SECURITY.md

@@ -0,0 +1,58 @@
+To report security concerns or vulnerabilities within deepl-rb, please email
+us at [security@deepl.com](mailto:security@deepl.com).
+
+You can send us PGP-encrypted email using the following PGP public key:
+
+```
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQINBF7WSmABEADzRUp22VY7bVfUWScKLi9o8BRSEL4u3aPn9WOQoRLQH0j3dNNQ
+FQlwTPn/Ez6qreEl8mX0aE+eLCEykXqsrU/UaTSTslF+H6UQyuGLXkRm8Lblt93I
+OEhL069fC7rm+/zJq72+hishBF8DXqa+WtFd8VfK3i211vRhU/teKeAKT0xiuN/5
+EQl1Bn7jR7mmQtNbPBhCsAlaC/tNUQ3Lyj6LYnnco7ums5Q/gCvfs2HM3mXJyvnG
+1MC2IrECPowTt04W3V1uXuMcm766orTG/AmtBIbPmOzao4sfqwRVHGvc8zcr1az9
+0nVyEJXx1eUVRDU1GAQuMjEkGgwvTd+nt6sHpn8C+9hMYJhon9veDSupViBuvNRC
+p1PnpSLYYy7tA7DPXMhP3cMXe+Z4bYzgwi3xjOwh6SDyB4OFIxtGyuMrLGfZnd6A
+hDH4H9zHPpciD5MxcOaqlKdgABQALvc6MvJ1Guf1ckGTbfHz1brtR1LPMK8rrnNu
+kwQzgkogYV6YAnt8LPXMPa2Vgy8TAiby7GPaATPeSWdNHtkuYGhWNVbnb60kEWiJ
+/RgHFZYfRT1dEcKoQEcDJ7AV14urEFIAfmhlsT8h7iJYUQMa45BakUubi3aWwcme
+ya+5WXvp2xU14VMfrscApA0e1v0VcTNVwlKambs/lwims0/xiSaXJS6gVwARAQAB
+tCNEZWVwTCBTZWN1cml0eSA8c2VjdXJpdHlAZGVlcGwuY29tPokCTgQTAQgAOBYh
+BGvTAPE3gtThLDZ9+ey96Y7yK41BBQJe1kpgAhsDBQsJCAcCBhUKCQgLAgQWAgMB
+Ah4BAheAAAoJEOy96Y7yK41BHVIP/04R08g4N32c47edY6z3sl3DAf+/6UI4Bc4S
+Jg5L4JcfrsKaDd55plps8nj31VXrxVBO0NrO6HLC50SXbYVrANyo0occ2mIoU8c2
+tNbYCUmJ3QjlUwDjHWlMV2J9FcfZkv7z+2TDY6DF8MKqCMi8j7Pnj0hlY0JytciH
+SGES1q8+//8tG9z6b6vvxBFfJI+iNXvcbn6uU1WRvGoBqq2A13fXuwTXiNNphsvu
+kHqBHSxnf/EAmcmBX0tm6yaWDdwy+rrcDNwXiqqvK6DFWEE7+/9t2FhlgzvuCOfx
+dQVMZL8WH2rr6OPQLDgtGxEUFmD+srmqbVn5NKdY6lQ/BEaraozDkuqJEb0/L/kb
+Dv+buz8rmKze0XPlrt1XTQ5ZDQp8AMAaPp1UsizVhasZgxxuUa+g5mMbJr7TSNJN
+CIqidnh1MEyIr3IccOAr2F51hn6keKIdVnO4dWrWNMTfk00dw3fPGFhNTniITTF2
+s3oJ8cy2NMNkVMP5XL3bulpgkKN+hXa4IHkTfWRv7hfYJ/3i3yTRNRjYGRoVp7eM
+iADumKaZy5Szl458txuI+p9DGAEvkSJoF7ptwedSvVZ/FZukS5mwYisRV9shzsXF
+3jpcGZ1B3qS68r9ySqnPEWR6oT8p63fpMNVMjz5r4YEbvU0A62OhUk52drLM6SgC
+mdOZcmnHuQINBF7WSmABEADc6L/wSexm4l1GWZSQpJ35ldlu7jjWQGguQeeG2900
+aEI3UcftMCWg+apwf4h4Yj2YjzUncYAM6RenGvXgZUYQe3OHb8uqpkSmYHUdB/Uq
+I4NPO3e8RMDo9YohPKCpZ7jV70X8F9GOUkUgfp29CjrMOYgSLwkSyWotsQ9KtkEH
+Sx/h+gviIERe0dkiN9lCsReNigoWLleH4qBSZGPxqF4tzANJ6D2tnAv+6KUQvho3
+CdijBiia4o16p9M0altSqsZCEX1Y5BKmWIh9fvvS2uB7SdzS0gcASzlekMGCjG10
+dNji+uSNdHExlbl0kUpEL1TuY2hxPBa6lc1hckI3dGng0jIFlio4s8DG3Utmrj3C
+KQFxnjqtO+uaJ8HdNo8ObtEp/v9TpsHWUchBTrBP4XN5KwqkljF8XVBA6ceh8H38
+7/RVWRcWp6h30ROm1DTnAGxJk02fbjpnEO0EvudxKTlnAJXV6z+Tm3yYaR4gQYa3
+/zfLZgz0z0MqNUsGephZGPzfUX7Lsz6HGUoo7I1KST6xD2QodJYOhHIEOgsqskk+
+cgeXp45X5JLlCQaBLQoL8ut6CTcop1/6U+JZtrm6DdXTZfq57sqfDI+gkG8WljRY
+yhsCL+xWiwDjtt/8kpk+W75EQmwPuctoS85Rm6hEpffewdQtb2XCEWpbta6hE1r1
+kQARAQABiQI2BBgBCAAgFiEEa9MA8TeC1OEsNn357L3pjvIrjUEFAl7WSmACGwwA
+CgkQ7L3pjvIrjUHFvg/9GnIW9SM/nYJpi1xZVWWGwQ+/kTceD50bv8kyvNaia/9m
+HG6n83xHNTRBYnt8NtTqHvW0y20Cp3gUs2WxboDgCIb3+srI2ipwiaDJcq+rVr0f
+XkCe5MryioKRbTFQ8OgvKh9GK/tYtqZakn7Q9596ajUjHOQV1+Uw/jywLYRlcbqI
+zbxyNVWitxPs3Z7jUDAvhPOIOmhLFc+QxSYrs1W4ZEGnZ3+9utqzlEiMusy9Rq0T
+/W/wrG6SckebjhrwWZJmy/hkW6V6LUX4++vCVV5+zwsvgEortCV8bhvLfqQDr/WN
+fnmbNZtXJbyhTYbcYReOLeKidxO2lZEemnX6iOt5xCdoMcYU23xDT9+tE7Eh6Nfw
+einZemBwfku5vxxPF73pOoQUCRq9tgvUrEq+3BqkqidhnFUOPi0J5726q1PBG65x
+5o+SQyvB3NA3al3mEH65z3V3/g0UHnhGcEMwVOXBkffgdKNhWYw59qhSVQnkiq0U
+MG10g/RL7VdiISAFPTDmKWUaEDYosinKqOMHwcaVdJq9ssvPf89et6yP/ZkbLIHs
+2y3oiPonh2RMxi2OedlDz+Jp/A2o3qHmwNvBx/meGB0praGUonFVZTAA1EMS39Bi
+NhG/L8giTyzA0mMkTJAPXtUVlRe5rEjORgYJsgRqZxEfpsJC9OkvYS4ayO0eCEs=
+=jVHt
+-----END PGP PUBLIC KEY BLOCK-----
+```%

data/VERSION

@@ -0,0 +1 @@
+3.7.0

data/deepl-rb.gemspec

@@ -0,0 +1,167 @@
+# Generated by juwelier
+# 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
+
+Gem::Specification.new do |s|
+  s.name = "deepl-rb".freeze
+  s.version = "3.7.0"
+
+  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.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 = [
+    "CHANGELOG.md",
+    "LICENSE.md",
+    "README.md",
+    "license_checker.sh"
+  ]
+  s.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"
+  ]
+  s.homepage = "https://github.com/DeepLcom/deepl-rb".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.4.10".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"])
+end
+

data/lib/deepl/api.rb

@@ -0,0 +1,22 @@
+# 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
+
+module DeepL
+  class API
+    attr_reader :configuration, :http_client
+
+    def initialize(configuration)
+      @configuration = configuration
+      configuration.validate!
+      uri = URI(configuration.host)
+      @http_client = Net::HTTP.new(uri.host, uri.port)
+      @http_client.use_ssl = uri.scheme == 'https'
+    end
+
+    def update_http_client(client)
+      @http_client = client
+    end
+  end
+end

data/lib/deepl/configuration.rb

@@ -0,0 +1,59 @@
+# 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
+
+module DeepL
+  class Configuration
+    ATTRIBUTES = %i[auth_key host logger max_doc_status_queries max_network_retries user_agent
+                    version].freeze
+
+    attr_accessor(*ATTRIBUTES)
+
+    DEEPL_SERVER_URL = 'https://api.deepl.com'
+    DEEPL_SERVER_URL_FREE = 'https://api-free.deepl.com'
+    private_constant :DEEPL_SERVER_URL, :DEEPL_SERVER_URL_FREE
+
+    def initialize(data = {}, app_info_name = nil, app_info_version = nil, send_platform_info = true) # rubocop:disable all
+      data.each { |key, value| send("#{key}=", value) }
+      @auth_key ||= ENV.fetch('DEEPL_AUTH_KEY', nil)
+      @host ||= ENV.fetch('DEEPL_SERVER_URL', nil)
+      @host ||= if self.class.free_account_auth_key?(@auth_key)
+                  DEEPL_SERVER_URL_FREE
+                else
+                  DEEPL_SERVER_URL
+                end
+      @version ||= 'v2'
+      @user_agent ||= construct_user_agent(send_platform_info, app_info_name, app_info_version)
+      @max_network_retries ||= 5
+      @logger ||= nil
+    end
+
+    def validate!
+      raise Exceptions::Error, 'auth_key not provided' if auth_key.nil? || auth_key.empty?
+    end
+
+    def attributes
+      ATTRIBUTES.to_h { |attr| [attr, send(attr)] }
+    end
+
+    def ==(other)
+      attributes == other.attributes
+    end
+
+    def self.free_account_auth_key?(key)
+      key&.end_with?(':fx')
+    end
+
+    def construct_user_agent(send_platform_info, app_info_name, app_info_version)
+      library_info_str = "deepl-ruby/#{DeepL::VERSION}"
+      if send_platform_info
+        library_info_str += " (#{RbConfig::CONFIG['host_os']}) ruby/#{RUBY_VERSION}"
+      end
+      if app_info_name && app_info_version
+        library_info_str += " #{app_info_name}/#{app_info_version}"
+      end
+      library_info_str
+    end
+  end
+end

data/lib/deepl/constants/base_constant.rb

@@ -0,0 +1,18 @@
+# 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.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class BaseConstant
+      def self.options
+        constants.map { |const| const_get(const) }
+      end
+
+      def self.valid?(value)
+        options.include?(value)
+      end
+    end
+  end
+end

data/lib/deepl/constants/formality.rb

@@ -0,0 +1,16 @@
+# 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.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class Formality < BaseConstant
+      DEFAULT = 'default'
+      MORE = 'more'
+      LESS = 'less'
+      PREFER_MORE = 'prefer_more'
+      PREFER_LESS = 'prefer_less'
+    end
+  end
+end

data/lib/deepl/constants/model_type.rb

@@ -0,0 +1,14 @@
+# 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.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class ModelType < BaseConstant
+      QUALITY_OPTIMIZED = 'quality_optimized'
+      PREFER_QUALITY_OPTIMIZED = 'prefer_quality_optimized'
+      LATENCY_OPTIMIZED = 'latency_optimized'
+    end
+  end
+end

data/lib/deepl/constants/split_sentences.rb

@@ -0,0 +1,14 @@
+# 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.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class SplitSentences < BaseConstant
+      NO_SPLITTING = '0'
+      SPLIT_ON_PUNCTUATION_AND_NEWLINES = '1'
+      SPLIT_ON_PUNCTUATION_ONLY = 'nonewlines'
+    end
+  end
+end

data/lib/deepl/constants/tag_handling.rb

@@ -0,0 +1,13 @@
+# 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.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class TagHandling < BaseConstant
+      XML = 'xml'
+      HTML = 'html'
+    end
+  end
+end