groupdocs 1.5.7 → 1.5.8

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 (177) hide show
  1. data/CHANGELOG.md +51 -0
  2. data/examples/api-samples/Gemfile +1 -1
  3. data/examples/api-samples/Gemfile.lock +43 -0
  4. data/examples/api-samples/public/docs/{sample2.html → sample01.html} +39 -19
  5. data/examples/api-samples/public/docs/{sample3.html → sample02.html} +28 -22
  6. data/examples/api-samples/public/docs/sample03.html +285 -0
  7. data/examples/api-samples/public/docs/{sample4.html → sample04.html} +30 -36
  8. data/examples/api-samples/public/docs/{sample5.html → sample05.html} +68 -31
  9. data/examples/api-samples/public/docs/sample06.html +299 -0
  10. data/examples/api-samples/public/docs/{sample7.html → sample07.html} +53 -18
  11. data/examples/api-samples/public/docs/{sample8.html → sample08.html} +64 -41
  12. data/examples/api-samples/public/docs/sample09.html +260 -0
  13. data/examples/api-samples/public/docs/sample10.html +67 -28
  14. data/examples/api-samples/public/docs/sample11.html +171 -55
  15. data/examples/api-samples/public/docs/sample12.html +53 -17
  16. data/examples/api-samples/public/docs/sample13.html +52 -16
  17. data/examples/api-samples/public/docs/sample14.html +51 -8
  18. data/examples/api-samples/public/docs/sample15.html +46 -10
  19. data/examples/api-samples/public/docs/sample16.html +81 -7
  20. data/examples/api-samples/public/docs/sample17.html +103 -15
  21. data/examples/api-samples/public/docs/sample18.html +117 -41
  22. data/examples/api-samples/public/docs/sample19.html +410 -36
  23. data/examples/api-samples/public/docs/sample20.html +46 -10
  24. data/examples/api-samples/public/docs/sample21.html +504 -45
  25. data/examples/api-samples/public/docs/sample22.html +166 -28
  26. data/examples/api-samples/public/docs/sample23.html +61 -25
  27. data/examples/api-samples/public/docs/sample24.html +100 -12
  28. data/examples/api-samples/public/docs/sample25.html +123 -49
  29. data/examples/api-samples/public/docs/sample26.html +41 -8
  30. data/examples/api-samples/public/docs/sample27.html +125 -50
  31. data/examples/api-samples/public/docs/sample28.html +27 -9
  32. data/examples/api-samples/public/docs/sample29.html +10 -10
  33. data/examples/api-samples/public/docs/sample30.html +70 -14
  34. data/examples/api-samples/public/docs/sample31.html +108 -67
  35. data/examples/api-samples/public/docs/sample32.html +71 -99
  36. data/examples/api-samples/public/docs/sample33.html +107 -32
  37. data/examples/api-samples/public/docs/{sample1.html → sample34.html} +58 -18
  38. data/examples/api-samples/public/docs/sample35.html +666 -0
  39. data/examples/api-samples/public/docs/{sample6.html → sample36.html} +56 -37
  40. data/examples/api-samples/public/docs/sample37.html +815 -0
  41. data/examples/api-samples/public/docs/sample38.html +508 -0
  42. data/examples/api-samples/public/docs/sample39.html +921 -0
  43. data/examples/api-samples/public/docs/sample40.html +510 -0
  44. data/examples/api-samples/public/docs/sample41.html +452 -0
  45. data/examples/api-samples/public/docs/sample42.html +311 -0
  46. data/examples/api-samples/public/templates/test_all_fields2.pdf +0 -0
  47. data/examples/api-samples/samples/sample01.rb +37 -0
  48. data/examples/api-samples/samples/sample02.rb +41 -0
  49. data/examples/api-samples/samples/sample03.rb +73 -0
  50. data/examples/api-samples/samples/sample04.rb +47 -0
  51. data/examples/api-samples/samples/{sample5.rb → sample05.rb} +26 -14
  52. data/examples/api-samples/samples/sample06.rb +80 -0
  53. data/examples/api-samples/samples/sample07.rb +52 -0
  54. data/examples/api-samples/samples/sample08.rb +69 -0
  55. data/examples/api-samples/samples/sample09.rb +83 -0
  56. data/examples/api-samples/samples/sample10.rb +29 -15
  57. data/examples/api-samples/samples/sample11.rb +89 -37
  58. data/examples/api-samples/samples/sample12.rb +22 -11
  59. data/examples/api-samples/samples/sample13.rb +22 -10
  60. data/examples/api-samples/samples/sample14.rb +23 -5
  61. data/examples/api-samples/samples/sample15.rb +18 -7
  62. data/examples/api-samples/samples/sample16.rb +28 -4
  63. data/examples/api-samples/samples/sample17.rb +31 -5
  64. data/examples/api-samples/samples/sample18.rb +36 -8
  65. data/examples/api-samples/samples/sample19.rb +138 -18
  66. data/examples/api-samples/samples/sample20.rb +14 -3
  67. data/examples/api-samples/samples/sample21.rb +162 -23
  68. data/examples/api-samples/samples/sample22.rb +73 -22
  69. data/examples/api-samples/samples/sample23.rb +17 -6
  70. data/examples/api-samples/samples/sample24.rb +34 -7
  71. data/examples/api-samples/samples/sample25.rb +37 -12
  72. data/examples/api-samples/samples/sample26.rb +12 -5
  73. data/examples/api-samples/samples/sample27.rb +38 -12
  74. data/examples/api-samples/samples/sample28.rb +25 -6
  75. data/examples/api-samples/samples/sample29.rb +12 -12
  76. data/examples/api-samples/samples/sample30.rb +27 -15
  77. data/examples/api-samples/samples/sample31.rb +44 -33
  78. data/examples/api-samples/samples/sample32.rb +43 -41
  79. data/examples/api-samples/samples/sample33.rb +42 -14
  80. data/examples/api-samples/samples/sample34.rb +40 -0
  81. data/examples/api-samples/samples/sample35.rb +224 -0
  82. data/examples/api-samples/samples/sample36.rb +58 -0
  83. data/examples/api-samples/samples/sample37.rb +229 -0
  84. data/examples/api-samples/samples/sample38.rb +128 -0
  85. data/examples/api-samples/samples/sample39.rb +252 -0
  86. data/examples/api-samples/samples/sample40.rb +164 -0
  87. data/examples/api-samples/samples/sample41.rb +118 -0
  88. data/examples/api-samples/samples/sample42.rb +97 -0
  89. data/examples/api-samples/views/_others_samples.haml +25 -11
  90. data/examples/api-samples/views/index.haml +23 -11
  91. data/examples/api-samples/views/popup.haml +32 -0
  92. data/examples/api-samples/views/{sample1.haml → sample01.haml} +12 -7
  93. data/examples/api-samples/views/{sample2.haml → sample02.haml} +20 -15
  94. data/examples/api-samples/views/sample03.haml +83 -0
  95. data/examples/api-samples/views/sample04.haml +49 -0
  96. data/examples/api-samples/views/{sample5.haml → sample05.haml} +19 -14
  97. data/examples/api-samples/views/sample06.haml +53 -0
  98. data/examples/api-samples/views/sample07.haml +47 -0
  99. data/examples/api-samples/views/{sample8.haml → sample08.haml} +17 -12
  100. data/examples/api-samples/views/{sample9.haml → sample09.haml} +19 -4
  101. data/examples/api-samples/views/sample10.haml +18 -13
  102. data/examples/api-samples/views/sample11.haml +48 -19
  103. data/examples/api-samples/views/sample12.haml +26 -21
  104. data/examples/api-samples/views/sample13.haml +18 -12
  105. data/examples/api-samples/views/sample14.haml +21 -15
  106. data/examples/api-samples/views/sample15.haml +16 -9
  107. data/examples/api-samples/views/sample16.haml +18 -5
  108. data/examples/api-samples/views/sample17.haml +14 -9
  109. data/examples/api-samples/views/sample18.haml +13 -7
  110. data/examples/api-samples/views/sample19.haml +37 -8
  111. data/examples/api-samples/views/sample20.haml +13 -8
  112. data/examples/api-samples/views/sample21.haml +71 -13
  113. data/examples/api-samples/views/sample22.haml +53 -16
  114. data/examples/api-samples/views/sample23.haml +9 -4
  115. data/examples/api-samples/views/sample24.haml +9 -4
  116. data/examples/api-samples/views/sample25.haml +18 -13
  117. data/examples/api-samples/views/sample26.haml +8 -3
  118. data/examples/api-samples/views/sample27.haml +20 -14
  119. data/examples/api-samples/views/sample28.haml +16 -10
  120. data/examples/api-samples/views/sample29.haml +4 -4
  121. data/examples/api-samples/views/sample30.haml +16 -10
  122. data/examples/api-samples/views/sample31.haml +39 -32
  123. data/examples/api-samples/views/sample32.haml +25 -36
  124. data/examples/api-samples/views/sample33.haml +14 -17
  125. data/examples/api-samples/views/sample34.haml +48 -0
  126. data/examples/api-samples/views/sample35.haml +95 -0
  127. data/examples/api-samples/views/sample36.haml +64 -0
  128. data/examples/api-samples/views/sample37.haml +124 -0
  129. data/examples/api-samples/views/sample38.haml +115 -0
  130. data/examples/api-samples/views/sample39.haml +236 -0
  131. data/examples/api-samples/views/sample40.haml +95 -0
  132. data/examples/api-samples/views/{sample4.haml → sample41.haml} +90 -72
  133. data/examples/api-samples/views/sample42.haml +59 -0
  134. data/lib/groupdocs/api/helpers/rest_helper.rb +13 -1
  135. data/lib/groupdocs/datasource.rb +2 -1
  136. data/lib/groupdocs/document.rb +101 -13
  137. data/lib/groupdocs/document/annotation.rb +28 -13
  138. data/lib/groupdocs/document/annotation/marker.rb +18 -0
  139. data/lib/groupdocs/document/annotation/reply.rb +9 -2
  140. data/lib/groupdocs/document/field.rb +5 -1
  141. data/lib/groupdocs/job.rb +12 -2
  142. data/lib/groupdocs/questionnaire.rb +174 -4
  143. data/lib/groupdocs/questionnaire/collector.rb +21 -0
  144. data/lib/groupdocs/questionnaire/question.rb +19 -0
  145. data/lib/groupdocs/questionnaire/question/answer.rb +5 -0
  146. data/lib/groupdocs/questionnaire/question/conditions.rb +20 -0
  147. data/lib/groupdocs/signature.rb +36 -308
  148. data/lib/groupdocs/signature/envelope.rb +146 -4
  149. data/lib/groupdocs/signature/field.rb +20 -1
  150. data/lib/groupdocs/signature/field/location.rb +18 -7
  151. data/lib/groupdocs/signature/form.rb +199 -10
  152. data/lib/groupdocs/signature/shared/document_methods.rb +38 -0
  153. data/lib/groupdocs/signature/shared/entity_methods.rb +0 -1
  154. data/lib/groupdocs/signature/shared/field_methods.rb +13 -38
  155. data/lib/groupdocs/signature/shared/recipient_methods.rb +8 -0
  156. data/lib/groupdocs/signature/template.rb +3 -1
  157. data/lib/groupdocs/storage.rb +4 -1
  158. data/lib/groupdocs/storage/file.rb +18 -1
  159. data/lib/groupdocs/subscription.rb +8 -3
  160. data/lib/groupdocs/user.rb +8 -0
  161. data/lib/groupdocs/version.rb +1 -1
  162. data/spec/groupdocs/document/annotation_spec.rb +1 -14
  163. data/spec/groupdocs/subscription_spec.rb +2 -2
  164. metadata +86 -32
  165. checksums.yaml +0 -15
  166. data/examples/api-samples/public/docs/sample9.html +0 -200
  167. data/examples/api-samples/samples/sample1.rb +0 -25
  168. data/examples/api-samples/samples/sample2.rb +0 -29
  169. data/examples/api-samples/samples/sample3.rb +0 -33
  170. data/examples/api-samples/samples/sample4.rb +0 -51
  171. data/examples/api-samples/samples/sample6.rb +0 -49
  172. data/examples/api-samples/samples/sample7.rb +0 -42
  173. data/examples/api-samples/samples/sample8.rb +0 -61
  174. data/examples/api-samples/samples/sample9.rb +0 -48
  175. data/examples/api-samples/views/sample3.haml +0 -44
  176. data/examples/api-samples/views/sample6.haml +0 -49
  177. data/examples/api-samples/views/sample7.haml +0 -42
