Add conversion document info API

[vipulnsward]

Description

• Add conversion document info API
• While working on Prepare api-refs x-codeExamples for Ruby #143 I saw that this one is missing, so adding before that

Checklist

• Tests (if applicable)
• Documentation (if applicable)
• Changelog stub (or use conventional commit messages)

Summary by CodeRabbit

• New Features

  • Introduced a new Document Info API to retrieve detailed information about documents.

• Documentation

  • Updated README.md with corrected typos and expanded examples for better clarity and usability.
  • Added a code snippet for determining document format and conversion formats.
  • Provided examples for generating authenticated URLs using Uploadcare::SignedUrlGenerators::AkamaiGenerator.

[coderabbitai]

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:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 4

Out of diff range and nitpick comments (2)

lib/uploadcare/client/conversion/document_conversion_client.rb (1)

25-27: Consider adding documentation for the document_info method to explain its purpose and usage.

lib/uploadcare/entity/conversion/base_converter.rb (1)

26-28: Consider adding documentation for the info method to explain its purpose and usage.

[coderabbitai]

Correct the comment to clarify the purpose of the AWS Rekognition Add-On.

- # Execute AWS Rekognition Add-On for a given target to detect labels in an image.
+ # Execute AWS Rekognition Add-On to detect labels in an image for a given file UUID.

---

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	# Execute AWS Rekognition Add-On for a given target to detect labels in an image.
	# Execute AWS Rekognition Add-On to detect labels in an image for a given file UUID.

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 9670955 and 26315a4.

Files selected for processing (1)

• lib/uploadcare/entity/conversion/base_converter.rb (1 hunks)

Files skipped from review as they are similar to previous changes (1)

• lib/uploadcare/entity/conversion/base_converter.rb

[coderabbitai]

Actionable comments posted: 0

Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 26315a4 and 134c6e1.

Files selected for processing (1)

• CHANGELOG.md (1 hunks)

Additional Context Used

LanguageTool (6)

CHANGELOG.md (6)

Near line 9: Possible typo: you repeated a word
Context: ...tConverter. ## 4.4.1 — 2024-04-27 ### Added * Added AWS Rekognition Moderation` Add-On. * ...

---

Near line 120: In American English, abbreviations like “etc.” require a period.
Context: ...s mime-type, image (dimensions, format, etc), video information (duration, format, ...

---

Near line 120: In American English, abbreviations like “etc.” require a period.
Context: ...information (duration, format, bitrate, etc), audio information, etc - Field `met...

---

Near line 120: In American English, abbreviations like “etc.” require a period.
Context: ...rmat, bitrate, etc), audio information, etc - Field metadata that includes arbi...

---

Near line 126: This phrase is redundant (‘I’ stands for ‘interface’). Use simply “API”.
Context: ...plications ### Added - Add Uploadcare API interface: - Uploadcare::FileMetadata -...

---

Near line 152: Possible typo: you repeated a word
Context: ...tureVerifier ## 3.1.1 — 2021-10-13 - FixedUploadcare::File#store- FixedUploadcare::File#delete` ## 3.1.0 — 2...

Additional comments not posted (1)

CHANGELOG.md (1)

6-6: Consider revising the changelog entry to avoid repetition of the word "Added".

- * Added `Document Info` API in `DocumentConverter`.
+ * `Document Info` API added in `DocumentConverter`.