deepl-rb 3.5.1 → 3.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a72aff32a39743d19e811efa5a3e9d5687b90c0f3f06e1545b3746143a7478b7
-  data.tar.gz: 02b0f280c59a81c24771a2c2d4248d9fb4d32bcb3a635dc9e8a0a8cf6ce8db71
+  metadata.gz: 5778d1b4102e5d798b157de8dcaeecd069d55f0f333eb190e510eb6b0593df9f
+  data.tar.gz: 117d03157edd90e2da5e6064f5d9c4b8c0ede6beddd009b7016b48d0e2673e19
 SHA512:
-  metadata.gz: c292502b6e5c35a73f79ddacbe7f44ea2c1ba51d12eb137a795e44f6f10c56f397277eea272faf193a4fb14c6f639fe597c0c066feca1cce03ad5584cf2d3224
-  data.tar.gz: 31f9cfdd8e9f762f30ff37e5de3aa3466527330e14aa6378d0c1bc2454c9f78249a74546998bfbf90ba56ef46e77fe4c09885cc82d489db615ab7a2ff89f3f7e
+  metadata.gz: e0b437203711dabb1b30f20a04964d940f17b5e85e41559436ea46dea5a2e093600122c58b15b486e81062831bb12534a146820b8cca69fd262710b8757caab1
+  data.tar.gz: c581a473d282486dcd516eacb8a20996302806bf0a40cf4e34467e11ea0f4445660a938addd64f60be5e01b05e32e17d54e3fdea542c14f23ee6b203fd789391

data/CHANGELOG.md

@@ -4,9 +4,11 @@ All notable changes to this project will be documented in this file.
 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).
 
-## [3.5.1] - 2025-12-19
-### Fixed
-- Fixed broken 3.5.0 release
+## [Unreleased]
+
+## [3.6.0] - 2025-12-10
+### Added
+- Added `tag_handling_version` parameter to `translate()` to specify which version of the tag handling algorithm to use. Options are `v1` and `v2`.
 
 ## [3.5.0] - 2025-12-03
 ### Added
@@ -84,7 +86,8 @@ The change in major version is only due to the change in maintainership, there i
 ### Fixed
 - Make RequestEntityTooLarge error message more clear
 
