deepl-rb 3.0.1 → 3.1.0

data/spec/fixtures/vcr_cassettes/translate_texts.yml

@@ -14,7 +14,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -53,7 +53,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -91,7 +91,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -130,7 +130,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -166,7 +166,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -202,7 +202,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -236,7 +236,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -273,7 +273,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -311,7 +311,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -352,7 +352,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -393,7 +393,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/x-www-form-urlencoded
   response:
@@ -4866,7 +4866,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3(darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -4907,7 +4907,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key invalid
       User-Agent:
-      - deepl-ruby/2.5.3(darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -4947,7 +4947,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -4991,7 +4991,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key invalid
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -5031,7 +5031,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -9513,7 +9513,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -9597,7 +9597,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -9642,7 +9642,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -9687,7 +9687,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -9768,7 +9768,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -9811,7 +9811,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -9853,7 +9853,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -9900,7 +9900,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -9945,7 +9945,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -10071,7 +10071,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -10116,7 +10116,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key invalid
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:
@@ -10146,4 +10146,227 @@ http_interactions:
       encoding: UTF-8
       string: ''
   recorded_at: Tue, 09 Jul 2024 10:04:32 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["That is hot!"],"source_lang":"EN","target_lang":"ES","context":""}'
+    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:
+      Date:
+      - Wed, 25 Sep 2024 16:07:59 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=88, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=126
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      X-Trace-Id:
+      - 53712edb2fc24c7f9d59e341bd80977a
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJ0cmFuc2xhdGlvbnMiOlt7ImRldGVjdGVkX3NvdXJjZV9sYW5ndWFnZSI6IkVOIiwidGV4dCI6IsKhRXNvIGVzdMOhIGNhbGllbnRlISJ9XX0=
+  recorded_at: Wed, 25 Sep 2024 16:07:59 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["That is hot!"],"source_lang":"EN","target_lang":"ES","context":"He
+        did not like the jalapenos in his meal."}'
+    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:
+      Date:
+      - Wed, 25 Sep 2024 16:08:00 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=67, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=124
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      X-Trace-Id:
+      - 1704af9968bf4570b155c12cc0ae0665
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJ0cmFuc2xhdGlvbnMiOlt7ImRldGVjdGVkX3NvdXJjZV9sYW5ndWFnZSI6IkVOIiwidGV4dCI6IsKhRXNvIGVzIHBpY2FudGUhIn1dfQ==
+  recorded_at: Wed, 25 Sep 2024 16:08:00 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["Sample text"],"source_lang":"EN","target_lang":"DE","model_type":"quality_optimized"}'
+    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:
+      Date:
+      - Fri, 08 Nov 2024 15:57:39 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=89, l7_lb_idle;dur=0, l7_lb_receive;dur=0, l7_lb_total;dur=165
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      X-Trace-Id:
+      - 7d71b768eebc41da8c5b820c33e7cdc1
+    body:
+      encoding: ASCII-8BIT
+      string: '{"translations":[{"detected_source_language":"EN","text":"Mustertext","model_type_used":"quality_optimized"}]}'
+  recorded_at: Fri, 08 Nov 2024 15:57:39 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["Sample text"],"source_lang":"EN","target_lang":"DE","model_type":"prefer_quality_optimized"}'
+    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:
+      Date:
+      - Mon, 11 Nov 2024 10:58:59 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=98, l7_lb_idle;dur=1, l7_lb_receive;dur=0, l7_lb_total;dur=320
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      X-Trace-Id:
+      - 0fa07be47b3b458ebf50268ca2efe7fe
+    body:
+      encoding: ASCII-8BIT
+      string: '{"translations":[{"detected_source_language":"EN","text":"Mustertext","model_type_used":"quality_optimized"}]}'
+  recorded_at: Mon, 11 Nov 2024 10:58:59 GMT
+- request:
+    method: post
+    uri: https://api.deepl.com/v2/translate
+    body:
+      encoding: UTF-8
+      string: '{"text":["Sample text"],"source_lang":"EN","target_lang":"DE","model_type":"latency_optimized"}'
+    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:
+      Date:
+      - Fri, 15 Nov 2024 11:35:22 GMT
+      Content-Type:
+      - application/json
+      Transfer-Encoding:
+      - chunked
+      Vary:
+      - Accept-Encoding
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=63072000; includeSubDomains; preload
+      Server-Timing:
+      - l7_lb_tls;dur=136, l7_lb_idle;dur=2, l7_lb_receive;dur=0, l7_lb_total;dur=156
+      Access-Control-Expose-Headers:
+      - Server-Timing, X-Trace-ID
+      X-Trace-Id:
+      - de2645cb65c3418db54e3bdefd35fe52
+    body:
+      encoding: ASCII-8BIT
+      string: '{"translations":[{"detected_source_language":"EN","text":"Beispieltext","model_type_used":"latency_optimized"}]}'
+  recorded_at: Fri, 15 Nov 2024 11:35:22 GMT
 recorded_with: VCR 6.2.0

