mindee-lite 5.0.0.beta1

data/lib/mindee.rb

@@ -0,0 +1,135 @@
+# frozen_string_literal: true
+
+require 'mindee/logging'
+require 'mindee/page_options'
+require 'mindee/v1'
+require 'mindee/v2'
+
+module Mindee
+  # Dependency management
+  module Dependency
+  end
+
+  # Mindee internal error module.
+  module Error
+  end
+
+  # Custom extraction module
+  module Extraction
+  end
+
+  # Mindee internal http module.
+  module HTTP
+  end
+
+  # PDF-specific operations.
+  module PDF
+  end
+
+  # Document handling.
+  module Input
+    # Document source handling.
+    module Source
+    end
+  end
+
+  module Image
+    # Miscellaneous image operations.
+    module ImageUtils
+    end
+
+    # Image compressor module to handle image compression.
+    module ImageCompressor
+    end
+  end
+
+  # Logging
+  module Logging
+  end
+
+  # Document input-related internals.
+  module Input
+  end
+
+  # Collection of all internal products.
+  module Product
+    # Europe-specific products.
+    module EU
+    end
+
+    # France-specific products.
+    module FR
+    end
+
+    # Indian-specific products.
+    module IND
+    end
+
+    # US-specific products.
+    module US
+    end
+  end
+
+  # V1-specific module.
+  module V1
+    # HTTP module for V1.
+    module HTTP
+    end
+
+    # Parsing internals and fields.
+    module Parsing
+      # Common fields and functions.
+      module Common
+      end
+
+      # Standard fields and functions.
+      module Standard
+      end
+
+      # Universal fields and functions.
+      module Universal
+      end
+    end
+
+    # V1-specific products.
+    module Product
+      # French products.
+      module FR
+      end
+    end
+  end
+
+  # V2-specific module.
+  module V2
+    # Mindee internal http module.
+    module HTTP
+    end
+
+    # File operations.
+    module FileOperation
+      # Crop operations.
+      module Crop
+      end
+
+      # Split operations.
+      module Split
+      end
+    end
+
+    # Product-specific module.
+    module Product
+    end
+
+    # V2 parsing module.
+    module Parsing
+      # V2 search module.
+      module Search
+      end
+    end
+  end
+end
+
+# Shorthand to call the logger from anywhere.
+def logger
+  Mindee::Logging.logger
+end

data/mindee-lite.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mindee/version'
+
+Gem::Specification.new do |spec|
+  spec.name = 'mindee-lite'
+  spec.version = Mindee::VERSION
+  spec.authors = ['Mindee, SA']
+  spec.email = ['opensource@mindee.co']
+
+  spec.summary = 'Mindee API Helper Library for Ruby (Lite)'
+  spec.description = "Quickly and easily connect to Mindee's API services using Ruby. This lite version omits " \
+                     'heavy image and PDF processing dependencies.'
+  spec.homepage = 'https://github.com/mindee/mindee-api-ruby'
+  spec.license = 'MIT'
+
+  spec.metadata['homepage_uri'] = 'https://mindee.com/'
+  spec.metadata['source_code_uri'] = 'https://github.com/mindee/mindee-api-ruby'
+  spec.metadata['changelog_uri'] = 'https://github.com/mindee/mindee-api-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(.github|spec|features)/}) }
+  end
+  spec.bindir = 'bin'
+  spec.executables = Dir.children('bin')
+                        .select { |f| File.file?(File.join('bin', f)) }
+                        .reject { |f| f == 'products.rb' }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.2')
+
+  spec.add_dependency 'base64', '~> 0.3'
+  spec.add_dependency 'logger', '~> 1.7'
+  spec.add_dependency 'marcel', '~> 1.1'
+end