-[3.5.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.5.0...v3.5.1
+[Unreleased]: https://github.com/DeepLcom/deepl-rb/compare/v3.6.0...HEAD
+[3.6.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.5.0...v3.6.0
 [3.5.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.4.0...v3.5.0
 [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

data/README.md

@@ -127,6 +127,18 @@ puts translation.text
 # => "<p>Una muestra</p>"
 ```
 
+To specify which version of the tag handling algorithm to use, you can use the `tag_handling_version` parameter:
+
+```rb
+translation = DeepL.translate '<p>A sample</p>', 'EN', 'ES',
+                              tag_handling: 'xml', tag_handling_version: 'v2'
+
+puts translation.text
+# => "<p>Una muestra</p>"
+```
+
+The available values are `'v1'` and `'v2'`.
+
 To translate with context, simply supply the `context` parameter:
 
 ```rb
@@ -183,6 +195,7 @@ The following parameters will be automatically converted:
 | `style_rule`          | No conversion applied (can be a string ID or a StyleRule object)
 | `context`             | No conversion applied
 | `custom_instructions` | No conversion applied
+| `tag_handling_version` | No conversion applied
 | `extra_body_parameters` | Hash of extra parameters to pass in the body of the HTTP request. Can be used to access beta features, or to override built-in parameters for testing purposes. Extra parameters can override keys explicitly set by the client.
 
 ### Rephrase Text

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 3.5.1
+  version: 3.6.0
 platform: ruby
 authors:
 - DeepL SE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-19 00:00:00.000000000 Z
+date: 2025-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -49,109 +49,10 @@ 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/list.rb
-- lib/deepl/requests/translate.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/usage.rb
-- lib/deepl/style_rule_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/translate_texts.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/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/translate_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/usage_spec.rb
-- spec/spec_helper.rb
 homepage: https://github.com/DeepLcom/deepl-rb
 licenses:
 - MIT

data/.circleci/config.yml

@@ -1,27 +0,0 @@
-version: 2
-jobs:
-  build:
-    working_directory: ~/deepl-rb
-    docker:
-    - image: circleci/ruby:2.7
-    steps:
-    - checkout
-
-    - run:
-        name: Bundle Install
-        command: bundle install --path vendor/bundle
-
-    # Run rspec
-    - type: shell
-      command: |
-        bundle exec rspec $(circleci tests glob "spec/**/*_spec.rb" |
-                            circleci tests split --split-by=timings)
-
-    # Run rubocop
-    - type: shell
-      command: |
-        bundle exec rubocop
-
-    # Save test results for timing analysis
-    - store_test_results:
-        path: test_results

data/.github/workflows/add_issues_to_kanban.yml

@@ -1,16 +0,0 @@
-name: Add bugs to bugs project
-
-on:
-  issues:
-    types:
-      - opened
-
-jobs:
-  add-to-project:
-    name: Add issue to project
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/add-to-project@v0.5.0
-        with:
-          project-url: https://github.com/orgs/DeepLcom/projects/1
-          github-token: ${{ secrets.ADD_TO_PROJECT_PAT }}

data/.gitlab-ci.yml

@@ -1,172 +0,0 @@
-# Note: This GitLab CI configuration is used for internal testing, users can ignore it.
-include:
-  - template: Security/SAST.gitlab-ci.yml
-  - project: '${CI_PROJECT_NAMESPACE}/ci-libs-for-client-libraries'
-    file:
-      - '/${CI_PROJECT_NAME}/.gitlab-ci.yml'
-  - project: 'deepl/ops/ci-cd-infrastructure/gitlab-ci-lib'
-    file:
-      - '/templates/.buildkit.yml'
-      - '/templates/.secret-detection.yml'
-      - '/templates/.gitlab-release.yml'
-
-# Global --------------------------
-
-workflow:
-  rules:
-    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
-    - if: $CI_COMMIT_TAG
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-
-variables:
-  GITLAB_ADVANCED_SAST_ENABLED: 'true'
-
-stages:
-  - install
-  - check
-  - test
-  - publish # Only for internal tracking
-
-
-before_script:
-  - ruby --version
-  - bundle install
-
-# stage: install ----------------------
-
-package:
-  stage: install
-  parallel:
-      matrix:
-          - DOCKER_IMAGE: 'ruby:2.7'
-          - DOCKER_IMAGE: 'ruby:3.2'
-          - DOCKER_IMAGE: 'ruby:3.3'
-  image:
-    name: ${DOCKER_IMAGE}
-    entrypoint: ['/builds/deepl/backend/oss-client-libs/deepl-ruby']
-  script:
-    - bundle exec rake build
-  artifacts:
-    paths:
-      - pkg/
-
-# stage: check ----------------------
-
-.rubocop_base:
-  stage: check
-  image:
-    name: ruby:2.7
-    entrypoint: ['/builds/deepl/backend/oss-client-libs/deepl-ruby']
-  script: bundle exec rubocop
-
-rubocop_scheduled:
-  extends: .rubocop_base
-  rules:
-    - if: $CI_PIPELINE_SOURCE == "schedule"
-  retry: 2
-
-rubocop_manual:
-  extends: .rubocop_base
-  rules:
-    - if: $CI_PIPELINE_SOURCE != "schedule"
-
-secret_detection:
-  extends: .secret-detection
-  stage: check
-  image: !reference [.secret-detection, image]
-  before_script:
-    - echo "overriding default before_script..."
-  rules:
-    - if: $CI_MERGE_REQUEST_ID
-
-license_check:
-  stage: check
-  before_script:
-    - echo "overriding default before_script..."
-  script:
-    - ./license_checker.sh '*.rb' | tee license_check_output.txt
-    - '[ ! -s license_check_output.txt ]'
-
-gitlab-advanced-sast:
-  stage: check
-  before_script:
-    - ''
-  rules:
-    - when: always
-  variables:
-    SAST_EXCLUDED_PATHS: '$DEFAULT_SAST_EXCLUDED_PATHS,/spec'
-    GIT_STRATEGY: clone
-    KUBERNETES_HELPER_MEMORY_LIMIT: 8Gi
-    SAST_SCANNER_ALLOWED_CLI_OPTS: --multi-core 8
-
-semgrep-sast:
-  stage: check
-  before_script:
-    - ''
-  rules:
-    - when: always
-  variables:
-    SAST_EXCLUDED_PATHS: '$DEFAULT_SAST_EXCLUDED_PATHS,/spec'
-    GIT_STRATEGY: clone
-    KUBERNETES_MEMORY_LIMIT: 8Gi
-
-
-# stage: test ----------------------
-
-.test_base:
-    stage: test
-    extends: .test
-    parallel:
-        matrix:
-          - DOCKER_IMAGE: 'ruby:2.7'
-          - DOCKER_IMAGE: 'ruby:3.2'
-          - DOCKER_IMAGE: 'ruby:3.3'
-          - DOCKER_IMAGE: 'ruby:2.7'
-            USE_MOCK_SERVER: "use mock server"
-          - DOCKER_IMAGE: 'ruby:3.2'
-            USE_MOCK_SERVER: "use mock server"
-          - DOCKER_IMAGE: 'ruby:3.3'
-            USE_MOCK_SERVER: "use mock server"
-    image:
-      name: ${DOCKER_IMAGE}
-      entrypoint: ['/builds/deepl/backend/oss-client-libs/deepl-ruby']
-    script:
-      - >
-        if [[ ! -z "${USE_MOCK_SERVER}" ]]; then
-          echo "Using mock server"
-          export DEEPL_SERVER_URL=http://deepl-mock:3000
-          export DEEPL_MOCK_SERVER_PORT=3000
-          export DEEPL_PROXY_URL=http://deepl-mock:3001
-          export DEEPL_MOCK_PROXY_SERVER_PORT=3001
-        fi
-      - bundle exec rake test
-      - bundle exec rspec --format RspecJunitFormatter --out rspec.xml
-    artifacts:
-        reports:
-            coverage_report:
-                coverage_format: cobertura
-                path: coverage/coverage.xml
-            junit:
-                - rspec.xml
-        when: always
-
-test_scheduled:
-  extends: .test_base
-  rules:
-    - if: $CI_PIPELINE_SOURCE == "schedule"
-  retry: 2
-
-test_manual:
-  stage: test
-  extends: .test_base
-  rules:
-    - if: $CI_PIPELINE_SOURCE != "schedule"
-
-
-# stage: publish ----------------------
-
-gitlab release:
-  stage: publish
-  extends: .create_gitlab_release
-  rules:
-    - if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'

data/.rubocop.yml

@@ -1,51 +0,0 @@
-# Custom rubocop configuration
-
-require:
-  - rubocop-rspec
-
-AllCops:
-  DisplayCopNames: true
-  NewCops: enable
-  Exclude:
-    - deepl-rb.gemspec
-    - vendor/**/*
-  TargetRubyVersion: 2.7.5
-
-Metrics/BlockLength:
-  Exclude:
-    - "**/*_spec.rb"
-
-Metrics/ParameterLists:
-  Max: 6
-
-Layout/LineLength:
-  Max: 100
-
-RSpec/ExampleLength:
-  Max: 10
-  CountAsOne: ['heredoc']
-
-RSpec/MessageSpies:
-  EnforcedStyle: 'receive'
-
-RSpec/MultipleExpectations:
-  Max: 8
-
-RSpec/MultipleMemoizedHelpers:
-  Max: 7
-
-RSpec/NestedGroups:
-  Max: 4
-
-RSpec/SpecFilePathSuffix:
-  Enabled: false
-
-RSpec/SpecFilePathFormat:
-  CustomTransform:
-    DeepL: ''
-
-Style/Documentation:
-  Enabled: false
-
-Style/ModuleFunction:
-  EnforcedStyle: extend_self

data/CODE_OF_CONDUCT.md

@@ -1,132 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our
-community a harassment-free experience for everyone, regardless of age, body
-size, visible or invisible disability, ethnicity, sex characteristics, gender
-identity and expression, level of experience, education, socio-economic status,
-nationality, personal appearance, race, caste, color, religion, or sexual
-identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming,
-diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our
-community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes,
-  and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall
-  community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or advances of
-  any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email address,
-  without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of
-acceptable behavior and will take appropriate and fair corrective action in
-response to any behavior that they deem inappropriate, threatening, offensive,
-or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject
-comments, commits, code, wiki edits, issues, and other contributions that are
-not aligned to this Code of Conduct, and will communicate reasons for moderation
-decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when
-an individual is officially representing the community in public spaces.
-Examples of representing our community include using an official e-mail address,
-posting via an official social media account, or acting as an appointed
-representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[open-source@deepl.com](mailto:open-source@deepl.com).
-All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the
-reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining
-the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed
-unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing
-clarity around the nature of the violation and an explanation of why the
-behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of
-actions.
-
-**Consequence**: A warning with consequences for continued behavior. No
-interaction with the people involved, including unsolicited interaction with
-those enforcing the Code of Conduct, for a specified period of time. This
-includes avoiding interactions in community spaces as well as external channels
-like social media. Violating these terms may lead to a temporary or permanent
-ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including
-sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public
-communication with the community for a specified period of time. No public or
-private interaction with the people involved, including unsolicited interaction
-with those enforcing the Code of Conduct, is allowed during this period.
-Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community
-standards, including sustained inappropriate behavior, harassment of an
-individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the
-community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 2.1, available at
-[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
-
-Community Impact Guidelines were inspired by
-[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
-
-For answers to common questions about this code of conduct, see the FAQ at
-[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
-[https://www.contributor-covenant.org/translations][translations].
-
-[homepage]: https://www.contributor-covenant.org
-[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
-[Mozilla CoC]: https://github.com/mozilla/diversity
-[FAQ]: https://www.contributor-covenant.org/faq
-[translations]: https://www.contributor-covenant.org/translations

data/CONTRIBUTING.md

@@ -1,37 +0,0 @@
-# Contributing guidelines
-
-* [Code of Conduct](#code-of-conduct)
-* [Issues](#issues)
-* [Pull Requests](#pull-requests)
-
-## Code of Conduct
-
-This project has a [Code of Conduct](CODE_OF_CONDUCT.md) to which all
-contributors must adhere when participating in the project. Instances of
-abusive, harassing, or otherwise unacceptable behavior may be reported by
-contacting [open-source@deepl.com](mailto:open-source@deepl.com) and/or a
-project maintainer.
-
-## Issues
-
-If you experience problems using the library, or would like to request a new
-feature, please open an [issue][issues].
-
-Please provide as much context as possible when you open an issue. The
-information you provide must be comprehensive enough for us to reproduce the
-issue.
-
-## Pull Requests
-
-You are welcome to contribute code and/or documentation in order to fix a bug or
-to implement a new feature. Before beginning work, you should create an issue
-describing the changes you plan to contribute, to avoid wasting or duplicating
-effort. We will then let you know whether we would accept the changes.
-
-Contributions must be licensed under the same license as the project:
-[MIT License](LICENSE.md).
-
-Currently automated testing is implemented internally at DeepL, however we plan
-to implement publicly visible testing soon.
-
-[issues]: https://www.github.com/DeepLcom/deepl-rb/issues

data/Gemfile

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-source 'https://rubygems.org'
-
-group :development do
-  # Gem management
-  gem 'juwelier'
-end
-
-group :test, :development do
-  gem 'byebug', require: 'byebug'
-end
-
-group :test do
-  # Test
-  gem 'rspec'
-  gem 'rspec_junit_formatter'
-  gem 'rubocop'
-  gem 'rubocop-rspec'
-  gem 'simplecov'
-  gem 'simplecov-cobertura'
-  gem 'vcr'
-  gem 'webmock'
-end