RubyGems - groupdocs - Versions diffs - 1.5.7 → 1.5.8 - Mend

groupdocs 1.5.7 → 1.5.8

Files changed (177) hide show

data/CHANGELOG.md +51 -0
data/examples/api-samples/Gemfile +1 -1
data/examples/api-samples/Gemfile.lock +43 -0
data/examples/api-samples/public/docs/{sample2.html → sample01.html} +39 -19
data/examples/api-samples/public/docs/{sample3.html → sample02.html} +28 -22
data/examples/api-samples/public/docs/sample03.html +285 -0
data/examples/api-samples/public/docs/{sample4.html → sample04.html} +30 -36
data/examples/api-samples/public/docs/{sample5.html → sample05.html} +68 -31
data/examples/api-samples/public/docs/sample06.html +299 -0
data/examples/api-samples/public/docs/{sample7.html → sample07.html} +53 -18
data/examples/api-samples/public/docs/{sample8.html → sample08.html} +64 -41
data/examples/api-samples/public/docs/sample09.html +260 -0
data/examples/api-samples/public/docs/sample10.html +67 -28
data/examples/api-samples/public/docs/sample11.html +171 -55
data/examples/api-samples/public/docs/sample12.html +53 -17
data/examples/api-samples/public/docs/sample13.html +52 -16
data/examples/api-samples/public/docs/sample14.html +51 -8
data/examples/api-samples/public/docs/sample15.html +46 -10
data/examples/api-samples/public/docs/sample16.html +81 -7
data/examples/api-samples/public/docs/sample17.html +103 -15
data/examples/api-samples/public/docs/sample18.html +117 -41
data/examples/api-samples/public/docs/sample19.html +410 -36
data/examples/api-samples/public/docs/sample20.html +46 -10
data/examples/api-samples/public/docs/sample21.html +504 -45
data/examples/api-samples/public/docs/sample22.html +166 -28
data/examples/api-samples/public/docs/sample23.html +61 -25
data/examples/api-samples/public/docs/sample24.html +100 -12
data/examples/api-samples/public/docs/sample25.html +123 -49
data/examples/api-samples/public/docs/sample26.html +41 -8
data/examples/api-samples/public/docs/sample27.html +125 -50
data/examples/api-samples/public/docs/sample28.html +27 -9
data/examples/api-samples/public/docs/sample29.html +10 -10
data/examples/api-samples/public/docs/sample30.html +70 -14
data/examples/api-samples/public/docs/sample31.html +108 -67
data/examples/api-samples/public/docs/sample32.html +71 -99
data/examples/api-samples/public/docs/sample33.html +107 -32
data/examples/api-samples/public/docs/{sample1.html → sample34.html} +58 -18
data/examples/api-samples/public/docs/sample35.html +666 -0
data/examples/api-samples/public/docs/{sample6.html → sample36.html} +56 -37
data/examples/api-samples/public/docs/sample37.html +815 -0
data/examples/api-samples/public/docs/sample38.html +508 -0
data/examples/api-samples/public/docs/sample39.html +921 -0
data/examples/api-samples/public/docs/sample40.html +510 -0
data/examples/api-samples/public/docs/sample41.html +452 -0
data/examples/api-samples/public/docs/sample42.html +311 -0
data/examples/api-samples/public/templates/test_all_fields2.pdf +0 -0
data/examples/api-samples/samples/sample01.rb +37 -0
data/examples/api-samples/samples/sample02.rb +41 -0
data/examples/api-samples/samples/sample03.rb +73 -0
data/examples/api-samples/samples/sample04.rb +47 -0
data/examples/api-samples/samples/{sample5.rb → sample05.rb} +26 -14
data/examples/api-samples/samples/sample06.rb +80 -0
data/examples/api-samples/samples/sample07.rb +52 -0
data/examples/api-samples/samples/sample08.rb +69 -0
data/examples/api-samples/samples/sample09.rb +83 -0
data/examples/api-samples/samples/sample10.rb +29 -15
data/examples/api-samples/samples/sample11.rb +89 -37
data/examples/api-samples/samples/sample12.rb +22 -11
data/examples/api-samples/samples/sample13.rb +22 -10
data/examples/api-samples/samples/sample14.rb +23 -5
data/examples/api-samples/samples/sample15.rb +18 -7
data/examples/api-samples/samples/sample16.rb +28 -4
data/examples/api-samples/samples/sample17.rb +31 -5
data/examples/api-samples/samples/sample18.rb +36 -8
data/examples/api-samples/samples/sample19.rb +138 -18
data/examples/api-samples/samples/sample20.rb +14 -3
data/examples/api-samples/samples/sample21.rb +162 -23
data/examples/api-samples/samples/sample22.rb +73 -22
data/examples/api-samples/samples/sample23.rb +17 -6
data/examples/api-samples/samples/sample24.rb +34 -7
data/examples/api-samples/samples/sample25.rb +37 -12
data/examples/api-samples/samples/sample26.rb +12 -5
data/examples/api-samples/samples/sample27.rb +38 -12
data/examples/api-samples/samples/sample28.rb +25 -6
data/examples/api-samples/samples/sample29.rb +12 -12
data/examples/api-samples/samples/sample30.rb +27 -15
data/examples/api-samples/samples/sample31.rb +44 -33
data/examples/api-samples/samples/sample32.rb +43 -41
data/examples/api-samples/samples/sample33.rb +42 -14
data/examples/api-samples/samples/sample34.rb +40 -0
data/examples/api-samples/samples/sample35.rb +224 -0
data/examples/api-samples/samples/sample36.rb +58 -0
data/examples/api-samples/samples/sample37.rb +229 -0
data/examples/api-samples/samples/sample38.rb +128 -0
data/examples/api-samples/samples/sample39.rb +252 -0
data/examples/api-samples/samples/sample40.rb +164 -0
data/examples/api-samples/samples/sample41.rb +118 -0
data/examples/api-samples/samples/sample42.rb +97 -0
data/examples/api-samples/views/_others_samples.haml +25 -11
data/examples/api-samples/views/index.haml +23 -11
data/examples/api-samples/views/popup.haml +32 -0
data/examples/api-samples/views/{sample1.haml → sample01.haml} +12 -7
data/examples/api-samples/views/{sample2.haml → sample02.haml} +20 -15
data/examples/api-samples/views/sample03.haml +83 -0
data/examples/api-samples/views/sample04.haml +49 -0
data/examples/api-samples/views/{sample5.haml → sample05.haml} +19 -14
data/examples/api-samples/views/sample06.haml +53 -0
data/examples/api-samples/views/sample07.haml +47 -0
data/examples/api-samples/views/{sample8.haml → sample08.haml} +17 -12
data/examples/api-samples/views/{sample9.haml → sample09.haml} +19 -4
data/examples/api-samples/views/sample10.haml +18 -13
data/examples/api-samples/views/sample11.haml +48 -19
data/examples/api-samples/views/sample12.haml +26 -21
data/examples/api-samples/views/sample13.haml +18 -12
data/examples/api-samples/views/sample14.haml +21 -15
data/examples/api-samples/views/sample15.haml +16 -9
data/examples/api-samples/views/sample16.haml +18 -5
data/examples/api-samples/views/sample17.haml +14 -9
data/examples/api-samples/views/sample18.haml +13 -7
data/examples/api-samples/views/sample19.haml +37 -8
data/examples/api-samples/views/sample20.haml +13 -8
data/examples/api-samples/views/sample21.haml +71 -13
data/examples/api-samples/views/sample22.haml +53 -16
data/examples/api-samples/views/sample23.haml +9 -4
data/examples/api-samples/views/sample24.haml +9 -4
data/examples/api-samples/views/sample25.haml +18 -13
data/examples/api-samples/views/sample26.haml +8 -3
data/examples/api-samples/views/sample27.haml +20 -14
data/examples/api-samples/views/sample28.haml +16 -10
data/examples/api-samples/views/sample29.haml +4 -4
data/examples/api-samples/views/sample30.haml +16 -10
data/examples/api-samples/views/sample31.haml +39 -32
data/examples/api-samples/views/sample32.haml +25 -36
data/examples/api-samples/views/sample33.haml +14 -17
data/examples/api-samples/views/sample34.haml +48 -0
data/examples/api-samples/views/sample35.haml +95 -0
data/examples/api-samples/views/sample36.haml +64 -0
data/examples/api-samples/views/sample37.haml +124 -0
data/examples/api-samples/views/sample38.haml +115 -0
data/examples/api-samples/views/sample39.haml +236 -0
data/examples/api-samples/views/sample40.haml +95 -0
data/examples/api-samples/views/{sample4.haml → sample41.haml} +90 -72
data/examples/api-samples/views/sample42.haml +59 -0
data/lib/groupdocs/api/helpers/rest_helper.rb +13 -1
data/lib/groupdocs/datasource.rb +2 -1
data/lib/groupdocs/document.rb +101 -13
data/lib/groupdocs/document/annotation.rb +28 -13
data/lib/groupdocs/document/annotation/marker.rb +18 -0
data/lib/groupdocs/document/annotation/reply.rb +9 -2
data/lib/groupdocs/document/field.rb +5 -1
data/lib/groupdocs/job.rb +12 -2
data/lib/groupdocs/questionnaire.rb +174 -4
data/lib/groupdocs/questionnaire/collector.rb +21 -0
data/lib/groupdocs/questionnaire/question.rb +19 -0
data/lib/groupdocs/questionnaire/question/answer.rb +5 -0
data/lib/groupdocs/questionnaire/question/conditions.rb +20 -0
data/lib/groupdocs/signature.rb +36 -308
data/lib/groupdocs/signature/envelope.rb +146 -4
data/lib/groupdocs/signature/field.rb +20 -1
data/lib/groupdocs/signature/field/location.rb +18 -7
data/lib/groupdocs/signature/form.rb +199 -10
data/lib/groupdocs/signature/shared/document_methods.rb +38 -0
data/lib/groupdocs/signature/shared/entity_methods.rb +0 -1
data/lib/groupdocs/signature/shared/field_methods.rb +13 -38
data/lib/groupdocs/signature/shared/recipient_methods.rb +8 -0
data/lib/groupdocs/signature/template.rb +3 -1
data/lib/groupdocs/storage.rb +4 -1
data/lib/groupdocs/storage/file.rb +18 -1
data/lib/groupdocs/subscription.rb +8 -3
data/lib/groupdocs/user.rb +8 -0
data/lib/groupdocs/version.rb +1 -1
data/spec/groupdocs/document/annotation_spec.rb +1 -14
data/spec/groupdocs/subscription_spec.rb +2 -2
metadata +86 -32
checksums.yaml +0 -15
data/examples/api-samples/public/docs/sample9.html +0 -200
data/examples/api-samples/samples/sample1.rb +0 -25
data/examples/api-samples/samples/sample2.rb +0 -29
data/examples/api-samples/samples/sample3.rb +0 -33
data/examples/api-samples/samples/sample4.rb +0 -51
data/examples/api-samples/samples/sample6.rb +0 -49
data/examples/api-samples/samples/sample7.rb +0 -42
data/examples/api-samples/samples/sample8.rb +0 -61
data/examples/api-samples/samples/sample9.rb +0 -48
data/examples/api-samples/views/sample3.haml +0 -44
data/examples/api-samples/views/sample6.haml +0 -49
data/examples/api-samples/views/sample7.haml +0 -42

