mistral_translator 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e52138d192d693042abbc570da3a9ed1f7f56acaed881c46a59df100dc476a0
-  data.tar.gz: 74a169d74c5248dc7ec1cab84c5892018eeacf3ba398bfb0b0a3c41a98d87ae9
+  metadata.gz: 242809c8a55ea79c9c436a2fc7b17d7a6deda5372090eaaa43b9a0863e1ba552
+  data.tar.gz: b6f86bc08b253f5ea4097e9fa1f3e901e41886067155c2fc595202694ce18acb
 SHA512:
-  metadata.gz: 3f324d7cb87b75c340d1875fc6189c13c39dfe26c1878ff187c30c04674b88549c813be6f73c644b2b01a5f28ed5e88da55351c86b37800d9648835113f58b3e
-  data.tar.gz: 0d9ac452969b457ed81cd34295e564d869c3e8f254e0807a8d473af8c99fbcb10f0d2ea5bc5abea518a0f7bd59d978428dac8e5c25864c63a4fa61d0dfb1617a
+  metadata.gz: 6183a2226ee0985e5229c2cb203fed6cfb71ced4c2a0cdb28fba16115f5b6fdf28b860baba50db8f3461e64792267558f3413481e715c54f2f1b5bf0747d3647
+  data.tar.gz: a71be86ea71b15e50af048cbba672e5fdecd41e6d3cd1e1313d534d11d2af7747ac593cf36791ad805f9b6db4ff6d6d88853a8b166a046cc45747a66e879bf0c

data/.env.example

@@ -0,0 +1,3 @@
+# Copy to .env (ignored by git) to run bin/check_api without typing the key.
+# Use a key dedicated to these checks, from a workspace with generation enabled.
+MISTRAL_TEST_API_KEY=

data/CHANGELOG.md

@@ -1,5 +1,43 @@
 ## [Unreleased]
 
+## [0.3.2] - 2026-10-28
+
+### Fixed
+
+- Rich text adapters send the stored ActionText HTML (`to_html`) instead of the rendered one (`to_s`), which wrapped every translation in an extra `<div class="trix-content">` and inlined the rendered attachments. `ActionText::Content` values are now recognised too, not only `ActionText::RichText`.
+- `RecordTranslationService` passes `preserve_html: true` for rich text fields.
+- `RecordTranslationService#translate_to_all_locales` returns `false` when a translation fails. It returned `true`, so failures went unnoticed; successful translations are still saved.
+- `RecordTranslationService`, `Translator` and `Summarizer` stop retrying after a few `RateLimitError`s and raise, instead of retrying forever on top of the client's own backoff.
+- `translate_to_multiple` passes `preserve_html` to each translation; the option was ignored.
+- `translate_with_mistral` raised `ArgumentError` on every call. `from:` is now the source locale and `to:` the target locales, through a new `target_locales:` option of `RecordTranslationService`.
+- A glossary given as a string no longer raises `NoMethodError` in `PromptBuilder`.
+- `BasicRateLimiter` no longer sleeps while holding its lock, which blocked every other thread.
+- HTTP error messages no longer end with a stray brace.
+
+### Changed
+
+- CI token restricted to read access, and development dependencies updated (addressable, json, uri).
+
+### Removed
+
+- Unused helpers `log_prompt_debug` and `build_html_validation_instruction`.
+
+## [0.3.1] - 2026-10-27
+
+### Fixed
+
+- Default model is now `mistral-small-latest`. Mistral retired the `mistral-small` name, so every call without an explicit `config.model` failed with a 404. The alias follows the current Mistral Small version; set `config.model` to pin one.
+
+### Added
+
+- `bin/check_api`: checks the API key and the default model, then runs the examples against the real API when the plan allows generation. The key is read from `MISTRAL_TEST_API_KEY`, `.env`, or a hidden prompt, and never printed.
+- Weekly workflow running `bin/check_api`, which opens an issue on failure.
+
+### Changed
+
+- CI: a single workflow, RuboCop plus the test suite on Ruby 3.2, 3.3, 3.4 and 4.0.
+- The test suite no longer prints part of the API key, and no longer deletes VCR cassettes after each run.
+
 ## [0.3.0] - 2025-12-09
 
 ### Added

