esp_sdk 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8ba33c6b2844803fe17abc39fd0f2ecfdd3c86c3
-  data.tar.gz: a9f51f6b6e0abd70064f0de21ea5b365b69b2acf
+  metadata.gz: 5f7250441652b3030ad983a15076317a4f23f514
+  data.tar.gz: 20d7beccfa0aac2dcb56e27c3b636ef4360a4f25
 SHA512:
-  metadata.gz: 15e6201640405e7dd7031147e38ff2342da257eba8ef8fd1d7a6e556f0eaf5c740c6953a2ab67522135e5cdbf57b6deed910551c302b325543d80890a3972b7b
-  data.tar.gz: 76c3758314ca2ff6121c25305fcb8151197293a3093dd115f9b13eca919b838e995b1027fee46678b5c6ea9f196c25f0115efbdf7b5f83110f7108ac2cd24dbd
+  metadata.gz: 89a03a0391777f8cbde9292ab9a44ed087046e19794caf5e8f8353670da41e5433a9ee14ef17d0853e9e389942ec67ef20dbb782f322d9ac3fc9778987d630fc
+  data.tar.gz: ff17a934abe8abac1a91eaff1e936902d24d69bbcffbce5e4195793bd2e652abd66ac29c3616a488438ac32033007e5dcd8e1c766b5d0d8e451482c2d9ed23a3

data/.ruby-version

@@ -1 +1 @@
-2.0.0
+2.0.0-p647

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## Unreleased
+
+## 2.2.3 - 2016-05-16
+### Changed
+- Some error messages changed a little bit on the API.  Specifically, on region suppression, signature suppress, and custom signature suppression objects.  Now when a validation trips on the related suppression object, the error message reflects that.  "Reason can't be blank" changed to "Suppression region can't be blank".  The message is built from the attribute which is in error, which changed from "Reason" to "Suppression.reason".  Had to gsub the "." to a space to make it message friendly.
+- Add the teams relation to custom signature, and the custom signatures relation to team.
+- Added an endpoint, ESP::Report::Export::Integration.create, to export reports to an integration
+
 ## 2.2.0 - 2016-03-2
 ### Added
 - Added the ESP::ScanInterval object to use the new scan interval endpoint on the API

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    esp_sdk (2.2.0)
+    esp_sdk (2.3.0)
       activeresource (~> 4.0.0)
       api-auth
       rack
@@ -165,3 +165,6 @@ DEPENDENCIES
   rubocop
   shoulda
   webmock
+
+BUNDLED WITH
+   1.11.2

data/Rakefile

@@ -6,7 +6,18 @@ require 'rdoc/task'
 
 Rake::TestTask.new do |task|
   task.libs << 'test'
-  task.test_files = FileList['test/*_test.rb', 'test/**/*_test.rb']
+  task.test_files = FileList['test/*_test.rb', 'test/**/*_test.rb'] - FileList["test/esp/integration/**/*_test.rb"]
+end
+
+namespace "test" do
+  Rake::TestTask.new("integration") do |t|
+    t.pattern = "test/esp/integration/**/*_test.rb"
+  end
+
+  Rake::TestTask.new("all") do |task|
+    task.libs << 'test'
+    task.test_files = FileList['test/*_test.rb', 'test/**/*_test.rb']
+  end
 end
 
 task default: [:test]

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

@@ -37,7 +37,7 @@ module ActiveResource # :nodoc: all
       end
 
       def decode(json)
-        # ap ActiveSupport::JSON.decode(json), index: false, indent: -2
+        # pp ActiveSupport::JSON.decode(json), index: false, indent: -2
         Formats.remove_root(parse_json_api(ActiveSupport::JSON.decode(json)))
       end
 

data/lib/esp/extensions/active_resource/validations.rb

@@ -35,8 +35,9 @@ module ActiveResource # :nodoc: all
         raw_errors.each do |error|
           next unless error['meta']
           error['meta'].map do |attr, message|
-            errors[attr] ||= []
-            errors[attr] << message
+            friendly_attr = attr.tr('.', ' ')
+            errors[friendly_attr] ||= []
+            errors[friendly_attr] << message
           end
         end
       end

data/lib/esp/external_account_creator.rb

@@ -30,11 +30,11 @@ module ESP # :nodoc: all
     def create
       fail ESP::AddExternalAccountError, aws.errors.full_messages.join(', ') unless aws.valid?
 