data/examples/api-samples/public/docs/sample41.html ADDED Viewed

@@ -0,0 +1,452 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>sample41.rb</title>
+  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
+  <link rel="stylesheet" media="all" href="docco.css" />
+</head>
+<body>
+  <div id="container">
+    <div id="background"></div>
+    <ul class="sections">
+          <li id="title">
+              <div class="annotation">
+                  <h1>sample41.rb</h1>
+              </div>
+          </li>
+        <li id="section-1">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-1">&#182;</a>
+              </div>
+              <p>GET request</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>get <span class="string">'/sample41'</span> <span class="keyword">do</span>
+  haml <span class="symbol">:sample41</span>
+<span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-2">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-2">&#182;</a>
+              </div>
+              <p>POST request</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>post <span class="string">'/sample41'</span> <span class="keyword">do</span></pre></div></div>
+        </li>
+        <li id="section-3">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-3">&#182;</a>
+              </div>
+              <p>set variables</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>  set <span class="symbol">:client_id</span>, params[<span class="symbol">:clientId</span>]
+  set <span class="symbol">:private_key</span>, params[<span class="symbol">:privateKey</span>]
+  set <span class="symbol">:source</span>, params[<span class="symbol">:source</span>]
+  set <span class="symbol">:file_id</span>, params[<span class="symbol">:fileId</span>]
+  set <span class="symbol">:url</span>, params[<span class="symbol">:url</span>]
+  set <span class="symbol">:base_path</span>, params[<span class="symbol">:basePath</span>]</pre></div></div>
+        </li>
+        <li id="section-4">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-4">&#182;</a>
+              </div>
+              <p>Set download path</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>  downloads_path = <span class="string">"<span class="subst">#{<span class="constant">File</span>.dirname(__FILE_<span class="number">_</span>)}</span>/../public/downloads"</span></pre></div></div>
+        </li>
+        <li id="section-5">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-5">&#182;</a>
+              </div>
+              <p>Remove all files from download directory or create folder if it not there</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>  <span class="keyword">if</span> <span class="constant">File</span>.directory?(downloads_path)
+    <span class="constant">Dir</span>.foreach(downloads_path) { |f| fn = <span class="constant">File</span>.join(downloads_path, f); <span class="constant">File</span>.delete(fn) <span class="keyword">if</span> f != <span class="string">'.'</span> &amp;&amp; f != <span class="string">'..'</span> }
+  <span class="keyword">else</span>
+    <span class="constant">Dir::</span>mkdir(downloads_path)
+  <span class="keyword">end</span>
+  <span class="keyword">begin</span></pre></div></div>
+        </li>
+        <li id="section-6">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-6">&#182;</a>
+              </div>
+              <p>Check required variables</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    raise <span class="string">'Please enter all required parameters'</span> <span class="keyword">if</span> settings.client_id.empty? <span class="keyword">or</span> settings.private_key.empty?
+    <span class="keyword">if</span> settings.base_path.empty? <span class="keyword">then</span> settings.base_path = <span class="string">'https://api.groupdocs.com'</span> <span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-7">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-7">&#182;</a>
+              </div>
+              <p>Configure your access to API server</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    <span class="constant">GroupDocs</span>.configure <span class="keyword">do</span> |groupdocs|
+      groupdocs.client_id = settings.client_id
+      groupdocs.private_key = settings.private_key</pre></div></div>
+        </li>
+        <li id="section-8">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-8">&#182;</a>
+              </div>
+              <p>Optionally specify API server and version</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>      groupdocs.api_server = settings.base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
+    <span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-9">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-9">&#182;</a>
+              </div>
+              <p>Get document by file GUID</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    <span class="keyword">case</span> settings.source
+      <span class="keyword">when</span> <span class="string">'guid'</span></pre></div></div>
+        </li>
+        <li id="section-10">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-10">&#182;</a>
+              </div>
+              <p>Create instance of File</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>        file = <span class="constant">GroupDocs::Storage::File</span>.new({<span class="symbol">:guid</span> =&gt; settings.file_id})
+      <span class="keyword">when</span> <span class="string">'local'</span></pre></div></div>
+        </li>
+        <li id="section-11">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-11">&#182;</a>
+              </div>
+              <p>Construct path</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>        file_path = <span class="string">"<span class="subst">#{<span class="constant">Dir</span>.tmpdir}</span>/<span class="subst">#{params[<span class="symbol">:file</span>][<span class="symbol">:filename</span>]}</span>"</span></pre></div></div>
+        </li>
+        <li id="section-12">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-12">&#182;</a>
+              </div>
+              <p>Open file</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>        <span class="constant">File</span>.open(file_path, <span class="string">'wb'</span>) { |f| f.write(params[<span class="symbol">:file</span>][<span class="symbol">:tempfile</span>].read) }</pre></div></div>
+        </li>
+        <li id="section-13">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-13">&#182;</a>
+              </div>
+              <p>Make a request to API using client_id and private_key</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>        file = <span class="constant">GroupDocs::Storage::File</span>.upload!(file_path, {})
+      <span class="keyword">when</span> <span class="string">'url'</span></pre></div></div>
+        </li>
+        <li id="section-14">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-14">&#182;</a>
+              </div>
+              <p>Upload file from defined url</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>        file = <span class="constant">GroupDocs::Storage::File</span>.upload_web!(settings.url)
+      <span class="keyword">else</span>
+        raise <span class="string">'Wrong GUID source.'</span>
+    <span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-15">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-15">&#182;</a>
+              </div>
+              <p>Raise exception if something went wrong</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    raise <span class="string">'No such file'</span> <span class="keyword">unless</span> file.is_a?(<span class="constant">GroupDocs::Storage::File</span>)</pre></div></div>
+        </li>
+        <li id="section-16">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-16">&#182;</a>
+              </div>
+              <p>Make GroupDocs::Storage::Document instance</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    document = file.to_document</pre></div></div>
+        </li>
+        <li id="section-17">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-17">&#182;</a>
+              </div>
+              <p>Create Hash with the options for job. :status=&gt; -1 means the Draft status of the job</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    options = {<span class="symbol">:actions</span> =&gt; [<span class="symbol">:convert</span>, <span class="symbol">:number_lines</span>], <span class="symbol">:out_formats</span> =&gt; [<span class="string">'doc'</span>], <span class="symbol">:name</span> =&gt; <span class="string">'sample'</span>}</pre></div></div>
+        </li>
+        <li id="section-18">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-18">&#182;</a>
+              </div>
+              <p>Create Job with provided options with Draft status (Sheduled job)</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    job = <span class="constant">GroupDocs::Job</span>.create!(options)</pre></div></div>
+        </li>
+        <li id="section-19">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-19">&#182;</a>
+              </div>
+              <p>Add the documents to previously created Job</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    job.add_document!(document, {<span class="symbol">:check_ownership</span> =&gt; <span class="keyword">false</span>})</pre></div></div>
+        </li>
+        <li id="section-20">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-20">&#182;</a>
+              </div>
+              <p>Update the Job with new status. :status =&gt; &#39;0&#39; mean Active status of the job (Start the job)</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    id = job.update!({<span class="symbol">:status</span> =&gt; <span class="string">'pending'</span>})
+    i = <span class="number">1</span>
+    <span class="keyword">while</span> i&lt;<span class="number">5</span> <span class="keyword">do</span>
+      sleep(<span class="number">5</span>)
+      job = <span class="constant">GroupDocs::Job</span>.get!(id[<span class="symbol">:job_id</span>])
+      <span class="keyword">break</span> <span class="keyword">if</span> job.status == <span class="symbol">:archived</span>
+      i  = i + <span class="number">1</span>
+    <span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-21">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-21">&#182;</a>
+              </div>
+              <p>Get the document into Pdf format</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    file = job.documents!()
+    document = file[<span class="symbol">:inputs</span>][<span class="number">0</span>].outputs[<span class="number">0</span>]</pre></div></div>
+        </li>
+        <li id="section-22">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-22">&#182;</a>
+              </div>
+              <p>Set iframe with document GUID or raise an error</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    <span class="keyword">if</span> document</pre></div></div>
+        </li>
+        <li id="section-23">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-23">&#182;</a>
+              </div>
+              <p>Get url from request</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>      <span class="keyword">case</span> settings.base_path
+        <span class="keyword">when</span> <span class="string">'https://stage-api-groupdocs.dynabic.com'</span>
+          url = <span class="string">"http://stage-apps-groupdocs.dynabic.com/document-viewer/embed/<span class="subst">#{document.guid}</span>"</span>
+        <span class="keyword">when</span> <span class="string">'https://dev-api-groupdocs.dynabic.com'</span>
+          url = <span class="string">"http://dev-apps-groupdocs.dynabic.com/document-viewer/embed/<span class="subst">#{document.guid}</span>"</span>
+        <span class="keyword">else</span>
+          url = <span class="string">"https://apps.groupdocs.com/document-viewer/embed/<span class="subst">#{document.guid}</span>"</span>
+      <span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-24">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-24">&#182;</a>
+              </div>
+              <p>Add the signature in url</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>      iframe = <span class="constant">GroupDocs::Api::Request</span>.new(<span class="symbol">:path</span> =&gt; url).prepare_and_sign_url
+      iframe = <span class="string">"&lt;iframe width='100%' height='600' frameborder='0' src='<span class="subst">#{iframe}</span>'&gt;&lt;/iframe&gt;"</span>
+    <span class="keyword">else</span>
+      raise <span class="string">'File was not converted'</span>
+    <span class="keyword">end</span>
+  <span class="keyword">rescue</span> <span class="constant">Exception</span> =&gt; e
+    err = e.message
+  <span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-25">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-25">&#182;</a>
+              </div>
+              <p>Set variables for template</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>  haml <span class="symbol">:sample41</span>, <span class="symbol">:locals</span> =&gt; {<span class="symbol">:userId</span> =&gt; settings.client_id, <span class="symbol">:privateKey</span> =&gt; settings.private_key, <span class="symbol">:err</span> =&gt; err, <span class="symbol">:iframe</span> =&gt; iframe}
+<span class="keyword">end</span></pre></div></div>
+        </li>
+    </ul>
+  </div>
+</body>
+</html>

