deepl-rb 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5778d1b4102e5d798b157de8dcaeecd069d55f0f333eb190e510eb6b0593df9f
-  data.tar.gz: 117d03157edd90e2da5e6064f5d9c4b8c0ede6beddd009b7016b48d0e2673e19
+  metadata.gz: ac9df781efec35e22812fb7d998386c19dd2f51afeb020d1850c4b2091e5ba20
+  data.tar.gz: 70db2ae1bd08aa8e1dffb01198225ad29fc5c2514cf4f1a38da948bbe97c51f3
 SHA512:
-  metadata.gz: e0b437203711dabb1b30f20a04964d940f17b5e85e41559436ea46dea5a2e093600122c58b15b486e81062831bb12534a146820b8cca69fd262710b8757caab1
-  data.tar.gz: c581a473d282486dcd516eacb8a20996302806bf0a40cf4e34467e11ea0f4445660a938addd64f60be5e01b05e32e17d54e3fdea542c14f23ee6b203fd789391
+  metadata.gz: 5c55b0eb6a6ef528eb14f78acfb89591fa99de7c7d8a82fb322e5b189c6663ff5f5f915d46ac4e93fcebc5a1d1f71bcef3d94fb1cac36d5e5fcabec9eb656cb5
+  data.tar.gz: a606b2405448a3598faf0d38e51830437d14019ab6b2cec4a794f93bc47f8329612fc524b1f2d5c71e48063ef4682a12831cada04d8b5c2a9f8ffd1f2012c3e6

data/.circleci/config.yml

@@ -0,0 +1,27 @@
+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

@@ -0,0 +1,16 @@
+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

@@ -0,0 +1,177 @@
+# 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']
+  variables:
+    HOME: /tmp
+  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
+  image: registry.gitlab.com/gitlab-org/release-cli:latest
+  extends: .create_gitlab_release
+  before_script:
+    - echo "overriding default before_script..."
+  rules:
+    - if: '$CI_COMMIT_TAG =~ /^v[0-9]+\.[0-9]+\.[0-9]+$/'

data/.rubocop.yml

@@ -0,0 +1,51 @@
+# 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/CHANGELOG.md

@@ -6,10 +6,39 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [3.7.0] - 2026-05-14
+### Added
+- Added support for listing translation memories via `DeepL.translation_memories.list`.
+- Added `translation_memory` and `translation_memory_threshold` parameters to `translate()`
+  to use a translation memory during text translation. The `translation_memory` parameter
+  accepts a string ID or a `TranslationMemory` object.
+- Added support for style rules CRUD operations via `DeepL.style_rules`:
+  `create()`, `find()`, `update_name()`, `update_configured_rules()`, and `destroy()`.
+- Added support for style rule custom instruction CRUD operations via `DeepL.style_rules`:
+  `create_custom_instruction()`, `find_custom_instruction()`,
+  `update_custom_instruction()`, and `destroy_custom_instruction()`.
+  Please refer to the README for usage instructions.
+
+### Changed
+- Updated unit test to expect the `model_type_used` to now be `quality_optimized`
+- Set explicit `image` for `gitlab release` CI job to avoid missing `$HOME` issues
+
+## [3.6.1] - 2025-12-19
+### Fixed
+- Fixed broken 3.6.0 release
+
 ## [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`.
 
+### Fixed
+- `extra_body_parameters` will no longer cast values to string, as this library sends JSON-encoded requests
+  (allows e.g. sending booleans)
+
+## [3.5.1] - 2025-12-19
+### Fixed
+- Fixed broken 3.5.0 release
+
 ## [3.5.0] - 2025-12-03
 ### Added
 - Added `custom_instructions` parameter to `translate()` to customize translation
@@ -19,6 +48,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   model type as the default. Requests combining `custom_instructions` and the
   `latency_optimized` model type will be rejected.
 
+## [3.4.1] - 2025-12-19
+### Fixed
+- Fixed broken 3.4.0 release
+
 ## [3.4.0] - 2025-11-17
 ### Added
 - Added support for the `GET /v3/style_rules` endpoint in the client library, the
@@ -86,9 +119,13 @@ 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.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
+[Unreleased]: https://github.com/DeepLcom/deepl-rb/compare/v3.7.0...HEAD
+[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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# 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

@@ -0,0 +1,37 @@
+# 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

@@ -0,0 +1,24 @@
+# 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