m2m_keygen 0.4.9 → 0.5.0

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 (174) hide show
  1. checksums.yaml +4 -4
  2. data/.overcommit.yml +4 -7
  3. data/.rubocop.yml +19 -16
  4. data/.ruby-version +1 -1
  5. data/.streerc +1 -0
  6. data/.tool-versions +1 -1
  7. data/CHANGELOG.md +60 -1
  8. data/Gemfile +2 -2
  9. data/Gemfile.lock +135 -158
  10. data/README.md +64 -78
  11. data/docs/MIGRATING.md +69 -0
  12. data/docs/SPEC.md +245 -0
  13. data/examples/nonce_store/postgres.rb +40 -0
  14. data/examples/nonce_store/redis.rb +23 -0
  15. data/gemfiles/rack_2.gemfile +5 -0
  16. data/gemfiles/rack_3.gemfile +5 -0
  17. data/lib/m2m_keygen/canonicalizer.rb +57 -0
  18. data/lib/m2m_keygen/nonce_store/disabled.rb +19 -0
  19. data/lib/m2m_keygen/nonce_store/memory.rb +64 -0
  20. data/lib/m2m_keygen/nonce_store.rb +18 -0
  21. data/lib/m2m_keygen/rack_validator.rb +72 -19
  22. data/lib/m2m_keygen/request_signer/signed_request.rb +10 -0
  23. data/lib/m2m_keygen/request_signer.rb +118 -0
  24. data/lib/m2m_keygen/signature.rb +41 -39
  25. data/lib/m2m_keygen/types/params_type.rb +6 -17
  26. data/lib/m2m_keygen/version.rb +1 -1
  27. data/lib/m2m_keygen.rb +6 -0
  28. data/m2m_keygen.gemspec +12 -14
  29. data/sorbet/config +1 -0
  30. data/sorbet/rbi/gems/.gitattributes +1 -0
  31. data/sorbet/rbi/gems/{ast@2.4.2.rbi → ast@2.4.3.rbi} +45 -79
  32. data/sorbet/rbi/gems/{benchmark@0.2.0.rbi → benchmark@0.5.0.rbi} +91 -58
  33. data/sorbet/rbi/gems/bundler-audit@0.9.3.rbi +397 -0
  34. data/sorbet/rbi/gems/byebug@13.0.0.rbi +3651 -0
  35. data/sorbet/rbi/gems/childprocess@5.1.0.rbi +336 -0
  36. data/sorbet/rbi/gems/concurrent-ruby@1.3.7.rbi +384 -0
  37. data/sorbet/rbi/gems/{diff-lcs@1.5.0.rbi → diff-lcs@1.6.2.rbi} +189 -199
  38. data/sorbet/rbi/gems/{docile@1.4.0.rbi → docile@1.4.1.rbi} +147 -147
  39. data/sorbet/rbi/gems/dotenv@3.2.0.rbi +267 -0
  40. data/sorbet/rbi/gems/erubi@1.13.1.rbi +155 -0
  41. data/sorbet/rbi/gems/{faker@2.22.0.rbi → faker@3.8.0.rbi} +8468 -3829
  42. data/sorbet/rbi/gems/{ffi@1.15.5.rbi → ffi@1.17.4.rbi} +1 -0
  43. data/sorbet/rbi/gems/{formatador@1.1.0.rbi → formatador@1.2.3.rbi} +1 -0
  44. data/sorbet/rbi/gems/{guard@2.18.0.rbi → guard@2.20.1.rbi} +1 -0
  45. data/sorbet/rbi/gems/{i18n@1.12.0.rbi → i18n@1.15.2.rbi} +687 -827
  46. data/sorbet/rbi/gems/io-console@0.8.2.rbi +9 -0
  47. data/sorbet/rbi/gems/{json@2.6.2.rbi → json@2.20.0.rbi} +994 -252
  48. data/sorbet/rbi/gems/language_server-protocol@3.17.0.5.rbi +9 -0
  49. data/sorbet/rbi/gems/lint_roller@1.1.0.rbi +189 -0
  50. data/sorbet/rbi/gems/listen@3.10.0.rbi +9 -0
  51. data/sorbet/rbi/gems/logger@1.7.0.rbi +896 -0
  52. data/sorbet/rbi/gems/{lumberjack@1.2.8.rbi → lumberjack@1.4.2.rbi} +1 -0
  53. data/sorbet/rbi/gems/{method_source@1.0.0.rbi → method_source@1.1.0.rbi} +111 -90
  54. data/sorbet/rbi/gems/{overcommit@0.59.1.rbi → overcommit@0.71.0.rbi} +503 -647
  55. data/sorbet/rbi/gems/parallel@2.1.0.rbi +321 -0
  56. data/sorbet/rbi/gems/parser@3.3.11.1.rbi +5229 -0
  57. data/sorbet/rbi/gems/prettier_print@1.2.1.rbi +878 -0
  58. data/sorbet/rbi/gems/prism@1.9.0.rbi +42224 -0
  59. data/sorbet/rbi/gems/pry-byebug@3.12.0.rbi +481 -0
  60. data/sorbet/rbi/gems/{pry@0.14.1.rbi → pry@0.16.0.rbi} +2567 -3550
  61. data/sorbet/rbi/gems/{racc@1.6.0.rbi → racc@1.8.1.rbi} +54 -40
  62. data/sorbet/rbi/gems/rack@3.2.6.rbi +4653 -0
  63. data/sorbet/rbi/gems/{rake@13.0.6.rbi → rake@13.4.2.rbi} +963 -732
  64. data/sorbet/rbi/gems/{rb-inotify@0.10.1.rbi → rb-inotify@0.11.1.rbi} +1 -0
  65. data/sorbet/rbi/gems/rbi@0.3.14.rbi +5519 -0
  66. data/sorbet/rbi/gems/rbs@4.0.3.rbi +6908 -0
  67. data/sorbet/rbi/gems/regexp_parser@2.12.0.rbi +3398 -0
  68. data/sorbet/rbi/gems/reline@0.6.3.rbi +2446 -0
  69. data/sorbet/rbi/gems/require-hooks@0.4.0.rbi +152 -0
  70. data/sorbet/rbi/gems/{rexml@3.2.5.rbi → rexml@3.4.4.rbi} +1085 -894
  71. data/sorbet/rbi/gems/rspec-core@3.13.6.rbi +9475 -0
  72. data/sorbet/rbi/gems/rspec-expectations@3.13.5.rbi +6108 -0
  73. data/sorbet/rbi/gems/rspec-mocks@3.13.8.rbi +4787 -0
  74. data/sorbet/rbi/gems/rspec-support@3.13.7.rbi +1274 -0
  75. data/sorbet/rbi/gems/rspec@3.13.2.rbi +15 -0
  76. data/sorbet/rbi/gems/rspec_in_context@1.2.2.rbi +294 -0
  77. data/sorbet/rbi/gems/rubocop-ast@1.49.1.rbi +7140 -0
  78. data/sorbet/rbi/gems/rubocop-faker@1.3.0.rbi +88 -0
  79. data/sorbet/rbi/gems/rubocop-performance@1.26.1.rbi +3403 -0
  80. data/sorbet/rbi/gems/rubocop-sorbet@0.12.0.rbi +2448 -0
  81. data/sorbet/rbi/gems/rubocop@1.88.1.rbi +63103 -0
  82. data/sorbet/rbi/gems/ruby-lsp@0.26.9.rbi +28 -0
  83. data/sorbet/rbi/gems/ruby-progressbar@1.13.0.rbi +988 -0
  84. data/sorbet/rbi/gems/rubydex@0.2.7.rbi +836 -0
  85. data/sorbet/rbi/gems/simplecov-html@0.13.2.rbi +90 -0
  86. data/sorbet/rbi/gems/{simplecov@0.21.2.rbi → simplecov@0.22.0.rbi} +438 -578
  87. data/sorbet/rbi/gems/spoom@1.8.2.rbi +6691 -0
  88. data/sorbet/rbi/gems/syntax_tree@6.3.0.rbi +22090 -0
  89. data/sorbet/rbi/gems/tapioca@0.19.2.rbi +3597 -0
  90. data/sorbet/rbi/gems/{thor@1.2.1.rbi → thor@1.5.0.rbi} +1085 -1171
  91. data/sorbet/rbi/gems/tsort@0.2.0.rbi +389 -0
  92. data/sorbet/rbi/gems/unicode-display_width@3.2.0.rbi +130 -0
  93. data/sorbet/rbi/gems/unicode-emoji@4.2.0.rbi +332 -0
  94. data/sorbet/rbi/gems/{yard-sorbet@0.7.0.rbi → yard-sorbet@0.9.0.rbi} +142 -99
  95. data/sorbet/rbi/gems/{yard@0.9.28.rbi → yard@0.9.44.rbi} +5350 -6316
  96. data/sorbet/rbi/gems/zeitwerk@2.8.2.rbi +1178 -0
  97. metadata +105 -111
  98. data/.prettierrc.js +0 -4
  99. data/docs/M2mKeygen/Error.html +0 -135
  100. data/docs/M2mKeygen/ParamsEncoder.html +0 -321
  101. data/docs/M2mKeygen/RackValidator.html +0 -533
  102. data/docs/M2mKeygen/Signature.html +0 -680
  103. data/docs/M2mKeygen/Types.html +0 -147
  104. data/docs/M2mKeygen.html +0 -157
  105. data/docs/_index.html +0 -182
  106. data/docs/class_list.html +0 -51
  107. data/docs/css/common.css +0 -1
  108. data/docs/css/full_list.css +0 -58
  109. data/docs/css/style.css +0 -497
  110. data/docs/file.README.html +0 -230
  111. data/docs/file_list.html +0 -56
  112. data/docs/frames.html +0 -17
  113. data/docs/index.html +0 -230
  114. data/docs/js/app.js +0 -314
  115. data/docs/js/full_list.js +0 -216
  116. data/docs/js/jquery.js +0 -4
  117. data/docs/method_list.html +0 -139
  118. data/docs/top-level-namespace.html +0 -110
  119. data/lib/m2m_keygen/params_encoder.rb +0 -56
  120. data/package.json +0 -12
  121. data/sig/m2m_keygen.rbs +0 -4
  122. data/sorbet/rbi/gems/activesupport@7.0.3.1.rbi +0 -18608
  123. data/sorbet/rbi/gems/backport@1.2.0.rbi +0 -522
  124. data/sorbet/rbi/gems/bundler-audit@0.9.1.rbi +0 -308
  125. data/sorbet/rbi/gems/byebug@11.1.3.rbi +0 -3603
  126. data/sorbet/rbi/gems/childprocess@4.1.0.rbi +0 -401
  127. data/sorbet/rbi/gems/concurrent-ruby@1.1.10.rbi +0 -11581
  128. data/sorbet/rbi/gems/dotenv@2.8.1.rbi +0 -234
  129. data/sorbet/rbi/gems/e2mmap@0.1.0.rbi +0 -8
  130. data/sorbet/rbi/gems/haml@5.2.2.rbi +0 -3190
  131. data/sorbet/rbi/gems/jaro_winkler@1.5.4.rbi +0 -19
  132. data/sorbet/rbi/gems/kramdown-parser-gfm@1.1.0.rbi +0 -133
  133. data/sorbet/rbi/gems/kramdown@2.4.0.rbi +0 -3261
  134. data/sorbet/rbi/gems/listen@3.7.1.rbi +0 -1181
  135. data/sorbet/rbi/gems/minitest@5.16.3.rbi +0 -1459
  136. data/sorbet/rbi/gems/nokogiri@1.13.8.rbi +0 -6514
  137. data/sorbet/rbi/gems/parallel@1.22.1.rbi +0 -277
  138. data/sorbet/rbi/gems/parser@3.1.2.1.rbi +0 -6826
  139. data/sorbet/rbi/gems/prettier@3.2.0.rbi +0 -22
  140. data/sorbet/rbi/gems/prettier_print@0.1.0.rbi +0 -8
  141. data/sorbet/rbi/gems/pry-byebug@3.10.1.rbi +0 -1222
  142. data/sorbet/rbi/gems/rack@2.2.4.rbi +0 -5630
  143. data/sorbet/rbi/gems/rbi@0.0.15.rbi +0 -3007
  144. data/sorbet/rbi/gems/rbs@2.6.0.rbi +0 -8
  145. data/sorbet/rbi/gems/regexp_parser@2.5.0.rbi +0 -3366
  146. data/sorbet/rbi/gems/reverse_markdown@2.1.1.rbi +0 -389
  147. data/sorbet/rbi/gems/rspec-core@3.11.0.rbi +0 -10786
  148. data/sorbet/rbi/gems/rspec-expectations@3.11.0.rbi +0 -8170
  149. data/sorbet/rbi/gems/rspec-mocks@3.11.1.rbi +0 -5385
  150. data/sorbet/rbi/gems/rspec-support@3.11.0.rbi +0 -1746
  151. data/sorbet/rbi/gems/rspec@3.11.0.rbi +0 -187
  152. data/sorbet/rbi/gems/rspec_in_context@1.1.0.3.rbi +0 -1113
  153. data/sorbet/rbi/gems/rubocop-ast@1.21.0.rbi +0 -7044
  154. data/sorbet/rbi/gems/rubocop-faker@1.1.0.rbi +0 -106
  155. data/sorbet/rbi/gems/rubocop-performance@1.14.3.rbi +0 -2982
  156. data/sorbet/rbi/gems/rubocop-sorbet@0.6.11.rbi +0 -990
  157. data/sorbet/rbi/gems/rubocop@1.35.1.rbi +0 -52002
  158. data/sorbet/rbi/gems/ruby-progressbar@1.11.0.rbi +0 -1239
  159. data/sorbet/rbi/gems/simplecov-html@0.12.3.rbi +0 -219
  160. data/sorbet/rbi/gems/solargraph@0.46.0.rbi +0 -9075
  161. data/sorbet/rbi/gems/spoom@1.1.12.rbi +0 -2369
  162. data/sorbet/rbi/gems/syntax_tree-haml@1.3.1.rbi +0 -8
  163. data/sorbet/rbi/gems/syntax_tree-rbs@0.5.0.rbi +0 -8
  164. data/sorbet/rbi/gems/syntax_tree@3.5.0.rbi +0 -8
  165. data/sorbet/rbi/gems/tapioca@0.9.4.rbi +0 -2946
  166. data/sorbet/rbi/gems/temple@0.8.2.rbi +0 -1712
  167. data/sorbet/rbi/gems/tilt@2.0.11.rbi +0 -742
  168. data/sorbet/rbi/gems/tzinfo@2.0.5.rbi +0 -5914
  169. data/sorbet/rbi/gems/unicode-display_width@2.2.0.rbi +0 -48
  170. data/sorbet/rbi/gems/unparser@0.6.5.rbi +0 -4529
  171. data/sorbet/rbi/gems/webrick@1.7.0.rbi +0 -2553
  172. data/sorbet/rbi/gems/zeitwerk@2.6.0.rbi +0 -867
  173. data/sorbet/rbi/manual.rbi +0 -7
  174. data/yarn.lock +0 -20
