echochamber 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (122) hide show
  1. checksums.yaml +7 -0
  2. data/.gitignore +4 -0
  3. data/.rspec +2 -0
  4. data/Gemfile +3 -0
  5. data/Gemfile.lock +79 -0
  6. data/LICENSE +21 -0
  7. data/LICENSE.txt +22 -0
  8. data/README.md +87 -0
  9. data/Rakefile +12 -0
  10. data/doc/Echochamber.html +131 -0
  11. data/doc/Echochamber/Agreement.html +529 -0
  12. data/doc/Echochamber/Agreement/UrlFileInfo.html +263 -0
  13. data/doc/Echochamber/Client.html +4161 -0
  14. data/doc/Echochamber/CounterSignerInfo.html +265 -0
  15. data/doc/Echochamber/Credentials.html +330 -0
  16. data/doc/Echochamber/Credentials/CredentialsError.html +123 -0
  17. data/doc/Echochamber/Fileinfo.html +303 -0
  18. data/doc/Echochamber/InvalidParameterError.html +123 -0
  19. data/doc/Echochamber/ParameterError.html +123 -0
  20. data/doc/Echochamber/PhoneInfo.html +279 -0
  21. data/doc/Echochamber/Recipient.html +309 -0
  22. data/doc/Echochamber/RecipientSecurityOption.html +294 -0
  23. data/doc/Echochamber/Reminder.html +277 -0
  24. data/doc/Echochamber/Request.html +4167 -0
  25. data/doc/Echochamber/Request/Failure.html +123 -0
  26. data/doc/Echochamber/RequiredParameterError.html +123 -0
  27. data/doc/Echochamber/UrlFileInfo.html +295 -0
  28. data/doc/Echochamber/User.html +420 -0
  29. data/doc/Echochamber/Validatable.html +355 -0
  30. data/doc/Echochamber/Validator.html +180 -0
  31. data/doc/Echochamber/Widget.html +654 -0
  32. data/doc/Echochamber/WidgetCompletionInfo.html +309 -0
  33. data/doc/Echochamber/WidgetPersonalization.html +326 -0
  34. data/doc/Echochamber/WidgetSecurityOption.html +359 -0
  35. data/doc/Echochamber/WidgetSignerSecurityOption.html +296 -0
  36. data/doc/Echochamber/WidgetStatus.html +314 -0
  37. data/doc/Echochamber/WidgetVaultingInfo.html +265 -0
  38. data/doc/_index.html +338 -0
  39. data/doc/class_list.html +54 -0
  40. data/doc/css/common.css +1 -0
  41. data/doc/css/full_list.css +57 -0
  42. data/doc/css/style.css +339 -0
  43. data/doc/file.README.html +157 -0
  44. data/doc/file_list.html +56 -0
  45. data/doc/frames.html +26 -0
  46. data/doc/index.html +157 -0
  47. data/doc/js/app.js +219 -0
  48. data/doc/js/full_list.js +178 -0
  49. data/doc/js/jquery.js +4 -0
  50. data/doc/method_list.html +581 -0
  51. data/doc/top-level-namespace.html +112 -0
  52. data/echochamber.gemspec +35 -0
  53. data/features/support/env.rb +8 -0
  54. data/fixtures/agreement.pdf +0 -0
  55. data/fixtures/vcr_cassettes/agreement_combined_pdf.yml +1465 -0
  56. data/fixtures/vcr_cassettes/agreement_document_file.yml +1465 -0
  57. data/fixtures/vcr_cassettes/agreement_documents.yml +42 -0
  58. data/fixtures/vcr_cassettes/agreement_form_data.yml +44 -0
  59. data/fixtures/vcr_cassettes/agreement_info.yml +50 -0
  60. data/fixtures/vcr_cassettes/agreement_signing_urls.yml +42 -0
  61. data/fixtures/vcr_cassettes/audit_trail_pdf.yml +1643 -0
  62. data/fixtures/vcr_cassettes/cancel_agreement.yml +46 -0
  63. data/fixtures/vcr_cassettes/create_agreement.yml +50 -0
  64. data/fixtures/vcr_cassettes/create_reminder.yml +47 -0
  65. data/fixtures/vcr_cassettes/create_transient_document.yml +716 -0
  66. data/fixtures/vcr_cassettes/create_user.yml +50 -0
  67. data/fixtures/vcr_cassettes/create_widget.yml +48 -0
  68. data/fixtures/vcr_cassettes/get_agreements.yml +46 -0
  69. data/fixtures/vcr_cassettes/get_library_document.yml +45 -0
  70. data/fixtures/vcr_cassettes/get_library_document_data.yml +1191 -0
  71. data/fixtures/vcr_cassettes/get_library_document_file.yml +42 -0
  72. data/fixtures/vcr_cassettes/get_library_documents.yml +47 -0
  73. data/fixtures/vcr_cassettes/get_token.yml +44 -0
  74. data/fixtures/vcr_cassettes/get_user.yml +46 -0
  75. data/fixtures/vcr_cassettes/get_users.yml +43 -0
  76. data/fixtures/vcr_cassettes/get_widget.yml +49 -0
  77. data/fixtures/vcr_cassettes/get_widget_document_file.yml +2682 -0
  78. data/fixtures/vcr_cassettes/get_widget_documents.yml +44 -0
  79. data/fixtures/vcr_cassettes/get_widgets.yml +50 -0
  80. data/fixtures/vcr_cassettes/library_combined_document.yml +2197 -0
  81. data/fixtures/vcr_cassettes/library_document_audit_trail.yml +1570 -0
  82. data/fixtures/vcr_cassettes/personalize_widget.yml +47 -0
  83. data/fixtures/vcr_cassettes/update_widget_status.yml +46 -0
  84. data/lib/echochamber.rb +10 -0
  85. data/lib/echochamber/agreement.rb +32 -0
  86. data/lib/echochamber/agreement/client.rb +118 -0
  87. data/lib/echochamber/agreement/fileinfo.rb +20 -0
  88. data/lib/echochamber/agreement/phone_info.rb +19 -0
  89. data/lib/echochamber/agreement/recipient.rb +23 -0
  90. data/lib/echochamber/agreement/recipient_security_option.rb +20 -0
  91. data/lib/echochamber/agreement/request.rb +142 -0
  92. data/lib/echochamber/agreement/url_file_info.rb +18 -0
  93. data/lib/echochamber/client.rb +82 -0
  94. data/lib/echochamber/credentials.rb +33 -0
  95. data/lib/echochamber/library_documents/client.rb +83 -0
  96. data/lib/echochamber/library_documents/request.rb +78 -0
  97. data/lib/echochamber/reminder.rb +17 -0
  98. data/lib/echochamber/request.rb +141 -0
  99. data/lib/echochamber/user.rb +29 -0
  100. data/lib/echochamber/validatable.rb +54 -0
  101. data/lib/echochamber/version.rb +3 -0
  102. data/lib/echochamber/widget.rb +42 -0
  103. data/lib/echochamber/widget/client.rb +127 -0
  104. data/lib/echochamber/widget/counter_signer_info.rb +19 -0
  105. data/lib/echochamber/widget/request.rb +135 -0
  106. data/lib/echochamber/widget/widget_completion_info.rb +19 -0
  107. data/lib/echochamber/widget/widget_personalization.rb +21 -0
  108. data/lib/echochamber/widget/widget_security_option.rb +22 -0
  109. data/lib/echochamber/widget/widget_signer_security_option.rb +18 -0
  110. data/lib/echochamber/widget/widget_status.rb +20 -0
  111. data/lib/echochamber/widget/widget_vaulting_info.rb +16 -0
  112. data/spec/lib/agreement/client_spec.rb +157 -0
  113. data/spec/lib/client_spec.rb +78 -0
  114. data/spec/lib/library_documents/client_spec.rb +71 -0
  115. data/spec/lib/request_spec.rb +18 -0
  116. data/spec/lib/shared_client.rb +22 -0
  117. data/spec/lib/user_spec.rb +6 -0
  118. data/spec/lib/validatable_spec.rb +110 -0
  119. data/spec/lib/version_spec.rb +7 -0
  120. data/spec/lib/widget/client_spec.rb +154 -0
  121. data/spec/spec_helper.rb +21 -0
  122. metadata +344 -0