data/mindee.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+require_relative 'lib/mindee/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mindee'
+  spec.version       = Mindee::VERSION
+  spec.authors       = ['Mindee, SA']
+  spec.email         = ['opensource@mindee.co']
+
+  spec.summary       = 'Mindee API Helper Library for Ruby'
+  spec.description   = "Quickly and easily connect to Mindee's API services using Ruby."
+  spec.homepage      = 'https://github.com/mindee/mindee-api-ruby'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri']      = 'https://mindee.com/'
+  spec.metadata['source_code_uri']   = 'https://github.com/mindee/mindee-api-ruby'
+  spec.metadata['changelog_uri']     = 'https://github.com/mindee/mindee-api-ruby/blob/main/CHANGELOG.md'
+  spec.metadata['rubygems_mfa_required'] = 'true'
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(.github|spec|features)/}) }
+  end
+  spec.bindir = 'bin'
+  spec.executables = Dir.children('bin')
+                        .select { |f| File.file?(File.join('bin', f)) }
+                        .reject { |f| f == 'products.rb' }
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = Gem::Requirement.new('>= 3.2')
+
+  spec.add_dependency 'base64', '~> 0.3'
+  spec.add_dependency 'logger', '~> 1.7'
+  spec.add_dependency 'marcel', '~> 1.1'
+  spec.add_dependency 'mini_magick', '>= 4', '< 6'
+  spec.add_dependency 'origamindee', '~> 4.0'
+  spec.add_dependency 'pdf-reader', '~> 2.15'
+
+  spec.add_development_dependency 'bundle-audit', '~> 0.2.0'
+  spec.add_development_dependency 'rbs', '~> 3.10'
+  spec.add_development_dependency 'rubocop', '~> 1.86'
+  spec.add_development_dependency 'steep', '~> 1.10'
+  spec.add_development_dependency 'yard', '~> 0.9'
+end

data/sig/custom/marcel.rbs

@@ -0,0 +1,3 @@
+module Marcel
+  MimeType: untyped
+end

data/sig/custom/mini_magick.rbs

@@ -0,0 +1,31 @@
+# Stub for the mini_magick library.
+# NOTE: though typing annotations for the MiniMagick library now exist, it seems that they aren't strict enough
+# to match the rules we have on the repo, hence the existence of this file and the overrides present below.
+module MiniMagick
+  class Image
+    def self.format: (String, ?Integer?, ?Hash[Symbol, untyped]?) -> Net::BufferedIO
+    def format: (String, ?Integer?, ?Hash[Symbol, untyped]?) -> Net::BufferedIO
+    def self.quality: (String) -> Net::BufferedIO
+    def self.crop: (String) -> Net::BufferedIO
+    def crop: (String) -> Net::BufferedIO
+    def self.height: () -> Integer
+    def self.width: () -> Integer
+    def height: () -> Integer
+    def width: () -> Integer
+    def self.data: (?untyped?, ?untyped?) -> untyped
+    def data: (?untyped?, ?untyped) -> instance
+    def self.read: (?untyped?, ?untyped?) -> Image
+    def read: (?untyped?, ?untyped) -> Image
+    def self.resolution: () -> Array[Float | Integer]
+    def resolution: () -> Array[Float | Integer]
+    def self.write: (StringIO | String) -> Net::BufferedIO
+    def write: (StringIO | String) -> Net::BufferedIO
+    def quality: (String) -> void
+    def self.resize: (String) -> void
+    def resize: (String) -> void
+    def self.to_blob: () -> String
+    def to_blob: () -> String
+    def self.[]: (*untyped) -> untyped
+    def []: (*untyped) -> untyped
+  end
+end

data/sig/custom/net_http.rbs

