deepl-rb 3.2.0 → 3.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47bf797967929a4b7775e21ce7021cdc1871283b3358cbb36d13a8f6f6b5ac6b
-  data.tar.gz: df4399cc6c552fb5c03b79b0566d2370101b58246bfd5e0b05d27c83e994ae6c
+  metadata.gz: 00b711743a7d8a7e5851e6985f624376f669ecaff43a25437485f77b42970b1c
+  data.tar.gz: b75a87f8ba086f6d8d7f67f5c7f955a95488722032d4d0c19547a1aa16b19156
 SHA512:
-  metadata.gz: 4639c87e107dfa0a13b1bace938e9a3580fb15bb1e2f280267527e3d5d0c9b8913752b841bd095039f1e4f7d15b13813075131c0767216855bf5e7d28a4b81a1
-  data.tar.gz: 19743f57e84c550e5fe35b1d6c39f853df1d0d1d357eb8c0f061a0202831af8a557651f34f50dcad10928b45638a3a09b9ab64652fdadab6d6ad62ec3f2a1242
+  metadata.gz: 8bd6e8200cae9ab13b19a20a30743e292074311f437e3c58658a176a4489f39667ca4d2dd056c36d0e76fade63b2832e3a8fb478bce348d6e746acb82ad07511
+  data.tar.gz: aa9bfb1bc15e12dbe612e68796651b20d7aeeef021fac5d5feb391dc9a55f6c3b22e8257b9b228d6bd62d826833fdf7022c42fd1b97411bbf4695ea69f7acf08

data/CHANGELOG.md

@@ -4,59 +4,78 @@ 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.2.0]
+## [3.4.0] - 2025-11-17
 ### Added
-* Added `rephrase` functionality to get a new version of submitted text with various possible styles or tones applied
-* Added `DeepL::Constants` namespace and associated constant values for options possibilities
+- Added support for the `GET /v3/style_rules` endpoint in the client library, the
+  implementation can be found in the `StyleRuleApi` class. Please refer to the
+  README for usage instructions
+- Added `style_id` option to `translate()` which allows text translation with
+  style rules.
 
