esp_sdk 2.0.0.rc1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 375b1160781a13a88cefd9a083eff938b826902d
-  data.tar.gz: 16a16aefa8bec1cde0b74c74de232700ed77bbd1
+  metadata.gz: 346fea31e490e4806a446f57683828c302ef3289
+  data.tar.gz: 8c429d99558d3b111eb4eabb7d7a35419391ab23
 SHA512:
-  metadata.gz: 6f7342eb640fb5eb04e02e0bab60b7e7ed7b8073cccab9c9d5759faac55762c711191f4ce63581e64131be3b7ed8b47335da5e1f5091704993ce6de70e7b3908
-  data.tar.gz: 9da7a80cff4b9ee24e24a804f4a68191887bc73ec4f6a10f19763936209179fa802762608f27ce90ba9362b1688acba52f4aab010d29cb227f9e8a418604172c
+  metadata.gz: 6ad3f1c191a879a5c17b3042941b7a590918f48a34e597beaf1c06d293d653cb49ac958f4e539ee717d24cac092861fbfce903e870e8ec0be09557542e3e0d82
+  data.tar.gz: d68c27b4c8fd22fe0dd65a2c4d702b4f8d2a19376e5e826514f1f6d9c8a40f2f316dbf6d6549cccbc164418a463c73e35a2a9e05433bb11f11888526a1a5e246

data/CHANGELOG.md

@@ -0,0 +1,16 @@
+## [Unreleased]
+### Added
+- Implemented searching using `where` on many object.
+
+## [2.0.0] - 2015-12-16
+### Added
+- Separate Metadata object
+- Metadata relationship to the Alert object.
+- Set the User-Agent header to "Ruby SDK #{ESP::VERSION}"
+
+### Removed
+- Unnecessary dependencies.
+
+## [2.0.0.rc1] - 2015-11-05
+### Added
+- Complete rewrite. See the README for the new DSL.

data/Gemfile.lock

@@ -1,12 +1,9 @@
 PATH
   remote: .
   specs:
-    esp_sdk (2.0.0.rc1)
+    esp_sdk (2.0.0)
       activeresource (~> 4.0.0)
       api-auth
-      artii
-      awesome_print
-      catpix
       rack
 
 GEM
@@ -28,19 +25,12 @@ GEM
     addressable (2.3.8)
     ansi (1.5.0)
     api-auth (1.3.2)
-    artii (2.1.1)
     ast (2.0.0)
     astrolabe (1.3.1)
       parser (~> 2.2)
-    awesome_print (1.6.1)
     bourne (1.6.0)
       mocha (~> 1.1)
     builder (3.2.2)
-    catpix (0.2.0)
-      docopt (~> 0.5, >= 0.5.0)
-      rmagick (~> 2.15, >= 2.15.2)
-      ruby-terminfo (~> 0.1, >= 0.1.1)
-      tco (~> 0.1, >= 0.1.8)
     coderay (1.1.0)
     coveralls (0.8.0)
       multi_json (~> 1.10)
@@ -51,7 +41,6 @@ GEM
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     docile (1.1.5)
-    docopt (0.5.0)
     factory_girl (4.5.0)
       activesupport (>= 3.0.0)
     ffi (1.9.10)
@@ -114,7 +103,6 @@ GEM
     rest-client (1.7.3)
       mime-types (>= 1.16, < 3.0)
       netrc (~> 0.7)
-    rmagick (2.15.4)
     rubocop (0.34.2)
       astrolabe (~> 1.3)
       parser (>= 2.2.2.5, < 3.0)
@@ -122,7 +110,6 @@ GEM
       rainbow (>= 1.99.1, < 3.0)
       ruby-progressbar (~> 1.4)
     ruby-progressbar (1.7.5)
-    ruby-terminfo (0.1.1)
     safe_yaml (1.0.4)
     shellany (0.0.1)
     shoulda (3.5.0)
@@ -137,7 +124,6 @@ GEM
       simplecov-html (~> 0.9.0)
     simplecov-html (0.9.0)
     slop (3.6.0)
-    tco (0.1.8)
     term-ansicolor (1.3.0)
       tins (~> 1.0)
     thor (0.19.1)

data/assets/esp_logo.ans

