mindee 5.2.1 → 5.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: addb1d4afceb4816df637946d7d0028da0459681ae05ecf5ce9550f5a2329b2c
-  data.tar.gz: f495ddafda38ba5f5cf6c0e00e88a331a32264a297704a941136d61b660700a8
+  metadata.gz: b779325cb790132dd8d191e72761e2145c7162d4316ac7ba254987ceb471547f
+  data.tar.gz: c00cd97ccded0ac194a1311d45adc36baa04c5e932fd49248b46c59e065c71f7
 SHA512:
-  metadata.gz: 2e2784c6fb7c8a8cb98eb1bb6d191b451899fbd4c4a4ae985d8f7d0271b4aa2a97edc64a0b084a700d8769def4b0400cdab24393b3eb7b1f14726407d7f2c93b
-  data.tar.gz: 6718cc7f954306771effbc7e96236bd246ed7aaf34f6296278d55cc821e3d850e54ce03608c64d7d81cb05d4b4ed8cf4055e2d0c08ec4ec315c0dfc0d948a188
+  metadata.gz: f7c68cd5d0281f22e0b4476fa6470dc840612045c15eeb6127fe8f50f78c5170f0c07fb5bbe30049f7029330f34390102b11c2ec59264ce2d95b71cf998486e9
+  data.tar.gz: d53c54dee59e8f1ee9ff6b62267def50a08248d27e491f2d5ccd53a28277812167c507efa7f1f990cb7a264985df126b7a9cb8c544c728dd98a5d243207b26f2

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Mindee Ruby API Library Changelog
 
