uploadcare-ruby 5.0.0.rc1

uploadcare-ruby 5.0.0.rc1

This release candidate is the first public v5 cut from the rewritten codebase.

Please review MIGRATING_V5.md before upgrading from v4.x.

Highlights

• New client-first public API centered on Uploadcare::Client
• Full endpoint-parity access through client.api.rest and client.api.upload
• Multi-account support through client-scoped Uploadcare::Configuration
• Faraday + Zeitwerk modernization across the codebase
• Ruby 4.0 support in the CI matrix

Important Fixes Included In RC1

• REST signing uses deterministic protocol-required digests (MD5 and SHA1)
• REST query signing uses the same nested parameter encoding as request transmission
• Multipart upload retries/timeouts now honor configuration (max_upload_retries, upload_timeout)
• Multipart upload worker cancellation now stops remaining queued work after first worker error
• Upload-from-URL polling now supports exponential backoff with configurable cap
• Multipart start payload no longer sends unsupported part_size to /multipart/start/
• Upload API batch uploads avoid duplicate filename key collisions without mutating caller-visible filenames
• FileMetadata resource instance initialization correctly assigns uuid

Upgrade Notes

• Ruby support baseline is now >= 3.3.
• If you use multiple Uploadcare projects/accounts, prefer explicit Uploadcare::Client instances.
• Keep rollback simple by pinning to the latest v4 release if your app depends on removed internal APIs.

Full Changelog

See CHANGELOG.md.

Version 4.4.3

Added

• Multi page conversion parameter (save_in_group) added to DocumentConverter#convert options.

Fixed

• Fixed that signed URLs now work with "~" in the path. This also fixes signed URLs with grouped file URLs.

Version 4.4.2

Fixed

• Fixed the Uploadcare::File.remote_copy method which raised an ApiStruct::EntityError: {url} must be Hash. Now returns a string instead of a File entity instance.

Added

• Document Info API added in DocumentConverter.

Version 4.4.1

Added

• Added AWS Rekognition Moderation Add-On.
• Added an optional wildcard boolean parameter to the generate_url method of AkamaiGenerator.

Changed

• File attribute datetime_stored is deprecated and will warn on usage from File object properties.

Fixed

• Throw AuthError if the current public key or secret key config is empty when accessing any of the APIs.
• AmakaiGenerator has been renamed to AkamaiGenerator to fix a typo in the class name.

Version 4.4.0

Breaking

• Drop support of unmaintainable Ruby versions < 3.x.

Fixed

• Update locations where Dry::Monads structure has changed.
• Sign URL uploads if configured (#139).
• Start returning proper error message when raising RequestError in poll_upload_response, to hint to users what is going on. Fixes #141.
• When polling, raise if an error is returned (#142).
• Fix documentation about original file url on simple file upload.

Changed

• Support params in Rest client and in file info method, to allow passing custom params like "include=appdata" in Uploadcare::File.file calls. Closes #132.

Version 4.3.6

Updated the REST API version for conversion clients.

Version 4.3.5

Updated behavior to exclude sending blank values in the store param.

Version 4.3.4

Use auto as the default value for the store param.

Version 4.3.3

• Use file_info request after a file upload if the secret key is not provided.
• Add a new file_info method to retreive file information without the secret key.

Version 4.3.2

• Added links to gemspec
• Improved documentation options at ruby-doc