-      puts "adding AWS account #{aws.owner_id} to ESP as #{team_name}" # rubocop:disable Rails/Output
+      puts "adding AWS account #{aws.owner_id} to ESP as #{team_name}" unless ESP.env.test? # rubocop:disable Rails/Output
       aws_role_object = aws.create_and_attach_role!(external_account_id)
       sleep 10
 
-      puts "aws_role_arn = #{aws_role_object.role.arn}, external_id = #{external_account_id}, nickname = #{team_name}, esp_suborg_id = #{sub_organization.id}, esp_team_id = #{team.id}" # rubocop:disable Rails/Output
+      puts "aws_role_arn = #{aws_role_object.role.arn}, external_id = #{external_account_id}, nickname = #{team_name}, esp_suborg_id = #{sub_organization.id}, esp_team_id = #{team.id}" unless ESP.env.test? # rubocop:disable Rails/Output
       external_account = ESP::ExternalAccount.create(arn: aws_role_object.role.arn, external_id: external_account_id, name: team_name, sub_organization_id: sub_organization.id, team_id: team.id)
       fail ESP::AddExternalAccountError, "On External Account: #{external_account.errors.full_messages.join(', ')}" unless external_account.errors.blank?
       external_account

data/lib/esp/resources/custom_signature.rb

@@ -4,6 +4,13 @@ module ESP
     # The organization this custom signature belongs to.
     belongs_to :organization, class_name: 'ESP::Organization'
 
+    ##
+    # The collection of teams that belong to the custom_signature.
+    def teams
+      return attributes['teams'] if attributes['teams'].present?
+      Team.where(custom_signatures_id_eq: id)
+    end
+
     # Run a custom signature that has not been saved.  Useful for debugging a custom signature.
     # Returns a collection of alerts.
     # Throws an error if not successful.

data/lib/esp/resources/report.rb

@@ -53,7 +53,7 @@ module ESP
     # ==== Example
     #
     #   report = ESP::Report.find(345)
-    #   alerts = report.alerts(status: 'fail', signature_severity: 'High')
+    #   alerts = report.alerts(status_eq: 'fail', signature_risk_level_in: ['High'])
     def alerts(arguments = {})
       ESP::Alert.where(arguments.merge(report_id: id))
     end

data/lib/esp/resources/reports/export/integration.rb

@@ -0,0 +1,44 @@
+module ESP
+  class Report
+    module Export
+      class Integration < ESP::Resource
+        self.prefix += "reports/export/"
+        # Not Implemented. You cannot search for Reports::Export::Integration.
+        def self.where(*)
+          fail ESP::NotImplementedError
+        end
+
+        # Not Implemented. You cannot search for Reports::Export::Integration.
+        def self.find(*)
+          fail ESP::NotImplementedError
+        end
+
+        # Not Implemented. You cannot update a Reports::Export::Integration.
+        def update
+          fail ESP::NotImplementedError
+        end
+
+        # Not Implemented. You cannot destroy a Reports::Export::Integration.
+        def destroy
+          fail ESP::NotImplementedError
+        end
+
+        # :singleton-method: create
+        # Enqueue reports to be exported to the given integration
+        # Returns a Report::Export::Integration object if successful
+        # ==== Attribute
+        #
+        # See {API documentation}[http://api-docs.evident.io?ruby#report-export] for valid arguments
+        #
+        # If not successful, returns a Report::Export::Integration object with the errors object populated.
+
+        protected
+
+        # A success message gets returned, so just return the response instead of parsing for attributes
+        def load_attributes_from_response(response)
+          response
+        end
+      end
+    end
+  end
+end

data/lib/esp/resources/team.rb

@@ -16,6 +16,12 @@ module ESP
     # The collection of reports that belong to the team.
     has_many :reports, class_name: 'ESP::Report'
 
+    ##
+    # The collection of custom_signatures that belong to the team.
+    def custom_signatures
+      CustomSignature.where(teams_id_eq: id)
+    end
+
     # Enqueue a report to be run for this team.
     # Returns a Report object with a status of 'queued' and an id
     # Periodically check the API

data/lib/esp/version.rb

@@ -1,3 +1,3 @@
 module ESP
-  VERSION = '2.2.0'
+  VERSION = '2.3.0'
 end

data/lib/esp.rb

@@ -114,4 +114,9 @@ module ESP
   autoload :StatService, File.expand_path(File.dirname(__FILE__) + '/esp/resources/stat_service')
   autoload :ExternalAccountCreator, File.expand_path(File.dirname(__FILE__) + '/../lib/esp/external_account_creator')
   autoload :AWSClients, File.expand_path(File.dirname(__FILE__) + '/../lib/esp/aws_clients')
