groupdocs 1.5.8 → 1.5.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (101) hide show
  1. data/CHANGELOG.md +9 -0
  2. data/examples/api-samples/public/docs/sample01.html +34 -15
  3. data/examples/api-samples/public/docs/sample02.html +36 -15
  4. data/examples/api-samples/public/docs/sample03.html +55 -34
  5. data/examples/api-samples/public/docs/sample04.html +33 -14
  6. data/examples/api-samples/public/docs/sample05.html +51 -33
  7. data/examples/api-samples/public/docs/sample06.html +86 -40
  8. data/examples/api-samples/public/docs/sample07.html +32 -13
  9. data/examples/api-samples/public/docs/sample08.html +39 -20
  10. data/examples/api-samples/public/docs/sample09.html +93 -39
  11. data/examples/api-samples/public/docs/sample10.html +39 -21
  12. data/examples/api-samples/public/docs/sample11.html +133 -88
  13. data/examples/api-samples/public/docs/sample12.html +33 -14
  14. data/examples/api-samples/public/docs/sample13.html +14 -7
  15. data/examples/api-samples/public/docs/sample14.html +37 -18
  16. data/examples/api-samples/public/docs/sample15.html +29 -10
  17. data/examples/api-samples/public/docs/sample16.html +58 -25
  18. data/examples/api-samples/public/docs/sample17.html +71 -38
  19. data/examples/api-samples/public/docs/sample18.html +98 -71
  20. data/examples/api-samples/public/docs/sample19.html +74 -42
  21. data/examples/api-samples/public/docs/sample20.html +39 -21
  22. data/examples/api-samples/public/docs/sample21.html +113 -69
  23. data/examples/api-samples/public/docs/sample22.html +89 -43
  24. data/examples/api-samples/public/docs/sample23.html +50 -32
  25. data/examples/api-samples/public/docs/sample24.html +64 -31
  26. data/examples/api-samples/public/docs/sample25.html +107 -60
  27. data/examples/api-samples/public/docs/sample26.html +29 -10
  28. data/examples/api-samples/public/docs/sample27.html +107 -61
  29. data/examples/api-samples/public/docs/sample28.html +158 -9
  30. data/examples/api-samples/public/docs/sample29.html +13 -8
  31. data/examples/api-samples/public/docs/sample30.html +34 -15
  32. data/examples/api-samples/public/docs/sample31.html +107 -76
  33. data/examples/api-samples/public/docs/sample32.html +104 -40
  34. data/examples/api-samples/public/docs/sample33.html +85 -36
  35. data/examples/api-samples/public/docs/sample34.html +30 -11
  36. data/examples/api-samples/public/docs/sample35.html +90 -27
  37. data/examples/api-samples/public/docs/sample36.html +36 -16
  38. data/examples/api-samples/public/docs/sample37.html +144 -265
  39. data/examples/api-samples/public/docs/sample38.html +113 -64
  40. data/examples/api-samples/public/docs/sample39.html +118 -45
  41. data/examples/api-samples/public/docs/sample40.html +81 -46
  42. data/examples/api-samples/public/docs/sample41.html +562 -90
  43. data/examples/api-samples/public/docs/sample42.html +94 -39
  44. data/examples/api-samples/public/docs/sample43.html +669 -0
  45. data/examples/api-samples/samples/sample01.rb +17 -10
  46. data/examples/api-samples/samples/sample02.rb +21 -12
  47. data/examples/api-samples/samples/sample03.rb +35 -29
  48. data/examples/api-samples/samples/sample04.rb +19 -12
  49. data/examples/api-samples/samples/sample05.rb +24 -17
  50. data/examples/api-samples/samples/sample06.rb +38 -32
  51. data/examples/api-samples/samples/sample07.rb +19 -12
  52. data/examples/api-samples/samples/sample08.rb +22 -15
  53. data/examples/api-samples/samples/sample09.rb +31 -29
  54. data/examples/api-samples/samples/sample10.rb +22 -15
  55. data/examples/api-samples/samples/sample11.rb +78 -81
  56. data/examples/api-samples/samples/sample12.rb +19 -21
  57. data/examples/api-samples/samples/sample13.rb +19 -21
  58. data/examples/api-samples/samples/sample14.rb +18 -12
  59. data/examples/api-samples/samples/sample15.rb +17 -10
  60. data/examples/api-samples/samples/sample16.rb +25 -17
  61. data/examples/api-samples/samples/sample17.rb +31 -23
  62. data/examples/api-samples/samples/sample18.rb +60 -55
  63. data/examples/api-samples/samples/sample19.rb +48 -42
  64. data/examples/api-samples/samples/sample20.rb +20 -13
  65. data/examples/api-samples/samples/sample21.rb +62 -54
  66. data/examples/api-samples/samples/sample22.rb +37 -31
  67. data/examples/api-samples/samples/sample23.rb +24 -17
  68. data/examples/api-samples/samples/sample24.rb +29 -22
  69. data/examples/api-samples/samples/sample25.rb +47 -40
  70. data/examples/api-samples/samples/sample26.rb +16 -9
  71. data/examples/api-samples/samples/sample27.rb +46 -39
  72. data/examples/api-samples/samples/sample28.rb +42 -11
  73. data/examples/api-samples/samples/sample29.rb +13 -8
  74. data/examples/api-samples/samples/sample30.rb +19 -12
  75. data/examples/api-samples/samples/sample31.rb +63 -58
  76. data/examples/api-samples/samples/sample32.rb +45 -42
  77. data/examples/api-samples/samples/sample33.rb +36 -25
  78. data/examples/api-samples/samples/sample34.rb +16 -9
  79. data/examples/api-samples/samples/sample35.rb +66 -53
  80. data/examples/api-samples/samples/sample36.rb +19 -15
  81. data/examples/api-samples/samples/sample37.rb +61 -99
  82. data/examples/api-samples/samples/sample38.rb +51 -43
  83. data/examples/api-samples/samples/sample39.rb +78 -62
  84. data/examples/api-samples/samples/sample40.rb +48 -38
  85. data/examples/api-samples/samples/sample41.rb +189 -67
  86. data/examples/api-samples/samples/sample42.rb +37 -29
  87. data/examples/api-samples/samples/sample43.rb +127 -0
  88. data/examples/api-samples/views/_others_samples.haml +4 -2
  89. data/examples/api-samples/views/index.haml +4 -2
  90. data/examples/api-samples/views/sample11.haml +1 -1
  91. data/examples/api-samples/views/sample28.haml +8 -0
  92. data/examples/api-samples/views/sample31.haml +1 -6
  93. data/examples/api-samples/views/sample39.haml +7 -2
  94. data/examples/api-samples/views/sample41.haml +78 -33
  95. data/examples/api-samples/views/sample42.haml +0 -1
  96. data/examples/api-samples/views/sample43.haml +91 -0
  97. data/lib/groupdocs/api/helpers/access_rights_helper.rb +6 -5
  98. data/lib/groupdocs/api/helpers/url_helper.rb +2 -1
  99. data/lib/groupdocs/document.rb +3 -3
  100. data/lib/groupdocs/version.rb +1 -1
  101. metadata +5 -2
