Installation

The package is available at rubygems.org and it can be installed via gem by executing the following command:

gem install groupdocs_annotation_cloud

Cloud Document Annotation Ruby SDK

GroupDocs.Annotation Cloud SDK for Ruby is a universal document annotator that supports almost all common business document and image file formats, including PDF, Microsoft Word, Excel, PowerPoint, TIFF, JPG and many more. API also works with all popular third-party cloud storage providers, including Amazon S3, Windows Azure, Box, Google Cloud and Dropbox. To facilitate the users to incorporate the services provided by the API in their Ruby applications, the SDK for Ruby has been developed, which is not only 100% tested but can be easily customized to suit your needs.

Document Annotations

Text Annotations

Add comments or explanations within the text.

Area Annotations

Highlight specific areas of a document for detailed notes.

Point Annotations

Mark specific points of interest in a document.

Arrow Annotations

Direct viewers’ attention to specific elements with arrow markers.

Strikeout/Underline Annotations

Highlight text by striking through or underlining it for easy referencing.

Markup Features

Highlighting

Mark important sections of the text with highlights.

Redaction

Completely hide or censor sensitive content within documents.

Watermarking

Protect document integrity by adding watermarks to indicate ownership or status.

Annotation Management

Edit Annotations

Modify or update existing annotations in documents.

Delete Annotations

Remove unnecessary or outdated annotations.

Export Annotations

Extract and export annotations to store separately or share with others.

Collaboration Features

Commenting

Enable multi-user collaboration with thread-based commenting features.

Version Control

Keep track of changes made to annotations with versioning tools.

Real-Time Updates

Implement real-time updates when multiple users are working on the same document.

Security Features

Access Control

Secure document annotations with user-based access control.

Role-Based Permissions

Assign different permission levels to users to protect sensitive annotations.

Encryption

Ensure that data is securely encrypted during document transfer and storage.

Advanced Features

Combine Annotations

Merge multiple annotations into one document.

Layered Annotations

Add and manipulate layered annotations to give flexibility in redacting and marking documents.

Custom Annotation Styles

Set custom colors, opacity, and size for annotations.

API Integration

Seamless integration with other systems and applications using REST APIs.

Scalable Infrastructure

Supports high-load environments with scalable architecture.

Supported Annotation Types and Features

Area Annotation

• Mark up an area within the document page with a rectangle.
  • Allows users to highlight a specific region on a document.
  • Box dimensions can be customized to fit the area of interest.
  • Supports replies to annotations for collaborative reviews.
  • The area annotation can include additional comments.

Distance Annotation

• Measures the distance between objects in a document.
  • Enables precise measurements within document content.
  • Coordinates and dimensions can be defined for exact measurements.
  • Useful for architectural and engineering documents where distance measures are critical.

Ellipse Annotation

• Draws elliptic annotations on a document page.
  • Enables users to highlight circular or elliptic areas.
  • Customizable radius, color, and opacity for clear visibility.
  • Supports multiple replies for added comments on the marked area.

Image Annotation

• Adds an image to a specific area of the document.
  • Inserts images within a document page for visual reference.
  • Supports positioning and resizing of images.
  • Useful for adding logos, stamps, or visual marks.

Link Annotation

• Adds a hyperlink to a document.
  • Links specific text or areas of the document to external URLs.
  • Provides support for web navigation or referencing additional resources.
  • Can be styled with different colors to differentiate from the text.

Multiple Annotation

• Allows adding multiple types of annotations simultaneously.
  • Supports adding a combination of annotations (e.g., text, images, shapes) at once.
  • Useful for reviewing documents where different annotation types are needed on the same page.
  • Multiple annotations can be grouped or treated separately.

Point Annotation

• Sticks comments to a specific point in the document.
  • Comments are associated with a specific point or location within the document.
  • Ideal for collaborative document reviews where pinpointing feedback is necessary.
  • Supports color and size adjustments for better visibility.

Polyline Annotation

• Draws connected lines to form a polyline in a document.
  • Used for drawing complex shapes or marking specific paths in a document.
  • Supports multiple points connected by straight lines.
  • Allows customization of line thickness, color, and opacity.

Resource Redaction Annotation

• Fills a black rectangle in a fixed position to hide sensitive information.
  • Effectively redacts confidential information from documents.
  • The black box can be sized and positioned over any sensitive data.
  • Commonly used for legal documents, financial statements, or personal identification numbers (PINs).

Squiggly Annotation

• Adds a wavy underline to mark text.
  • Highlights text with a squiggly underline for attention.
  • Ideal for marking spelling or grammatical errors.
  • Color and line style can be adjusted to differentiate from other annotations.

Supported Annotation Formats

Getting Started GroupDocs.Annotation Cloud Ruby SDK

Installation

A gem of groupdocs_annotation_cloud is available at rubygems.org. You can install it with:

gem install groupdocs_annotation_cloud

To add dependency to your app copy following into your Gemfile and run bundle install:

gem "groupdocs_annotation_cloud", "~> 23.12"

Please follow the installation procedure and then run the following code:

# Load the gem
require 'groupdocs_annotation_cloud'

# Get your app_sid and app_key at https://dashboard.groupdocs.cloud (free registration is required).
app_sid = "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX"
app_key = "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"

# Create instance of the API class
api = GroupDocsAnnotationCloud::InfoApi.from_keys(app_sid, app_key)

# Retrieve supported file-formats
response = api.get_supported_file_formats

# Print out supported file-formats
puts("Supported file-formats:")
response.formats.each do |format|
  puts("#{format.file_format} (#{format.extension})") 
end

GroupDocs.Annotation Cloud API Data Models

FilesUploadResult, Error, ErrorDetails, FilesList, StorageFile, StorageExist, ObjectExist, DiscUsage, FileVersions, FileVersion, AnnotationInfo, Rectangle, Point, AnnotationReplyInfo, FileInfo, AnnotationApiLink, Link, RemoveOptions, AnnotateOptions, FormatsResult, Format, DocumentInfo, PageInfo, ConsumptionResult, PageImages, PageImage, LinkElement, PreviewOptions

Ruby Code Sample 1: Add Text Annotation

This code sample demonstrates how to add a text annotation to a document using GroupDocs.Annotation Cloud SDK for Ruby. The text annotation is customizable in terms of position, font, and color.

# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby-samples
require 'groupdocs_annotation_cloud'
 
$app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
$api = GroupDocsAnnotationCloud::AnnotateApi.from_keys($app_sid, $app_key)
 
$a1 = GroupDocsAnnotationCloud::AnnotationInfo.new
$a1.annotation_position = GroupDocsAnnotationCloud::Point.new
$a1.annotation_position.x = 1
$a1.annotation_position.y = 1
$a1.box = GroupDocsAnnotationCloud::Rectangle.new
$a1.box.x = 100
$a1.box.y = 100
$a1.box.width = 200
$a1.box.height = 100
$a1.page_number = 0
$a1.font_color = 1201033
$a1.font_size = 12
$a1.opacity = 0.7
$a1.type = "TextField"   
$a1.text = "Text field text"
$a1.creator_name = "Anonym A."     
 
file_info = GroupDocsAnnotationCloud::FileInfo.new()
file_info.file_path = "annotationdocs\\one-page.docx"
 
options = GroupDocsAnnotationCloud::AnnotateOptions.new()
options.file_info = file_info
options.annotations = [$a1]
options.output_path = "Output/output.docx"
 
$request = GroupDocsAnnotationCloud::AnnotateRequest.new(options)
 
# Executing an API.
result = $api.annotate($request)
 
puts("AddTextFieldAnnotation: Text Field Annotation added: " + result.href)

Ruby Code Sample 2: Add Area Annotation

This code sample demonstrates how to add an area annotation (highlighting a section of a document).

# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby-samples
require 'groupdocs_annotation_cloud'
 
$app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
$api = GroupDocsAnnotationCloud::AnnotateApi.from_keys($app_sid, $app_key)
 
$a1 = GroupDocsAnnotationCloud::AnnotationInfo.new
$a1.annotation_position = GroupDocsAnnotationCloud::Point.new
$a1.annotation_position.x = 1
$a1.annotation_position.y = 1
$a1.box = GroupDocsAnnotationCloud::Rectangle.new
$a1.box.x = 100
$a1.box.y = 100
$a1.box.width = 200
$a1.box.height = 100
$a1.page_number = 0
$a1.pen_color = 1201033
$a1.pen_style = "Solid"
$a1.pen_width = 1
$a1.opacity = 0.7
$a1.type = "Area"
$a1.text = "This is area annotation"
$a1.creator_name = "Anonym A."     
 
file_info = GroupDocsAnnotationCloud::FileInfo.new()
file_info.file_path = "annotationdocs\\one-page.docx"
 
options = GroupDocsAnnotationCloud::AnnotateOptions.new()
options.file_info = file_info
options.annotations = [$a1]
options.output_path = "Output/output.docx"
 
$request = GroupDocsAnnotationCloud::AnnotateRequest.new(options)
 
# Executing an API.
result = $api.annotate($request)
 
puts("AddAreaAnnotation: Area Annotation added: " + result.href)

Ruby Code Sample 3: Remove Annotation

This code sample demonstrates how to remove an annotation from a document.

# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby-samples
require 'groupdocs_annotation_cloud'
 
$app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
$api = GroupDocsAnnotationCloud::AnnotateApi.from_keys($app_sid, $app_key)
 
file_info = GroupDocsAnnotationCloud::FileInfo.new()
file_info.file_path = "annotationdocs\\input.docx"
 
options = GroupDocsAnnotationCloud::RemoveOptions.new()
options.file_info = file_info
options.annotation_ids = [1, 2, 3]
options.output_path = "Output/output.docx"
 
$request = GroupDocsAnnotationCloud::RemoveAnnotationsRequest.new(options)
 
# Executing an API.
$response = $api.remove_annotations($request)
 
puts("RemoveAnnotations: Annotations deleted from document: " + $response.href)