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

Add conversion document info API #169

Closed vipulnsward closed 2 months ago

vipulnsward commented 2 months ago

Description

Checklist

Summary by CodeRabbit

coderabbitai[bot] commented 2 months ago

Walkthrough

The recent changes bring enhancements to document handling with a new Document Info API in the DocumentConverter. README.md updates focus on improving AWS Rekognition documentation and adding examples for using Uploadcare's AkamaiGenerator, spanning multiple files with method additions and test enhancements.

Changes

File Path Change Summary
CHANGELOG.md, lib/uploadcare/client/conversion/document_conversion_client.rb, lib/uploadcare/entity/conversion/base_converter.rb Added Document Info API for improved document retrieval.
README.md Corrected typos, added code snippets for document format identification, and included examples for authenticated URL generation.
lib/uploadcare/client/conversion/document_conversion_client.rb, lib/uploadcare/entity/conversion/base_converter.rb, spec/fixtures/vcr_cassettes/document_convert_info.yml Added methods and tests for the new Document Info API functionality.

🐰✨ A hop, a skip, a code deploy,
New features in the doc, oh boy!
From typos fixed to info anew,
Here's to updates, fresh and true!
📄🔍💾


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.