deepl-rb 2.5.3 → 3.0.0

data/SECURITY.md

@@ -0,0 +1,58 @@
+To report security concerns or vulnerabilities within deepl-rb, please email
+us at [security@deepl.com](mailto:security@deepl.com).
+
+You can send us PGP-encrypted email using the following PGP public key:
+
+```
+-----BEGIN PGP PUBLIC KEY BLOCK-----
+
+mQINBF7WSmABEADzRUp22VY7bVfUWScKLi9o8BRSEL4u3aPn9WOQoRLQH0j3dNNQ
+FQlwTPn/Ez6qreEl8mX0aE+eLCEykXqsrU/UaTSTslF+H6UQyuGLXkRm8Lblt93I
+OEhL069fC7rm+/zJq72+hishBF8DXqa+WtFd8VfK3i211vRhU/teKeAKT0xiuN/5
+EQl1Bn7jR7mmQtNbPBhCsAlaC/tNUQ3Lyj6LYnnco7ums5Q/gCvfs2HM3mXJyvnG
+1MC2IrECPowTt04W3V1uXuMcm766orTG/AmtBIbPmOzao4sfqwRVHGvc8zcr1az9
+0nVyEJXx1eUVRDU1GAQuMjEkGgwvTd+nt6sHpn8C+9hMYJhon9veDSupViBuvNRC
+p1PnpSLYYy7tA7DPXMhP3cMXe+Z4bYzgwi3xjOwh6SDyB4OFIxtGyuMrLGfZnd6A
+hDH4H9zHPpciD5MxcOaqlKdgABQALvc6MvJ1Guf1ckGTbfHz1brtR1LPMK8rrnNu
+kwQzgkogYV6YAnt8LPXMPa2Vgy8TAiby7GPaATPeSWdNHtkuYGhWNVbnb60kEWiJ
+/RgHFZYfRT1dEcKoQEcDJ7AV14urEFIAfmhlsT8h7iJYUQMa45BakUubi3aWwcme
+ya+5WXvp2xU14VMfrscApA0e1v0VcTNVwlKambs/lwims0/xiSaXJS6gVwARAQAB
+tCNEZWVwTCBTZWN1cml0eSA8c2VjdXJpdHlAZGVlcGwuY29tPokCTgQTAQgAOBYh
+BGvTAPE3gtThLDZ9+ey96Y7yK41BBQJe1kpgAhsDBQsJCAcCBhUKCQgLAgQWAgMB
+Ah4BAheAAAoJEOy96Y7yK41BHVIP/04R08g4N32c47edY6z3sl3DAf+/6UI4Bc4S
+Jg5L4JcfrsKaDd55plps8nj31VXrxVBO0NrO6HLC50SXbYVrANyo0occ2mIoU8c2
+tNbYCUmJ3QjlUwDjHWlMV2J9FcfZkv7z+2TDY6DF8MKqCMi8j7Pnj0hlY0JytciH
+SGES1q8+//8tG9z6b6vvxBFfJI+iNXvcbn6uU1WRvGoBqq2A13fXuwTXiNNphsvu
+kHqBHSxnf/EAmcmBX0tm6yaWDdwy+rrcDNwXiqqvK6DFWEE7+/9t2FhlgzvuCOfx
+dQVMZL8WH2rr6OPQLDgtGxEUFmD+srmqbVn5NKdY6lQ/BEaraozDkuqJEb0/L/kb
+Dv+buz8rmKze0XPlrt1XTQ5ZDQp8AMAaPp1UsizVhasZgxxuUa+g5mMbJr7TSNJN
+CIqidnh1MEyIr3IccOAr2F51hn6keKIdVnO4dWrWNMTfk00dw3fPGFhNTniITTF2
+s3oJ8cy2NMNkVMP5XL3bulpgkKN+hXa4IHkTfWRv7hfYJ/3i3yTRNRjYGRoVp7eM
+iADumKaZy5Szl458txuI+p9DGAEvkSJoF7ptwedSvVZ/FZukS5mwYisRV9shzsXF
+3jpcGZ1B3qS68r9ySqnPEWR6oT8p63fpMNVMjz5r4YEbvU0A62OhUk52drLM6SgC
+mdOZcmnHuQINBF7WSmABEADc6L/wSexm4l1GWZSQpJ35ldlu7jjWQGguQeeG2900
+aEI3UcftMCWg+apwf4h4Yj2YjzUncYAM6RenGvXgZUYQe3OHb8uqpkSmYHUdB/Uq
+I4NPO3e8RMDo9YohPKCpZ7jV70X8F9GOUkUgfp29CjrMOYgSLwkSyWotsQ9KtkEH
+Sx/h+gviIERe0dkiN9lCsReNigoWLleH4qBSZGPxqF4tzANJ6D2tnAv+6KUQvho3
+CdijBiia4o16p9M0altSqsZCEX1Y5BKmWIh9fvvS2uB7SdzS0gcASzlekMGCjG10
+dNji+uSNdHExlbl0kUpEL1TuY2hxPBa6lc1hckI3dGng0jIFlio4s8DG3Utmrj3C
+KQFxnjqtO+uaJ8HdNo8ObtEp/v9TpsHWUchBTrBP4XN5KwqkljF8XVBA6ceh8H38
+7/RVWRcWp6h30ROm1DTnAGxJk02fbjpnEO0EvudxKTlnAJXV6z+Tm3yYaR4gQYa3
+/zfLZgz0z0MqNUsGephZGPzfUX7Lsz6HGUoo7I1KST6xD2QodJYOhHIEOgsqskk+
+cgeXp45X5JLlCQaBLQoL8ut6CTcop1/6U+JZtrm6DdXTZfq57sqfDI+gkG8WljRY
+yhsCL+xWiwDjtt/8kpk+W75EQmwPuctoS85Rm6hEpffewdQtb2XCEWpbta6hE1r1
+kQARAQABiQI2BBgBCAAgFiEEa9MA8TeC1OEsNn357L3pjvIrjUEFAl7WSmACGwwA
+CgkQ7L3pjvIrjUHFvg/9GnIW9SM/nYJpi1xZVWWGwQ+/kTceD50bv8kyvNaia/9m
+HG6n83xHNTRBYnt8NtTqHvW0y20Cp3gUs2WxboDgCIb3+srI2ipwiaDJcq+rVr0f
+XkCe5MryioKRbTFQ8OgvKh9GK/tYtqZakn7Q9596ajUjHOQV1+Uw/jywLYRlcbqI
+zbxyNVWitxPs3Z7jUDAvhPOIOmhLFc+QxSYrs1W4ZEGnZ3+9utqzlEiMusy9Rq0T
+/W/wrG6SckebjhrwWZJmy/hkW6V6LUX4++vCVV5+zwsvgEortCV8bhvLfqQDr/WN
+fnmbNZtXJbyhTYbcYReOLeKidxO2lZEemnX6iOt5xCdoMcYU23xDT9+tE7Eh6Nfw
+einZemBwfku5vxxPF73pOoQUCRq9tgvUrEq+3BqkqidhnFUOPi0J5726q1PBG65x
+5o+SQyvB3NA3al3mEH65z3V3/g0UHnhGcEMwVOXBkffgdKNhWYw59qhSVQnkiq0U
+MG10g/RL7VdiISAFPTDmKWUaEDYosinKqOMHwcaVdJq9ssvPf89et6yP/ZkbLIHs
+2y3oiPonh2RMxi2OedlDz+Jp/A2o3qHmwNvBx/meGB0praGUonFVZTAA1EMS39Bi
+NhG/L8giTyzA0mMkTJAPXtUVlRe5rEjORgYJsgRqZxEfpsJC9OkvYS4ayO0eCEs=
+=jVHt
+-----END PGP PUBLIC KEY BLOCK-----
+```%