+## v5.2.2 - 2026-06-18
+### Changes
+* :recycle: refactor CLI to conform with other client libraries
+* :recycle: add secondary accessor for search model pagination to match json return
+* :recycle: ensure HEIF images are detected as such and properly handled
+
+
 ## v5.2.1 - 2026-05-27
 ### Changes
 * :recycle: add polling options as a dedicated parameter (#252)

data/bin/mindee.rb

@@ -6,24 +6,29 @@ require 'optparse'
 require_relative 'v1/parser'
 require_relative 'v2/parser'
 
-def setup_main_parser
-  v1_parser = MindeeCLI::V1Parser.new(ARGV)
-  v2_parser = MindeeCLI::V2Parser.new(ARGV)
-  main_parser = OptionParser.new do |opts|
-    opts.banner = "Usage: mindee [command]"
-    opts.separator "Commands:"
-    opts.separator "  v1    Use Version 1 of the Mindee API"
-    opts.separator "  v2    Use Version 2 of the Mindee API"
+def root_help
+  help = "Usage: mindee command [options]\n\nAvailable commands:\n"
+  help += "  #{'v1'.ljust(50)}Use Version 1 of the Mindee API\n"
+  help += "  #{'search-models'.ljust(50)}Search for available models for this API key\n"
+
+  V2_PRODUCTS.each do |product_key, product_values|
+    help += "  #{product_key.ljust(50)}#{product_values[:description]}\n"
   end
-  main_command = ARGV.shift
 
-  case main_command
-  when 'v1'
-    v1_parser.execute
-  when 'v2'
-    v2_parser.execute
+  help
+end
+
+def setup_main_parser
+  main_command = ARGV.first
+
+  if main_command == 'v1'
+    ARGV.shift
+    MindeeCLI::V1Parser.new(ARGV).execute
+  elsif main_command.nil? || %w[help -h --help].include?(main_command)
+    abort(root_help)
   else
-    abort(main_parser.help)
+    ARGV.shift if main_command == 'v2'
+    MindeeCLI::V2Parser.new(ARGV, command_prefix: 'mindee').execute
   end
 end
 

data/bin/v2/parser.rb

@@ -19,10 +19,11 @@ module MindeeCLI
     # @return [Parser]
     attr_reader :search_parser
 
-    def initialize(arguments)
+    def initialize(arguments, command_prefix: 'mindee v2')
       @arguments = arguments
+      @command_prefix = command_prefix
       @options_parser = OptionParser.new do |opts|
-        opts.banner = 'Usage: mindee v2 command [options]'
+        opts.banner = "Usage: #{@command_prefix} command [options]"
       end
       @product_parser = init_product_parser
       @search_parser = init_search_parser
@@ -67,6 +68,8 @@ module MindeeCLI
       else
         abort("#{e.message}\n\n#{@product_parser[command].help}")
       end
+    rescue Mindee::Error::MindeeError => e
+      abort(format_cli_error(e))
     end
 
     private
@@ -83,9 +86,21 @@ module MindeeCLI
       abort(error_msg)
     end
 
+    def format_cli_error(error)
+      if error.is_a?(Mindee::Error::MindeeHTTPErrorV2) && error.status.to_i == 401
+        "CLI error: Missing credentials. Provide an API key using '--key' or " \
+          "the 'MINDEE_V2_API_KEY' environment variable."
+      elsif error.is_a?(Mindee::Error::MindeeAPIError) && error.message.include?('Missing API key')
+        "CLI error: Missing API key. Provide it using '--key' or " \
+          "the 'MINDEE_V2_API_KEY' environment variable."
+      else
+        "CLI error: #{error.message}"
+      end
+    end
+
     def init_search_parser
       OptionParser.new do |options_parser|
-        options_parser.banner = 'Usage: mindee v2 search-models [options]'
+        options_parser.banner = "Usage: #{@command_prefix} search-models [options]"
         init_common_options(options_parser)
         options_parser.on('-n [NAME]', '--name [NAME]',
                           'Search for partial matches in model name. Note: case insensitive') do |v|
@@ -159,7 +174,7 @@ module MindeeCLI
       v2_product_parser = {}
       V2_PRODUCTS.each do |product_key, product_values|
         v2_product_parser[product_key] = OptionParser.new do |options_parser|
-          options_parser.banner = "Usage: mindee v2 #{product_key} [options] file"
+          options_parser.banner = "Usage: #{@command_prefix} #{product_key} [options] file"
           options_parser.on('-m MODEL_ID', '--model-id MODEL_ID', 'Model ID') { |v| @options[:model_id] = v }
           options_parser.on('-a ALIAS', '--alias ALIAS', 'Add a file alias to the response') do |v|
             @options[:alias] = v

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

@@ -16,6 +16,7 @@ module Mindee
       ALLOWED_MIME_TYPES = [
         'application/pdf',
         'image/heic',
+        'image/heif',
         'image/png',
         'image/jpeg',
         'image/tiff',
@@ -37,11 +38,7 @@ module Mindee
         def initialize(io_stream, filename, repair_pdf: false)
           @io_stream = io_stream
           @filename = filename
-          @file_mimetype = if repair_pdf
-                             Marcel::MimeType.for @io_stream
-                           else
-                             Marcel::MimeType.for @io_stream, name: @filename
-                           end
+          @file_mimetype = detect_mime_type(repair_pdf)
           if ALLOWED_MIME_TYPES.include? @file_mimetype
             logger.debug("Loaded new input #{@filename} from #{self.class}")
             return
@@ -197,6 +194,28 @@ module Mindee
 
           Mindee::PDF::PDFTools.source_text?(@io_stream)
         end
+
+        private
+
+        # Checks the mimetype for the file. If it is a PDF, it will attempt to repair it if repair_pdf is true.
+        # @param repair_pdf [bool] Whether to attempt to repair the PDF.
+        # @return [String] The mimetype of the file.
+        def detect_mime_type(repair_pdf)
+          return Marcel::MimeType.for(@io_stream) if repair_pdf
+
+          heif_mimetype_from_extension || Marcel::MimeType.for(@io_stream, name: @filename)
+        end
+
+        # Checks the file extension for a HEIF mimetype.
+        # @return [String, nil] The mimetype if found, nil otherwise.
+        def heif_mimetype_from_extension
+          case File.extname(@filename.to_s).downcase
+          when '.heic'
+            'image/heic'
+          when '.heif'
+            'image/heif'
+          end
+        end
       end
 
       # Replaces non-ASCII characters by their UNICODE escape sequence.

data/lib/mindee/v2/parsing/search/search_response.rb

@@ -6,16 +6,19 @@ module Mindee
       module Search
         # Models search response.
         class SearchResponse < CommonResponse
-          # @return [Search::Search] Parsed search payload.
+          # @return [Search::SearchModels] Parsed search payload.
           attr_reader :models
-          # @return [Search::Search] Pagination metadata.
+          # @return [Search::PaginationMetadata] Pagination metadata.
+          attr_reader :pagination
+          # @return [Search::PaginationMetadata] Pagination metadata.
           attr_reader :pagination_metadata
 
           def initialize(server_response)
             super
 
-            @models = Search::SearchModels.new(server_response['models'])
-            @pagination_metadata = PaginationMetadata.new(server_response['pagination'])
+            @models = SearchModels.new(server_response['models'])
+            @pagination = PaginationMetadata.new(server_response['pagination'])
+            @pagination_metadata = @pagination
           end
 
           # String representation.
@@ -27,7 +30,7 @@ module Mindee
               @models.to_s,
               'Pagination Metadata',
               '###################',
-              @pagination_metadata.to_s,
+              @pagination.to_s,
               '',
             ].join("\n")
           end

data/lib/mindee/version.rb

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

data/sig/mindee/input/sources/local_input_source.rbs

@@ -23,6 +23,12 @@ module Mindee
         def write_to_file: (String?) -> void
         def compress!: (?quality: Integer, ?max_width: Integer?, ?max_height: Integer?, ?force_source_text: bool, ?disable_source_text: bool) -> Integer
         def source_text?: -> bool?
+
+        private
+
+        def detect_mime_type: (bool) -> String
+
+        def heif_mimetype_from_extension: -> String?
       end
       def self.convert_to_unicode_escape: (String) -> String
     end

data/sig/mindee/v2/parsing/search/search_models.rbs

@@ -0,0 +1,13 @@
+# lib/mindee/v2/parsing/search/search_models.rb
+
+module Mindee
+  module V2
+    module Parsing
+      module Search
+        # Array of search models.
+        class SearchModels < Array[SearchModel]
+        end
+      end
+    end
+  end
+end

data/sig/mindee/v2/parsing/search/search_response.rbs

@@ -5,6 +5,7 @@ module Mindee
       module Search
         class SearchResponse
           attr_reader models: Array[SearchResponse]
+          attr_reader pagination: PaginationMetadata
           attr_reader pagination_metadata: PaginationMetadata
 
           def initialize: (Hash[String|Symbol, untyped]) -> void

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mindee
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 5.2.2
 platform: ruby
 authors:
 - Mindee, SA
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-05-27 00:00:00.000000000 Z
+date: 2026-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -174,8 +174,8 @@ description: Quickly and easily connect to Mindee's API services using Ruby.
 email:
 - opensource@mindee.co
 executables:
-- mindee.rb
 - console
+- mindee.rb
 extensions: []
 extra_rdoc_files: []
 files:
@@ -652,6 +652,7 @@ files:
 - sig/mindee/v2/parsing/search/model_webhook.rbs
 - sig/mindee/v2/parsing/search/pagination_metadata.rbs
 - sig/mindee/v2/parsing/search/search_model.rbs
+- sig/mindee/v2/parsing/search/search_models.rbs
 - sig/mindee/v2/parsing/search/search_response.rbs
 - sig/mindee/v2/parsing/search_models.rbs
 - sig/mindee/v2/product/base_product.rbs