-## [3.1.0]
+### Fixed
+- Send correct library version in user-agent. Expose library version in the module as a variable.
+
+## [3.3.0] - 2025-11-04
+### Added
+- Added `extra_body_parameters` option to text and document translation methods to pass arbitrary parameters in the request body. This can be used to access beta features or override built-in parameters (such as `target_lang`, `source_lang`, etc.).
+- Added `rephrase` functionality to the top-level `DeepL` module for convenience.
+  * Thanks to [341bms](https://github.com/341bms) in [#14](https://github.com/DeepLcom/deepl-rb/issues/14) for the report!
+
+## [3.2.0] - 2025-01-15
+### Added
+- Added `rephrase` functionality to get a new version of submitted text with various possible styles or tones applied
+- Added `DeepL::Constants` namespace and associated constant values for options possibilities
+
+## [3.1.0] - 2024-11-15
 ### Added
-* Added `model_type` option to `translate()` to use models with higher
+- Added `model_type` option to `translate()` to use models with higher
   translation quality (available for some language pairs), or better latency.
   Options are `'quality_optimized'`, `'latency_optimized'`, and  `'prefer_quality_optimized'`
-* Added the `model_type_used` field to the `translate()` response, that
+- Added the `model_type_used` field to the `translate()` response, that
   indicates the translation model used when the `model_type` option is
   specified.
 
-
 ## [3.0.2] - 2024-10-02
 ### Added
-* Added doc example and tests for context parameter
+- Added doc example and tests for context parameter
+
 ### Fixed
-* Fix metadata displayed on RubyGems.org for this library.
-* Fixed library version sent in the `User-Agent` string.
+- Fix metadata displayed on RubyGems.org for this library.
+- Fixed library version sent in the `User-Agent` string.
 
 ## [3.0.1] - 2024-09-23
 ### Fixed
-* `document.translate_document` required a filename, this is now optional. The example in the README now works.
+- `document.translate_document` required a filename, this is now optional. The example in the README now works.
 
 ## [3.0.0] - 2024-09-20
 Beginning with version 3, deepl-rb is officially supported by DeepL, and maintained together with [Daniel Herzog](mailto:info@danielherzog.es) the developer of earlier versions of this library.
 The change in major version is only due to the change in maintainership, there is no migration necessary from v2 to v3.
+
 ### Added
-* Added rubocop-rspec linting for rspec test files
-* Added document translation to the ruby CL
-* Added possibility to use one HTTP session for multiple calls
-* Added platform and ruby version information to the user-agent string that is sent with API calls, along with an opt-out
-* Added support for logging of HTTP requests
-* Added support for using a proxy and a custom certificate file
-* Added a gitlab CI pipeline
+- Added rubocop-rspec linting for rspec test files
+- Added document translation to the ruby CL
+- Added possibility to use one HTTP session for multiple calls
+- Added platform and ruby version information to the user-agent string that is sent with API calls, along with an opt-out
+- Added support for logging of HTTP requests
+- Added support for using a proxy and a custom certificate file
+- Added a gitlab CI pipeline
+
 ### Changed
-* HTTP requests to the DeepL API now use `application/json`, rather than `application/www-form-unencoded`
-* HTTP requests now automatically retry on transient failures, using exponential backoff
-### Deprecated
+- HTTP requests to the DeepL API now use `application/json`, rather than `application/www-form-unencoded`
+- HTTP requests now automatically retry on transient failures, using exponential backoff
+
 ### Removed
-* Removed CircleCI and CodeCov upload
-### Fixed
-### Security
+- Removed CircleCI and CodeCov upload
 
 ## [2.5.3] - 2022-09-26
 ### Fixed
-* Make RequestEntityTooLarge error message more clear
+- Make RequestEntityTooLarge error message more clear
 
-[3.2.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.1.0...3.2.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
+[3.2.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.1.0...v3.2.0
 [3.1.0]: https://github.com/DeepLcom/deepl-rb/compare/v3.0.2...v3.1.0
 [3.0.2]: https://github.com/DeepLcom/deepl-rb/compare/v3.0.1...v3.0.2
 [3.0.1]: https://github.com/DeepLcom/deepl-rb/compare/v3.0.0...v3.0.1
 [3.0.0]: https://github.com/DeepLcom/deepl-rb/compare/v2.5.3...v3.0.0
-[2.5.3]: https://github.com/DeepLcom/deepl-rb/compare/v2.5.2...v2.5.3
+[2.5.3]: https://github.com/DeepLcom/deepl-rb/releases/tag/v2.5.3

data/README.md

@@ -166,7 +166,10 @@ 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)
 | `context`             | 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
 
@@ -293,6 +296,62 @@ puts language_pairs.first.target_lang
 # => de
 ```
 
+### Style Rules
+
+Style rules allow you to customize your translations using a managed, shared list
+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
+
+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.
+
+#### Listing all style rules
+
+`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).
+
+```rb
+# Get 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
+style_rules = DeepL.style_rules.list(detailed: true)
+style_rules.each do |rule|
+  if rule.configured_rules
+    puts "  Number formatting: #{rule.configured_rules.numbers.keys.join(', ')}"
+  end
+end
+```
+
+Created style rules can be used in the `translate` method by specifying the `style_id` option:
+
+```rb
+translation = DeepL.translate 'Hello World', 'EN', 'ES', style_id: 'dca2e053-8ae5-45e6-a0d2-881156e7f4e4'
+
+puts translation.class
+# => DeepL::Resources::Text
+puts translation.text
+# => 'Hola Mundo'
+```
+
+You can also pass a `StyleRule` object directly:
+
+```rb
+style_rules = DeepL.style_rules.list
+style_rule = style_rules.first
+
+translation = DeepL.translate 'Hello World', 'EN', 'ES', style_rule: style_rule
+```
+
 ### Monitor usage
 
 To check current API usage, use:
@@ -322,6 +381,18 @@ doc_status = doc_handle.wait_until_document_translation_finished # alternatively
 DeepL.document.download(doc_handle, '/path/to/translated_document.pdf') unless doc_status.error?
 ```
 
+You can also pass additional options to document translation methods, including `extra_body_parameters`:
+
+```rb
+options = {
+  formality: 'more',
+  extra_body_parameters: { example_param: 'true' }
+}
+doc_handle = DeepL.document.upload('/path/to/spanish_document.pdf', 'ES', 'EN', nil, options)
+```
+
+The `extra_body_parameters` option allows you to pass arbitrary parameters in the request body. This can be used to access beta features by adding new parameters, or to override built-in parameters (such as `target_lang`, `source_lang`, etc.) for testing purposes.
+
 ### Handle exceptions
 
 You can capture and process exceptions that may be raised during API calls. These are all the possible exceptions:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.4.0
 platform: ruby
 authors:
 - DeepL SE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-01-15 00:00:00.000000000 Z
+date: 2025-12-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -49,102 +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/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/text.rb
-- lib/deepl/resources/usage.rb
-- lib/deepl/utils/backoff_timer.rb
-- lib/deepl/utils/exception_builder.rb
-- lib/http_client_options.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_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/translate_texts.yml
-- spec/fixtures/vcr_cassettes/usage.yml
-- spec/integration_tests/document_api_spec.rb
-- spec/integration_tests/integration_test_utils.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
@@ -168,7 +76,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: Official Ruby library for the DeepL language translation API.

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,135 +0,0 @@
-# Note: This GitLab CI configuration is used for internal testing, users can ignore it.
-include:
-  - 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'
-
-# Global --------------------------
-
-workflow:
-  rules:
-    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
-    - if: $CI_COMMIT_TAG
-    - if: '$CI_COMMIT_BRANCH == $CI_DEFAULT_BRANCH'
-
-stages:
-  - install
-  - check
-  - test
-#  - publish
-
-
-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 ]'
-
-
-# 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"

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