deepl-rb 3.1.0 → 3.3.0

data/lib/deepl/requests/document/upload.rb

@@ -20,18 +20,10 @@ module DeepL
           @filename = filename
         end
 
-        def request # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+        def request
           input_file = File.open(input_file_path, 'rb')
-          form_data = [
-            ['file', input_file], ['source_lang', source_lang],
-            ['target_lang', target_lang]
-          ]
-          filename_param = filename || File.basename(input_file_path)
-          form_data.push(['filename', filename_param]) unless filename_param.nil?
-          # Manually add options due to multipart/form-data request
-          SUPPORTED_OPTIONS.each do |option|
-            form_data.push([option, options[option]]) unless options[option].nil?
-          end
+          form_data = build_base_form_data(input_file)
+          apply_extra_body_parameters_to_form(form_data)
           build_doc_handle(*execute_request_with_retries(post_request_with_file(form_data),
                                                          [input_file]))
         end
@@ -49,6 +41,24 @@ module DeepL
 
         private
 
+        def build_base_form_data(input_file)
+          form_data = [
+            ['file', input_file], ['source_lang', source_lang],
+            ['target_lang', target_lang]
+          ]
+          filename_param = filename || File.basename(input_file_path)
+          form_data.push(['filename', filename_param]) unless filename_param.nil?
+          add_supported_options_to_form(form_data)
+          form_data
+        end
+
+        def add_supported_options_to_form(form_data)
+          SUPPORTED_OPTIONS.each do |option_name|
+            option_value = option(option_name)
+            form_data.push([option_name, option_value]) unless option_value.nil?
+          end
+        end
+
         def build_doc_handle(request, response)
           parsed_response = JSON.parse(response.body)
           Resources::DocumentHandle.new(parsed_response['document_id'],

data/lib/deepl/requests/rephrase.rb

@@ -0,0 +1,55 @@
+# 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 Requests
+    class Rephrase < Base
+      attr_reader :text, :target_lang, :writing_style, :tone
+
+      def initialize(api, text, target_lang = nil, writing_style = nil, tone = nil, options = {}) # rubocop:disable Metrics/ParameterLists
+        super(api, options)
+        @text = text
+        @target_lang = target_lang
+        @writing_style = writing_style
+        @tone = tone
+      end
+
+      def request # rubocop:disable Metrics/AbcSize
+        text_arrayified = text.is_a?(Array) ? text : [text]
+        payload = { text: text_arrayified }
+        payload[:target_lang] = target_lang unless target_lang.nil?
+        payload[:writing_style] = writing_style unless writing_style.nil?
+        payload[:tone] = tone unless tone.nil?
+        build_texts(*execute_request_with_retries(post_request(payload)))
+      end
+
+      def details
+        "HTTP Headers: #{headers}\nPayload #{{ text: text, target_lang: target_lang,
+                                               writing_style: writing_style, tone: tone }}"
+      end
+
+      def to_s
+        "POST #{uri.request_uri}"
+      end
+
+      private
+
+      def build_texts(request, response)
+        data = JSON.parse(response.body)
+
+        texts = data['improvements'].map do |improvement|
+          Resources::Text.new(improvement['text'], improvement['detected_source_language'], nil,
+                              request, response)
+        end
+
+        texts.size == 1 ? texts.first : texts
+      end
+
+      def path
+        'write/rephrase'
+      end
+    end
+  end
+end

data/lib/deepl.rb

@@ -34,6 +34,7 @@ require 'deepl/requests/glossary/list'
 require 'deepl/requests/languages'
 require 'deepl/requests/translate'
 require 'deepl/requests/usage'
+require 'deepl/requests/rephrase'
 
 # -- Responses and resources
 require 'deepl/resources/base'
@@ -49,6 +50,15 @@ require 'deepl/resources/usage'
 require 'deepl/utils/exception_builder'
 require 'deepl/utils/backoff_timer'
 
+# -- Constants
+require 'deepl/constants/base_constant'
+require 'deepl/constants/formality'
+require 'deepl/constants/model_type'
+require 'deepl/constants/split_sentences'
+require 'deepl/constants/tag_handling'
+require 'deepl/constants/tone'
+require 'deepl/constants/writing_style'
+
 # -- HTTP Utils
 require 'http_client_options'
 