data/README.md

@@ -2,11 +2,11 @@
 
 Ruby gem for AI-powered translation and text summarization using Mistral AI API, with advanced Rails support.
 
-[![Ruby](https://img.shields.io/badge/ruby-%23CC342D.svg?style=flat&logo=ruby&logoColor=white)](https://www.ruby-lang.org/)
-[![Gem Version](https://badge.fury.io/rb/mistral_translator.svg)](https://badge.fury.io/rb/mistral_translator)
-[![RSpec](https://img.shields.io/badge/tested%20with-RSpec-red.svg)](https://rspec.info/)
-[![RuboCop](https://img.shields.io/badge/code%20style-RuboCop-brightgreen.svg)](https://rubocop.org/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Gem Version](https://img.shields.io/gem/v/mistral_translator)](https://rubygems.org/gems/mistral_translator)
+[![Downloads](https://img.shields.io/gem/dt/mistral_translator)](https://rubygems.org/gems/mistral_translator)
+[![CI](https://github.com/Peyochanchan/mistral_translator/actions/workflows/ci.yml/badge.svg)](https://github.com/Peyochanchan/mistral_translator/actions/workflows/ci.yml)
+[![Weekly API check](https://github.com/Peyochanchan/mistral_translator/actions/workflows/weekly-api-check.yml/badge.svg)](https://github.com/Peyochanchan/mistral_translator/actions/workflows/weekly-api-check.yml)
+[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE.txt)
 
 ## Quick Start
 
@@ -159,7 +159,7 @@ MistralTranslator.configure do |config|
   config.api_key = ENV['MISTRAL_API_KEY']
 
   # Optional
-  config.model = "mistral-small"                    # AI model to use
+  config.model = "mistral-small-latest"            # AI model to use (an alias that follows the current Mistral Small)
   config.retry_delays = [1, 2, 4, 8, 16]          # Retry delays in seconds
   config.enable_metrics = true                     # Enable performance metrics
 
@@ -233,7 +233,7 @@ The complete documentation includes:
 ## Requirements
 
 - Ruby 3.2+
-- Mistral AI API key
+- Mistral AI API key, on a plan with API access (Mistral's free plan cannot generate text)
 - Rails 6.0+ (optional, for Rails integration features)
 
 ## Testing
@@ -247,6 +247,10 @@ bundle exec rspec spec/mistral_translator/
 
 # Run all tests with documentation format
 bundle exec rspec --format documentation
+
+# Check the API key and default model, then run the examples against the real
+# API (reads MISTRAL_TEST_API_KEY, .env or asks for the key, never prints it)
+bin/check_api
 ```
 
 ### Integration Tests

data/docs/api-reference/configuration.md

@@ -11,7 +11,7 @@ Référence complète des options de configuration.
 ```ruby
 MistralTranslator.configure do |config|
   config.api_key = ENV['MISTRAL_API_KEY']        # Obligatoire
-  config.model = "mistral-small"                 # Défaut
+  config.model = "mistral-small-latest"                 # Défaut
   config.api_url = "https://api.mistral.ai"      # URL API
   config.default_max_tokens = 4000               # Limite tokens
   config.default_temperature = 0.3               # Créativité (0-1)

data/docs/api-reference/methods.md

@@ -268,7 +268,7 @@ Configure la gem avec un bloc.
 ```ruby
 MistralTranslator.configure do |config|
   config.api_key = ENV['MISTRAL_API_KEY']
-  config.model = "mistral-small"
+  config.model = "mistral-small-latest"
   config.retry_delays = [1, 2, 4, 8]
   config.enable_metrics = true
 end

data/docs/installation.md

@@ -76,7 +76,7 @@ end
 ```ruby
 MistralTranslator.configure do |config|
   config.api_key = ENV['MISTRAL_API_KEY']
-  config.model = "mistral-small"                # Modèle par défaut
+  config.model = "mistral-small-latest"                # Modèle par défaut
   config.retry_delays = [2, 4, 8, 16]          # Délais retry
   config.enable_metrics = true                  # Suivi des stats
   config.default_max_tokens = 4000              # Limite tokens

data/lib/mistral_translator/adapters.rb

@@ -43,24 +43,35 @@ module MistralTranslator
         value = get_field_value(field, locale)
         return false if value.nil?
 
-        # Gestion des rich text
-        if defined?(ActionText::RichText) && value.is_a?(ActionText::RichText)
-          !value.to_plain_text.to_s.strip.empty?
-        else
-          !value.to_s.strip.empty?
-        end
+        text = rich_text?(value) ? value.to_plain_text : value
+        !text.to_s.strip.empty?
       end
 
       def get_translatable_content(field, locale)
         value = get_field_value(field, locale)
         return nil if value.nil?
 
-        # Gestion des rich text - préserver le HTML
-        if defined?(ActionText::RichText) && value.is_a?(ActionText::RichText)
-          value.body.to_s
-        else
-          value.to_s
-        end
+        rich_text?(value) ? rich_text_html(value) : value.to_s
+      end
+
+      # ActionText::RichText (has_rich_text) ou ActionText::Content (son body)
+      def rich_text?(value)
+        (defined?(ActionText::RichText) && value.is_a?(ActionText::RichText)) ||
+          (defined?(ActionText::Content) && value.is_a?(ActionText::Content))
+      end
+
+      def rich_text_field?(field, locale)
+        rich_text?(get_field_value(field, locale))
+      end
+
+      private
+
+      # HTML tel que stocké, pièces jointes réduites à <action-text-attachment>.
+      # to_s rendrait le layout (<div class="trix-content">) et le contenu des
+      # pièces jointes, qui seraient alors enregistrés dans la traduction.
+      def rich_text_html(value)
+        content = value.respond_to?(:body) ? value.body : value
+        content&.to_html.to_s
       end
     end
 
@@ -167,16 +178,22 @@ module MistralTranslator
   # Service de traduction utilisant les adaptateurs
   module Adapters
     class RecordTranslationService
-      def initialize(record, translatable_fields, adapter: nil, source_locale: nil)
+      MAX_RATE_LIMIT_RETRIES = 3
+
+      # target_locales : toutes les locales de l'adaptateur par défaut
+      def initialize(record, translatable_fields, adapter: nil, source_locale: nil, target_locales: nil)
         @record = record
         @translatable_fields = Array(translatable_fields)
         @adapter = adapter || Adapters::AdapterFactory.build_for(record)
         @source_locale = source_locale
+        @target_locales = target_locales&.map(&:to_sym)
       end
 
+      # Enregistre les traductions obtenues ; renvoie false si l'une a échoué.
       def translate_to_all_locales
         return false if @translatable_fields.empty?
 
+        @failed = false
         ActiveRecord::Base.transaction do
           @translatable_fields.each do |field|
             translate_field(field)
@@ -184,7 +201,7 @@ module MistralTranslator
           @adapter.save_record!
         end
 
-        true
+        !@failed
       rescue StandardError => e
         Rails.logger.error "Translation failed: #{e.message}" if defined?(Rails)
         false
@@ -198,34 +215,57 @@ module MistralTranslator
 
         return if source_content.nil? || source_content.strip.empty?
 
+        options = rich_text_field?(field, source_locale) ? { preserve_html: true } : {}
         target_locales = @adapter.available_locales - [source_locale]
+        target_locales &= @target_locales if @target_locales
 
         target_locales.each do |target_locale|
-          translate_to_locale(field, source_content, source_locale, target_locale)
-          sleep(2) # Rate limiting basique
+          translated = translate_to_locale(field, source_content, source_locale, target_locale, options)
+          sleep(2) if translated # Rate limiting basique
         end
       end
 
-      def translate_to_locale(field, content, source_locale, target_locale)
-        translated_content = MistralTranslator.translate(
-          content,
-          from: source_locale.to_s,
-          to: target_locale.to_s
-        )
+      # Les adaptateurs fournis par l'application n'héritent pas forcément de BaseAdapter.
+      def rich_text_field?(field, locale)
+        @adapter.respond_to?(:rich_text_field?) && @adapter.rich_text_field?(field, locale)
+      end
 
-        if translated_content && !translated_content.strip.empty?
-          @adapter.set_field_value(field, target_locale,
-                                   translated_content)
-        end
-      rescue MistralTranslator::RateLimitError => e
-        Rails.logger.warn "Rate limit: #{e.message}" if defined?(Rails)
-        sleep(2)
-        retry
-      rescue StandardError => e
-        if defined?(Rails)
-          Rails.logger.error "Translation error for #{field} #{source_locale}->#{target_locale}: #{e.message}"
+      def translate_to_locale(field, content, source_locale, target_locale, options)
+        rate_limit_retries = 0
+        begin
+          translated_content = MistralTranslator.translate(
+            content,
+            from: source_locale.to_s,
+            to: target_locale.to_s,
+            **options
+          )
+
+          if translated_content && !translated_content.strip.empty?
+            @adapter.set_field_value(field, target_locale,
+                                     translated_content)
+          end
+          true
+        rescue MistralTranslator::RateLimitError => e
+          Rails.logger.warn "Rate limit: #{e.message}" if defined?(Rails)
+          rate_limit_retries += 1
+          if rate_limit_retries <= MAX_RATE_LIMIT_RETRIES
+            sleep(2)
+            retry
+          end
+          record_failure(field, source_locale, target_locale, e)
+          false
+        rescue StandardError => e
+          record_failure(field, source_locale, target_locale, e)
+          false
         end
       end
+
+      def record_failure(field, source_locale, target_locale, error)
+        @failed = true
+        return unless defined?(Rails)
+
+        Rails.logger.error "Translation error for #{field} #{source_locale}->#{target_locale}: #{error.message}"
+      end
     end
   end
 

data/lib/mistral_translator/client_helpers.rb

@@ -101,9 +101,9 @@ module MistralTranslator
           # Rate limit sera géré séparément
           nil
         when 400..499
-          raise ApiError, "Client error (#{response.code})}"
+          raise ApiError, "Client error (#{response.code})"
         when 500..599
-          raise ApiError, "Server error (#{response.code})}"
+          raise ApiError, "Server error (#{response.code})"
         end
       end
 

data/lib/mistral_translator/configuration.rb

@@ -11,7 +11,7 @@ module MistralTranslator
     def initialize
       @api_key = nil
       @api_url = "https://api.mistral.ai"
-      @model = "mistral-small"
+      @model = "mistral-small-latest"
       @default_max_tokens = nil
       @default_temperature = nil
       @retry_delays = [2, 4, 8, 16, 32, 64, 128, 256, 512, 1024]
@@ -110,7 +110,8 @@ module MistralTranslator
       @metrics_mutex.synchronize do
         @metrics.merge({
                          average_translation_time: if @metrics[:total_translations].positive?
-                                                     (@metrics[:total_duration] / @metrics[:total_translations]).round(3)
+                                                     (@metrics[:total_duration] /
+                                                       @metrics[:total_translations]).round(3)
                                                    else
                                                      0
                                                    end,

data/lib/mistral_translator/helpers.rb

@@ -258,10 +258,11 @@ module MistralTranslator
 
     # Module pour inclure dans les classes Rails si souhaité
     module RecordHelpers
-      def translate_with_mistral(fields, from:, to:, **)
+      def translate_with_mistral(fields, from:, to:)
         adapter = MistralTranslator::Adapters::AdapterFactory.build_for(self)
-        service = MistralTranslator::Adapters::RecordTranslationService.new(self, fields, adapter: adapter, from: from,
-                                                                                          to: to, **)
+        service = MistralTranslator::Adapters::RecordTranslationService.new(
+          self, fields, adapter: adapter, source_locale: from, target_locales: Array(to)
+        )
         service.translate_to_all_locales
       end
 

data/lib/mistral_translator/prompt_helpers.rb

@@ -51,14 +51,6 @@ module MistralTranslator
           Ne traduis que le contenu textuel à l'intérieur des balises.
         HTML_INSTRUCTION
       end
-
-      def build_html_validation_instruction
-        <<~HTML_VALIDATION
-
-          IMPORTANT : Vérifie que le HTML est valide et bien formé.
-          Corrige toute erreur de structure HTML si nécessaire.
-        HTML_VALIDATION
-      end
     end
 
     # Helper pour les instructions de formatage

data/lib/mistral_translator/prompt_metadata_helpers.rb

@@ -8,7 +8,7 @@ module MistralTranslator
       additions = []
 
       additions << '"has_context": true' if context && !context.to_s.strip.empty?
-      additions << '"has_glossary": true' if glossary && !glossary.to_s.strip.empty? && glossary.any?
+      additions << '"has_glossary": true' if glossary_present?(glossary)
       additions << '"preserve_html": true' if preserve_html
 
       additions.any? ? ",\n              #{additions.join(",\n              ")}" : ""
@@ -23,20 +23,16 @@ module MistralTranslator
       additions.any? ? ",\n              #{additions.join(",\n              ")}" : ""
     end
 
+    # Le glossaire est un Hash ou une chaîne : String ne répond pas à #any?
+    def glossary_present?(glossary)
+      return glossary.any? if glossary.is_a?(Hash)
+
+      !glossary.to_s.strip.empty?
+    end
+
     def log_prompt_generation(prompt_type, source_locale, target_locale)
       message = "Generated #{prompt_type} prompt for #{source_locale} -> #{target_locale}"
       Logger.debug_if_verbose(message, sensitive: false)
     end
-
-    def log_prompt_debug(_prompt)
-      return unless ENV["MISTRAL_TRANSLATOR_DEBUG"]
-
-      if defined?(Rails) && Rails.respond_to?(:logger)
-        Rails.logger.info message
-      elsif ENV["MISTRAL_TRANSLATOR_DEBUG"]
-        # Log de debug seulement si mode verbose activé
-        Logger.debug_if_verbose(message, sensitive: false)
-      end
-    end
   end
 end

data/lib/mistral_translator/security.rb

@@ -42,30 +42,32 @@ module MistralTranslator
         @mutex = Mutex.new
       end
 
+      # Réserve un créneau sous verrou, puis attend hors du verrou : les autres
+      # threads réservent les créneaux suivants au lieu d'être bloqués.
       def wait_and_record!
-        @mutex.synchronize do
-          cleanup_old_requests
-          if @requests.size >= @max_requests
-            wait_time = calculate_wait_time
-            sleep(wait_time) if wait_time.positive?
-          end
-          @requests << Time.now
+        wait_time = @mutex.synchronize do
+          now = Time.now
+          cleanup_old_requests(now)
+          slot = next_slot(now)
+          @requests << slot
+          slot - now
         end
+        sleep(wait_time) if wait_time.positive?
       end
 
       private
 
-      def cleanup_old_requests
-        cutoff_time = Time.now - @window_seconds
+      def cleanup_old_requests(now)
+        cutoff_time = now - @window_seconds
         @requests.reject! { |request_time| request_time < cutoff_time }
       end
 
-      def calculate_wait_time
-        return 0 if @requests.empty?
+      # Premier instant où la fenêtre compte moins de max_requests requêtes,
+      # créneaux déjà réservés compris
+      def next_slot(now)
+        return now if @requests.size < @max_requests
 
-        oldest_request = @requests.min
-        time_until_oldest_expires = (oldest_request + @window_seconds) - Time.now
-        [time_until_oldest_expires, 0].max
+        @requests.sort[@requests.size - @max_requests] + @window_seconds
       end
     end
   end

data/lib/mistral_translator/summarizer.rb

@@ -146,10 +146,13 @@ module MistralTranslator
         log_debug("Max retries reached for #{target_locale}, giving up")
         raise e
       end
-    rescue RateLimitError => e
+    rescue RateLimitError
+      # Le client a déjà relancé avec backoff : quelques tentatives de plus suffisent.
+      raise if attempt >= DEFAULT_RETRY_COUNT
+
       log_rate_limit_hit("summary", target_locale)
       sleep(DEFAULT_RETRY_DELAY)
-      retry
+      summarize_with_retry(text, target_locale, max_words, attempt + 1)
     end
     # rubocop:enable Metrics/PerceivedComplexity
 

data/lib/mistral_translator/translator.rb

@@ -71,12 +71,13 @@ module MistralTranslator
       source_locale = LocaleHelper.validate_locale!(from)
       target_locales = Array(to).map { |locale| LocaleHelper.validate_locale!(locale) }
 
+      translation_options = { context: options[:context], glossary: options[:glossary] }
+      translation_options[:preserve_html] = true if options[:preserve_html]
+
       if options[:use_batch] && target_locales.size > 3
-        translate_to_multiple_batch(text, source_locale, target_locales, context: options[:context],
-                                                                         glossary: options[:glossary])
+        translate_to_multiple_batch(text, source_locale, target_locales, **translation_options)
       else
-        translate_to_multiple_sequential(text, source_locale, target_locales, context: options[:context],
-                                                                              glossary: options[:glossary])
+        translate_to_multiple_sequential(text, source_locale, target_locales, **translation_options)
       end
     end
 
@@ -184,9 +185,12 @@ module MistralTranslator
         translate_with_retry(text, source_locale, target_locale, attempt + 1, **options)
       end
     rescue RateLimitError
+      # Le client a déjà relancé avec backoff : quelques tentatives de plus suffisent.
+      raise if attempt >= DEFAULT_RETRY_COUNT
+
       log_rate_limit_hit(source_locale, target_locale)
       sleep(DEFAULT_RETRY_DELAY)
-      retry
+      translate_with_retry(text, source_locale, target_locale, attempt + 1, **options)
     end
 
     # Ces méthodes sont héritées via RequestHelper

data/lib/mistral_translator/translator_helpers.rb

@@ -228,10 +228,14 @@ module MistralTranslator
 
     # Helper pour traductions multi-cibles
     module MultiTargetHelper
-      def translate_to_multiple_batch(text, source_locale, target_locales, context: nil, glossary: nil)
+      DEFAULT_MULTI_TARGET_OPTIONS = { context: nil, glossary: nil }.freeze
+
+      # options : context, glossary, preserve_html
+      def translate_to_multiple_batch(text, source_locale, target_locales, **options)
+        options = DEFAULT_MULTI_TARGET_OPTIONS.merge(options)
         requests = target_locales.map do |target_locale|
           {
-            prompt: build_translation_prompt(text, source_locale, target_locale, context: context, glossary: glossary),
+            prompt: build_translation_prompt(text, source_locale, target_locale, **options),
             from: source_locale,
             to: target_locale,
             original_text: text
@@ -252,13 +256,14 @@ module MistralTranslator
         results
       end
 
-      def translate_to_multiple_sequential(text, source_locale, target_locales, context: nil, glossary: nil)
+      def translate_to_multiple_sequential(text, source_locale, target_locales, **options)
+        options = DEFAULT_MULTI_TARGET_OPTIONS.merge(options)
         results = {}
 
         target_locales.each_with_index do |target_locale, index|
           sleep(MistralTranslator::Translator::DEFAULT_RETRY_DELAY) if index.positive?
           results[target_locale] =
-            translate_with_retry(text, source_locale, target_locale, context: context, glossary: glossary)
+            translate_with_retry(text, source_locale, target_locale, **options)
         end
 
         results

data/lib/mistral_translator/version.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 module MistralTranslator
-  VERSION = "0.3.0"
+  VERSION = "0.3.2"
 
   # Informations additionnelles sur la gem
   API_VERSION = "v1"
-  SUPPORTED_MODEL = "mistral-small"
+  SUPPORTED_MODEL = "mistral-small-latest"
 
   # Méthode pour obtenir des informations complètes sur la version
   def self.version_info

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification
 name: mistral_translator
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
-- Peyochanchan
+- Pierre Cherbero
 bindir: exe
 cert_chain: []
 date: 1980-01-02 00:00:00.000000000 Z
@@ -117,6 +117,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.example"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -196,7 +197,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.1
+rubygems_version: 4.0.5
 specification_version: 4
 summary: Gem to translate and summarize text with Mistral API
 test_files: []