deepl-rb 2.2.3 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83485dc84bdce1dd11492bc0eb141825202b624e903cc747cc7bcc2f0afbc74e
-  data.tar.gz: 2f39d5af1a2926e123fa2fb1e3a3cae247546234f6382a0fc185f3e0fb5d7599
+  metadata.gz: 9f9236d354e5ca92bb03e6c8f34e9b332dff42c1bd985a80193b39f7509bbf99
+  data.tar.gz: d0796f1d303279647026c81a588f1d8442b526edc9c0f7be13252fff7cbd957b
 SHA512:
-  metadata.gz: 44bb0eb91abfea54a199830b26abdf52b275badcf3cad7ca0a905cd2bfef7360cd3ced29690047438f263c46dfa71e2ce9c34abab09b30f4af25565aac7309d4
-  data.tar.gz: df542383415d3c0eecb848d29e01c0c1e8ef2b8d7e272ce224383251ea1ca876edb4f6cc65f8c78f9978621f918cb75e946737a9bffc2a40fc8e87506bc5e5f3
+  metadata.gz: 9c30aea5725784be6a7766bc9d7c8a0909338937352dfbe04254341d7355f12ffad801c14364b10a8b0eefccc52dd003783e22f3b9679f65767fb664b27b710f
+  data.tar.gz: 3a4b61ebfdd6f130ec1d24a0d7ee81c7cab1b783dfb7a6e113a2af91f4240863fe727c5a054b9487e3d4bd2af011d644d15b426ae46a1c435b89ade536cc7c6a

data/Gemfile

@@ -7,6 +7,10 @@ group :development do
   gem 'juwelier'
 end
 
+group :test, :development do
+  gem 'byebug', require: 'byebug'
+end
+
 group :test do
   # Test
   gem 'codecov', require: false

data/README.md

@@ -40,11 +40,42 @@ You can also configure the API host and the API version:
 ```rb
 DeepL.configure do |config|
   config.auth_key = 'your-api-token'
-  config.host = 'https://test-api.deepl.com' # Default value is 'https://api.deepl.com'
+  config.host = 'https://api-free.deepl.com' # Default value is 'https://api.deepl.com'
   config.version = 'v1' # Default value is 'v2'
 end
 ```
 