@@ -0,0 +1,27 @@
+
+
+
+
+
+         ▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄▄
+                                           
+            ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀     
+       ▀                               ▀    
+            ▀    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀        
+            ▀    ▀                ▀   ▀    
+             ▀   ▀                ▀▀▀▀    ▀
+             ▀    ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀    
+         ▀    ▀                     ▀    ▀
+          ▀    ▀     ▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀▀    
+           ▀    ▀▀   ▀▀      ▀▀▀▀▀▀    ▀
+            ▀    ▀▀    ▀▀  ▀▀    ▀     
+             ▀     ▀▀          ▀▀    ▀
+               ▀    ▀▀▀      ▀▀     ▀
+                ▀      ▀▀▀▀▀▀     ▀
+                  ▀             ▀
+                    ▀▀        ▀
+                       ▀▀▀▀▀
+
+
+
+

data/bin/esp_console

@@ -53,13 +53,9 @@ module ESP
 end
 
 begin
-  require 'catpix'
-  logo = File.expand_path(File.dirname(__FILE__) + '/../assets/logo.png')
-  Catpix::print_image logo
+  puts File.read(File.expand_path(File.dirname(__FILE__) + '/../assets/esp_logo.ans'))
 rescue
-  require 'artii'
-  artii = Artii::Base.new(font: 'slant')
-  print artii.asciify('E.S.P')
+  #swallow the error
 end
 print <<-banner
 

data/esp_sdk.gemspec

@@ -38,7 +38,4 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activeresource', '~> 4.0.0'
   spec.add_dependency 'api-auth'
   spec.add_dependency 'rack'
-  spec.add_dependency 'awesome_print'
-  spec.add_dependency 'artii'
-  spec.add_dependency 'catpix'
 end

data/lib/esp/extensions/active_resource/formats/json_api_format.rb

@@ -72,7 +72,7 @@ module ActiveResource
 
       def self.parse_relationships!(object, included)
         object.fetch('relationships', {}).each do |assoc, details|
-          extract_foreign_keys!(object, assoc, details['data'])
+          extract_foreign_keys!(object, assoc, details)
           merge_included_objects!(object, assoc, details['data'], included)
         end
       end
@@ -82,8 +82,17 @@ module ActiveResource
         object.merge! object.delete('attributes') unless object['attributes'].blank?
       end
 
-      def self.extract_foreign_keys!(object, assoc, data)
-        return if data.blank?
+      def self.extract_foreign_keys!(object, assoc, assoc_details)
+        data = assoc_details['data']
+        related_link = assoc_details.fetch('links', {}).fetch('related', {})
+        if data.present?
+          parse_data(object, assoc, data)
+        elsif related_link.present?
+          parse_related_link(object, assoc, related_link)
+        end
+      end
+
+      def self.parse_data(object, assoc, data)
         if data.is_a? Array
           object["#{assoc.singularize}_ids"] = data.map { |d| d['id'] }
         else
@@ -91,6 +100,16 @@ module ActiveResource
         end
       end
 
+      def self.parse_related_link(object, assoc, related_link)
+        # parse the url to get the id if the data node is not returned
+        related_link.scan(%r{/(\d+)\.json$}) do |id|
+          object["#{assoc}_id"] = id.first
+        end
+        return if object["#{assoc}_id"].present?
+        uri = URI.parse(related_link)
+        object["#{assoc.singularize}_ids"] = Rack::Utils.parse_nested_query(CGI.unescape(uri.query)).fetch('filter', {}).fetch('id_in', []) if uri.query.present?
+      end
+
       def self.merge_included_objects!(object, assoc, data, included)
         return if included.blank?
         object[assoc] = case data

data/lib/esp/resources/alert.rb

@@ -28,6 +28,12 @@ module ESP
     # Returns the tags associated with this alert.
     has_many :tags, class_name: 'ESP::Tag'
 
+    ##
+    # Returns the metadata associated with this alert.
+    def metadata
+      ESP::Metadata.for_alert(id)
+    end
+
     # Not Implemented. You cannot create or update an Alert.
     def save
       fail ESP::NotImplementedError

data/lib/esp/resources/metadata.rb

