vuzitruby

= VuzitRuby - Vuzit Web Services library

== INTRODUCTION

This is a library that allows developers to directly access the Vuzit Web Service API through a simple Ruby script:

http://vuzit.com/developer/web_service_api

Below is a basic upload example:

require "vuzitruby"

Vuzit::Service.public_key = 'YOUR_PUBLIC_API_KEY' Vuzit::Service.private_key = 'YOUR_PRIVATE_API_KEY'

doc = Vuzit::Document.upload("c:/path/to/document.pdf")

puts "Document id: " + doc.id

To get started all you need to do is download the code, sign up for a free account (https://ssl.vuzit.com/signup) and replace the public and private keys with the keys from your account.

== SETUP

The client library is a RubyGem called vuzitruby. To install, type:

gem install vuzitruby

== GETTING STARTED

• Download the code - http://github.com/vuzit/vuzitruby/downloads
• Sign up for a free Vuzit account - https://ssl.vuzit.com/signup
• Code Examples - http://wiki.github.com/vuzit/vuzitruby/code_examples
• Vuzit API Reference - http://wiki.github.com/vuzit/vuzitruby/api_reference
• VuzitCL Command Line - http://wiki.github.com/vuzit/vuzitruby/vuzitcl

== EXAMPLES

Find Document Example - how to load a document:

require "vuzitruby"

Vuzit::Service.public_key = 'YOUR_PUBLIC_API_KEY' Vuzit::Service.private_key = 'YOUR_PRIVATE_API_KEY'

doc = Vuzit::Document.find("DOCUMENT_ID")

puts "Document id: " + doc.id puts "Document title: " + doc.title

Delete (destroy) Document Example:

require "vuzitruby"

Vuzit::Service.public_key = 'YOUR_PUBLIC_API_KEY' Vuzit::Service.private_key = 'YOUR_PRIVATE_API_KEY'

doc = Vuzit::Document.destroy("DOCUMENT_ID")

Upload and View with the JavaScript API Example for a Rails RHTML file:

<% require "vuzitruby" require 'cgi'

Vuzit::Service.public_key = 'YOUR_PUBLIC_API_KEY' Vuzit::Service.private_key = 'YOUR_PRIVATE_API_KEY'

doc = Vuzit::Document.upload("c:/path/to/document.pdf") timestamp = Time.now sig = Vuzit::Service.signature("show", doc.id, timestamp) %>

== LICENSE

Copyright (c) 2009-2010 Brent Matzelle, Vuzit LLC

Released under the MIT license:

http://www.opensource.org/licenses/mit-license.php

This means you can use it in proprietary products. See LICENSE file.