RubyGems - esp_sdk - Versions diffs - 2.0.0 → 2.1.0 - Mend

esp_sdk 2.0.0 → 2.1.0

Files changed (148) hide show

checksums.yaml +4 -4
data/.travis.yml +1 -0
data/CHANGELOG.md +6 -1
data/Gemfile.lock +11 -1
data/README.md +287 -28
data/bin/esp +15 -0
data/esp_sdk.gemspec +2 -0
data/lib/esp/aws_clients.rb +60 -0
data/lib/esp/commands/add_external_account.rb +57 -0
data/lib/esp/commands/commands_tasks.rb +106 -0
data/lib/esp/commands/console.rb +68 -0
data/lib/esp/extensions/active_resource/formats/json_api_format.rb +12 -4
data/lib/esp/extensions/active_resource/paginated_collection.rb +5 -5
data/lib/esp/extensions/active_resource/validations.rb +1 -1
data/lib/esp/external_account_creator.rb +77 -0
data/lib/esp/resources/alert.rb +30 -34
data/lib/esp/resources/cloud_trail_event.rb +5 -0
data/lib/esp/resources/contact_request.rb +6 -5
data/lib/esp/resources/custom_signature.rb +32 -56
data/lib/esp/resources/dashboard.rb +8 -1
data/lib/esp/resources/external_account.rb +27 -19
data/lib/esp/resources/organization.rb +27 -3
data/lib/esp/resources/region.rb +15 -3
data/lib/esp/resources/report.rb +28 -24
data/lib/esp/resources/resource.rb +26 -10
data/lib/esp/resources/service.rb +5 -0
data/lib/esp/resources/signature.rb +28 -12
data/lib/esp/resources/stat.rb +21 -2
data/lib/esp/resources/stat_custom_signature.rb +30 -4
data/lib/esp/resources/stat_region.rb +29 -3
data/lib/esp/resources/stat_service.rb +29 -3
data/lib/esp/resources/stat_signature.rb +29 -3
data/lib/esp/resources/sub_organization.rb +27 -3
data/lib/esp/resources/suppression/region.rb +14 -32
data/lib/esp/resources/suppression/signature.rb +14 -40
data/lib/esp/resources/suppression/unique_identifier.rb +8 -6
data/lib/esp/resources/suppression.rb +43 -5
data/lib/esp/resources/tag.rb +5 -0
data/lib/esp/resources/team.rb +33 -9
data/lib/esp/resources/user.rb +29 -3
data/lib/esp/version.rb +1 -1
data/lib/esp.rb +25 -5
data/test/esp/aws_clients_test.rb +101 -0
data/test/esp/extensions/active_resource/formats/json_api_format_test.rb +26 -12
data/test/esp/extensions/active_resource/paginated_collection_test.rb +93 -72
data/test/esp/extensions/active_resource/validations_test.rb +2 -12
data/test/esp/external_account_creator_test.rb +153 -0
data/test/esp/resources/alert_test.rb +71 -33
data/test/esp/resources/cloud_trail_event_test.rb +9 -1
data/test/esp/resources/contact_request_test.rb +8 -0
data/test/esp/resources/custom_signature_test.rb +8 -0
data/test/esp/resources/dashboard_test.rb +8 -0
data/test/esp/resources/external_account_test.rb +8 -0
data/test/esp/resources/metadata_test.rb +1 -1
data/test/esp/resources/organization_test.rb +8 -0
data/test/esp/resources/region_test.rb +12 -4
data/test/esp/resources/report_test.rb +13 -4
data/test/esp/resources/resource_test.rb +208 -64
data/test/esp/resources/service_test.rb +8 -0
data/test/esp/resources/signature_test.rb +15 -9
data/test/esp/resources/stat_custom_signature_test.rb +9 -1
data/test/esp/resources/stat_region_test.rb +23 -1
data/test/esp/resources/stat_service_test.rb +23 -1
data/test/esp/resources/stat_signature_test.rb +23 -1
data/test/esp/resources/stat_test.rb +52 -8
data/test/esp/resources/sub_organization_test.rb +8 -0
data/test/esp/resources/suppression/region_test.rb +10 -2
data/test/esp/resources/suppression/signature_test.rb +10 -2
data/test/esp/resources/suppression/unique_identifier_test.rb +10 -2
data/test/esp/resources/suppression_test.rb +74 -14
data/test/esp/resources/tag_test.rb +9 -1
data/test/esp/resources/team_test.rb +8 -0
data/test/esp/resources/user_test.rb +49 -19
data/test/esp_test.rb +19 -1
data/test/factories/alerts.rb +70 -0
data/test/factories/organizations.rb +2 -2
data/test/factories/regions.rb +1 -1
data/test/factories/sub_organizations.rb +1 -1
data/test/factories/suppressions.rb +109 -3
data/test/factories/users.rb +65 -2
data/test/test_helper.rb +9 -8
metadata +41 -69
data/bin/esp_console +0 -67
data/rdoc/ActiveResource/Formats.html +0 -178
data/rdoc/ActiveResource/PaginatedCollection.html +0 -912
data/rdoc/ActiveResource.html +0 -182
data/rdoc/ESP/Alert.html +0 -808
data/rdoc/ESP/CloudTrailEvent.html +0 -377
data/rdoc/ESP/ContactRequest.html +0 -368
data/rdoc/ESP/CustomSignature.html +0 -748
data/rdoc/ESP/Dashboard.html +0 -357
data/rdoc/ESP/ExternalAccount.html +0 -567
data/rdoc/ESP/Metadata.html +0 -411
data/rdoc/ESP/Organization.html +0 -592
data/rdoc/ESP/Region.html +0 -401
data/rdoc/ESP/Report.html +0 -624
data/rdoc/ESP/Service.html +0 -382
data/rdoc/ESP/Signature.html +0 -557
data/rdoc/ESP/Stat.html +0 -1780
data/rdoc/ESP/StatCustomSignature.html +0 -1601
data/rdoc/ESP/StatRegion.html +0 -1600
data/rdoc/ESP/StatService.html +0 -1600
data/rdoc/ESP/StatSignature.html +0 -1600
data/rdoc/ESP/SubOrganization.html +0 -542
data/rdoc/ESP/Suppression/Region.html +0 -456
data/rdoc/ESP/Suppression/Signature.html +0 -472
data/rdoc/ESP/Suppression/UniqueIdentifier.html +0 -419
data/rdoc/ESP/Suppression.html +0 -651
data/rdoc/ESP/Tag.html +0 -373
data/rdoc/ESP/Team.html +0 -586
data/rdoc/ESP/User.html +0 -485
data/rdoc/ESP.html +0 -549
data/rdoc/README_md.html +0 -503
data/rdoc/created.rid +0 -31
data/rdoc/images/add.png +0 -0
data/rdoc/images/arrow_up.png +0 -0
data/rdoc/images/brick.png +0 -0
data/rdoc/images/brick_link.png +0 -0
data/rdoc/images/bug.png +0 -0
data/rdoc/images/bullet_black.png +0 -0
data/rdoc/images/bullet_toggle_minus.png +0 -0
data/rdoc/images/bullet_toggle_plus.png +0 -0
data/rdoc/images/date.png +0 -0
data/rdoc/images/delete.png +0 -0
data/rdoc/images/find.png +0 -0
data/rdoc/images/loadingAnimation.gif +0 -0
data/rdoc/images/macFFBgHack.png +0 -0
data/rdoc/images/package.png +0 -0
data/rdoc/images/page_green.png +0 -0
data/rdoc/images/page_white_text.png +0 -0
data/rdoc/images/page_white_width.png +0 -0
data/rdoc/images/plugin.png +0 -0
data/rdoc/images/ruby.png +0 -0
data/rdoc/images/tag_blue.png +0 -0
data/rdoc/images/tag_green.png +0 -0
data/rdoc/images/transparent.png +0 -0
data/rdoc/images/wrench.png +0 -0
data/rdoc/images/wrench_orange.png +0 -0
data/rdoc/images/zoom.png +0 -0
data/rdoc/index.html +0 -136
data/rdoc/js/darkfish.js +0 -155
data/rdoc/js/jquery.js +0 -4
data/rdoc/js/navigation.js +0 -142
data/rdoc/js/search.js +0 -94
data/rdoc/js/search_index.js +0 -1
data/rdoc/js/searcher.js +0 -228
data/rdoc/rdoc.css +0 -595
data/rdoc/table_of_contents.html +0 -942

