deepl-rb 3.6.0 → 3.7.0

data/lib/deepl/requests/document/get_status.rb

@@ -0,0 +1,44 @@
+# 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 Requests
+    module Document
+      class GetStatus < Base
+        attr_reader :document_id, :document_key
+
+        def initialize(api, document_id, document_key, options = {}, additional_headers = {})
+          super(api, options, additional_headers)
+          @document_id = document_id
+          @document_key = document_key
+        end
+
+        def request
+          payload = { document_key: document_key }
+          build_doc_translation_status(*execute_request_with_retries(post_request(payload)))
+        end
+
+        def details
+          "HTTP Headers: #{headers}\nPayload #{{ document_key: document_key }}"
+        end
+
+        def to_s
+          "POST #{uri.request_uri}"
+        end
+
+        private
+
+        def build_doc_translation_status(request, response)
+          document_translation_status = JSON.parse(response.body)
+          Resources::DocumentTranslationStatus.new(document_translation_status, request, response)
+        end
+
+        def path
+          "document/#{document_id}"
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/document/upload.rb

@@ -0,0 +1,75 @@
+# 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 Requests
+    module Document
+      class Upload < Base
+        attr_reader :input_file_path, :source_lang, :target_lang, :filename
+
+        SUPPORTED_OPTIONS = %w[formality glossary_id output_format].freeze
+
+        def initialize(api, input_file_path, source_lang, target_lang, filename = nil, # rubocop:disable Metrics/ParameterLists
+                       options = {}, additional_headers = {})
+          super(api, options, additional_headers)
+          @input_file_path = input_file_path
+          @source_lang = source_lang
+          @target_lang = target_lang
+          @filename = filename
+        end
+
+        def request
+          File.open(input_file_path, 'rb') do |input_file|
+            form_data = build_base_form_data(input_file)
+            apply_extra_body_parameters_to_form(form_data)
+            build_doc_handle(*execute_request_with_retries(post_request_with_file(form_data),
+                                                           [input_file]))
+          end
+        end
+
+        def details
+          "HTTP Headers: #{headers}\nPayload #{[
+            ['file', "File at #{input_file_path} opened in binary mode"],
+            ['source_lang', source_lang], ['target_lang', target_lang], ['filename', filename]
+          ]}"
+        end
+
+        def to_s
+          "POST #{uri.request_uri}"
+        end
+
+        private
+
+        def build_base_form_data(input_file)
+          form_data = [
+            ['file', input_file], ['source_lang', source_lang],
+            ['target_lang', target_lang]
+          ]
+          filename_param = filename || File.basename(input_file_path)
+          form_data.push(['filename', filename_param]) unless filename_param.nil?
+          add_supported_options_to_form(form_data)
+          form_data
+        end
+
+        def add_supported_options_to_form(form_data)
+          SUPPORTED_OPTIONS.each do |option_name|
+            option_value = option(option_name)
+            form_data.push([option_name, option_value]) unless option_value.nil?
+          end
+        end
+
+        def build_doc_handle(request, response)
+          parsed_response = JSON.parse(response.body)
+          Resources::DocumentHandle.new(parsed_response['document_id'],
+                                        parsed_response['document_key'], request, response)
+        end
+
+        def path
+          'document'
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/glossary/create.rb

@@ -0,0 +1,59 @@
+# 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 Requests
+    module Glossary
+      class Create < Base
+        attr_reader :name, :source_lang, :target_lang, :entries, :entries_format
+
+        def initialize(api, name, source_lang, target_lang, entries, options = {})
+          super(api, options)
+          @name = name
+          @source_lang = source_lang
+          @target_lang = target_lang
+          @entries = entries
+          @entries_format = delete_option(:entries_format) || 'tsv'
+        end
+
+        def request
+          payload = {
+            name: name, source_lang: source_lang, target_lang: target_lang, entries: entries_to_tsv,
+            entries_format: entries_format
+          }
+          build_glossary(*execute_request_with_retries(post_request(payload)))
+        end
+
+        def details
+          "HTTP Headers: #{headers}\nPayload #{{
+            name: name, source_lang: source_lang, target_lang: target_lang, entries: entries_to_tsv,
+            entries_format: entries_format
+          }}"
+        end
+
+        def to_s
+          "POST #{uri.request_uri}"
+        end
+
+        private
+
+        def entries_to_tsv
+          return entries if entries.is_a?(String)
+
+          entries.reduce('') { |tsv, entry| "#{tsv}#{entry.first}\t#{entry.last}\n" }
+        end
+
+        def build_glossary(request, response)
+          glossary = JSON.parse(response.body)
+          Resources::Glossary.new(glossary, request, response)
+        end
+
+        def path
+          'glossaries'
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/glossary/destroy.rb

