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/Report.html ADDED
@@ -0,0 +1,622 @@
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::Report - 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/report.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 ><a href="#method-c-all">::all</a>
77
+
78
+ <li class="calls-super" ><a href="#method-c-create">::create</a>
79
+
80
+ <li ><a href="#method-c-find">::find</a>
81
+
82
+ <li ><a href="#method-i-alerts">#alerts</a>
83
+
84
+ <li ><a href="#method-i-destroy">#destroy</a>
85
+
86
+ <li ><a href="#method-i-organization">#organization</a>
87
+
88
+ <li ><a href="#method-i-stat">#stat</a>
89
+
90
+ <li ><a href="#method-i-sub_organization">#sub_organization</a>
91
+
92
+ <li ><a href="#method-i-team">#team</a>
93
+
94
+ <li ><a href="#method-i-update">#update</a>
95
+
96
+ </ul>
97
+ </nav>
98
+
99
+ </div>
100
+
101
+ <div id="project-metadata">
102
+ <nav id="fileindex-section" class="section project-section">
103
+ <h3 class="section-header">Pages</h3>
104
+
105
+ <ul>
106
+
107
+ <li class="file"><a href="../README_md.html">README</a>
108
+
109
+ </ul>
110
+ </nav>
111
+
112
+ <nav id="classindex-section" class="section project-section">
113
+ <h3 class="section-header">Class and Module Index</h3>
114
+
115
+ <ul class="link-list">
116
+
117
+ <li><a href="../ActiveResource.html">ActiveResource</a>
118
+
119
+ <li><a href="../ActiveResource/Formats.html">ActiveResource::Formats</a>
120
+
121
+ <li><a href="../ActiveResource/PaginatedCollection.html">ActiveResource::PaginatedCollection</a>
122
+
123
+ <li><a href="../ESP.html">ESP</a>
124
+
125
+ <li><a href="../ESP/Alert.html">ESP::Alert</a>
126
+
127
+ <li><a href="../ESP/CloudTrailEvent.html">ESP::CloudTrailEvent</a>
128
+
129
+ <li><a href="../ESP/ContactRequest.html">ESP::ContactRequest</a>
130
+
131
+ <li><a href="../ESP/CustomSignature.html">ESP::CustomSignature</a>
132
+
133
+ <li><a href="../ESP/Dashboard.html">ESP::Dashboard</a>
134
+
135
+ <li><a href="../ESP/ExternalAccount.html">ESP::ExternalAccount</a>
136
+
137
+ <li><a href="../ESP/Organization.html">ESP::Organization</a>
138
+
139
+ <li><a href="../ESP/Region.html">ESP::Region</a>
140
+
141
+ <li><a href="../ESP/Report.html">ESP::Report</a>
142
+
143
+ <li><a href="../ESP/Service.html">ESP::Service</a>
144
+
145
+ <li><a href="../ESP/Signature.html">ESP::Signature</a>
146
+
147
+ <li><a href="../ESP/Stat.html">ESP::Stat</a>
148
+
149
+ <li><a href="../ESP/StatCustomSignature.html">ESP::StatCustomSignature</a>
150
+
151
+ <li><a href="../ESP/StatRegion.html">ESP::StatRegion</a>
152
+
153
+ <li><a href="../ESP/StatService.html">ESP::StatService</a>
154
+
155
+ <li><a href="../ESP/StatSignature.html">ESP::StatSignature</a>
156
+
157
+ <li><a href="../ESP/SubOrganization.html">ESP::SubOrganization</a>
158
+
159
+ <li><a href="../ESP/Suppression.html">ESP::Suppression</a>
160
+
161
+ <li><a href="../ESP/Suppression/Region.html">ESP::Suppression::Region</a>
162
+
163
+ <li><a href="../ESP/Suppression/Signature.html">ESP::Suppression::Signature</a>
164
+
165
+ <li><a href="../ESP/Suppression/UniqueIdentifier.html">ESP::Suppression::UniqueIdentifier</a>
166
+
167
+ <li><a href="../ESP/Tag.html">ESP::Tag</a>
168
+
169
+ <li><a href="../ESP/Team.html">ESP::Team</a>
170
+
171
+ <li><a href="../ESP/User.html">ESP::User</a>
172
+
173
+ </ul>
174
+ </nav>
175
+
176
+ </div>
177
+ </nav>
178
+
179
+ <div id="documentation">
180
+ <h1 class="class">class ESP::Report</h1>
181
+
182
+ <div id="description" class="description">
183
+
184
+ </div><!-- description -->
185
+
186
+
187
+
188
+
189
+ <section id="5Buntitled-5D" class="documentation-section">
190
+
191
+
192
+
193
+
194
+
195
+
196
+
197
+
198
+ <!-- Methods -->
199
+
200
+ <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
201
+ <h3 class="section-header">Public Class Methods</h3>
202
+
203
+
204
+ <div id="method-c-all" class="method-detail ">
205
+
206
+ <div class="method-heading">
207
+ <span class="method-name">all</span><span
208
+ class="method-args">()</span>
209
+
210
+ <span class="method-click-advice">click to toggle source</span>
211
+
212
+ </div>
213
+
214
+
215
+ <div class="method-description">
216
+
217
+ <p>Return a paginated <a href="Report.html">Report</a> list</p>
218
+
219
+
220
+
221
+
222
+ <div class="method-source-code" id="all-source">
223
+ <pre><span class="ruby-comment"># File lib/esp/resources/report.rb, line 99</span>
224
+ </pre>
225
+ </div><!-- all-source -->
226
+
227
+ </div>
228
+
229
+
230
+
231
+
232
+ </div><!-- all-method -->
233
+
234
+
235
+ <div id="method-c-create" class="method-detail ">
236
+
237
+ <div class="method-heading">
238
+ <span class="method-name">create</span><span
239
+ class="method-args">(arguments = {})</span>
240
+
241
+ <span class="method-click-advice">click to toggle source</span>
242
+
243
+ </div>
244
+
245
+
246
+ <div class="method-description">
247
+
248
+ <p>Enqueue a report to be run for the given team. Returns a <a
249
+ href="Report.html">Report</a> object with a status of &#39;queued&#39; and
250
+ an id</p>
251
+
252
+ <h4 id="method-c-create-label-Attribute">Attribute<span><a href="#method-c-create-label-Attribute">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
253
+
254
+ <p><code>team_id</code> | Required | The ID of the team to create a report for</p>
255
+
256
+ <p>Periodically check the API</p>
257
+
258
+ <pre>ESP::Report.find(&lt;id&gt;)</pre>
259
+
260
+ <p>until status is &#39;complete&#39;.</p>
261
+
262
+ <p>If not successful, returns a <a href="Report.html">Report</a> object with
263
+ the errors object populated.</p>
264
+
265
+
266
+ <div class="method-calls-super">
267
+ Calls superclass method
268
+
269
+ </div>
270
+
271
+
272
+
273
+ <div class="method-source-code" id="create-source">
274
+ <pre><span class="ruby-comment"># File lib/esp/resources/report.rb, line 36</span>
275
+ <span class="ruby-keyword">def</span> <span class="ruby-keyword">self</span>.<span class="ruby-identifier">create</span>(<span class="ruby-identifier">arguments</span> = {})
276
+ <span class="ruby-identifier">fail</span> <span class="ruby-constant">ArgumentError</span>, <span class="ruby-string">&quot;You must supply a team id.&quot;</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">with_indifferent_access</span>[<span class="ruby-value">:team_id</span>].<span class="ruby-identifier">present?</span>
277
+ <span class="ruby-keyword">super</span>
278
+ <span class="ruby-keyword">rescue</span> <span class="ruby-constant">ActiveResource</span><span class="ruby-operator">::</span><span class="ruby-constant">ResourceNotFound</span> =<span class="ruby-operator">&gt;</span> <span class="ruby-identifier">error</span>
279
+ <span class="ruby-identifier">new</span>(<span class="ruby-identifier">arguments</span>).<span class="ruby-identifier">tap</span> { <span class="ruby-operator">|</span><span class="ruby-identifier">r</span><span class="ruby-operator">|</span> <span class="ruby-identifier">r</span>.<span class="ruby-identifier">load_remote_errors</span>(<span class="ruby-identifier">error</span>, <span class="ruby-keyword">true</span>) }
280
+ <span class="ruby-keyword">end</span></pre>
281
+ </div><!-- create-source -->
282
+
283
+ </div>
284
+
285
+
286
+
287
+
288
+ </div><!-- create-method -->
289
+
290
+
291
+ <div id="method-c-find" class="method-detail ">
292
+
293
+
294
+ <div class="method-heading">
295
+ <span class="method-callseq">
296
+ find(id)
297
+ </span>
298
+
299
+ <span class="method-click-advice">click to toggle source</span>
300
+
301
+ </div>
302
+
303
+
304
+
305
+ <div class="method-description">
306
+
307
+ <p>Find a <a href="Report.html">Report</a> by id</p>
308
+
309
+ <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>
310
+
311
+ <p><code>id</code> | Required | The ID of the report to retrieve</p>
312
+
313
+
314
+
315
+
316
+ <div class="method-source-code" id="find-source">
317
+ <pre><span class="ruby-comment"># File lib/esp/resources/report.rb, line 97</span>
318
+ </pre>
319
+ </div><!-- find-source -->
320
+
321
+ </div>
322
+
323
+
324
+
325
+
326
+ </div><!-- find-method -->
327
+
328
+
329
+ </section><!-- public-class-method-details -->
330
+
331
+ <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
332
+ <h3 class="section-header">Public Instance Methods</h3>
333
+
334
+
335
+ <div id="method-i-alerts" class="method-detail ">
336
+
337
+ <div class="method-heading">
338
+ <span class="method-name">alerts</span><span
339
+ class="method-args">(arguments = {})</span>
340
+
341
+ <span class="method-click-advice">click to toggle source</span>
342
+
343
+ </div>
344
+
345
+
346
+ <div class="method-description">
347
+
348
+ <p>Returns a paginated collection of alerts for the report</p>
349
+
350
+ <h4 id="method-i-alerts-label-Parameters">Parameters<span><a href="#method-i-alerts-label-Parameters">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
351
+
352
+ <p><code>arguments</code> | Not Required | An optional hash of search criteria
353
+ to filter the returned collection</p>
354
+
355
+ <h5 id="method-i-alerts-label-Valid+Arguments">Valid Arguments<span><a href="#method-i-alerts-label-Valid+Arguments">&para;</a> <a href="#documentation">&uarr;</a></span></h5>
356
+
357
+ <p><code>region_id</code> | Not Required | Return only alerts for this region.</p>
358
+
359
+ <p><code>status</code> | Not Required | Return only alerts for the give
360
+ status(es). Valid values are fail, warn, error, pass, info</p>
361
+
362
+ <p><code>first_seen</code> | Not Required | Return only alerts that have
363
+ started within a number of hours of the report. For example, first_seen of
364
+ 3 will return alerts that started showing up within the last 3 hours of the
365
+ report.</p>
366
+
367
+ <p><code>suppressed</code> | Not Required | Return only suppressed alerts</p>
368
+
369
+ <p><code>team_id</code> | Not Required | Return only alerts for the given
370
+ team.</p>
371
+
372
+ <p><code>external_account_id</code> | Not Required | Return only alerts for
373
+ the given external id.</p>
374
+
375
+ <p><code>service_id</code> | Not Required | Return only alerts on signatures
376
+ with the given service.</p>
377
+
378
+ <p><code>signature_severity</code> | Not Required | Return only alerts for
379
+ signatures with the given risk_level. Valid values are Low, Medium, High</p>
380
+
381
+ <p><code>signature_name</code> | Not Required | Return only alerts for
382
+ signatures with the given name.</p>
383
+
384
+ <p><code>resource</code> | Not Required | Return only alerts for the given
385
+ resource or tag.</p>
386
+
387
+ <p><code>signature_identifier</code> | Not Required | Return only alerts for
388
+ signatures with the given identifier.</p>
389
+
390
+ <h4 id="method-i-alerts-label-Example">Example<span><a href="#method-i-alerts-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
391
+
392
+ <pre>report = ESP::Report.find(345)
393
+ alerts = report.alerts(status: &#39;fail&#39;, signature_severity: &#39;High&#39;)</pre>
394
+
395
+
396
+
397
+
398
+ <div class="method-source-code" id="alerts-source">
399
+ <pre><span class="ruby-comment"># File lib/esp/resources/report.rb, line 77</span>
400
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">alerts</span>(<span class="ruby-identifier">arguments</span> = {})
401
+ <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">Alert</span>.<span class="ruby-identifier">for_report</span>(<span class="ruby-identifier">id</span>, <span class="ruby-identifier">arguments</span>)
402
+ <span class="ruby-keyword">end</span></pre>
403
+ </div><!-- alerts-source -->
404
+
405
+ </div>
406
+
407
+
408
+
409
+
410
+ </div><!-- alerts-method -->
411
+
412
+
413
+ <div id="method-i-destroy" class="method-detail ">
414
+
415
+ <div class="method-heading">
416
+ <span class="method-name">destroy</span><span
417
+ class="method-args">()</span>
418
+
419
+ <span class="method-click-advice">click to toggle source</span>
420
+
421
+ </div>
422
+
423
+
424
+ <div class="method-description">
425
+
426
+ <p>Not Implemented. You cannot destroy a <a href="Report.html">Report</a>.</p>
427
+
428
+
429
+
430
+
431
+ <div class="method-source-code" id="destroy-source">
432
+ <pre><span class="ruby-comment"># File lib/esp/resources/report.rb, line 21</span>
433
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span>
434
+ <span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
435
+ <span class="ruby-keyword">end</span></pre>
436
+ </div><!-- destroy-source -->
437
+
438
+ </div>
439
+
440
+
441
+
442
+
443
+ </div><!-- destroy-method -->
444
+
445
+
446
+ <div id="method-i-organization" class="method-detail ">
447
+
448
+ <div class="method-heading">
449
+ <span class="method-name">organization</span><span
450
+ class="method-args">()</span>
451
+
452
+ <span class="method-click-advice">click to toggle source</span>
453
+
454
+ </div>
455
+
456
+
457
+ <div class="method-description">
458
+
459
+ <p>The organization the report belongs to.</p>
460
+
461
+
462
+
463
+
464
+ <div class="method-source-code" id="organization-source">
465
+ <pre><span class="ruby-comment"># File lib/esp/resources/report.rb, line 5</span>
466
+ <span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:organization</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::Organization&#39;</span>
467
+ </pre>
468
+ </div><!-- organization-source -->
469
+
470
+ </div>
471
+
472
+
473
+
474
+
475
+ </div><!-- organization-method -->
476
+
477
+
478
+ <div id="method-i-stat" class="method-detail ">
479
+
480
+ <div class="method-heading">
481
+ <span class="method-name">stat</span><span
482
+ class="method-args">()</span>
483
+
484
+ <span class="method-click-advice">click to toggle source</span>
485
+
486
+ </div>
487
+
488
+
489
+ <div class="method-description">
490
+
491
+ <p>Returns the stats for this report</p>
492
+
493
+
494
+
495
+
496
+ <div class="method-source-code" id="stat-source">
497
+ <pre><span class="ruby-comment"># File lib/esp/resources/report.rb, line 82</span>
498
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">stat</span>
499
+ <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">Stat</span>.<span class="ruby-identifier">for_report</span>(<span class="ruby-identifier">id</span>)
500
+ <span class="ruby-keyword">end</span></pre>
501
+ </div><!-- stat-source -->
502
+
503
+ </div>
504
+
505
+
506
+
507
+
508
+ </div><!-- stat-method -->
509
+
510
+
511
+ <div id="method-i-sub_organization" class="method-detail ">
512
+
513
+ <div class="method-heading">
514
+ <span class="method-name">sub_organization</span><span
515
+ class="method-args">()</span>
516
+
517
+ <span class="method-click-advice">click to toggle source</span>
518
+
519
+ </div>
520
+
521
+
522
+ <div class="method-description">
523
+
524
+ <p>The <a href="Report.html#method-i-sub_organization">#sub_organization</a>
525
+ the report belongs to.</p>
526
+
527
+
528
+
529
+
530
+ <div class="method-source-code" id="sub_organization-source">
531
+ <pre><span class="ruby-comment"># File lib/esp/resources/report.rb, line 9</span>
532
+ <span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:sub_organization</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::SubOrganization&#39;</span>
533
+ </pre>
534
+ </div><!-- sub_organization-source -->
535
+
536
+ </div>
537
+
538
+
539
+
540
+
541
+ </div><!-- sub_organization-method -->
542
+
543
+
544
+ <div id="method-i-team" class="method-detail ">
545
+
546
+ <div class="method-heading">
547
+ <span class="method-name">team</span><span
548
+ class="method-args">()</span>
549
+
550
+ <span class="method-click-advice">click to toggle source</span>
551
+
552
+ </div>
553
+
554
+
555
+ <div class="method-description">
556
+
557
+ <p>The team the report belongs to.</p>
558
+
559
+
560
+
561
+
562
+ <div class="method-source-code" id="team-source">
563
+ <pre><span class="ruby-comment"># File lib/esp/resources/report.rb, line 13</span>
564
+ <span class="ruby-identifier">belongs_to</span> <span class="ruby-value">:team</span>, <span class="ruby-identifier">class_name</span><span class="ruby-operator">:</span> <span class="ruby-string">&#39;ESP::Team&#39;</span>
565
+ </pre>
566
+ </div><!-- team-source -->
567
+
568
+ </div>
569
+
570
+
571
+
572
+
573
+ </div><!-- team-method -->
574
+
575
+
576
+ <div id="method-i-update" class="method-detail ">
577
+
578
+ <div class="method-heading">
579
+ <span class="method-name">update</span><span
580
+ class="method-args">()</span>
581
+
582
+ <span class="method-click-advice">click to toggle source</span>
583
+
584
+ </div>
585
+
586
+
587
+ <div class="method-description">
588
+
589
+ <p>Not Implemented. You cannot create or update a <a
590
+ href="Report.html">Report</a>.</p>
591
+
592
+
593
+
594
+
595
+ <div class="method-source-code" id="update-source">
596
+ <pre><span class="ruby-comment"># File lib/esp/resources/report.rb, line 16</span>
597
+ <span class="ruby-keyword">def</span> <span class="ruby-identifier">update</span>
598
+ <span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
599
+ <span class="ruby-keyword">end</span></pre>
600
+ </div><!-- update-source -->
601
+
602
+ </div>
603
+
604
+
605
+
606
+
607
+ </div><!-- update-method -->
608
+
609
+
610
+ </section><!-- public-instance-method-details -->
611
+
612
+ </section><!-- 5Buntitled-5D -->
613
+
614
+ </div><!-- documentation -->
615
+
616
+
617
+ <footer id="validator-badges">
618
+ <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
619
+ <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
620
+ <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
621
+ </footer>
622
+