data/VERSION

@@ -1 +1 @@
-2.5.3
+3.0.0

data/deepl-rb.gemspec

@@ -2,36 +2,46 @@
 # DO NOT EDIT THIS FILE DIRECTLY
 # Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
-# stub: deepl-rb 2.5.3 ruby lib
+# stub: deepl-rb 3.0.0 ruby lib
 
 Gem::Specification.new do |s|
   s.name = "deepl-rb".freeze
-  s.version = "2.5.3"
+  s.version = "3.0.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 = "2022-09-26"
-  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.authors = ["DeepL SE".freeze]
+  s.date = "2024-09-20"
+  s.description = "Official Ruby library for the DeepL language translation API (v2). For more information, check this: https://www.deepl.com/docs/api-reference.html".freeze
+  s.email = "open-source@deepl.com".freeze
   s.extra_rdoc_files = [
+    "CHANGELOG.md",
     "LICENSE.md",
-    "README.md"
+    "README.md",
+    "license_checker.sh"
   ]
   s.files = [
     ".circleci/config.yml",
+    ".github/workflows/add_issues_to_kanban.yml",
+    ".gitlab-ci.yml",
     ".rubocop.yml",
+    "CHANGELOG.md",
+    "CODE_OF_CONDUCT.md",
+    "CONTRIBUTING.md",
     "Gemfile",
     "LICENSE.md",
     "README.md",
     "Rakefile",
+    "SECURITY.md",
     "VERSION",
     "deepl-rb.gemspec",
     "lib/deepl.rb",
     "lib/deepl/api.rb",
     "lib/deepl/configuration.rb",
+    "lib/deepl/document_api.rb",
     "lib/deepl/exceptions/authorization_failed.rb",
     "lib/deepl/exceptions/bad_request.rb",
+    "lib/deepl/exceptions/document_translation_error.rb",
     "lib/deepl/exceptions/error.rb",
     "lib/deepl/exceptions/limit_exceeded.rb",
     "lib/deepl/exceptions/not_found.rb",
@@ -39,8 +49,12 @@ Gem::Specification.new do |s|
     "lib/deepl/exceptions/quota_exceeded.rb",
     "lib/deepl/exceptions/request_entity_too_large.rb",
     "lib/deepl/exceptions/request_error.rb",
+    "lib/deepl/exceptions/server_error.rb",
     "lib/deepl/glossary_api.rb",
     "lib/deepl/requests/base.rb",
+    "lib/deepl/requests/document/download.rb",
+    "lib/deepl/requests/document/get_status.rb",
+    "lib/deepl/requests/document/upload.rb",
     "lib/deepl/requests/glossary/create.rb",
     "lib/deepl/requests/glossary/destroy.rb",
     "lib/deepl/requests/glossary/entries.rb",
@@ -51,15 +65,22 @@ Gem::Specification.new do |s|
     "lib/deepl/requests/translate.rb",
     "lib/deepl/requests/usage.rb",
     "lib/deepl/resources/base.rb",
+    "lib/deepl/resources/document_handle.rb",
+    "lib/deepl/resources/document_translation_status.rb",
     "lib/deepl/resources/glossary.rb",
     "lib/deepl/resources/language.rb",
     "lib/deepl/resources/language_pair.rb",
     "lib/deepl/resources/text.rb",
     "lib/deepl/resources/usage.rb",
+    "lib/deepl/utils/backoff_timer.rb",
     "lib/deepl/utils/exception_builder.rb",
+    "lib/http_client_options.rb",
+    "license_checker.sh",
     "spec/api/api_spec.rb",
     "spec/api/configuration_spec.rb",
     "spec/api/deepl_spec.rb",
+    "spec/fixtures/vcr_cassettes/deepl_document.yml",
+    "spec/fixtures/vcr_cassettes/deepl_document_download.yml",
     "spec/fixtures/vcr_cassettes/deepl_glossaries.yml",
     "spec/fixtures/vcr_cassettes/deepl_languages.yml",
     "spec/fixtures/vcr_cassettes/deepl_translate.yml",
@@ -68,6 +89,8 @@ Gem::Specification.new do |s|
     "spec/fixtures/vcr_cassettes/languages.yml",
     "spec/fixtures/vcr_cassettes/translate_texts.yml",
     "spec/fixtures/vcr_cassettes/usage.yml",
+    "spec/integration_tests/document_api_spec.rb",
+    "spec/integration_tests/integration_test_utils.rb",
     "spec/requests/glossary/create_spec.rb",
     "spec/requests/glossary/destroy_spec.rb",
     "spec/requests/glossary/entries_spec.rb",
@@ -84,21 +107,14 @@ Gem::Specification.new do |s|
     "spec/resources/usage_spec.rb",
     "spec/spec_helper.rb"
   ]
