mindee 5.2.0 → 5.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4035b0201f4458b0bdb6066c4602d132ef2695436d47d2c36f27a5eccf8c5af8
-  data.tar.gz: dfa07b33ef6c2da5f5d973fa47c01ff969bcd011e3b595785f2f06dd411b4c4c
+  metadata.gz: addb1d4afceb4816df637946d7d0028da0459681ae05ecf5ce9550f5a2329b2c
+  data.tar.gz: f495ddafda38ba5f5cf6c0e00e88a331a32264a297704a941136d61b660700a8
 SHA512:
-  metadata.gz: 620d7b8e30cb6368451485d4119a357f991b5105c73d7407d18294ef440c17d2d0602960a00742fb5a3969d33cd7308a8771833bb01fd2fb8bfd74eb64fc5fef
-  data.tar.gz: 10644668f5aa9b0c2848e252cfe8174368c3bd49f5483028c9d0a7e316356986c0300acd875e162156e5338ff53d3d297e47aec5fd33ca9824e39d3d3181272b
+  metadata.gz: 2e2784c6fb7c8a8cb98eb1bb6d191b451899fbd4c4a4ae985d8f7d0271b4aa2a97edc64a0b084a700d8769def4b0400cdab24393b3eb7b1f14726407d7f2c93b
+  data.tar.gz: 6718cc7f954306771effbc7e96236bd246ed7aaf34f6296278d55cc821e3d850e54ce03608c64d7d81cb05d4b4ed8cf4055e2d0c08ec4ec315c0dfc0d948a188

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Mindee Ruby API Library Changelog
 
