deepl-rb 3.9.0 → 3.10.0

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

@@ -0,0 +1,35 @@
+# 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 StyleProfile
+      class Create < Base
+        attr_reader :name, :fields
+
+        def initialize(api, name, fields, options = {})
+          super(api, options)
+          @name = name
+          @fields = fields
+        end
+
+        def request
+          payload = { name: name }.merge(optional_fields_payload(fields))
+          build_style_profile(*execute_request_with_retries(post_request(payload)))
+        end
+
+        def to_s
+          "POST #{uri.request_uri}"
+        end
+
+        private
+
+        def path
+          'style_profiles'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,34 @@
+# 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 StyleProfile
+      class Destroy < Base
+        attr_reader :id
+
+        def initialize(api, id, options = {})
+          super(api, options)
+          @id = style_profile_id(id)
+        end
+
+        def request
+          execute_request_with_retries(delete_request)
+          id
+        end
+
+        def to_s
+          "DELETE #{uri.request_uri}"
+        end
+
+        private
+
+        def path
+          "style_profiles/#{escaped_id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# 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 StyleProfile
+      class Find < Base
+        attr_reader :id
+
+        def initialize(api, id, options = {})
+          super(api, options)
+          @id = style_profile_id(id)
+        end
+
+        def request
+          build_style_profile(*execute_request_with_retries(get_request))
+        end
+
+        def to_s
+          "GET #{uri.request_uri}"
+        end
+
+        private
+
+        def path
+          "style_profiles/#{escaped_id}"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# 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 StyleProfile
+      class List < Base
+        SUPPORTED_OPTIONS = %w[page page_size].freeze
+
+        def request
+          build_style_profile_list(*execute_request_with_retries(get_request))
+        end
+
+        def to_s
+          "GET #{uri.request_uri}"
+        end
+
+        private
+
+        def build_style_profile_list(request, response)
+          profiles = JSON.parse(response.body)['style_profiles']
+          return [] unless profiles.is_a?(Array)
+
+          profiles.grep(Hash).map do |profile|
+            Resources::StyleProfile.new(profile, request, response)
+          end
+        end
+
+        def query_params
+          SUPPORTED_OPTIONS.each_with_object({}) do |option_name, params|
+            params[option_name] = option(option_name).to_s if option?(option_name)
+          end
+        end
+
+        def path
+          'style_profiles'
+        end
+      end
+    end
+  end
+end

data/lib/deepl/requests/style_profile/update.rb

@@ -0,0 +1,35 @@
+# 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 StyleProfile
+      class Update < Base
+        attr_reader :id, :fields
+
+        def initialize(api, id, fields, options = {})
+          super(api, options)
+          @id = style_profile_id(id)
+          @fields = fields
+        end
+
+        def request
+          payload = optional_fields_payload(fields)
+          build_style_profile(*execute_request_with_retries(patch_request(payload)))
+        end
+
+        def to_s
+          "PATCH #{uri.request_uri}"
+        end
+
+        private
+
+        def path
+          "style_profiles/#{escaped_id}"
+        end
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module DeepL
     module StyleRule
       class Create < Base
         def initialize(api, name, language, options = {})
-          super(api, options)
+          super(api, options.dup)
           @name = name
           @language = language
           @configured_rules = delete_option(:configured_rules)

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

@@ -7,9 +7,11 @@ module DeepL
   module Requests
     module StyleRule
       class CreateCustomInstruction < Base
+        include Helpers
+
         def initialize(api, style_id, label, prompt, source_language = nil, options = {})
           super(api, options)
-          @style_id = style_id
+          @style_id = style_rule_id(style_id)
           @label = label
           @prompt = prompt
           @source_language = source_language
@@ -37,7 +39,7 @@ module DeepL
         end
 
         def path
-          "style_rules/#{@style_id}/custom_instructions"
+          style_rule_path(@style_id, 'custom_instructions')
         end
       end
     end

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

@@ -7,9 +7,11 @@ module DeepL
   module Requests
     module StyleRule
       class Destroy < Base
+        include Helpers
+
         def initialize(api, style_id, options = {})
           super(api, options)
-          @style_id = style_id
+          @style_id = style_rule_id(style_id)
         end
 
         def request
@@ -31,7 +33,7 @@ module DeepL
         end
 
         def path
-          "style_rules/#{@style_id}"
+          style_rule_path(@style_id)
         end
       end
     end

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

@@ -7,10 +7,12 @@ module DeepL
   module Requests
     module StyleRule
       class DestroyCustomInstruction < Base
+        include Helpers
+
         def initialize(api, style_id, instruction_id, options = {})
           super(api, options)
