examples/api-samples/public/docs/sample33.html in groupdocs-1.6.0 vs examples/api-samples/public/docs/sample33.html in groupdocs-1.7.0
- old
+ new
@@ -29,13 +29,13 @@
</div>
<p>GET request</p>
</div>
- <div class="content"><div class='highlight'><pre>get <span class="string">'/sample33'</span> <span class="keyword">do</span>
- haml <span class="symbol">:sample33</span>
-<span class="keyword">end</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre>get <span class="hljs-string">'/sample-33-how-to-convert-several-html-documents-into-one-pdf-document'</span> <span class="hljs-keyword">do</span>
+ haml <span class="hljs-symbol">:sample33</span>
+<span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-2">
@@ -46,11 +46,11 @@
</div>
<p>POST request</p>
</div>
- <div class="content"><div class='highlight'><pre>post <span class="string">'/sample33'</span> <span class="keyword">do</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre>post <span class="hljs-string">'/sample-33-how-to-convert-several-html-documents-into-one-pdf-document'</span> <span class="hljs-keyword">do</span></pre></div></div>
</li>
<li id="section-3">
@@ -61,18 +61,18 @@
</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">: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>]
+ <div class="content"><div class='highlight'><pre> set <span class="hljs-symbol">:client_id</span>, params[<span class="hljs-symbol">:clientId</span>]
+ set <span class="hljs-symbol">:private_key</span>, params[<span class="hljs-symbol">:privateKey</span>]
+ set <span class="hljs-symbol">:url_1</span>, params[<span class="hljs-symbol">:url1</span>]
+ set <span class="hljs-symbol">:url_2</span>, params[<span class="hljs-symbol">:url2</span>]
+ set <span class="hljs-symbol">:url_3</span>, params[<span class="hljs-symbol">:url3</span>]
+ set <span class="hljs-symbol">:base_path</span>, params[<span class="hljs-symbol">:basePath</span>]
- <span class="keyword">begin</span></pre></div></div>
+ <span class="hljs-keyword">begin</span></pre></div></div>
</li>
<li id="section-4">
@@ -83,11 +83,11 @@
</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?</pre></div></div>
+ <div class="content"><div class='highlight'><pre> raise <span class="hljs-string">'Please enter all required parameters'</span> <span class="hljs-keyword">if</span> settings.client_id.empty? <span class="hljs-keyword">or</span> settings.private_key.empty? <span class="hljs-keyword">or</span> settings.url_1.empty? <span class="hljs-keyword">or</span> settings.url_2.empty? <span class="hljs-keyword">or</span> settings.url_3.empty?</pre></div></div>
</li>
<li id="section-5">
@@ -98,17 +98,17 @@
</div>
<p>Prepare base path</p>
</div>
- <div class="content"><div class='highlight'><pre> <span class="keyword">if</span> settings.base_path.empty?
- base_path = <span class="string">'https://api.groupdocs.com'</span>
- <span class="keyword">elsif</span> settings.base_path.match(<span class="string">'/v2.0'</span>)
- base_path = settings.base_path.split(<span class="string">'/v2.0'</span>)[<span class="number">0</span>]
- <span class="keyword">else</span>
+ <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> settings.base_path.empty?
+ base_path = <span class="hljs-string">'https://api.groupdocs.com'</span>
+ <span class="hljs-keyword">elsif</span> settings.base_path.match(<span class="hljs-string">'/v2.0'</span>)
+ base_path = settings.base_path.split(<span class="hljs-string">'/v2.0'</span>)[<span class="hljs-number">0</span>]
+ <span class="hljs-keyword">else</span>
base_path = settings.base_path
- <span class="keyword">end</span></pre></div></div>
+ <span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-6">
@@ -119,11 +119,11 @@
</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|
+ <div class="content"><div class='highlight'><pre> <span class="hljs-constant">GroupDocs</span>.configure <span class="hljs-keyword">do</span> |groupdocs|
groupdocs.client_id = settings.client_id
groupdocs.private_key = settings.private_key</pre></div></div>
</li>
@@ -136,13 +136,13 @@
</div>
<p>Optionally specify API server and version</p>
</div>
- <div class="content"><div class='highlight'><pre> groupdocs.api_server = base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
+ <div class="content"><div class='highlight'><pre> groupdocs.api_server = base_path <span class="hljs-comment"># default is 'https://api.groupdocs.com'</span>
- <span class="keyword">end</span></pre></div></div>
+ <span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-8">
@@ -168,11 +168,11 @@
</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>
+ <div class="content"><div class='highlight'><pre> options = {<span class="hljs-symbol">:actions</span> => [<span class="hljs-symbol">:convert</span>, <span class="hljs-symbol">:combine</span>], <span class="hljs-symbol">:out_formats</span> => [<span class="hljs-string">'pdf'</span>], <span class="hljs-symbol">:status</span> => -<span class="hljs-number">1</span>, <span class="hljs-symbol">:name</span> => <span class="hljs-string">'sample'</span>}</pre></div></div>
</li>
<li id="section-10">
@@ -183,11 +183,11 @@
</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>
+ <div class="content"><div class='highlight'><pre> job = <span class="hljs-constant">GroupDocs::Job</span>.create!(options)</pre></div></div>
</li>
<li id="section-11">
@@ -198,38 +198,38 @@
</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|
- document = <span class="constant">GroupDocs::Storage::File</span>.upload_web!(url).to_document
- job.add_document!(document, {<span class="symbol">:check_ownership</span> => <span class="keyword">false</span>})
- <span class="keyword">end</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre> url.each <span class="hljs-keyword">do</span> |url|
+ document = <span class="hljs-constant">GroupDocs::Storage::File</span>.upload_web!(url).to_document
+ job.add_document!(document, {<span class="hljs-symbol">:check_ownership</span> => <span class="hljs-keyword">false</span>})
+ <span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-12">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-12">¶</a>
</div>
- <p>Update the Job with new status. :status => '0' mean Active status of the job (Start the job)</p>
+ <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> id = job.update!({<span class="symbol">:status</span> => <span class="string">'0'</span>})
+ <div class="content"><div class='highlight'><pre> id = job.update!({<span class="hljs-symbol">:status</span> => <span class="hljs-string">'0'</span>})
- i = <span class="number">1</span>
+ i = <span class="hljs-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>
+ <span class="hljs-keyword">while</span> i<<span class="hljs-number">5</span> <span class="hljs-keyword">do</span>
+ sleep(<span class="hljs-number">5</span>)
+ job = <span class="hljs-constant">GroupDocs::Job</span>.get!(id[<span class="hljs-symbol">:job_id</span>])
+ <span class="hljs-keyword">break</span> <span class="hljs-keyword">if</span> job.status == <span class="hljs-symbol">:archived</span>
+ i = i + <span class="hljs-number">1</span>
+ <span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-13">
@@ -242,11 +242,11 @@
</div>
<div class="content"><div class='highlight'><pre> file = job.documents!()
- document = file[<span class="symbol">:outputs</span>]</pre></div></div>
+ document = file[<span class="hljs-symbol">:outputs</span>]</pre></div></div>
</li>
<li id="section-14">
@@ -257,11 +257,11 @@
</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>
+ <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> document</pre></div></div>
</li>
<li id="section-15">
@@ -272,11 +272,11 @@
</div>
<p>Prepare to sign url</p>
</div>
- <div class="content"><div class='highlight'><pre> iframe = <span class="string">"/document-viewer/embed/<span class="subst">#{document[<span class="number">0</span>].guid}</span>"</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre> iframe = <span class="hljs-string">"/document-viewer/embed/<span class="hljs-subst">#{document[<span class="hljs-number">0</span>].guid}</span>"</span></pre></div></div>
</li>
<li id="section-16">
@@ -287,11 +287,11 @@
</div>
<p>Construct result string</p>
</div>
- <div class="content"><div class='highlight'><pre> url = <span class="constant">GroupDocs::Api::Request</span>.new(<span class="symbol">:path</span> => iframe).prepare_and_sign_url</pre></div></div>
+ <div class="content"><div class='highlight'><pre> url = <span class="hljs-constant">GroupDocs::Api::Request</span>.new(<span class="hljs-symbol">:path</span> => iframe).prepare_and_sign_url</pre></div></div>
</li>
<li id="section-17">
@@ -302,18 +302,18 @@
</div>
<p>Generate iframe URL</p>
</div>
- <div class="content"><div class='highlight'><pre> <span class="keyword">case</span> base_path
- <span class="keyword">when</span> <span class="string">'https://stage-api-groupdocs.dynabic.com'</span>
- iframe = <span class="string">"https://stage-api-groupdocs.dynabic.com<span class="subst">#{url}</span>"</span>
- <span class="keyword">when</span> <span class="string">'https://dev-api-groupdocs.dynabic.com'</span>
- iframe = <span class="string">"https://dev-apps.groupdocs.com<span class="subst">#{url}</span>"</span>
- <span class="keyword">else</span>
- iframe = <span class="string">"https://apps.groupdocs.com<span class="subst">#{url}</span>"</span>
- <span class="keyword">end</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">case</span> base_path
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'https://stage-api-groupdocs.dynabic.com'</span>
+ iframe = <span class="hljs-string">"https://stage-api-groupdocs.dynabic.com<span class="hljs-subst">#{url}</span>"</span>
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'https://dev-api-groupdocs.dynabic.com'</span>
+ iframe = <span class="hljs-string">"https://dev-apps.groupdocs.com<span class="hljs-subst">#{url}</span>"</span>
+ <span class="hljs-keyword">else</span>
+ iframe = <span class="hljs-string">"https://apps.groupdocs.com<span class="hljs-subst">#{url}</span>"</span>
+ <span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-18">
@@ -324,18 +324,18 @@
</div>
<p>Make iframe</p>
</div>
- <div class="content"><div class='highlight'><pre> iframe = <span class="string">"<iframe id='downloadframe' src='<span class="subst">#{iframe}</span>' width='800' height='1000'></iframe>"</span>
+ <div class="content"><div class='highlight'><pre> iframe = <span class="hljs-string">"<iframe id='downloadframe' src='<span class="hljs-subst">#{iframe}</span>' width='800' height='1000'></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
+ <span class="hljs-keyword">else</span>
+ raise <span class="hljs-string">'File was not converted'</span>
+ <span class="hljs-keyword">end</span>
+ <span class="hljs-keyword">rescue</span> <span class="hljs-constant">Exception</span> => e
err = e.message
- <span class="keyword">end</span></pre></div></div>
+ <span class="hljs-keyword">end</span></pre></div></div>
</li>
<li id="section-19">
@@ -346,11 +346,11 @@
</div>
<p>Set variables for template</p>
</div>
- <div class="content"><div class='highlight'><pre> haml <span class="symbol">:sample33</span>, <span class="symbol">:locals</span> => {<span class="symbol">:userId</span> => settings.client_id, <span class="symbol">:privateKey</span> => settings.private_key, <span class="symbol">:err</span> => err, <span class="symbol">:iframe</span> => iframe}
-<span class="keyword">end</span></pre></div></div>
+ <div class="content"><div class='highlight'><pre> haml <span class="hljs-symbol">:sample33</span>, <span class="hljs-symbol">:locals</span> => {<span class="hljs-symbol">:userId</span> => settings.client_id, <span class="hljs-symbol">:privateKey</span> => settings.private_key, <span class="hljs-symbol">:err</span> => err, <span class="hljs-symbol">:iframe</span> => iframe}
+<span class="hljs-keyword">end</span></pre></div></div>
</li>
</ul>
</div>