@@ -0,0 +1,43 @@
+# This is a stub of mock type declarations for the net/http standard library, which isn't
+# currently supported by Steep.
+# Do not mess with it unless Steep fixes the handling of this library.
+
+module Net
+  class BufferedIO
+  end
+  class HTTP
+    def self.start: [T] (String?, Integer?, use_ssl: bool?, ?read_timeout: Integer) { (HTTP) -> T } -> T
+
+    def request: (untyped) -> untyped
+
+    # Stub for the HTTP POST request class.
+    class Post
+      def initialize: (untyped, Hash[String, String?]?) -> void
+      def set_form: (untyped, String?) -> void
+      def new: (untyped, untyped) -> void
+      def []=: (?untyped, ?untyped) -> bool
+    end
+
+    # Stub for the HTTP GET request class.
+    class Get
+      def initialize: (untyped, ?Hash[String, String?]?) -> void
+      def new: (untyped, untyped) -> void
+      def basic_auth: (untyped, untyped) -> void
+      def []=: (?untyped, ?untyped) -> bool
+    end
+  end
+
+  class HTTPResponse
+    def self.body: -> String
+    def body: -> String
+    def []: (untyped) -> untyped
+    def key?: (untyped) -> bool
+    def code: -> String
+  end
+
+  class HTTPRedirection
+    def []: (untyped) -> untyped
+    def body: -> untyped
+    def code: -> String?
+  end
+end

data/sig/custom/origami.rbs

@@ -0,0 +1,59 @@
+# Stubs for the origami library.
+# This one _should_ exist, but it would take too long, so this is a stub.
+module Origami
+  def compile: (Hash[Symbol, untyped]) -> void
+  class Array
+    def each: { (untyped) -> untyped } -> untyped
+  end
+  class PDF
+    def self.read: (StringIO | File) -> untyped
+    def initialize: () -> void
+    def append_page: (Page) -> void
+    def delete_pages_at: (::Array[Integer]) -> void
+    def pages: () -> ::Array[Page]
+    def save: (StringIO | File) -> void
+    def to_io_stream: -> StringIO
+    class LinearParser
+      def initialize: (Hash[Symbol, untyped]) -> void
+      def new: (Hash[Symbol, untyped]) -> void
+      def parse: (StringIO | File?) -> PDF
+    end
+  end
+
+  class Page
+    def initialize: () -> void
+    def add_xobject: (Graphics::ImageXObject, String) -> untyped
+    def Contents: (?untyped?) -> untyped
+    def Contents=: (?untyped?, untyped?) -> untyped
+    def []: (untyped) -> untyped
+    def []=: (untyped, untyped) -> bool
+  end
+
+  module Graphics
+    class ImageXObject
+      def initialize: () -> void
+
+      def BitsPerComponent=: (Integer) -> untyped
+      def ColorSpace=: (Symbol) -> untyped
+      def dictionary: () -> Hash[Symbol, untyped]
+      def data=: (StringIO) -> untyped
+      def self.from_image_file: (StringIO, String) -> untyped
+      def Height=: (Integer | Float) -> untyped
+      def Width=: (Integer | Float) -> untyped
+    end
+  end
+
+  class InvalidPDFError < StandardError
+  end
+
+  class Parser
+    VERBOSE_QUIET: String
+  end
+
+  class Stream
+    def initialize: (?String) -> untyped
+    def data : () -> untyped
+    def data= : (String | StringIO) -> void
+    def dictionary : -> Hash[Symbol, untyped]
+  end
+end

data/sig/mindee/dependency.rbs

@@ -0,0 +1,13 @@
+module Mindee
+  module Dependency
+    MINDEE_DEPENDENCIES_LOAD_ERROR: String
+
+    self.@all_deps_available: bool
+
+    def self.check_all_dependencies: -> bool
+
+    def self.all_deps_available?: -> bool
+    def self.require_all_deps!: -> void
+
+  end
+end

data/sig/mindee/error/mindee_error.rbs

@@ -0,0 +1,13 @@
+# lib/mindee/error/mindee_error.rb
+module Mindee
+  module Error
+    class MindeeError < StandardError
+    end
+    class MindeeAPIError < MindeeError
+    end
+    class MindeeConfigurationError < MindeeError
+    end
+    class MindeeGeometryError < MindeeError
+    end
+  end
+end

data/sig/mindee/error/mindee_http_error.rbs