@@ -2,7 +2,7 @@
2
2
 
3
3
  <html>
4
4
  <head>
5
- <title>sample7.rb</title>
5
+ <title>sample07.rb</title>
6
6
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
7
7
  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
8
8
  <link rel="stylesheet" media="all" href="docco.css" />
@@ -15,7 +15,7 @@
15
15
 
16
16
  <li id="title">
17
17
  <div class="annotation">
18
- <h1>sample7.rb</h1>
18
+ <h1>sample07.rb</h1>
19
19
  </div>
20
20
  </li>
21
21
 
@@ -31,8 +31,8 @@
31
31
 
32
32
  </div>
33
33
 
34
- <div class="content"><div class='highlight'><pre>get <span class="string">'/sample7'</span> <span class="keyword">do</span>
35
- haml <span class="symbol">:sample7</span>
34
+ <div class="content"><div class='highlight'><pre>get <span class="string">'/sample07'</span> <span class="keyword">do</span>
35
+ haml <span class="symbol">:sample07</span>
36
36
  <span class="keyword">end</span></pre></div></div>
37
37
 
38
38
  </li>
@@ -48,7 +48,7 @@
48
48
 
49
49
  </div>
50
50
 
51
- <div class="content"><div class='highlight'><pre>post <span class="string">'/sample7'</span> <span class="keyword">do</span></pre></div></div>
51
+ <div class="content"><div class='highlight'><pre>post <span class="string">'/sample07'</span> <span class="keyword">do</span></pre></div></div>
52
52
 
