uploadcare-ruby 5.0.0.rc1 → 5.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de585668a800a9c568b1c24ee4458a9347ca6d33b7ef89c395959682a0904b84
-  data.tar.gz: 866e8cbadbe47bae82d442d99a4dd5c4d5174fe7d18829b4d6a98658000975b0
+  metadata.gz: b00b913c8479a90ace5e4c44800bec64fe8ff94f2c04d50de2abfcdd627d44d3
+  data.tar.gz: 5b00dd30f553d1b300fe5a0013f3890de574ab48221a5735cb049ae5f62c62f8
 SHA512:
-  metadata.gz: 1f57d707ac7d812cf8a68c9328cc0ff29b81863d3f680a0be802f8c32423e9e369f78083edf035c195972abcff3a20fa2e6ea122b85f3de5a3cb496928b2831e
-  data.tar.gz: 0d0cca16356a961e43bfa8b04f21bbab6b166c0fdb57af4e392ba57a39ae2eb15236d3810d684e70d304562bb21c952ffba9e8a7256b277bfc449b431166a5a0
+  metadata.gz: 8c92a051097323fc96ebfe5cd798faf6d82cbf20cdceb683529f19d0311cd68fff3d5f2c53f20ebb6d9f14fcadada16e0c5ea892122dce2846e35a9fdfdb590e
+  data.tar.gz: 9720e878e6c6a29baf5ec7be621a46598f431da9ddd06b84ab75627eaa3256bd226ec768ce1d3c024c915c7937ee7a0fe29802ae1c6c3331e8c8415e71e222e6

data/CHANGELOG.md

@@ -1,8 +1,17 @@
 # Changelog
 
-## 5.0.0.rc1 — 2026-04-22
+## 5.0.1 — 2026-06-09
 
-This release candidate is the first public v5 cut from the rewritten codebase.
+### Fixed
+
+* Upload API requests now send the SDK-generated `User-Agent` instead of Faraday's default header.
+* Multipart upload part requests to presigned URLs now include the same SDK-generated `User-Agent`.
+
+## 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`](./MIGRATING_V5.md) before upgrading from v4.x.
 
@@ -12,6 +21,7 @@ Please review [`MIGRATING_V5.md`](./MIGRATING_V5.md) before upgrading from v4.x.
 * 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
@@ -46,14 +56,20 @@ Please review [`MIGRATING_V5.md`](./MIGRATING_V5.md) before upgrading from v4.x.
 * 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 rc1 rollout: wire explicit `Uploadcare::Client` instances first, then migrate call sites incrementally.
+* 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

data/context7.json

@@ -0,0 +1,74 @@
+{
+  "$schema": "https://context7.com/schema/context7.json",
+  "projectTitle": "Uploadcare Ruby",
+  "description": "Ruby API client for Uploadcare uploads, file management, conversions, webhooks, add-ons, and signed CDN URLs.",
+  "url": "https://context7.com/uploadcare/uploadcare-ruby",
+  "public_key": "pk_WoigIc3LrHKMjLxnI0IA2",
+  "branch": "main",
+  "folders": [
+    "lib",
+    "api_examples",
+    "examples",
+    "docs"
+  ],
+  "excludeFolders": [
+    ".github",
+    "bin",
+    "spec",
+    "vendor",
+    "tmp",
+    "coverage",
+    "pkg",
+    "doc",
+    "*archive*",
+    "*archived*",
+    "old",
+    "docs/old",
+    "*deprecated*",
+    "*legacy*",
+    "*previous*",
+    "*outdated*",
+    "*superseded*"
+  ],
+  "excludeFiles": [
+    "CHANGELOG.md",
+    "changelog.md",
+    "CHANGELOG.mdx",
+    "changelog.mdx",
+    "LICENSE",
+    "LICENSE.md",
+    "license.md",
+    "CODE_OF_CONDUCT.md",
+    "code_of_conduct.md",
+    "Gemfile",
+    "Rakefile",
+    "uploadcare-ruby.gemspec",
+    ".rspec",
+    ".rubocop.yml",
+    ".yardopts"
+  ],
+  "rules": [
+    "Install the gem as `uploadcare-ruby` and require it with `require \"uploadcare\"`.",
+    "Prefer explicit `Uploadcare::Client` instances for application code, especially when an app uses more than one Uploadcare project.",
+    "Configure credentials with `Uploadcare::Client.new(public_key: ..., secret_key: ...)`, `Uploadcare.configure`, or the UPLOADCARE_PUBLIC_KEY and UPLOADCARE_SECRET_KEY environment variables.",
+    "Never hardcode real Uploadcare API keys in examples or application code; use environment variables or an application secrets store.",
+    "Use `client.files`, `client.groups`, `client.uploads`, `client.project`, `client.webhooks`, `client.file_metadata`, `client.addons`, and `client.conversions` for normal application workflows.",
+    "Use `client.api.rest` and `client.api.upload` when exact REST API or Upload API endpoint parity is needed.",
+    "Use `client.uploads.upload` for automatic upload method selection and `client.uploads.multipart_upload` for explicit multipart uploads.",
+    "Use `MIGRATING_V5.md` when upgrading applications from uploadcare-ruby v4.x to v5."
+  ],
+  "previousVersions": [
+    {
+      "tag": "v4.4.3"
+    },
+    {
+      "tag": "v3.3.2"
+    },
+    {
+      "tag": "v2.1.2"
+    },
+    {
+      "tag": "v1.2.2"
+    }
+  ]
+}

