deepl-rb 2.2.0 → 2.3.0

data/lib/deepl/requests/translate.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Requests
     class Translate < Base
@@ -31,6 +33,7 @@ module DeepL
       def tweak_parameters!
         OPTIONS_CONVERSIONS.each do |param, converter|
           next unless option?(param) && converter[option(param)]
+
           set_option(param, converter[option(param)])
         end
       end

data/lib/deepl/requests/usage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Requests
     class Usage < Base

data/lib/deepl/resources/base.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Resources
     class Base

data/lib/deepl/resources/language.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module DeepL
+  module Resources
+    class Language < Base
+      attr_reader :code, :name
+
+      def initialize(code, name, *args)
+        super(*args)
+
+        @code = code
+        @name = name
+      end
+
+      def to_s
+        "#{code} - #{name}"
+      end
+    end
+  end
+end

data/lib/deepl/resources/text.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Resources
     class Text < Base

data/lib/deepl/resources/usage.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module DeepL
   module Resources
     class Usage < Base

data/spec/api/api_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL::API do

data/spec/api/configuration_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL::Configuration do
@@ -14,7 +16,7 @@ describe DeepL::Configuration do
     end
 
     context 'When using custom configuration attributes' do
-      let(:attributes) { { auth_key: 'SAMPLE', host: 'http://www.example.org', version: 'v1' } }
+      let(:attributes) { { auth_key: 'SAMPLE', host: 'https://api-free.deepl.com', version: 'v1' } }
 
       it 'should use custom attributes' do
         expect(subject.auth_key).to eq(attributes[:auth_key])

data/spec/api/deepl_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe DeepL do
@@ -45,6 +47,7 @@ describe DeepL do
     let(:options) { { param: 'fake' } }
 
     around do |example|
+      subject.configure { |config| config.host = 'https://api-free.deepl.com' }
       VCR.use_cassette('deepl_translate') { example.call }
     end
 
@@ -63,6 +66,7 @@ describe DeepL do
     let(:options) { {} }
 
     around do |example|
+      subject.configure { |config| config.host = 'https://api-free.deepl.com' }
       VCR.use_cassette('deepl_usage') { example.call }
     end
 
@@ -76,4 +80,24 @@ describe DeepL do
       end
     end
   end
+
+  describe '#languages' do
+    let(:options) { { type: :target } }
+
+    around do |example|
+      subject.configure { |config| config.host = 'https://api-free.deepl.com' }
+      VCR.use_cassette('deepl_languages') { example.call }
+    end
+
+    context 'When checking languages' do
+      it 'should create and call a request object' do
+        expect(DeepL::Requests::Languages).to receive(:new)
+          .with(subject.api, options).and_call_original
+
+        languages = subject.languages(options)
+        expect(languages).to be_an(Array)
+        expect(languages.all? { |l| l.is_a?(DeepL::Resources::Language) }).to be_truthy
+      end
+    end
+  end
 end

data/spec/fixtures/vcr_cassettes/deepl_languages.yml

@@ -0,0 +1,41 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api-free.deepl.com/v2/languages?auth_key=VALID_TOKEN&type=target
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 17 May 2021 15:07:54 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '1667'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '[{"language":"BG","name":"Bulgarian","supports_formality":false},{"language":"CS","name":"Czech","supports_formality":false},{"language":"DA","name":"Danish","supports_formality":false},{"language":"DE","name":"German","supports_formality":true},{"language":"EL","name":"Greek","supports_formality":false},{"language":"EN-GB","name":"English
+        (British)","supports_formality":false},{"language":"EN-US","name":"English
+        (American)","supports_formality":false},{"language":"ES","name":"Spanish","supports_formality":true},{"language":"ET","name":"Estonian","supports_formality":false},{"language":"FI","name":"Finnish","supports_formality":false},{"language":"FR","name":"French","supports_formality":true},{"language":"HU","name":"Hungarian","supports_formality":false},{"language":"IT","name":"Italian","supports_formality":true},{"language":"JA","name":"Japanese","supports_formality":false},{"language":"LT","name":"Lithuanian","supports_formality":false},{"language":"LV","name":"Latvian","supports_formality":false},{"language":"NL","name":"Dutch","supports_formality":true},{"language":"PL","name":"Polish","supports_formality":true},{"language":"PT-BR","name":"Portuguese
+        (Brazilian)","supports_formality":true},{"language":"PT-PT","name":"Portuguese
+        (European)","supports_formality":true},{"language":"RO","name":"Romanian","supports_formality":false},{"language":"RU","name":"Russian","supports_formality":true},{"language":"SK","name":"Slovak","supports_formality":false},{"language":"SL","name":"Slovenian","supports_formality":false},{"language":"SV","name":"Swedish","supports_formality":false},{"language":"ZH","name":"Chinese","supports_formality":false}]'
+  recorded_at: Mon, 17 May 2021 15:07:54 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/deepl_translate.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN&param=fake
+    uri: https://api-free.deepl.com/v2/translate?auth_key=VALID_TOKEN&param=fake
     body:
       encoding: US-ASCII
       string: text=Sample&source_lang=EN&target_lang=ES
