esp_sdk 1.1.0 → 2.0.0.rc1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (199) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +0 -2
  3. data/.rubocop.yml +53 -6
  4. data/.ruby-version +1 -1
  5. data/.travis.yml +8 -2
  6. data/Gemfile.lock +171 -0
  7. data/Guardfile +47 -0
  8. data/README.md +230 -5
  9. data/Rakefile +14 -1
  10. data/assets/logo.png +0 -0
  11. data/bin/esp_console +71 -0
  12. data/esp_sdk.gemspec +27 -18
  13. data/lib/esp/exceptions.rb +3 -0
  14. data/lib/esp/extensions/active_resource/formats/json_api_format.rb +105 -0
  15. data/lib/esp/extensions/active_resource/paginated_collection.rb +198 -0
  16. data/lib/esp/extensions/active_resource/validations.rb +45 -0
  17. data/lib/esp/resources/alert.rb +135 -0
  18. data/lib/esp/resources/cloud_trail_event.rb +45 -0
  19. data/lib/esp/resources/concerns/stat_totals.rb +79 -0
  20. data/lib/esp/resources/contact_request.rb +42 -0
  21. data/lib/esp/resources/custom_signature.rb +224 -0
  22. data/lib/esp/resources/dashboard.rb +31 -0
  23. data/lib/esp/resources/external_account.rb +89 -0
  24. data/lib/esp/resources/organization.rb +61 -0
  25. data/lib/esp/resources/region.rb +46 -0
  26. data/lib/esp/resources/report.rb +100 -0
  27. data/lib/esp/resources/resource.rb +66 -0
  28. data/lib/esp/resources/service.rb +31 -0
  29. data/lib/esp/resources/signature.rb +106 -0
  30. data/lib/esp/resources/stat.rb +124 -0
  31. data/lib/esp/resources/stat_custom_signature.rb +121 -0
  32. data/lib/esp/resources/stat_region.rb +121 -0
  33. data/lib/esp/resources/stat_service.rb +121 -0
  34. data/lib/esp/resources/stat_signature.rb +121 -0
  35. data/lib/esp/resources/sub_organization.rb +69 -0
  36. data/lib/esp/resources/suppression/region.rb +99 -0
  37. data/lib/esp/resources/suppression/signature.rb +107 -0
  38. data/lib/esp/resources/suppression/unique_identifier.rb +60 -0
  39. data/lib/esp/resources/suppression.rb +86 -0
  40. data/lib/esp/resources/tag.rb +45 -0
  41. data/lib/esp/resources/team.rb +79 -0
  42. data/lib/esp/resources/user.rb +46 -0
  43. data/lib/esp/version.rb +3 -0
  44. data/lib/esp.rb +95 -0
  45. data/lib/esp_sdk.rb +9 -45
  46. data/lib/tasks/rubocop.rake +2 -0
  47. data/lib/tasks/testing.rake +3 -0
  48. data/rdoc/ActiveResource/Formats.html +176 -0
  49. data/rdoc/ActiveResource/PaginatedCollection.html +910 -0
  50. data/rdoc/ActiveResource.html +180 -0
  51. data/rdoc/ESP/Alert.html +771 -0
  52. data/rdoc/ESP/CloudTrailEvent.html +375 -0
  53. data/rdoc/ESP/ContactRequest.html +366 -0
  54. data/rdoc/ESP/CustomSignature.html +746 -0
  55. data/rdoc/ESP/Dashboard.html +355 -0
  56. data/rdoc/ESP/ExternalAccount.html +565 -0
  57. data/rdoc/ESP/Organization.html +590 -0
  58. data/rdoc/ESP/Region.html +399 -0
  59. data/rdoc/ESP/Report.html +622 -0
  60. data/rdoc/ESP/Service.html +380 -0
  61. data/rdoc/ESP/Signature.html +555 -0
  62. data/rdoc/ESP/Stat.html +1778 -0
  63. data/rdoc/ESP/StatCustomSignature.html +1599 -0
  64. data/rdoc/ESP/StatRegion.html +1598 -0
  65. data/rdoc/ESP/StatService.html +1598 -0
  66. data/rdoc/ESP/StatSignature.html +1598 -0
  67. data/rdoc/ESP/SubOrganization.html +540 -0
  68. data/rdoc/ESP/Suppression/Region.html +454 -0
  69. data/rdoc/ESP/Suppression/Signature.html +470 -0
  70. data/rdoc/ESP/Suppression/UniqueIdentifier.html +417 -0
  71. data/rdoc/ESP/Suppression.html +649 -0
  72. data/rdoc/ESP/Tag.html +371 -0
  73. data/rdoc/ESP/Team.html +584 -0
  74. data/rdoc/ESP/User.html +483 -0
  75. data/rdoc/ESP.html +546 -0
  76. data/rdoc/README_md.html +501 -0
  77. data/rdoc/created.rid +30 -0
  78. data/rdoc/images/add.png +0 -0
  79. data/rdoc/images/arrow_up.png +0 -0
  80. data/rdoc/images/brick.png +0 -0
  81. data/rdoc/images/brick_link.png +0 -0
  82. data/rdoc/images/bug.png +0 -0
  83. data/rdoc/images/bullet_black.png +0 -0
  84. data/rdoc/images/bullet_toggle_minus.png +0 -0
  85. data/rdoc/images/bullet_toggle_plus.png +0 -0
  86. data/rdoc/images/date.png +0 -0
  87. data/rdoc/images/delete.png +0 -0
  88. data/rdoc/images/find.png +0 -0
  89. data/rdoc/images/loadingAnimation.gif +0 -0
  90. data/rdoc/images/macFFBgHack.png +0 -0
  91. data/rdoc/images/package.png +0 -0
  92. data/rdoc/images/page_green.png +0 -0
  93. data/rdoc/images/page_white_text.png +0 -0
  94. data/rdoc/images/page_white_width.png +0 -0
  95. data/rdoc/images/plugin.png +0 -0
  96. data/rdoc/images/ruby.png +0 -0
  97. data/rdoc/images/tag_blue.png +0 -0
  98. data/rdoc/images/tag_green.png +0 -0
  99. data/rdoc/images/transparent.png +0 -0
  100. data/rdoc/images/wrench.png +0 -0
  101. data/rdoc/images/wrench_orange.png +0 -0
  102. data/rdoc/images/zoom.png +0 -0
  103. data/rdoc/index.html +134 -0
  104. data/rdoc/js/darkfish.js +155 -0
  105. data/rdoc/js/jquery.js +4 -0
  106. data/rdoc/js/navigation.js +142 -0
  107. data/rdoc/js/search.js +94 -0
  108. data/rdoc/js/search_index.js +1 -0
  109. data/rdoc/js/searcher.js +228 -0
  110. data/rdoc/rdoc.css +595 -0
  111. data/rdoc/table_of_contents.html +927 -0
  112. data/test/esp/extensions/active_resource/formats/json_api_format_test.rb +109 -0
  113. data/test/esp/extensions/active_resource/paginated_collection_test.rb +435 -0
  114. data/test/esp/extensions/active_resource/validations_test.rb +59 -0
  115. data/test/esp/resources/alert_test.rb +263 -0
  116. data/test/esp/resources/cloud_trail_event_test.rb +98 -0
  117. data/test/esp/resources/contact_request_test.rb +73 -0
  118. data/test/esp/resources/custom_signature_test.rb +241 -0
  119. data/test/esp/resources/dashboard_test.rb +71 -0
  120. data/test/esp/resources/external_account_test.rb +125 -0
  121. data/test/esp/resources/organization_test.rb +175 -0
  122. data/test/esp/resources/region_test.rb +84 -0
  123. data/test/esp/resources/report_test.rb +180 -0
  124. data/test/esp/resources/resource_test.rb +183 -0
  125. data/test/esp/resources/service_test.rb +64 -0
  126. data/test/esp/resources/signature_test.rb +177 -0
  127. data/test/esp/resources/stat_custom_signature_test.rb +115 -0
  128. data/test/esp/resources/stat_region_test.rb +114 -0
  129. data/test/esp/resources/stat_service_test.rb +114 -0
  130. data/test/esp/resources/stat_signature_test.rb +115 -0
  131. data/test/esp/resources/stat_test.rb +159 -0
  132. data/test/esp/resources/sub_organization_test.rb +127 -0
  133. data/test/esp/resources/suppression/region_test.rb +115 -0
  134. data/test/esp/resources/suppression/signature_test.rb +117 -0
  135. data/test/esp/resources/suppression/unique_identifier_test.rb +79 -0
  136. data/test/esp/resources/suppression_test.rb +226 -0
  137. data/test/esp/resources/tag_test.rb +98 -0
  138. data/test/esp/resources/team_test.rb +140 -0
  139. data/test/esp/resources/user_test.rb +113 -0
  140. data/test/esp_test.rb +139 -0
  141. data/test/factories/alerts.rb +234 -0
  142. data/test/factories/cloud_trail_events.rb +16 -0
  143. data/test/factories/contact_requests.rb +14 -0
  144. data/test/factories/custom_signatures.rb +30 -0
  145. data/test/factories/dashboards.rb +91 -0
  146. data/test/factories/errors.rb +24 -0
  147. data/test/factories/external_accounts.rb +44 -0
  148. data/test/factories/organizations.rb +48 -0
  149. data/test/factories/regions.rb +9 -0
  150. data/test/factories/reports.rb +56 -0
  151. data/test/factories/services.rb +12 -0
  152. data/test/factories/signatures.rb +28 -0
  153. data/test/factories/stat_custom_signatures.rb +97 -0
  154. data/test/factories/stat_regions.rb +97 -0
  155. data/test/factories/stat_services.rb +97 -0
  156. data/test/factories/stat_signautures.rb +97 -0
  157. data/test/factories/stats.rb +129 -0
  158. data/test/factories/sub_organizations.rb +34 -0
  159. data/test/factories/suppression/regions.rb +90 -0
  160. data/test/factories/suppression/signatures.rb +117 -0
  161. data/test/factories/suppression/unique_identifiers.rb +111 -0
  162. data/test/factories/suppressions.rb +71 -0
  163. data/test/factories/tags.rb +12 -0
  164. data/test/factories/teams.rb +32 -0
  165. data/test/factories/users.rb +54 -0
  166. data/test/json_strategy.rb +25 -0
  167. data/test/test_helper.rb +44 -5
  168. metadata +387 -119
  169. data/bin/esp_repl +0 -60
  170. data/lib/esp_sdk/api.rb +0 -33
  171. data/lib/esp_sdk/client.rb +0 -62
  172. data/lib/esp_sdk/configure.rb +0 -40
  173. data/lib/esp_sdk/end_points/base.rb +0 -102
  174. data/lib/esp_sdk/end_points/contact_requests.rb +0 -6
  175. data/lib/esp_sdk/end_points/custom_signatures.rb +0 -41
  176. data/lib/esp_sdk/end_points/dashboard.rb +0 -35
  177. data/lib/esp_sdk/end_points/external_accounts.rb +0 -9
  178. data/lib/esp_sdk/end_points/organizations.rb +0 -6
  179. data/lib/esp_sdk/end_points/reports.rb +0 -6
  180. data/lib/esp_sdk/end_points/services.rb +0 -6
  181. data/lib/esp_sdk/end_points/signatures.rb +0 -39
  182. data/lib/esp_sdk/end_points/sub_organizations.rb +0 -6
  183. data/lib/esp_sdk/end_points/teams.rb +0 -6
  184. data/lib/esp_sdk/end_points/users.rb +0 -6
  185. data/lib/esp_sdk/exceptions.rb +0 -8
  186. data/lib/esp_sdk/extensions/rest_client/request.rb +0 -9
  187. data/lib/esp_sdk/repl.rb +0 -61
  188. data/lib/esp_sdk/version.rb +0 -3
  189. data/test/esp_sdk/api_test.rb +0 -36
  190. data/test/esp_sdk/client_test.rb +0 -129
  191. data/test/esp_sdk/configure_test.rb +0 -65
  192. data/test/esp_sdk/end_points/.keep +0 -0
  193. data/test/esp_sdk/end_points/base_test.rb +0 -230
  194. data/test/esp_sdk/end_points/custom_signatures_test.rb +0 -90
  195. data/test/esp_sdk/end_points/dashboard_test.rb +0 -55
  196. data/test/esp_sdk/end_points/external_accounts_test.rb +0 -20
  197. data/test/esp_sdk/end_points/signatures_test.rb +0 -83
  198. data/test/esp_sdk/exceptions_test.rb +0 -41
  199. data/test/esp_sdk_test.rb +0 -70