@@ -0,0 +1,37 @@
+# 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 Requests
+    module Glossary
+      class Destroy < Base
+        attr_reader :id
+
+        def initialize(api, id, options = {})
+          super(api, options)
+          @id = id
+        end
+
+        def request
+          build_response(*execute_request_with_retries(delete_request))
+        end
+
+        def to_s
+          "DELETE #{uri.request_uri}"
+        end
+
+        private
+
+        def build_response(_, _)
+          id
+        end
+
+        def path
+          "glossaries/#{id}"
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/glossary/entries.rb

@@ -0,0 +1,37 @@
+# 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 Requests
+    module Glossary
+      class Entries < Base
+        attr_reader :id
+
+        def initialize(api, id, options = {})
+          super(api, options)
+          @id = id
+        end
+
+        def request
+          build_entries(*execute_request_with_retries(get_request))
+        end
+
+        def to_s
+          "GET #{uri.request_uri}"
+        end
+
+        private
+
+        def build_entries(_, response)
+          response.body.split("\n").map { |entry| entry.split("\t") }
+        end
+
+        def path
+          "glossaries/#{id}/entries"
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/glossary/find.rb

@@ -0,0 +1,38 @@
+# 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 Requests
+    module Glossary
+      class Find < Base
+        attr_reader :id
+
+        def initialize(api, id, options = {})
+          super(api, options)
+          @id = id
+        end
+
+        def request
+          build_glossary(*execute_request_with_retries(get_request))
+        end
+
+        def to_s
+          "GET #{uri.request_uri}"
+        end
+
+        private
+
+        def build_glossary(request, response)
+          glossary = JSON.parse(response.body)
+          Resources::Glossary.new(glossary, request, response)
+        end
+
+        def path
+          "glossaries/#{id}"
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/glossary/language_pairs.rb

@@ -0,0 +1,38 @@
+# 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 Requests
+    module Glossary
+      class LanguagePairs < Base
+        def initialize(api, options = {})
+          super
+        end
+
+        def request
+          build_language_pair_list(*execute_request_with_retries(get_request))
+        end
+
+        def to_s
+          "GET #{uri.request_uri}"
+        end
+
+        private
+
+        def build_language_pair_list(request, response)
+          data = JSON.parse(response.body)
+          data['supported_languages'].map do |language_pair|
+            Resources::LanguagePair.new(language_pair['source_lang'], language_pair['target_lang'],
+                                        request, response)
+          end
+        end
+
+        def path
+          'glossary-language-pairs'
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/glossary/list.rb

@@ -0,0 +1,37 @@
+# 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 Requests
+    module Glossary
+      class List < Base
+        def initialize(api, options = {})
+          super
+        end
+
+        def request
+          build_glossary_list(*execute_request_with_retries(get_request))
+        end
+
+        def to_s
+          "GET #{uri.request_uri}"
+        end
+
+        private
+
+        def build_glossary_list(request, response)
+          data = JSON.parse(response.body)
+          data['glossaries'].map do |glossary|
+            Resources::Glossary.new(glossary, request, response)
+          end
+        end
+
+        def path
+          'glossaries'
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/languages.rb

@@ -0,0 +1,37 @@
+# Copyright 2021 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 Requests
+    class Languages < Base
+      def initialize(api, options = {})
+        super
+      end
+
+      def request
+        build_languages(*execute_request_with_retries(get_request))
+      end
+
+      def to_s
+        "GET #{uri.request_uri}"
+      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/rephrase.rb

@@ -0,0 +1,55 @@
+# 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 Requests
+    class Rephrase < Base
+      attr_reader :text, :target_lang, :writing_style, :tone
+
+      def initialize(api, text, target_lang = nil, writing_style = nil, tone = nil, options = {}) # rubocop:disable Metrics/ParameterLists
+        super(api, options)
+        @text = text
+        @target_lang = target_lang
+        @writing_style = writing_style
+        @tone = tone
+      end
+
+      def request # rubocop:disable Metrics/AbcSize
+        text_arrayified = text.is_a?(Array) ? text : [text]
+        payload = { text: text_arrayified }
+        payload[:target_lang] = target_lang unless target_lang.nil?
+        payload[:writing_style] = writing_style unless writing_style.nil?
+        payload[:tone] = tone unless tone.nil?
+        build_texts(*execute_request_with_retries(post_request(payload)))
+      end
+
+      def details
+        "HTTP Headers: #{headers}\nPayload #{{ text: text, target_lang: target_lang,
+                                               writing_style: writing_style, tone: tone }}"
+      end
+
+      def to_s
+        "POST #{uri.request_uri}"
+      end
+
+      private
+
+      def build_texts(request, response)
+        data = JSON.parse(response.body)
+
+        texts = data['improvements'].map do |improvement|
+          Resources::Text.new(improvement['text'], improvement['detected_source_language'], nil,
+                              request, response)
+        end
+
+        texts.size == 1 ? texts.first : texts
+      end
+
+      def path
+        'write/rephrase'
+      end
+    end
+  end
+end