@@ -59,7 +59,7 @@
59
59
  <div class="pilwrap ">
60
60
  <a class="pilcrow" href="#section-3">&#182;</a>
61
61
  </div>
62
- <p>set variables</p>
62
+ <p>Set variables</p>
63
63
 
64
64
  </div>
65
65
 
@@ -78,7 +78,7 @@
78
78
  <div class="pilwrap ">
79
79
  <a class="pilcrow" href="#section-4">&#182;</a>
80
80
  </div>
81
- <p>check required variables</p>
81
+ <p>Check required variables</p>
82
82
 
83
83
  </div>
84
84
 
@@ -93,7 +93,32 @@
93
93
  <div class="pilwrap ">
94
94
  <a class="pilcrow" href="#section-5">&#182;</a>
95
95
  </div>
96
+ <<<<<<< HEAD
96
97
  <p>Configure your access to API server.</p>
98
+ =======
99
+ <p>Prepare base path</p>
100
+
101
+ </div>
102
+
103
+ <div class="content"><div class='highlight'><pre> <span class="keyword">if</span> settings.base_path.empty?
104
+ base_path = <span class="string">'https://api.groupdocs.com'</span>
105
+ <span class="keyword">elsif</span> settings.base_path.match(<span class="string">'/v2.0'</span>)
106
+ base_path = settings.base_path.split(<span class="string">'/v2.0'</span>)[<span class="number">0</span>]
107
+ <span class="keyword">else</span>
108
+ base_path = settings.base_path
109
+ <span class="keyword">end</span></pre></div></div>
110
+
111
+ </li>
112
+
113
+
114
+ <li id="section-6">
115
+ <div class="annotation">
116
+
117
+ <div class="pilwrap ">
118
+ <a class="pilcrow" href="#section-6">&#182;</a>
119
+ </div>
120
+ <p>Configure your access to API server</p>
121
+ >>>>>>> samples-dev
97
122
 
98
123
  </div>
99
124
 
@@ -105,13 +130,33 @@
105
130
  </li>
106
131
 
107
132
 
108
- <li id="section-6">
133
+ <li id="section-7">
109
134
  <div class="annotation">
110
135
 
111
136
  <div class="pilwrap ">
112
- <a class="pilcrow" href="#section-6">&#182;</a>
137
+ <a class="pilcrow" href="#section-7">&#182;</a>
113
138
  </div>
139
+ <<<<<<< HEAD
114
140
  <p>make a request to API using client_id and private_key</p>
141
+ =======
142
+ <p>Optionally specify API server and version</p>
143
+
144
+ </div>
145
+
146
+ <div class="content"><div class='highlight'><pre> groupdocs.api_server = base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
147
+ <span class="keyword">end</span></pre></div></div>
148
+
149
+ </li>
150
+
151
+
152
+ <li id="section-8">
153
+ <div class="annotation">
154
+
155
+ <div class="pilwrap ">
156
+ <a class="pilcrow" href="#section-8">&#182;</a>
157
+ </div>
158
+ <p>Make a request to API using client_id and private_key</p>
159
+ >>>>>>> samples-dev
115
160
 
116
161
  </div>
117
162
 
@@ -121,13 +166,21 @@
121
166
  </li>
122
167
 
123
168
 
169
+ <<<<<<< HEAD
124
170
  <li id="section-7">
125
171
  <div class="annotation">
126
172
 
127
173
  <div class="pilwrap ">
128
174
  <a class="pilcrow" href="#section-7">&#182;</a>
175
+ =======
176
+ <li id="section-9">
177
+ <div class="annotation">
178
+
179
+ <div class="pilwrap ">
180
+ <a class="pilcrow" href="#section-9">&#182;</a>
181
+ >>>>>>> samples-dev
129
182
  </div>
130
- <p>get document by file ID</p>
183
+ <p>Get document by file ID</p>
131
184
 
132
185
  </div>
133
186
 
@@ -143,13 +196,21 @@
143
196
  </li>
144
197
 
145
198
 
199
+ <<<<<<< HEAD
146
200
  <li id="section-8">
147
201
  <div class="annotation">
148
202
 
149
203
  <div class="pilwrap ">
150
204
  <a class="pilcrow" href="#section-8">&#182;</a>