53
53
  </li>
54
54
 
@@ -59,12 +59,13 @@
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
 
66
- <div class="content"><div class='highlight'><pre> set <span class="symbol">:client_id</span>, params[<span class="symbol">:client_id</span>]
67
- set <span class="symbol">:private_key</span>, params[<span class="symbol">:private_key</span>]
66
+ <div class="content"><div class='highlight'><pre> set <span class="symbol">:client_id</span>, params[<span class="symbol">:clientId</span>]
67
+ set <span class="symbol">:private_key</span>, params[<span class="symbol">:privateKey</span>]
68
+ set <span class="symbol">:base_path</span>, params[<span class="symbol">:basePath</span>]
68
69
 
69
70
  <span class="keyword">begin</span></pre></div></div>
70
71
 
@@ -77,11 +78,13 @@
77
78
  <div class="pilwrap ">
78
79
  <a class="pilcrow" href="#section-4">&#182;</a>
79
80
  </div>
80
- <p>check required variables</p>
81
+ <p>Check required variables</p>
81
82
 
82
83
  </div>
83
84
 
84
- <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>
85
+ <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?
86
+
87
+ <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>
85
88
 
86
89
  </li>
87
90
 
@@ -92,11 +95,13 @@
92
95
  <div class="pilwrap ">
