Contents

# 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 Resources
    class DocumentHandle < Base
      attr_reader :document_id, :document_key

      def initialize(document_id, document_key, *args)
        super(*args)

        @document_id = document_id
        @document_key = document_key
      end

      def to_s
        "DocumentHandle: ID: #{document_id} - Key: #{document_key}"
      end

      ##
      # For this DocumentHandle, waits until the document translation is finished and returns the
      # final status of the document.
      #
      # @return [DeepL::Resources::DocumentTranslationStatus] Final status of the document
      #                                                       translation.

      def wait_until_document_translation_finished
        doc_status = nil
        max_tries = max_doc_status_queries
        num_tries = 0
        loop do
          num_tries += 1
          sleep(calculate_waiting_time(doc_status)) unless doc_status.nil?
          doc_status = DeepL.document.get_status(self)
          break if doc_status.finished? || num_tries > max_tries
        end
        doc_status
      end

      private

      def calculate_waiting_time(_resp)
        # ignore _resp.seconds_remaining for now, while it is unreliable
        5
      end

      def max_doc_status_queries
        configured_value = DeepL.configuration.max_doc_status_queries
        return configured_value unless configured_value.nil?

        10
      end
    end
  end
end

Version data entries

4 entries across 4 versions & 1 rubygems

Version	Path
deepl-rb-3.1.0	lib/deepl/resources/document_handle.rb
deepl-rb-3.0.2	lib/deepl/resources/document_handle.rb
deepl-rb-3.0.1	lib/deepl/resources/document_handle.rb
deepl-rb-3.0.0	lib/deepl/resources/document_handle.rb