205
+ =======
206
+ <li id="section-10">
207
+ <div class="annotation">
208
+
209
+ <div class="pilwrap ">
210
+ <a class="pilcrow" href="#section-10">&#182;</a>
211
+ >>>>>>> samples-dev
151
212
  </div>
152
- <p>get list of annotations</p>
213
+ <p>Get list of annotations</p>
153
214
 
154
215
  </div>
155
216
 
@@ -158,19 +219,99 @@
158
219
  </li>
159
220
 
160
221
 
222
+ <<<<<<< HEAD
161
223
  <li id="section-9">
162
224
  <div class="annotation">
163
225
 
164
226
  <div class="pilwrap ">
165
227
  <a class="pilcrow" href="#section-9">&#182;</a>
228
+ =======
229
+ <li id="section-11">
230
+ <div class="annotation">
231
+
232
+ <div class="pilwrap ">
233
+ <a class="pilcrow" href="#section-11">&#182;</a>
234
+ >>>>>>> samples-dev
166
235
  </div>
167
- <p>delete all annotations from document</p>
236
+ <p>Delete all annotations from document</p>
168
237
 
169
238
  </div>
170
239
 
171
240
  <div class="content"><div class='highlight'><pre> annotations.each <span class="keyword">do</span> |annotation|
241
+ <<<<<<< HEAD
172
242
  annotation.remove!(<span class="symbol">:client_id</span> =&gt; settings.client_id, <span class="symbol">:private_key</span> =&gt; settings.private_key)
173
243
  <span class="keyword">end</span>
244
+ =======
245
+ annotation.remove!()
246
+ <span class="keyword">end</span></pre></div></div>
247
+
248
+ </li>
249
+
250
+
251
+ <li id="section-12">
252
+ <div class="annotation">
253
+
254
+ <div class="pilwrap ">
255
+ <a class="pilcrow" href="#section-12">&#182;</a>
256
+ </div>
257
+ <p>Prepare to sign url</p>
258
+
259
+ </div>
260
+
261
+ <div class="content"><div class='highlight'><pre> iframe = <span class="string">"/document-viewer/embed/<span class="subst">#{settings.file_id}</span>"</span></pre></div></div>
262
+
263
+ </li>
264
+
265
+
266
+ <li id="section-13">
267
+ <div class="annotation">
268
+
269
+ <div class="pilwrap ">
270
+ <a class="pilcrow" href="#section-13">&#182;</a>
271
+ </div>
272
+ <p>Construct result string</p>
273
+
274
+ </div>
275
+
276
+ <div class="content"><div class='highlight'><pre> url = <span class="constant">GroupDocs::Api::Request</span>.new(<span class="symbol">:path</span> =&gt; iframe).prepare_and_sign_url</pre></div></div>
277
+
278
+ </li>
279
+
280
+
281
+ <li id="section-14">
282
+ <div class="annotation">
283
+
284
+ <div class="pilwrap ">
285
+ <a class="pilcrow" href="#section-14">&#182;</a>
286
+ </div>
287
+ <p>Generate iframe URL</p>
288
+
289
+ </div>
290
+
291
+ <div class="content"><div class='highlight'><pre> <span class="keyword">case</span> base_path
292
+ <span class="keyword">when</span> <span class="string">'https://stage-api-groupdocs.dynabic.com'</span>
293
+ iframe = <span class="string">"https://stage-api-groupdocs.dynabic.com<span class="subst">#{url}</span>"</span>
294
+ <span class="keyword">when</span> <span class="string">'https://dev-api-groupdocs.dynabic.com'</span>
295
+ iframe = <span class="string">"https://dev-apps.groupdocs.com<span class="subst">#{url}</span>"</span>
296
+ <span class="keyword">else</span>
297
+ iframe = <span class="string">"https://apps.groupdocs.com<span class="subst">#{url}</span>"</span>
298
+ <span class="keyword">end</span></pre></div></div>
299
+
300
+ </li>
301
+
302
+
303
+ <li id="section-15">
304
+ <div class="annotation">
305
+
306
+ <div class="pilwrap ">
307
+ <a class="pilcrow" href="#section-15">&#182;</a>
308
+ </div>
309
+ <p>Make iframe</p>
310
+
311
+ </div>
312
+
313
+ <div class="content"><div class='highlight'><pre> iframe = <span class="string">"&lt;iframe id='downloadframe' src='<span class="subst">#{iframe}</span>' width='800' height='1000'&gt;&lt;/iframe&gt;"</span>
314
+ >>>>>>> samples-dev
174
315
 
175
316
  message = <span class="string">'Annotations was deleted from document'</span>
176
317
  <span class="keyword">end</span>
@@ -182,17 +323,25 @@
182
323
  </li>
183
324
 
184
325
 
326
+ <<<<<<< HEAD
185
327
  <li id="section-10">
186
328
  <div class="annotation">
187
329
 
188
330
  <div class="pilwrap ">
189
331
  <a class="pilcrow" href="#section-10">&#182;</a>
332
+ =======
333
+ <li id="section-16">
334
+ <div class="annotation">
335
+
336
+ <div class="pilwrap ">
337
+ <a class="pilcrow" href="#section-16">&#182;</a>
338
+ >>>>>>> samples-dev
190
339
  </div>
191
- <p>set variables for template</p>
340
+ <p>Set variables for template</p>
192
341
 
193
342
  </div>
194
343
 
195
- <div class="content"><div class='highlight'><pre> haml <span class="symbol">:sample28</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">:messages</span> =&gt; message, <span class="symbol">:fileId</span> =&gt; settings.file_id, <span class="symbol">:err</span> =&gt; err}
344
+ <div class="content"><div class='highlight'><pre> haml <span class="symbol">:sample28</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">:messages</span> =&gt; message, <span class="symbol">:iframe</span> =&gt; iframe, <span class="symbol">:fileId</span> =&gt; settings.file_id, <span class="symbol">:err</span> =&gt; err}
196
345
  <span class="keyword">end</span></pre></div></div>
