deepl-rb 3.6.0 → 3.6.1

data/deepl-rb.gemspec

@@ -0,0 +1,140 @@
+# Generated by juwelier
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Juwelier::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+# stub: deepl-rb 3.6.1 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "deepl-rb".freeze
+  s.version = "3.6.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0".freeze) if s.respond_to? :required_rubygems_version=
+  s.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" } if s.respond_to? :metadata=
+  s.require_paths = ["lib".freeze]
+  s.authors = ["DeepL SE".freeze]
+  s.date = "2025-12-19"
+  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",
+    "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/constants/base_constant.rb",
+    "lib/deepl/constants/formality.rb",
+    "lib/deepl/constants/model_type.rb",
+    "lib/deepl/constants/split_sentences.rb",
+    "lib/deepl/constants/tag_handling.rb",
+    "lib/deepl/constants/tone.rb",
+    "lib/deepl/constants/writing_style.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",
+    "lib/deepl/exceptions/not_supported.rb",
+    "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",
+    "lib/deepl/requests/glossary/find.rb",
+    "lib/deepl/requests/glossary/language_pairs.rb",
+    "lib/deepl/requests/glossary/list.rb",
+    "lib/deepl/requests/languages.rb",
+    "lib/deepl/requests/rephrase.rb",
+    "lib/deepl/requests/style_rule/list.rb",
+    "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/style_rule.rb",
+    "lib/deepl/resources/text.rb",
+    "lib/deepl/resources/usage.rb",
+    "lib/deepl/style_rule_api.rb",
+    "lib/deepl/utils/backoff_timer.rb",
+    "lib/deepl/utils/exception_builder.rb",
+    "lib/http_client_options.rb",
+    "lib/version.rb",
+    "license_checker.sh",
+    "spec/api/api_spec.rb",
+    "spec/api/configuration_spec.rb",
+    "spec/api/deepl_spec.rb",
+    "spec/constants/constants_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_rephrase.yml",
+    "spec/fixtures/vcr_cassettes/deepl_translate.yml",
+    "spec/fixtures/vcr_cassettes/deepl_usage.yml",
+    "spec/fixtures/vcr_cassettes/glossaries.yml",
+    "spec/fixtures/vcr_cassettes/languages.yml",
+    "spec/fixtures/vcr_cassettes/rephrase_texts.yml",
+    "spec/fixtures/vcr_cassettes/style_rules.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/integration_tests/style_rule_api_spec.rb",
+    "spec/requests/extra_body_parameters_types_spec.rb",
+    "spec/requests/glossary/create_spec.rb",
+    "spec/requests/glossary/destroy_spec.rb",
+    "spec/requests/glossary/entries_spec.rb",
+    "spec/requests/glossary/find_spec.rb",
+    "spec/requests/glossary/language_pairs_spec.rb",
+    "spec/requests/glossary/list_spec.rb",
+    "spec/requests/languages_spec.rb",
+    "spec/requests/rephrase_spec.rb",
+    "spec/requests/translate_spec.rb",
+    "spec/requests/usage_spec.rb",
+    "spec/resources/glossary_spec.rb",
+    "spec/resources/language_pair_spec.rb",
+    "spec/resources/language_spec.rb",
+    "spec/resources/text_spec.rb",
+    "spec/resources/usage_spec.rb",
+    "spec/spec_helper.rb"
+  ]
+  s.homepage = "https://github.com/DeepLcom/deepl-rb".freeze
+  s.licenses = ["MIT".freeze]
+  s.rubygems_version = "3.4.6".freeze
+  s.summary = "Official Ruby library for the DeepL language translation API.".freeze
+
+  s.specification_version = 4
+
+  s.add_development_dependency(%q<juwelier>.freeze, [">= 0"])
+  s.add_development_dependency(%q<byebug>.freeze, [">= 0"])
+end
+

data/lib/deepl/api.rb

@@ -0,0 +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, :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

@@ -0,0 +1,59 @@
+# 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 logger max_doc_status_queries max_network_retries user_agent
+                    version].freeze
+
+    attr_accessor(*ATTRIBUTES)
+
+    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 ||= 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!
+      raise Exceptions::Error, 'auth_key not provided' if auth_key.nil? || auth_key.empty?
+    end
+
+    def attributes
+      ATTRIBUTES.to_h { |attr| [attr, send(attr)] }
+    end
+
+    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/#{DeepL::VERSION}"
+      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/constants/base_constant.rb

@@ -0,0 +1,18 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class BaseConstant
+      def self.options
+        constants.map { |const| const_get(const) }
+      end
+
+      def self.valid?(value)
+        options.include?(value)
+      end
+    end
+  end
+end

data/lib/deepl/constants/formality.rb