-  s.homepage = "http://github.com/wikiti/deepl-rb".freeze
+  s.homepage = "https://github.com/DeepLcom/deepl-rb".freeze
   s.licenses = ["MIT".freeze]
-  s.rubygems_version = "3.3.7".freeze
-  s.summary = "A simple ruby wrapper for the DeepL API".freeze
+  s.rubygems_version = "3.4.6".freeze
+  s.summary = "Official Ruby library for the DeepL language translation API.".freeze
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 4
-  end
+  s.specification_version = 4
 
-  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
+  s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
+  s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
 end
 

data/lib/deepl/api.rb

@@ -1,12 +1,22 @@
+# Copyright 2018 Daniel Herzog
+# 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
   class API
-    attr_reader :configuration
+    attr_reader :configuration, :http_client
 
     def initialize(configuration)
       @configuration = configuration
       configuration.validate!
+      uri = URI(configuration.host)
+      @http_client = Net::HTTP.new(uri.host, uri.port)
+      @http_client.use_ssl = uri.scheme == 'https'
+    end
+
+    def update_http_client(client)
+      @http_client = client
     end
   end
 end

data/lib/deepl/configuration.rb

@@ -1,16 +1,32 @@
+# Copyright 2018 Daniel Herzog
+# 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
   class Configuration
