Skip to content

CHANGELOG.md

Latest commit

 

History

History
302 lines (204 loc) · 11 KB

CHANGELOG.md

File metadata and controls

302 lines (204 loc) · 11 KB
Raw

Changelog

Unreleased

Added

  • File search through client.files.search, including full-text, exact, metadata, tag, range, and image filters, sorting, highlights, include=appdata, and POST-aware pagination
  • Per-file tags through client.file_tags with list, replace, and atomic add/delete operations
  • Upload-time tags: support for direct, batch, URL, and multipart uploads
  • The tags attribute on file resources returned by the REST API

5.0.0 — 2026-05-17

v5 is stable. No API changes since 5.0.0.rc1. This cut removes the prerelease suffix, ports the relevant upstream release-readiness updates, and publishes the v5 line as stable.

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

Added

  • New client-first public API centered on Uploadcare::Client
  • Full endpoint-parity access through client.api.rest and client.api.upload
  • Canonical endpoint examples for the REST API and Upload API under api_examples/
  • Updated workflow-oriented examples under examples/
  • Context7 configuration tuned for the v5 client-first API and example layout
  • Multi-account configuration support through client-scoped Uploadcare::Configuration
  • Documented internal API surface through YARD for maintainers and integrators
  • Ruby 4.0 support in the test matrix

Changed

  • Replaced the older flatter API shape with a layered API:
    • convenience layer for application code
    • raw parity layer for exact endpoint access
  • Replaced dry-configurable with a plain Ruby configuration object
  • Replaced legacy HTTP and autoloading patterns with Faraday and Zeitwerk
  • Standardized resource and collection return types across the convenience layer
  • Reworked README, migration docs, and examples to match the current v5 API

Fixed

  • Upload IO normalization for both path-backed files and generic readable streams
  • Client/config scoping so resources do not silently fall back to the wrong account context
  • Video conversion store parameter normalization
  • Document conversion boolean option normalization to match video conversion behavior
  • REST request signing so the resolved Content-Type is the same value used for both signing and transmission
  • REST query signing to use the same parameter encoding style as request transmission
  • Multipart upload retry semantics so max_retries means retries after the initial attempt
  • Multipart upload part retries/timeouts now honor configuration (max_upload_retries, upload_timeout)
  • Multipart upload worker cancellation after first parallel upload error to avoid unnecessary in-flight uploads
  • Multipart upload start payload no longer sends unsupported part_size to /multipart/start/
  • Upload-from-URL polling now supports exponential backoff with a configurable cap
  • Example cleanup to avoid leaking temporary files and groups in the demo project
  • Standalone example loading and script execution
  • File metadata resource initialization now correctly assigns instance UUID
  • Upload API batch uploads now avoid filename collisions without mutating caller-visible filenames
  • REST authenticator now uses deterministic protocol-required digests (MD5 body digest and SHA1 HMAC digest)
  • Upload API debug logger now avoids emitting request/response headers and bodies by default
  • Thread-safe lazy memoization for client/accessor/API endpoint objects and CNAME cache internals
  • Test fixture generation now closes source and destination file handles correctly

Removed

  • Support for Ruby versions below 3.3
  • Legacy configuration and transport patterns that were no longer aligned with the v5 architecture

Risk & Rollout Notes

  • Ruby support baseline is now >= 3.3; verify application/runtime images before upgrading.
  • Recommended rollout: wire explicit Uploadcare::Client instances first, then migrate call sites incrementally.
  • Validate large-file uploads because multipart retry and cancellation behavior was hardened.
  • Validate custom REST signing integrations if your app reimplements signing outside this gem.
  • After deploy, monitor upload errors, multipart worker failures, and REST signing errors for 24-72 hours.
  • Keep rollback simple by pinning to the latest v4 release if your app depends on removed internal APIs.

4.5.0 — 2025-07-25

