GroupDocs

Ruby SDK for GroupDocs REST API.

Installation

GroupDocs requires Ruby 1.9. Ruby 1.8 is not supported!

Install as usually

gem install groupdocs

Installing from source

gem install bundler # unless it's already installed
git clone git@github.com:groupdocs/groupdocs-ruby.git
cd groupdocs-ruby/
git checkout master
bundle install --path vendor/bundle
bundle exec rake install

Usage

All "bang" methods (ending with exclamation sign) imply interaction with API server.

Other methods (with expect to some methods - see documentation) do not operate with API Server

Configuration

First of all you need to configure your access to API server.

require 'groupdocs'

GroupDocs.configure do |groupdocs|
  groupdocs.client_id = 'your_client_id'
  groupdocs.private_key = 'your_private_key'
  # optionally specify API server and version
  groupdocs.api_server = 'https://dev-api.groupdocs.com'
  groupdocs.api_version = '2.0'
end

GroupDocs::Storage::Folder.create!('/folder')
#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="folder", @url="http://groupdocs.com">

You can also pass access credentials to particular requests

GroupDocs::Storage::Folder.create!('/folder', client_id: 'your_client_id', private_key: 'your_private_key')
#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="folder", @url="http://groupdocs.com">

GroupDocs::Document.find!(:name, 'CV.doc', client_id: 'your_client_id', private_key: 'your_private_key')
#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="Folder1", @url="http://groupdocs.com">

Entities

All entities can be initialized in several ways.

• Object is created, attributes are set later.

folder = GroupDocs::Storage::Folder.new
folder.name = 'Folder'
folder.inspect
#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder">

• Hash of attributes are passed to object constructor.

GroupDocs::Storage::Folder.new(name: 'Folder')
#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder">

• Block is passed to object constructor.

GroupDocs::Storage::Folder.new do |folder|
  folder.name = 'Folder'
end
#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @name="Folder">

Find entities

Some entities support #all!, #find! and #find_all! methods. You can pass any attribute that object responds to and its value to find with.

• List all files

GroupDocs::Storage::File.all!
#=> [#<GroupDocs::Storage::File:0x0000000171f432 @id=123, @guid="uhfsa9dry29rhfodn", @name="resume.pdf", @url="http://groupdocs.com">, #<GroupDocs::Storage::File:0x0000000171f498 @id=456, @guid="soif97sr9u24bfosd9", @name="CV.doc", @url="http://groupdocs.com">]

• Find folder with name Folder1

GroupDocs::Storage::Folder.find!(:name, 'Folder1')
#=> #<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="Folder1", @url="http://groupdocs.com">

• Find all folders which name starts with Folder

GroupDocs::Storage::Folder.find_all!(:name, /^Folder/)
#=> [#<GroupDocs::Storage::Folder:0x0000000171f432 @id=1, @name="Folder1", @url="http://groupdocs.com">, #<GroupDocs::Storage::Folder:0x0000000171f467 @id=2, @name="Folder2", @url="http://groupdocs.com">]

Annotation API

Read more about examples of using Annotation API on wiki.

Assembly API

Read more about examples of using Assembly API on wiki.

Comparison API

Read more about examples of using Comparison API on wiki.

Document API

Read more about examples of using Document API on wiki.

Job API

Read more about examples of using Job API on wiki.

Signature API

Not yet implemented.

Storage API

Read more about examples of using Storage API on wiki.

Copyright

Copyright (c) 2012 Aspose Inc.