-    ATTRIBUTES = %i[auth_key host version].freeze
+    ATTRIBUTES = %i[auth_key host logger max_doc_status_queries max_network_retries user_agent
+                    version].freeze
 
     attr_accessor(*ATTRIBUTES)
 
-    def initialize(data = {})
+    DEEPL_SERVER_URL = 'https://api.deepl.com'
+    DEEPL_SERVER_URL_FREE = 'https://api-free.deepl.com'
+    private_constant :DEEPL_SERVER_URL, :DEEPL_SERVER_URL_FREE
+
+    def initialize(data = {}, app_info_name = nil, app_info_version = nil, send_platform_info = true) # rubocop:disable all
       data.each { |key, value| send("#{key}=", value) }
       @auth_key ||= ENV.fetch('DEEPL_AUTH_KEY', nil)
-      @host ||= 'https://api.deepl.com'
+      @host ||= ENV.fetch('DEEPL_SERVER_URL', nil)
+      @host ||= if self.class.free_account_auth_key?(@auth_key)
+                  DEEPL_SERVER_URL_FREE
+                else
+                  DEEPL_SERVER_URL
+                end
       @version ||= 'v2'
+      @user_agent ||= construct_user_agent(send_platform_info, app_info_name, app_info_version)
+      @max_network_retries ||= 5
+      @logger ||= nil
     end
 
     def validate!
@@ -24,5 +40,20 @@ module DeepL
     def ==(other)
       attributes == other.attributes
     end
+
+    def self.free_account_auth_key?(key)
+      key&.end_with?(':fx')
+    end
+
+    def construct_user_agent(send_platform_info, app_info_name, app_info_version)
+      library_info_str = 'deepl-ruby/2.5.3'
+      if send_platform_info
+        library_info_str += " (#{RbConfig::CONFIG['host_os']}) ruby/#{RUBY_VERSION}"
+      end
+      if app_info_name && app_info_version
+        library_info_str += " #{app_info_name}/#{app_info_version}"
+      end
+      library_info_str
+    end
   end
 end