Added

  • CDN Subdomain Support: Added support for automatic subdomain generation to improve CDN performance and caching.
    • New CnameGenerator class for generating CNAME prefixes based on public key using SHA256 hashing
    • Configuration options:
      • use_subdomains - Enable automatic subdomain generation (default: false)
      • cdn_base_postfix - Base domain for subdomain generation (default: https://ucarecd.net/)
      • default_cdn_base - Original CDN base URL (default: https://ucarecdn.com/)
      • cdn_base - Dynamic CDN base selection based on subdomain configuration
    • New cdn_url method for File and Group entities to get CDN URLs using configured base
    • New file_cdn_urls method for Group entities to get CDN URLs of all files in a group without API requests
  • New Uploadcare::Exception::ConfigurationError for configuration-related errors
  • Ruby 3.4 support added to test matrix

4.4.3 — 2024-07-06

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.

4.4.2 — 2024-05-29

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.

4.4.1 — 2024-04-27

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 current public key or secret key config are empty when accessing any of the APIs.
  • AmakaiGenerator has been renamed to AkamaiGenerator to fix typo in class name.

4.4.0 — 2024-03-09

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.

4.3.6 — 2023-11-18

Fixed

  • Updated the version of the REST Api for conversion clients (closes #135).

4.3.5 — 2023-09-19

Changed

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

4.3.4 — 2023-05-16

Changed

  • Use auto as the default value for the store param.

4.3.3 — 2023-04-14

Changed

  • Use file_info request after a file upload if the secret key is not provided.

Added

  • Add a new file_info method to retreive file information without the secret key.

4.3.2 — 2023-03-28

Changed

  • Improved readme to look better at ruby-doc

4.3.1 — 2023-03-17

Changed

  • Update the gem description
  • Allow ENV keys to be configured after the gem load

4.3.0 — 2023-03-15

Add support of new ruby versions

Breaking Сhanges

  • Drop support of unmaintainable Ruby versions (2.4, 2.5, 2.6).
  • Replace unmaintainable api_struct with uploadcare-api_struct

Added

  • Add support for Ruby 3+ (3.0, 3.1, 3.2).

4.0.0 — 2022-12-29

This version supports latest Uploadcare REST API — v0.7, which introduces new file management features:

Breaking Сhanges

  • For Uploadcare::File#info
    • File information doesn't return image_info and video_info fields anymore
    • Removed rekognition_info in favor of appdata
    • Parameter add_fields was renamed to include
  • For Uploadcare::FileList#file_list
    • Removed the option of sorting the file list by file size
  • For Uploadcare::Group#store
    • Changed response format
  • For Uploadcare::File
    • Removed method copy in favor of local_copy and remote_copy methods

Changed

  • For Uploadcare::File#info
    • Field content_info that includes mime-type, image (dimensions, format, etc), video information (duration, format, bitrate, etc), audio information, etc
    • Field metadata that includes arbitrary metadata associated with a file
    • Field appdata that includes dictionary of application names and data associated with these applications

Added

  • Add Uploadcare API interface:
    • Uploadcare::FileMetadata
    • Uploadcare::Addons
  • Added an option to delete a Group
  • For Uploadcare::File add local_copy and remote_copy methods

3.3.2 - 2022-07-18

  • Fixes dry-configurable deprecation warnings

3.3.1 - 2022-04-19

  • Fixed README: Uploadcare::URLGenerators::AmakaiGenerator > Uploadcare::SignedUrlGenerators::AmakaiGenerator
  • Autoload generators constants

3.3.0 — 2022-04-08

  • Added Uploadcare::URLGenerators::AmakaiGenerator. Use custom domain and CDN provider to deliver files with authenticated URLs

3.2.0 — 2021-11-16

  • Added option signing_secret to the Uploadcare::Webhook
  • Added webhook signature verifier class Uploadcare::Param::WebhookSignatureVerifier

3.1.1 — 2021-10-13

  • Fixed Uploadcare::File#store
  • Fixed Uploadcare::File#delete

3.1.0 — 2021-09-21

  • Added documents and videos conversions
  • Added new attributes to the Entity class (variations, video_info, source, rekognition_info)
  • Added an option to add custom logic to large files uploading process

3.0.5 — 2021-04-15

  • Replace Travis-CI with Github Actions
  • Automate gem pushing

3.0.4-dev — 2020-03-19

  • Added better pagination methods for GroupList & FileList
  • Improved documentation and install instructions
  • Added CI

3.0.3-dev — 2020-03-13

  • Added better pagination and iterators for GroupList & FileList

3.0.2-dev — 2020-03-11

  • Expanded File and Group entities
  • Changed user agent syntax

3.0.1-dev — 2020-03-11

  • Added Upload/group functionality
  • Added user API
  • Added user agent
  • Isolated clients, entities and concerns
  • Expanded documentation

3.0.0-dev — 2020-02-18

Changed

  • Rewrote gem from scratch

Added

  • Client wrappers for REST API
  • Serializers for REST API
  • Client wrappers for Upload API
  • Serializers for Upload API
  • rdoc documentation