groupdocs 2.2.0 → 2.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (324) hide show
  1. checksums.yaml +7 -0
  2. data/.travis.yml +9 -9
  3. data/CHANGELOG.md +482 -477
  4. data/Gemfile +3 -3
  5. data/LICENSE.txt +21 -21
  6. data/README.md +94 -94
  7. data/Rakefile +9 -9
  8. data/examples/README.md +12 -12
  9. data/examples/api-samples/Gemfile +5 -5
  10. data/examples/api-samples/Gemfile.lock +49 -49
  11. data/examples/api-samples/README.md +23 -23
  12. data/examples/api-samples/public/css/style.css +229 -229
  13. data/examples/api-samples/public/docs/annotation-sample.html +167 -167
  14. data/examples/api-samples/public/docs/docco.css +500 -500
  15. data/examples/api-samples/public/docs/envelope-sample.html +374 -374
  16. data/examples/api-samples/public/docs/sample01.html +181 -181
  17. data/examples/api-samples/public/docs/sample02.html +199 -199
  18. data/examples/api-samples/public/docs/sample03.html +318 -318
  19. data/examples/api-samples/public/docs/sample04.html +217 -217
  20. data/examples/api-samples/public/docs/sample05.html +296 -296
  21. data/examples/api-samples/public/docs/sample06.html +347 -347
  22. data/examples/api-samples/public/docs/sample07.html +209 -209
  23. data/examples/api-samples/public/docs/sample08.html +277 -277
  24. data/examples/api-samples/public/docs/sample09.html +314 -314
  25. data/examples/api-samples/public/docs/sample10.html +270 -270
  26. data/examples/api-samples/public/docs/sample11.html +462 -462
  27. data/examples/api-samples/public/docs/sample12.html +199 -199
  28. data/examples/api-samples/public/docs/sample13.html +201 -201
  29. data/examples/api-samples/public/docs/sample14.html +204 -204
  30. data/examples/api-samples/public/docs/sample15.html +182 -182
  31. data/examples/api-samples/public/docs/sample16.html +234 -234
  32. data/examples/api-samples/public/docs/sample17.html +309 -309
  33. data/examples/api-samples/public/docs/sample18.html +721 -721
  34. data/examples/api-samples/public/docs/sample19.html +631 -631
  35. data/examples/api-samples/public/docs/sample20.html +230 -230
  36. data/examples/api-samples/public/docs/sample21.html +790 -790
  37. data/examples/api-samples/public/docs/sample22.html +408 -408
  38. data/examples/api-samples/public/docs/sample25.html +550 -550
  39. data/examples/api-samples/public/templates/base-simple_source.html +191 -191
  40. data/examples/api-samples/public/templates/testdocument.html +100 -100
  41. data/examples/api-samples/public/templates/welcome.htm +137 -137
  42. data/examples/api-samples/samples/annotation-sample.rb +56 -56
  43. data/examples/api-samples/samples/envelope-sample.rb +133 -133
  44. data/examples/api-samples/samples/sample01.rb +44 -44
  45. data/examples/api-samples/samples/sample02.rb +50 -50
  46. data/examples/api-samples/samples/sample03.rb +79 -79
  47. data/examples/api-samples/samples/sample04.rb +54 -54
  48. data/examples/api-samples/samples/sample05.rb +83 -83
  49. data/examples/api-samples/samples/sample06.rb +86 -86
  50. data/examples/api-samples/samples/sample07.rb +59 -59
  51. data/examples/api-samples/samples/sample08.rb +76 -76
  52. data/examples/api-samples/samples/sample09.rb +85 -85
  53. data/examples/api-samples/samples/sample10.rb +70 -70
  54. data/examples/api-samples/samples/sample11.rb +132 -132
  55. data/examples/api-samples/samples/sample12.rb +48 -48
  56. data/examples/api-samples/samples/sample13.rb +49 -49
  57. data/examples/api-samples/samples/sample14.rb +54 -54
  58. data/examples/api-samples/samples/sample15.rb +43 -43
  59. data/examples/api-samples/samples/sample16.rb +57 -57
  60. data/examples/api-samples/samples/sample17.rb +70 -70
  61. data/examples/api-samples/samples/sample18.rb +190 -190
  62. data/examples/api-samples/samples/sample19.rb +188 -188
  63. data/examples/api-samples/samples/sample20.rb +68 -68
  64. data/examples/api-samples/samples/sample21.rb +212 -212
  65. data/examples/api-samples/samples/sample22.rb +109 -109
  66. data/examples/api-samples/samples/sample25.rb +127 -127
  67. data/examples/api-samples/views/_others_samples.haml +233 -233
  68. data/examples/api-samples/views/annotation_sample.haml +63 -63
  69. data/examples/api-samples/views/envelope_sample.haml +72 -72
  70. data/examples/api-samples/views/index.haml +235 -235
  71. data/examples/api-samples/views/layout.haml +3 -3
  72. data/examples/api-samples/views/sample01.haml +63 -63
  73. data/examples/api-samples/views/sample02.haml +52 -52
  74. data/examples/api-samples/views/sample03.haml +87 -87
  75. data/examples/api-samples/views/sample04.haml +55 -55
  76. data/examples/api-samples/views/sample05.haml +86 -86
  77. data/examples/api-samples/views/sample06.haml +58 -58
  78. data/examples/api-samples/views/sample07.haml +52 -52
  79. data/examples/api-samples/views/sample08.haml +100 -100
  80. data/examples/api-samples/views/sample09.haml +95 -95
  81. data/examples/api-samples/views/sample10.haml +93 -93
  82. data/examples/api-samples/views/sample11.haml +140 -140
  83. data/examples/api-samples/views/sample12.haml +68 -68
  84. data/examples/api-samples/views/sample13.haml +64 -64
  85. data/examples/api-samples/views/sample14.haml +60 -60
  86. data/examples/api-samples/views/sample15.haml +51 -51
  87. data/examples/api-samples/views/sample16.haml +50 -50
  88. data/examples/api-samples/views/sample17.haml +54 -54
  89. data/examples/api-samples/views/sample18.haml +143 -143
  90. data/examples/api-samples/views/sample19.haml +92 -92
  91. data/examples/api-samples/views/sample20.haml +54 -54
  92. data/examples/api-samples/views/sample21.haml +123 -123
  93. data/examples/api-samples/views/sample22.haml +106 -106
  94. data/examples/api-samples/views/sample25.haml +101 -101
  95. data/examples/api-samples/views/sample31.haml +2 -2
  96. data/examples/api-samples/web.rb +20 -20
  97. data/examples/viewer/Gemfile +5 -5
  98. data/examples/viewer/app.rb +52 -52
  99. data/groupdocs.gemspec +31 -31
  100. data/lib/groupdocs.rb +62 -62
  101. data/lib/groupdocs/api.rb +6 -6
  102. data/lib/groupdocs/api/entity.rb +112 -112
  103. data/lib/groupdocs/api/helpers.rb +11 -11
  104. data/lib/groupdocs/api/helpers/access_mode_helper.rb +27 -27
  105. data/lib/groupdocs/api/helpers/access_rights_helper.rb +55 -55
  106. data/lib/groupdocs/api/helpers/accessor_helper.rb +30 -30
  107. data/lib/groupdocs/api/helpers/byte_flag_helper.rb +49 -49
  108. data/lib/groupdocs/api/helpers/credentials_helper.rb +35 -35
  109. data/lib/groupdocs/api/helpers/mime_helper.rb +21 -21
  110. data/lib/groupdocs/api/helpers/path_helper.rb +28 -28
  111. data/lib/groupdocs/api/helpers/rest_helper.rb +99 -99
  112. data/lib/groupdocs/api/helpers/signature_public_helper.rb +22 -22
  113. data/lib/groupdocs/api/helpers/status_helper.rb +27 -27
  114. data/lib/groupdocs/api/helpers/url_helper.rb +101 -101
  115. data/lib/groupdocs/api/request.rb +91 -91
  116. data/lib/groupdocs/datasource.rb +249 -249
  117. data/lib/groupdocs/datasource/field.rb +39 -39
  118. data/lib/groupdocs/document.rb +1550 -1550
  119. data/lib/groupdocs/document/annotation.rb +421 -421
  120. data/lib/groupdocs/document/annotation/reply.rb +173 -173
  121. data/lib/groupdocs/document/annotation/reviewer.rb +66 -66
  122. data/lib/groupdocs/document/change.rb +56 -56
  123. data/lib/groupdocs/document/field.rb +53 -53
  124. data/lib/groupdocs/document/metadata.rb +32 -32
  125. data/lib/groupdocs/document/rectangle.rb +18 -18
  126. data/lib/groupdocs/document/view.rb +36 -36
  127. data/lib/groupdocs/errors.rb +8 -8
  128. data/lib/groupdocs/job.rb +468 -468
  129. data/lib/groupdocs/questionnaire.rb +530 -530
  130. data/lib/groupdocs/questionnaire/collector.rb +335 -335
  131. data/lib/groupdocs/questionnaire/execution.rb +181 -181
  132. data/lib/groupdocs/questionnaire/page.rb +43 -43
  133. data/lib/groupdocs/questionnaire/question.rb +108 -108
  134. data/lib/groupdocs/questionnaire/question/answer.rb +15 -15
  135. data/lib/groupdocs/signature.rb +380 -380
  136. data/lib/groupdocs/signature/contact.rb +181 -181
  137. data/lib/groupdocs/signature/envelope.rb +747 -747
  138. data/lib/groupdocs/signature/envelope/log.rb +20 -20
  139. data/lib/groupdocs/signature/field.rb +286 -286
  140. data/lib/groupdocs/signature/field/location.rb +71 -71
  141. data/lib/groupdocs/signature/form.rb +804 -804
  142. data/lib/groupdocs/signature/list.rb +92 -92
  143. data/lib/groupdocs/signature/recipient.rb +79 -79
  144. data/lib/groupdocs/signature/role.rb +54 -54
  145. data/lib/groupdocs/signature/shared.rb +6 -6
  146. data/lib/groupdocs/signature/shared/document_methods.rb +158 -158
  147. data/lib/groupdocs/signature/shared/entity_fields.rb +76 -76
  148. data/lib/groupdocs/signature/shared/entity_methods.rb +144 -144
  149. data/lib/groupdocs/signature/shared/field_methods.rb +354 -354
  150. data/lib/groupdocs/signature/shared/recipient_methods.rb +75 -75
  151. data/lib/groupdocs/signature/shared/resource_methods.rb +65 -65
  152. data/lib/groupdocs/signature/template.rb +124 -124
  153. data/lib/groupdocs/storage.rb +44 -44
  154. data/lib/groupdocs/storage/file.rb +432 -432
  155. data/lib/groupdocs/storage/folder.rb +288 -288
  156. data/lib/groupdocs/storage/package.rb +48 -48
  157. data/lib/groupdocs/storage/provider.rb +32 -32
  158. data/lib/groupdocs/subscription.rb +323 -323
  159. data/lib/groupdocs/subscription/limit.rb +20 -20
  160. data/lib/groupdocs/user.rb +955 -930
  161. data/lib/groupdocs/version.rb +3 -3
  162. data/spec/groupdocs/api/entity_spec.rb +55 -55
  163. data/spec/groupdocs/api/helpers/access_mode_helper_spec.rb +21 -21
  164. data/spec/groupdocs/api/helpers/access_rights_helper_spec.rb +43 -43
  165. data/spec/groupdocs/api/helpers/accessor_helper_spec.rb +16 -16
  166. data/spec/groupdocs/api/helpers/byte_flag_helper_spec.rb +23 -23
  167. data/spec/groupdocs/api/helpers/credentials_helpers_spec.rb +48 -48
  168. data/spec/groupdocs/api/helpers/mime_helper_spec.rb +16 -16
  169. data/spec/groupdocs/api/helpers/path_helper_spec.rb +15 -15
  170. data/spec/groupdocs/api/helpers/rest_helper_spec.rb +161 -161
  171. data/spec/groupdocs/api/helpers/signature_public_helper_spec.rb +21 -21
  172. data/spec/groupdocs/api/helpers/status_helper_spec.rb +22 -22
  173. data/spec/groupdocs/api/helpers/url_helper_spec.rb +112 -112
  174. data/spec/groupdocs/api/request_spec.rb +112 -112
  175. data/spec/groupdocs/datasource/field_spec.rb +29 -29
  176. data/spec/groupdocs/datasource_spec.rb +145 -145
  177. data/spec/groupdocs/document/annotation/reply_spec.rb +154 -154
  178. data/spec/groupdocs/document/annotation/reviewer_spec.rb +51 -51
  179. data/spec/groupdocs/document/annotation_spec.rb +234 -234
  180. data/spec/groupdocs/document/change_spec.rb +39 -39
  181. data/spec/groupdocs/document/field_spec.rb +28 -28
  182. data/spec/groupdocs/document/metadata_spec.rb +21 -21
  183. data/spec/groupdocs/document/rectangle_spec.rb +14 -14
  184. data/spec/groupdocs/document/view_spec.rb +33 -33
  185. data/spec/groupdocs/document_spec.rb +859 -859
  186. data/spec/groupdocs/errors_spec.rb +7 -7
  187. data/spec/groupdocs/job_spec.rb +323 -323
  188. data/spec/groupdocs/questionnaire/collector_spec.rb +197 -197
  189. data/spec/groupdocs/questionnaire/execution_spec.rb +162 -162
  190. data/spec/groupdocs/questionnaire/page_spec.rb +47 -47
  191. data/spec/groupdocs/questionnaire/question/answer_spec.rb +9 -9
  192. data/spec/groupdocs/questionnaire/question_spec.rb +75 -75
  193. data/spec/groupdocs/questionnaire_spec.rb +295 -295
  194. data/spec/groupdocs/signature/contact_spec.rb +142 -142
  195. data/spec/groupdocs/signature/envelope/log_spec.rb +15 -15
  196. data/spec/groupdocs/signature/envelope_spec.rb +384 -384
  197. data/spec/groupdocs/signature/field/location_spec.rb +40 -40
  198. data/spec/groupdocs/signature/field_spec.rb +235 -235
  199. data/spec/groupdocs/signature/form_spec.rb +205 -205
  200. data/spec/groupdocs/signature/list_spec.rb +87 -87
  201. data/spec/groupdocs/signature/recipient_spec.rb +26 -26
  202. data/spec/groupdocs/signature/role_spec.rb +47 -47
  203. data/spec/groupdocs/signature/template_spec.rb +80 -80
  204. data/spec/groupdocs/signature_spec.rb +194 -194
  205. data/spec/groupdocs/storage/file_spec.rb +303 -303
  206. data/spec/groupdocs/storage/folder_spec.rb +270 -270
  207. data/spec/groupdocs/storage/package_spec.rb +38 -38
  208. data/spec/groupdocs/storage/provider_spec.rb +21 -21
  209. data/spec/groupdocs/storage_spec.rb +27 -27
  210. data/spec/groupdocs/subscription/limit_spec.rb +16 -16
  211. data/spec/groupdocs/subscription_spec.rb +74 -74
  212. data/spec/groupdocs/user_spec.rb +257 -257
  213. data/spec/groupdocs_spec.rb +63 -63
  214. data/spec/spec_helper.rb +73 -73
  215. data/spec/support/json/annotation_access_set.json +11 -11
  216. data/spec/support/json/annotation_collaborators_get.json +16 -16
  217. data/spec/support/json/annotation_collaborators_set.json +16 -16
  218. data/spec/support/json/annotation_create.json +12 -12
  219. data/spec/support/json/annotation_list.json +32 -32
  220. data/spec/support/json/annotation_marker_move.json +10 -10
  221. data/spec/support/json/annotation_move.json +8 -8
  222. data/spec/support/json/annotation_remove.json +9 -9
  223. data/spec/support/json/annotation_replies_create.json +9 -9
  224. data/spec/support/json/annotation_replies_get.json +25 -25
  225. data/spec/support/json/annotation_reviewers_get.json +18 -18
  226. data/spec/support/json/comparison_changes.json +46 -46
  227. data/spec/support/json/comparison_compare.json +8 -8
  228. data/spec/support/json/comparison_document.json +10 -10
  229. data/spec/support/json/contact_add.json +12 -12
  230. data/spec/support/json/contacts_get.json +19 -19
  231. data/spec/support/json/contacts_import.json +8 -8
  232. data/spec/support/json/datasource_add.json +8 -8
  233. data/spec/support/json/datasource_get.json +22 -22
  234. data/spec/support/json/datasource_remove.json +8 -8
  235. data/spec/support/json/datasource_update.json +8 -8
  236. data/spec/support/json/delete_account.json +9 -9
  237. data/spec/support/json/document_access_info_get.json +14 -14
  238. data/spec/support/json/document_convert.json +8 -8
  239. data/spec/support/json/document_datasource.json +10 -10
  240. data/spec/support/json/document_fields.json +34 -34
  241. data/spec/support/json/document_formats.json +8 -8
  242. data/spec/support/json/document_metadata.json +15 -15
  243. data/spec/support/json/document_page_images_get.json +20 -20
  244. data/spec/support/json/document_questionnaire_create.json +9 -9
  245. data/spec/support/json/document_questionnaires.json +23 -23
  246. data/spec/support/json/document_sharers_remove.json +8 -8
  247. data/spec/support/json/document_sharers_set.json +16 -16
  248. data/spec/support/json/document_thumbnails.json +24 -24
  249. data/spec/support/json/document_views.json +32 -32
  250. data/spec/support/json/envelope_get.json +46 -46
  251. data/spec/support/json/envelope_logs.json +16 -16
  252. data/spec/support/json/envelope_recipient_add.json +26 -26
  253. data/spec/support/json/envelopes_all.json +48 -48
  254. data/spec/support/json/envelopes_resources.json +31 -31
  255. data/spec/support/json/file_compress.json +8 -8
  256. data/spec/support/json/file_copy.json +14 -14
  257. data/spec/support/json/file_delete.json +5 -5
  258. data/spec/support/json/file_move.json +14 -14
  259. data/spec/support/json/file_upload.json +8 -8
  260. data/spec/support/json/folder_create.json +8 -8
  261. data/spec/support/json/folder_delete.json +5 -5
  262. data/spec/support/json/folder_list.json +22 -22
  263. data/spec/support/json/folder_move.json +8 -8
  264. data/spec/support/json/folder_sharers_get.json +16 -16
  265. data/spec/support/json/folder_sharers_remove.json +8 -8
  266. data/spec/support/json/folder_sharers_set.json +16 -16
  267. data/spec/support/json/form_get.json +21 -21
  268. data/spec/support/json/forms_all.json +23 -23
  269. data/spec/support/json/job_add_url.json +8 -8
  270. data/spec/support/json/job_create.json +8 -8
  271. data/spec/support/json/job_documents.json +40 -40
  272. data/spec/support/json/job_file_add.json +8 -8
  273. data/spec/support/json/job_get.json +30 -30
  274. data/spec/support/json/job_update.json +7 -7
  275. data/spec/support/json/jobs_get.json +58 -58
  276. data/spec/support/json/list_add.json +12 -12
  277. data/spec/support/json/lists_get.json +19 -19
  278. data/spec/support/json/package_create.json +7 -7
  279. data/spec/support/json/questionnaire_collector.json +17 -17
  280. data/spec/support/json/questionnaire_collectors.json +38 -38
  281. data/spec/support/json/questionnaire_collectors_add.json +10 -10
  282. data/spec/support/json/questionnaire_create.json +10 -10
  283. data/spec/support/json/questionnaire_datasources.json +26 -26
  284. data/spec/support/json/questionnaire_execution_add.json +9 -9
  285. data/spec/support/json/questionnaire_execution_status_set.json +8 -8
  286. data/spec/support/json/questionnaire_execution_update.json +8 -8
  287. data/spec/support/json/questionnaire_executions.json +28 -28
  288. data/spec/support/json/questionnaire_get.json +17 -17
  289. data/spec/support/json/questionnaire_remove.json +8 -8
  290. data/spec/support/json/questionnaire_update.json +8 -8
  291. data/spec/support/json/questionnaires_get.json +40 -40
  292. data/spec/support/json/sign_documents.json +16 -16
  293. data/spec/support/json/signature_create.json +12 -12
  294. data/spec/support/json/signature_field_add.json +25 -25
  295. data/spec/support/json/signature_fields_get.json +27 -27
  296. data/spec/support/json/signature_roles_get.json +17 -17
  297. data/spec/support/json/signatures_get.json +19 -19
  298. data/spec/support/json/storage_info.json +10 -10
  299. data/spec/support/json/subscription_plan_get.json +9 -9
  300. data/spec/support/json/subscription_plans_get.json +17 -17
  301. data/spec/support/json/template_get.json +35 -35
  302. data/spec/support/json/template_get_documents.json +15 -15
  303. data/spec/support/json/template_get_recipients.json +20 -20
  304. data/spec/support/json/templates_all.json +37 -37
  305. data/spec/support/json/templates_get.json +21 -21
  306. data/spec/support/json/update_account.json +10 -10
  307. data/spec/support/json/user_area.json +67 -67
  308. data/spec/support/json/user_embed_key.json +38 -38
  309. data/spec/support/json/user_get_embed_key.json +67 -67
  310. data/spec/support/json/user_login.json +67 -67
  311. data/spec/support/json/user_profile_get.json +24 -24
  312. data/spec/support/json/user_providers.json +31 -31
  313. data/spec/support/json/user_roles.json +25 -25
  314. data/spec/support/json/user_users_get.json +27 -27
  315. data/spec/support/shared_examples/api/entity.rb +39 -39
  316. data/spec/support/shared_examples/api/helpers/access_mode_helper.rb +11 -11
  317. data/spec/support/shared_examples/api/helpers/status_helper.rb +11 -11
  318. data/spec/support/shared_examples/signature/shared/document_methods.rb +68 -68
  319. data/spec/support/shared_examples/signature/shared/entity_fields.rb +56 -56
  320. data/spec/support/shared_examples/signature/shared/entity_methods.rb +116 -116
  321. data/spec/support/shared_examples/signature/shared/field_methods.rb +220 -220
  322. data/spec/support/shared_examples/signature/shared/recipient_methods.rb +46 -46
  323. data/spec/support/shared_examples/signature/shared/resource_methods.rb +46 -46
  324. metadata +35 -55