+## v5.2.1 - 2026-05-27
+### Changes
+* :recycle: add polling options as a dedicated parameter (#252)
+
+
 ## v5.2.0 - 2026-05-19
 ### Changes
 * :sparkles: add webhook info to model searches

data/lib/mindee/dependencies.rb

@@ -3,6 +3,7 @@
 module Mindee
   # Centralized check for optional heavy dependencies
   module Dependencies
+    # Checks the presence of dependencies.
     def self.check_all_dependencies
       require 'origami'
       require 'mini_magick'
@@ -12,16 +13,20 @@ module Mindee
       false
     end
 
+    # Memoized check.
     @all_deps_available = check_all_dependencies
 
+    # Checks whether all dependencies are available.
     def self.all_deps_available?
       check_all_dependencies
     end
 
+    # Raises an error if dependencies are not available.
     def self.require_all_deps!
       raise LoadError, MINDEE_DEPENDENCIES_LOAD_ERROR unless all_deps_available?
     end
 
+    # Error message to display when dependencies are not available.
     MINDEE_DEPENDENCIES_LOAD_ERROR = 'Attempted to load Mindee PDF/Image tools without required dependencies. ' \
                                      "If you need to process local files, please replace the 'mindee-lite' gem " \
                                      "with the standard 'mindee' gem in your Gemfile."

data/lib/mindee/image/image_compressor.rb

@@ -9,7 +9,7 @@ module Mindee
       # @param image [MiniMagick::Image, StringIO] Input image.
       # @param quality [Integer, nil] Quality of the final file.
       # @param max_width [Integer, nil] Maximum width. If not specified, the horizontal ratio will remain the same.
-      # @param max_height [Integer] Maximum height. If not specified, the vertical ratio will remain the same.
+      # @param max_height [Integer, nil] Maximum height. If not specified, the vertical ratio will remain the same.
       # @return [StringIO]
       def self.compress_image(image, quality: 85, max_width: nil, max_height: nil)
         processed_image = ImageUtils.to_image(image)

data/lib/mindee/input/base_parameters.rb

@@ -22,7 +22,7 @@ module Mindee
       # @param [String] model_id ID of the model
       # @param [String, nil] file_alias File alias, if applicable.
       # @param [Array<String>, nil] webhook_ids List of webhook IDs to propagate the API response to.
-      # @param [Hash, nil] polling_options Options for polling. Set only if having timeout issues.
+      # @param [Hash, PollingOptions, nil] polling_options Options for polling. Set only if having timeout issues.
       # @param [Boolean, nil] close_file Whether to close the file after parsing.
       def initialize(
         model_id,
@@ -40,6 +40,13 @@ module Mindee
         @close_file = close_file.nil? || close_file
       end
 
+      # Sets polling options after normalizing hash inputs.
+      # @param [Hash, PollingOptions, nil] polling_options
+      # @return [PollingOptions]
+      def polling_options=(polling_options)
+        @polling_options = get_clean_polling_options(polling_options)
+      end
+
       # @return [String] Slug for the endpoint.
       def self.slug
         if self == BaseParameters

data/lib/mindee/input/sources/local_input_source.rb

@@ -83,12 +83,14 @@ module Mindee
         # @return [StringIO] The fixed stream.
         # @raise [Mindee::Error::MindeePDFError]
         def self.fix_pdf(stream, maximum_offset: 500)
-          out_stream = StringIO.new
+          out_stream = StringIO.new(''.b)
           stream.gets('%PDF-')
           raise Error::MindeePDFError if stream.eof? || stream.pos > maximum_offset
 
           stream.pos = stream.pos - 5
-          out_stream << stream.read
+          out_stream.write(stream.read.to_s.b)
+          out_stream.rewind
+          out_stream
         end
 
         # Cuts a PDF file according to provided options.

data/lib/mindee/v2/client.rb

@@ -57,14 +57,16 @@ module Mindee
       # @param input_source [Mindee::Input::Source::LocalInputSource, Mindee::Input::Source::URLInputSource]
       #   The source of the input document (local file or URL).
       # @param params [Hash, Input::BaseParameters] Parameters for the inference.
+      # @param polling_options [Hash, PollingOptions, nil] Parameters for polling.
       # @return [Parsing::BaseResponse]
       def enqueue_and_get_result(
         product,
         input_source,
-        params
+        params,
+        polling_options = nil
       )
         enqueue_response = enqueue(product, input_source, params)
-        normalized_params = normalize_parameters(product.params_type, params)
+        normalized_params = normalize_parameters(product.params_type, params, polling_options: polling_options)
         normalized_params.validate_async_params
 
         if enqueue_response.job.id.nil? || enqueue_response.job.id.empty?
@@ -121,8 +123,14 @@ module Mindee
 
       # If needed, converts the parsing options provided as a hash into a proper BaseParameters subclass object.
       # @param params [Hash, Class<BaseParameters>] Params.
+      # @param polling_options [Hash, PollingOptions, nil] Polling options.
       # @return [BaseParameters]
-      def normalize_parameters(param_class, params)
+      def normalize_parameters(param_class, params, polling_options: nil)
+        if params.is_a?(Hash)
+          params[:polling_options] = polling_options if polling_options
+        elsif params.is_a?(Mindee::Input::BaseParameters) && !polling_options.nil?
+          params.polling_options = polling_options
+        end
         return param_class.from_hash(params: params) if params.is_a?(Hash)
 
         params

data/lib/mindee/v2/product/classification/params/classification_parameters.rb

@@ -16,7 +16,7 @@ module Mindee
             # @param [String] model_id ID of the model
             # @param [String, nil] file_alias File alias, if applicable.
             # @param [Array<String>, nil] webhook_ids List of webhook IDs to propagate the API response to.
-            # @param [Hash, nil] polling_options Options for polling. Set only if having timeout issues.
+            # @param [Hash, PollingOptions, nil] polling_options Options for polling. Set only if having timeout issues.
             # @param [Boolean, nil] close_file Whether to close the file after parsing.
             def initialize(
               model_id,

data/lib/mindee/v2/product/crop/params/crop_parameters.rb

@@ -16,7 +16,7 @@ module Mindee
             # @param [String] model_id ID of the model
             # @param [String, nil] file_alias File alias, if applicable.
             # @param [Array<String>, nil] webhook_ids List of webhook IDs to propagate the API response to.
-            # @param [Hash, nil] polling_options Options for polling. Set only if having timeout issues.
+            # @param [Hash, PollingOptions, nil] polling_options Options for polling. Set only if having timeout issues.
             # @param [Boolean, nil] close_file Whether to close the file after parsing.
             def initialize(
               model_id,

data/lib/mindee/v2/product/extraction/params/data_schema.rb

@@ -13,7 +13,7 @@ module Mindee
             # @return [Mindee::V2::Product::Extraction::Params::DataSchemaReplace]
             attr_reader :replace
 
-            # @param data_schema [Hash, String]
+            # @param data_schema [Hash, DataSchema, String]
             def initialize(data_schema)
               case data_schema
               when String

data/lib/mindee/v2/product/extraction/params/extraction_parameters.rb

@@ -46,7 +46,7 @@ module Mindee
             # @param [String, nil] file_alias File alias, if applicable.
             # @param [Array<String>, nil] webhook_ids
             # @param [String, nil] text_context
-            # @param [Hash, nil] polling_options
+            # @param [Hash, PollingOptions, nil] polling_options
             # @param [Boolean, nil] close_file
             # @param [DataSchemaField, String, Hash nil] data_schema
             def initialize(

data/lib/mindee/v2/product/ocr/params/ocr_parameters.rb

@@ -16,7 +16,7 @@ module Mindee
             # @param [String] model_id ID of the model
             # @param [String, nil] file_alias File alias, if applicable.
             # @param [Array<String>, nil] webhook_ids List of webhook IDs to propagate the API response to.
-            # @param [Hash, nil] polling_options Options for polling. Set only if having timeout issues.
+            # @param [Hash, PollingOptions, nil] polling_options Options for polling. Set only if having timeout issues.
             # @param [Boolean, nil] close_file Whether to close the file after parsing.
             def initialize(
               model_id,

data/lib/mindee/v2/product/split/params/split_parameters.rb

@@ -17,7 +17,7 @@ module Mindee
             # @param [String] model_id ID of the model
             # @param [String, nil] file_alias File alias, if applicable.
             # @param [Array<String>, nil] webhook_ids List of webhook IDs to propagate the API response to.
-            # @param [Hash, nil] polling_options Options for polling. Set only if having timeout issues.
+            # @param [Hash, PollingOptions, nil] polling_options Options for polling. Set only if having timeout issues.
             # @param [Boolean, nil] close_file Whether to close the file after parsing.
             def initialize(
               model_id,

data/lib/mindee/version.rb

@@ -3,7 +3,7 @@
 # Mindee
 module Mindee
   # Current version.
-  VERSION = '5.2.0'
+  VERSION = '5.2.1'
 
   # Finds and return the current platform.
   # @return [Symbol, Hash[String | Symbol, Regexp], Nil?]

data/sig/mindee/input/base_parameters.rbs

@@ -26,6 +26,7 @@ module Mindee
 
       def append_form_data: (Array[Array[untyped]]) -> Array[Array[untyped]]
       def validate_async_params: () -> void
+      def polling_options=: (Hash[Symbol | String, untyped] | PollingOptions?) -> PollingOptions
 
       private
 

data/sig/mindee/v2/client.rbs

@@ -17,13 +17,13 @@ module Mindee
 
       def enqueue: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::BaseParameters params) -> V2::Parsing::JobResponse
 
-      def enqueue_and_get_result: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::BaseParameters params) -> T
+      def enqueue_and_get_result: [T] (HTTP::_ProductClass[T] product, Input::Source::LocalInputSource | Input::Source::URLInputSource, Hash[String | Symbol, untyped] | Input::BaseParameters params, ?Hash[String | Symbol, untyped] | Input::PollingOptions?) -> T
 
       def search_models: (String?, String?) -> Mindee::V2::Parsing::Search::SearchResponse
 
       def validate_async_params: (Integer | Float, Integer | Float, Integer) -> void
 
-      def normalize_parameters: (singleton(Input::BaseParameters) param_class, Hash[String | Symbol, untyped] | Input::BaseParameters params) -> Input::BaseParameters
+      def normalize_parameters: (singleton(Input::BaseParameters) param_class, Hash[String | Symbol, untyped] | Input::BaseParameters params, ?polling_options: Hash[String | Symbol, untyped] | Input::PollingOptions?) -> Input::BaseParameters
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 5.2.0
+  version: 5.2.1
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-19 00:00:00.000000000 Z
+date: 2026-05-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64