+  class Report
+    module Export
+      autoload :Integration, File.expand_path(File.dirname(__FILE__) + '/esp/resources/reports/export/integration')
+    end
+  end
 end

data/test/esp/extensions/active_resource/formats/json_api_format_test.rb

@@ -51,51 +51,6 @@ module ActiveResource
             end
           end
         end
-
-        context 'live calls' do
-          setup do
-            skip "Make sure you run the live calls locally to ensure proper integration" if ENV['CI_SERVER']
-            WebMock.allow_net_connect!
-          end
-
-          teardown do
-            WebMock.disable_net_connect!
-          end
-
-          should 'merge included objects' do
-            alert = ESP::Alert.find(1, include: 'external_account.team.organization,region,signature,custom_signature')
-
-            assert_not_nil alert.attributes['external_account']
-            assert_equal alert.external_account_id, alert.external_account.id
-            assert_not_nil alert.external_account.attributes['organization']
-            assert_equal alert.external_account.organization_id, alert.external_account.organization.id
-            assert_not_nil alert.external_account.attributes['team']
-            assert_equal alert.external_account.team_id, alert.external_account.team.id
-            assert_not_nil alert.external_account.team.attributes['organization']
-            assert_equal alert.external_account.team.organization_id, alert.external_account.team.organization.id
-            assert_not_nil alert.attributes['region']
-            assert_equal alert.region_id, alert.region.id
-            if alert.signature.present?
-              assert_not_nil alert.attributes['signature']
-              assert_equal alert.signature_id, alert.signature.id
-            else
-              assert_not_nil alert.attributes['custom_signature']
-              assert_equal alert.custom_signature_id, alert.custom_signature.id
-            end
-          end
-
-          should 'assign foreign key for a belongs_to relationship' do
-            user = ESP::User.last
-
-            assert_not_nil user.organization_id
-          end
-
-          should 'assign foreign key for a has_many relationship' do
-            user = ESP::User.last
-
-            assert_not_nil user.sub_organization_ids
-          end
-        end
       end
 
       context ActiveResource::ConnectionError do
@@ -118,28 +73,6 @@ module ActiveResource
             end
           end
         end
-
-        context 'live calls' do
-          setup do
-            skip "Make sure you run the live calls locally to ensure proper integration" if ENV['CI_SERVER']
-            WebMock.allow_net_connect!
-          end
-
-          teardown do
-            WebMock.disable_net_connect!
-          end
-
-          context "with ESP::Team" do
-            context '.initialize' do
-              should 'parse the error and return a descriptive error message' do
-                error = assert_raises ActiveResource::BadRequest do
-                  ESP::Team.create
-                end
-                assert_equal 'Failed.  Response code = 400.  Response message = param is missing or the value is empty: attributes.', error.message
-              end
-            end
-          end
-        end
       end
     end
   end

data/test/esp/extensions/active_resource/paginated_collection_test.rb

@@ -382,75 +382,6 @@ module ActiveResource
           end
         end
       end
-
-      context 'live calls' do
-        setup do
-          skip "Make sure you run the live calls locally to ensure proper integration" if ENV['CI_SERVER']
-          WebMock.allow_net_connect!
-        end
-
-        teardown do
-          WebMock.disable_net_connect!
-        end
-
-        should 'always return the correct page and update itself when using the ! methods' do
-          report = ESP::Report.all.detect { |r| r.status == 'complete' }
-          alerts = report.alerts
-          last_page_number = alerts.last_page_number
-
-          assert_equal '1', alerts.current_page_number
-          first_id = alerts.first.id
-
-          alerts.next_page!
-          assert_equal '2', alerts.current_page_number
-          refute_equal first_id, alerts.first.id
-          first_id = alerts.first.id
-
-          alerts.last_page!
-          assert_equal last_page_number, alerts.current_page_number
-          refute_equal first_id, alerts.first.id
-          first_id = alerts.first.id
-
-          alerts.previous_page!
-          assert_equal alerts.last_page_number.to_i - 1, alerts.current_page_number.to_i
-          refute_equal first_id, alerts.first.id
-          assert_equal 20, alerts.count # make sure the size did not get messed up while on the last page
-          first_id = alerts.first.id
-
-          alerts.page!(4)
-          assert_equal '4', alerts.current_page_number
-          refute_equal first_id, alerts.first.id
-        end
-
-        should 'always return the correct page and when not using the ! methods' do
-          report = ESP::Report.all.detect { |r| r.status == 'complete' }
-          alerts = report.alerts
-          last_page_number = alerts.last_page_number
-
-          assert_equal '1', alerts.current_page_number
-          first_id = alerts.first.id
-
-          page = alerts.next_page
-          assert_equal '2', page.current_page_number
-          refute_equal first_id, page.first.id
-          first_id = page.first.id
-
-          page = page.last_page
-          assert_equal last_page_number, page.current_page_number
-          refute_equal first_id, page.first.id
-          first_id = page.first.id
-
-          page = page.previous_page
-          assert_equal page.last_page_number.to_i - 1, page.current_page_number.to_i
-          refute_equal first_id, page.first.id
-          assert_equal 20, page.count # make sure the size did not get messed up while on the last page
-          first_id = page.first.id
-
-          page = alerts.page(4)
-          assert_equal '4', page.current_page_number
-          refute_equal first_id, page.first.id
-        end
-      end
     end
   end
 end