+### Available languages
+
+Available languages can be retrieved via API:
+
+```rb
+languages = DeepL.languages
+
+puts languages.class
+# => Array
+puts languages.first.class
+# => DeepL::Resources::Language
+puts "#{languages.first.code} -> #{languages.first.name}"
+# => "ES -> Spanish"
+```
+
+Note that source and target languages may be different, which can be retrieved by using the `type`
+option:
+
+```rb
+puts DeepL.languages(type: :source).count
+# => 24
+puts DeepL.languages(type: :target).count
+# => 26
+```
+
+All languages are also defined on the
+[official API documentation](https://www.deepl.com/docs-api/translating-text/).
+
+Note that target languages may include the `supports_formality` flag, which may be checked
+using the `DeepL::Resources::Language#supports_formality?`.
+
 ### Translate
 
 To translate a simple text, use the `translate` method:
@@ -79,20 +110,6 @@ puts translations.first.class
 # => DeepL::Resources::Text
 ```
 
-Here's a list of available language codes:
-
-| Language code   | Language
-| --------------- | ---------------
-| `EN`            | English
-| `DE`            | German
-| `FR`            | French
-| `ES`            | Spanish
-| `PT`            | Portuguese
-| `IT`            | Italian
-| `NL`            | Dutch
-| `PL`            | Polish
-| `RU`            | Russian
-
 You can also use custom query parameters, like `tag_handling`, `split_sentences`, `non_splitting_tags` or `ignore_tags`:
 
 ```rb
@@ -110,10 +127,13 @@ The following parameters will be automatically converted:
 | --------------------- | ---------------
 | `preserve_formatting` | Converts `false` to `'0'` and `true` to `'1'`
 | `split_sentences`     | Converts `false` to `'0'` and `true` to `'1'`
+| `outline_detection`   | Converts `false` to `'0'` and `true` to `'1'`
 | `non_splitting_tags`  | Converts arrays to strings joining by commas
 | `ignore_tags`         | Converts arrays to strings joining by commas
+| `formality`           | No conversion applied
+| `glossary_id`         | No conversion applied
 
-### Usage
+### Monitor usage
 
 To check current API usage, use:
 
@@ -137,6 +157,7 @@ You can capture and process exceptions that may be raised during API calls. Thes
 | `DeepL::Exceptions::LimitExceeded` | You've reached the API's call limit. |
 | `DeepL::Exceptions::QuotaExceeded` | You've reached the API's character limit. |
 | `DeepL::Exceptions::RequestError` | An unkown request error. Check `exception.response` and `exception.request` for more information. |
+| `DeepL::Exceptions::NotSupported` | The requested method or API endpoint is not supported. |
 
 An exampling of handling a generic exception:
 

data/VERSION

@@ -1 +1 @@
-2.2.3
+2.4.0

data/deepl-rb.gemspec

@@ -2,16 +2,16 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: deepl-rb 2.2.3 ruby lib
+# stub: deepl-rb 2.4.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "2.2.3"
+  s.version = "2.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
   s.require_paths = ["lib".freeze]
   s.authors = ["Daniel Herzog".freeze]
-  s.date = "2020-11-14"
+  s.date = "2022-01-24"
   s.description = "A simple ruby wrapper for the DeepL translation API (v1). For more information, check this: https://www.deepl.com/docs/api-reference.html".freeze
   s.email = "info@danielherzog.es".freeze
   s.extra_rdoc_files = [
@@ -34,23 +34,30 @@ Gem::Specification.new do |s|
     "lib/deepl/exceptions/bad_request.rb",
     "lib/deepl/exceptions/error.rb",
     "lib/deepl/exceptions/limit_exceeded.rb",
+    "lib/deepl/exceptions/not_supported.rb",
     "lib/deepl/exceptions/quota_exceeded.rb",
     "lib/deepl/exceptions/request_error.rb",
     "lib/deepl/requests/base.rb",
+    "lib/deepl/requests/languages.rb",
     "lib/deepl/requests/translate.rb",
     "lib/deepl/requests/usage.rb",
     "lib/deepl/resources/base.rb",
+    "lib/deepl/resources/language.rb",
     "lib/deepl/resources/text.rb",
     "lib/deepl/resources/usage.rb",
     "spec/api/api_spec.rb",
     "spec/api/configuration_spec.rb",
     "spec/api/deepl_spec.rb",
+    "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/languages.yml",
     "spec/fixtures/vcr_cassettes/translate_texts.yml",
     "spec/fixtures/vcr_cassettes/usage.yml",
+    "spec/requests/languages_spec.rb",
     "spec/requests/translate_spec.rb",
     "spec/requests/usage_spec.rb",
+    "spec/resources/language_spec.rb",
     "spec/resources/text_spec.rb",
     "spec/resources/usage_spec.rb",
     "spec/spec_helper.rb"
@@ -66,8 +73,10 @@ Gem::Specification.new do |s|
 
   if s.respond_to? :add_runtime_dependency then
     s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
+    s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
   else
     s.add_dependency(%q<juwelier>.freeze, [">= 0"])
+    s.add_dependency(%q<byebug>.freeze, [">= 0"])
   end
 end
 

data/lib/deepl/configuration.rb

@@ -18,7 +18,7 @@ module DeepL
     end
 
     def attributes
-      ATTRIBUTES.map { |attr| [attr, send(attr)] }.to_h
+      ATTRIBUTES.to_h { |attr| [attr, send(attr)] }
     end
 
     def ==(other)

data/lib/deepl/exceptions/bad_request.rb

@@ -5,6 +5,8 @@ module DeepL
     class BadRequest < RequestError
       def message
         JSON.parse(response.body)['message']
+      rescue JSON::ParserError
+        response.body
       end
     end
   end

data/lib/deepl/exceptions/not_supported.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module DeepL
+  module Exceptions
+    class NotSupported < Error
+      def initialize(msg = 'The feature is not supported')
+        super
+      end
+    end
+  end
+end

data/lib/deepl/requests/languages.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module DeepL
+  module Requests
+    class Languages < Base
+      def initialize(api, options = {})
+        super(api, options)
+      end
+
+      def request
+        build_languages(*get)
+      end
+
+      private
+
+      def build_languages(request, response)
+        data = JSON.parse(response.body)
+        data.map do |language|
+          Resources::Language.new(language['language'], language['name'],
+                                  language['supports_formality'],
+                                  request, response)
+        end
+      end
+
+      def path
+        'languages'
+      end
+    end
+  end
+end

data/lib/deepl/requests/translate.rb

@@ -8,6 +8,7 @@ module DeepL
       OPTIONS_CONVERSIONS = {
         split_sentences: BOOLEAN_CONVERSION,
         preserve_formatting: BOOLEAN_CONVERSION,
+        outline_detection: BOOLEAN_CONVERSION,
         non_splitting_tags: ARRAY_CONVERSION,
         ignore_tags: ARRAY_CONVERSION
       }.freeze

data/lib/deepl/resources/language.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module DeepL
+  module Resources
+    class Language < Base
+      attr_reader :code, :name
+
+      def initialize(code, name, supports_formality, *args)
+        super(*args)
+
+        @code = code
+        @name = name
+        @supports_formality = supports_formality
+      end
+
+      def to_s
+        "#{code} - #{name}"
+      end
+
+      def supports_formality?
+        return @supports_formality unless @supports_formality.nil?
+
+        raise Exceptions::NotSupported, 'Support formality is only available on target languages'
+      end
+    end
+  end
+end

data/lib/deepl.rb

@@ -11,14 +11,17 @@ require 'deepl/exceptions/authorization_failed'
 require 'deepl/exceptions/bad_request'
 require 'deepl/exceptions/limit_exceeded'
 require 'deepl/exceptions/quota_exceeded'
+require 'deepl/exceptions/not_supported'
 
 # -- Requests
 require 'deepl/requests/base'
+require 'deepl/requests/languages'
 require 'deepl/requests/translate'
 require 'deepl/requests/usage'
 
 # -- Responses and resources
 require 'deepl/resources/base'
+require 'deepl/resources/language'
 require 'deepl/resources/text'
 require 'deepl/resources/usage'
 
@@ -36,6 +39,10 @@ module DeepL
     @api ||= API.new(configuration)
   end
 
+  def languages(options = {})
+    Requests::Languages.new(api, options).request
+  end
+
   def translate(text, source_lang, target_lang, options = {})
     configure if @configuration.nil?
     Requests::Translate.new(api, text, source_lang, target_lang, options).request

data/spec/api/configuration_spec.rb

@@ -16,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

@@ -47,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
 
@@ -65,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
 
@@ -78,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,42 @@ 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
+- request:
+    method: post
+    uri: https://api-free.deepl.com/v2/translate?auth_key=VALID_TOKEN&glossary_id=123
+    body:
+      encoding: US-ASCII
+      string: text=%3Cp%3ESample+text%3C%2Fp%3E&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: 400
+      message: Bad Request
+    headers:
+      Server:
+      - nginx
+      Date:
+      - Tue, 28 Sep 2021 17:20:52 GMT
+      Content-Type:
+      - application/json
+      Content-Length:
+      - '51'
+      Connection:
+      - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
+    body:
+      encoding: UTF-8
+      string: '{"message":"Value for ''termbaseId'' not supported."}'
+  recorded_at: Tue, 28 Sep 2021 17:20:52 GMT
+recorded_with: VCR 6.0.0

data/spec/fixtures/vcr_cassettes/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 20:42:44 GMT
+      - Mon, 17 May 2021 14:18:32 GMT
+      Content-Type:
+      - application/json
       Content-Length:
-      - '52'
+      - '48'
       Connection:
       - keep-alive
+      Access-Control-Allow-Origin:
+      - "*"
     body:
       encoding: UTF-8
-      string: '{"character_count":805718,"character_limit":1000000}'
-    http_version: 
-  recorded_at: Tue, 08 May 2018 20:42:43 GMT
-recorded_with: VCR 4.0.0
+      string: '{"character_count":353,"character_limit":500000}'
+  recorded_at: Mon, 17 May 2021 14:18:32 GMT
+recorded_with: VCR 6.0.0

data/spec/requests/languages_spec.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::Requests::Languages do
+  let(:api) { build_deepl_api }
+  let(:options) { {} }
+  subject { DeepL::Requests::Languages.new(api, options) }
+
+  describe '#initialize' do
+    context 'When building a request' do
+      it 'should create a request object' do
+        expect(subject).to be_a(described_class)
+      end
+    end
+  end
+
+  describe '#request' do
+    around do |example|
+      VCR.use_cassette('languages') { example.call }
+    end
+
+    context 'When requesting source languages' do
+      it 'should return an usage object' do
+        languages = subject.request
+
+        expect(languages).to be_an(Array)
+        expect(languages.size).to eq(24)
+        expect(languages.any? { |l| l.code == 'EN' && l.name == 'English' }).to be_truthy
+        expect(languages.any? { |l| l.code == 'ES' && l.name == 'Spanish' }).to be_truthy
+      end
+    end
+
+    context 'When requesting target languages' do
+      let(:options) { { type: :target } }
+
+      it 'should return an usage object' do
+        languages = subject.request
+
+        expect(languages).to be_an(Array)
+        expect(languages.size).to eq(26)
+        expect(languages.any? { |l| l.code == 'EN' && l.name == 'English' }).to be_falsey
+        expect(languages.any? { |l| l.code == 'ES' && l.name == 'Spanish' }).to be_truthy
+        expect(languages.any? { |l| l.code == 'EN-US' && l.name == 'English (American)' })
+          .to be_truthy
+      end
+    end
+
+    context 'When using an invalid type' do
+      let(:options) { { type: :invalid } }
+
+      it 'should return an usage object' do
+        message = "Parameter 'type' is invalid. 'source' and 'target' are valid values."
+        expect { subject.request }.to raise_error(DeepL::Exceptions::BadRequest, message)
+      end
+    end
+  end
+end

data/spec/requests/translate_spec.rb

@@ -90,6 +90,11 @@ describe DeepL::Requests::Translate do
         expect(request.options[:split_sentences]).to eq('0')
       end
 
+      it 'should leave `nonewlines` as is' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, split_sentences: 'nonewlines')
+        expect(request.options[:split_sentences]).to eq('nonewlines')
+      end
+
       it 'should leave `1` as is' do
         request = DeepL::Requests::Translate.new(api, nil, nil, nil, split_sentences: '1')
         expect(request.options[:split_sentences]).to eq('1')
@@ -117,6 +122,52 @@ describe DeepL::Requests::Translate do
         expect(request.options[:preserve_formatting]).to eq('1')
       end
     end
+
+    context 'when using `outline_detection` options' do
+      it 'should convert `true` to `1`' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, outline_detection: true)
+        expect(request.options[:outline_detection]).to eq('1')
+      end
+
+      it 'should convert `false` to `0`' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, outline_detection: false)
+        expect(request.options[:outline_detection]).to eq('0')
+      end
+
+      it 'should leave `0` as is' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, outline_detection: '0')
+        expect(request.options[:outline_detection]).to eq('0')
+      end
+
+      it 'should leave `1` as is' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, outline_detection: '1')
+        expect(request.options[:outline_detection]).to eq('1')
+      end
+    end
+
+    context 'when using `glossary_id` options' do
+      it 'should work with a nil values' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, glossary_id: nil)
+        expect(request.options[:glossary_id]).to eq(nil)
+      end
+
+      it 'should work with a string' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, glossary_id: 'sample_id')
+        expect(request.options[:glossary_id]).to eq('sample_id')
+      end
+    end
+
+    context 'when using `formality` options' do
+      it 'should work with a nil values' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, formality: nil)
+        expect(request.options[:formality]).to eq(nil)
+      end
+
+      it 'should work with a string' do
+        request = DeepL::Requests::Translate.new(api, nil, nil, nil, formality: 'more')
+        expect(request.options[:formality]).to eq('more')
+      end
+    end
   end
 
   describe '#request' do