197
346
 
198
347
  </li>
@@ -27,7 +27,8 @@
27
27
  <div class="pilwrap ">
28
28
  <a class="pilcrow" href="#section-1">&#182;</a>
29
29
  </div>
30
-
30
+ <p>GET request</p>
31
+
31
32
  </div>
32
33
 
33
34
  <div class="content"><div class='highlight'><pre>get <span class="string">'/sample29'</span> <span class="keyword">do</span>
@@ -58,7 +59,7 @@
58
59
  <div class="pilwrap ">
59
60
  <a class="pilcrow" href="#section-3">&#182;</a>
60
61
  </div>
61
- <p>set variables</p>
62
+ <p>Set variables</p>
62
63
 
63
64
  </div>
64
65
 
@@ -81,11 +82,15 @@
81
82
  <div class="pilwrap ">
82
83
  <a class="pilcrow" href="#section-4">&#182;</a>
83
84
  </div>
84
- <p>If base base is empty seting base path to prod server</p>
85
+ <p>Prepare base path</p>
85
86
 
86
87
  </div>
87
88
 
88
- <div class="content"><div class='highlight'><pre> base_path = <span class="string">'https://api.groupdocs.com/v2.0'</span> <span class="keyword">unless</span> !base_path.empty?</pre></div></div>
89
+ <div class="content"><div class='highlight'><pre> <span class="keyword">if</span> settings.base_path.empty?
90
+ base_path = <span class="string">'https://api.groupdocs.com'</span>
91
+ <span class="keyword">elsif</span> settings.base_path.match(<span class="string">'/v2.0'</span>)
92
+ base_path = settings.base_path.split(<span class="string">'/v2.0'</span>)[<span class="number">0</span>]
93
+ <span class="keyword">end</span></pre></div></div>
89
94
 
90
95
  </li>
91
96
 
@@ -103,7 +108,7 @@
103
108
  <div class="content"><div class='highlight'><pre> <span class="keyword">if</span> (!url.empty?)
104
109
 
105
110
  <span class="keyword">if</span> (base_path == <span class="string">"https://api.groupdocs.com/v2.0"</span>)
106
- iframe = <span class="string">"https://apps.groupdocs.com/document-viewer/embed?url=<span class="subst">#{url}</span> &amp;user_id=<span class="subst">#{client_id}</span>"</span>
111
+ iframe = <span class="string">"https://apps.groupdocs.com/document-viewer/embed?url=<span class="subst">#{url}</span>&amp;user_id=<span class="subst">#{client_id}</span>"</span>
107
112
  <span class="keyword">elsif</span> (base_path == <span class="string">"https://dev-api.groupdocs.com/v2.0"</span>)</pre></div></div>
108
113
 
109
114
  </li>
@@ -119,7 +124,7 @@
119
124
 
120
125
  </div>
121
126
 
122
- <div class="content"><div class='highlight'><pre> iframe = <span class="string">"https://dev-apps.groupdocs.com/document-viewer/embed?url=<span class="subst">#{url}</span> &amp;user_id=<span class="subst">#{client_id}</span>"</span>
127
+ <div class="content"><div class='highlight'><pre> iframe = <span class="string">"https://dev-apps.groupdocs.com/document-viewer/embed?url=<span class="subst">#{url}</span>&amp;user_id=<span class="subst">#{client_id}</span>"</span>
123
128
  <span class="keyword">elsif</span> (base_path == <span class="string">"https://stage-api.groupdocs.com/v2.0"</span>)</pre></div></div>
124
129
 
125
130
  </li>
@@ -135,9 +140,9 @@
135
140
 
136
141
  </div>
137
142
 
138
- <div class="content"><div class='highlight'><pre> iframe = <span class="string">"https://stage-apps.groupdocs.com/document-viewer/embed?url=<span class="subst">#{url}</span> &amp;user_id=<span class="subst">#{client_id}</span>"</span>
143
+ <div class="content"><div class='highlight'><pre> iframe = <span class="string">"https://stage-apps.groupdocs.com/document-viewer/embed?url=<span class="subst">#{url}</span>&amp;user_id=<span class="subst">#{client_id}</span>"</span>
139
144
  <span class="keyword">elsif</span> (base_path == <span class="string">"http://realtime-api.groupdocs.com"</span>)
140
- iframe = <span class="string">"http://realtime-apps.groupdocs.com/document-viewer/embed?url=<span class="subst">#{url}</span> &amp;user_id=<span class="subst">#{client_id}</span>"</span>
145
+ iframe = <span class="string">"http://realtime-apps.groupdocs.com/document-viewer/embed?url=<span class="subst">#{url}</span>&amp;user_id=<span class="subst">#{client_id}</span>"</span>
141
146
  <span class="keyword">end</span>
142
147
 
143
148
 
@@ -79,13 +79,11 @@
79
79
  <div class="pilwrap ">
80
80
  <a class="pilcrow" href="#section-4">&#182;</a>
81
81
  </div>
82
- <p>check required variables</p>
82
+ <p>Check required variables</p>
83
83
 
84
84
  </div>
85
85
 
86
- <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.name.empty?
87
-
88
- <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>
86
+ <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.name.empty?</pre></div></div>
89
87
 
90
88
  </li>
91
89
 
@@ -96,6 +94,27 @@
96
94
  <div class="pilwrap ">
97
95
  <a class="pilcrow" href="#section-5">&#182;</a>
98
96
  </div>