@@ -0,0 +1,17 @@
+# lib/mindee/error/mindee_http_error.rb
+module Mindee
+  module Error
+    class MindeeHTTPError < Error::MindeeError
+      attr_reader api_code: Integer
+      attr_reader api_details: String
+      attr_reader api_message: String
+      attr_reader status_code: Integer
+
+      def initialize: (Hash[String | Symbol, untyped], String, Integer) -> void
+    end
+    class MindeeHTTPClientError < MindeeHTTPError
+    end
+    class MindeeHTTPServerError < MindeeHTTPError
+    end
+  end
+end

data/sig/mindee/error/mindee_http_error_v2.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/error/mindee_http_error_v2.rb
+module Mindee
+  module Error
+    # API V2 HttpError
+    class MindeeHTTPErrorV2 < MindeeError
+      attr_reader detail: String
+      attr_reader status: Integer
+      attr_reader code: String
+      attr_reader title: String
+      attr_reader errors: Array[V2::Parsing::ErrorItem]
+
+      def initialize: (Hash[String, untyped] | Mindee::V2::Parsing::ErrorResponse) -> void
+    end
+  end
+end

data/sig/mindee/error/mindee_http_unknown_error_v2.rbs

@@ -0,0 +1,9 @@
+# lib/mindee/error/mindee_http_unknown_error_v2.rb
+module Mindee
+  module Error
+    # Unknown HTTP error for the V2 API.
+    class MindeeHTTPUnknownErrorV2 < MindeeHTTPErrorV2
+      def initialize: (Hash[String|Symbol, untyped]) -> void
+    end
+  end
+end

data/sig/mindee/error/mindee_input_error.rbs

@@ -0,0 +1,18 @@
+# lib/mindee/error/mindee_input_error.rb
+module Mindee
+  module Error
+    class MindeeInputError < MindeeError
+    end
+    class MindeeSourceError < MindeeInputError
+    end
+    class MindeeMimeTypeError < MindeeSourceError
+      attr_reader invalid_mimetype: String
+
+      def initialize: (String) -> void
+    end
+    class MindeeImageError < MindeeInputError
+    end
+    class MindeePDFError < MindeeInputError
+    end
+  end
+end

data/sig/mindee/geometry/min_max.rbs

@@ -0,0 +1,11 @@
+# lib/mindee/geometry/min_max.rb
+module Mindee
+  module Geometry
+    class MinMax
+      attr_reader max: Float
+      attr_reader min: Float
+
+      def initialize: (Float, Float) -> void
+    end
+  end
+end

data/sig/mindee/geometry/point.rbs

@@ -0,0 +1,14 @@
+# lib/mindee/geometry/point.rb
+module Mindee
+  module Geometry
+    class Point
+      attr_accessor x: Float
+      attr_accessor y: Float
+
+      def initialize: (Float, Float) -> void
+      def []: (Integer) -> Float
+
+      def to_s: -> String
+    end
+  end
+end

data/sig/mindee/geometry/polygon.rbs

@@ -0,0 +1,12 @@
+# lib/mindee/geometry/polygon.rb
+module Mindee
+  module Geometry
+    class Polygon < Array[Point]
+      def initialize: (Array[::Mindee::Geometry::Point | Array[Float]]) -> void
+      def centroid: -> Point
+      def point_in_y?: (Point) -> bool
+
+      def to_s: -> String
+    end
+  end
+end

data/sig/mindee/geometry/quadrilateral.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/geometry/quadrilateral.rb
+module Mindee
+  module Geometry
+    class Quadrilateral
+      attr_accessor bottom_left: Point
+      attr_accessor bottom_right: Point
+      attr_accessor top_left: Point
+      attr_accessor top_right: Point
+
+      def initialize: (Point, Point, Point, Point) -> void
+      def []: (Integer) -> Point
+      def size: -> Integer
+    end
+  end
+end

data/sig/mindee/geometry/utils.rbs