-          @style_id = style_id
-          @instruction_id = instruction_id
+          @style_id = style_rule_id(style_id)
+          @instruction_id = custom_instruction_id(instruction_id)
         end
 
         def request
@@ -32,7 +34,7 @@ module DeepL
         end
 
         def path
-          "style_rules/#{@style_id}/custom_instructions/#{@instruction_id}"
+          style_rule_path(@style_id, 'custom_instructions', @instruction_id)
         end
       end
     end

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

@@ -7,9 +7,11 @@ module DeepL
   module Requests
     module StyleRule
       class Find < Base
+        include Helpers
+
         def initialize(api, style_id, options = {})
           super(api, options)
-          @style_id = style_id
+          @style_id = style_rule_id(style_id)
         end
 
         def request
@@ -32,7 +34,7 @@ module DeepL
         end
 
         def path
-          "style_rules/#{@style_id}"
+          style_rule_path(@style_id)
         end
       end
     end

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

@@ -7,10 +7,12 @@ module DeepL
   module Requests
     module StyleRule
       class FindCustomInstruction < Base
+        include Helpers
+
         def initialize(api, style_id, instruction_id, options = {})
           super(api, options)
-          @style_id = style_id
-          @instruction_id = instruction_id
+          @style_id = style_rule_id(style_id)
+          @instruction_id = custom_instruction_id(instruction_id)
         end
 
         def request
@@ -33,7 +35,7 @@ module DeepL
         end
 
         def path
-          "style_rules/#{@style_id}/custom_instructions/#{@instruction_id}"
+          style_rule_path(@style_id, 'custom_instructions', @instruction_id)
         end
       end
     end

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

@@ -0,0 +1,35 @@
+# 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
+      # IDs and paths shared by the style rule requests. A style rule list and a custom
+      # instruction are given as their ID or as the resource object.
+      module Helpers
+        private
+
+        def style_rule_id(style_rule)
+          return style_rule.style_id if style_rule.is_a?(DeepL::Resources::StyleRule)
+
+          style_rule
+        end
+
+        def custom_instruction_id(instruction)
+          return instruction.id if instruction.is_a?(DeepL::Resources::CustomInstruction)
+
+          instruction
+        end
+
+        # The path of a style rule list, with its ID and the custom instruction ID URL-encoded.
+        def style_rule_path(style_id, suffix = nil, instruction_id = nil)
+          segments = ["style_rules/#{escape_path_segment(style_id)}", suffix]
+          segments << escape_path_segment(instruction_id) unless instruction_id.nil?
+          segments.compact.join('/')
+        end
+      end
+    end
+  end
+end

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

@@ -47,7 +47,7 @@ module DeepL
           params['page'] = option(:page).to_s if option?(:page)
           params['page_size'] = option(:page_size).to_s if option?(:page_size)
           params['detailed'] = option(:detailed).to_s.downcase if option?(:detailed)
-          URI.encode_www_form(params)
+          encode_query(params)
         end
 
         def path

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

@@ -7,9 +7,11 @@ module DeepL
   module Requests
     module StyleRule
       class Update < Base
+        include Helpers
+
         def initialize(api, style_id, name, options = {})
           super(api, options)
-          @style_id = style_id
+          @style_id = style_rule_id(style_id)
           @name = name
         end
 
@@ -34,7 +36,7 @@ module DeepL
         end
 
         def path
-          "style_rules/#{@style_id}"
+          style_rule_path(@style_id)
         end
       end
     end

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

@@ -7,9 +7,11 @@ module DeepL
   module Requests
     module StyleRule
       class UpdateConfiguredRules < Base
+        include Helpers
+
         def initialize(api, style_id, configured_rules, options = {})
           super(api, options)
-          @style_id = style_id
+          @style_id = style_rule_id(style_id)
           @configured_rules = configured_rules
         end
 
@@ -33,7 +35,7 @@ module DeepL
         end
 
         def path
-          "style_rules/#{@style_id}/configured_rules"
+          style_rule_path(@style_id, 'configured_rules')
         end
       end
     end

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

@@ -7,11 +7,13 @@ module DeepL
   module Requests
     module StyleRule
       class UpdateCustomInstruction < Base
+        include Helpers
+
         def initialize(api, style_id, instruction_id, label, prompt, # rubocop:disable Metrics/ParameterLists
                        source_language = nil, options = {})
           super(api, options)
-          @style_id = style_id
-          @instruction_id = instruction_id
+          @style_id = style_rule_id(style_id)
+          @instruction_id = custom_instruction_id(instruction_id)
           @label = label
           @prompt = prompt
           @source_language = source_language
