Ruby library for communicating with the Aspose.Words Cloud API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
Settings
TestData
docker
lib
scripts
test/reports
tests
.gitignore
.rubocop.yml
Dockerfile
Gemfile
Jenkinsfile
JenkinsfileRelease
README.md
Rakefile
aspose_words_cloud.gemspec
test.sh

README.md

This repository contains Aspose.Words Cloud SDK for Ruby source code. This SDK allows you to work with Aspose.Words Cloud REST APIs in your Ruby applications quickly and easily, with zero initial cost.

Key Features

  • Conversion between various document-related formats (20+ formats supported), including PDF<->Word conversion
  • Mail merge and reports generation
  • Splitting Word documents
  • Accessing Word document metadata and statistics
  • Find and replace
  • Watermarks and protection
  • Full read & write access to Document Object Model, including sections, paragraphs, text, images, tables, headers/footers and many others

See API Reference for full API specification.

How to use the SDK?

The complete source code is available in this repository folder. You can either directly use it in your project via source code or get RubyGem (recommended). For more details, please visit our documentation website.

Prerequisites

To use Aspose Words for Cloud Ruby SDK you need to register an account with Aspose Cloud and lookup/create App Key and SID at Cloud Dashboard. There is free quota available. For more details, see Aspose Cloud Pricing.

Installation

To install this package do the following: update your Gemfile

gem 'aspose_words_cloud', '~> 18.7'

or install directly

gem install aspose_words_cloud

Sample usage

@config = Configuration.new
@config.api_key['api_key'] = '' # Put your's api_key and app_sid
@config.api_key['app_sid'] = ''
@api_client = ApiClient.new @config
@words_api = WordsApi.new @api_client
AsposeApp.app_key_and_sid(@config.api_key['api_key'], @config.api_key['app_sid'])
@storage_api = StorageApi.new
request = DeleteDocumentWatermarkRequest.new remote_name, remote_test_folder + test_folder
result = @words_api.delete_document_watermark request

Tests contain various examples of using the SDK. Please put your credentials into Configuration.

Dependencies

  • Ruby 2.3 or later
  • referenced packages (see here for more details)

Comparison with Old generation SDK

New SDK has the following advantages over the previous version:

  • SDK is fully in sync with the API, all missing methods are added
  • Classes, methods and properties have comments and are IDE-friendly
  • Better security
  • Usage of Request/Response classes to represent long lists of parameters. This allows for cleaner code and easier backwards-compatibility going forward

New SDK is not backwards compatible with previous generation because of the last item. It should be straightforward to convert your code to using Request/Response objects, if you need any help on migration please ask at Free Support Forums.

Contact Us

Your feedback is very important to us. Please feel free to contact us using our Support Forums.