@@ -0,0 +1,16 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class Formality < BaseConstant
+      DEFAULT = 'default'
+      MORE = 'more'
+      LESS = 'less'
+      PREFER_MORE = 'prefer_more'
+      PREFER_LESS = 'prefer_less'
+    end
+  end
+end

data/lib/deepl/constants/model_type.rb

@@ -0,0 +1,14 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class ModelType < BaseConstant
+      QUALITY_OPTIMIZED = 'quality_optimized'
+      PREFER_QUALITY_OPTIMIZED = 'prefer_quality_optimized'
+      LATENCY_OPTIMIZED = 'latency_optimized'
+    end
+  end
+end

data/lib/deepl/constants/split_sentences.rb

@@ -0,0 +1,14 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class SplitSentences < BaseConstant
+      NO_SPLITTING = '0'
+      SPLIT_ON_PUNCTUATION_AND_NEWLINES = '1'
+      SPLIT_ON_PUNCTUATION_ONLY = 'nonewlines'
+    end
+  end
+end

data/lib/deepl/constants/tag_handling.rb

@@ -0,0 +1,13 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class TagHandling < BaseConstant
+      XML = 'xml'
+      HTML = 'html'
+    end
+  end
+end

data/lib/deepl/constants/tone.rb

@@ -0,0 +1,20 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class Tone < BaseConstant
+      DEFAULT = 'default'
+      ENTHUSIASTIC = 'enthusiastic'
+      FRIENDLY = 'friendly'
+      CONFIDENT = 'confident'
+      DIPLOMATIC = 'diplomatic'
+      PREFER_ENTHUSIASTIC = 'prefer_enthusiastic'
+      PREFER_FRIENDLY = 'prefer_friendly'
+      PREFER_CONFIDENT = 'prefer_confident'
+      PREFER_DIPLOMATIC = 'prefer_diplomatic'
+    end
+  end
+end

data/lib/deepl/constants/writing_style.rb

@@ -0,0 +1,20 @@
+# Copyright 2025 DeepL SE (https://www.deepl.com)
+# Use of this source code is governed by an MIT
+# license that can be found in the LICENSE.md file.
+# frozen_string_literal: true
+
+module DeepL
+  module Constants
+    class WritingStyle < BaseConstant
+      DEFAULT = 'default'
+      SIMPLE = 'simple'
+      BUSINESS = 'business'
+      ACADEMIC = 'academic'
+      CASUAL = 'casual'
+      PREFER_SIMPLE = 'prefer_simple'
+      PREFER_BUSINESS = 'prefer_business'
+      PREFER_ACADEMIC = 'prefer_academic'
+      PREFER_CASUAL = 'prefer_casual'
+    end
+  end
+end

data/lib/deepl/document_api.rb

@@ -0,0 +1,121 @@
+# 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). If nil, will use
+    #                               the filename of +input_file_path+.
+    # @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, # rubocop:disable Metrics/MethodLength,Metrics/ParameterLists
+                           filename = nil, 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

@@ -0,0 +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 AuthorizationFailed < RequestError
+      def to_s
+        'Authorization failed. Please supply a valid auth_key parameter.'
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/bad_request.rb

@@ -0,0 +1,16 @@
+# 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 BadRequest < RequestError
+      def to_s
+        JSON.parse(response.body)['message']
+      rescue JSON::ParserError
+        response.body
+      end
+    end
+  end
+end

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

@@ -0,0 +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

@@ -0,0 +1,18 @@
+# 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 LimitExceeded < RequestError
+      def to_s
+        '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

@@ -0,0 +1,16 @@
+# 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
+  module Exceptions
+    class NotFound < RequestError
+      def to_s
+        JSON.parse(response.body)['message']
+      rescue JSON::ParserError
+        response.body
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/not_supported.rb

@@ -0,0 +1,14 @@
+# 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
+  module Exceptions
+    class NotSupported < Error
+      def initialize(msg = 'The feature is not supported')
+        super
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/quota_exceeded.rb

@@ -0,0 +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 QuotaExceeded < RequestError
+      def to_s
+        'Quota exceeded. The character limit has been reached.'
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/request_entity_too_large.rb

@@ -0,0 +1,15 @@
+# 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
+  module Exceptions
+    class RequestEntityTooLarge < RequestError
+      def to_s
+        'The request size has reached the supported limit. ' \
+          "Make sure that you're not sending more than 50 text parts."
+      end
+    end
+  end
+end

data/lib/deepl/exceptions/request_error.rb

@@ -0,0 +1,21 @@
+# 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 RequestError < Error
+      attr_reader :request, :response
+
+      def initialize(response)
+        super()
+        @response = response
+      end
+
+      def to_s
+        'Unknown error.'
+      end
+    end
+  end
+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 to_s
+        'An internal server error occured. Try again after waiting a short period.'
+      end
+
+      def should_retry?
+        true
+      end
+    end
+  end
+end