@@ -0,0 +1,13 @@
+# lib/mindee/geometry/utils.rb
+module Mindee
+  module Geometry
+    def self.quadrilateral_from_prediction: (Array[Array[Float]]) -> Quadrilateral
+    def self.polygon_from_prediction: (Array[Array[Float]]) -> Polygon
+    def self.get_bbox: (Array[Point]) -> [Float, Float, Float, Float]
+    def self.get_bounding_box: (Array[Point]) -> Quadrilateral
+    def self.get_centroid: (Array[Point]) -> Point
+    def self.get_min_max_y: (Array[Point]) -> MinMax
+    def self.get_min_max_x: (Array[Point]) -> MinMax
+    def self.below?: (Array[Point], Array[Point], Float, Float) -> bool
+  end
+end

data/sig/mindee/http/http_error_handler.rbs

@@ -0,0 +1,15 @@
+# lib/mindee/http/http_error_handler.rb
+module Mindee
+  module HTTP
+    module ErrorHandler
+      def extract_error: (Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped]?
+      def create_error_obj: (Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped]
+      def self.generate_v2_error: (Hash[String, Integer | String]) -> Error::MindeeHTTPErrorV2
+      def generate_v2_error: (Hash[Symbol, String | Integer]) -> Error::MindeeHTTPErrorV2
+
+      def self.handle_error: (String, Net::HTTPResponse) -> Error::MindeeHTTPError
+      def handle_error:      (String, Net::HTTPResponse) -> Error::MindeeHTTPError
+      def handle_v2_error: (Hash[String | Symbol, untyped]) -> void
+    end
+  end
+end

data/sig/mindee/http/response_validation.rbs

@@ -0,0 +1,11 @@
+# lib/mindee/http/response_validation.rb
+module Mindee
+  module HTTP
+    module ResponseValidation
+      def self.valid_sync_response?: (Net::HTTPResponse) -> bool
+      def self.valid_v2_response?: (Net::HTTPResponse) -> bool
+      def self.valid_async_response?: (Net::HTTPResponse) -> bool
+      def self.clean_request!: (Net::HTTPResponse) -> void
+    end
+  end
+end

data/sig/mindee/image/extracted_image.rbs

@@ -0,0 +1,21 @@
+# lib/mindee/image/extracted_image.rb
+module Mindee
+  module Image
+    class ExtractedImage
+      def logger: () -> Logger
+      def page_id: -> Integer
+      def element_id: -> Integer
+      def buffer: -> StringIO
+      def filename: -> String
+      def initialize: (
+        Input::Source::LocalInputSource | Input::Source::BytesInputSource,
+        Integer,
+        Integer?,
+        ?preserve_input_filename: bool
+      ) -> Integer
+      def write_to_file: (String, ?String?) -> void
+      def as_source: -> Input::Source::BytesInputSource
+      def as_input_source: -> Input::Source::BytesInputSource
+    end
+  end
+end

data/sig/mindee/image/image_compressor.rbs

@@ -0,0 +1,8 @@
+# lib/mindee/image/image_compressor.rb
+module Mindee
+  module Image
+    module ImageCompressor
+      def self.compress_image: (MiniMagick::Image | StringIO | File, ?quality: Integer | Float?, ?max_width: Integer | Float?, ?max_height: Integer | Float?) -> StringIO
+    end
+  end
+end

data/sig/mindee/image/image_extractor.rbs

@@ -0,0 +1,13 @@
+# lib/mindee/image/image_extractor.rb
+module Mindee
+  module Image
+    module ImageExtractor
+      def self.attach_image_as_new_file: (StringIO | File, ?format: String) -> Origami::PDF
+      def self.to_blob: () -> String
+      def self.extract_multiple_images_from_source: (Input::Source::LocalInputSource, Integer, Array[Array[Geometry::Point] |Geometry::Polygon | Geometry::Quadrilateral]) -> Array[ExtractedImage]
+      def self.extract_images_from_polygons: (Input::Source::LocalInputSource, StringIO | File, Integer, Array[Array[Geometry::Point] | Geometry::Polygon | Geometry::Quadrilateral]) -> Array[ExtractedImage]
+      def self.create_extracted_image: (StringIO | File, String, Integer, Integer) -> ExtractedImage
+      def self.load_input_source_pdf_page_as_stringio: (Input::Source::LocalInputSource, Integer) -> (StringIO | File)
+    end
+  end
+end