@@ -0,0 +1,50 @@
+module ESP
+  class Metadata < ESP::Resource
+    # Not Implemented. You cannot search for Metadata.
+    def self.where(*)
+      fail ESP::NotImplementedError
+    end
+
+    # Not Implemented. You cannot create or update Metadata.
+    def save
+      fail ESP::NotImplementedError
+    end
+
+    # Not Implemented. You cannot destroy Metadata.
+    def destroy
+      fail ESP::NotImplementedError
+    end
+
+    # Returns a metadata object for the given alert_id
+    # Convenience method to use instead of ::find since an alert_id is required to return metadata.
+    #
+    # ==== Parameter
+    #
+    # +alert_id+ | Required | The ID of the alert to retrieve metadata for
+    #
+    # ==== Example
+    #   alerts = ESP::Metadata.for_alert(1194)
+    def self.for_alert(alert_id = nil)
+      fail ArgumentError, "You must supply an alert id." unless alert_id.present?
+      from = "#{prefix}alerts/#{alert_id}/metadata.json"
+      find(:one, from: from)
+    end
+
+    # Find a Metadata object by id
+    #
+    # ==== Parameter
+    #
+    # +id+ | Required | The ID of the metadata object to retrieve
+    #
+    # :call-seq:
+    #  find(id)
+    def self.find(*arguments)
+      scope = arguments.slice!(0)
+      options = (arguments.slice!(0) || {}).with_indifferent_access
+      return super(scope, options) if scope.is_a?(Numeric) || options[:from].present?
+      params = options.fetch(:params, {}).with_indifferent_access
+      alert_id = params.delete(:alert_id)
+      for_alert(alert_id)
+    end
+  end
+end

data/lib/esp/resources/resource.rb

@@ -4,6 +4,7 @@ module ESP
     self.format = ActiveResource::Formats::JsonAPIFormat
     with_api_auth(ESP.access_key_id, ESP.secret_access_key)
     headers["Content-Type"] = format.mime_type
+    headers["User-Agent"] = "Ruby SDK #{ESP::VERSION}"
 
     self.collection_parser = ActiveResource::PaginatedCollection
 

data/lib/esp/resources/signature.rb

@@ -26,11 +26,11 @@ module ESP
     #
     # +external_account_id+ | Required | The ID of the external account to run this custom signature against
     #
-    # +regions+ | Required | Array of region names to run this custom signature against
+    # +region+ | Required | Region name to run this custom signature against
     #
     # ==== Example
     #   signature = ESP::Signature.find(3)
-    #   alerts = signature.run!(external_account_id: 3, regions: ['us_east_1'])
+    #   alerts = signature.run!(external_account_id: 3, region: 'us_east_1')
     def run!(arguments = {})
       result = run(arguments)
       return result if result.is_a?(ActiveResource::Collection)
@@ -50,15 +50,15 @@ module ESP
     #
     # +external_account_id+ | Required | The ID of the external account to run this custom signature against
     #
-    # +regions+ | Required | Array of region names to run this custom signature against
+    # +region+ | Required | Region name to run this custom signature against
     #
     # ==== Example
     #   signature = ESP::Signature.find(3)
-    #   alerts = signature.run(external_account_id: 3, regions: ['us_east_1'])
+    #   alerts = signature.run(external_account_id: 3, region: 'us_east_1')
     def run(arguments = {})
       arguments = arguments.with_indifferent_access
       attributes['external_account_id'] ||= arguments[:external_account_id]
-      attributes['regions'] ||= Array(arguments[:regions])
+      attributes['region'] ||= arguments[:region]
 
       response = connection.post("#{self.class.prefix}signatures/#{id}/run.json", to_json)
       ESP::Alert.send(:instantiate_collection, self.class.format.decode(response.body))

data/lib/esp/version.rb

@@ -1,3 +1,3 @@
 module ESP
-  VERSION = '2.0.0.rc1'
+  VERSION = '2.0.0'
 end

data/lib/esp.rb

@@ -79,6 +79,7 @@ module ESP
   autoload :RawAlert, File.expand_path(File.dirname(__FILE__) + '/esp/resources/raw_alert')
   autoload :Dashboard, File.expand_path(File.dirname(__FILE__) + '/esp/resources/dashboard')
   autoload :CloudTrailEvent, File.expand_path(File.dirname(__FILE__) + '/esp/resources/cloud_trail_event')
+  autoload :Metadata, File.expand_path(File.dirname(__FILE__) + '/esp/resources/metadata')
   autoload :Tag, File.expand_path(File.dirname(__FILE__) + '/esp/resources/tag')
   autoload :Region, File.expand_path(File.dirname(__FILE__) + '/esp/resources/region')
   autoload :Suppression, File.expand_path(File.dirname(__FILE__) + '/esp/resources/suppression')

data/lib/esp_sdk.rb

@@ -1,7 +1,6 @@
 require 'active_support/all'
 require 'active_resource'
 require 'api_auth'
-require 'awesome_print'
 require_relative 'esp/extensions/active_resource/paginated_collection'
 require_relative 'esp/extensions/active_resource/validations'
 require_relative 'esp/extensions/active_resource/formats/json_api_format'

data/rdoc/ActiveResource/Formats.html

@@ -100,6 +100,8 @@
   
     <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>

data/rdoc/ActiveResource/PaginatedCollection.html