data/docs/release-notes-5.0.0.md

@@ -0,0 +1,47 @@
+# uploadcare-ruby 5.0.0
+
+v5 is stable.
+No API changes since `5.0.0.rc1`.
+What to do now: run the full test suite in staging, validate large multipart uploads, deploy, and monitor for 24-72 hours.
+
+Please review [MIGRATING_V5.md](../MIGRATING_V5.md) before upgrading from v4.x.
+
+## Highlights
+
+- Use `Uploadcare::Client` as the primary API; avoid internal helpers.
+- Use `client.api.rest` and `client.api.upload` when you need exact endpoint behavior.
+- Create one client per project for multi-account setups.
+- Faraday and Zeitwerk reduce internal coupling; audit code that relied on old internals.
+- Follow the canonical API examples, workflow examples, migration docs, and Context7 rules for v5.
+- CI covers Ruby 3.3, 3.4, and 4.0.
+
+## Important Fixes Included
+
+- 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
+
+- Requirement: Ruby `>= 3.3`.
+- Do this first: run the full test suite against v5 in staging.
+- Example check: `bundle update uploadcare-ruby && bundle exec rspec`.
+- Multi-account apps: create one `Uploadcare::Client` per project.
+- Audit code for removed internal APIs; replace them with `client.files`, `client.groups`, `client.uploads`, or `client.api`.
+- Test large-file uploads because multipart retry and cancellation behavior changed.
+- Re-validate custom REST signing if your app reimplements signing outside this gem.
+- Rollback: pin to the latest v4 release and keep rollback trivial.
+
+## Risk Notes
+
+- v5 uses Faraday and Zeitwerk with simpler internal dependencies; audit any app code that relied on old internals.
+- Post-deploy: monitor upload errors, multipart worker failures, and REST signing errors for 24-72 hours.
+
+## Full Changelog
+
+See [CHANGELOG.md](../CHANGELOG.md).

data/lib/uploadcare/api/upload.rb

@@ -159,7 +159,7 @@ class Uploadcare::Api::Upload
   end
 
   def prepare_headers(req, _method, _uri, headers)
-    req.headers['User-Agent'] ||= Uploadcare::Internal::UserAgent.call(config: config)
+    req.headers['User-Agent'] = Uploadcare::Internal::UserAgent.call(config: config)
     req.headers.merge!(headers)
   end
 
@@ -243,6 +243,7 @@ class Uploadcare::Api::Upload
   def upload_part_request(conn:, request_uri:, data:, timeout:, open_timeout:)
     conn.put(request_uri) do |req|
       req.headers['Content-Type'] = 'application/octet-stream'
+      req.headers['User-Agent'] = Uploadcare::Internal::UserAgent.call(config: config)
       req.options.timeout = timeout if timeout
       req.options.open_timeout = open_timeout if open_timeout
       req.body = data

data/lib/uploadcare/internal/user_agent.rb

@@ -7,7 +7,7 @@
 #
 # @example
 #   Uploadcare::Internal::UserAgent.call(config: config)
-#   # => "UploadcareRuby/5.0.0.rc1/demopublickey (Ruby/3.3.0)"
+#   # => "UploadcareRuby/5.0.1/demopublickey (Ruby/3.3.0)"
 class Uploadcare::Internal::UserAgent
   # Build a User-Agent string.
   #

data/lib/uploadcare/version.rb

@@ -3,5 +3,5 @@
 # Root namespace for the Uploadcare Ruby SDK.
 module Uploadcare
   # Gem version.
-  VERSION = '5.0.0.rc1'
+  VERSION = '5.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: uploadcare-ruby
 version: !ruby/object:Gem::Version
-  version: 5.0.0.rc1
+  version: 5.0.1
 platform: ruby
 authors:
 - "@dmitrijivanchenko (Dmitrij Ivanchenko), @T0mbery (Andrey Aksenov)"
@@ -150,7 +150,8 @@ files:
 - api_examples/upload_api/put_multipart_part.rb
 - bin/console
 - bin/setup
-- docs/release-notes-5.0.0.rc1.md
+- context7.json
+- docs/release-notes-5.0.0.md
 - examples/README.md
 - examples/batch_upload.rb
 - examples/group_creation.rb

data/docs/release-notes-5.0.0.rc1.md

@@ -1,34 +0,0 @@
-# uploadcare-ruby 5.0.0.rc1
-
-This release candidate is the first public v5 cut from the rewritten codebase.
-
-Please review [MIGRATING_V5.md](../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](../CHANGELOG.md).