data/lib/deepl/document_api.rb

@@ -0,0 +1,120 @@
+# Copyright 2024 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+module DeepL
+  class DocumentApi
+    def initialize(api, options = {})
+      @api = api
+      @options = options
+    end
+
+    ##
+    # Uploads the file at the given +input_file_path+ to be translated from +source_lang+ into
+    # +target_lang+. The API interface is async, so you need to poll using the returned
+    # `DeepL::Resources::DocumentHandle` until the translation is finished, then you can download it
+    #
+    # @param [String] input_file_path File path to the file to be translated
+    # @param [String, nil] source_lang Source language to use for the translation. `nil` will cause
+    #                                  automatic source langauge detection to be used. Must be
+    #                                  formatted as ISO 639-1, 2-letter language codes.
+    # @param [String] target_lang Target language to use for the translation. Must be formatted as
+    #                             ISO 639-1, 2-letter language codes, plus a hyphen "-" with the
+    #                             variant identifier for languages with variants/dialects/... .
+    # @param [String, nil] filename The filename of the file, including its extension. Used to open
+    #                               the different kinds of documents (PDFs, etc). If nil, will use
+    #                               the filename of +input_file_path+.
+    # @param [Hash] options Additional (body) options for the upload.
+    # @param [Hash] additional_headers Additional HTTP headers for the upload.
+    # @return [DeepL::Resources::DocumentHandle] Document handle for the uploaded document.
+
+    def upload(input_file_path, source_lang, target_lang, filename = nil, options = {},
+               additional_headers = {})
+      DeepL::Requests::Document::Upload.new(@api, input_file_path, source_lang, target_lang,
+                                            filename, options, additional_headers)
+                                       .request
+    end
+
+    ##
+    # Queries the status of the translation of the document with the given +document_handle+.
+    #
+    # @param [DeepL::Resources::DocumentHandle] document_handle Handle returned by the `upload`
+    # method.
+    # @param [Hash] options Additional options for the upload.
+    # @param [Hash] additional_headers Additional HTTP headers for the status check.
+    # @return [DeepL::Resources::DocumentTranslationStatus] Status of the document translation.
+
+    def get_status(document_handle, options = {}, additional_headers = {})
+      DeepL::Requests::Document::GetStatus.new(@api, document_handle.document_id,
+                                               document_handle.document_key, options,
+                                               additional_headers).request
+    end
+
+    ##
+    # Downloads the document identified by the +document_handle+ to +output_file+
+    #
+    # @param [DeepL::Resources::DocumentHandle] document_handle Handle returned by the `upload`
+    # method.
+    # @param [String] output_file Path to the file to write to. Will be overwritten if the file
+    #                             already exists.
+    # @return [DeepL::Resources::DocumentTranslationStatus] Status of the document translation.
+
+    def download(document_handle, output_file)
+      DeepL::Requests::Document::Download.new(@api, document_handle.document_id,
+                                              document_handle.document_key, output_file).request
+    end
+
+    ##
+    # Translates a document with the DeepL API, `sleep`ing during waiting periods. Returns the
+    # status that was queried last. This can be either because the document translation terminated
+    # (successfully or with an error) or because the maximum number of status requests have been
+    # made. See the parameter `max_doc_status_queries` for details.
+    #
+    # @raise [DocumentTranslationError] If any error occurs during the process.
+    #
+    # @param [String] input_file Path to the file to be translated
+    # @param [String] output_file Path to the file to write to. Will be overwritten if the file
+    #                             already exists.
+    # @param [String, nil] source_lang Source language to use for the translation. `nil` will cause
+    #                                  automatic source langauge detection to be used. Must be
+    #                                  formatted as ISO 639-1, 2-letter language codes.
+    # @param [String] target_lang Target language to use for the translation. Must be formatted as
+    #                             ISO 639-1, 2-letter language codes, plus a hyphen "-" with the
+    #                             variant identifier for languages with variants/dialects/... .
+    # @param [String, nil] filename The filename of the file, including its extension. Used to open
+    #                               the different kinds of documents (PDFs, etc).
+    # @param [Hash] options Additional options for the upload.
+    # @param [Hash] additional_headers Additional headers for the upload.
+    # @return [DeepL::Resources::DocumentTranslationStatus] Status of the document translation.
+
+    def translate_document(input_file, output_file, source_lang, target_lang, filename, # rubocop:disable Metrics/MethodLength,Metrics/ParameterLists
+                           options = {}, additional_headers = {})
+      raise IOError 'File already exists at output path' if File.exist?(output_file)
+
+      begin
+        handle = upload(input_file, source_lang, target_lang, filename, options,
+                        additional_headers)
+        translate_document_wait_and_download(handle, output_file)
+      rescue StandardError => e
+        FileUtils.rm_f(output_file)
+        raise Exceptions::DocumentTranslationError.new(
+          "Error occurred during document translation: #{e.message}", handle
+        )
+      end
+    end
+
+    private
+
+    def translate_document_wait_and_download(document_handle, output_file)
+      doc_status = document_handle.wait_until_document_translation_finished
+      if doc_status.error?
+        raise Exceptions::DocumentTranslationError.new(
+          "Exception when querying document status #{doc_status.error_message}", document_handle
+        )
+      else
+        download(document_handle, output_file)
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/authorization_failed.rb

