examples/api-samples/public/docs/sample33.html in groupdocs-1.5.7 vs examples/api-samples/public/docs/sample33.html in groupdocs-1.5.8
- old
+ new
@@ -61,17 +61,16 @@
</div>
<p>set variables</p>
</div>
- <div class="content"><div class='highlight'><pre> set <span class="symbol">:client_id</span>, params[<span class="symbol">:client_id</span>]
- set <span class="symbol">:private_key</span>, params[<span class="symbol">:private_key</span>]
- set <span class="symbol">:url_1</span>, params[<span class="symbol">:url_1</span>]
- set <span class="symbol">:url_2</span>, params[<span class="symbol">:url_2</span>]
- set <span class="symbol">:url_3</span>, params[<span class="symbol">:url_3</span>]
- set <span class="symbol">:url_4</span>, params[<span class="symbol">:url_4</span>]
- set <span class="symbol">:url_5</span>, params[<span class="symbol">:url_5</span>]
+ <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">:url_1</span>, params[<span class="symbol">:url1</span>]
+ set <span class="symbol">:url_2</span>, params[<span class="symbol">:url2</span>]
+ set <span class="symbol">:url_3</span>, params[<span class="symbol">:url3</span>]
+ set <span class="symbol">:base_path</span>, params[<span class="symbol">:basePath</span>]
<span class="keyword">begin</span></pre></div></div>
</li>
@@ -84,71 +83,101 @@
</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">or</span> settings.url_1.empty? <span class="keyword">or</span> settings.url_2.empty? <span class="keyword">or</span> settings.url_3.empty? <span class="keyword">or</span> settings.url_4.empty? <span class="keyword">or</span> settings.url_5.empty?
-
- <span class="constant">GroupDocs</span>.configure <span class="keyword">do</span> |groupdocs|
- groupdocs.client_id = settings.client_id
- groupdocs.private_key = settings.private_key
- <span class="keyword">end</span></pre></div></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">or</span> settings.url_1.empty? <span class="keyword">or</span> settings.url_2.empty? <span class="keyword">or</span> settings.url_3.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">¶</a>
</div>
- <p>Create Array from variables</p>
+ <p>Configure your access to API server</p>
</div>
- <div class="content"><div class='highlight'><pre> url = [settings.url_1, settings.url_2, settings.url_3, settings.url_4, settings.url_5 ]</pre></div></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">¶</a>
</div>
- <p>Create Hash with the options for job. :status=> -1 means the Draft status of the job</p>
+ <p>Optionally specify API server and version</p>
</div>
- <div class="content"><div class='highlight'><pre> options = {<span class="symbol">:actions</span> => [<span class="symbol">:convert</span>, <span class="symbol">:combine</span>], <span class="symbol">:out_formats</span> => [<span class="string">'pdf'</span>], <span class="symbol">:status</span> => -<span class="number">1</span>, <span class="symbol">:name</span> => <span class="string">'sample'</span>}</pre></div></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-7">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-7">¶</a>
</div>
- <p>Create Job with provided options with Draft status (Sheduled job)</p>
+ <p>Create Array from variables</p>
</div>
- <div class="content"><div class='highlight'><pre> job = <span class="constant">GroupDocs::Job</span>.create!(options)</pre></div></div>
+ <div class="content"><div class='highlight'><pre> url = [settings.url_1, settings.url_2, settings.url_3 ]</pre></div></div>
</li>
<li id="section-8">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-8">¶</a>
</div>
+ <p>Create Hash with the options for job. :status=> -1 means the Draft status of the job</p>
+
+ </div>
+
+ <div class="content"><div class='highlight'><pre> options = {<span class="symbol">:actions</span> => [<span class="symbol">:convert</span>, <span class="symbol">:combine</span>], <span class="symbol">:out_formats</span> => [<span class="string">'pdf'</span>], <span class="symbol">:status</span> => -<span class="number">1</span>, <span class="symbol">:name</span> => <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">¶</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">¶</a>
+ </div>
<p>Upload documents to GroupDocs Storage by url and add the documents to previously created Job</p>
</div>
<div class="content"><div class='highlight'><pre> url.each <span class="keyword">do</span> |url|
@@ -157,69 +186,115 @@
<span class="keyword">end</span></pre></div></div>
</li>
- <li id="section-9">
+ <li id="section-11">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-9">¶</a>
+ <a class="pilcrow" href="#section-11">¶</a>
</div>
<p>Update the Job with new status. :status => '0' mean Active status of the job (Start the job)</p>
</div>
- <div class="content"><div class='highlight'><pre> job.update!({<span class="symbol">:status</span> => <span class="string">'0'</span>})
- sleep(<span class="number">5</span>)</pre></div></div>
+ <div class="content"><div class='highlight'><pre> id = job.update!({<span class="symbol">:status</span> => <span class="string">'0'</span>})
+
+ i = <span class="number">1</span>
+
+ <span class="keyword">while</span> i<<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-10">
+ <li id="section-12">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-10">¶</a>
+ <a class="pilcrow" href="#section-12">¶</a>
</div>
<p>Get the document into Pdf format</p>
</div>
<div class="content"><div class='highlight'><pre> file = job.documents!()
- sleep(<span class="number">7</span>)
+
document = file[<span class="symbol">:outputs</span>]</pre></div></div>
</li>
- <li id="section-11">
+ <li id="section-13">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-11">¶</a>
+ <a class="pilcrow" href="#section-13">¶</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
- iframe = <span class="string">"<iframe width='100%' height='600' frameborder='0' src='https://apps.groupdocs.com/document-viewer/embed/<span class="subst">#{document[<span class="number">0</span>].guid}</span>'></iframe>"</span>
+ <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">¶</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[<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-viewer/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-viewer/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">¶</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> => url).prepare_and_sign_url
+ iframe = <span class="string">"<iframe width='100%' height='600' frameborder='0' src='<span class="subst">#{iframe}</span>'></iframe>"</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> => e
err = e.message
<span class="keyword">end</span></pre></div></div>
</li>
- <li id="section-12">
+ <li id="section-16">
<div class="annotation">
<div class="pilwrap ">
- <a class="pilcrow" href="#section-12">¶</a>
+ <a class="pilcrow" href="#section-16">¶</a>
</div>
<p>Set variables for template</p>
</div>