orthodox 0.3.4 → 0.3.5

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,298 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: OtpCredentialsHelper
8
+
9
+ &mdash; Orthodox
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "OtpCredentialsHelper";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index (O)</a> &raquo;
40
+
41
+
42
+ <span class="title">OtpCredentialsHelper</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: OtpCredentialsHelper
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+
73
+
74
+
75
+
76
+
77
+
78
+
79
+ <dl>
80
+ <dt>Defined in:</dt>
81
+ <dd>lib/generators/authentication/templates/helpers/otp_credentials_helper.rb</dd>
82
+ </dl>
83
+
84
+ </div>
85
+
86
+ <h2>Overview</h2><div class="docstring">
87
+ <div class="discussion">
88
+ <p>Helper for one-time-password authentication methods</p>
89
+
90
+ <p>Automatically generated by the orthodox gem (<a href="https://github.com/katanacode/orthodox">https://github.com/katanacode/orthodox</a>)
91
+ (c) Copyright 2019 Katana Code Ltd. All Rights Reserved.</p>
92
+
93
+
94
+ </div>
95
+ </div>
96
+ <div class="tags">
97
+
98
+
99
+ </div>
100
+
101
+
102
+
103
+
104
+
105
+
106
+
107
+ <h2>
108
+ Instance Method Summary
109
+ <small><a href="#" class="summary_toggle">collapse</a></small>
110
+ </h2>
111
+
112
+ <ul class="summary">
113
+
114
+ <li class="private ">
115
+ <span class="summary_signature">
116
+
117
+ <a href="#qrcode-instance_method" title="#qrcode (instance method)">#<strong>qrcode</strong>(otp_credential) &#x21d2; Object </a>
118
+
119
+
120
+
121
+ </span>
122
+
123
+
124
+
125
+ <span class="note title private">private</span>
126
+
127
+
128
+
129
+
130
+
131
+ <span class="summary_desc"><div class='inline'></div></span>
132
+
133
+ </li>
134
+
135
+
136
+ <li class="public ">
137
+ <span class="summary_signature">
138
+
139
+ <a href="#svg_url_for_otp_credential-instance_method" title="#svg_url_for_otp_credential (instance method)">#<strong>svg_url_for_otp_credential</strong>(otp_credential) &#x21d2; Object </a>
140
+
141
+
142
+
143
+ </span>
144
+
145
+
146
+
147
+
148
+
149
+
150
+
151
+
152
+
153
+ <span class="summary_desc"><div class='inline'><p>SVG code for a given OtpCredential.</p>
154
+ </div></span>
155
+
156
+ </li>
157
+
158
+
159
+ </ul>
160
+
161
+
162
+
163
+
164
+ <div id="instance_method_details" class="method_details_list">
165
+ <h2>Instance Method Details</h2>
166
+
167
+
168
+ <div class="method_details first">
169
+ <h3 class="signature first" id="qrcode-instance_method">
170
+
171
+ #<strong>qrcode</strong>(otp_credential) &#x21d2; <tt>Object</tt> <span class="extras">(private)</span>
172
+
173
+
174
+
175
+
176
+
177
+ </h3><table class="source_code">
178
+ <tr>
179
+ <td>
180
+ <pre class="lines">
181
+
182
+
183
+ 29
184
+ 30
185
+ 31</pre>
186
+ </td>
187
+ <td>
188
+ <pre class="code"><span class="info file"># File 'lib/generators/authentication/templates/helpers/otp_credentials_helper.rb', line 29</span>
189
+
190
+ <span class='kw'>def</span> <span class='id identifier rubyid_qrcode'>qrcode</span><span class='lparen'>(</span><span class='id identifier rubyid_otp_credential'>otp_credential</span><span class='rparen'>)</span>
191
+ <span class='const'>RQRCode</span><span class='op'>::</span><span class='const'>QRCode</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_otp_credential'>otp_credential</span><span class='period'>.</span><span class='id identifier rubyid_url'>url</span><span class='rparen'>)</span>
192
+ <span class='kw'>end</span></pre>
193
+ </td>
194
+ </tr>
195
+ </table>
196
+ </div>
197
+
198
+ <div class="method_details ">
199
+ <h3 class="signature " id="svg_url_for_otp_credential-instance_method">
200
+
201
+ #<strong>svg_url_for_otp_credential</strong>(otp_credential) &#x21d2; <tt>Object</tt>
202
+
203
+
204
+
205
+
206
+
207
+ </h3><div class="docstring">
208
+ <div class="discussion">
209
+ <p>SVG code for a given OtpCredential. Use this to add a QR code to a page</p>
210
+
211
+
212
+ </div>
213
+ </div>
214
+ <div class="tags">
215
+ <p class="tag_title">Parameters:</p>
216
+ <ul class="param">
217
+
218
+ <li>
219
+
220
+ <span class='name'>otp_credential</span>
221
+
222
+
223
+ <span class='type'></span>
224
+
225
+
226
+
227
+ &mdash;
228
+ <div class='inline'><p>An OtpCredential to show the SVG for.</p>
229
+ </div>
230
+
231
+ </li>
232
+
233
+ <li>
234
+
235
+ <span class='name'>Retuns</span>
236
+
237
+
238
+ <span class='type'></span>
239
+
240
+
241
+
242
+ &mdash;
243
+ <div class='inline'><p>String of valid HTML</p>
244
+ </div>
245
+
246
+ </li>
247
+
248
+ </ul>
249
+
250
+
251
+ </div><table class="source_code">
252
+ <tr>
253
+ <td>
254
+ <pre class="lines">
255
+
256
+
257
+ 16
258
+ 17
259
+ 18
260
+ 19
261
+ 20
262
+ 21
263
+ 22
264
+ 23
265
+ 24
266
+ 25</pre>
267
+ </td>
268
+ <td>
269
+ <pre class="code"><span class="info file"># File 'lib/generators/authentication/templates/helpers/otp_credentials_helper.rb', line 16</span>
270
+
271
+ <span class='kw'>def</span> <span class='id identifier rubyid_svg_url_for_otp_credential'>svg_url_for_otp_credential</span><span class='lparen'>(</span><span class='id identifier rubyid_otp_credential'>otp_credential</span><span class='rparen'>)</span>
272
+ <span class='id identifier rubyid_qrcode'>qrcode</span> <span class='op'>=</span> <span class='id identifier rubyid_qrcode'>qrcode</span><span class='lparen'>(</span><span class='id identifier rubyid_otp_credential'>otp_credential</span><span class='rparen'>)</span>
273
+ <span class='id identifier rubyid_qrcode'>qrcode</span><span class='period'>.</span><span class='id identifier rubyid_as_svg'>as_svg</span><span class='lparen'>(</span><span class='lbrace'>{</span>
274
+ <span class='label'>offset:</span> <span class='int'>0</span><span class='comma'>,</span>
275
+ <span class='label'>color:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>000</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
276
+ <span class='label'>shape_rendering:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>crispEdges</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span>
277
+ <span class='label'>module_size:</span> <span class='int'>3</span><span class='comma'>,</span>
278
+ <span class='label'>standalone:</span> <span class='kw'>true</span>
279
+ <span class='rbrace'>}</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_html_safe'>html_safe</span>
280
+ <span class='kw'>end</span></pre>
281
+ </td>
282
+ </tr>
283
+ </table>
284
+ </div>
285
+
286
+ </div>
287
+
288
+ </div>
289
+
290
+ <div id="footer">
291
+ Generated on Thu Aug 13 16:36:42 2020 by
292
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
293
+ 0.9.24 (ruby-2.6.6).
294
+ </div>
295
+
296
+ </div>
297
+ </body>
298
+ </html>
data/docs/Otpable.html ADDED
@@ -0,0 +1,267 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Module: Otpable
8
+
9
+ &mdash; Orthodox
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "Otpable";
19
+ relpath = '';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="_index.html">Index (O)</a> &raquo;
40
+
41
+
42
+ <span class="title">Otpable</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Module: Otpable
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+
70
+
71
+
72
+ <dl>
73
+ <dt>Extended by:</dt>
74
+ <dd>ActiveSupport::Concern</dd>
75
+ </dl>
76
+
77
+
78
+
79
+
80
+
81
+
82
+
83
+
84
+ <dl>
85
+ <dt>Defined in:</dt>
86
+ <dd>lib/generators/authentication/templates/models/concerns/otpable.rb</dd>
87
+ </dl>
88
+
89
+ </div>
90
+
91
+ <h2>Overview</h2><div class="docstring">
92
+ <div class="discussion">
93
+ <p>Model concern to provide shared behaviour for two-factor auth (one-time password)</p>
94
+
95
+ <p>Automatically generated by the orthodox gem (<a href="https://github.com/katanacode/orthodox">https://github.com/katanacode/orthodox</a>)
96
+ (c) Copyright 2019 Katana Code Ltd. All Rights Reserved.</p>
97
+
98
+
99
+ </div>
100
+ </div>
101
+ <div class="tags">
102
+
103
+
104
+ </div>
105
+
106
+
107
+
108
+
109
+
110
+
111
+
112
+ <h2>
113
+ Instance Method Summary
114
+ <small><a href="#" class="summary_toggle">collapse</a></small>
115
+ </h2>
116
+
117
+ <ul class="summary">
118
+
119
+ <li class="public ">
120
+ <span class="summary_signature">
121
+
122
+ <a href="#destroy_otp_credential-instance_method" title="#destroy_otp_credential (instance method)">#<strong>destroy_otp_credential</strong> &#x21d2; Object </a>
123
+
124
+
125
+
126
+ </span>
127
+
128
+
129
+
130
+
131
+
132
+
133
+
134
+
135
+
136
+ <span class="summary_desc"><div class='inline'></div></span>
137
+
138
+ </li>
139
+
140
+
141
+ <li class="public ">
142
+ <span class="summary_signature">
143
+
144
+ <a href="#tfa%3F-instance_method" title="#tfa? (instance method)">#<strong>tfa?</strong> &#x21d2; Boolean </a>
145
+
146
+
147
+
148
+ </span>
149
+
150
+
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+ <span class="summary_desc"><div class='inline'></div></span>
159
+
160
+ </li>
161
+
162
+
163
+ </ul>
164
+
165
+
166
+
167
+
168
+
169
+ <div id="instance_method_details" class="method_details_list">
170
+ <h2>Instance Method Details</h2>
171
+
172
+
173
+ <div class="method_details first">
174
+ <h3 class="signature first" id="destroy_otp_credential-instance_method">
175
+
176
+ #<strong>destroy_otp_credential</strong> &#x21d2; <tt>Object</tt>
177
+
178
+
179
+
180
+
181
+
182
+ </h3><table class="source_code">
183
+ <tr>
184
+ <td>
185
+ <pre class="lines">
186
+
187
+
188
+ 22
189
+ 23
190
+ 24</pre>
191
+ </td>
192
+ <td>
193
+ <pre class="code"><span class="info file"># File 'lib/generators/authentication/templates/models/concerns/otpable.rb', line 22</span>
194
+
195
+ <span class='kw'>def</span> <span class='id identifier rubyid_destroy_otp_credential'>destroy_otp_credential</span>
196
+ <span class='id identifier rubyid_otp_credential'>otp_credential</span><span class='period'>.</span><span class='id identifier rubyid_destroy'>destroy</span>
197
+ <span class='kw'>end</span></pre>
198
+ </td>
199
+ </tr>
200
+ </table>
201
+ </div>
202
+
203
+ <div class="method_details ">
204
+ <h3 class="signature " id="tfa?-instance_method">
205
+
206
+ #<strong>tfa?</strong> &#x21d2; <tt>Boolean</tt>
207
+
208
+
209
+
210
+
211
+
212
+ </h3><div class="docstring">
213
+ <div class="discussion">
214
+
215
+
216
+ </div>
217
+ </div>
218
+ <div class="tags">
219
+
220
+ <p class="tag_title">Returns:</p>
221
+ <ul class="return">
222
+
223
+ <li>
224
+
225
+
226
+ <span class='type'>(<tt>Boolean</tt>)</span>
227
+
228
+
229
+
230
+ </li>
231
+
232
+ </ul>
233
+
234
+ </div><table class="source_code">
235
+ <tr>
236
+ <td>
237
+ <pre class="lines">
238
+
239
+
240
+ 18
241
+ 19
242
+ 20</pre>
243
+ </td>
244
+ <td>
245
+ <pre class="code"><span class="info file"># File 'lib/generators/authentication/templates/models/concerns/otpable.rb', line 18</span>
246
+
247
+ <span class='kw'>def</span> <span class='id identifier rubyid_tfa?'>tfa?</span>
248
+ <span class='id identifier rubyid_otp_credential'>otp_credential</span><span class='period'>.</span><span class='id identifier rubyid_present?'>present?</span>
249
+ <span class='kw'>end</span></pre>
250
+ </td>
251
+ </tr>
252
+ </table>
253
+ </div>
254
+
255
+ </div>
256
+
257
+ </div>
258
+
259
+ <div id="footer">
260
+ Generated on Thu Aug 13 16:36:42 2020 by
261
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
262
+ 0.9.24 (ruby-2.6.6).
263
+ </div>
264
+
265
+ </div>
266
+ </body>
267
+ </html>