@@ -39,7 +41,7 @@ module DeepL
         end
 
         def path
-          "style_rules/#{@style_id}/custom_instructions/#{@instruction_id}"
+          style_rule_path(@style_id, 'custom_instructions', @instruction_id)
         end
       end
     end

data/lib/deepl/requests/translate.rb

@@ -5,7 +5,7 @@
 
 module DeepL
   module Requests
-    class Translate < Base
+    class Translate < Base # rubocop:disable Metrics/ClassLength
       STRING_TO_BOOLEAN_MAP = { '1' => true, '0' => false }.freeze
       BOOLEAN_TO_STRING_MAP = { true => '1', false => '0' }.freeze
       STRING_TO_BOOLEAN_CONVERSION = ->(value) { STRING_TO_BOOLEAN_MAP[value] }
@@ -17,6 +17,10 @@ module DeepL
           (value.is_a?(Array) ? value : value.split(','))
         end
       }.freeze
+      # A custom instruction may contain commas, so a single string is one instruction.
+      STRING_TO_SINGLE_ELEMENT_ARRAY_CONVERSION = lambda { |value|
+        value.is_a?(String) ? [value] : value
+      }.freeze
       OPTIONS_CONVERSIONS = {
         split_sentences: BOOLEAN_TO_STRING_CONVERSION,
         preserve_formatting: STRING_TO_BOOLEAN_CONVERSION,
@@ -24,14 +28,15 @@ module DeepL
         splitting_tags: STRING_TO_ARRAY_CONVERSION,
         non_splitting_tags: STRING_TO_ARRAY_CONVERSION,
         ignore_tags: STRING_TO_ARRAY_CONVERSION,
-        custom_instructions: STRING_TO_ARRAY_CONVERSION
+        custom_instructions: STRING_TO_SINGLE_ELEMENT_ARRAY_CONVERSION
       }.freeze
 
       attr_reader :text, :source_lang, :target_lang, :ignore_tags, :splitting_tags,
                   :non_splitting_tags, :model_type, :custom_instructions, :tag_handling_version
 
       def initialize(api, text, source_lang, target_lang, options = {}, additional_headers = {})
-        super(api, options, additional_headers)
+        # Options set to nil are unset and not sent.
+        super(api, options.compact, additional_headers)
         @text = text
         @source_lang = source_lang
         @target_lang = target_lang
@@ -41,39 +46,58 @@ module DeepL
 
       def request # rubocop:disable Metrics/AbcSize, Metrics/MethodLength, Metrics/PerceivedComplexity, Metrics/CyclomaticComplexity
         text_arrayified = text.is_a?(Array) ? text : [text]
-        payload = { text: text_arrayified, source_lang: source_lang, target_lang: target_lang }
+        payload = { text: text_arrayified, target_lang: target_lang, show_billed_characters: true }
+        payload[:source_lang] = source_lang unless source_lang.nil?
 
         if option?(:style_rule)
           style_rule = delete_option(:style_rule)
-          payload[:style_id] = if style_rule.is_a?(DeepL::Resources::StyleRule)
-                                 style_rule.style_id
-                               else
-                                 style_rule.to_s
-                               end
+          unless style_rule.nil?
+            payload[:style_id] = if style_rule.is_a?(DeepL::Resources::StyleRule)
+                                   style_rule.style_id
+                                 else
+                                   style_rule.to_s
+                                 end
+          end
+        end
+
+        if option?(:style_profile)
+          profile = delete_option(:style_profile)
+          unless profile.nil?
+            payload[:style_profile_id] = if profile.is_a?(DeepL::Resources::StyleProfile)
+                                           profile.style_profile_id
+                                         else
+                                           profile.to_s
+                                         end
+          end
         end
 
         if option?(:translation_memory)
           tm = delete_option(:translation_memory)
-          payload[:translation_memory_id] = if tm.is_a?(DeepL::Resources::TranslationMemory)
-                                              tm.translation_memory_id
-                                            else
-                                              tm.to_s
-                                            end
+          unless tm.nil?
+            payload[:translation_memory_id] = if tm.is_a?(DeepL::Resources::TranslationMemory)
+                                                tm.translation_memory_id
+                                              else
+                                                tm.to_s
+                                              end
+          end
         end
 
         if option?(:translation_memory_threshold)
-          payload[:translation_memory_threshold] = delete_option(:translation_memory_threshold)
+          threshold = delete_option(:translation_memory_threshold)
+          payload[:translation_memory_threshold] = threshold unless threshold.nil?
         end
 