@@ -87,6 +97,11 @@ module DeepL
     GlossaryApi.new(api, options)
   end
 
+  def rephrase(text, target_lang = nil, writing_style = nil, tone = nil, options = {}) # rubocop:disable Metrics/ParameterLists
+    configure if @configuration.nil?
+    Requests::Rephrase.new(api, text, target_lang, writing_style, tone, options).request
+  end
+
   def usage(options = {})
     configure if @configuration.nil?
     Requests::Usage.new(api, options).request

data/spec/api/deepl_spec.rb

@@ -428,4 +428,33 @@ describe DeepL do
       end
     end
   end
+
+  describe '#rephrase' do
+    let(:text) { 'Ih bin ei beispielsatz.' }
+    let(:target_lang) { 'DE' }
+    let(:options) { {} }
+
+    around do |example|
+      deepl.configure
+      VCR.use_cassette('deepl_rephrase') { example.call }
+    end
+
+    context 'when rephrasing text' do
+      it 'creates and call a request object' do
+        expect(DeepL::Requests::Rephrase).to receive(:new)
+          .with(deepl.api, text, nil, nil, nil, {}).and_call_original
+
+        rephrased_text = deepl.rephrase(text)
+        expect(rephrased_text).to be_a(DeepL::Resources::Text)
+      end
+
+      it 'creates and call a request object when passing options' do
+        expect(DeepL::Requests::Rephrase).to receive(:new)
+          .with(deepl.api, text, target_lang, nil, nil, options).and_call_original
+
+        rephrased_text = deepl.rephrase(text, target_lang, nil, nil, options)
+        expect(rephrased_text).to be_a(DeepL::Resources::Text)
+      end
+    end
+  end
 end

data/spec/constants/constants_spec.rb