@@ -1,680 +0,0 @@
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
- Class: M2mKeygen::Signature
8
-
9
- &mdash; Documentation by YARD 0.9.34
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 = "M2mKeygen::Signature";
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 (S)</a> &raquo;
40
- <span class='title'><span class='object_link'><a href="../M2mKeygen.html" title="M2mKeygen (module)">M2mKeygen</a></span></span>
41
- &raquo;
42
- <span class="title">Signature</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>Class: M2mKeygen::Signature
63
-
64
-
65
-
66
- </h1>
67
- <div class="box_info">
68
-
69
- <dl>
70
- <dt>Inherits:</dt>
71
- <dd>
72
- <span class="inheritName">Object</span>
73
-
74
- <ul class="fullTree">
75
- <li>Object</li>
76
-
77
- <li class="next">M2mKeygen::Signature</li>
78
-
79
- </ul>
80
- <a href="#" class="inheritanceTree">show all</a>
81
-
82
- </dd>
83
- </dl>
84
-
85
-
86
-
87
-
88
- <dl>
89
- <dt>Extended by:</dt>
90
- <dd>T::Sig</dd>
91
- </dl>
92
-
93
-
94
-
95
-
96
-
97
-
98
-
99
-
100
- <dl>
101
- <dt>Defined in:</dt>
102
- <dd>lib/m2m_keygen/signature.rb</dd>
103
- </dl>
104
-
105
- </div>
106
-
107
-
108
-
109
-
110
-
111
- <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
112
- <ul class="summary">
113
-
114
- <li class="public ">
115
- <span class="summary_signature">
116
-
117
- <a href="#algorithm-instance_method" title="#algorithm (instance method)">#<strong>algorithm</strong> &#x21d2; String </a>
118
-
119
-
120
-
121
- </span>
122
-
123
-
124
-
125
-
126
- <span class="note title readonly">readonly</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="#secret-instance_method" title="#secret (instance method)">#<strong>secret</strong> &#x21d2; String </a>
145
-
146
-
147
-
148
- </span>
149
-
150
-
151
-
152
-
153
- <span class="note title readonly">readonly</span>
154
-
155
-
156
-
157
-
158
-
159
-
160
-
161
-
162
-
163
- <span class="summary_desc"><div class='inline'></div></span>
164
-
165
- </li>
166
-
167
-
168
- </ul>
169
-
170
-
171
-
172
-
173
-
174
- <h2>
175
- Instance Method Summary
176
- <small><a href="#" class="summary_toggle">collapse</a></small>
177
- </h2>
178
-
179
- <ul class="summary">
180
-
181
- <li class="public ">
182
- <span class="summary_signature">
183
-
184
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(secret, algorithm: &#39;sha512&#39;) &#x21d2; void </a>
185
-
186
-
187
-
188
- </span>
189
-
190
-
191
- <span class="note title constructor">constructor</span>
192
-
193
-
194
-
195
-
196
-
197
-
198
-
199
-
200
- <span class="summary_desc"><div class='inline'></div></span>
201
-
202
- </li>
203
-
204
-
205
- <li class="public ">
206
- <span class="summary_signature">
207
-
208
- <a href="#sign-instance_method" title="#sign (instance method)">#<strong>sign</strong>(params:, verb:, path:) &#x21d2; String </a>
209
-
210
-
211
-
212
- </span>
213
-
214
-
215
-
216
-
217
-
218
-
219
-
220
-
221
-
222
- <span class="summary_desc"><div class='inline'></div></span>
223
-
224
- </li>
225
-
226
-
227
- <li class="public ">
228
- <span class="summary_signature">
229
-
230
- <a href="#validate-instance_method" title="#validate (instance method)">#<strong>validate</strong>(params:, verb:, path:, signature:) &#x21d2; Boolean </a>
231
-
232
-
233
-
234
- </span>
235
-
236
-
237
-
238
-
239
-
240
-
241
-
242
-
243
-
244
- <span class="summary_desc"><div class='inline'></div></span>
245
-
246
- </li>
247
-
248
-
249
- </ul>
250
-
251
-
252
-
253
- <div id="constructor_details" class="method_details_list">
254
- <h2>Constructor Details</h2>
255
-
256
- <div class="method_details first">
257
- <h3 class="signature first" id="initialize-instance_method">
258
-
259
- #<strong>initialize</strong>(secret, algorithm: &#39;sha512&#39;) &#x21d2; <tt>void</tt>
260
-
261
-
262
-
263
-
264
-
265
- </h3><div class="docstring">
266
- <div class="discussion">
267
-
268
-
269
- </div>
270
- </div>
271
- <div class="tags">
272
- <p class="tag_title">Parameters:</p>
273
- <ul class="param">
274
-
275
- <li>
276
-
277
- <span class='name'>secret</span>
278
-
279
-
280
- <span class='type'>(<tt>String</tt>)</span>
281
-
282
-
283
-
284
- </li>
285
-
286
- <li>
287
-
288
- <span class='name'>algorithm</span>
289
-
290
-
291
- <span class='type'>(<tt>String</tt>)</span>
292
-
293
-
294
- <em class="default">(defaults to: <tt>&#39;sha512&#39;</tt>)</em>
295
-
296
-
297
- </li>
298
-
299
- </ul>
300
-
301
-
302
- </div><table class="source_code">
303
- <tr>
304
- <td>
305
- <pre class="lines">
306
-
307
-
308
- 17
309
- 18
310
- 19
311
- 20
312
- 21</pre>
313
- </td>
314
- <td>
315
- <pre class="code"><span class="info file"># File 'lib/m2m_keygen/signature.rb', line 17</span>
316
-
317
- <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='id identifier rubyid_secret'>secret</span><span class='comma'>,</span> <span class='label'>algorithm:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>sha512</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
318
- <span class='ivar'>@secret</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='id identifier rubyid_secret'>secret</span><span class='comma'>,</span> <span class='const'>String</span><span class='rparen'>)</span>
319
- <span class='ivar'>@algorithm</span> <span class='op'>=</span> <span class='const'>T</span><span class='period'>.</span><span class='id identifier rubyid_let'>let</span><span class='lparen'>(</span><span class='id identifier rubyid_algorithm'>algorithm</span><span class='comma'>,</span> <span class='const'>String</span><span class='rparen'>)</span>
320
- <span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>HMAC</span><span class='period'>.</span><span class='id identifier rubyid_hexdigest'>hexdigest</span><span class='lparen'>(</span><span class='ivar'>@algorithm</span><span class='comma'>,</span> <span class='ivar'>@secret</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
321
- <span class='kw'>end</span></pre>
322
- </td>
323
- </tr>
324
- </table>
325
- </div>
326
-
327
- </div>
328
-
329
- <div id="instance_attr_details" class="attr_details">
330
- <h2>Instance Attribute Details</h2>
331
-
332
-
333
- <span id=""></span>
334
- <div class="method_details first">
335
- <h3 class="signature first" id="algorithm-instance_method">
336
-
337
- #<strong>algorithm</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
338
-
339
-
340
-
341
-
342
-
343
- </h3><div class="docstring">
344
- <div class="discussion">
345
-
346
-
347
- </div>
348
- </div>
349
- <div class="tags">
350
-
351
- <p class="tag_title">Returns:</p>
352
- <ul class="return">
353
-
354
- <li>
355
-
356
-
357
- <span class='type'>(<tt>String</tt>)</span>
358
-
359
-
360
-
361
- </li>
362
-
363
- </ul>
364
-
365
- </div><table class="source_code">
366
- <tr>
367
- <td>
368
- <pre class="lines">
369
-
370
-
371
- 14
372
- 15
373
- 16</pre>
374
- </td>
375
- <td>
376
- <pre class="code"><span class="info file"># File 'lib/m2m_keygen/signature.rb', line 14</span>
377
-
378
- <span class='kw'>def</span> <span class='id identifier rubyid_algorithm'>algorithm</span>
379
- <span class='ivar'>@algorithm</span>
380
- <span class='kw'>end</span></pre>
381
- </td>
382
- </tr>
383
- </table>
384
- </div>
385
-
386
-
387
- <span id=""></span>
388
- <div class="method_details ">
389
- <h3 class="signature " id="secret-instance_method">
390
-
391
- #<strong>secret</strong> &#x21d2; <tt>String</tt> <span class="extras">(readonly)</span>
392
-
393
-
394
-
395
-
396
-
397
- </h3><div class="docstring">
398
- <div class="discussion">
399
-
400
-
401
- </div>
402
- </div>
403
- <div class="tags">
404
-
405
- <p class="tag_title">Returns:</p>
406
- <ul class="return">
407
-
408
- <li>
409
-
410
-
411
- <span class='type'>(<tt>String</tt>)</span>
412
-
413
-
414
-
415
- </li>
416
-
417
- </ul>
418
-
419
- </div><table class="source_code">
420
- <tr>
421
- <td>
422
- <pre class="lines">
423
-
424
-
425
- 11
426
- 12
427
- 13</pre>
428
- </td>
429
- <td>
430
- <pre class="code"><span class="info file"># File 'lib/m2m_keygen/signature.rb', line 11</span>
431
-
432
- <span class='kw'>def</span> <span class='id identifier rubyid_secret'>secret</span>
433
- <span class='ivar'>@secret</span>
434
- <span class='kw'>end</span></pre>
435
- </td>
436
- </tr>
437
- </table>
438
- </div>
439
-
440
- </div>
441
-
442
-
443
- <div id="instance_method_details" class="method_details_list">
444
- <h2>Instance Method Details</h2>
445
-
446
-
447
- <div class="method_details first">
448
- <h3 class="signature first" id="sign-instance_method">
449
-
450
- #<strong>sign</strong>(params:, verb:, path:) &#x21d2; <tt>String</tt>
451
-
452
-
453
-
454
-
455
-
456
- </h3><div class="docstring">
457
- <div class="discussion">
458
-
459
-
460
- </div>
461
- </div>
462
- <div class="tags">
463
- <p class="tag_title">Parameters:</p>
464
- <ul class="param">
465
-
466
- <li>
467
-
468
- <span class='name'>params</span>
469
-
470
-
471
- <span class='type'>(<tt><span class='object_link'><a href="Types.html#ParamsType-constant" title="M2mKeygen::Types::ParamsType (constant)">Types::ParamsType</a></span></tt>)</span>
472
-
473
-
474
-
475
- </li>
476
-
477
- <li>
478
-
479
- <span class='name'>verb</span>
480
-
481
-
482
- <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
483
-
484
-
485
-
486
- </li>
487
-
488
- <li>
489
-
490
- <span class='name'>path</span>
491
-
492
-
493
- <span class='type'>(<tt>String</tt>)</span>
494
-
495
-
496
-
497
- </li>
498
-
499
- </ul>
500
-
501
- <p class="tag_title">Returns:</p>
502
- <ul class="return">
503
-
504
- <li>
505
-
506
-
507
- <span class='type'>(<tt>String</tt>)</span>
508
-
509
-
510
-
511
- </li>
512
-
513
- </ul>
514
-
515
- </div><table class="source_code">
516
- <tr>
517
- <td>
518
- <pre class="lines">
519
-
520
-
521
- 30
522
- 31
523
- 32
524
- 33
525
- 34
526
- 35
527
- 36</pre>
528
- </td>
529
- <td>
530
- <pre class="code"><span class="info file"># File 'lib/m2m_keygen/signature.rb', line 30</span>
531
-
532
- <span class='kw'>def</span> <span class='id identifier rubyid_sign'>sign</span><span class='lparen'>(</span><span class='label'>params:</span><span class='comma'>,</span> <span class='label'>verb:</span><span class='comma'>,</span> <span class='label'>path:</span><span class='rparen'>)</span>
533
- <span class='const'>OpenSSL</span><span class='op'>::</span><span class='const'>HMAC</span><span class='period'>.</span><span class='id identifier rubyid_hexdigest'>hexdigest</span><span class='lparen'>(</span>
534
- <span class='ivar'>@algorithm</span><span class='comma'>,</span>
535
- <span class='ivar'>@secret</span><span class='comma'>,</span>
536
- <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_verb'>verb</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='period'>.</span><span class='id identifier rubyid_upcase'>upcase</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_path'>path</span><span class='embexpr_end'>}</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="ParamsEncoder.html" title="M2mKeygen::ParamsEncoder (class)">ParamsEncoder</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="ParamsEncoder.html#initialize-instance_method" title="M2mKeygen::ParamsEncoder#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='id identifier rubyid_params'>params</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_encode'>encode</span><span class='embexpr_end'>}</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
537
- <span class='rparen'>)</span>
538
- <span class='kw'>end</span></pre>
539
- </td>
540
- </tr>
541
- </table>
542
- </div>
543
-
544
- <div class="method_details ">
545
- <h3 class="signature " id="validate-instance_method">
546
-
547
- #<strong>validate</strong>(params:, verb:, path:, signature:) &#x21d2; <tt>Boolean</tt>
548
-
549
-
550
-
551
-
552
-
553
- </h3><div class="docstring">
554
- <div class="discussion">
555
-
556
-
557
- </div>
558
- </div>
559
- <div class="tags">
560
- <p class="tag_title">Parameters:</p>
561
- <ul class="param">
562
-
563
- <li>
564
-
565
- <span class='name'>params</span>
566
-
567
-
568
- <span class='type'>(<tt><span class='object_link'><a href="Types.html#ParamsType-constant" title="M2mKeygen::Types::ParamsType (constant)">Types::ParamsType</a></span></tt>)</span>
569
-
570
-
571
-
572
- </li>
573
-
574
- <li>
575
-
576
- <span class='name'>verb</span>
577
-
578
-
579
- <span class='type'>(<tt>String</tt>, <tt>Symbol</tt>)</span>
580
-
581
-
582
-
583
- </li>
584
-
585
- <li>
586
-
587
- <span class='name'>path</span>
588
-
589
-
590
- <span class='type'>(<tt>String</tt>)</span>
591
-
592
-
593
-
594
- </li>
595
-
596
- <li>
597
-
598
- <span class='name'>signature</span>
599
-
600
-
601
- <span class='type'>(<tt>String</tt>)</span>
602
-
603
-
604
-
605
- </li>
606
-
607
- </ul>
608
-
609
- <p class="tag_title">Returns:</p>
610
- <ul class="return">
611
-
612
- <li>
613
-
614
-
615
- <span class='type'>(<tt>Boolean</tt>)</span>
616
-
617
-
618
-
619
- </li>
620
-
621
- </ul>
622
-
623
- </div><table class="source_code">
624
- <tr>
625
- <td>
626
- <pre class="lines">
627
-
628
-
629
- 46
630
- 47
631
- 48
632
- 49
633
- 50
634
- 51
635
- 52
636
- 53
637
- 54
638
- 55
639
- 56
640
- 57
641
- 58
642
- 59
643
- 60</pre>
644
- </td>
645
- <td>
646
- <pre class="code"><span class="info file"># File 'lib/m2m_keygen/signature.rb', line 46</span>
647
-
648
- <span class='kw'>def</span> <span class='id identifier rubyid_validate'>validate</span><span class='lparen'>(</span><span class='label'>params:</span><span class='comma'>,</span> <span class='label'>verb:</span><span class='comma'>,</span> <span class='label'>path:</span><span class='comma'>,</span> <span class='label'>signature:</span><span class='rparen'>)</span>
649
- <span class='kw'>if</span> <span class='const'>OpenSSL</span><span class='period'>.</span><span class='id identifier rubyid_methods'>methods</span><span class='period'>.</span><span class='id identifier rubyid_include?'>include?</span><span class='lparen'>(</span><span class='symbol'>:fixed_length_secure_compare</span><span class='rparen'>)</span>
650
- <span class='const'>OpenSSL</span><span class='period'>.</span><span class='id identifier rubyid_fixed_length_secure_compare'>fixed_length_secure_compare</span><span class='lparen'>(</span>
651
- <span class='id identifier rubyid_sign'>sign</span><span class='lparen'>(</span><span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='label'>verb:</span> <span class='id identifier rubyid_verb'>verb</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span>
652
- <span class='id identifier rubyid_signature'>signature</span><span class='comma'>,</span>
653
- <span class='rparen'>)</span>
654
- <span class='kw'>else</span>
655
- <span class='id identifier rubyid_fallback_fixed_length_secure_compare'>fallback_fixed_length_secure_compare</span><span class='lparen'>(</span>
656
- <span class='id identifier rubyid_sign'>sign</span><span class='lparen'>(</span><span class='label'>params:</span> <span class='id identifier rubyid_params'>params</span><span class='comma'>,</span> <span class='label'>verb:</span> <span class='id identifier rubyid_verb'>verb</span><span class='comma'>,</span> <span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span><span class='comma'>,</span>
657
- <span class='id identifier rubyid_signature'>signature</span><span class='comma'>,</span>
658
- <span class='rparen'>)</span>
659
- <span class='kw'>end</span>
660
- <span class='kw'>rescue</span> <span class='const'>StandardError</span>
661
- <span class='kw'>false</span>
662
- <span class='kw'>end</span></pre>
663
- </td>
664
- </tr>
665
- </table>
666
- </div>
667
-
668
- </div>
669
-
670
- </div>
671
-
672
- <div id="footer">
673
- Generated on Wed Oct 4 16:28:22 2023 by
674
- <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
675
- 0.9.34 (ruby-3.2.2).
676
- </div>
677
-
678
- </div>
679
- </body>
680
- </html>