-        glossary_ids = build_glossary_ids_param(source_lang)
+        glossary_ids = build_glossary_ids_param
         payload[:glossary_ids] = glossary_ids unless glossary_ids.nil?
+        glossary_id = build_glossary_param
+        payload[:glossary_id] = glossary_id unless glossary_id.nil?
 
         build_texts(*execute_request_with_retries(post_request(payload)))
       end
 
       def details
-        "HTTP Headers: #{headers}\nPayload #{{ text: text, source_lang: source_lang,
-                                               target_lang: target_lang }}"
+        "HTTP Headers: #{loggable_headers}\nPayload #{{ text: text, source_lang: source_lang,
+                                                        target_lang: target_lang }}"
       end
 
       def to_s
@@ -94,13 +118,21 @@ module DeepL
         data = JSON.parse(response.body)
 
         texts = data['translations'].map do |translation|
-          Resources::Text.new(translation['text'], translation['detected_source_language'],
-                              translation['model_type_used'], request, response)
+          Resources::Text.new(
+            translation['text'], translation['detected_source_language'],
+            translation['model_type_used'], request, response,
+            Utils::NumberParser.optional_count(translation['billed_characters']),
+            optional_string(translation['tag_handling_version'])
+          )
         end
 
         texts.size == 1 ? texts.first : texts
       end
 
+      def optional_string(value)
+        value if value.is_a?(String)
+      end
+
       def path
         'translate'
       end

data/lib/deepl/requests/translation_memory/base.rb

@@ -24,10 +24,7 @@ module DeepL
         end
 
         def build_query_string
-          # encode_www_form encodes a space as `+`, which is correct for a form body but not for
-          # a URI query string. A literal `+` is already escaped as %2B, so every remaining `+`
-          # is a space.
-          URI.encode_www_form(query_params).gsub('+', '%20')
+          encode_query(query_params)
         end
 
         def query_params

data/lib/deepl/requests/translation_memory/create_export.rb

@@ -33,7 +33,7 @@ module DeepL
         end
 
         def path
-          "translation_memories/#{translation_memory_id}/export"
+          "translation_memories/#{escape_path_segment(translation_memory_id)}/export"
         end
       end
     end

data/lib/deepl/requests/translation_memory/create_import.rb

@@ -22,7 +22,7 @@ module DeepL
         end
 
         def details
-          "HTTP Headers: #{headers}\nPayload #{payload}"
+          "HTTP Headers: #{loggable_headers}\nPayload #{payload}"
         end
 
         def to_s

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

@@ -29,7 +29,7 @@ module DeepL
         end
 
         def path
-          "translation_memories/#{translation_memory_id}"
+          "translation_memories/#{escape_path_segment(translation_memory_id)}"
         end
       end
     end

data/lib/deepl/requests/translation_memory/download_export.rb

@@ -28,6 +28,10 @@ module DeepL
 
         def extract_file(_request, response)
           File.binwrite(@output_file, response.body)
+        rescue SystemCallError, IOError => e
+          raise e unless api.client?
+
+          raise Exceptions::Error, "Could not write the export to #{@output_file}: #{e.message}"
         end
       end
     end

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

@@ -30,7 +30,7 @@ module DeepL
         end
 
         def path
-          "translation_memories/#{translation_memory_id}"
+          "translation_memories/#{escape_path_segment(translation_memory_id)}"
         end
       end
     end

data/lib/deepl/requests/translation_memory/find_job.rb

@@ -30,7 +30,7 @@ module DeepL
         end
 
         def path
-          "translation_memories/jobs/#{job_id}"
+          "translation_memories/jobs/#{escape_path_segment(job_id)}"
         end
       end
     end

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

@@ -32,7 +32,8 @@ module DeepL
 
         def query_params
           SUPPORTED_OPTIONS.each_with_object({}) do |option_name, params|
-            params[option_name] = option(option_name).to_s if option?(option_name)
+            value = option(option_name)
+            params[option_name] = value.to_s unless value.nil?
           end
         end
 

data/lib/deepl/requests/translation_memory/segments.rb

@@ -33,12 +33,13 @@ module DeepL
 
         def query_params
           SUPPORTED_OPTIONS.each_with_object({}) do |option_name, params|
-            params[option_name] = option(option_name).to_s if option?(option_name)
+            value = option(option_name)
+            params[option_name] = value.to_s unless value.nil?
           end
         end
 
         def path
-          "translation_memories/#{translation_memory_id}/segments"
+          "translation_memories/#{escape_path_segment(translation_memory_id)}/segments"
         end
       end
     end