@@ -151,6 +202,7 @@ describe DeepL::Requests::Translate do
 
     context 'When performing a valid request with tag handling' do
       let(:text) { '<p>Sample text</p>' }
+      let(:options) { { tag_handling: 'xml' } }
 
       it 'should return a text object' do
         text = subject.request
@@ -163,13 +215,13 @@ describe DeepL::Requests::Translate do
 
     context 'When performing a valid request and passing a variable' do
       let(:text) { 'Welcome and <code>Hello great World</code> Good Morning!' }
-      let(:options) { { ignore_tags: 'code, span' } }
+      let(:options) { { tag_handling: 'xml', ignore_tags: 'code,span' } }
 
       it 'should return a text object' do
         text = subject.request
 
         expect(text).to be_a(DeepL::Resources::Text)
-        expect(text.text).to eq('Bienvenido y <code>Hello great World</code> Buenos días!')
+        expect(text.text).to eq('Bienvenido y <code>Hello great World</code> ¡Buenos días!')
         expect(text.detected_source_language).to eq('EN')
       end
     end
@@ -200,7 +252,7 @@ describe DeepL::Requests::Translate do
         let(:target_lang) { nil }
 
         it 'should raise a bad request error' do
-          message = "Parameter 'target_lang' not specified."
+          message = "Value for 'target_lang' not supported."
           expect { subject.request }.to raise_error(DeepL::Exceptions::BadRequest, message)
         end
       end