@@ -0,0 +1,158 @@
+# 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
+
+require 'spec_helper'
+
+describe 'DeepL::Constants' do
+  describe DeepL::Constants::Tone do
+    subject(:tone) { described_class }
+
+    it 'includes all expected tone values' do # rubocop:disable RSpec/ExampleLength
+      expect(tone.options).to contain_exactly(
+        'confident',
+        'default',
+        'diplomatic',
+        'enthusiastic',
+        'friendly',
+        'prefer_confident',
+        'prefer_diplomatic',
+        'prefer_enthusiastic',
+        'prefer_friendly'
+      )
+    end
+
+    it 'validates correct tone values' do
+      expect(tone.valid?('enthusiastic')).to be true
+      expect(tone.valid?('friendly')).to be true
+      expect(tone.valid?('confident')).to be true
+      expect(tone.valid?('diplomatic')).to be true
+      expect(tone.valid?('default')).to be true
+    end
+
+    it 'invalidates incorrect tone values' do
+      expect(tone.valid?('angry')).to be false
+      expect(tone.valid?('')).to be false
+      expect(tone.valid?(nil)).to be false
+    end
+  end
+
+  describe DeepL::Constants::WritingStyle do
+    subject(:writing_style) { described_class }
+
+    it 'includes all expected writing style values' do # rubocop:disable RSpec/ExampleLength
+      expect(writing_style.options).to contain_exactly(
+        'default',
+        'simple',
+        'business',
+        'academic',
+        'casual',
+        'prefer_academic',
+        'prefer_business',
+        'prefer_casual',
+        'prefer_simple'
+      )
+    end
+
+    it 'validates correct writing style values' do
+      expect(writing_style.valid?('simple')).to be true
+      expect(writing_style.valid?('business')).to be true
+      expect(writing_style.valid?('academic')).to be true
+      expect(writing_style.valid?('casual')).to be true
+      expect(writing_style.valid?('default')).to be true
+    end
+
+    it 'invalidates incorrect writing style values' do
+      expect(writing_style.valid?('wordy')).to be false
+      expect(writing_style.valid?('')).to be false
+      expect(writing_style.valid?(nil)).to be false
+    end
+  end
+
+  describe DeepL::Constants::TagHandling do
+    subject(:tag_handling) { described_class }
+
+    it 'includes all expected tag handling values' do
+      expect(tag_handling.options).to contain_exactly('xml', 'html')
+    end
+
+    it 'validates correct tag handling values' do
+      expect(tag_handling.valid?('xml')).to be true
+      expect(tag_handling.valid?('html')).to be true
+    end
+
+    it 'invalidates incorrect tag handling values' do
+      expect(tag_handling.valid?('json')).to be false
+      expect(tag_handling.valid?('')).to be false
+      expect(tag_handling.valid?(nil)).to be false
+    end
+  end
+
+  describe DeepL::Constants::SplitSentences do
+    subject(:split_sentences) { described_class }
+
+    it 'includes all expected split sentences values' do
+      expect(split_sentences.options).to contain_exactly('0', '1', 'nonewlines')
+    end
+
+    it 'validates correct split sentences values' do
+      expect(split_sentences.valid?('0')).to be true
+      expect(split_sentences.valid?('1')).to be true
+      expect(split_sentences.valid?('nonewlines')).to be true
+    end
+
+    it 'invalidates incorrect split sentences values' do
+      expect(split_sentences.valid?('2')).to be false
+      expect(split_sentences.valid?('')).to be false
+      expect(split_sentences.valid?(nil)).to be false
+    end
+  end
+
+  describe DeepL::Constants::ModelType do
+    subject(:model_type) { described_class }
+
+    it 'includes all expected model type values' do
+      expect(model_type.options).to contain_exactly(
+        'quality_optimized',
+        'prefer_quality_optimized',
+        'latency_optimized'
+      )
+    end
+
+    it 'validates correct model type values' do
+      expect(model_type.valid?('quality_optimized')).to be true
+      expect(model_type.valid?('prefer_quality_optimized')).to be true
+      expect(model_type.valid?('latency_optimized')).to be true
+    end
+
+    it 'invalidates incorrect model type values' do
+      expect(model_type.valid?('speed_optimized')).to be false
+      expect(model_type.valid?('')).to be false
+      expect(model_type.valid?(nil)).to be false
+    end
+  end
+
+  describe DeepL::Constants::Formality do
+    subject(:formality) { described_class }
+
+    it 'includes all expected formality values' do
+      expect(formality.options).to contain_exactly('default', 'more', 'less', 'prefer_more',
+                                                   'prefer_less')
+    end
+
+    it 'validates correct formality values' do
+      expect(formality.valid?('default')).to be true
+      expect(formality.valid?('more')).to be true
+      expect(formality.valid?('less')).to be true
+      expect(formality.valid?('prefer_more')).to be true
+      expect(formality.valid?('prefer_less')).to be true
+    end
+
+    it 'invalidates incorrect formality values' do
+      expect(formality.valid?('neutral')).to be false
+      expect(formality.valid?('')).to be false
+      expect(formality.valid?(nil)).to be false
+    end
+  end
+end

data/spec/fixtures/vcr_cassettes/deepl_rephrase.yml

@@ -0,0 +1,87 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["Ih bin ei beispielsatz."]}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin22) ruby/3.2.1
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 04 Nov 2025 09:49:46 GMT
+      X-Trace-Id:
+      - 55e4d15b3b5f43d5911ddd20e43e4853
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=39, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=122
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: '{"improvements":[{"text":"Ich bin ein Beispiel.","detected_source_language":"de","target_language":"de"}]}'
+  recorded_at: Tue, 04 Nov 2025 09:49:47 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/write/rephrase
+    body:
+      encoding: UTF-8
+      string: '{"text":["Ih bin ei beispielsatz."],"target_lang":"DE"}'
+    headers:
+      Authorization:
+      - DeepL-Auth-Key VALID_TOKEN
+      User-Agent:
+      - deepl-ruby/3.0.2 (darwin22) ruby/3.2.1
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Content-Type:
+      - application/json; charset=utf-8
+      Date:
+      - Tue, 04 Nov 2025 09:49:47 GMT
+      X-Trace-Id:
+      - bdeb8592514b40b8a16068b3cff1a4ed
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      Server-Timing:
+      - l7_lb_tls;dur=40, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=138
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+    body:
+      encoding: ASCII-8BIT
+      string: '{"improvements":[{"text":"Ich bin ein Beispiel.","detected_source_language":"de","target_language":"de"}]}'
+  recorded_at: Tue, 04 Nov 2025 09:49:47 GMT
+recorded_with: VCR 6.2.0