DocumentCloud RubyGem

Rubygem for interacting with the DocumentCloud API.

Usage

gem install documentcloud or put in your gemfile and bundle install

To authenticate, initialize the configuration and pass in a block:

DocumentCloud.configure do |config|
  config.email    = 'my_email@somedomain.com'
  config.password = 'my_secret_password'
end

Search

All search results return Document objects that has methods and accessors for the information.

search = DocumentCloud.search('my query')

puts search.total # returns number of results

puts search.documents[0].pdf

Upload

You can upload a document by providing a ruby File object, or a string with the url to a file.

local_doc = DocumentCloud.upload(File.new('/my/file/path.pdf','rb'), 'My Document Title')

remote_doc = DocumentCloud.upload('http://somesite.com/file.pdf', 'Document Title')

Both return a document object which can then be used.

Document

Fetch a document by passing the document id.

doc = DocumentCloud.document('1234-document-id')

Update

Update a document by providing the file id, and any parameters you want to change.

updated_doc = DocumentCloud.update('1234-file-name', title: 'Changed Document Title')

Destroy

Destroy a document simply by passing the document id.

DocumentCloud.destroy('1234-file-name')

Information

DocumentCloud API info: http://www.documentcloud.org/help/api