97
+ <p>Prepare base path</p>
98
+
99
+ </div>
100
+
101
+ <div class="content"><div class='highlight'><pre> <span class="keyword">if</span> settings.base_path.empty?
102
+ base_path = <span class="string">'https://api.groupdocs.com'</span>
103
+ <span class="keyword">elsif</span> settings.base_path.match(<span class="string">'/v2.0'</span>)
104
+ base_path = settings.base_path.split(<span class="string">'/v2.0'</span>)[<span class="number">0</span>]
105
+ <span class="keyword">else</span>
106
+ base_path = settings.base_path
107
+ <span class="keyword">end</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>
99
118
  <p>Configure your access to API server</p>
100
119
 
101
120
  </div>
@@ -107,27 +126,27 @@
107
126
  </li>
108
127
 
109
128
 
110
- <li id="section-6">
129
+ <li id="section-7">
111
130
  <div class="annotation">
112
131
 
113
132
  <div class="pilwrap ">
114
- <a class="pilcrow" href="#section-6">&#182;</a>
133
+ <a class="pilcrow" href="#section-7">&#182;</a>
115
134
  </div>
116
135
  <p>Optionally specify API server and version</p>
117
136
 
118
137
  </div>
119
138
 
120
- <div class="content"><div class='highlight'><pre> groupdocs.api_server = settings.base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
139
+ <div class="content"><div class='highlight'><pre> groupdocs.api_server = base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
121
140
  <span class="keyword">end</span></pre></div></div>
122
141
 
123
142
  </li>
124
143
 
125
144
 
126
- <li id="section-7">
145
+ <li id="section-8">
127
146
  <div class="annotation">
128
147
 
129
148
  <div class="pilwrap ">
130
- <a class="pilcrow" href="#section-7">&#182;</a>
149
+ <a class="pilcrow" href="#section-8">&#182;</a>
131
150
  </div>
132
151
  <p>Make a request to API using client_id and private_key</p>
133
152
 
@@ -139,11 +158,11 @@
139
158
  </li>
140
159
 
141
160
 
142
- <li id="section-8">
161
+ <li id="section-9">
143
162
  <div class="annotation">
144
163
 
145
164
  <div class="pilwrap ">
146
- <a class="pilcrow" href="#section-8">&#182;</a>
165
+ <a class="pilcrow" href="#section-9">&#182;</a>
147
166
  </div>
148
167
  <p>Get document by file ID</p>
149
168
 
@@ -158,11 +177,11 @@
158
177
  </li>
159
178
 
160
179
 
161
- <li id="section-9">
180
+ <li id="section-10">
162
181
  <div class="annotation">
163
182
 
164
183
  <div class="pilwrap ">
165
- <a class="pilcrow" href="#section-9">&#182;</a>
184
+ <a class="pilcrow" href="#section-10">&#182;</a>
166
185
  </div>
167
186
  <p>Delete file from GroupDocs Storage</p>
168
187
 
@@ -179,11 +198,11 @@
179
198
  </li>
180
199
 
181
200
 
182
- <li id="section-10">
201
+ <li id="section-11">
183
202
  <div class="annotation">
184
203
 
185
204
  <div class="pilwrap ">
186
- <a class="pilcrow" href="#section-10">&#182;</a>
205
+ <a class="pilcrow" href="#section-11">&#182;</a>
187
206
  </div>
188
207
  <p>Set variables for template</p>
189
208
 
@@ -282,7 +282,7 @@
282
282
  <div class="pilwrap ">
283
283
  <a class="pilcrow" href="#section-16">&#182;</a>
284
284
  </div>
285
- <p>set variables</p>
285
+ <p>Set variables</p>
286
286
 
287
287
  </div>
288
288
 
@@ -343,13 +343,11 @@
343
343
  <div class="pilwrap ">
344
344
  <a class="pilcrow" href="#section-19">&#182;</a>
345
345
  </div>
346
- <p>check required variables</p>
346
+ <p>Check required variables</p>
347
347
 
348
348
  </div>
349
349
 
350
- <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?
351
-
352
- <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>
350
+ <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?</pre></div></div>
353
351
 
354
352
  </li>
355
353
 
@@ -360,6 +358,27 @@
360
358
  <div class="pilwrap ">
361
359
  <a class="pilcrow" href="#section-20">&#182;</a>
362
360
  </div>
361
+ <p>Prepare base path</p>
362
+
363
+ </div>
364
+
365
+ <div class="content"><div class='highlight'><pre> <span class="keyword">if</span> settings.base_path.empty?
366
+ base_path = <span class="string">'https://api.groupdocs.com'</span>
367
+ <span class="keyword">elsif</span> settings.base_path.match(<span class="string">'/v2.0'</span>)
368
+ base_path = settings.base_path.split(<span class="string">'/v2.0'</span>)[<span class="number">0</span>]
369
+ <span class="keyword">else</span>
370
+ base_path = settings.base_path
371
+ <span class="keyword">end</span></pre></div></div>
372
+
373
+ </li>
374
+
375
+
376
+ <li id="section-21">
377
+ <div class="annotation">
378
+
379
+ <div class="pilwrap ">
380
+ <a class="pilcrow" href="#section-21">&#182;</a>
381
+ </div>
363
382
  <p>Configure your access to API server</p>
364
383
 
365
384
  </div>
@@ -371,27 +390,27 @@
371
390
  </li>
372
391
 
373
392
 
374
- <li id="section-21">
393
+ <li id="section-22">
375
394
  <div class="annotation">
376
395
 
377
396
  <div class="pilwrap ">
378
- <a class="pilcrow" href="#section-21">&#182;</a>
397
+ <a class="pilcrow" href="#section-22">&#182;</a>
379
398
  </div>
380
399
  <p>Optionally specify API server and version</p>
381
400
 
382
401
  </div>
383
402
 
384
- <div class="content"><div class='highlight'><pre> groupdocs.api_server = settings.base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
403
+ <div class="content"><div class='highlight'><pre> groupdocs.api_server = base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
385
404
  <span class="keyword">end</span></pre></div></div>