93
96
  <a class="pilcrow" href="#section-5">&#182;</a>
94
97
  </div>
95
- <p>make a request to API using client_id and private_key</p>
98
+ <p>Configure your access to API server</p>
96
99
 
97
100
  </div>
98
101
 
99
- <div class="content"><div class='highlight'><pre> files_list = <span class="constant">GroupDocs::Storage::Folder</span>.list!(<span class="string">'/'</span>, {<span class="symbol">:extended</span> =&gt; <span class="keyword">true</span>}, {<span class="symbol">:client_id</span> =&gt; settings.client_id, <span class="symbol">:private_key</span> =&gt; settings.private_key})</pre></div></div>
102
+ <div class="content"><div class='highlight'><pre> <span class="constant">GroupDocs</span>.configure <span class="keyword">do</span> |groupdocs|
103
+ groupdocs.client_id = settings.client_id
104
+ groupdocs.private_key = settings.private_key</pre></div></div>
100
105
 
101
106
  </li>
102
107
 
@@ -107,7 +112,38 @@
107
112
  <div class="pilwrap ">
108
113
  <a class="pilcrow" href="#section-6">&#182;</a>
109
114
  </div>
110
- <p>construct result string</p>
115
+ <p>Optionally specify API server and version</p>
116
+
117
+ </div>
118
+
119
+ <div class="content"><div class='highlight'><pre> groupdocs.api_server = settings.base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
120
+ <span class="keyword">end</span></pre></div></div>
121
+
122
+ </li>
123
+
124
+
125
+ <li id="section-7">
126
+ <div class="annotation">
127
+
128
+ <div class="pilwrap ">
129
+ <a class="pilcrow" href="#section-7">&#182;</a>
130
+ </div>
131
+ <p>Make a request to API using client_id and private_key</p>
132
+
133
+ </div>
134
+
135
+ <div class="content"><div class='highlight'><pre> files_list = <span class="constant">GroupDocs::Storage::Folder</span>.list!(<span class="string">'/'</span>, {<span class="symbol">:extended</span> =&gt; <span class="keyword">true</span>}, {<span class="symbol">:client_id</span> =&gt; settings.client_id, <span class="symbol">:private_key</span> =&gt; settings.private_key})</pre></div></div>
136
+
137
+ </li>
138
+
139
+
140
+ <li id="section-8">
141
+ <div class="annotation">
142
+
143
+ <div class="pilwrap ">
144
+ <a class="pilcrow" href="#section-8">&#182;</a>
145
+ </div>
146
+ <p>Construct result string</p>
111
147
 
112
148
  </div>
113
149
 
@@ -116,7 +152,6 @@
116
152
  <span class="keyword">if</span> element.<span class="keyword">class</span>.name.split(<span class="string">'::'</span>).last == <span class="string">'Folder'</span>
117
153
  <span class="keyword">next</span>
118
154
  <span class="keyword">end</span>
119
-
120
155
  <span class="keyword">if</span> element.thumbnail
121
156
  name = element.name
122
157
  thumbnails += <span class="string">"&lt;p&gt;&lt;img src='data:image/png;base64,<span class="subst">#{element.thumbnail}</span>', width='40px', height='40px'&gt; <span class="subst">#{name}</span>&lt;/p&gt;"</span>
@@ -134,17 +169,17 @@
134
169
  </li>
135
170
 
136
171
 
137
- <li id="section-7">
172
+ <li id="section-9">
138
173
  <div class="annotation">
139
174
 
140
175
  <div class="pilwrap ">
141
- <a class="pilcrow" href="#section-7">&#182;</a>
176
+ <a class="pilcrow" href="#section-9">&#182;</a>
142
177
  </div>
143
- <p>set variables for template</p>
178
+ <p>Set variables for template</p>
144
179
 
145
180
  </div>
146
181
 
147
- <div class="content"><div class='highlight'><pre> haml <span class="symbol">:sample7</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">:thumbnailList</span> =&gt; thumbnails, <span class="symbol">:err</span> =&gt; err}
182
+ <div class="content"><div class='highlight'><pre> haml <span class="symbol">:sample07</span>, <span class="symbol">:locals</span> =&gt; {<span class="symbol">:clientId</span> =&gt; settings.client_id, <span class="symbol">:privateKey</span> =&gt; settings.private_key, <span class="symbol">:thumbnailList</span> =&gt; thumbnails, <span class="symbol">:err</span> =&gt; err}
148
183
  <span class="keyword">end</span></pre></div></div>
149
184
 
150
185
  </li>
@@ -2,7 +2,7 @@
2
2
 
3
3
  <html>
4
4
  <head>
5
- <title>sample8.rb</title>
5
+ <title>sample08.rb</title>
6
6
  <meta http-equiv="content-type" content="text/html; charset=UTF-8">
7
7
  <meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
8
8
  <link rel="stylesheet" media="all" href="docco.css" />
@@ -15,7 +15,7 @@
15
15
 
16
16
  <li id="title">
17
17
  <div class="annotation">
18
- <h1>sample8.rb</h1>
18
+ <h1>sample08.rb</h1>
19
19
  </div>
20
20
  </li>
21
21
 