data/rdoc/ESP/Alert.html ADDED
@@ -0,0 +1,771 @@
1
+ <!DOCTYPE html>
2
+
3
+ <html>
4
+ <head>
5
+ <meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
6
+
7
+ <title>class ESP::Alert - ESPSDK</title>
8
+
9
+ <link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
10
+
11
+ <script type="text/javascript">
12
+ var rdoc_rel_prefix = "../";
13
+ </script>
14
+
15
+ <script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
16
+ <script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
17
+ <script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
18
+ <script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
19
+ <script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
20
+ <script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
21
+
22
+
23
+ <body id="top" class="class">
24
+ <nav id="metadata">
25
+ <nav id="home-section" class="section">
26
+ <h3 class="section-header">
27
+ <a href="../index.html">Home</a>
28
+ <a href="../table_of_contents.html#classes">Classes</a>
29
+ <a href="../table_of_contents.html#methods">Methods</a>
30
+ </h3>
31
+ </nav>
32
+
33
+
34
+ <nav id="search-section" class="section project-section" class="initially-hidden">
35
+ <form action="#" method="get" accept-charset="utf-8">
36
+ <h3 class="section-header">
37
+ <input type="text" name="search" placeholder="Search" id="search-field"
38
+ title="Type to search, Up and Down to navigate, Enter to load">
39
+ </h3>
40
+ </form>
41
+
42
+ <ul id="search-results" class="initially-hidden"></ul>
43
+ </nav>
44
+
45
+
46
+
47
+
48
+ <div id="file-metadata">
49
+ <nav id="file-list-section" class="section">
50
+ <h3 class="section-header">Defined In</h3>
51
+ <ul>
52
+ <li>lib/esp/resources/alert.rb
53
+ </ul>
54
+ </nav>
55
+
56
+
57
+ </div>
58
+
59
+ <div id="class-metadata">
60
+
61
+ <nav id="parent-class-section" class="section">
62
+ <h3 class="section-header">Parent</h3>
63
+
64
+ <p class="link">ESP::Resource
65
+
66
+ </nav>
67
+
68
+
69
+
70
+ <!-- Method Quickref -->
71
+ <nav id="method-list-section" class="section">
72
+ <h3 class="section-header">Methods</h3>
73
+
74
+ <ul class="link-list">
75
+
76
+ <li class="calls-super" ><a href="#method-c-find">::find</a>
77
+
78
+ <li ><a href="#method-c-for_report">::for_report</a>
79
+
80
+ <li ><a href="#method-i-cloud_trail_events">#cloud_trail_events</a>
81
+
82
+ <li ><a href="#method-i-custom_signature">#custom_signature</a>
83
+
84
+ <li ><a href="#method-i-destroy">#destroy</a>
85
+
86
+ <li ><a href="#method-i-external_account">#external_account</a>
87
+
88
+ <li ><a href="#method-i-region">#region</a>
89
+
90
+ <li ><a href="#method-i-save">#save</a>
91
+
92
+ <li ><a href="#method-i-signature">#signature</a>
93
+
94
+ <li ><a href="#method-i-suppress_region">#suppress_region</a>
95
+
96
+ <li ><a href="#method-i-suppress_signature">#suppress_signature</a>
97
+
98
+ <li ><a href="#method-i-suppress_unique_identifier">#suppress_unique_identifier</a>
99
+
100
+ <li ><a href="#method-i-suppression">#suppression</a>
101
+
102
+ <li ><a href="#method-i-tags">#tags</a>
103
+
104
+ </ul>
105
+ </nav>
106
+
107
+ </div>
108
+
109
+ <div id="project-metadata">
110
+ <nav id="fileindex-section" class="section project-section">
111
+ <h3 class="section-header">Pages</h3>
112
+
113
+ <ul>
114
+
115
+ <li class="file"><a href="../README_md.html">README</a>
116
+
117
+ </ul>
118
+ </nav>
119
+
120
+ <nav id="classindex-section" class="section project-section">
121
+ <h3 class="section-header">Class and Module Index</h3>
122
+
123
+ <ul class="link-list">
124
+
125
+ <li><a href="../ActiveResource.html">ActiveResource</a>
126
+
127
+ <li><a href="../ActiveResource/Formats.html">ActiveResource::Formats</a>
128
+
129
+ <li><a href="../ActiveResource/PaginatedCollection.html">ActiveResource::PaginatedCollection</a>
130
+
131
+ <li><a href="../ESP.html">ESP</a>
132
+
133
+ <li><a href="../ESP/Alert.html">ESP::Alert</a>
134
+
135
+ <li><a href="../ESP/CloudTrailEvent.html">ESP::CloudTrailEvent</a>
136
+
137
+ <li><a href="../ESP/ContactRequest.html">ESP::ContactRequest</a>
138
+
139
+ <li><a href="../ESP/CustomSignature.html">ESP::CustomSignature</a>
140
+
141
+ <li><a href="../ESP/Dashboard.html">ESP::Dashboard</a>
142
+
143
+ <li><a href="../ESP/ExternalAccount.html">ESP::ExternalAccount</a>
144
+
145
+ <li><a href="../ESP/Organization.html">ESP::Organization</a>
146
+
147
+ <li><a href="../ESP/Region.html">ESP::Region</a>
148
+
149
+ <li><a href="../ESP/Report.html">ESP::Report</a>
150
+
151
+ <li><a href="../ESP/Service.html">ESP::Service</a>
152
+
153
+ <li><a href="../ESP/Signature.html">ESP::Signature</a>
154
+
155
+ <li><a href="../ESP/Stat.html">ESP::Stat</a>
156
+
157
+ <li><a href="../ESP/StatCustomSignature.html">ESP::StatCustomSignature</a>
158
+
159
+ <li><a href="../ESP/StatRegion.html">ESP::StatRegion</a>
160
+
161
+ <li><a href="../ESP/StatService.html">ESP::StatService</a>
162
+
163
+ <li><a href="../ESP/StatSignature.html">ESP::StatSignature</a>
164
+
165
+ <li><a href="../ESP/SubOrganization.html">ESP::SubOrganization</a>
166
+
167
+ <li><a href="../ESP/Suppression.html">ESP::Suppression</a>
168
+
169
+ <li><a href="../ESP/Suppression/Region.html">ESP::Suppression::Region</a>
170
+
171
+ <li><a href="../ESP/Suppression/Signature.html">ESP::Suppression::Signature</a>
172
+
173
+ <li><a href="../ESP/Suppression/UniqueIdentifier.html">ESP::Suppression::UniqueIdentifier</a>
174
+
175
+ <li><a href="../ESP/Tag.html">ESP::Tag</a>
176
+
177
+ <li><a href="../ESP/Team.html">ESP::Team</a>
178
+
179
+ <li><a href="../ESP/User.html">ESP::User</a>
180
+
181
+ </ul>
182
+ </nav>
183
+
184
+ </div>
185
+ </nav>
186
+
187
+ <div id="documentation">
188
+ <h1 class="class">class ESP::Alert</h1>
189
+
190
+ <div id="description" class="description">
191
+
192
+ </div><!-- description -->
193
+
194
+
195
+
196
+
197
+ <section id="5Buntitled-5D" class="documentation-section">
198
+
199
+
200
+
201
+
202
+
203
+
204
+
205
+
206
+ <!-- Methods -->
207
+
208
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
209
+ <h3 class="section-header">Public Class Methods</h3>
210
+
211
+
212
+ <div id="method-c-find" class="method-detail ">
213
+
214
+
215
+ <div class="method-heading">
216
+ <span class="method-callseq">
217
+ find(id)
218
+ </span>
219
+
220
+ <span class="method-click-advice">click to toggle source</span>
221
+
222
+ </div>
223
+
224
+
225
+
226
+ <div class="method-description">
227
+
228
+ <p>Find an <a href="Alert.html">Alert</a> by id</p>
229
+
230
+ <h4 id="method-c-find-label-Parameter">Parameter<span><a href="#method-c-find-label-Parameter">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
231
+
232
+ <p><code>id</code> | Required | The ID of the alert to retrieve</p>
233
+
234
+
235
+ <div class="method-calls-super">
236
+ Calls superclass method
237
+
238
+ </div>
239
+
240
+
241
+
242
+ <div class="method-source-code" id="find-source">
243
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 90</span>
244
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">find</span>(<span class="ruby-operator">*</span><span class="ruby-identifier">arguments</span>)
245
+ <span class="ruby-identifier">scope</span> = <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-value">0</span>)
246
+ <span class="ruby-identifier">options</span> = (<span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-value">0</span>) <span class="ruby-operator">||</span> {}).<span class="ruby-identifier">with_indifferent_access</span>
247
+ <span class="ruby-keyword">return</span> <span class="ruby-keyword">super</span>(<span class="ruby-identifier">scope</span>, <span class="ruby-identifier">options</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">scope</span>.<span class="ruby-identifier">is_a?</span>(<span class="ruby-constant">Numeric</span>) <span class="ruby-operator">||</span> <span class="ruby-identifier">options</span>[<span class="ruby-value">:from</span>].<span class="ruby-identifier">present?</span>
248
+ <span class="ruby-identifier">params</span> = <span class="ruby-identifier">options</span>.<span class="ruby-identifier">fetch</span>(<span class="ruby-value">:params</span>, {}).<span class="ruby-identifier">with_indifferent_access</span>
249
+ <span class="ruby-identifier">report_id</span> = <span class="ruby-identifier">params</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-value">:report_id</span>)
250
+ <span class="ruby-identifier">for_report</span>(<span class="ruby-identifier">report_id</span>, <span class="ruby-identifier">params</span>)
251
+ <span class="ruby-keyword">end</span></pre>
252
+ </div><!-- find-source -->
253
+
254
+ </div>
255
+
256
+
257
+
258
+
259
+ </div><!-- find-method -->
260
+
261
+
262
+ <div id="method-c-for_report" class="method-detail ">
263
+
264
+ <div class="method-heading">
265
+ <span class="method-name">for_report</span><span
266
+ class="method-args">(report_id = nil, arguments = {})</span>
267
+
268
+ <span class="method-click-advice">click to toggle source</span>
269
+
270
+ </div>
271
+
272
+
273
+ <div class="method-description">
274
+
275
+ <p>Returns a paginated collection of alerts for the given report_id
276
+ Convenience method to use instead of <a
277
+ href="Alert.html#method-c-find">::find</a> since a report_id is required to
278
+ return alerts.</p>
279
+
280
+ <h4 id="method-c-for_report-label-Parameters">Parameters<span><a href="#method-c-for_report-label-Parameters">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
281
+
282
+ <p><code>report_id</code> | Required | The ID of the report to retrieve alerts
283
+ for</p>
284
+
285
+ <p><code>arguments</code> | Not Required | An optional hash of search criteria
286
+ to filter the returned collection</p>
287
+
288
+ <h5 id="method-c-for_report-label-Valid+Arguments">Valid Arguments<span><a href="#method-c-for_report-label-Valid+Arguments">&para;</a> <a href="#documentation">&uarr;</a></span></h5>
289
+
290
+ <p><code>region_id</code> | Not Required | Return only alerts for this region.</p>
291
+
292
+ <p><code>status</code> | Not Required | Return only alerts for the give
293
+ status(es). Valid values are fail, warn, error, pass, info</p>
294
+
295
+ <p><code>first_seen</code> | Not Required | Return only alerts that have
296
+ started within a number of hours of the report. For example, first_seen of
297
+ 3 will return alerts that started showing up within the last 3 hours of the
298
+ report.</p>
299
+
300
+ <p><code>suppressed</code> | Not Required | Return only suppressed alerts</p>
301
+
302
+ <p><code>team_id</code> | Not Required | Return only alerts for the given
303
+ team.</p>
304
+
305
+ <p><code>external_account_id</code> | Not Required | Return only alerts for
306
+ the given external id.</p>
307
+
308
+ <p><code>service_id</code> | Not Required | Return only alerts on signatures
309
+ with the given service.</p>
310
+
311
+ <p><code>signature_severity</code> | Not Required | Return only alerts for
312
+ signatures with the given risk_level. Valid values are Low, Medium, High</p>
313
+
314
+ <p><code>signature_name</code> | Not Required | Return only alerts for
315
+ signatures with the given name.</p>
316
+
317
+ <p><code>resource</code> | Not Required | Return only alerts for the given
318
+ resource or tag.</p>
319
+
320
+ <p><code>signature_identifier</code> | Not Required | Return only alerts for
321
+ signatures with the given identifier.</p>
322
+
323
+ <h4 id="method-c-for_report-label-Example">Example<span><a href="#method-c-for_report-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
324
+
325
+ <pre>alerts = ESP::Alert.for_report(54, status: &#39;fail&#39;, signature_severity: &#39;High&#39;)</pre>
326
+
327
+
328
+
329
+
330
+ <div class="method-source-code" id="for_report-source">
331
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 76</span>
332
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">for_report</span>(<span class="ruby-identifier">report_id</span> = <span class="ruby-keyword">nil</span>, <span class="ruby-identifier">arguments</span> = {})
333
+ <span class="ruby-identifier">fail</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;You must supply a report id.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">report_id</span>.<span class="ruby-identifier">present?</span>
334
+ <span class="ruby-identifier">from</span> = <span class="ruby-node">&quot;#{prefix}reports/#{report_id}/alerts.json&quot;</span>
335
+ <span class="ruby-identifier">all</span>(<span class="ruby-identifier">from</span><span class="ruby-operator">:</span> <span class="ruby-identifier">from</span>, <span class="ruby-identifier">params</span><span class="ruby-operator">:</span> <span class="ruby-identifier">arguments</span>)
336
+ <span class="ruby-keyword">end</span></pre>
337
+ </div><!-- for_report-source -->
338
+
339
+ </div>
340
+
341
+
342
+
343
+
344
+ </div><!-- for_report-method -->
345
+
346
+
347
+ </section><!-- public-class-method-details -->
348
+
349
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
350
+ <h3 class="section-header">Public Instance Methods</h3>
351
+
352
+
353
+ <div id="method-i-cloud_trail_events" class="method-detail ">
354
+
355
+ <div class="method-heading">
356
+ <span class="method-name">cloud_trail_events</span><span
357
+ class="method-args">()</span>
358
+
359
+ <span class="method-click-advice">click to toggle source</span>
360
+
361
+ </div>
362
+
363
+
364
+ <div class="method-description">
365
+
366
+ <p>Returns the cloud trail events associated with this alert. These may be
367
+ added up to 10 minutes after the alert was created</p>
368
+
369
+
370
+
371
+
372
+ <div class="method-source-code" id="cloud_trail_events-source">
373
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 25</span>
374
+ <span class="ruby-identifier">has_many</span> <span class="ruby-value">:cloud_trail_events</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::CloudTrailEvent&#39;</span>
375
+ </pre>
376
+ </div><!-- cloud_trail_events-source -->
377
+
378
+ </div>
379
+
380
+
381
+
382
+
383
+ </div><!-- cloud_trail_events-method -->
384
+
385
+
386
+ <div id="method-i-custom_signature" class="method-detail ">
387
+
388
+ <div class="method-heading">
389
+ <span class="method-name">custom_signature</span><span
390
+ class="method-args">()</span>
391
+
392
+ <span class="method-click-advice">click to toggle source</span>
393
+
394
+ </div>
395
+
396
+
397
+ <div class="method-description">
398
+
399
+ <p>Returns the custom signature associated with this alert. Either a
400
+ signature or custom signature but not both will be present.</p>
401
+
402
+
403
+
404
+
405
+ <div class="method-source-code" id="custom_signature-source">
406
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 17</span>
407
+ <span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:custom_signature</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::CustomSignature&#39;</span>
408
+ </pre>
409
+ </div><!-- custom_signature-source -->
410
+
411
+ </div>
412
+
413
+
414
+
415
+
416
+ </div><!-- custom_signature-method -->
417
+
418
+
419
+ <div id="method-i-destroy" class="method-detail ">
420
+
421
+ <div class="method-heading">
422
+ <span class="method-name">destroy</span><span
423
+ class="method-args">()</span>
424
+
425
+ <span class="method-click-advice">click to toggle source</span>
426
+
427
+ </div>
428
+
429
+
430
+ <div class="method-description">
431
+
432
+ <p>Not Implemented. You cannot destroy a an <a href="Alert.html">Alert</a>.</p>
433
+
434
+
435
+
436
+
437
+ <div class="method-source-code" id="destroy-source">
438
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 37</span>
439
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span>
440
+ <span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
441
+ <span class="ruby-keyword">end</span></pre>
442
+ </div><!-- destroy-source -->
443
+
444
+ </div>
445
+
446
+
447
+
448
+
449
+ </div><!-- destroy-method -->
450
+
451
+
452
+ <div id="method-i-external_account" class="method-detail ">
453
+
454
+ <div class="method-heading">
455
+ <span class="method-name">external_account</span><span
456
+ class="method-args">()</span>
457
+
458
+ <span class="method-click-advice">click to toggle source</span>
459
+
460
+ </div>
461
+
462
+
463
+ <div class="method-description">
464
+
465
+ <p>Returns the external account associated with this alert.</p>
466
+
467
+
468
+
469
+
470
+ <div class="method-source-code" id="external_account-source">
471
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 5</span>
472
+ <span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:external_account</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::ExternalAccount&#39;</span>
473
+ </pre>
474
+ </div><!-- external_account-source -->
475
+
476
+ </div>
477
+
478
+
479
+
480
+
481
+ </div><!-- external_account-method -->
482
+
483
+
484
+ <div id="method-i-region" class="method-detail ">
485
+
486
+ <div class="method-heading">
487
+ <span class="method-name">region</span><span
488
+ class="method-args">()</span>
489
+
490
+ <span class="method-click-advice">click to toggle source</span>
491
+
492
+ </div>
493
+
494
+
495
+ <div class="method-description">
496
+
497
+ <p>Returns the region associated with this alert.</p>
498
+
499
+
500
+
501
+
502
+ <div class="method-source-code" id="region-source">
503
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 9</span>
504
+ <span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:region</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::Region&#39;</span>
505
+ </pre>
506
+ </div><!-- region-source -->
507
+
508
+ </div>
509
+
510
+
511
+
512
+
513
+ </div><!-- region-method -->
514
+
515
+
516
+ <div id="method-i-save" class="method-detail ">
517
+
518
+ <div class="method-heading">
519
+ <span class="method-name">save</span><span
520
+ class="method-args">()</span>
521
+
522
+ <span class="method-click-advice">click to toggle source</span>
523
+
524
+ </div>
525
+
526
+
527
+ <div class="method-description">
528
+
529
+ <p>Not Implemented. You cannot create or update an <a
530
+ href="Alert.html">Alert</a>.</p>
531
+
532
+
533
+
534
+
535
+ <div class="method-source-code" id="save-source">
536
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 32</span>
537
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">save</span>
538
+ <span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
539
+ <span class="ruby-keyword">end</span></pre>
540
+ </div><!-- save-source -->
541
+
542
+ </div>
543
+
544
+
545
+
546
+
547
+ </div><!-- save-method -->
548
+
549
+
550
+ <div id="method-i-signature" class="method-detail ">
551
+
552
+ <div class="method-heading">
553
+ <span class="method-name">signature</span><span
554
+ class="method-args">()</span>
555
+
556
+ <span class="method-click-advice">click to toggle source</span>
557
+
558
+ </div>
559
+
560
+
561
+ <div class="method-description">
562
+
563
+ <p>Returns the region associated with this alert. Either a signature or
564
+ custom signature but not both will be present.</p>
565
+
566
+
567
+
568
+
569
+ <div class="method-source-code" id="signature-source">
570
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 13</span>
571
+ <span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:signature</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::Signature&#39;</span>
572
+ </pre>
573
+ </div><!-- signature-source -->
574
+
575
+ </div>
576
+
577
+
578
+
579
+
580
+ </div><!-- signature-method -->
581
+
582
+
583
+ <div id="method-i-suppress_region" class="method-detail ">
584
+
585
+ <div class="method-heading">
586
+ <span class="method-name">suppress_region</span><span
587
+ class="method-args">(reason = nil)</span>
588
+
589
+ <span class="method-click-advice">click to toggle source</span>
590
+
591
+ </div>
592
+
593
+
594
+ <div class="method-description">
595
+
596
+ <p>Suppress the region associated with this alert.</p>
597
+
598
+ <h4 id="method-i-suppress_region-label-Parameter">Parameter<span><a href="#method-i-suppress_region-label-Parameter">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
599
+
600
+ <p><code>reason</code> | Required | The reason for creating the suppression.</p>
601
+
602
+
603
+
604
+
605
+ <div class="method-source-code" id="suppress_region-source">
606
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 111</span>
607
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">suppress_region</span>(<span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
608
+ <span class="ruby-identifier">suppress</span>(<span class="ruby-constant">Suppression</span><span class="ruby-operator">::</span><span class="ruby-constant">Region</span>, <span class="ruby-identifier">reason</span>)
609
+ <span class="ruby-keyword">end</span></pre>
610
+ </div><!-- suppress_region-source -->
611
+
612
+ </div>
613
+
614
+
615
+
616
+
617
+ </div><!-- suppress_region-method -->
618
+
619
+
620
+ <div id="method-i-suppress_signature" class="method-detail ">
621
+
622
+ <div class="method-heading">
623
+ <span class="method-name">suppress_signature</span><span
624
+ class="method-args">(reason = nil)</span>
625
+
626
+ <span class="method-click-advice">click to toggle source</span>
627
+
628
+ </div>
629
+
630
+
631
+ <div class="method-description">
632
+
633
+ <p>Suppress the signature associated with this alert.</p>
634
+
635
+ <h4 id="method-i-suppress_signature-label-Parameter">Parameter<span><a href="#method-i-suppress_signature-label-Parameter">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
636
+
637
+ <p><code>reason</code> | Required | The reason for creating the suppression.</p>
638
+
639
+
640
+
641
+
642
+ <div class="method-source-code" id="suppress_signature-source">
643
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 103</span>
644
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">suppress_signature</span>(<span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
645
+ <span class="ruby-identifier">suppress</span>(<span class="ruby-constant">Suppression</span><span class="ruby-operator">::</span><span class="ruby-constant">Signature</span>, <span class="ruby-identifier">reason</span>)
646
+ <span class="ruby-keyword">end</span></pre>
647
+ </div><!-- suppress_signature-source -->
648
+
649
+ </div>
650
+
651
+
652
+
653
+
654
+ </div><!-- suppress_signature-method -->
655
+
656
+
657
+ <div id="method-i-suppress_unique_identifier" class="method-detail ">
658
+
659
+ <div class="method-heading">
660
+ <span class="method-name">suppress_unique_identifier</span><span
661
+ class="method-args">(reason = nil)</span>
662
+
663
+ <span class="method-click-advice">click to toggle source</span>
664
+
665
+ </div>
666
+
667
+
668
+ <div class="method-description">
669
+
670
+ <p>Suppress the unique identifier associated with this alert.</p>
671
+
672
+ <h4 id="method-i-suppress_unique_identifier-label-Parameter">Parameter<span><a href="#method-i-suppress_unique_identifier-label-Parameter">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
673
+
674
+ <p><code>reason</code> | Required | The reason for creating the suppression.</p>
675
+
676
+
677
+
678
+
679
+ <div class="method-source-code" id="suppress_unique_identifier-source">
680
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 119</span>
681
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">suppress_unique_identifier</span>(<span class="ruby-identifier">reason</span> = <span class="ruby-keyword">nil</span>)
682
+ <span class="ruby-identifier">suppress</span>(<span class="ruby-constant">Suppression</span><span class="ruby-operator">::</span><span class="ruby-constant">UniqueIdentifier</span>, <span class="ruby-identifier">reason</span>)
683
+ <span class="ruby-keyword">end</span></pre>
684
+ </div><!-- suppress_unique_identifier-source -->
685
+
686
+ </div>
687
+
688
+
689
+
690
+
691
+ </div><!-- suppress_unique_identifier-method -->
692
+
693
+
694
+ <div id="method-i-suppression" class="method-detail ">
695
+
696
+ <div class="method-heading">
697
+ <span class="method-name">suppression</span><span
698
+ class="method-args">()</span>
699
+
700
+ <span class="method-click-advice">click to toggle source</span>
701
+
702
+ </div>
703
+
704
+
705
+ <div class="method-description">
706
+
707
+ <p>Returns the suppression associated with this alert. If present the alert
708
+ was suppressed.</p>
709
+
710
+
711
+
712
+
713
+ <div class="method-source-code" id="suppression-source">
714
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 21</span>
715
+ <span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:suppression</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::Suppression&#39;</span>
716
+ </pre>
717
+ </div><!-- suppression-source -->
718
+
719
+ </div>
720
+
721
+
722
+
723
+
724
+ </div><!-- suppression-method -->
725
+
726
+
727
+ <div id="method-i-tags" class="method-detail ">
728
+
729
+ <div class="method-heading">
730
+ <span class="method-name">tags</span><span
731
+ class="method-args">()</span>
732
+
733
+ <span class="method-click-advice">click to toggle source</span>
734
+
735
+ </div>
736
+
737
+
738
+ <div class="method-description">
739
+
740
+ <p>Returns the tags associated with this alert.</p>
741
+
742
+
743
+
744
+
745
+ <div class="method-source-code" id="tags-source">
746
+ <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 29</span>
747
+ <span class="ruby-identifier">has_many</span> <span class="ruby-value">:tags</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::Tag&#39;</span>
748
+ </pre>
749
+ </div><!-- tags-source -->
750
+
751
+ </div>
752
+
753
+
754
+
755
+
756
+ </div><!-- tags-method -->
757
+
758
+
759
+ </section><!-- public-instance-method-details -->
760
+
761
+ </section><!-- 5Buntitled-5D -->
762
+
763
+ </div><!-- documentation -->
764
+
765
+
766
+ <footer id="validator-badges">
767
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
768
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
769
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
770
+ </footer>
771
+