386
405
 
387
406
  </li>
388
407
 
389
408
 
390
- <li id="section-22">
409
+ <li id="section-23">
391
410
  <div class="annotation">
392
411
 
393
412
  <div class="pilwrap ">
394
- <a class="pilcrow" href="#section-22">&#182;</a>
413
+ <a class="pilcrow" href="#section-23">&#182;</a>
395
414
  </div>
396
415
  <p>Write client and private key to the file for callback job</p>
397
416
 
@@ -403,13 +422,13 @@
403
422
  </li>
404
423
 
405
424
 
406
- <li id="section-23">
425
+ <li id="section-24">
407
426
  <div class="annotation">
408
427
 
409
428
  <div class="pilwrap ">
410
- <a class="pilcrow" href="#section-23">&#182;</a>
429
+ <a class="pilcrow" href="#section-24">&#182;</a>
411
430
  </div>
412
- <p>white space is required</p>
431
+ <p>White space is required</p>
413
432
 
414
433
  </div>
415
434
 
@@ -417,19 +436,17 @@
417
436
  out_file.write(<span class="string">"<span class="subst">#{settings.private_key}</span>"</span>)
418
437
  out_file.close
419
438
  <span class="keyword">end</span>
420
- <span class="keyword">if</span> settings.last_name.empty?
421
- settings.last_name = <span class="string">'test'</span>
422
- <span class="keyword">end</span>
439
+
423
440
  file = <span class="keyword">nil</span></pre></div></div>
424
441
 
425
442
  </li>
426
443
 
427
444
 
428
- <li id="section-24">
445
+ <li id="section-25">
429
446
  <div class="annotation">
430
447
 
431
448
  <div class="pilwrap ">
432
- <a class="pilcrow" href="#section-24">&#182;</a>
449
+ <a class="pilcrow" href="#section-25">&#182;</a>
433
450
  </div>
434
451
  <p>Create instance of File</p>
435
452
 
@@ -440,11 +457,11 @@
440
457
  </li>
441
458
 
442
459
 
443
- <li id="section-25">
460
+ <li id="section-26">
444
461
  <div class="annotation">
445
462
 
446
463
  <div class="pilwrap ">
447
- <a class="pilcrow" href="#section-25">&#182;</a>
464
+ <a class="pilcrow" href="#section-26">&#182;</a>
448
465
  </div>
449
466
  <p>Raise exception if something went wrong</p>
450
467
 
@@ -455,11 +472,11 @@
455
472
  </li>
456
473
 
457
474
 
458
- <li id="section-26">
475
+ <li id="section-27">
459
476
  <div class="annotation">
460
477
 
461
478
  <div class="pilwrap ">
462
- <a class="pilcrow" href="#section-26">&#182;</a>
479
+ <a class="pilcrow" href="#section-27">&#182;</a>
463
480
  </div>
464
481
  <p>Make GroupDocs::Storage::Document instance</p>
465
482
 
@@ -470,11 +487,11 @@
470
487
  </li>
471
488
 
472
489
 
473
- <li id="section-27">
490
+ <li id="section-28">
474
491
  <div class="annotation">
475
492
 
476
493
  <div class="pilwrap ">
477
- <a class="pilcrow" href="#section-27">&#182;</a>
494
+ <a class="pilcrow" href="#section-28">&#182;</a>
478
495
  </div>
479
496
  <p>Create datasource with fields</p>
480
497
 
@@ -485,26 +502,26 @@
485
502
  </li>
486
503
 
487
504
 
488
- <li id="section-28">
505
+ <li id="section-29">
489
506
  <div class="annotation">
490
507
 
491
508
  <div class="pilwrap ">
492
- <a class="pilcrow" href="#section-28">&#182;</a>
509
+ <a class="pilcrow" href="#section-29">&#182;</a>
493
510
  </div>
494
511
  <p>Get arry of document&#39;s fields</p>
495
512
 
496
513
  </div>
497
514
 
498
- <div class="content"><div class='highlight'><pre> enteredData = {<span class="string">"email"</span> =&gt; settings.email, <span class="string">"name"</span> =&gt; settings.name, <span class="string">"last_name"</span> =&gt; settings.last_name, <span class="string">"country"</span>=&gt; settings.country, <span class="string">"city"</span> =&gt; settings.city, <span class="string">"street"</span> =&gt; settings.street}</pre></div></div>
515
+ <div class="content"><div class='highlight'><pre> enteredData = {<span class="string">"email"</span> =&gt; settings.email, <span class="string">"name"</span> =&gt; settings.name, <span class="string">"country"</span>=&gt; settings.country, <span class="string">"city"</span> =&gt; settings.city, <span class="string">"street"</span> =&gt; settings.street}</pre></div></div>
499
516
 
500
517
  </li>
501
518
 
502
519
 
503
- <li id="section-29">
520
+ <li id="section-30">
504
521
  <div class="annotation">
505
522
 
506
523
  <div class="pilwrap ">
507
- <a class="pilcrow" href="#section-29">&#182;</a>
524
+ <a class="pilcrow" href="#section-30">&#182;</a>
508
525
  </div>
509
526
  <p>Create Field instance and fill the fields</p>
510
527
 
@@ -515,11 +532,11 @@
515
532
  </li>
516
533
 
517
534
 
518
- <li id="section-30">
535
+ <li id="section-31">
519
536
  <div class="annotation">
520
537
 
521
538
  <div class="pilwrap ">
522
- <a class="pilcrow" href="#section-30">&#182;</a>
539
+ <a class="pilcrow" href="#section-31">&#182;</a>
523
540
  </div>
524
541
  <p>Adds datasource.</p>
525
542
 