@@ -31,8 +31,8 @@
31
31
 
32
32
  </div>
33
33
 
34
- <div class="content"><div class='highlight'><pre>get <span class="string">'/sample8'</span> <span class="keyword">do</span>
35
- haml <span class="symbol">:sample8</span>
34
+ <div class="content"><div class='highlight'><pre>get <span class="string">'/sample08'</span> <span class="keyword">do</span>
35
+ haml <span class="symbol">:sample08</span>
36
36
  <span class="keyword">end</span></pre></div></div>
37
37
 
38
38
  </li>
@@ -48,7 +48,7 @@
48
48
 
49
49
  </div>
50
50
 
51
- <div class="content"><div class='highlight'><pre>post <span class="string">'/sample8'</span> <span class="keyword">do</span></pre></div></div>
51
+ <div class="content"><div class='highlight'><pre>post <span class="string">'/sample08'</span> <span class="keyword">do</span></pre></div></div>
52
52
 
53
53
  </li>
54
54
 
@@ -59,14 +59,19 @@
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
 
66
- <div class="content"><div class='highlight'><pre> set <span class="symbol">:client_id</span>, params[<span class="symbol">:client_id</span>]
67
- set <span class="symbol">:private_key</span>, params[<span class="symbol">:private_key</span>]
66
+ <div class="content"><div class='highlight'><pre> set <span class="symbol">:client_id</span>, params[<span class="symbol">:clientId</span>]
67
+ set <span class="symbol">:private_key</span>, params[<span class="symbol">:privateKey</span>]
68
68
  set <span class="symbol">:guid</span>, params[<span class="symbol">:guid</span>]
69
- set <span class="symbol">:page_number</span>, params[<span class="symbol">:page_number</span>]</pre></div></div>
69
+ set <span class="symbol">:page_number</span>, params[<span class="symbol">:pageNumber</span>]
70
+ set <span class="symbol">:source</span>, params[<span class="symbol">:source</span>]
71
+ set <span class="symbol">:file_id</span>, params[<span class="symbol">:fileId</span>]
72
+ set <span class="symbol">:base_path</span>, params[<span class="symbol">:basePath</span>]
73
+
74
+ <span class="keyword">begin</span></pre></div></div>
70
75
 
71
76
  </li>
72
77
 
@@ -77,13 +82,13 @@
77
82
  <div class="pilwrap ">
78
83
  <a class="pilcrow" href="#section-4">&#182;</a>
79
84
  </div>
80
- <p> file = GroupDocs::Storage::Folder.list!.last
81
- document = file.to_document
82
- document.page_images! 1024, 768, first_page: 0, page_count: 1</p>
85
+ <p>Check required variables</p>
83
86
 
84
87
  </div>
85
88
 
86
- <div class="content"><div class='highlight'><pre> <span class="keyword">begin</span></pre></div></div>
89
+ <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?
90
+
91
+ <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>
87
92
 
88
93
  </li>
89
94
 
@@ -94,11 +99,29 @@
94
99
  <div class="pilwrap ">
95
100
  <a class="pilcrow" href="#section-5">&#182;</a>
96
101
  </div>
97
- <p>check required variables</p>
102
+ <p>Configure your access to API server</p>
98
103
 
99
104
  </div>
100
105
 
101
- <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?
106
+ <div class="content"><div class='highlight'><pre> <span class="constant">GroupDocs</span>.configure <span class="keyword">do</span> |groupdocs|
107
+ groupdocs.client_id = settings.client_id
108
+ groupdocs.private_key = settings.private_key</pre></div></div>
109
+
110
+ </li>
111
+
112
+
113
+ <li id="section-6">
114
+ <div class="annotation">
115
+
116
+ <div class="pilwrap ">
117
+ <a class="pilcrow" href="#section-6">&#182;</a>
118
+ </div>
119
+ <p>Optionally specify API server and version</p>
120
+
121
+ </div>
122
+
123
+ <div class="content"><div class='highlight'><pre> groupdocs.api_server = settings.base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
124
+ <span class="keyword">end</span>
102
125
 
103
126
  file = <span class="keyword">nil</span>
104
127
  doc = <span class="keyword">nil</span>
@@ -107,13 +130,13 @@
107
130
  </li>
108
131
 
109
132
 
110
- <li id="section-6">
133
+ <li id="section-7">
111
134
  <div class="annotation">
112
135
 
113
136
  <div class="pilwrap ">
114
- <a class="pilcrow" href="#section-6">&#182;</a>
137
+ <a class="pilcrow" href="#section-7">&#182;</a>
115
138
  </div>
116
- <p>get document by file GUID</p>
139
+ <p>Get document by file GUID</p>
117
140
 
118
141
  </div>
119
142
 
@@ -125,13 +148,13 @@
125
148
  </li>
126
149
 
127
150
 
128
- <li id="section-7">
151
+ <li id="section-8">
129
152
  <div class="annotation">
130
153
 
131
154
  <div class="pilwrap ">
132
- <a class="pilcrow" href="#section-7">&#182;</a>
155
+ <a class="pilcrow" href="#section-8">&#182;</a>
133
156
  </div>
134
- <p>construct path</p>
157
+ <p>Construct path</p>
135
158
 