@@ -23,7 +23,7 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Tue, 08 May 2018 16:31:34 GMT
+      - Mon, 17 May 2021 14:42:56 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -35,6 +35,5 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"translations":[{"detected_source_language":"EN","text":"Muestra"}]}'
-    http_version:
-  recorded_at: Tue, 08 May 2018 16:31:33 GMT
-recorded_with: VCR 4.0.0
+  recorded_at: Mon, 17 May 2021 14:42:56 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/deepl_usage.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: get
-    uri: https://api.deepl.com/v2/usage?auth_key=VALID_TOKEN
+    uri: https://api-free.deepl.com/v2/usage?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: ''
@@ -21,14 +21,17 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Tue, 08 May 2018 16:31:35 GMT
+      - Mon, 17 May 2021 14:18:28 GMT
+      Content-Type:
+      - application/json
       Content-Length:
-      - '52'
+      - '48'
       Connection:
       - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
-      string: '{"character_count":802127,"character_limit":1000000}'
-    http_version: 
-  recorded_at: Tue, 08 May 2018 16:31:33 GMT
-recorded_with: VCR 4.0.0
+      string: '{"character_count":303,"character_limit":500000}'
+  recorded_at: Mon, 17 May 2021 14:18:28 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/languages.yml

@@ -0,0 +1,108 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api-free.deepl.com/v2/languages?auth_key=VALID_TOKEN
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 17 May 2021 14:49:42 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '845'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '[{"language":"BG","name":"Bulgarian"},{"language":"CS","name":"Czech"},{"language":"DA","name":"Danish"},{"language":"DE","name":"German"},{"language":"EL","name":"Greek"},{"language":"EN","name":"English"},{"language":"ES","name":"Spanish"},{"language":"ET","name":"Estonian"},{"language":"FI","name":"Finnish"},{"language":"FR","name":"French"},{"language":"HU","name":"Hungarian"},{"language":"IT","name":"Italian"},{"language":"JA","name":"Japanese"},{"language":"LT","name":"Lithuanian"},{"language":"LV","name":"Latvian"},{"language":"NL","name":"Dutch"},{"language":"PL","name":"Polish"},{"language":"PT","name":"Portuguese"},{"language":"RO","name":"Romanian"},{"language":"RU","name":"Russian"},{"language":"SK","name":"Slovak"},{"language":"SL","name":"Slovenian"},{"language":"SV","name":"Swedish"},{"language":"ZH","name":"Chinese"}]'
+  recorded_at: Mon, 17 May 2021 14:49:42 GMT
+- request:
+    method: get
+    uri: https://api-free.deepl.com/v2/languages?auth_key=VALID_TOKEN&type=target
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 17 May 2021 14:55:30 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '1667'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '[{"language":"BG","name":"Bulgarian","supports_formality":false},{"language":"CS","name":"Czech","supports_formality":false},{"language":"DA","name":"Danish","supports_formality":false},{"language":"DE","name":"German","supports_formality":true},{"language":"EL","name":"Greek","supports_formality":false},{"language":"EN-GB","name":"English
+        (British)","supports_formality":false},{"language":"EN-US","name":"English
+        (American)","supports_formality":false},{"language":"ES","name":"Spanish","supports_formality":true},{"language":"ET","name":"Estonian","supports_formality":false},{"language":"FI","name":"Finnish","supports_formality":false},{"language":"FR","name":"French","supports_formality":true},{"language":"HU","name":"Hungarian","supports_formality":false},{"language":"IT","name":"Italian","supports_formality":true},{"language":"JA","name":"Japanese","supports_formality":false},{"language":"LT","name":"Lithuanian","supports_formality":false},{"language":"LV","name":"Latvian","supports_formality":false},{"language":"NL","name":"Dutch","supports_formality":true},{"language":"PL","name":"Polish","supports_formality":true},{"language":"PT-BR","name":"Portuguese
+        (Brazilian)","supports_formality":true},{"language":"PT-PT","name":"Portuguese
+        (European)","supports_formality":true},{"language":"RO","name":"Romanian","supports_formality":false},{"language":"RU","name":"Russian","supports_formality":true},{"language":"SK","name":"Slovak","supports_formality":false},{"language":"SL","name":"Slovenian","supports_formality":false},{"language":"SV","name":"Swedish","supports_formality":false},{"language":"ZH","name":"Chinese","supports_formality":false}]'
+  recorded_at: Mon, 17 May 2021 14:55:30 GMT
+- request:
+    method: get
+    uri: https://api-free.deepl.com/v2/languages?auth_key=VALID_TOKEN&type=invalid
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+  response:
+    status:
+      code: 400
+      message: Bad Request
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 17 May 2021 14:57:00 GMT
+      Content-Length:
+      - '82'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"message":"Parameter ''type'' is invalid. ''source'' and ''target''
+        are valid values."}'
+  recorded_at: Mon, 17 May 2021 14:57:00 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/translate_texts.yml