@@ -530,11 +547,11 @@
530
547
  </li>
531
548
 
532
549
 
533
- <li id="section-31">
550
+ <li id="section-32">
534
551
  <div class="annotation">
535
552
 
536
553
  <div class="pilwrap ">
537
- <a class="pilcrow" href="#section-31">&#182;</a>
554
+ <a class="pilcrow" href="#section-32">&#182;</a>
538
555
  </div>
539
556
  <p>Creates new job to merge datasource into document.</p>
540
557
 
@@ -546,11 +563,11 @@
546
563
  </li>
547
564
 
548
565
 
549
- <li id="section-32">
566
+ <li id="section-33">
550
567
  <div class="annotation">
551
568
 
552
569
  <div class="pilwrap ">
553
- <a class="pilcrow" href="#section-32">&#182;</a>
570
+ <a class="pilcrow" href="#section-33">&#182;</a>
554
571
  </div>
555
572
  <p>Returns an hash of input and output documents associated to job.</p>
556
573
 
@@ -561,11 +578,11 @@
561
578
  </li>
562
579
 
563
580
 
564
- <li id="section-33">
581
+ <li id="section-34">
565
582
  <div class="annotation">
566
583
 
567
584
  <div class="pilwrap ">
568
- <a class="pilcrow" href="#section-33">&#182;</a>
585
+ <a class="pilcrow" href="#section-34">&#182;</a>
569
586
  </div>
570
587
  <p>Creates new document to envelope</p>
571
588
 
@@ -576,11 +593,11 @@
576
593
  </li>
577
594
 
578
595
 
579
- <li id="section-34">
596
+ <li id="section-35">
580
597
  <div class="annotation">
581
598
 
582
599
  <div class="pilwrap ">
583
- <a class="pilcrow" href="#section-34">&#182;</a>
600
+ <a class="pilcrow" href="#section-35">&#182;</a>
584
601
  </div>
585
602
  <p>Creates envelope using user id and entered by user name</p>
586
603
 
@@ -593,26 +610,26 @@
593
610
  </li>
594
611
 
595
612
 
596
- <li id="section-35">
613
+ <li id="section-36">
597
614
  <div class="annotation">
598
615
 
599
616
  <div class="pilwrap ">
600
- <a class="pilcrow" href="#section-35">&#182;</a>
617
+ <a class="pilcrow" href="#section-36">&#182;</a>
601
618
  </div>
602
619
  <p>Adds uploaded document to envelope</p>
603
620
 
604
621
  </div>
605
622
 
606
- <div class="content"><div class='highlight'><pre> envelope.add_document!(document, {})</pre></div></div>
623
+ <div class="content"><div class='highlight'><pre> envelope.add_document!(document, {<span class="symbol">parseFields:</span> <span class="keyword">true</span>})</pre></div></div>
607
624
 
608
625
  </li>
609
626
 
610
627
 
611
- <li id="section-36">
628
+ <li id="section-37">
612
629
  <div class="annotation">
613
630
 
614
631
  <div class="pilwrap ">
615
- <a class="pilcrow" href="#section-36">&#182;</a>
632
+ <a class="pilcrow" href="#section-37">&#182;</a>
616
633
  </div>
617
634
  <p>Get role list for current user</p>
618
635
 
@@ -623,11 +640,11 @@
623
640
  </li>
624
641
 
625
642
 
626
- <li id="section-37">
643
+ <li id="section-38">
627
644
  <div class="annotation">
628
645
 
629
646
  <div class="pilwrap ">
630
- <a class="pilcrow" href="#section-37">&#182;</a>
647
+ <a class="pilcrow" href="#section-38">&#182;</a>
631
648
  </div>
632
649
  <p>Creates new recipient</p>
633
650
 
@@ -636,17 +653,17 @@
636
653
  <div class="content"><div class='highlight'><pre> recipient = <span class="constant">GroupDocs::Signature::Recipient</span>.new
637
654
  recipient.email = settings.email
638
655
  recipient.first_name = settings.name
639
- recipient.last_name = settings.last_name
656
+ recipient.last_name = <span class="string">"lastName"</span>
640
657
  recipient.role_id = roles.detect { |role| role.name == <span class="string">'Signer'</span> }.id</pre></div></div>
641
658
 
642
659
  </li>
643
660
 
644
661
 
645
- <li id="section-38">
662
+ <li id="section-39">
646
663
  <div class="annotation">
647
664
 
648
665
  <div class="pilwrap ">
649
- <a class="pilcrow" href="#section-38">&#182;</a>
666
+ <a class="pilcrow" href="#section-39">&#182;</a>
650
667
  </div>
651
668
  <p>Adds recipient to envelope</p>
652
669
 
@@ -657,11 +674,11 @@
657
674
  </li>
658
675
 
659
676
 
660
- <li id="section-39">
677
+ <li id="section-40">
661
678
  <div class="annotation">
662
679
 
663
680
  <div class="pilwrap ">
664
- <a class="pilcrow" href="#section-39">&#182;</a>
681
+ <a class="pilcrow" href="#section-40">&#182;</a>
665
682
  </div>
666
683
  <p>Get recipients</p>
667
684
 
@@ -672,11 +689,11 @@
672
689
  </li>
673
690
 
674
691
 
675
- <li id="section-40">
692
+ <li id="section-41">
676
693
  <div class="annotation">
677
694
 
678
695
  <div class="pilwrap ">
679
- <a class="pilcrow" href="#section-40">&#182;</a>
696
+ <a class="pilcrow" href="#section-41">&#182;</a>
680
697
  </div>
681
698
  <p>Send envelope</p>
682
699
 
@@ -687,56 +704,69 @@
687
704
  </li>
688
705
 
689
706
 
690
- <li id="section-41">
707
+ <li id="section-42">
691
708
  <div class="annotation">