136
159
  </div>
137
160
 
@@ -140,13 +163,13 @@
140
163
  </li>
141
164
 
142
165
 
143
- <li id="section-8">
166
+ <li id="section-9">
144
167
  <div class="annotation">
145
168
 
146
169
  <div class="pilwrap ">
147
- <a class="pilcrow" href="#section-8">&#182;</a>
170
+ <a class="pilcrow" href="#section-9">&#182;</a>
148
171
  </div>
149
- <p>open file</p>
172
+ <p>Open file</p>
150
173
 
151
174
  </div>
152
175
 
@@ -155,51 +178,51 @@
155
178
  </li>
156
179
 
157
180
 
158
- <li id="section-9">
181
+ <li id="section-10">
159
182
  <div class="annotation">
160
183
 
161
184
  <div class="pilwrap ">
162
- <a class="pilcrow" href="#section-9">&#182;</a>
185
+ <a class="pilcrow" href="#section-10">&#182;</a>
163
186
  </div>
164
- <p>make a request to API using client_id and private_key</p>
187
+ <p>Make a request to API using client_id and private_key</p>
165
188
 
166
189
  </div>
167
190
 
168
- <div class="content"><div class='highlight'><pre> file = <span class="constant">GroupDocs::Storage::File</span>.upload!(filepath, {}, <span class="symbol">client_id:</span> settings.client_id, <span class="symbol">private_key:</span> settings.private_key)
191
+ <div class="content"><div class='highlight'><pre> file = <span class="constant">GroupDocs::Storage::File</span>.upload!(filepath, {})
169
192
  <span class="keyword">when</span> <span class="string">'url'</span>
170
- file = <span class="constant">GroupDocs::Storage::File</span>.upload_web!(settings.url, <span class="symbol">client_id:</span> settings.client_id, <span class="symbol">private_key:</span> settings.private_key)
193
+ file = <span class="constant">GroupDocs::Storage::File</span>.upload_web!(settings.url)
171
194
  <span class="keyword">else</span>
172
195
  raise <span class="string">'Wrong GUID source.'</span>
173
196
  <span class="keyword">end</span>
174
197
 
175
198
  doc = file.to_document
176
- metadata = doc.metadata!({<span class="symbol">:client_id</span> =&gt; settings.client_id, <span class="symbol">:private_key</span> =&gt; settings.private_key})</pre></div></div>
199
+ metadata = doc.metadata!()</pre></div></div>
177
200
 
178
201
  </li>
179
202
 
180
203
 
181
- <li id="section-10">
204
+ <li id="section-11">
182
205
  <div class="annotation">
183
206
 
184
207
  <div class="pilwrap ">
185
- <a class="pilcrow" href="#section-10">&#182;</a>
208
+ <a class="pilcrow" href="#section-11">&#182;</a>
186
209
  </div>
187
- <p>get document page images</p>
210
+ <p>Get document page images</p>
188
211
 
189
212
  </div>
190
213
 
191
- <div class="content"><div class='highlight'><pre> images = doc.page_images!(<span class="number">800</span>, <span class="number">400</span>, {<span class="symbol">:first_page</span> =&gt; <span class="number">0</span>, <span class="symbol">:page_count</span> =&gt; metadata.page_count}, {<span class="symbol">:client_id</span> =&gt; settings.client_id, <span class="symbol">:private_key</span> =&gt; settings.private_key})</pre></div></div>
214
+ <div class="content"><div class='highlight'><pre> images = doc.page_images!(<span class="number">800</span>, <span class="number">400</span>, {<span class="symbol">:first_page</span> =&gt; <span class="number">0</span>, <span class="symbol">:page_count</span> =&gt; metadata.views_count})</pre></div></div>
192
215
 
193
216
  </li>
194
217
 
195
218
 
196
- <li id="section-11">
219
+ <li id="section-12">
197
220
  <div class="annotation">
198
221
 
199
222
  <div class="pilwrap ">
200
- <a class="pilcrow" href="#section-11">&#182;</a>
223
+ <a class="pilcrow" href="#section-12">&#182;</a>
201
224
  </div>
202
- <p>result</p>
225
+ <p>Result</p>
203
226
 
204
227
  </div>
205
228
 
@@ -214,17 +237,17 @@
214
237
  </li>
215
238
 
216
239
 
217
- <li id="section-12">
240
+ <li id="section-13">
218
241
  <div class="annotation">
219
242
 
220
243
  <div class="pilwrap ">
221
- <a class="pilcrow" href="#section-12">&#182;</a>
244
+ <a class="pilcrow" href="#section-13">&#182;</a>
222
245
  </div>
223
- <p>set variables for template</p>
246
+ <p>Set variables for template</p>
224
247
 
225
248
  </div>
226
249
 
