A Ruby library for communicating with the GroupDocs.Storage Cloud API
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib
tests/GroupDocs/Storage
.gitignore
Gemfile
Gemfile.lock
LICENSE
README.md
groupdocs_storage_cloud.gemspec

README.md

GroupDocs.Storage Cloud SDK for Ruby

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

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 via RubyGem distribution (recommended). For more details, please visit our documentation website.

Prerequisites

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

Installation

Install groupdocs_storage_cloud via RubyGem

groupdocs_storage_cloud is available on RubyGem as the groupdocs_storage_cloud package. Run the following command:

gem install groupdocs_storage_cloud

Sample usage

The example below shows how your application has to initiate and download a file using groupdocs_storage_cloud package:

@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
@storage_api = StorageApi.new @api_client

$path = 'folder/FileTest.pdf'
$versionId = nil
$storage = 'StorageName'
$request = GetDownloadRequest.new($path, $versionId, $storage)
$result = @storage_api.get_download($request)

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

Dependencies

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

Contact Us

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