@@ -1,550 +1,550 @@
1
- <!DOCTYPE html>
2
-
3
- <html>
4
- <head>
5
- <title>sample25.rb</title>
6
- <meta http-equiv="content-type" content="text/html; charset=UTF-8">
7
- <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
8
- <link rel="stylesheet" media="all" href="docco.css" />
9
- </head>
10
- <body>
11
- <div id="container">
12
- <div id="background"></div>
13
-
14
- <ul class="sections">
15
-
16
- <li id="title">
17
- <div class="annotation">
18
- <h1>sample25.rb</h1>
19
- </div>
20
- </li>
21
-
22
-
23
-
24
- <li id="section-1">
25
- <div class="annotation">
26
-
27
- <div class="pilwrap ">
28
- <a class="pilcrow" href="#section-1">&#182;</a>
29
- </div>
30
- <p>GET request</p>
31
-
32
- </div>
33
-
34
- <div class="content"><div class='highlight'><pre>get <span class="hljs-string">'/sample-25-how-to-merge-assemble-and-convert-document'</span> <span class="hljs-keyword">do</span>
35
- haml <span class="hljs-symbol">:sample25</span>
36
- <span class="hljs-keyword">end</span></pre></div></div>
37
-
38
- </li>
39
-
40
-
41
- <li id="section-2">
42
- <div class="annotation">
43
-
44
- <div class="pilwrap ">
45
- <a class="pilcrow" href="#section-2">&#182;</a>
46
- </div>
47
- <p>POST request</p>
48
-
49
- </div>
50
-
51
- <div class="content"><div class='highlight'><pre>post <span class="hljs-string">'/sample-25-how-to-merge-assemble-and-convert-document'</span> <span class="hljs-keyword">do</span></pre></div></div>
52
-
53
- </li>
54
-
55
-
56
- <li id="section-3">
57
- <div class="annotation">
58
-
59
- <div class="pilwrap ">
60
- <a class="pilcrow" href="#section-3">&#182;</a>
61
- </div>
62
- <p>Set variables</p>
63
-
64
- </div>
65
-
66
- <div class="content"><div class='highlight'><pre> set <span class="hljs-symbol">:client_id</span>, params[<span class="hljs-symbol">:clientId</span>]
67
- set <span class="hljs-symbol">:private_key</span>, params[<span class="hljs-symbol">:privateKey</span>]
68
- set <span class="hljs-symbol">:source</span>, params[<span class="hljs-symbol">:source</span>]
69
- set <span class="hljs-symbol">:file_id</span>, params[<span class="hljs-symbol">:fileId</span>]
70
- set <span class="hljs-symbol">:url</span>, params[<span class="hljs-symbol">:url</span>]
71
- set <span class="hljs-symbol">:base_path</span>, params[<span class="hljs-symbol">:basePath</span>]</pre></div></div>
72
-
73
- </li>
74
-
75
-
76
- <li id="section-4">
77
- <div class="annotation">
78
-
79
- <div class="pilwrap ">
80
- <a class="pilcrow" href="#section-4">&#182;</a>
81
- </div>
82
- <p>Set download path</p>
83
-
84
- </div>
85
-
86
- <div class="content"><div class='highlight'><pre> downloads_path = <span class="hljs-string">"<span class="hljs-subst">#{<span class="hljs-constant">File</span>.dirname(__FILE_<span class="hljs-number">_</span>)}</span>/../public/downloads"</span></pre></div></div>
87
-
88
- </li>
89
-
90
-
91
- <li id="section-5">
92
- <div class="annotation">
93
-
94
- <div class="pilwrap ">
95
- <a class="pilcrow" href="#section-5">&#182;</a>
96
- </div>
97
- <p>Remove all files from download directory or create folder if it not there</p>
98
-
99
- </div>
100
-
101
- <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> <span class="hljs-constant">File</span>.directory?(downloads_path)
102
- <span class="hljs-constant">Dir</span>.foreach(downloads_path) { |f| fn = <span class="hljs-constant">File</span>.join(downloads_path, f); <span class="hljs-constant">File</span>.delete(fn) <span class="hljs-keyword">if</span> f != <span class="hljs-string">'.'</span> &amp;&amp; f != <span class="hljs-string">'..'</span> }
103
- <span class="hljs-keyword">else</span>
104
- <span class="hljs-constant">Dir::</span>mkdir(downloads_path)
105
- <span class="hljs-keyword">end</span>
106
-
107
- <span class="hljs-keyword">begin</span></pre></div></div>
108
-
109
- </li>
110
-
111
-
112
- <li id="section-6">
113
- <div class="annotation">
114
-
115
- <div class="pilwrap ">
116
- <a class="pilcrow" href="#section-6">&#182;</a>
117
- </div>
118
- <p>Check required variables</p>
119
-
120
- </div>
121
-
122
- <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?</pre></div></div>
123
-
124
- </li>
125
-
126
-
127
- <li id="section-7">
128
- <div class="annotation">
129
-
130
- <div class="pilwrap ">
131
- <a class="pilcrow" href="#section-7">&#182;</a>
132
- </div>
133
- <p>Prepare base path</p>
134
-
135
- </div>
136
-
137
- <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> settings.base_path.empty?
138
- base_path = <span class="hljs-string">'https://api.groupdocs.com'</span>
139
- <span class="hljs-keyword">elsif</span> settings.base_path.match(<span class="hljs-string">'/v2.0'</span>)
140
- base_path = settings.base_path.split(<span class="hljs-string">'/v2.0'</span>)[<span class="hljs-number">0</span>]
141
- <span class="hljs-keyword">else</span>
142
- base_path = settings.base_path
143
- <span class="hljs-keyword">end</span></pre></div></div>
144
-
145
- </li>
146
-
147
-
148
- <li id="section-8">
149
- <div class="annotation">
150
-
151
- <div class="pilwrap ">
152
- <a class="pilcrow" href="#section-8">&#182;</a>
153
- </div>
154
- <p>Configure your access to API server</p>
155
-
156
- </div>
157
-
158
- <div class="content"><div class='highlight'><pre> <span class="hljs-constant">GroupDocs</span>.configure <span class="hljs-keyword">do</span> |groupdocs|
159
- groupdocs.client_id = settings.client_id
160
- groupdocs.private_key = settings.private_key</pre></div></div>
161
-
162
- </li>
163
-
164
-
165
- <li id="section-9">
166
- <div class="annotation">
167
-
168
- <div class="pilwrap ">
169
- <a class="pilcrow" href="#section-9">&#182;</a>
170
- </div>
171
- <p>Optionally specify API server and version</p>
172
-
173
- </div>
174
-
175
- <div class="content"><div class='highlight'><pre> groupdocs.api_server = base_path <span class="hljs-comment"># default is 'https://api.groupdocs.com'</span>
176
- <span class="hljs-keyword">end</span></pre></div></div>
177
-
178
- </li>
179
-
180
-
181
- <li id="section-10">
182
- <div class="annotation">
183
-
184
- <div class="pilwrap ">
185
- <a class="pilcrow" href="#section-10">&#182;</a>
186
- </div>
187
- <p>Get document by file GUID</p>
188
-
189
- </div>
190
-
191
- <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">case</span> settings.source
192
- <span class="hljs-keyword">when</span> <span class="hljs-string">'guid'</span></pre></div></div>
193
-
194
- </li>
195
-
196
-
197
- <li id="section-11">
198
- <div class="annotation">
199
-
200
- <div class="pilwrap ">
201
- <a class="pilcrow" href="#section-11">&#182;</a>
202
- </div>
203
- <p>Create instance of File</p>
204
-
205
- </div>
206
-
207
- <div class="content"><div class='highlight'><pre> file = <span class="hljs-constant">GroupDocs::Storage::File</span>.new({<span class="hljs-symbol">:guid</span> =&gt; settings.file_id})
208
- <span class="hljs-keyword">when</span> <span class="hljs-string">'local'</span></pre></div></div>
209
-
210
- </li>
211
-
212
-
213
- <li id="section-12">
214
- <div class="annotation">
215
-
216
- <div class="pilwrap ">
217
- <a class="pilcrow" href="#section-12">&#182;</a>
218
- </div>
219
- <p>Construct path</p>
220
-
221
- </div>
222
-
223
- <div class="content"><div class='highlight'><pre> file_path = <span class="hljs-string">"<span class="hljs-subst">#{<span class="hljs-constant">Dir</span>.tmpdir}</span>/<span class="hljs-subst">#{params[<span class="hljs-symbol">:file</span>][<span class="hljs-symbol">:filename</span>]}</span>"</span></pre></div></div>
224
-
225
- </li>
226
-
227
-
228
- <li id="section-13">
229
- <div class="annotation">
230
-
231
- <div class="pilwrap ">
232
- <a class="pilcrow" href="#section-13">&#182;</a>
233
- </div>
234
- <p>Open file</p>
235
-
236
- </div>
237
-
238
- <div class="content"><div class='highlight'><pre> <span class="hljs-constant">File</span>.open(file_path, <span class="hljs-string">'wb'</span>) { |f| f.write(params[<span class="hljs-symbol">:file</span>][<span class="hljs-symbol">:tempfile</span>].read) }</pre></div></div>
239
-
240
- </li>
241
-
242
-
243
- <li id="section-14">
244
- <div class="annotation">
245
-
246
- <div class="pilwrap ">
247
- <a class="pilcrow" href="#section-14">&#182;</a>
248
- </div>
249
- <p>Make a request to API using client_id and private_key</p>
250
-
251
- </div>
252
-
253
- <div class="content"><div class='highlight'><pre> file = <span class="hljs-constant">GroupDocs::Storage::File</span>.upload!(file_path, {})
254
- <span class="hljs-keyword">when</span> <span class="hljs-string">'url'</span></pre></div></div>
255
-
256
- </li>
257
-
258
-
259
- <li id="section-15">
260
- <div class="annotation">
261
-
262
- <div class="pilwrap ">
263
- <a class="pilcrow" href="#section-15">&#182;</a>
264
- </div>
265
- <p>Upload file from defined url</p>
266
-
267
- </div>
268
-
269
- <div class="content"><div class='highlight'><pre> file = <span class="hljs-constant">GroupDocs::Storage::File</span>.upload_web!(settings.url)
270
- <span class="hljs-keyword">else</span>
271
- raise <span class="hljs-string">'Wrong GUID source.'</span>
272
- <span class="hljs-keyword">end</span></pre></div></div>
273
-
274
- </li>
275
-
276
-
277
- <li id="section-16">
278
- <div class="annotation">
279
-
280
- <div class="pilwrap ">
281
- <a class="pilcrow" href="#section-16">&#182;</a>
282
- </div>
283
- <p>Raise exception if something went wrong</p>
284
-
285
- </div>
286
-
287
- <div class="content"><div class='highlight'><pre> raise <span class="hljs-string">'No such file'</span> <span class="hljs-keyword">unless</span> file.is_a?(<span class="hljs-constant">GroupDocs::Storage::File</span>)</pre></div></div>
288
-
289
- </li>
290
-
291
-
292
- <li id="section-17">
293
- <div class="annotation">
294
-
295
- <div class="pilwrap ">
296
- <a class="pilcrow" href="#section-17">&#182;</a>
297
- </div>
298
- <p>Make GroupDocs::Storage::Document instance</p>
299
-
300
- </div>
301
-
302
- <div class="content"><div class='highlight'><pre> document = file.to_document</pre></div></div>
303
-
304
- </li>
305
-
306
-
307
- <li id="section-18">
308
- <div class="annotation">
309
-
310
- <div class="pilwrap ">
311
- <a class="pilcrow" href="#section-18">&#182;</a>
312
- </div>
313
- <p>Create datasource with fields</p>
314
-
315
- </div>
316
-
317
- <div class="content"><div class='highlight'><pre> datasource = <span class="hljs-constant">GroupDocs::DataSource</span>.new</pre></div></div>
318
-
319
- </li>
320
-
321
-
322
- <li id="section-19">
323
- <div class="annotation">
324
-
325
- <div class="pilwrap ">
326
- <a class="pilcrow" href="#section-19">&#182;</a>
327
- </div>
328
- <p>Get arry of document’s fields</p>
329
-
330
- </div>
331
-
332
- <div class="content"><div class='highlight'><pre> fields = document.fields!()</pre></div></div>
333
-
334
- </li>
335
-
336
-
337
- <li id="section-20">
338
- <div class="annotation">
339
-
340
- <div class="pilwrap ">
341
- <a class="pilcrow" href="#section-20">&#182;</a>
342
- </div>
343
- <p>Create Field instance and fill the fields</p>
344
-
345
- </div>
346
-
347
- <div class="content"><div class='highlight'><pre> datasource.fields = fields.map { |field| <span class="hljs-constant">GroupDocs::DataSource::Field</span>.new(<span class="hljs-symbol">name:</span> field.name, <span class="hljs-symbol">type:</span> <span class="hljs-symbol">:text</span>, <span class="hljs-symbol">values:</span> <span class="hljs-string">%w(value1 value2)</span>) }</pre></div></div>
348
-
349
- </li>
350
-
351
-
352
- <li id="section-21">
353
- <div class="annotation">
354
-
355
- <div class="pilwrap ">
356
- <a class="pilcrow" href="#section-21">&#182;</a>
357
- </div>
358
- <p>Adds datasource.</p>
359
-
360
- </div>
361
-
362
- <div class="content"><div class='highlight'><pre> datasource.add!()</pre></div></div>
363
-
364
- </li>
365
-
366
-
367
- <li id="section-22">
368
- <div class="annotation">
369
-
370
- <div class="pilwrap ">
371
- <a class="pilcrow" href="#section-22">&#182;</a>
372
- </div>
373
- <p>Creates new job to merge datasource into document.</p>
374
-
375
- </div>
376
-
377
- <div class="content"><div class='highlight'><pre> job = document.datasource!(datasource, {<span class="hljs-symbol">:new_type</span> =&gt; <span class="hljs-string">'pdf'</span>})
378
- sleep <span class="hljs-number">10</span> <span class="hljs-comment"># wait for merge and convert</span></pre></div></div>
379
-
380
- </li>
381
-
382
-
383
- <li id="section-23">
384
- <div class="annotation">
385
-
386
- <div class="pilwrap ">
387
- <a class="pilcrow" href="#section-23">&#182;</a>
388
- </div>
389
- <p>Returns an hash of input and output documents associated to job.</p>
390
-
391
- </div>
392
-
393
- <div class="content"><div class='highlight'><pre> document = job.documents!()</pre></div></div>
394
-
395
- </li>
396
-
397
-
398
- <li id="section-24">
399
- <div class="annotation">
400
-
401
- <div class="pilwrap ">
402
- <a class="pilcrow" href="#section-24">&#182;</a>
403
- </div>
404
- <p>Download file</p>
405
-
406
- </div>
407
-
408
- <div class="content"><div class='highlight'><pre> document[<span class="hljs-symbol">:inputs</span>][<span class="hljs-number">0</span>].outputs[<span class="hljs-number">0</span>].download!(<span class="hljs-string">"<span class="hljs-subst">#{<span class="hljs-constant">File</span>.dirname(__FILE_<span class="hljs-number">_</span>)}</span>/../public/downloads"</span>)</pre></div></div>
409
-
410
- </li>
411
-
412
-
413
- <li id="section-25">
414
- <div class="annotation">
415
-
416
- <div class="pilwrap ">
417
- <a class="pilcrow" href="#section-25">&#182;</a>
418
- </div>
419
- <p>Set converted document GUID</p>
420
-
421
- </div>
422
-
423
- <div class="content"><div class='highlight'><pre> guid = document[<span class="hljs-symbol">:inputs</span>][<span class="hljs-number">0</span>].outputs[<span class="hljs-number">0</span>].guid</pre></div></div>
424
-
425
- </li>
426
-
427
-
428
- <li id="section-26">
429
- <div class="annotation">
430
-
431
- <div class="pilwrap ">
432
- <a class="pilcrow" href="#section-26">&#182;</a>
433
- </div>
434
- <p>Set converted document Name</p>
435
-
436
- </div>
437
-
438
- <div class="content"><div class='highlight'><pre> file_name = document[<span class="hljs-symbol">:inputs</span>][<span class="hljs-number">0</span>].outputs[<span class="hljs-number">0</span>].name</pre></div></div>
439
-
440
- </li>
441
-
442
-
443
- <li id="section-27">
444
- <div class="annotation">
445
-
446
- <div class="pilwrap ">
447
- <a class="pilcrow" href="#section-27">&#182;</a>
448
- </div>
449
- <p>Prepare to sign url</p>
450
-
451
- </div>
452
-
453
- <div class="content"><div class='highlight'><pre> iframe = <span class="hljs-string">"/document-viewer/embed/<span class="hljs-subst">#{guid}</span>"</span></pre></div></div>
454
-
455
- </li>
456
-
457
-
458
- <li id="section-28">
459
- <div class="annotation">
460
-
461
- <div class="pilwrap ">
462
- <a class="pilcrow" href="#section-28">&#182;</a>
463
- </div>
464
- <p>Construct result string</p>
465
-
466
- </div>
467
-
468
- <div class="content"><div class='highlight'><pre> url = <span class="hljs-constant">GroupDocs::Api::Request</span>.new(<span class="hljs-symbol">:path</span> =&gt; iframe).prepare_and_sign_url</pre></div></div>
469
-
470
- </li>
471
-
472
-
473
- <li id="section-29">
474
- <div class="annotation">
475
-
476
- <div class="pilwrap ">
477
- <a class="pilcrow" href="#section-29">&#182;</a>
478
- </div>
479
- <p>Generate iframe URL</p>
480
-
481
- </div>
482
-
483
- <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">case</span> base_path
484
- <span class="hljs-keyword">when</span> <span class="hljs-string">'https://stage-api-groupdocs.dynabic.com'</span>
485
- iframe = <span class="hljs-string">"https://stage-api-groupdocs.dynabic.com<span class="hljs-subst">#{url}</span>"</span>
486
- <span class="hljs-keyword">when</span> <span class="hljs-string">'https://dev-api-groupdocs.dynabic.com'</span>
487
- iframe = <span class="hljs-string">"https://dev-apps.groupdocs.com<span class="hljs-subst">#{url}</span>"</span>
488
- <span class="hljs-keyword">else</span>
489
- iframe = <span class="hljs-string">"https://apps.groupdocs.com<span class="hljs-subst">#{url}</span>"</span>
490
- <span class="hljs-keyword">end</span></pre></div></div>
491
-
492
- </li>
493
-
494
-
495
- <li id="section-30">
496
- <div class="annotation">
497
-
498
- <div class="pilwrap ">
499
- <a class="pilcrow" href="#section-30">&#182;</a>
500
- </div>
501
- <p>Set iframe with document GUID or raise an error</p>
502
-
503
- </div>
504
-
505
- <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> guid</pre></div></div>
506
-
507
- </li>
508
-
509
-
510
- <li id="section-31">
511
- <div class="annotation">
512
-
513
- <div class="pilwrap ">
514
- <a class="pilcrow" href="#section-31">&#182;</a>
515
- </div>
516
- <p>Make iframe</p>
517
-
518
- </div>
519
-
520
- <div class="content"><div class='highlight'><pre> iframe = <span class="hljs-string">"&lt;iframe id='downloadframe' src='<span class="hljs-subst">#{iframe}</span>' width='800' height='1000'&gt;&lt;/iframe&gt;"</span>
521
- <span class="hljs-keyword">else</span>
522
- raise <span class="hljs-string">'File was not converted'</span>
523
- <span class="hljs-keyword">end</span>
524
-
525
- <span class="hljs-keyword">rescue</span> <span class="hljs-constant">Exception</span> =&gt; e
526
- err = e.message
527
- <span class="hljs-keyword">end</span></pre></div></div>
528
-
529
- </li>
530
-
531
-
532
- <li id="section-32">
533
- <div class="annotation">
534
-
535
- <div class="pilwrap ">
536
- <a class="pilcrow" href="#section-32">&#182;</a>
537
- </div>
538
- <p>Set variables for template</p>
539
-
540
- </div>
541
-
542
- <div class="content"><div class='highlight'><pre> haml <span class="hljs-symbol">:sample25</span>, <span class="hljs-symbol">:locals</span> =&gt; {<span class="hljs-symbol">:userId</span> =&gt; settings.client_id, <span class="hljs-symbol">:privateKey</span> =&gt; settings.private_key, <span class="hljs-symbol">:iframe</span> =&gt; iframe, <span class="hljs-symbol">:fileName</span> =&gt; file_name, <span class="hljs-symbol">:err</span> =&gt; err}
543
- <span class="hljs-keyword">end</span></pre></div></div>
544
-
545
- </li>
546
-
547
- </ul>
548
- </div>
549
- </body>
550
- </html>
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <title>sample25.rb</title>
6
+ <meta http-equiv="content-type" content="text/html; charset=UTF-8">
7
+ <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
8
+ <link rel="stylesheet" media="all" href="docco.css" />
9
+ </head>
10
+ <body>
11
+ <div id="container">
12
+ <div id="background"></div>
13
+
14
+ <ul class="sections">
15
+
16
+ <li id="title">
17
+ <div class="annotation">
18
+ <h1>sample25.rb</h1>
19
+ </div>
20
+ </li>
21
+
22
+
23
+
24
+ <li id="section-1">
25
+ <div class="annotation">
26
+
27
+ <div class="pilwrap ">
28
+ <a class="pilcrow" href="#section-1">&#182;</a>
29
+ </div>
30
+ <p>GET request</p>
31
+
32
+ </div>
33
+
34
+ <div class="content"><div class='highlight'><pre>get <span class="hljs-string">'/sample-25-how-to-merge-assemble-and-convert-document'</span> <span class="hljs-keyword">do</span>
35
+ haml <span class="hljs-symbol">:sample25</span>
36
+ <span class="hljs-keyword">end</span></pre></div></div>
37
+
38
+ </li>
39
+
40
+
41
+ <li id="section-2">
42
+ <div class="annotation">
43
+
44
+ <div class="pilwrap ">
45
+ <a class="pilcrow" href="#section-2">&#182;</a>
46
+ </div>
47
+ <p>POST request</p>
48
+
49
+ </div>
50
+
51
+ <div class="content"><div class='highlight'><pre>post <span class="hljs-string">'/sample-25-how-to-merge-assemble-and-convert-document'</span> <span class="hljs-keyword">do</span></pre></div></div>
52
+
53
+ </li>
54
+
55
+
56
+ <li id="section-3">
57
+ <div class="annotation">
58
+
59
+ <div class="pilwrap ">
60
+ <a class="pilcrow" href="#section-3">&#182;</a>
61
+ </div>
62
+ <p>Set variables</p>
63
+
64
+ </div>
65
+
66
+ <div class="content"><div class='highlight'><pre> set <span class="hljs-symbol">:client_id</span>, params[<span class="hljs-symbol">:clientId</span>]
67
+ set <span class="hljs-symbol">:private_key</span>, params[<span class="hljs-symbol">:privateKey</span>]
68
+ set <span class="hljs-symbol">:source</span>, params[<span class="hljs-symbol">:source</span>]
69
+ set <span class="hljs-symbol">:file_id</span>, params[<span class="hljs-symbol">:fileId</span>]
70
+ set <span class="hljs-symbol">:url</span>, params[<span class="hljs-symbol">:url</span>]
71
+ set <span class="hljs-symbol">:base_path</span>, params[<span class="hljs-symbol">:basePath</span>]</pre></div></div>
72
+
73
+ </li>
74
+
75
+
76
+ <li id="section-4">
77
+ <div class="annotation">
78
+
79
+ <div class="pilwrap ">
80
+ <a class="pilcrow" href="#section-4">&#182;</a>
81
+ </div>
82
+ <p>Set download path</p>
83
+
84
+ </div>
85
+
86
+ <div class="content"><div class='highlight'><pre> downloads_path = <span class="hljs-string">"<span class="hljs-subst">#{<span class="hljs-constant">File</span>.dirname(__FILE_<span class="hljs-number">_</span>)}</span>/../public/downloads"</span></pre></div></div>
87
+
88
+ </li>
89
+
90
+
91
+ <li id="section-5">
92
+ <div class="annotation">
93
+
94
+ <div class="pilwrap ">
95
+ <a class="pilcrow" href="#section-5">&#182;</a>
96
+ </div>
97
+ <p>Remove all files from download directory or create folder if it not there</p>
98
+
99
+ </div>
100
+
101
+ <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> <span class="hljs-constant">File</span>.directory?(downloads_path)
102
+ <span class="hljs-constant">Dir</span>.foreach(downloads_path) { |f| fn = <span class="hljs-constant">File</span>.join(downloads_path, f); <span class="hljs-constant">File</span>.delete(fn) <span class="hljs-keyword">if</span> f != <span class="hljs-string">'.'</span> &amp;&amp; f != <span class="hljs-string">'..'</span> }
103
+ <span class="hljs-keyword">else</span>
104
+ <span class="hljs-constant">Dir::</span>mkdir(downloads_path)
105
+ <span class="hljs-keyword">end</span>
106
+
107
+ <span class="hljs-keyword">begin</span></pre></div></div>
108
+
109
+ </li>
110
+
111
+
112
+ <li id="section-6">
113
+ <div class="annotation">
114
+
115
+ <div class="pilwrap ">
116
+ <a class="pilcrow" href="#section-6">&#182;</a>
117
+ </div>
118
+ <p>Check required variables</p>
119
+
120
+ </div>
121
+
122
+ <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?</pre></div></div>
123
+
124
+ </li>
125
+
126
+
127
+ <li id="section-7">
128
+ <div class="annotation">
129
+
130
+ <div class="pilwrap ">
131
+ <a class="pilcrow" href="#section-7">&#182;</a>
132
+ </div>
133
+ <p>Prepare base path</p>
134
+
135
+ </div>
136
+
137
+ <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> settings.base_path.empty?
138
+ base_path = <span class="hljs-string">'https://api.groupdocs.com'</span>
139
+ <span class="hljs-keyword">elsif</span> settings.base_path.match(<span class="hljs-string">'/v2.0'</span>)
140
+ base_path = settings.base_path.split(<span class="hljs-string">'/v2.0'</span>)[<span class="hljs-number">0</span>]
141
+ <span class="hljs-keyword">else</span>
142
+ base_path = settings.base_path
143
+ <span class="hljs-keyword">end</span></pre></div></div>
144
+
145
+ </li>
146
+
147
+
148
+ <li id="section-8">
149
+ <div class="annotation">
150
+
151
+ <div class="pilwrap ">
152
+ <a class="pilcrow" href="#section-8">&#182;</a>
153
+ </div>
154
+ <p>Configure your access to API server</p>
155
+
156
+ </div>
157
+
158
+ <div class="content"><div class='highlight'><pre> <span class="hljs-constant">GroupDocs</span>.configure <span class="hljs-keyword">do</span> |groupdocs|
159
+ groupdocs.client_id = settings.client_id
160
+ groupdocs.private_key = settings.private_key</pre></div></div>
161
+
162
+ </li>
163
+
164
+
165
+ <li id="section-9">
166
+ <div class="annotation">
167
+
168
+ <div class="pilwrap ">
169
+ <a class="pilcrow" href="#section-9">&#182;</a>
170
+ </div>
171
+ <p>Optionally specify API server and version</p>
172
+
173
+ </div>
174
+
175
+ <div class="content"><div class='highlight'><pre> groupdocs.api_server = base_path <span class="hljs-comment"># default is 'https://api.groupdocs.com'</span>
176
+ <span class="hljs-keyword">end</span></pre></div></div>
177
+
178
+ </li>
179
+
180
+
181
+ <li id="section-10">
182
+ <div class="annotation">
183
+
184
+ <div class="pilwrap ">
185
+ <a class="pilcrow" href="#section-10">&#182;</a>
186
+ </div>
187
+ <p>Get document by file GUID</p>
188
+
189
+ </div>
190
+
191
+ <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">case</span> settings.source
192
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'guid'</span></pre></div></div>
193
+
194
+ </li>
195
+
196
+
197
+ <li id="section-11">
198
+ <div class="annotation">
199
+
200
+ <div class="pilwrap ">
201
+ <a class="pilcrow" href="#section-11">&#182;</a>
202
+ </div>
203
+ <p>Create instance of File</p>
204
+
205
+ </div>
206
+
207
+ <div class="content"><div class='highlight'><pre> file = <span class="hljs-constant">GroupDocs::Storage::File</span>.new({<span class="hljs-symbol">:guid</span> =&gt; settings.file_id})
208
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'local'</span></pre></div></div>
209
+
210
+ </li>
211
+
212
+
213
+ <li id="section-12">
214
+ <div class="annotation">
215
+
216
+ <div class="pilwrap ">
217
+ <a class="pilcrow" href="#section-12">&#182;</a>
218
+ </div>
219
+ <p>Construct path</p>
220
+
221
+ </div>
222
+
223
+ <div class="content"><div class='highlight'><pre> file_path = <span class="hljs-string">"<span class="hljs-subst">#{<span class="hljs-constant">Dir</span>.tmpdir}</span>/<span class="hljs-subst">#{params[<span class="hljs-symbol">:file</span>][<span class="hljs-symbol">:filename</span>]}</span>"</span></pre></div></div>
224
+
225
+ </li>
226
+
227
+
228
+ <li id="section-13">
229
+ <div class="annotation">
230
+
231
+ <div class="pilwrap ">
232
+ <a class="pilcrow" href="#section-13">&#182;</a>
233
+ </div>
234
+ <p>Open file</p>
235
+
236
+ </div>
237
+
238
+ <div class="content"><div class='highlight'><pre> <span class="hljs-constant">File</span>.open(file_path, <span class="hljs-string">'wb'</span>) { |f| f.write(params[<span class="hljs-symbol">:file</span>][<span class="hljs-symbol">:tempfile</span>].read) }</pre></div></div>
239
+
240
+ </li>
241
+
242
+
243
+ <li id="section-14">
244
+ <div class="annotation">
245
+
246
+ <div class="pilwrap ">
247
+ <a class="pilcrow" href="#section-14">&#182;</a>
248
+ </div>
249
+ <p>Make a request to API using client_id and private_key</p>
250
+
251
+ </div>
252
+
253
+ <div class="content"><div class='highlight'><pre> file = <span class="hljs-constant">GroupDocs::Storage::File</span>.upload!(file_path, {})
254
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'url'</span></pre></div></div>
255
+
256
+ </li>
257
+
258
+
259
+ <li id="section-15">
260
+ <div class="annotation">
261
+
262
+ <div class="pilwrap ">
263
+ <a class="pilcrow" href="#section-15">&#182;</a>
264
+ </div>
265
+ <p>Upload file from defined url</p>
266
+
267
+ </div>
268
+
269
+ <div class="content"><div class='highlight'><pre> file = <span class="hljs-constant">GroupDocs::Storage::File</span>.upload_web!(settings.url)
270
+ <span class="hljs-keyword">else</span>
271
+ raise <span class="hljs-string">'Wrong GUID source.'</span>
272
+ <span class="hljs-keyword">end</span></pre></div></div>
273
+
274
+ </li>
275
+
276
+
277
+ <li id="section-16">
278
+ <div class="annotation">
279
+
280
+ <div class="pilwrap ">
281
+ <a class="pilcrow" href="#section-16">&#182;</a>
282
+ </div>
283
+ <p>Raise exception if something went wrong</p>
284
+
285
+ </div>
286
+
287
+ <div class="content"><div class='highlight'><pre> raise <span class="hljs-string">'No such file'</span> <span class="hljs-keyword">unless</span> file.is_a?(<span class="hljs-constant">GroupDocs::Storage::File</span>)</pre></div></div>
288
+
289
+ </li>
290
+
291
+
292
+ <li id="section-17">
293
+ <div class="annotation">
294
+
295
+ <div class="pilwrap ">
296
+ <a class="pilcrow" href="#section-17">&#182;</a>
297
+ </div>
298
+ <p>Make GroupDocs::Storage::Document instance</p>
299
+
300
+ </div>
301
+
302
+ <div class="content"><div class='highlight'><pre> document = file.to_document</pre></div></div>
303
+
304
+ </li>
305
+
306
+
307
+ <li id="section-18">
308
+ <div class="annotation">
309
+
310
+ <div class="pilwrap ">
311
+ <a class="pilcrow" href="#section-18">&#182;</a>
312
+ </div>
313
+ <p>Create datasource with fields</p>
314
+
315
+ </div>
316
+
317
+ <div class="content"><div class='highlight'><pre> datasource = <span class="hljs-constant">GroupDocs::DataSource</span>.new</pre></div></div>
318
+
319
+ </li>
320
+
321
+
322
+ <li id="section-19">
323
+ <div class="annotation">
324
+
325
+ <div class="pilwrap ">
326
+ <a class="pilcrow" href="#section-19">&#182;</a>
327
+ </div>
328
+ <p>Get arry of document’s fields</p>
329
+
330
+ </div>
331
+
332
+ <div class="content"><div class='highlight'><pre> fields = document.fields!()</pre></div></div>
333
+
334
+ </li>
335
+
336
+
337
+ <li id="section-20">
338
+ <div class="annotation">
339
+
340
+ <div class="pilwrap ">
341
+ <a class="pilcrow" href="#section-20">&#182;</a>
342
+ </div>
343
+ <p>Create Field instance and fill the fields</p>
344
+
345
+ </div>
346
+
347
+ <div class="content"><div class='highlight'><pre> datasource.fields = fields.map { |field| <span class="hljs-constant">GroupDocs::DataSource::Field</span>.new(<span class="hljs-symbol">name:</span> field.name, <span class="hljs-symbol">type:</span> <span class="hljs-symbol">:text</span>, <span class="hljs-symbol">values:</span> <span class="hljs-string">%w(value1 value2)</span>) }</pre></div></div>
348
+
349
+ </li>
350
+
351
+
352
+ <li id="section-21">
353
+ <div class="annotation">
354
+
355
+ <div class="pilwrap ">
356
+ <a class="pilcrow" href="#section-21">&#182;</a>
357
+ </div>
358
+ <p>Adds datasource.</p>
359
+
360
+ </div>
361
+
362
+ <div class="content"><div class='highlight'><pre> datasource.add!()</pre></div></div>
363
+
364
+ </li>
365
+
366
+
367
+ <li id="section-22">
368
+ <div class="annotation">
369
+
370
+ <div class="pilwrap ">
371
+ <a class="pilcrow" href="#section-22">&#182;</a>
372
+ </div>
373
+ <p>Creates new job to merge datasource into document.</p>
374
+
375
+ </div>
376
+
377
+ <div class="content"><div class='highlight'><pre> job = document.datasource!(datasource, {<span class="hljs-symbol">:new_type</span> =&gt; <span class="hljs-string">'pdf'</span>})
378
+ sleep <span class="hljs-number">10</span> <span class="hljs-comment"># wait for merge and convert</span></pre></div></div>
379
+
380
+ </li>
381
+
382
+
383
+ <li id="section-23">
384
+ <div class="annotation">
385
+
386
+ <div class="pilwrap ">
387
+ <a class="pilcrow" href="#section-23">&#182;</a>
388
+ </div>
389
+ <p>Returns an hash of input and output documents associated to job.</p>
390
+
391
+ </div>
392
+
393
+ <div class="content"><div class='highlight'><pre> document = job.documents!()</pre></div></div>
394
+
395
+ </li>
396
+
397
+
398
+ <li id="section-24">
399
+ <div class="annotation">
400
+
401
+ <div class="pilwrap ">
402
+ <a class="pilcrow" href="#section-24">&#182;</a>
403
+ </div>
404
+ <p>Download file</p>
405
+
406
+ </div>
407
+
408
+ <div class="content"><div class='highlight'><pre> document[<span class="hljs-symbol">:inputs</span>][<span class="hljs-number">0</span>].outputs[<span class="hljs-number">0</span>].download!(<span class="hljs-string">"<span class="hljs-subst">#{<span class="hljs-constant">File</span>.dirname(__FILE_<span class="hljs-number">_</span>)}</span>/../public/downloads"</span>)</pre></div></div>
409
+
410
+ </li>
411
+
412
+
413
+ <li id="section-25">
414
+ <div class="annotation">
415
+
416
+ <div class="pilwrap ">
417
+ <a class="pilcrow" href="#section-25">&#182;</a>
418
+ </div>
419
+ <p>Set converted document GUID</p>
420
+
421
+ </div>
422
+
423
+ <div class="content"><div class='highlight'><pre> guid = document[<span class="hljs-symbol">:inputs</span>][<span class="hljs-number">0</span>].outputs[<span class="hljs-number">0</span>].guid</pre></div></div>
424
+
425
+ </li>
426
+
427
+
428
+ <li id="section-26">
429
+ <div class="annotation">
430
+
431
+ <div class="pilwrap ">
432
+ <a class="pilcrow" href="#section-26">&#182;</a>
433
+ </div>
434
+ <p>Set converted document Name</p>
435
+
436
+ </div>
437
+
438
+ <div class="content"><div class='highlight'><pre> file_name = document[<span class="hljs-symbol">:inputs</span>][<span class="hljs-number">0</span>].outputs[<span class="hljs-number">0</span>].name</pre></div></div>
439
+
440
+ </li>
441
+
442
+
443
+ <li id="section-27">
444
+ <div class="annotation">
445
+
446
+ <div class="pilwrap ">
447
+ <a class="pilcrow" href="#section-27">&#182;</a>
448
+ </div>
449
+ <p>Prepare to sign url</p>
450
+
451
+ </div>
452
+
453
+ <div class="content"><div class='highlight'><pre> iframe = <span class="hljs-string">"/document-viewer/embed/<span class="hljs-subst">#{guid}</span>"</span></pre></div></div>
454
+
455
+ </li>
456
+
457
+
458
+ <li id="section-28">
459
+ <div class="annotation">
460
+
461
+ <div class="pilwrap ">
462
+ <a class="pilcrow" href="#section-28">&#182;</a>
463
+ </div>
464
+ <p>Construct result string</p>
465
+
466
+ </div>
467
+
468
+ <div class="content"><div class='highlight'><pre> url = <span class="hljs-constant">GroupDocs::Api::Request</span>.new(<span class="hljs-symbol">:path</span> =&gt; iframe).prepare_and_sign_url</pre></div></div>
469
+
470
+ </li>
471
+
472
+
473
+ <li id="section-29">
474
+ <div class="annotation">
475
+
476
+ <div class="pilwrap ">
477
+ <a class="pilcrow" href="#section-29">&#182;</a>
478
+ </div>
479
+ <p>Generate iframe URL</p>
480
+
481
+ </div>
482
+
483
+ <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">case</span> base_path
484
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'https://stage-api-groupdocs.dynabic.com'</span>
485
+ iframe = <span class="hljs-string">"https://stage-api-groupdocs.dynabic.com<span class="hljs-subst">#{url}</span>"</span>
486
+ <span class="hljs-keyword">when</span> <span class="hljs-string">'https://dev-api-groupdocs.dynabic.com'</span>
487
+ iframe = <span class="hljs-string">"https://dev-apps.groupdocs.com<span class="hljs-subst">#{url}</span>"</span>
488
+ <span class="hljs-keyword">else</span>
489
+ iframe = <span class="hljs-string">"https://apps.groupdocs.com<span class="hljs-subst">#{url}</span>"</span>
490
+ <span class="hljs-keyword">end</span></pre></div></div>
491
+
492
+ </li>
493
+
494
+
495
+ <li id="section-30">
496
+ <div class="annotation">
497
+
498
+ <div class="pilwrap ">
499
+ <a class="pilcrow" href="#section-30">&#182;</a>
500
+ </div>
501
+ <p>Set iframe with document GUID or raise an error</p>
502
+
503
+ </div>
504
+
505
+ <div class="content"><div class='highlight'><pre> <span class="hljs-keyword">if</span> guid</pre></div></div>
506
+
507
+ </li>
508
+
509
+
510
+ <li id="section-31">
511
+ <div class="annotation">
512
+
513
+ <div class="pilwrap ">
514
+ <a class="pilcrow" href="#section-31">&#182;</a>
515
+ </div>
516
+ <p>Make iframe</p>
517
+
518
+ </div>
519
+
520
+ <div class="content"><div class='highlight'><pre> iframe = <span class="hljs-string">"&lt;iframe id='downloadframe' src='<span class="hljs-subst">#{iframe}</span>' width='800' height='1000'&gt;&lt;/iframe&gt;"</span>
521
+ <span class="hljs-keyword">else</span>
522
+ raise <span class="hljs-string">'File was not converted'</span>
523
+ <span class="hljs-keyword">end</span>
524
+
525
+ <span class="hljs-keyword">rescue</span> <span class="hljs-constant">Exception</span> =&gt; e
526
+ err = e.message
527
+ <span class="hljs-keyword">end</span></pre></div></div>
528
+
529
+ </li>
530
+
531
+
532
+ <li id="section-32">
533
+ <div class="annotation">
534
+
535
+ <div class="pilwrap ">
536
+ <a class="pilcrow" href="#section-32">&#182;</a>
537
+ </div>
538
+ <p>Set variables for template</p>
539
+
540
+ </div>
541
+
542
+ <div class="content"><div class='highlight'><pre> haml <span class="hljs-symbol">:sample25</span>, <span class="hljs-symbol">:locals</span> =&gt; {<span class="hljs-symbol">:userId</span> =&gt; settings.client_id, <span class="hljs-symbol">:privateKey</span> =&gt; settings.private_key, <span class="hljs-symbol">:iframe</span> =&gt; iframe, <span class="hljs-symbol">:fileName</span> =&gt; file_name, <span class="hljs-symbol">:err</span> =&gt; err}
543
+ <span class="hljs-keyword">end</span></pre></div></div>
544
+
545
+ </li>
546
+
547
+ </ul>
548
+ </div>
549
+ </body>
550
+ </html>