search

uploadcare / uploadcare-ruby

Ruby API client that handles uploads and further operations with files by wrapping Uploadcare Upload and REST APIs.
https://uploadcare.com
MIT License
39 stars 28 forks source link

Prepare for 4.4.1 release #166

Closed vipulnsward closed 2 months ago

vipulnsward commented 2 months ago

Description

Many things have been pushed since the last release and other libraries depend on some of these changes.

Changelog-

Added

Changed

Fixed

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

Version 4.4.1 introduces a minor update to the codebase, featuring a new optional boolean parameter in the generate_url method of the AkamaiGenerator and a correction in the class name from AmakaiGenerator to AkamaiGenerator. Additionally, the version number in the Uploadcare module has been updated to reflect these changes.

Changes

File Path Change Summary
CHANGELOG.md Added an optional boolean parameter to generate_url in AkamaiGenerator; Renamed AmakaiGenerator to AkamaiGenerator.
lib/.../version.rb Updated version from 4.4.0 to 4.4.1 in Uploadcare.

Poem

🌟 A Tiny Tale of Code 🌟

In the land of bits and bytes,
A typo was corrected, oh so right!
A method tweaked, a version new,
Hop, hop, hurray, to version 4.4.1 we flew!
🐰💻✨

Recent Review Details **Configuration used: CodeRabbit UI** **Review profile: CHILL**
Commits Files that changed from the base of the PR and between 81182de0bad4ff52509bbabd54308712f73c825b and 0d7600146630b81032c385e77ac8994c5a664049.
Files selected for processing (2) * CHANGELOG.md (1 hunks) * lib/uploadcare/ruby/version.rb (1 hunks)
Files skipped from review due to trivial changes (1) * lib/uploadcare/ruby/version.rb
Additional Context Used
LanguageTool (42)
CHANGELOG.md (42)
Near line 5: Possible typo: you repeated a word Context: ...# Changelog ## 4.4.1 — 2024-04-27 ### Added * Added `AWS Rekognition Moderation` Add-On. * ... --- Near line 6: Possible spelling mistake found. Context: ...# 4.4.1 — 2024-04-27 ### Added * Added `AWS Rekognition Moderation` Add-On. * Added an optional... --- Near line 7: Possible spelling mistake found. Context: ...nal `wildcard` boolean parameter to the `generate_url` method of `AkamaiGenerator`. ### Chan... --- Near line 7: Possible spelling mistake found. Context: ...rameter to the `generate_url` method of `AkamaiGenerator`. ### Changed * File attribute `dateti... --- Near line 10: Only proper nouns start with an uppercase character (there are exceptions for headlines). Context: ...od of `AkamaiGenerator`. ### Changed * File attribute `datetime_stored` is deprecat... --- Near line 10: Possible spelling mistake found. Context: ...nerator`. ### Changed * File attribute `datetime_stored` is deprecated and will warn on ... --- Near line 14: Possible spelling mistake found. Context: ... object properties. ### Fixed * Throw `AuthError` if current public key or secret key co... --- Near line 15: This sentence does not start with an uppercase letter. Context: ...ng any of the APIs. * `AmakaiGenerator` has been renamed to `AkamaiGenerator` to fi... --- Near line 15: Possible spelling mistake found. Context: ...* `AmakaiGenerator` has been renamed to `AkamaiGenerator` to fix typo in class name. ## 4.4.0 —... --- Near line 27: Possible spelling mistake found. Context: ...rning proper error message when raising RequestError in poll_upload_response, to hint to use... --- Near line 29: Possible spelling mistake found. Context: ...* Fix documentation about original file url on simple file upload. ### Changed * S... --- Near line 32: Possible spelling mistake found. Context: ...ple file upload. ### Changed * Support params in Rest client and in file info method,... --- Near line 32: Possible spelling mistake found. Context: ...le info method, to allow passing custom params like "include=appdata" in `Uploadcare::... --- Near line 32: Possible spelling mistake found. Context: ...low passing custom params like "include=appdata" in `Uploadcare::File.file` calls. Clos... --- Near line 32: Possible spelling mistake found. Context: ...custom params like "include=appdata" in `Uploadcare::File.file` calls. Closes #132. ## 4.... --- Near line 39: Possible spelling mistake found. Context: ...ixed * Updated the version of the REST Api for conversion clients (closes #135). ... --- Near line 45: Possible spelling mistake found. Context: ...ude sending blank values in the `store` param. ## 4.3.4 — 2023-05-16 ### Changed ... --- Near line 52: Possible spelling mistake found. Context: ...o` as the default value for the `store` param. ## 4.3.3 — 2023-04-14 ### Changed ... --- Near line 63: Possible spelling mistake found. Context: ...dded * Add a new `file_info` method to retreive file information without the secret key... --- Near line 69: Possible spelling mistake found. Context: ...2 — 2023-03-28 ### Changed * Improved readme to look better at ruby-doc ## 4.3.1 — ... --- Near line 82: Possible spelling mistake found. Context: ...port of new ruby versions ### Breaking Сhanges - Drop support of unmaintainable Ruby ... --- Near line 85: Possible spelling mistake found. Context: ....4, 2.5, 2.6). - Replace unmaintainable `api_struct` with `uploadcare-api_struct` #... --- Near line 93: Possible spelling mistake found. Context: ...022-12-29 This version supports latest Uploadcare REST API — [v0.7](https://uploadcare.co... --- Near line 100: Possible spelling mistake found. Context: ...ence/object-recognition/) ### Breaking Сhanges - For `Uploadcare::File#info` - File... --- Near line 104: Possible spelling mistake found. Context: ...`video_info` fields anymore - Removed `rekognition_info` in favor of `appdata` - Paramet... --- Near line 116: In American English, abbreviations like “etc.” require a period. Context: ...s mime-type, image (dimensions, format, etc), video information (duration, format, ... --- Near line 116: In American English, abbreviations like “etc.” require a period. Context: ...information (duration, format, bitrate, etc), audio information, etc - Field `met... --- Near line 116: In American English, abbreviations like “etc.” require a period. Context: ...rmat, bitrate, etc), audio information, etc - Field `metadata` that includes arbi... --- Near line 118: Possible spelling mistake found. Context: ...tadata associated with a file - Field `appdata` that includes dictionary of applicatio... --- Near line 122: Possible spelling mistake found. Context: ...th these applications ### Added - Add Uploadcare API interface: - `Uploadcare::FileM... --- Near line 122: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “API”. Context: ...plications ### Added - Add Uploadcare API interface: - `Uploadcare::FileMetadata` -... --- Near line 126: Possible spelling mistake found. Context: ...Added an option to delete a Group - For `Uploadcare::File` add `local_copy` and `remote_cop... --- Near line 134: Possible spelling mistake found. Context: ... ## 3.3.1 - 2022-04-19 - Fixed README: `Uploadcare::URLGenerators::AmakaiGenerator` > `Upl... --- Near line 139: Possible spelling mistake found. Context: ...nstants ## 3.3.0 — 2022-04-08 - Added `Uploadcare::URLGenerators::AmakaiGenerator`. Use c... --- Near line 148: Possible typo: you repeated a word Context: ...tureVerifier` ## 3.1.1 — 2021-10-13 - Fixed `Uploadcare::File#store` - Fixed `Uploadcare::File#delete` ## 3.1.0 — 2... --- Near line 154: Possible spelling mistake found. Context: ... (`variations`, `video_info`, `source`, `rekognition_info`) - Added an option to add custom ... --- Near line 159: The official name of this software platform is spelled with a capital “H”. Context: ... — 2021-04-15 - Replace Travis-CI with Github Actions - Automate gem pushing ## 3.0.... --- Near line 164: Possible spelling mistake found. Context: ... - Added better pagination methods for `GroupList` & `FileList` - Improved documentation ... --- Near line 170: Possible spelling mistake found. Context: ...ded better pagination and iterators for `GroupList` & `FileList` ## 3.0.2-dev — 2020-03-1... --- Near line 194: Possible spelling mistake found. Context: ...Added - Client wrappers for REST API - Serializers for REST API - Client wrappers for Uplo... --- Near line 196: Possible spelling mistake found. Context: ... API - Client wrappers for Upload API - Serializers for Upload API - rdoc documentation --- Near line 197: Possible spelling mistake found. Context: ...load API - Serializers for Upload API - rdoc documentation
Additional comments not posted (5)
CHANGELOG.md (5)
`3-3`: Ensure the release date is accurate and matches the planned release schedule. --- `5-7`: Confirm the implementation of the `AWS Rekognition Moderation` Add-On and the `wildcard` parameter in the `generate_url` method as described. --- `10-10`: Verify that the deprecation of the `datetime_stored` attribute is handled correctly in the code, including the generation of a warning. --- `12-12`: Ensure that the `AuthError` is thrown as described when the public key or secret key configuration is empty. --- `15-15`: Confirm the renaming of `AmakaiGenerator` to `AkamaiGenerator` across all occurrences in the codebase to maintain consistency.
--- Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?
Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger a review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.