@@ -1,3 +1,6 @@
+# Copyright 2018 Daniel Herzog
+# 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

data/lib/deepl/exceptions/bad_request.rb

@@ -1,3 +1,6 @@
+# Copyright 2018 Daniel Herzog
+# 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

data/lib/deepl/exceptions/document_translation_error.rb

@@ -0,0 +1,15 @@
+# Copyright 2024 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+module DeepL
+  module Exceptions
+    class DocumentTranslationError < Error
+      def initialize(message, handle)
+        super(message)
+        @handle = handle
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/error.rb

@@ -1,8 +1,14 @@
+# Copyright 2018 Daniel Herzog
+# 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 Exceptions
     class Error < StandardError
+      def should_retry?
+        false
+      end
     end
   end
 end

data/lib/deepl/exceptions/limit_exceeded.rb

@@ -1,3 +1,6 @@
+# Copyright 2018 Daniel Herzog
+# 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
@@ -6,6 +9,10 @@ module DeepL
       def message
         'Limit exceeded. Please wait and send your request once again.'
       end
+
+      def should_retry?
+        true
+      end
     end
   end
 end

data/lib/deepl/exceptions/not_found.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 Daniel Herzog
+# 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

data/lib/deepl/exceptions/not_supported.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 Daniel Herzog
+# 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

data/lib/deepl/exceptions/quota_exceeded.rb

@@ -1,3 +1,6 @@
+# Copyright 2018 Daniel Herzog
+# 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

data/lib/deepl/exceptions/request_entity_too_large.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 Daniel Herzog
+# 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

data/lib/deepl/exceptions/request_error.rb

@@ -1,3 +1,6 @@
+# Copyright 2018 Daniel Herzog
+# 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
@@ -5,9 +8,8 @@ module DeepL
     class RequestError < Error
       attr_reader :request, :response
 
-      def initialize(request, response)
+      def initialize(response)
         super()
-        @request = request
         @response = response
       end
 

data/lib/deepl/exceptions/server_error.rb

@@ -0,0 +1,18 @@
+# Copyright 2024 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE file.
+# frozen_string_literal: true
+
+module DeepL
+  module Exceptions
+    class ServerError < RequestError
+      def message
+        'An internal server error occured. Try again after waiting a short period.'
+      end
+
+      def should_retry?
+        true
+      end
+    end
+  end
+end

data/lib/deepl/glossary_api.rb

@@ -1,3 +1,6 @@
+# Copyright 2022 Daniel Herzog
+# 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