227
- <div class="content"><div class='highlight'><pre> haml <span class="symbol">:sample8</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">:guid</span> =&gt; settings.guid, <span class="symbol">:page_number</span> =&gt; settings.page_number, <span class="symbol">:image</span> =&gt; image, <span class="symbol">:err</span> =&gt; err}
250
+ <div class="content"><div class='highlight'><pre> haml <span class="symbol">:sample08</span>, <span class="symbol">:locals</span> =&gt; {<span class="symbol">:clientId</span> =&gt; settings.client_id, <span class="symbol">:privateKey</span> =&gt; settings.private_key, <span class="symbol">:guid</span> =&gt; settings.guid, <span class="symbol">:pageNumber</span> =&gt; settings.page_number, <span class="symbol">:image</span> =&gt; image, <span class="symbol">:err</span> =&gt; err}
228
251
  <span class="keyword">end</span></pre></div></div>
229
252
 
230
253
  </li>
@@ -0,0 +1,260 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <title>sample09.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>sample09.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="string">'/sample09'</span> <span class="keyword">do</span>
35
+ haml <span class="symbol">:sample09</span>
36
+ <span class="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="string">'/sample09'</span> <span class="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="symbol">:file_id</span>, params[<span class="symbol">:fileId</span>]
67
+ set <span class="symbol">:width</span>, params[<span class="symbol">:width</span>]
68
+ set <span class="symbol">:height</span>, params[<span class="symbol">:height</span>]
69
+ set <span class="symbol">:source</span>, params[<span class="symbol">:source</span>]
70
+ set <span class="symbol">:client_id</span>, params[<span class="symbol">:clientId</span>]
71
+ set <span class="symbol">:private_key</span>, params[<span class="symbol">:privateKey</span>]
72
+ set <span class="symbol">:check</span>, params[<span class="symbol">:check</span>]
73
+ set <span class="symbol">:url</span>, params[<span class="symbol">:url</span>]
74
+ set <span class="symbol">:base_path</span>, params[<span class="symbol">:basePath</span>]
75
+
76
+ <span class="keyword">begin</span></pre></div></div>
77
+
78
+ </li>
79
+
80
+
81
+ <li id="section-4">
82
+ <div class="annotation">
83
+
84
+ <div class="pilwrap ">
85
+ <a class="pilcrow" href="#section-4">&#182;</a>
86
+ </div>
87
+ <p>Check required variables</p>
88
+
89
+ </div>
90
+
91
+ <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.width.empty? <span class="keyword">or</span> settings.height.empty?
92
+
93
+ <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>
94
+
95
+ </li>
96
+
97
+
98
+ <li id="section-5">
99
+ <div class="annotation">
100
+
101
+ <div class="pilwrap ">
102
+ <a class="pilcrow" href="#section-5">&#182;</a>
103
+ </div>
104
+ <p>Configure your access to API server</p>
105
+
106
+ </div>
107
+
108
+ <div class="content"><div class='highlight'><pre> <span class="constant">GroupDocs</span>.configure <span class="keyword">do</span> |groupdocs|
109
+ groupdocs.client_id = settings.client_id
110
+ groupdocs.private_key = settings.private_key</pre></div></div>
111
+
112
+ </li>
113
+
114
+
115
+ <li id="section-6">
116
+ <div class="annotation">
117
+
118
+ <div class="pilwrap ">
119
+ <a class="pilcrow" href="#section-6">&#182;</a>
120
+ </div>
121
+ <p>Optionally specify API server and version</p>
122
+
123
+ </div>
124
+
125
+ <div class="content"><div class='highlight'><pre> groupdocs.api_server = settings.base_path <span class="comment"># default is 'https://api.groupdocs.com'</span>
126
+ <span class="keyword">end</span></pre></div></div>
127
+
128
+ </li>
129
+
130
+
131
+ <li id="section-7">
132
+ <div class="annotation">
133
+
134
+ <div class="pilwrap ">
135
+ <a class="pilcrow" href="#section-7">&#182;</a>
136
+ </div>
137
+ <p>Get document by file GUID</p>
138
+
139
+ </div>
140
+
141
+ <div class="content"><div class='highlight'><pre> file = <span class="keyword">nil</span>
142
+ <span class="keyword">case</span> settings.source
143
+ <span class="keyword">when</span> <span class="string">'guid'</span>
144
+ file = <span class="constant">GroupDocs::Storage::File</span>.new({<span class="symbol">:guid</span> =&gt; settings.file_id})
145
+ <span class="keyword">when</span> <span class="string">'local'</span></pre></div></div>
146
+
147
+ </li>
148
+
149
+
150
+ <li id="section-8">
151
+ <div class="annotation">
152
+
153
+ <div class="pilwrap ">
154
+ <a class="pilcrow" href="#section-8">&#182;</a>
155
+ </div>
156
+ <p>Construct path</p>
157
+
158
+ </div>
159
+
160
+ <div class="content"><div class='highlight'><pre> filepath = <span class="string">"<span class="subst">#{<span class="constant">Dir</span>.tmpdir}</span>/<span class="subst">#{params[<span class="symbol">:file</span>][<span class="symbol">:filename</span>]}</span>"</span></pre></div></div>
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>Open file</p>
172
+
173
+ </div>
174
+
175
+ <div class="content"><div class='highlight'><pre> <span class="constant">File</span>.open(filepath, <span class="string">'wb'</span>) { |f| f.write(params[<span class="symbol">:file</span>][<span class="symbol">:tempfile</span>].read) }</pre></div></div>
176
+
177
+ </li>
178
+
179
+
180
+ <li id="section-10">
181
+ <div class="annotation">
182
+
183
+ <div class="pilwrap ">
184
+ <a class="pilcrow" href="#section-10">&#182;</a>
185
+ </div>
186
+ <p>Make a request to API using client_id and private_key</p>
187
+
188
+ </div>
189
+
190
+ <div class="content"><div class='highlight'><pre> file = <span class="constant">GroupDocs::Storage::File</span>.upload!(filepath, {})
191
+ <span class="keyword">when</span> <span class="string">'url'</span>
192
+ file = <span class="constant">GroupDocs::Storage::File</span>.upload_web!(settings.url)
193
+ <span class="keyword">else</span>
194
+ raise <span class="string">'Wrong GUID source.'</span>
195
+ <span class="keyword">end</span>
196
+ url = <span class="keyword">nil</span>
197
+
198
+ <span class="keyword">case</span> settings.check
199
+ <span class="keyword">when</span> <span class="string">'viewer'</span>
200
+ <span class="keyword">case</span> settings.base_path
201
+ <span class="keyword">when</span> <span class="string">'https://stage-api-groupdocs.dynabic.com'</span>
202
+ url = <span class="string">"http://stage-apps-groupdocs.dynabic.com/document-viewer/embed/<span class="subst">#{file.guid}</span>?frameborder='0' width='<span class="subst">#{settings.width}</span>' height='<span class="subst">#{settings.height}</span>'"</span>
203
+ <span class="keyword">when</span> <span class="string">'https://dev-api-groupdocs.dynabic.com'</span>
204
+ url = <span class="string">"http://dev-apps-groupdocs.dynabic.com/document-viewer/embed/<span class="subst">#{file.guid}</span>?frameborder='0' width='<span class="subst">#{settings.width}</span>' height='<span class="subst">#{settings.height}</span>'"</span>
205
+ <span class="keyword">else</span>
206
+ url = <span class="string">"https://apps.groupdocs.com/document-viewer/embed/<span class="subst">#{file.guid}</span>?frameborder='0' width='<span class="subst">#{settings.width}</span>' height='<span class="subst">#{settings.height}</span>'"</span>
207
+ <span class="keyword">end</span>
208
+
209
+ <span class="keyword">when</span> <span class="string">'annotation'</span>
210
+ <span class="keyword">case</span> settings.base_path
211
+ <span class="keyword">when</span> <span class="string">'https://stage-api-groupdocs.dynabic.com'</span>
212
+ url = <span class="string">"http://stage-apps-groupdocs.dynabic.com/document-annotation2/embed/<span class="subst">#{file.guid}</span>?frameborder='0' width='<span class="subst">#{settings.width}</span>' height='<span class="subst">#{settings.height}</span>'"</span>
213
+ <span class="keyword">when</span> <span class="string">'https://dev-api-groupdocs.dynabic.com'</span>
214
+ url = <span class="string">"http://dev-apps-groupdocs.dynabic.com/document-annotation2/embed/<span class="subst">#{file.guid}</span>?frameborder='0' width='<span class="subst">#{settings.width}</span>' height='<span class="subst">#{settings.height}</span>'"</span>
215
+ <span class="keyword">else</span>
216
+ url = <span class="string">"https://apps.groupdocs.com/document-annotation2/embed/<span class="subst">#{file.guid}</span>?frameborder='0' width='<span class="subst">#{settings.width}</span>' height='<span class="subst">#{settings.height}</span>'"</span>
217
+ <span class="keyword">end</span>
218
+ <span class="keyword">end</span></pre></div></div>
219
+
220
+ </li>
221
+
222
+
223
+ <li id="section-11">
224
+ <div class="annotation">
225
+
226
+ <div class="pilwrap ">
227
+ <a class="pilcrow" href="#section-11">&#182;</a>
228
+ </div>
229
+ <p>Construct result string</p>
230
+
231
+ </div>
232
+
233
+ <div class="content"><div class='highlight'><pre> url = <span class="constant">GroupDocs::Api::Request</span>.new(<span class="symbol">:path</span> =&gt; url).prepare_and_sign_url
234
+
235
+ <span class="keyword">rescue</span> <span class="constant">Exception</span> =&gt; e
236
+ err = e.message
237
+ <span class="keyword">end</span></pre></div></div>
238
+
239
+ </li>
240
+
241
+
242
+ <li id="section-12">
243
+ <div class="annotation">
244
+
245
+ <div class="pilwrap ">
246
+ <a class="pilcrow" href="#section-12">&#182;</a>
247
+ </div>
248
+ <p>Set variables for template</p>
249
+
250
+ </div>
251
+
252
+ <div class="content"><div class='highlight'><pre> haml <span class="symbol">:sample09</span>, <span class="symbol">:locals</span> =&gt; {<span class="symbol">:guid</span> =&gt; file.guid, <span class="symbol">:width</span> =&gt; settings.width, <span class="symbol">:height</span> =&gt; settings.height, <span class="symbol">:v_url</span> =&gt; url, <span class="symbol">:err</span> =&gt; err}
253
+ <span class="keyword">end</span></pre></div></div>
254
+
255
+ </li>
256
+
257
+ </ul>
258
+ </div>
259
+ </body>
260
+ </html>