data/lib/deepl/requests/style_rule/create.rb

@@ -0,0 +1,46 @@
+# Copyright 2026 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 Requests
+    module StyleRule
+      class Create < Base
+        def initialize(api, name, language, options = {})
+          super(api, options)
+          @name = name
+          @language = language
+          @configured_rules = delete_option(:configured_rules)
+          @custom_instructions = delete_option(:custom_instructions)
+        end
+
+        def request
+          payload = { name: @name, language: @language }
+          payload[:configured_rules] = @configured_rules if @configured_rules
+          payload[:custom_instructions] = @custom_instructions if @custom_instructions
+          build_style_rule(*execute_request_with_retries(post_request(payload)))
+        end
+
+        def to_s
+          "POST #{uri.request_uri}"
+        end
+
+        private
+
+        def build_style_rule(request, response)
+          data = JSON.parse(response.body)
+          DeepL::Resources::StyleRule.new(data, request, response)
+        end
+
+        def uri
+          @uri ||= URI("#{host}/v3/#{path}")
+        end
+
+        def path
+          'style_rules'
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/style_rule/create_custom_instruction.rb

@@ -0,0 +1,45 @@
+# Copyright 2026 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 Requests
+    module StyleRule
+      class CreateCustomInstruction < Base
+        def initialize(api, style_id, label, prompt, source_language = nil, options = {})
+          super(api, options)
+          @style_id = style_id
+          @label = label
+          @prompt = prompt
+          @source_language = source_language
+        end
+
+        def request
+          payload = { label: @label, prompt: @prompt }
+          payload[:source_language] = @source_language if @source_language
+          build_custom_instruction(*execute_request_with_retries(post_request(payload)))
+        end
+
+        def to_s
+          "POST #{uri.request_uri}"
+        end
+
+        private
+
+        def build_custom_instruction(_request, response)
+          data = JSON.parse(response.body)
+          DeepL::Resources::CustomInstruction.new(data)
+        end
+
+        def uri
+          @uri ||= URI("#{host}/v3/#{path}")
+        end
+
+        def path
+          "style_rules/#{@style_id}/custom_instructions"
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/style_rule/destroy.rb

@@ -0,0 +1,39 @@
+# Copyright 2026 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 Requests
+    module StyleRule
+      class Destroy < Base
+        def initialize(api, style_id, options = {})
+          super(api, options)
+          @style_id = style_id
+        end
+
+        def request
+          build_response(*execute_request_with_retries(delete_request))
+        end
+
+        def to_s
+          "DELETE #{uri.request_uri}"
+        end
+
+        private
+
+        def build_response(_, _)
+          @style_id
+        end
+
+        def uri
+          @uri ||= URI("#{host}/v3/#{path}")
+        end
+
+        def path
+          "style_rules/#{@style_id}"
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/style_rule/destroy_custom_instruction.rb

@@ -0,0 +1,40 @@
+# Copyright 2026 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 Requests
+    module StyleRule
+      class DestroyCustomInstruction < Base
+        def initialize(api, style_id, instruction_id, options = {})
+          super(api, options)
+          @style_id = style_id
+          @instruction_id = instruction_id
+        end
+
+        def request
+          build_response(*execute_request_with_retries(delete_request))
+        end
+
+        def to_s
+          "DELETE #{uri.request_uri}"
+        end
+
+        private
+
+        def build_response(_, _)
+          @instruction_id
+        end
+
+        def uri
+          @uri ||= URI("#{host}/v3/#{path}")
+        end
+
+        def path
+          "style_rules/#{@style_id}/custom_instructions/#{@instruction_id}"
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/style_rule/find.rb

@@ -0,0 +1,40 @@
+# Copyright 2026 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 Requests
+    module StyleRule
+      class Find < Base
+        def initialize(api, style_id, options = {})
+          super(api, options)
+          @style_id = style_id
+        end
+
+        def request
+          build_style_rule(*execute_request_with_retries(get_request))
+        end
+
+        def to_s
+          "GET #{uri.request_uri}"
+        end
+
+        private
+
+        def build_style_rule(request, response)
+          data = JSON.parse(response.body)
+          DeepL::Resources::StyleRule.new(data, request, response)
+        end
+
+        def uri
+          @uri ||= URI("#{host}/v3/#{path}")
+        end
+
+        def path
+          "style_rules/#{@style_id}"
+        end
+      end
+    end
+  end
+end