-
Notifications
You must be signed in to change notification settings - Fork 2
/
README
105 lines (70 loc) · 3.05 KB
/
README
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
= 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)
%>
<html>
<head>
<link href="http://vuzit.com/stylesheets/Vuzit-2.9.css" rel="Stylesheet" type="text/css" />
<script src="http://vuzit.com/javascripts/Vuzit-2.9.js" type="text/javascript"></script>
<script type="text/javascript">
// Called when the page is loaded.
function initialize() {
vuzit.Base.apiKeySet("<%= 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>
== 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.