data/spec/fixtures/vcr_cassettes/usage.yml

@@ -14,7 +14,7 @@ http_interactions:
       Accept:
       - "*/*"
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
   response:
     status:
       code: 200
@@ -46,7 +46,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3(darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
@@ -88,7 +88,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Accept-Encoding:
       - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
       Accept:
@@ -132,7 +132,7 @@ http_interactions:
       Authorization:
       - DeepL-Auth-Key VALID_TOKEN
       User-Agent:
-      - deepl-ruby/2.5.3 (darwin23) ruby/3.3.3
+      - deepl-ruby/3.0.2 (darwin23) ruby/3.3.3
       Content-Type:
       - application/json
       Accept-Encoding:

data/spec/requests/translate_spec.rb

@@ -190,6 +190,18 @@ describe DeepL::Requests::Translate do
         expect(request.options[:formality]).to eq('more')
       end
     end
+
+    context 'when using `model_type` options' do
+      it 'works with a nil value' do
+        request = described_class.new(api, nil, nil, nil, model_type: nil)
+        expect(request.options[:model_type]).to be_nil
+      end
+
+      it 'works with a string' do
+        request = described_class.new(api, nil, nil, nil, model_type: 'latency_optimized')
+        expect(request.options[:model_type]).to eq('latency_optimized')
+      end
+    end
   end
 
   describe '#request' do
@@ -292,6 +304,45 @@ describe DeepL::Requests::Translate do
       end
     end
 
+    context 'when performing a valid request with context' do
+      let(:text) { 'That is hot!' }
+
+      context 'when context is empty' do
+        let(:options) { { context: '' } }
+
+        it 'translates correctly with empty context' do
+          res = translate.request
+          expect(res).to be_a(DeepL::Resources::Text)
+          expect(res.text).to eq('¡Eso está caliente!')
+        end
+      end
+
+      context 'when context is set' do
+        let(:options) { { context: 'He did not like the jalapenos in his meal.' } }
+
+        it 'translates correctly with context taken into account' do
+          res = translate.request
+          expect(res).to be_a(DeepL::Resources::Text)
+          expect(res.text).to eq('¡Eso es picante!')
+        end
+      end
+    end
+
+    context 'when performing a request with a model type' do
+      let(:target_lang) { 'DE' }
+
+      %w[quality_optimized latency_optimized prefer_quality_optimized].each do |model_type_str|
+        it "translates correctly with #{model_type_str} models" do
+          options = { model_type: model_type_str }
+          translate = described_class.new(api, text, source_lang, target_lang, options)
+          res = translate.request
+          expect(res).to be_a(DeepL::Resources::Text)
+          expected_model_type = model_type_str.sub(/^prefer_/, '')
+          expect(res.model_type_used).to eq(expected_model_type)
+        end
+      end
+    end
+
     context 'when performing a bad request' do
       context 'when using an invalid token' do
         let(:api) do

data/spec/resources/text_spec.rb

@@ -6,7 +6,7 @@
 require 'spec_helper'
 
 describe DeepL::Resources::Text do
-  subject(:text) { described_class.new('Target', 'es', nil, nil) }
+  subject(:text) { described_class.new('Target', 'es', nil, nil, nil) }
 
   describe '#initialize' do
     context 'when building a basic object' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 3.0.1
+  version: 3.1.0
 platform: ruby
 authors:
 - DeepL SE
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-09-23 00:00:00.000000000 Z
+date: 2024-11-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -137,7 +137,11 @@ files:
 homepage: https://github.com/DeepLcom/deepl-rb
 licenses:
 - MIT
-metadata: {}
+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
 post_install_message:
 rdoc_options: []
 require_paths: