uploadcare / uploadcare-rails

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

For `Uploadcare::ConversionApi` added `get_document_conversion_formats_info` method to get the possible document conversion formats. #145

Closed vipulnsward closed 5 months ago

vipulnsward commented 5 months ago

Description

For Uploadcare::ConversionApi added get_document_conversion_formats_info method to get the possible document conversion formats.

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 5 months ago

Walkthrough

The recent updates introduce a new method get_document_conversion_formats_info to the Uploadcare::ConversionApi class, allowing users to retrieve document conversion formats from the Uploadcare API. Additionally, a new test case and VCR cassette are added to support this method. The dependency version of uploadcare-ruby is updated to 4.4.2, and RuboCop configuration is adjusted to exclude spec files from the Metrics/ModuleLength rule.

Changes

Files Change Summary
CHANGELOG.md Added a summary of the new get_document_conversion_formats_info method to the "Unreleased" section.
lib/uploadcare/rails/api/rest/conversion_api.rb Added the get_document_conversion_formats_info method to retrieve document conversion formats.
spec/fixtures/vcr_cassettes/conversion_api_get_document_formats.yml Captured HTTP interaction for retrieving document conversion formats.
spec/uploadcare/rails/api/rest/conversion_api_spec.rb Added test cases for the get_document_conversion_formats_info method.
uploadcare-rails.gemspec Updated uploadcare-ruby dependency version from 4.4.1 to 4.4.2.
.rubocop.yml Excluded files under the spec directory from the Metrics/ModuleLength rule.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant UploadcareRails
    participant UploadcareAPI

    User->>UploadcareRails: Call get_document_conversion_formats_info
    UploadcareRails->>UploadcareAPI: GET /conversion/formats/document/
    UploadcareAPI-->>UploadcareRails: Return supported formats (e.g., jpg, avif, bmp, gif)
    UploadcareRails-->>User: Return supported formats

Poem

In the code where data flows, New formats bloom like a rose. 🌹 From API to test and spec, Conversion magic we now check. With RuboCop rules set aside, Our gem's version takes a ride. Uploadcare's path is clear and bright, Document formats take flight! 🚀


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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@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.