data/test/esp/extensions/active_resource/validations_test.rb

@@ -24,26 +24,6 @@ module ActiveResource
           end
         end
       end
-
-      context 'live calls' do
-        setup do
-          skip "Make sure you run the live calls locally to ensure proper integration" if ENV['CI_SERVER']
-          WebMock.allow_net_connect!
-        end
-
-        teardown do
-          WebMock.disable_net_connect!
-        end
-
-        context "#load_remote_errors" do
-          should 'should parse the response and put error messages in the errors object' do
-            team = ESP::Team.create(name: 'bob')
-
-            assert_contains team.errors.full_messages, "Organization can't be blank"
-            assert_contains team.errors.full_messages, "Organization can't be blank"
-          end
-        end
-      end
     end
   end
 end

data/test/esp/integration/alert_integration_test.rb

@@ -0,0 +1,96 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP::Integration
+  class AlertTest < ESP::Integration::TestCase
+    context ESP::Alert do
+      context 'live calls' do
+        setup do
+          @report = ESP::Report.all.detect { |r| r.status == 'complete' }
+          fail "Live DB does not have any reports.  Add a report and run tests again." if @report.blank?
+          @alert = @report.alerts.last
+        end
+
+        context '#external_account' do
+          should 'return an external_account' do
+            external_account = @alert.external_account
+
+            assert_equal ESP::ExternalAccount, external_account.class
+            assert_equal @alert.external_account_id, external_account.id
+          end
+        end
+
+        context '#region' do
+          should 'return a region' do
+            region = @alert.region
+
+            assert_equal ESP::Region, region.class
+            assert_equal @alert.region_id, region.id
+          end
+        end
+
+        context '#signature' do
+          should 'return a signature' do
+            @alert.attributes['signature_id'] ||= 1
+            signature = @alert.signature
+
+            assert_equal ESP::Signature, signature.class
+            assert_equal @alert.signature_id, signature.id
+          end
+        end
+
+        context '#custom_signature' do
+          should 'return a custom_signature' do
+            @alert.attributes['custom_signature_id'] ||= 1
+            custom_signature = @alert.custom_signature
+
+            assert_equal ESP::CustomSignature, custom_signature.class
+            assert_equal @alert.custom_signature_id.to_s, custom_signature.id.to_s
+          end
+        end
+
+        context '#suppression' do
+          should 'return a suppression' do
+            assert_nothing_raised do
+              @alert.attributes['suppression_id'] ||= 1
+              @alert.suppression
+            end
+          end
+        end
+
+        context '#cloud_trail_events' do
+          should 'return cloud_trail_events' do
+            assert_nothing_raised do
+              @alert.cloud_trail_events
+            end
+          end
+        end
+
+        context '#tags' do
+          should 'return tags' do
+            assert_nothing_raised do
+              @alert.tags
+            end
+          end
+        end
+
+        context '.find' do
+          should 'return an alert by id' do
+            alert = ESP::Alert.find(@alert.id.to_i)
+
+            assert_equal ESP::Alert, alert.class
+            assert_equal @alert.id, alert.id
+          end
+        end
+
+        context '.where' do
+          should 'return alert objects' do
+            alerts = ESP::Alert.where(report_id: @report.id, id_eq: @alert.id)
+
+            assert_equal ESP::Alert, alerts.resource_class
+            assert_equal @alert.id, alerts.first.id
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/integration/cloud_trail_event_integration_test.rb