data/examples/api-samples/public/docs/sample42.html ADDED Viewed

@@ -0,0 +1,311 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>sample42.rb</title>
+  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
+  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
+  <link rel="stylesheet" media="all" href="docco.css" />
+</head>
+<body>
+  <div id="container">
+    <div id="background"></div>
+    <ul class="sections">
+          <li id="title">
+              <div class="annotation">
+                  <h1>sample42.rb</h1>
+              </div>
+          </li>
+        <li id="section-1">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-1">&#182;</a>
+              </div>
+              <p>GET request</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>get <span class="string">'/sample42'</span> <span class="keyword">do</span>
+  haml <span class="symbol">:sample42</span>
+<span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-2">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-2">&#182;</a>
+              </div>
+              <p>POST request</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>post <span class="string">'/sample42'</span> <span class="keyword">do</span></pre></div></div>
+        </li>
+        <li id="section-3">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-3">&#182;</a>
+              </div>
+              <p>set variables</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>  set <span class="symbol">:client_id</span>, params[<span class="symbol">:clientId</span>]
+  set <span class="symbol">:private_key</span>, params[<span class="symbol">:privateKey</span>]
+  set <span class="symbol">:file_id</span>, params[<span class="symbol">:fileId</span>]
+  set <span class="symbol">:base_path</span>, params[<span class="symbol">:basePath</span>]
+  <span class="keyword">begin</span></pre></div></div>
+        </li>
+        <li id="section-4">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-4">&#182;</a>
+              </div>
+              <p>Check required variables</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    raise <span class="string">'Please enter all required parameters'</span> <span class="keyword">if</span> settings.client_id.empty? <span class="keyword">or</span> settings.private_key.empty?
+    <span class="keyword">if</span> settings.base_path.empty? <span class="keyword">then</span> settings.base_path = <span class="string">'https://api.groupdocs.com'</span> <span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-5">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-5">&#182;</a>
+              </div>
+              <p>Configure your access to API server</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    <span class="constant">GroupDocs</span>.configure <span class="keyword">do</span> |groupdocs|
+      groupdocs.client_id = settings.client_id
+      groupdocs.private_key = settings.private_key</pre></div></div>
+        </li>
+        <li id="section-6">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-6">&#182;</a>
+              </div>
+              <p>Optionally specify API server and version</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>      groupdocs.api_server = settings.base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
+    <span class="keyword">end</span>
+    document = <span class="constant">GroupDocs::Storage::File</span>.new(<span class="symbol">:guid</span> =&gt; settings.file_id).to_document</pre></div></div>
+        </li>
+        <li id="section-7">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-7">&#182;</a>
+              </div>
+              <p>Check, has document the annotations?</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    raise <span class="string">'Your document has no annotations'</span> <span class="keyword">if</span> document.annotations!.empty?</pre></div></div>
+        </li>
+        <li id="section-8">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-8">&#182;</a>
+              </div>
+              <p>Create Hash with the options for job. :status=&gt; -1 means the Draft status of the job</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    options = {<span class="symbol">:actions</span> =&gt; [<span class="symbol">:import_annotations</span>], <span class="symbol">:name</span> =&gt; <span class="string">'sample'</span>}</pre></div></div>
+        </li>
+        <li id="section-9">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-9">&#182;</a>
+              </div>
+              <p>Create Job with provided options with Draft status (Sheduled job)</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    job = <span class="constant">GroupDocs::Job</span>.create!(options)</pre></div></div>
+        </li>
+        <li id="section-10">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-10">&#182;</a>
+              </div>
+              <p>Add the documents to previously created Job</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    job.add_document!(document, {<span class="symbol">:check_ownership</span> =&gt; <span class="keyword">false</span>})</pre></div></div>
+        </li>
+        <li id="section-11">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-11">&#182;</a>
+              </div>
+              <p>Update the Job with new status. :status =&gt; &#39;0&#39; mean Active status of the job (Start the job)</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    id = job.update!({<span class="symbol">:status</span> =&gt; <span class="string">'0'</span>})
+    i = <span class="number">1</span>
+    <span class="keyword">while</span> i&lt;<span class="number">5</span> <span class="keyword">do</span>
+      sleep(<span class="number">5</span>)
+      job = <span class="constant">GroupDocs::Job</span>.get!(id[<span class="symbol">:job_id</span>])
+      <span class="keyword">break</span> <span class="keyword">if</span> job.status == <span class="symbol">:archived</span>
+      i  = i + <span class="number">1</span>
+    <span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-12">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-12">&#182;</a>
+              </div>
+              <p>Get the document into Pdf format</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    file = job.documents!()
+    document = file[<span class="symbol">:inputs</span>]</pre></div></div>
+        </li>
+        <li id="section-13">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-13">&#182;</a>
+              </div>
+              <p>Set iframe with document GUID or raise an error</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>    <span class="keyword">if</span> document</pre></div></div>
+        </li>
+        <li id="section-14">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-14">&#182;</a>
+              </div>
+              <p>Get url from request</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>      <span class="keyword">case</span> settings.base_path
+        <span class="keyword">when</span> <span class="string">'https://stage-api-groupdocs.dynabic.com'</span>
+          url = <span class="string">"http://stage-apps-groupdocs.dynabic.com/document-annotation/embed/<span class="subst">#{document[<span class="number">0</span>].guid}</span>"</span>
+        <span class="keyword">when</span> <span class="string">'https://dev-api-groupdocs.dynabic.com'</span>
+          url = <span class="string">"http://dev-apps-groupdocs.dynabic.com/document-annotation/embed/<span class="subst">#{document[<span class="number">0</span>].guid}</span>"</span>
+        <span class="keyword">else</span>
+          url = <span class="string">"https://apps.groupdocs.com/document-annotation/embed/<span class="subst">#{document[<span class="number">0</span>].guid}</span>"</span>
+      <span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-15">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-15">&#182;</a>
+              </div>
+              <p>Add the signature in url</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>      iframe = <span class="constant">GroupDocs::Api::Request</span>.new(<span class="symbol">:path</span> =&gt; url).prepare_and_sign_url
+      iframe = <span class="string">"&lt;iframe width='100%' height='600' frameborder='0' src='<span class="subst">#{iframe}</span>'&gt;&lt;/iframe&gt;"</span>
+      path = <span class="string">"<span class="subst">#{<span class="constant">File</span>.dirname(__FILE_<span class="number">_</span>)}</span>/../public/downloads"</span>
+      <span class="constant">GroupDocs::User</span>.download!(path, document[<span class="number">0</span>].outputs[<span class="number">0</span>].name, document[<span class="number">0</span>].outputs[<span class="number">0</span>].guid)
+      message = <span class="string">"&lt;span style=\"color:green\"&gt;File with annotations was downloaded to server's local folder. You can check them &lt;a href=\"/downloads/<span class="subst">#{document[<span class="number">0</span>].outputs[<span class="number">0</span>].name}</span>\"&gt;here&lt;/a&gt;&lt;/span&gt;"</span>
+    <span class="keyword">else</span>
+      raise <span class="string">'File was not converted'</span>
+    <span class="keyword">end</span>
+  <span class="keyword">rescue</span> <span class="constant">Exception</span> =&gt; e
+    err = e.message
+  <span class="keyword">end</span></pre></div></div>
+        </li>
+        <li id="section-16">
+            <div class="annotation">
+              <div class="pilwrap ">
+                <a class="pilcrow" href="#section-16">&#182;</a>
+              </div>
+              <p>Set variables for template</p>
+            </div>
+            <div class="content"><div class='highlight'><pre>  haml <span class="symbol">:sample42</span>, <span class="symbol">:locals</span> =&gt; {<span class="symbol">:userId</span> =&gt; settings.client_id, <span class="symbol">:privateKey</span> =&gt; settings.private_key, <span class="symbol">:err</span> =&gt; err, <span class="symbol">:iframe</span> =&gt; iframe, <span class="symbol">:message</span> =&gt; message}
+<span class="keyword">end</span></pre></div></div>
+        </li>
+    </ul>
+  </div>
+</body>
+</html>