data/sig/mindee/image/image_utils.rbs

@@ -0,0 +1,19 @@
+# lib/mindee/image/image_utils.rb
+module Mindee
+  module Image
+    module ImageUtils
+      def self.resize_image: (MiniMagick::Image, Integer, Integer) -> void
+      def self.compress_image_quality: (MiniMagick::Image, untyped) -> void
+      def self.to_image: (MiniMagick::Image | StringIO | IO | File | Tempfile?) -> (MiniMagick::Image)
+      def self.image_to_stringio: (MiniMagick::Image, ?String) -> StringIO
+      def self.calculate_new_dimensions: (MiniMagick::Image, ?max_width: Integer | Float?, ?max_height: Integer | Float?) -> [Integer, Integer]
+      def self.calculate_dimensions_from_media_box: (MiniMagick::Image, Array[Integer]?) -> [Integer, Integer]
+      def self.pdf_to_magick_image: (StringIO | File, Integer) -> MiniMagick::Image
+      def self.normalize_polygon: (Geometry::Quadrilateral | Geometry::Polygon | Array[Geometry::Point]) -> Geometry::Quadrilateral
+      def self.read_page_content: (StringIO | File) -> (MiniMagick::Image)
+      def self.crop_image: (MiniMagick::Image, Geometry::MinMax, Geometry::MinMax) -> (MiniMagick::Image)
+      def self.write_image_to_buffer: (MiniMagick::Image, StringIO) -> void
+      def self.determine_file_extension: (Input::Source::LocalInputSource) -> String?
+    end
+  end
+end

data/sig/mindee/input/base_parameters.rbs

@@ -0,0 +1,35 @@
+# lib/mindee/input/base_parameters.rb
+
+module Mindee
+  module Input
+    class BaseParameters
+      attr_reader self.slug: String
+
+      def self.from_hash: (params: Hash[String | Symbol, untyped]) -> instance
+      def self.load_from_hash: (params: Hash[String | Symbol, untyped]) -> Hash[String | Symbol, untyped]
+
+      def slug: -> String
+
+      attr_reader model_id: String
+      attr_reader file_alias: String?
+      attr_reader webhook_ids: Array[String]?
+      attr_reader polling_options: PollingOptions
+      attr_reader close_file: bool
+
+      def initialize: (
+          String,
+          ?file_alias: String?,
+          ?webhook_ids: Array[String]?,
+          ?polling_options: Hash[Symbol | String, untyped] | PollingOptions?,
+          ?close_file: bool?
+        ) -> void
+
+      def append_form_data: (Array[Array[untyped]]) -> Array[Array[untyped]]
+      def validate_async_params: () -> void
+
+      private
+
+      def get_clean_polling_options: (Hash[String | Symbol, untyped] | PollingOptions?) -> PollingOptions
+    end
+  end
+end

data/sig/mindee/input/local_response.rbs

@@ -0,0 +1,14 @@
+# lib/mindee/input/local_response.rb
+module Mindee
+  module Input
+    class LocalResponse
+      attr_reader file: StringIO
+      def initialize: (File | IO | StringIO | String | Pathname | Tempfile) -> void
+      def as_hash: -> Hash[String | Symbol, untyped]
+      def self.process_secret_key: (String) -> String
+      def get_hmac_signature: (String) -> String
+      def valid_hmac_signature?: (String, String) -> bool
+      def deserialize_response: (singleton(V2::Parsing::CommonResponse))-> (V2::Parsing::CommonResponse)
+    end
+  end
+end