@@ -148,6 +148,8 @@
   
     <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>

data/rdoc/ActiveResource.html

@@ -104,6 +104,8 @@
   
     <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>

data/rdoc/ESP/Alert.html

@@ -85,6 +85,8 @@
     
     <li ><a href="#method-i-external_account">#external_account</a>
     
+    <li ><a href="#method-i-metadata">#metadata</a>
+    
     <li ><a href="#method-i-region">#region</a>
     
     <li ><a href="#method-i-save">#save</a>
@@ -142,6 +144,8 @@
   
     <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>
@@ -240,7 +244,7 @@
 
           
           <div class="method-source-code" id="find-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 90</span>
+            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 96</span>
 <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>)
   <span class="ruby-identifier">scope</span> = <span class="ruby-identifier">arguments</span>.<span class="ruby-identifier">slice!</span>(<span class="ruby-value">0</span>)
   <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>
@@ -328,7 +332,7 @@ signatures with the given identifier.</p>
 
           
           <div class="method-source-code" id="for_report-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 76</span>
+            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 82</span>
 <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> = {})
   <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>
   <span class="ruby-identifier">from</span> = <span class="ruby-node">&quot;#{prefix}reports/#{report_id}/alerts.json&quot;</span>
@@ -435,7 +439,7 @@ signature or custom signature but not both will be present.</p>
 
           
           <div class="method-source-code" id="destroy-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 37</span>
+            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 43</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">destroy</span>
   <span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
 <span class="ruby-keyword">end</span></pre>
@@ -481,6 +485,39 @@ signature or custom signature but not both will be present.</p>
       </div><!-- external_account-method -->
 
     
+      <div id="method-i-metadata" class="method-detail ">
+        
+        <div class="method-heading">
+          <span class="method-name">metadata</span><span
+            class="method-args">()</span>
+          
+          <span class="method-click-advice">click to toggle source</span>
+          
+        </div>
+        
+
+        <div class="method-description">
+          
+          <p>Returns the metadata associated with this alert.</p>
+          
+          
+
+          
+          <div class="method-source-code" id="metadata-source">
+            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 33</span>
+<span class="ruby-keyword">def</span> <span class="ruby-identifier">metadata</span>
+  <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">Metadata</span>.<span class="ruby-identifier">for_alert</span>(<span class="ruby-identifier">id</span>)
+<span class="ruby-keyword">end</span></pre>
+          </div><!-- metadata-source -->
+          
+        </div>
+
+        
+
+        
+      </div><!-- metadata-method -->
+
+    
       <div id="method-i-region" class="method-detail ">
         
         <div class="method-heading">
@@ -533,7 +570,7 @@ href="Alert.html">Alert</a>.</p>
 
           
           <div class="method-source-code" id="save-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 32</span>
+            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 38</span>
 <span class="ruby-keyword">def</span> <span class="ruby-identifier">save</span>
   <span class="ruby-identifier">fail</span> <span class="ruby-constant">ESP</span><span class="ruby-operator">::</span><span class="ruby-constant">NotImplementedError</span>
 <span class="ruby-keyword">end</span></pre>
@@ -603,7 +640,7 @@ custom signature but not both will be present.</p>
 
           
           <div class="method-source-code" id="suppress_region-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 111</span>
+            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 117</span>
 <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>)
   <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>)
 <span class="ruby-keyword">end</span></pre>
@@ -640,7 +677,7 @@ custom signature but not both will be present.</p>
 
           
           <div class="method-source-code" id="suppress_signature-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 103</span>
+            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 109</span>
 <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>)
   <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>)
 <span class="ruby-keyword">end</span></pre>
@@ -677,7 +714,7 @@ custom signature but not both will be present.</p>
 
           
           <div class="method-source-code" id="suppress_unique_identifier-source">
-            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 119</span>
+            <pre><span class="ruby-comment"># File lib/esp/resources/alert.rb, line 125</span>
 <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>)
   <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>)
 <span class="ruby-keyword">end</span></pre>

data/rdoc/ESP/CloudTrailEvent.html

@@ -122,6 +122,8 @@
   
     <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>

data/rdoc/ESP/ContactRequest.html

@@ -122,6 +122,8 @@
   
     <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>

data/rdoc/ESP/CustomSignature.html

@@ -134,6 +134,8 @@
   
     <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>

data/rdoc/ESP/Dashboard.html

@@ -122,6 +122,8 @@
   
     <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>

data/rdoc/ESP/ExternalAccount.html

@@ -132,6 +132,8 @@
   
     <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>