692
709
 
693
710
  <div class="pilwrap ">
694
- <a class="pilcrow" href="#section-41">&#182;</a>
711
+ <a class="pilcrow" href="#section-42">&#182;</a>
695
712
  </div>
696
- <p>Get url from request</p>
713
+ <p>Prepare to sign url</p>
697
714
 
698
715
  </div>
699
716
 
700
- <div class="content"><div class='highlight'><pre> <span class="keyword">case</span> settings.base_path
701
-
702
- <span class="keyword">when</span> <span class="string">'https://stage-api-groupdocs.dynabic.com'</span>
703
- url = <span class="string">"http://stage-apps-groupdocs.dynabic.com/signature2/signembed/<span class="subst">#{envelope.id}</span>/<span class="subst">#{recipientGet.id}</span>"</span>
704
- <span class="keyword">when</span> <span class="string">'https://dev-api-groupdocs.dynabic.com'</span>
705
- url = <span class="string">"http://dev-apps-groupdocs.dynabic.com/signature2/signembed/<span class="subst">#{envelope.id}</span>/<span class="subst">#{recipientGet.id}</span>"</span>
706
- <span class="keyword">else</span>
707
- url = <span class="string">"https://apps.groupdocs.com/signature2/signembed/<span class="subst">#{envelope.id}</span>/<span class="subst">#{recipientGet.id}</span>"</span>
708
- <span class="keyword">end</span></pre></div></div>
717
+ <div class="content"><div class='highlight'><pre> iframe = <span class="string">"/signature2/signembed/<span class="subst">#{envelope.id}</span>/<span class="subst">#{recipientGet.id}</span>"</span></pre></div></div>
709
718
 
710
719
  </li>
711
720
 
712
721
 
713
- <li id="section-42">
722
+ <li id="section-43">
714
723
  <div class="annotation">
715
724
 
716
725
  <div class="pilwrap ">
717
- <a class="pilcrow" href="#section-42">&#182;</a>
726
+ <a class="pilcrow" href="#section-43">&#182;</a>
718
727
  </div>
719
- <p>Add the signature in url</p>
728
+ <p>Construct result string</p>
720
729
 
721
730
  </div>
722
731
 
723
- <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</pre></div></div>
732
+ <div class="content"><div class='highlight'><pre> url = <span class="constant">GroupDocs::Api::Request</span>.new(<span class="symbol">:path</span> =&gt; iframe).prepare_and_sign_url</pre></div></div>
724
733
 
725
734
  </li>
726
735
 
727
736
 
728
- <li id="section-43">
737
+ <li id="section-44">
729
738
  <div class="annotation">
730
739
 
731
740
  <div class="pilwrap ">
732
- <a class="pilcrow" href="#section-43">&#182;</a>
741
+ <a class="pilcrow" href="#section-44">&#182;</a>
742
+ </div>
743
+ <p>Generate iframe URL</p>
744
+
745
+ </div>
746
+
747
+ <div class="content"><div class='highlight'><pre> <span class="keyword">case</span> base_path
748
+ <span class="keyword">when</span> <span class="string">'https://stage-api-groupdocs.dynabic.com'</span>
749
+ iframe = <span class="string">"https://stage-api-groupdocs.dynabic.com<span class="subst">#{url}</span>"</span>
750
+ <span class="keyword">when</span> <span class="string">'https://dev-api-groupdocs.dynabic.com'</span>
751
+ iframe = <span class="string">"https://dev-apps.groupdocs.com<span class="subst">#{url}</span>"</span>
752
+ <span class="keyword">else</span>
753
+ iframe = <span class="string">"https://apps.groupdocs.com<span class="subst">#{url}</span>"</span>
754
+ <span class="keyword">end</span></pre></div></div>
755
+
756
+ </li>
757
+
758
+
759
+ <li id="section-45">
760
+ <div class="annotation">
761
+
762
+ <div class="pilwrap ">
763
+ <a class="pilcrow" href="#section-45">&#182;</a>
733
764
  </div>
734
765
  <p>Make iframe</p>
735
766
 
736
767
  </div>
737
768
 
738
- <div class="content"><div class='highlight'><pre> iframe = <span class="string">"&lt;iframe src='<span class="subst">#{iframe}</span>' frameborder='0' width='720' height='600'&gt;&lt;/iframe&gt;"</span>
739
-
769
+ <div class="content"><div class='highlight'><pre> iframe = <span class="string">"&lt;iframe id='downloadframe' src='<span class="subst">#{iframe}</span>' width='800' height='1000'&gt;&lt;/iframe&gt;"</span>
740
770
 
741
771
  <span class="keyword">rescue</span> <span class="constant">Exception</span> =&gt; e
742
772
  err = e.message
@@ -745,13 +775,13 @@
745
775
  </li>
746
776
 
747
777
 
748
- <li id="section-44">
778
+ <li id="section-46">
749
779
  <div class="annotation">
750
780
 
751
781
  <div class="pilwrap ">
752
- <a class="pilcrow" href="#section-44">&#182;</a>
782
+ <a class="pilcrow" href="#section-46">&#182;</a>
753
783
  </div>
754
- <p>set variables for template</p>
784
+ <p>Set variables for template</p>
755
785
 
756
786
  </div>
757
787
 
@@ -764,6 +794,7 @@
764
794
  <span class="symbol">:city</span> =&gt; settings.city,
765
795
  <span class="symbol">:street</span> =&gt; settings.street,
766
796
  <span class="symbol">:iframe</span> =&gt; iframe,
797
+ <span class="symbol">:templateGuid</span> =&gt; settings.template_guid,
767
798
  <span class="symbol">:err</span> =&gt; err}
768
799
  <span class="keyword">end</span></pre></div></div>
769
800