@@ -0,0 +1,18 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP::Integration
+  class CloudTrailEventTest < ESP::Integration::TestCase
+    context ESP::CloudTrailEvent do
+      context 'live calls' do
+        context '.for_alert' do
+          should 'return events for alert id' do
+            report = ESP::Report.all.detect { |r| r.status == 'complete' }
+            events = ESP::CloudTrailEvent.for_alert(report.alerts.last.id)
+
+            assert_equal ESP::CloudTrailEvent, events.resource_class
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/integration/contact_request_integration_test.rb

@@ -0,0 +1,21 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP::Integration
+  class ContactRequestTest < ESP::Integration::TestCase
+    context ESP::ContactRequest do
+      context 'live calls' do
+        context '#CRUD' do
+          should 'be able to create, update and destroy' do
+            contact_request = ESP::ContactRequest.new(user_id: 5, request_type: 'feature', title: 'My great feature idea', description: 'This is my idea for a really useful feature...')
+
+            assert_predicate contact_request, :new?
+
+            contact_request.save
+
+            refute_predicate contact_request, :new?
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/integration/custom_signature_integration_test.rb

@@ -0,0 +1,97 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP::Integration
+  class CustomSignatureTest < ESP::Integration::TestCase
+    context ESP::CustomSignature do
+      context 'live calls' do
+        setup do
+          @custom_signature = ESP::CustomSignature.last
+          fail "Live DB does not have any custom_signatures.  Add a custom_signature and run tests again." if @custom_signature.blank?
+        end
+
+        context '#organization' do
+          should 'return an organization' do
+            organization = @custom_signature.organization
+
+            assert_equal @custom_signature.organization_id, organization.id
+            assert_equal ESP::Organization, organization.class
+          end
+        end
+
+        context '#teams' do
+          should 'return list of teams' do
+            team = @custom_signature.teams
+
+            assert_equal ESP::Team, team.resource_class
+          end
+        end
+
+        context '.run' do
+          should 'return alerts' do
+            skip "Can't run sigs on CI" if ENV['CI_SERVER']
+            external_account_id = ESP::ExternalAccount.last.id
+            alerts = ESP::CustomSignature.run(external_account_id: external_account_id, regions: 'us_east_1', language: @custom_signature.language, signature: @custom_signature.signature)
+
+            assert_equal ESP::Alert, alerts.resource_class
+          end
+
+          should 'return errors' do
+            signature = ESP::CustomSignature.run(external_account_id: 999_999_999_999, regions: 'us_east_1', language: @custom_signature.language, signature: @custom_signature.signature)
+
+            assert_equal "Couldn't find ExternalAccount", signature.errors.full_messages.first
+          end
+        end
+
+        context '#run' do
+          should 'return alerts' do
+            skip "Can't run sigs on CI" if ENV['CI_SERVER']
+            external_account_id = ESP::ExternalAccount.last.id
+            alerts = @custom_signature.run(external_account_id: external_account_id, regions: ['us_east_1'])
+
+            assert_equal ESP::Alert, alerts.resource_class
+          end
+
+          should 'return errors' do
+            @custom_signature.run(external_account_id: 999_999_999_999)
+
+            assert_equal "Couldn't find ExternalAccount", @custom_signature.errors.full_messages.first
+          end
+        end
+
+        context '.where' do
+          should 'return custom_signature objects' do
+            custom_signatures = ESP::CustomSignature.where(id_eq: @custom_signature.id)
+
+            assert_equal ESP::CustomSignature, custom_signatures.resource_class
+          end
+        end
+
+        context '#CRUD' do
+          should 'be able to create, update and destroy' do
+            skip "Can't run sigs on CI" if ENV['CI_SERVER']
+            custom_signature = ESP::CustomSignature.new(@custom_signature.attributes)
+
+            assert_predicate custom_signature, :new?
+
+            custom_signature.save
+
+            refute_predicate custom_signature, :new?
+
+            custom_signature.identifier = 'new identifier'
+            custom_signature.save
+
+            assert_nothing_raised do
+              ESP::CustomSignature.find(custom_signature.id)
+            end
+
+            custom_signature.destroy
+
+            assert_raises ActiveResource::ResourceNotFound do
+              ESP::CustomSignature.find(custom_signature.id)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/integration/dashboard_integration_test.rb

@@ -0,0 +1,17 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP::Integration
+  class DashboardTest < ESP::Integration::TestCase
+    context ESP::Dashboard do
+      context 'live calls' do
+        context '.recent' do
+          should 'return an array of contact_requests' do
+            dashboards = ESP::Dashboard.recent
+
+            assert_equal ESP::Dashboard, dashboards.resource_class
+          end
+        end
+      end
+    end
+  end
+end