data/spec/resources/language_spec.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe DeepL::Resources::Language do
+  subject { described_class.new('EN', 'English', nil, nil, nil) }
+
+  describe '#initialize' do
+    context 'When building a basic object' do
+      it 'should create a resource' do
+        expect(subject).to be_a(described_class)
+      end
+
+      it 'should assign the attributes' do
+        expect(subject.code).to eq('EN')
+        expect(subject.name).to eq('English')
+      end
+
+      it 'should not define the supports formality method' do
+        expect { subject.supports_formality? }.to raise_error(DeepL::Exceptions::NotSupported)
+      end
+    end
+
+    context 'when building a target language object' do
+      subject { described_class.new('EN', 'English', true, nil, nil) }
+
+      it 'should create a resource' do
+        expect(subject).to be_a(described_class)
+      end
+
+      it 'should assign the attributes' do
+        expect(subject.code).to eq('EN')
+        expect(subject.name).to eq('English')
+      end
+
+      it 'should include the supports formality method' do
+        expect { subject.supports_formality? }.not_to raise_error
+        expect(subject.supports_formality?).to be_truthy
+      end
+    end
+  end
+end

data/spec/resources/text_spec.rb

@@ -3,12 +3,12 @@
 require 'spec_helper'
 
 describe DeepL::Resources::Text do