@@ -2,7 +2,7 @@
 http_interactions:
 - request:
     method: post
-    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN
+    uri: https://api-free.deepl.com/v2/translate?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: text=Sample+text&source_lang=EN&target_lang=ES
@@ -23,11 +23,11 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Tue, 08 May 2018 16:31:36 GMT
+      - Mon, 17 May 2021 14:20:14 GMT
       Content-Type:
       - application/json
       Content-Length:
-      - '74'
+      - '78'
       Connection:
       - keep-alive
       Access-Control-Allow-Origin:
@@ -36,11 +36,10 @@ http_interactions:
       encoding: UTF-8
       string: '{"translations":[{"detected_source_language":"EN","text":"Texto de
         muestra"}]}'
-    http_version: 
-  recorded_at: Tue, 08 May 2018 16:31:34 GMT
+  recorded_at: Mon, 17 May 2021 14:20:14 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN
+    uri: https://api-free.deepl.com/v2/translate?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: text=Sample&text=Word&source_lang=EN&target_lang=ES
@@ -61,7 +60,7 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Tue, 08 May 2018 16:31:37 GMT
+      - Mon, 17 May 2021 14:20:14 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -73,11 +72,10 @@ http_interactions:
     body:
       encoding: UTF-8
       string: '{"translations":[{"detected_source_language":"EN","text":"Muestra"},{"detected_source_language":"EN","text":"Palabra"}]}'
-    http_version: 
-  recorded_at: Tue, 08 May 2018 16:31:35 GMT
+  recorded_at: Mon, 17 May 2021 14:20:14 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN
+    uri: https://api-free.deepl.com/v2/translate?auth_key=VALID_TOKEN&tag_handling=xml
     body:
       encoding: US-ASCII
       string: text=%3Cp%3ESample+text%3C%2Fp%3E&source_lang=EN&target_lang=ES
@@ -98,7 +96,7 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Tue, 08 May 2018 16:31:37 GMT
+      - Mon, 17 May 2021 14:20:15 GMT
       Content-Type:
       - application/json
       Content-Length:
@@ -111,11 +109,47 @@ http_interactions:
       encoding: UTF-8
       string: '{"translations":[{"detected_source_language":"EN","text":"<p>Texto
         de muestra</p>"}]}'
-    http_version: 
-  recorded_at: Tue, 08 May 2018 16:31:36 GMT
+  recorded_at: Mon, 17 May 2021 14:20:15 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v2/translate?auth_key=invalid
+    uri: https://api-free.deepl.com/v2/translate?auth_key=VALID_TOKEN&ignore_tags=code,span
+    body:
+      encoding: US-ASCII
+      string: text=Welcome+and+%3Ccode%3EHello+great+World%3C%2Fcode%3E+Good+Morning%21&source_lang=EN&target_lang=ES
+    headers:
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+      User-Agent:
+      - Ruby
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Mon, 17 May 2021 14:20:16 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '119'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: ASCII-8BIT
+      string: !binary |-
+        eyJ0cmFuc2xhdGlvbnMiOlt7ImRldGVjdGVkX3NvdXJjZV9sYW5ndWFnZSI6IkVOIiwidGV4dCI6IkJpZW52ZW5pZG8geSA8Y29kZT5Ib2xhIGdyYW4gbXVuZG88L2NvZGU+IMKhQnVlbm9zIGTDrWFzISJ9XX0=
+  recorded_at: Mon, 17 May 2021 14:20:16 GMT
+- request:
+    method: post
+    uri: https://api-free.deepl.com/v2/translate?auth_key=invalid
     body:
       encoding: US-ASCII
       string: text=Sample+text&source_lang=EN&target_lang=ES
