VuzitRuby 2.1.1

VuzitRuby A library that allows developers to directly access the Vuzit Web Service API.

VuzitRuby is is a library that lets developers access the Vuzit Web

Service API through a Ruby script.

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


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.get_signature("show", doc.id, timestamp)
  % >
  < html >
    < head >
      < link href="http://vuzit.com/stylesheets/Vuzit-2.6.css" rel="Stylesheet" type="text/css" / >
      < script src="http://vuzit.com/javascripts/Vuzit-2.6.js" type="text/javascript" >< /script >
      < script type="text/javascript" >
        // Called when the page is loaded. 
        function initialize()  {
          vuzit.Base.PublicKeySet("< %= Vuzit::Service.public_key % >");
          var options = {signature: '< %= CGI.escape(sig) % >',
                         timestamp: '< %= timestamp %>', ssl: true}
          var viewer = vuzit.Viewer.fromId("< %= doc.id % >", options);
         
          viewer.display(document.getElementById("vuzit_viewer"), { zoom: 1 });
        }
      < /script >
    < /head >
    < body onload="initialize()" >
      < div id="vuzit_viewer" style="width: 650px; height: 500px;" >< /div >
    < /body >
  < /html >


Product's homepage

Requirements:



· Ruby

Download VuzitRuby 2.1.1 Free
Tags: Ruby library   , Vuzit access   , Ruby   , library   , Vuzit   ,
, document, vuzitruby, vuzitservicepublic_key, require, = 'your_public_api_key' vuzitserviceprivate_key, 'your_public_api_key' vuzitserviceprivate_key, timestamp, vuzitservicepublic_key =, = 'your_public_api_key', docid, example, 'your_public_api_key', 'your_private_api_key', doc, vuzitserviceprivate_key, type=, puts, options, var, called, keys, initialize, document_id, vuzit_viewer