Repository navigation
✨ simplify access to input sources - #279
Merged
Merged
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The updated spec lacks the mindee import needed for the new top-level aliases, causing standalone runs to raise NameError even when full-suite load order masks the issue.
1 open issue
What changed in this PR
This PR simplifies input-source creation in the Mindee Ruby SDK by exposing existing source classes directly under Mindee, while retaining their nested names.
Changes:
- Adds five top-level input-source aliases and corresponding RBS declarations.
- Updates V1 and V2 code samples to use
Mindee::PathInputSource.new. - Updates input-source specs to exercise the shorter names and reorganizes RBS namespaces.
| File | Description |
|---|---|
lib/mindee.rb |
Adds five top-level input-source aliases. |
sig/mindee.rbs |
Declares aliases and reorganizes namespaces. |
spec/input/sources/url_input_source_spec.rb |
Uses URL and bytes aliases. |
spec/input/sources/sources_spec.rb |
Uses the path alias in format tests. |
spec/input/sources/files_handling_spec.rb |
Uses path and Base64 aliases. |
docs/code_samples/workflow_polling.txt |
Simplifies workflow input creation. |
docs/code_samples/v2_split.txt |
Simplifies split input creation. |
docs/code_samples/v2_ocr.txt |
Simplifies OCR input creation. |
docs/code_samples/v2_extraction.txt |
Simplifies extraction input creation. |
docs/code_samples/v2_extraction_webhook.txt |
Simplifies webhook extraction input creation. |
docs/code_samples/v2_crop.txt |
Simplifies crop input creation. |
docs/code_samples/v2_classification.txt |
Simplifies classification input creation. |
docs/code_samples/resume_v1_async.txt |
Uses the path alias for résumés. |
docs/code_samples/passport_v1.txt |
Uses the path alias for passports. |
docs/code_samples/multi_receipts_detector_v1.txt |
Uses the path alias for receipt detection. |
docs/code_samples/invoices_v4.txt |
Uses the path alias for invoices. |
docs/code_samples/invoices_v4_async.txt |
Uses the path alias for async invoices. |
docs/code_samples/invoice_splitter_v1_async.txt |
Uses the path alias for invoice splitting. |
docs/code_samples/international_id_v2_async.txt |
Uses the path alias for international IDs. |
docs/code_samples/idcard_fr_v2.txt |
Uses the path alias for French ID cards. |
docs/code_samples/financial_document_v1.txt |
Uses the path alias for financial documents. |
docs/code_samples/financial_document_v1_async.txt |
Uses the path alias for async financial documents. |
docs/code_samples/expense_receipts_v5.txt |
Uses the path alias for expense receipts. |
docs/code_samples/expense_receipts_v5_async.txt |
Uses the path alias for async expense receipts. |
docs/code_samples/default.txt |
Simplifies custom-endpoint input creation. |
docs/code_samples/default_async.txt |
Simplifies async custom-endpoint input creation. |
docs/code_samples/cropper_v1.txt |
Uses the path alias for cropping. |
docs/code_samples/bank_statement_fr_v2_async.txt |
Uses the path alias for French bank statements. |
docs/code_samples/bank_account_details_v2.txt |
Uses the path alias for bank account details. |
Review effort: Balanced
ianardee
force-pushed
the
simpler-input-source
branch
from
November 5, 2026 23:57
869e76e to
ecb0928
Compare
ianardee
force-pushed
the
simpler-input-source
branch
from
November 5, 2026 23:59
ecb0928 to
9e89cb0
Compare
ianardee
force-pushed
the
simpler-input-source
branch
from
November 6, 2026 00:05
9e89cb0 to
202fd6d
Compare
ianardee
force-pushed
the
simpler-input-source
branch
from
November 6, 2026 00:07
202fd6d to
a403cc8
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Types of changes