data/rdoc/ESP/ExternalAccount.html DELETED Viewed

@@ -1,567 +0,0 @@
-<!DOCTYPE html>
-<html>
-<head>
-<meta content="text/html; charset=UTF-8" http-equiv="Content-Type">
-<title>class ESP::ExternalAccount - ESPSDK</title>
-<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
-<script type="text/javascript">
-  var rdoc_rel_prefix = "../";
-</script>
-<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
-<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
-<body id="top" class="class">
-<nav id="metadata">
-  <nav id="home-section" class="section">
-  <h3 class="section-header">
-    <a href="../index.html">Home</a>
-    <a href="../table_of_contents.html#classes">Classes</a>
-    <a href="../table_of_contents.html#methods">Methods</a>
-  </h3>
-</nav>
-  <nav id="search-section" class="section project-section" class="initially-hidden">
-  <form action="#" method="get" accept-charset="utf-8">
-    <h3 class="section-header">
-      <input type="text" name="search" placeholder="Search" id="search-field"
-             title="Type to search, Up and Down to navigate, Enter to load">
-    </h3>
-  </form>
-  <ul id="search-results" class="initially-hidden"></ul>
-</nav>
-  <div id="file-metadata">
-    <nav id="file-list-section" class="section">
-  <h3 class="section-header">Defined In</h3>
-  <ul>
-    <li>lib/esp/resources/external_account.rb
-  </ul>
-</nav>
-  </div>
-  <div id="class-metadata">
-    <nav id="parent-class-section" class="section">
-  <h3 class="section-header">Parent</h3>
-  <p class="link">ESP::Resource
-</nav>
-    <!-- Method Quickref -->
-<nav id="method-list-section" class="section">
-  <h3 class="section-header">Methods</h3>
-  <ul class="link-list">
-    <li ><a href="#method-c-all">::all</a>
-    <li ><a href="#method-c-create">::create</a>
-    <li ><a href="#method-c-find">::find</a>
-    <li ><a href="#method-i-destroy">#destroy</a>
-    <li ><a href="#method-i-generate_external_id">#generate_external_id</a>
-    <li ><a href="#method-i-organization">#organization</a>
-    <li ><a href="#method-i-save">#save</a>
-    <li ><a href="#method-i-sub_organization">#sub_organization</a>
-    <li ><a href="#method-i-team">#team</a>
-  </ul>
-</nav>
-  </div>
-  <div id="project-metadata">
-    <nav id="fileindex-section" class="section project-section">
-  <h3 class="section-header">Pages</h3>
-  <ul>
-    <li class="file"><a href="../README_md.html">README</a>
-  </ul>
-</nav>
-    <nav id="classindex-section" class="section project-section">
-  <h3 class="section-header">Class and Module Index</h3>
-  <ul class="link-list">
-    <li><a href="../ActiveResource.html">ActiveResource</a>
-    <li><a href="../ActiveResource/Formats.html">ActiveResource::Formats</a>
-    <li><a href="../ActiveResource/PaginatedCollection.html">ActiveResource::PaginatedCollection</a>
-    <li><a href="../ESP.html">ESP</a>
-    <li><a href="../ESP/Alert.html">ESP::Alert</a>
-    <li><a href="../ESP/CloudTrailEvent.html">ESP::CloudTrailEvent</a>
-    <li><a href="../ESP/ContactRequest.html">ESP::ContactRequest</a>
-    <li><a href="../ESP/CustomSignature.html">ESP::CustomSignature</a>
-    <li><a href="../ESP/Dashboard.html">ESP::Dashboard</a>
-    <li><a href="../ESP/ExternalAccount.html">ESP::ExternalAccount</a>
-    <li><a href="../ESP/Metadata.html">ESP::Metadata</a>
-    <li><a href="../ESP/Organization.html">ESP::Organization</a>
-    <li><a href="../ESP/Region.html">ESP::Region</a>
-    <li><a href="../ESP/Report.html">ESP::Report</a>
-    <li><a href="../ESP/Service.html">ESP::Service</a>
-    <li><a href="../ESP/Signature.html">ESP::Signature</a>
-    <li><a href="../ESP/Stat.html">ESP::Stat</a>
-    <li><a href="../ESP/StatCustomSignature.html">ESP::StatCustomSignature</a>
-    <li><a href="../ESP/StatRegion.html">ESP::StatRegion</a>
-    <li><a href="../ESP/StatService.html">ESP::StatService</a>
-    <li><a href="../ESP/StatSignature.html">ESP::StatSignature</a>
-    <li><a href="../ESP/SubOrganization.html">ESP::SubOrganization</a>
-    <li><a href="../ESP/Suppression.html">ESP::Suppression</a>
-    <li><a href="../ESP/Suppression/Region.html">ESP::Suppression::Region</a>
-    <li><a href="../ESP/Suppression/Signature.html">ESP::Suppression::Signature</a>
-    <li><a href="../ESP/Suppression/UniqueIdentifier.html">ESP::Suppression::UniqueIdentifier</a>
-    <li><a href="../ESP/Tag.html">ESP::Tag</a>
-    <li><a href="../ESP/Team.html">ESP::Team</a>
-    <li><a href="../ESP/User.html">ESP::User</a>
-  </ul>
-</nav>
-  </div>
-</nav>
-<div id="documentation">
-  <h1 class="class">class ESP::ExternalAccount</h1>
-  <div id="description" class="description">
-  </div><!-- description -->
-  <section id="5Buntitled-5D" class="documentation-section">
-    <!-- Methods -->
-     <section id="public-class-5Buntitled-5D-method-details" class="method-section section">
-      <h3 class="section-header">Public Class Methods</h3>
-      <div id="method-c-all" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">all</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Return a paginated <a href="CustomSignature.html">CustomSignature</a> list</p>
-          <div class="method-source-code" id="all-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/external_account.rb, line 41</span>
-    </pre>
-          </div><!-- all-source -->
-        </div>
-      </div><!-- all-method -->
-      <div id="method-c-create" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-callseq">
-            create(attributes={})
-          </span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Create an <a href="ExternalAccount.html">ExternalAccount</a>.</p>
-<h4 id="method-c-create-label-Parameter">Parameter<span><a href="#method-c-create-label-Parameter">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
-<p><code>attributes</code> | Required | A hash of external account attributes</p>
-<h5 id="method-c-create-label-Valid+Attributes">Valid Attributes<span><a href="#method-c-create-label-Valid+Attributes">&para;</a> <a href="#documentation">&uarr;</a></span></h5>
-<p><code>arn</code> | Required | Amazon Resource Name for the IAM role</p>
-<p><code>external_id</code> | Required | External identifier set on the role.
-This will be set by calling <a
-href="ExternalAccount.html#method-i-generate_external_id">generate_external_id</a>
-if not already set.</p>
-<p><code>name</code> | Not Required |  The name for this external account</p>
-<p><code>sub_organization_id</code> | Required | The ID of the sub
-organization the external account will belong to</p>
-<p><code>team_id</code> | Required | The ID of the team the external account
-will belong to</p>
-<h4 id="method-c-create-label-Example">Example<span><a href="#method-c-create-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
-<pre>external_account = ESP::ExternalAccount.create(arn: &#39;arn:from:aws&#39;, external_id: &#39;c40e6af4-a5a0-422a-9a42-3d7d236c3428&#39;, sub_organization_id: 4, team_id: 8)</pre>
-          <div class="method-source-code" id="create-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/external_account.rb, line 66</span>
-    </pre>
-          </div><!-- create-source -->
-        </div>
-      </div><!-- create-method -->
-      <div id="method-c-find" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-callseq">
-            find(id)
-          </span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Find an <a href="ExternalAccount.html">ExternalAccount</a> by id</p>
-<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>
-<p><code>id</code> | Required | The ID of the external account to retrieve</p>
-          <div class="method-source-code" id="find-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/external_account.rb, line 38</span>
-    </pre>
-          </div><!-- find-source -->
-        </div>
-      </div><!-- find-method -->
-    </section><!-- public-class-method-details -->
-     <section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
-      <h3 class="section-header">Public Instance Methods</h3>
-      <div id="method-i-destroy" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">destroy</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Delete a <a href="CustomSignature.html">CustomSignature</a></p>
-          <div class="method-source-code" id="destroy-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/external_account.rb, line 88</span>
-  </pre>
-          </div><!-- destroy-source -->
-        </div>
-      </div><!-- destroy-method -->
-      <div id="method-i-generate_external_id" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">generate_external_id</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Helper to generate an external id. Called automatically when creating an <a
-href="ExternalAccount.html">ExternalAccount</a> if <code>external_id</code>
-is not already set.</p>
-          <div class="method-source-code" id="generate_external_id-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/external_account.rb, line 17</span>
-<span class="ruby-keyword">def</span> <span class="ruby-identifier">generate_external_id</span>
-  <span class="ruby-constant">SecureRandom</span>.<span class="ruby-identifier">uuid</span>
-<span class="ruby-keyword">end</span></pre>
-          </div><!-- generate_external_id-source -->
-        </div>
-      </div><!-- generate_external_id-method -->
-      <div id="method-i-organization" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">organization</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>The organization the external account belongs to.</p>
-          <div class="method-source-code" id="organization-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/external_account.rb, line 5</span>
-<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>
-</pre>
-          </div><!-- organization-source -->
-        </div>
-      </div><!-- organization-method -->
-      <div id="method-i-save" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">save</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>Create or update an <a href="ExternalAccount.html">ExternalAccount</a>.</p>
-<h5 id="method-i-save-label-Valid+Attributes">Valid Attributes<span><a href="#method-i-save-label-Valid+Attributes">&para;</a> <a href="#documentation">&uarr;</a></span></h5>
-<p><code>arn</code> | Required | Amazon Resource Name for the IAM role</p>
-<p><code>external_id</code> | Required | External identifier set on the role.
-This will be set by calling <a
-href="ExternalAccount.html#method-i-generate_external_id">generate_external_id</a>
-if not already set.</p>
-<p><code>name</code> | Not Required |  The name for this external account</p>
-<p><code>sub_organization_id</code> | Required | The ID of the sub
-organization the external account will belong to</p>
-<p><code>team_id</code> | Required | The ID of the team the external account
-will belong to</p>
-<h4 id="method-i-save-label-Example">Example<span><a href="#method-i-save-label-Example">&para;</a> <a href="#documentation">&uarr;</a></span></h4>
-<pre>external_account = ESP::ExternalAccount.new(arn: &#39;arn:from:aws&#39;, external_id: &#39;c40e6af4-a5a0-422a-9a42-3d7d236c3428&#39;, sub_organization_id: 4, team_id: 8)
-external_account.save</pre>
-          <div class="method-source-code" id="save-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/external_account.rb, line 86</span>
-    </pre>
-          </div><!-- save-source -->
-        </div>
-      </div><!-- save-method -->
-      <div id="method-i-sub_organization" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">sub_organization</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>The <a
-href="ExternalAccount.html#method-i-sub_organization">#sub_organization</a>
-the external account belongs to.</p>
-          <div class="method-source-code" id="sub_organization-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/external_account.rb, line 9</span>
-<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>
-</pre>
-          </div><!-- sub_organization-source -->
-        </div>
-      </div><!-- sub_organization-method -->
-      <div id="method-i-team" class="method-detail ">
-        <div class="method-heading">
-          <span class="method-name">team</span><span
-            class="method-args">()</span>
-          <span class="method-click-advice">click to toggle source</span>
-        </div>
-        <div class="method-description">
-          <p>The team the external account belongs to.</p>
-          <div class="method-source-code" id="team-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/external_account.rb, line 13</span>
-<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>
-</pre>
-          </div><!-- team-source -->
-        </div>
-      </div><!-- team-method -->
-    </section><!-- public-instance-method-details -->
-  </section><!-- 5Buntitled-5D -->
-</div><!-- documentation -->
-<footer id="validator-badges">
-  <p><a href="http://validator.w3.org/check/referer">[Validate]</a>
-  <p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 4.0.0.
-  <p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
-</footer>