-  subject { DeepL::Resources::Text.new('Target', 'es', nil, nil) }
+  subject { described_class.new('Target', 'es', nil, nil) }
 
   describe '#initialize' do
     context 'When building a basic object' do
       it 'should create a resource' do
-        expect(subject).to be_a(DeepL::Resources::Text)
+        expect(subject).to be_a(described_class)
       end
 
       it 'should assign the attributes' do

data/spec/resources/usage_spec.rb

@@ -3,12 +3,12 @@
 require 'spec_helper'
 
 describe DeepL::Resources::Usage do
-  subject { DeepL::Resources::Usage.new(3, 5, nil, nil) }
+  subject { described_class.new(3, 5, nil, nil) }
 
   describe '#initialize' do
     context 'When building a basic object' do
       it 'should create a resource' do
-        expect(subject).to be_a(DeepL::Resources::Usage)
+        expect(subject).to be_a(described_class)
       end
 
       it 'should assign the attributes' do
@@ -22,7 +22,7 @@ describe DeepL::Resources::Usage do
     end
 
     context 'When building a quota exceeded object' do
-      subject { DeepL::Resources::Usage.new(5, 5, nil, nil) }
+      subject { described_class.new(5, 5, nil, nil) }
 
       it 'should exceed the quota' do
         expect(subject.quota_exceeded?).to be_truthy

data/spec/spec_helper.rb

@@ -27,5 +27,5 @@ end
 
 # General helpers
 def build_deepl_api
-  DeepL::API.new(DeepL::Configuration.new)
+  DeepL::API.new(DeepL::Configuration.new(host: 'https://api-free.deepl.com'))
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: deepl-rb
 version: !ruby/object:Gem::Version
-  version: 2.2.3
+  version: 2.4.0
 platform: ruby
 authors:
 - Daniel Herzog
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-14 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: juwelier
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 'A simple ruby wrapper for the DeepL translation API (v1). For more information,
   check this: https://www.deepl.com/docs/api-reference.html'
 email: info@danielherzog.es
@@ -48,23 +62,30 @@ files:
 - lib/deepl/exceptions/bad_request.rb
 - lib/deepl/exceptions/error.rb
 - lib/deepl/exceptions/limit_exceeded.rb
+- lib/deepl/exceptions/not_supported.rb
 - lib/deepl/exceptions/quota_exceeded.rb
 - lib/deepl/exceptions/request_error.rb
 - lib/deepl/requests/base.rb
+- lib/deepl/requests/languages.rb
 - lib/deepl/requests/translate.rb
 - lib/deepl/requests/usage.rb
 - lib/deepl/resources/base.rb
+- lib/deepl/resources/language.rb
 - lib/deepl/resources/text.rb
 - lib/deepl/resources/usage.rb
 - spec/api/api_spec.rb
 - spec/api/configuration_spec.rb
 - spec/api/deepl_spec.rb
+- 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/languages.yml
 - spec/fixtures/vcr_cassettes/translate_texts.yml
 - spec/fixtures/vcr_cassettes/usage.yml
+- spec/requests/languages_spec.rb
 - spec/requests/translate_spec.rb
 - spec/requests/usage_spec.rb
+- spec/resources/language_spec.rb
 - spec/resources/text_spec.rb
 - spec/resources/usage_spec.rb
 - spec/spec_helper.rb