data/doc/Echochamber/Validator.html ADDED
@@ -0,0 +1,180 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Module: Echochamber::Validator
8
+
9
+ &mdash; Documentation by YARD 0.8.7.4
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!Echochamber/Validator.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (V)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Echochamber.html" title="Echochamber (module)">Echochamber</a></span></span>
36
+ &raquo;
37
+ <span class="title">Validator</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Module: Echochamber::Validator
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+
75
+
76
+
77
+
78
+
79
+
80
+
81
+ <dt class="r1 last">Defined in:</dt>
82
+ <dd class="r1 last">lib/echochamber/validate.rb</dd>
83
+
84
+ </dl>
85
+ <div class="clear"></div>
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <h2>
96
+ Class Method Summary
97
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
98
+ </h2>
99
+
100
+ <ul class="summary">
101
+
102
+ <li class="public ">
103
+ <span class="summary_signature">
104
+
105
+ <a href="#validate-class_method" title="validate (class method)">+ (Object) <strong>validate</strong>(required_fields, params) </a>
106
+
107
+
108
+
109
+ </span>
110
+
111
+
112
+
113
+
114
+
115
+
116
+
117
+
118
+
119
+ <span class="summary_desc"><div class='inline'></div></span>
120
+
121
+ </li>
122
+
123
+
124
+ </ul>
125
+
126
+
127
+
128
+
129
+ <div id="class_method_details" class="method_details_list">
130
+ <h2>Class Method Details</h2>
131
+
132
+
133
+ <div class="method_details first">
134
+ <h3 class="signature first" id="validate-class_method">
135
+
136
+ + (<tt>Object</tt>) <strong>validate</strong>(required_fields, params)
137
+
138
+
139
+
140
+
141
+
142
+ </h3><table class="source_code">
143
+ <tr>
144
+ <td>
145
+ <pre class="lines">
146
+
147
+
148
+ 7
149
+ 8
150
+ 9
151
+ 10
152
+ 11
153
+ 12</pre>
154
+ </td>
155
+ <td>
156
+ <pre class="code"><span class="info file"># File 'lib/echochamber/validate.rb', line 7</span>
157
+
158
+ <span class='kw'>def</span> <span class='kw'>self</span><span class='period'>.</span><span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='id identifier rubyid_required_fields'>required_fields</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
159
+ <span class='ivar'>@params</span> <span class='op'>=</span> <span class='id identifier rubyid_params'>params</span>
160
+ <span class='id identifier rubyid_required_fields'>required_fields</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_field'>field</span><span class='op'>|</span>
161
+ <span class='id identifier rubyid_validate_field'>validate_field</span><span class='lparen'>(</span><span class='id identifier rubyid_field'>field</span><span class='rparen'>)</span>
162
+ <span class='kw'>end</span>
163
+ <span class='kw'>end</span></pre>
164
+ </td>
165
+ </tr>
166
+ </table>
167
+ </div>
168
+
169
+ </div>
170
+
171
+ </div>
172
+
173
+ <div id="footer">
174
+ Generated on Sat Aug 16 05:33:16 2014 by
175
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
176
+ 0.8.7.4 (ruby-2.0.0).
177
+ </div>
178
+
179
+ </body>
180
+ </html>
data/doc/Echochamber/Widget.html ADDED
@@ -0,0 +1,654 @@
1
+ <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
2
+ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3
+ <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4
+ <head>
5
+ <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
6
+ <title>
7
+ Class: Echochamber::Widget
8
+
9
+ &mdash; Documentation by YARD 0.8.7.4
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../css/style.css" type="text/css" charset="utf-8" />
14
+
15
+ <link rel="stylesheet" href="../css/common.css" type="text/css" charset="utf-8" />
16
+
17
+ <script type="text/javascript" charset="utf-8">
18
+ hasFrames = window.top.frames.main ? true : false;
19
+ relpath = '../';
20
+ framesUrl = "../frames.html#!Echochamber/Widget.html";
21
+ </script>
22
+
23
+
24
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
25
+
26
+ <script type="text/javascript" charset="utf-8" src="../js/app.js"></script>
27
+
28
+
29
+ </head>
30
+ <body>
31
+ <div id="header">
32
+ <div id="menu">
33
+
34
+ <a href="../_index.html">Index (W)</a> &raquo;
35
+ <span class='title'><span class='object_link'><a href="../Echochamber.html" title="Echochamber (module)">Echochamber</a></span></span>
36
+ &raquo;
37
+ <span class="title">Widget</span>
38
+
39
+
40
+ <div class="noframes"><span class="title">(</span><a href="." target="_top">no frames</a><span class="title">)</span></div>
41
+ </div>
42
+
43
+ <div id="search">
44
+
45
+ <a class="full_list_link" id="class_list_link"
46
+ href="../class_list.html">
47
+ Class List
48
+ </a>
49
+
50
+ <a class="full_list_link" id="method_list_link"
51
+ href="../method_list.html">
52
+ Method List
53
+ </a>
54
+
55
+ <a class="full_list_link" id="file_list_link"
56
+ href="../file_list.html">
57
+ File List
58
+ </a>
59
+
60
+ </div>
61
+ <div class="clear"></div>
62
+ </div>
63
+
64
+ <iframe id="search_frame"></iframe>
65
+
66
+ <div id="content"><h1>Class: Echochamber::Widget
67
+
68
+
69
+
70
+ </h1>
71
+
72
+ <dl class="box">
73
+
74
+ <dt class="r1">Inherits:</dt>
75
+ <dd class="r1">
76
+ <span class="inheritName">Hash</span>
77
+
78
+ <ul class="fullTree">
79
+ <li>Object</li>
80
+
81
+ <li class="next">Hash</li>
82
+
83
+ <li class="next">Echochamber::Widget</li>
84
+
85
+ </ul>
86
+ <a href="#" class="inheritanceTree">show all</a>
87
+
88
+ </dd>
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dt class="r2">Includes:</dt>
96
+ <dd class="r2"><span class='object_link'><a href="Validatable.html" title="Echochamber::Validatable (module)">Validatable</a></span></dd>
97
+
98
+
99
+
100
+
101
+
102
+ <dt class="r1 last">Defined in:</dt>
103
+ <dd class="r1 last">lib/echochamber/widget.rb</dd>
104
+
105
+ </dl>
106
+ <div class="clear"></div>
107
+
108
+
109
+
110
+
111
+
112
+ <h2>Instance Attribute Summary <small>(<a href="#" class="summary_toggle">collapse</a>)</small></h2>
113
+ <ul class="summary">
114
+
115
+ <li class="public ">
116
+ <span class="summary_signature">
117
+
118
+ <a href="#user_email-instance_method" title="#user_email (instance method)">- (Object) <strong>user_email</strong> </a>
119
+
120
+
121
+
122
+ </span>
123
+
124
+
125
+
126
+
127
+ <span class="note title readonly">readonly</span>
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+
137
+ <span class="summary_desc"><div class='inline'>
138
+ <p>Returns the value of attribute user_email.</p>
139
+ </div></span>
140
+
141
+ </li>
142
+
143
+
144
+ <li class="public ">
145
+ <span class="summary_signature">
146
+
147
+ <a href="#user_id-instance_method" title="#user_id (instance method)">- (Object) <strong>user_id</strong> </a>
148
+
149
+
150
+
151
+ </span>
152
+
153
+
154
+
155
+
156
+ <span class="note title readonly">readonly</span>
157
+
158
+
159
+
160
+
161
+
162
+
163
+
164
+
165
+
166
+ <span class="summary_desc"><div class='inline'>
167
+ <p>Returns the value of attribute user_id.</p>
168
+ </div></span>
169
+
170
+ </li>
171
+
172
+
173
+ </ul>
174
+
175
+
176
+
177
+
178
+
179
+ <h2>
180
+ Instance Method Summary
181
+ <small>(<a href="#" class="summary_toggle">collapse</a>)</small>
182
+ </h2>
183
+
184
+ <ul class="summary">
185
+
186
+ <li class="public ">
187
+ <span class="summary_signature">
188
+
189
+ <a href="#initialize-instance_method" title="#initialize (instance method)">- (Widget) <strong>initialize</strong>(user_id = nil, user_email = nil, params) </a>
190
+
191
+
192
+
193
+ </span>
194
+
195
+
196
+ <span class="note title constructor">constructor</span>
197
+
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+ <span class="summary_desc"><div class='inline'>
206
+ <p>Widget initialization object.</p>
207
+ </div></span>
208
+
209
+ </li>
210
+
211
+
212
+ </ul>
213
+
214
+
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+ <h3 class="inherited">Methods included from <span class='object_link'><a href="Validatable.html" title="Echochamber::Validatable (module)">Validatable</a></span></h3>
225
+ <p class="inherited"><span class='object_link'><a href="Validatable.html#require_exactly_one-instance_method" title="Echochamber::Validatable#require_exactly_one (method)">#require_exactly_one</a></span>, <span class='object_link'><a href="Validatable.html#require_keys-instance_method" title="Echochamber::Validatable#require_keys (method)">#require_keys</a></span>, <span class='object_link'><a href="Validatable.html#validate_field-instance_method" title="Echochamber::Validatable#validate_field (method)">#validate_field</a></span></p>
226
+
227
+ <div id="constructor_details" class="method_details_list">
228
+ <h2>Constructor Details</h2>
229
+
230
+ <div class="method_details first">
231
+ <h3 class="signature first" id="initialize-instance_method">
232
+
233
+ - (<tt><span class='object_link'><a href="" title="Echochamber::Widget (class)">Widget</a></span></tt>) <strong>initialize</strong>(user_id = nil, user_email = nil, params)
234
+
235
+
236
+
237
+
238
+
239
+ </h3><div class="docstring">
240
+ <div class="discussion">
241
+
242
+ <p>Widget initialization object</p>
243
+
244
+
245
+ </div>
246
+ </div>
247
+ <div class="tags">
248
+ <p class="tag_title">Parameters:</p>
249
+ <ul class="param">
250
+
251
+ <li>
252
+
253
+ <span class='name'>user_id</span>
254
+
255
+
256
+ <span class='type'>(<tt>String</tt>)</span>
257
+
258
+
259
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
260
+
261
+
262
+ &mdash;
263
+ <div class='inline'>
264
+ <p>The ID of the user on whose behalf widget is being created.</p>
265
+ </div>
266
+
267
+ </li>
268
+
269
+ <li>
270
+
271
+ <span class='name'>user_email</span>
272
+
273
+
274
+ <span class='type'>(<tt>String</tt>)</span>
275
+
276
+
277
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
278
+
279
+
280
+ &mdash;
281
+ <div class='inline'>
282
+ <p>The email address of the user on whose behalf widget is being created. If
283
+ both X-User-Id and X-User-Email are provided then X-User-Id is given
284
+ preference. If neither is specified then the user is inferred from the
285
+ access token.</p>
286
+ </div>
287
+
288
+ </li>
289
+
290
+ <li>
291
+
292
+ <span class='name'>params</span>
293
+
294
+
295
+ <span class='type'>(<tt>Hash</tt>)</span>
296
+
297
+
298
+
299
+ &mdash;
300
+ <div class='inline'>
301
+ <p>SYMBOL-referenced Hash containing: (REQUIRED)</p>
302
+ </div>
303
+
304
+ </li>
305
+
306
+ <li>
307
+
308
+ <span class='name'>param</span>
309
+
310
+
311
+ <span class='type'>(<tt>Hash</tt>)</span>
312
+
313
+
314
+
315
+ &mdash;
316
+ <div class='inline'>
317
+ <p>a customizable set of options</p>
318
+ </div>
319
+
320
+ </li>
321
+
322
+ </ul>
323
+
324
+
325
+
326
+
327
+
328
+
329
+
330
+
331
+ <p class="tag_title">Options Hash (<tt>params</tt>):</p>
332
+ <ul class="option">
333
+
334
+ <li>
335
+ <span class="name">:name</span>
336
+ <span class="type">(<tt>String</tt>)</span>
337
+ <span class="default">
338
+
339
+ </span>
340
+
341
+ &mdash; <div class='inline'>
342
+ <p>The name of the widget that will be used to identify it, in emails and on
343
+ the website (REQUIRED)</p>
344
+ </div>
345
+
346
+ </li>
347
+
348
+ <li>
349
+ <span class="name">:fileInfos</span>
350
+ <span class="type">(<tt>Array</tt>)</span>
351
+ <span class="default">
352
+
353
+ </span>
354
+
355
+ &mdash; <div class='inline'>
356
+ <p>Populate with instances of <span class='object_link'><a href="Fileinfo.html" title="Echochamber::Fileinfo (class)">Echochamber::Fileinfo</a></span>.
357
+ A list of one or more files (or references to files) that will be used to
358
+ create the widget. If more than one file is provided, they will be combined
359
+ before the widget is created. Library documents are not permitted. Note:
360
+ Only one of the four parameters in every Fileinfo object must be specified
361
+ (REQUIRED)</p>
362
+ </div>
363
+
364
+ </li>
365
+
366
+ <li>
367
+ <span class="name">:formFieldLayerTemplates</span>
368
+ <span class="type">(<tt>Array</tt>)</span>
369
+ <span class="default">
370
+
371
+ </span>
372
+
373
+ &mdash; <div class='inline'>
374
+ <p>Populate with instances of <span class='object_link'><a href="Fileinfo.html" title="Echochamber::Fileinfo (class)">Echochamber::Fileinfo</a></span>.
375
+ Specifies the form field layer template or source of form fields to apply
376
+ on the files in this transaction. If specified, the FileInfo for this
377
+ parameter must refer to a form field layer template via libraryDocumentId
378
+ or libraryDocumentName, or if specified via transientDocumentId or
379
+ documentURL, it must be of a supported file type. Note: Only one of the
380
+ four parameters in every FileInfo object must be specified.</p>
381
+ </div>
382
+
383
+ </li>
384
+
385
+ <li>
386
+ <span class="name">:widgetCompletionInfo</span>
387
+ <span class="type">(<tt><span class='object_link'><a href="WidgetCompletionInfo.html" title="Echochamber::WidgetCompletionInfo (class)">Echochamber::WidgetCompletionInfo</a></span></tt>)</span>
388
+ <span class="default">
389
+
390
+ </span>
391
+
392
+ &mdash; <div class='inline'>
393
+ <p>URL and associated properties for the success page the user will be taken
394
+ to after filling out the widget</p>
395
+ </div>
396
+
397
+ </li>
398
+
399
+ <li>
400
+ <span class="name">:callbackInfo</span>
401
+ <span class="type">(<tt>String</tt>)</span>
402
+ <span class="default">
403
+
404
+ </span>
405
+
406
+ &mdash; <div class='inline'>
407
+ <p>A publicly accessible url to which EchoSign will perform an HTTP PUT
408
+ operation with the final signed PDF file. HTTP authentication is supported
409
+ using standard embedded syntax - i.e. <a
410
+ href="http://username:password@your.server.com/path/to/file">username:password@your.server.com/path/to/file</a>.
411
+ EchoSign can also communicate with your system using HTTP GET, every time
412
+ there is a new agreement event. Please contact support@echosign.com if you
413
+ wish to use this option.</p>
414
+ </div>
415
+
416
+ </li>
417
+
418
+ <li>
419
+ <span class="name">:securityOptions</span>
420
+ <span class="type">(<tt><span class='object_link'><a href="WidgetSecurityOption.html" title="Echochamber::WidgetSecurityOption (class)">Echochamber::WidgetSecurityOption</a></span></tt>)</span>
421
+ <span class="default">
422
+
423
+ </span>
424
+
425
+ &mdash; <div class='inline'>
426
+ <p>Sets optional secondary security parameters for your widget</p>
427
+ </div>
428
+
429
+ </li>
430
+
431
+ <li>
432
+ <span class="name">:locale</span>
433
+ <span class="type">(<tt>String</tt>)</span>
434
+ <span class="default">
435
+
436
+ </span>
437
+
438
+ &mdash; <div class='inline'>
439
+ <p>The locale associated with this widget - specifies the language for the
440
+ signing page and emails, for example en_US or fr_FR. If none specified,
441
+ defaults to the language configured for the widget creator</p>
442
+ </div>
443
+
444
+ </li>
445
+
446
+ <li>
447
+ <span class="name">:counterSigners</span>
448
+ <span class="type">(<tt><span class='object_link'><a href="CounterSignerInfo.html" title="Echochamber::CounterSignerInfo (class)">Echochamber::CounterSignerInfo</a></span></tt>)</span>
449
+ <span class="default">
450
+
451
+ </span>
452
+
453
+ &mdash; <div class='inline'>
454
+ <p>A list of one or more counter signers</p>
455
+ </div>
456
+
457
+ </li>
458
+
459
+ <li>
460
+ <span class="name">:vaultingInfo</span>
461
+ <span class="type">(<tt><span class='object_link'><a href="WidgetVaultingInfo.html" title="Echochamber::WidgetVaultingInfo (class)">Echochamber::WidgetVaultingInfo</a></span></tt>)</span>
462
+ <span class="default">
463
+
464
+ </span>
465
+
466
+ &mdash; <div class='inline'>
467
+ <p>Sets the vaulting properties that allows EchoSign to securely store
468
+ documents with a vault provider</p>
469
+ </div>
470
+
471
+ </li>
472
+
473
+ <li>
474
+ <span class="name">:mergeFieldInfo</span>
475
+ <span class="type">(<tt>Echochamber::WidgetMergefieldInfo</tt>)</span>
476
+ <span class="default">
477
+
478
+ </span>
479
+
480
+ &mdash; <div class='inline'>
481
+ <p>Optional default values for fields to merge into the document. The values
482
+ will be presented to the signers for editable fields; for read-only fields
483
+ the provided values will not be editable during the signing process.
484
+ Merging data into fields is currently not supported when used with
485
+ libraryDocumentId or libraryDocumentName. Only file and url are curently
486
+ supported</p>
487
+ </div>
488
+
489
+ </li>
490
+
491
+ <li>
492
+ <span class="name">:widgetAuthFailureInfo</span>
493
+ <span class="type">(<tt><span class='object_link'><a href="WidgetCompletionInfo.html" title="Echochamber::WidgetCompletionInfo (class)">Echochamber::WidgetCompletionInfo</a></span></tt>)</span>
494
+ <span class="default">
495
+
496
+ </span>
497
+
498
+ &mdash; <div class='inline'>
499
+ <p>URL and associated properties for the error page the user will be taken
500
+ after failing to authenticate</p>
501
+ </div>
502
+
503
+ </li>
504
+
505
+ <li>
506
+ <span class="name">:widgetSignerSecurityOptions</span>
507
+ <span class="type">(<tt><span class='object_link'><a href="WidgetSignerSecurityOption.html" title="Echochamber::WidgetSignerSecurityOption (class)">Echochamber::WidgetSignerSecurityOption</a></span></tt>)</span>
508
+ <span class="default">
509
+
510
+ </span>
511
+
512
+ &mdash; <div class='inline'>
513
+ <p>Security options that apply to widget signers</p>
514
+ </div>
515
+
516
+ </li>
517
+
518
+ </ul>
519
+
520
+
521
+
522
+ </div><table class="source_code">
523
+ <tr>
524
+ <td>
525
+ <pre class="lines">
526
+
527
+
528
+ 33
529
+ 34
530
+ 35
531
+ 36
532
+ 37
533
+ 38
534
+ 39</pre>
535
+ </td>
536
+ <td>
537
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget.rb', line 33</span>
538
+
539
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_user_id'>user_id</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_user_email'>user_email</span><span class='op'>=</span><span class='kw'>nil</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
540
+ <span class='id identifier rubyid_require_keys'>require_keys</span><span class='lparen'>(</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='comma'>,</span> <span class='symbol'>:fileInfos</span><span class='comma'>,</span> <span class='symbol'>:signatureFlow</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span>
541
+ <span class='ivar'>@user_id</span> <span class='op'>=</span> <span class='id identifier rubyid_user_id'>user_id</span>
542
+ <span class='ivar'>@user_email</span> <span class='op'>=</span> <span class='id identifier rubyid_user_email'>user_email</span>
543
+
544
+ <span class='id identifier rubyid_merge!'>merge!</span><span class='lparen'>(</span><span class='lbrace'>{</span> <span class='label'>widgetCreationInfo:</span> <span class='id identifier rubyid_params'>params</span> <span class='rbrace'>}</span><span class='rparen'>)</span>
545
+ <span class='kw'>end</span></pre>
546
+ </td>
547
+ </tr>
548
+ </table>
549
+ </div>
550
+
551
+ </div>
552
+
553
+ <div id="instance_attr_details" class="attr_details">
554
+ <h2>Instance Attribute Details</h2>
555
+
556
+
557
+ <span id=""></span>
558
+ <div class="method_details first">
559
+ <h3 class="signature first" id="user_email-instance_method">
560
+
561
+ - (<tt>Object</tt>) <strong>user_email</strong> <span class="extras">(readonly)</span>
562
+
563
+
564
+
565
+
566
+
567
+ </h3><div class="docstring">
568
+ <div class="discussion">
569
+
570
+ <p>Returns the value of attribute user_email</p>
571
+
572
+
573
+ </div>
574
+ </div>
575
+ <div class="tags">
576
+
577
+
578
+ </div><table class="source_code">
579
+ <tr>
580
+ <td>
581
+ <pre class="lines">
582
+
583
+
584
+ 13
585
+ 14
586
+ 15</pre>
587
+ </td>
588
+ <td>
589
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget.rb', line 13</span>
590
+
591
+ <span class='kw'>def</span> <span class='id identifier rubyid_user_email'>user_email</span>
592
+ <span class='ivar'>@user_email</span>
593
+ <span class='kw'>end</span></pre>
594
+ </td>
595
+ </tr>
596
+ </table>
597
+ </div>
598
+
599
+
600
+ <span id=""></span>
601
+ <div class="method_details ">
602
+ <h3 class="signature " id="user_id-instance_method">
603
+
604
+ - (<tt>Object</tt>) <strong>user_id</strong> <span class="extras">(readonly)</span>
605
+
606
+
607
+
608
+
609
+
610
+ </h3><div class="docstring">
611
+ <div class="discussion">
612
+
613
+ <p>Returns the value of attribute user_id</p>
614
+
615
+
616
+ </div>
617
+ </div>
618
+ <div class="tags">
619
+
620
+
621
+ </div><table class="source_code">
622
+ <tr>
623
+ <td>
624
+ <pre class="lines">
625
+
626
+
627
+ 13
628
+ 14
629
+ 15</pre>
630
+ </td>
631
+ <td>
632
+ <pre class="code"><span class="info file"># File 'lib/echochamber/widget.rb', line 13</span>
633
+
634
+ <span class='kw'>def</span> <span class='id identifier rubyid_user_id'>user_id</span>
635
+ <span class='ivar'>@user_id</span>
636
+ <span class='kw'>end</span></pre>
637
+ </td>
638
+ </tr>
639
+ </table>
640
+ </div>
641
+
642
+ </div>
643
+
644
+
645
+ </div>
646
+
647
+ <div id="footer">
648
+ Generated on Thu Aug 21 05:14:34 2014 by
649
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
650
+ 0.8.7.4 (ruby-2.0.0).
651
+ </div>
652
+
653
+ </body>
654
+ </html>