@@ -136,19 +170,20 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Tue, 08 May 2018 16:31:38 GMT
+      - Mon, 17 May 2021 14:20:16 GMT
       Content-Length:
       - '0'
       Connection:
       - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: ''
-    http_version: 
-  recorded_at: Tue, 08 May 2018 16:31:37 GMT
+  recorded_at: Mon, 17 May 2021 14:20:16 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN
+    uri: https://api-free.deepl.com/v2/translate?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: source_lang=EN&target_lang=ES
@@ -169,19 +204,20 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Tue, 08 May 2018 16:31:38 GMT
+      - Mon, 17 May 2021 14:20:16 GMT
       Content-Length:
       - '45'
       Connection:
       - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
       string: '{"message":"Parameter ''text'' not specified."}'
-    http_version: 
-  recorded_at: Tue, 08 May 2018 16:31:37 GMT
+  recorded_at: Mon, 17 May 2021 14:20:16 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN
+    uri: https://api-free.deepl.com/v2/translate?auth_key=VALID_TOKEN
     body:
       encoding: US-ASCII
       string: text=Sample+text&source_lang=EN
@@ -202,19 +238,20 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Tue, 08 May 2018 16:31:39 GMT
+      - Mon, 17 May 2021 14:20:17 GMT
       Content-Length:
       - '52'
       Connection:
       - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
-      string: '{"message":"Parameter ''target_lang'' not specified."}'
-    http_version: 
-  recorded_at: Tue, 08 May 2018 16:31:37 GMT
+      string: '{"message":"Value for ''target_lang'' not supported."}'
+  recorded_at: Mon, 17 May 2021 14:20:17 GMT
 - request:
     method: post
-    uri: https://api.deepl.com/v2/translate?auth_key=VALID_TOKEN&ignore_tags=code,%20span
+    uri: https://api-free.deepl.com/v2/translate?auth_key=VALID_TOKEN&ignore_tags=code,span&tag_handling=xml
     body:
       encoding: US-ASCII
       string: text=Welcome+and+%3Ccode%3EHello+great+World%3C%2Fcode%3E+Good+Morning%21&source_lang=EN&target_lang=ES
@@ -235,11 +272,11 @@ http_interactions:
       Server:
       - nginx
       Date:
-      - Tue, 24 Jul 2018 16:13:51 GMT
+      - Mon, 17 May 2021 14:20:56 GMT
       Content-Type:
       - application/json
       Content-Length:
-      - '119'
+      - '121'
       Connection:
       - keep-alive
       Access-Control-Allow-Origin:
@@ -247,7 +284,6 @@ http_interactions:
     body:
       encoding: ASCII-8BIT
       string: !binary |-
-        eyJ0cmFuc2xhdGlvbnMiOlt7ImRldGVjdGVkX3NvdXJjZV9sYW5ndWFnZSI6IkVOIiwidGV4dCI6IkJpZW52ZW5pZG8geSA8Y29kZT5IZWxsbyBncmVhdCBXb3JsZDwvY29kZT4gQnVlbm9zIGTDrWFzISJ9XX0=
-    http_version: 
-  recorded_at: Tue, 24 Jul 2018 16:13:49 GMT
-recorded_with: VCR 4.0.0
+        eyJ0cmFuc2xhdGlvbnMiOlt7ImRldGVjdGVkX3NvdXJjZV9sYW5ndWFnZSI6IkVOIiwidGV4dCI6IkJpZW52ZW5pZG8geSA8Y29kZT5IZWxsbyBncmVhdCBXb3JsZDwvY29kZT4gwqFCdWVub3MgZMOtYXMhIn1dfQ==
+  recorded_at: Mon, 17 May 2021 14:20:56 GMT
+recorded_with: VCR 6.0.0