esp_sdk 2.0.0 → 2.1.0

data/test/esp/resources/resource_test.rb

@@ -39,14 +39,6 @@ module ESP
           end
         end
 
-        context '.where' do
-          should 'not be implemented yet' do
-            assert_raise ESP::NotImplementedError do
-              ESP::Team.where(id: 1)
-            end
-          end
-        end
-
         context '#serializable_hash' do
           should 'format per json api standard' do
             t = build(:team)
@@ -101,90 +93,242 @@ module ESP
               assert_equal({ "0" => "3", "1" => "4" }, query['filter']['id_in'])
             end
           end
-        end
 
-        should 'not put page parameter inside filter parameter' do
-          stub_request(:get, /teams.json*/).to_return(body: json_list(:team, 2))
+          should 'not put page parameter inside filter parameter' do
+            stub_request(:get, /teams.json*/).to_return(body: json_list(:team, 2))
 
-          ESP::Team.find(:all, params: { id: 3, page: { number: 2, size: 3 } })
+            ESP::Team.find(:all, params: { id: 3, page: { number: 2, size: 3 } })
 
-          assert_requested(:get, /teams.json*/) do |req|
-            query = Rack::Utils.parse_nested_query(CGI.unescape(req.uri.query))
-            assert_equal true, query.key?('filter')
-            assert_equal '2', query['page']['number']
+            assert_requested(:get, /teams.json*/) do |req|
+              query = Rack::Utils.parse_nested_query(CGI.unescape(req.uri.query))
+              assert_equal true, query.key?('filter')
+              assert_equal '2', query['page']['number']
+            end
           end
-        end
 
-        should 'add the include option to param' do
-          stub_request(:get, /teams.json*/).to_return(body: json_list(:team, 2))
+          should 'add the include option to param' do
+            stub_request(:get, /teams.json*/).to_return(body: json_list(:team, 2))
 
-          ESP::Team.find(:all, include: 'organization')
+            ESP::Team.find(:all, include: 'organization')
 
-          assert_requested(:get, /teams.json*/) do |req|
-            query = Rack::Utils.parse_nested_query(CGI.unescape(req.uri.query))
-            assert_equal true, query.key?('include')
-            assert_equal 'organization', query['include']
+            assert_requested(:get, /teams.json*/) do |req|
+              query = Rack::Utils.parse_nested_query(CGI.unescape(req.uri.query))
+              assert_equal true, query.key?('include')
+              assert_equal 'organization', query['include']
+            end
           end
-        end
 
-        should 'add the include option to param when finding by id' do
-          stub_request(:get, %r{teams/2.json*}).to_return(body: json_list(:team, 2))
+          should 'add the include option to param when finding by id' do
+            stub_request(:get, %r{teams/2.json*}).to_return(body: json_list(:team, 2))
 
-          ESP::Team.find(2, include: 'organization')
+            ESP::Team.find(2, include: 'organization')
 
-          assert_requested(:get, %r{teams/2.json*}) do |req|
-            query = Rack::Utils.parse_nested_query(CGI.unescape(req.uri.query))
-            assert_equal true, query.key?('include')
-            assert_equal 'organization', query['include']
+            assert_requested(:get, %r{teams/2.json*}) do |req|
+              query = Rack::Utils.parse_nested_query(CGI.unescape(req.uri.query))
+              assert_equal true, query.key?('include')
+              assert_equal 'organization', query['include']
+            end
           end
-        end
 
-        should 'not ransackize the filter parameter if it is passed' do
-          stub_request(:get, /teams.json*/).to_return(body: json_list(:team, 2))
+          should 'not ransackize the filter parameter if it is passed' do
+            stub_request(:get, /teams.json*/).to_return(body: json_list(:team, 2))
 
-          ESP::Team.find(:all, params: { filter: { id_eq: 3 }, page: { number: 2, size: 3 } })
+            ESP::Team.find(:all, params: { filter: { id_eq: 3 }, page: { number: 2, size: 3 } })
 
-          assert_requested(:get, /teams.json*/) do |req|
-            query = Rack::Utils.parse_nested_query(CGI.unescape(req.uri.query))
-            assert_equal true, query.key?('filter')
-            assert_equal true, query['filter'].key?('id_eq')
+            assert_requested(:get, /teams.json*/) do |req|
+              query = Rack::Utils.parse_nested_query(CGI.unescape(req.uri.query))
+              assert_equal true, query.key?('filter')
+              assert_equal true, query['filter'].key?('id_eq')
+            end
           end
-        end
 
-        should 'add the from attribute to PaginatedCollection objects when from is supplied' do
-          stub_request(:get, /teams.json*/).to_return(body: json_list(:team, 2))
+          should 'add the from attribute to PaginatedCollection objects when from is supplied' do
+            stub_request(:get, /teams.json*/).to_return(body: json_list(:team, 2))
 
-          teams = ESP::Team.find(:all, from: "#{Team.prefix}teams.json", params: { filter: { id_eq: 3 }, page: { number: 2, size: 3 } })
+            teams = ESP::Team.find(:all, from: "#{Team.prefix}teams.json", params: { filter: { id_eq: 3 }, page: { number: 2, size: 3 } })
 
-          assert_equal '/api/v2/teams.json', teams.from
+            assert_equal '/api/v2/teams.json', teams.from
+          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!
-          @team = ESP::Team.last
-          skip "Live DB does not have any teams.  Add a team and run tests again." if @team.blank?
-        end
+        context '.where' do
+          should 'call the index method when finding by single id using put' do
+            stub_request(:put, /teams.json/).to_return(body: json_list(:team, 1))
+
+            ESP::Team.where(id: 3)
+
+            assert_requested(:put, /teams.json/)
+          end
+
+          should 'build body inside filter param and ad _eq when single value' do
+            stub_request(:put, /teams.json*/).to_return(body: json_list(:team, 2))
+
+            ESP::Team.where(id: 3)
+
+            assert_requested(:put, /teams.json*/) do |req|
+              body = JSON.parse req.body
+              assert_equal true, body.key?('filter')
+              assert_equal true, body['filter'].key?('id_eq')
+              assert_equal 3, body['filter']['id_eq']
+            end
+          end
+
+          should 'build body inside filter param and ad _in when multiple values' do
+            stub_request(:put, /teams.json*/).to_return(body: json_list(:team, 2))
+
+            ESP::Team.where(id: [3, 4])
+
+            assert_requested(:put, /teams.json*/) do |req|
+              body = JSON.parse req.body
+              assert_equal true, body.key?('filter')
+              assert_equal true, body['filter'].key?('id_in')
+              assert_equal([3, 4], body['filter']['id_in'])
+            end
+          end
 
-        teardown do
-          WebMock.disable_net_connect!
+          should 'not put page parameter inside filter parameter' do
+            stub_request(:put, /teams.json*/).to_return(body: json_list(:team, 2))
+
+            ESP::Team.where(id: 3, page: { number: 2, size: 3 })
+
+            assert_requested(:put, /teams.json*/) do |req|
+              body = JSON.parse req.body
+              assert_equal true, body.key?('filter')
+              assert_equal 2, body['page']['number']
+            end
+          end
+
+          should 'add the include option to param' do
+            stub_request(:put, /teams.json*/).to_return(body: json_list(:team, 2))
+
+            ESP::Team.where(id: 1, include: 'organization')
+
+            assert_requested(:put, /teams.json*/) do |req|
+              body = JSON.parse req.body
+              assert_equal true, body.key?('include')
+              assert_equal 'organization', body['include']
+            end
+          end
+
+          should 'add the sorts option to the params' do
+            stub_request(:put, /teams.json*/).to_return(body: json_list(:team, 2))
+
+            ESP::Team.where(name_cont: 'Team', sorts: 'created_at')
+
+            assert_requested(:put, /teams.json*/) do |req|
+              body = JSON.parse req.body
+              assert_equal true, body.key?('filter')
+              assert_equal 'Team', body['filter']['name_cont']
+              assert_equal 'created_at', body['filter']['sorts']
+            end
+          end
+
+          should 'add the combinator option to the params' do
+            stub_request(:put, /teams.json*/).to_return(body: json_list(:team, 2))
+
+            ESP::Team.where(name_cont: 'Team', id_eq: 3, m: :or)
+
+            assert_requested(:put, /teams.json*/) do |req|
+              body = JSON.parse req.body
+              assert_equal true, body.key?('filter')
+              assert_equal 'Team', body['filter']['name_cont']
+              assert_equal 3, body['filter']['id_eq']
+              assert_equal 'or', body['filter']['m']
+            end
+          end
+
+          should 'add _eq to attribute if predicate is not already appended' do
+            stub_request(:put, /teams.json*/).to_return(body: json_list(:team, 2))
+
+            ESP::Team.where(id: 3)
+
+            assert_requested(:put, /teams.json*/) do |req|
+              body = JSON.parse req.body
+              assert_equal true, body.key?('filter')
+              assert_equal true, body['filter'].key?("id_eq")
+            end
+          end
+
+          should 'add _in to array attribute if predicate is not already appended' do
+            stub_request(:put, /teams.json*/).to_return(body: json_list(:team, 2))
+
+            ESP::Team.where(id: [3])
+
+            assert_requested(:put, /teams.json*/) do |req|
+              body = JSON.parse req.body
+              assert_equal true, body.key?('filter')
+              assert_equal true, body['filter'].key?("id_in")
+            end
+          end
+
+          ESP::Resource::PREDICATES.split('|').each do |predicate|
+            next if predicate == 'm' # This is a special case
+            should "not ransackize attributes that already have ransack predicate #{predicate} appended" do
+              stub_request(:put, /teams.json*/).to_return(body: json_list(:team, 2))
+
+              args = { page: { number: 2, size: 3 } }
+              args["id_#{predicate}"] = 3
+              ESP::Team.where(args)
+
+              assert_requested(:put, /teams.json*/) do |req|
+                body = JSON.parse req.body
+                assert_equal true, body.key?('filter')
+                assert_equal true, body['filter'].key?("id_#{predicate}")
+              end
+            end
+          end
         end
 
-        context 'with ESP::Team' do
-          should 'find a team' do
-            t = ESP::Team.find(@team.id)
+        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!
+            @team = ESP::Team.last
+            skip "Live DB does not have any teams.  Add a team and run tests again." if @team.blank?
+          end
 
-            assert_equal ESP::Team, t.class
-            assert_equal @team.id, t.id
+          teardown do
+            WebMock.disable_net_connect!
           end
 
-          should 'find teams' do
-            t = ESP::Team.find(:all, params: { id: @team.id })
+          context 'with ESP::Team' do
+            context '.find' do
+              should 'find a team' do
+                t = ESP::Team.find(@team.id)
+
+                assert_equal ESP::Team, t.class
+                assert_equal @team.id, t.id
+              end
+
+              should 'find teams' do
+                t = ESP::Team.find(:all, params: { id: @team.id })
+
+                assert_equal ESP::Team, t.resource_class
+                assert_equal 1, t.count
+              end
+            end
+
+            context '.where' do
+              should 'return teams' do
+                teams = ESP::Team.where(id: @team.id)
 
-            assert_equal ESP::Team, t.resource_class
-            assert_equal 1, t.count
+                assert_equal ESP::Team, teams.resource_class
+                assert_equal 1, teams.count
+              end
+
+              should 'return included object on first call' do
+                teams = ESP::Team.where(id: @team.id, include: 'organization')
+
+                assert_equal ESP::Organization, teams.first.attributes['organization'].class
+              end
+
+              should 'return multiple included objects on first call' do
+                teams = ESP::Team.where(id: @team.id, include: 'sub_organization, organization')
+
+                assert_equal ESP::Organization, teams.first.attributes['organization'].class
+                assert_equal ESP::SubOrganization, teams.first.attributes['sub_organization'].class
+              end
+            end
           end
         end
       end

data/test/esp/resources/service_test.rb

@@ -4,6 +4,14 @@ module ESP
   class ServiceTest < ActiveSupport::TestCase
     context ESP::Service do
       context '#signatures' do
+        context '.where' do
+          should 'not be implemented' do
+            assert_raises ESP::NotImplementedError do
+              Tag.where(id_eq: 2)
+            end
+          end
+        end
+
         should 'call the api' do
           s = build(:service)
           stub_request(:get, /signatures.json*/).to_return(body: json_list(:signature, 2))

data/test/esp/resources/signature_test.rb

@@ -123,6 +123,8 @@ module ESP
         setup do
           skip "Make sure you run the live calls locally to ensure proper integration" if ENV['CI_SERVER']
           WebMock.allow_net_connect!
+          @signature = ESP::Signature.where(name_cont: 'heartbleed').last
+          skip "Live DB does not have any signatures.  Add a signature and run tests again." if @signature.blank?
         end
 
         teardown do
@@ -131,32 +133,36 @@ module ESP
 
         context '#service' do
           should 'return a service' do
-            signature = ESP::Signature.first
+            service = @signature.service
 
-            service = signature.service
-
-            assert_equal signature.service_id, service.id
+            assert_equal @signature.service_id, service.id
             assert_equal ESP::Service, service.class
           end
         end
 
         context '#run' do
           should 'return alerts' do
-            signature = ESP::Signature.first
             external_account_id = ESP::ExternalAccount.last.id
 
-            alerts = signature.run(external_account_id: external_account_id, region: 'us_east_1')
+            alerts = @signature.run(external_account_id: external_account_id, region: 'us_east_1')
 
             assert_equal ESP::Alert, alerts.resource_class
           end
 
           should 'return errors' do
-            signature = ESP::Signature.first
             external_account_id = 999_999_999_999
 
-            signature = signature.run(external_account_id: external_account_id, region: 'us_east_1')
+            @signature.run(external_account_id: external_account_id, region: 'us_east_1')
+
+            assert_equal "Couldn't find ExternalAccount", @signature.errors.full_messages.first
+          end
+        end
+
+        context '.where' do
+          should 'return signature objects' do
+            signatures = ESP::Signature.where(id_eq: @signature.id)
 
-            assert_equal "Couldn't find ExternalAccount", signature.errors.full_messages.first
+            assert_equal ESP::Signature, signatures.resource_class
           end
         end
 

data/test/esp/resources/stat_custom_signature_test.rb

@@ -5,6 +5,14 @@ module ESP
     class CustomSignatureTest < ActiveSupport::TestCase
       context ESP::StatCustomSignature do
         context '.for_stat' do
+          context '.where' do
+            should 'not be implemented' do
+              assert_raises ESP::NotImplementedError do
+                StatCustomSignature.where(id_eq: 2)
+              end
+            end
+          end
+
           should 'throw an error if stat id is not supplied' do
             error = assert_raises ArgumentError do
               ESP::StatCustomSignature.for_stat
@@ -100,7 +108,7 @@ module ESP
 
           context '.for_stat' do
             should 'return tags for stat id' do
-              report = ESP::Report.find(:first, params: { status: 'complete' })
+              report = ESP::Report.find(:first, params: { id_eq: 1 })
               skip "make sure you have a complete report" unless report.present?
               stat_id = report.stat.id
               stats = ESP::StatCustomSignature.for_stat(stat_id)

data/test/esp/resources/stat_region_test.rb

@@ -4,6 +4,14 @@ module ESP
   class Stat
     class RegionTest < ActiveSupport::TestCase
       context ESP::StatRegion do
+        context '.where' do
+          should 'not be implemented' do
+            assert_raises ESP::NotImplementedError do
+              StatRegion.where(id_eq: 2)
+            end
+          end
+        end
+
         context '.for_stat' do
           should 'throw an error if stat id is not supplied' do
             error = assert_raises ArgumentError do
@@ -97,9 +105,23 @@ module ESP
             WebMock.disable_net_connect!
           end
 
+          context '#regions' do
+            should 'return regions' do
+              report = ESP::Report.all.detect { |r| r.status == 'complete' }
+              skip "Live DB does not have any reports.  Add a report with stats and run tests again." if report.blank?
+              stat = ESP::Stat.for_report(report.id)
+              regions = stat.regions
+
+              region = regions.first.region
+
+              assert_equal ESP::Region, region.class
+              assert_equal regions.first.region.code, region.code
+            end
+          end
+
           context '.for_stat' do
             should 'return tags for stat id' do
-              report = ESP::Report.find(:first, params: { status: 'complete' })
+              report = ESP::Report.find(:first, params: { id_eq: 1 })
               skip "make sure you have a complete report" unless report.present?
               stat_id = report.stat.id
               stats = ESP::StatRegion.for_stat(stat_id)

data/test/esp/resources/stat_service_test.rb

@@ -4,6 +4,14 @@ module ESP
   class Stat
     class ServiceTest < ActiveSupport::TestCase
       context ESP::StatService do
+        context '.where' do
+          should 'not be implemented' do
+            assert_raises ESP::NotImplementedError do
+              StatService.where(id_eq: 2)
+            end
+          end
+        end
+
         context '.for_stat' do
           should 'throw an error if stat id is not supplied' do
             error = assert_raises ArgumentError do
@@ -97,9 +105,23 @@ module ESP
             WebMock.disable_net_connect!
           end
 
+          context '#services' do
+            should 'return signatures' do
+              report = ESP::Report.all.detect { |r| r.status == 'complete' }
+              skip "Live DB does not have any reports.  Add a report with stats and run tests again." if report.blank?
+              stat = ESP::Stat.for_report(report.id)
+              services = stat.services
+
+              service = services.first.service
+
+              assert_equal ESP::Service, service.class
+              assert_equal services.first.service.name, service.name
+            end
+          end
+
           context '.for_stat' do
             should 'return tags for stat id' do
-              report = ESP::Report.find(:first, params: { status: 'complete' })
+              report = ESP::Report.find(:first, params: { id_eq: 1 })
               skip "make sure you have a complete report" unless report.present?
               stat_id = report.stat.id
               stats = ESP::StatService.for_stat(stat_id)

data/test/esp/resources/stat_signature_test.rb

@@ -4,6 +4,14 @@ module ESP
   class Stat
     class SignatureTest < ActiveSupport::TestCase
       context ESP::StatSignature do
+        context '.where' do
+          should 'not be implemented' do
+            assert_raises ESP::NotImplementedError do
+              StatSignature.where(id_eq: 2)
+            end
+          end
+        end
+
         context '.for_stat' do
           should 'throw an error if stat id is not supplied' do
             error = assert_raises ArgumentError do
@@ -98,9 +106,23 @@ module ESP
             WebMock.disable_net_connect!
           end
 
+          context '#signatures' do
+            should 'return signatures' do
+              report = ESP::Report.all.detect { |r| r.status == 'complete' }
+              skip "Live DB does not have any reports.  Add a report with stats and run tests again." if report.blank?
+              stat = ESP::Stat.for_report(report.id)
+              signatures = stat.signatures
+
+              signature = signatures.first.signature
+
+              assert_equal ESP::Signature, signature.class
+              assert_equal signatures.first.signature.name, signature.name
+            end
+          end
+
           context '.for_stat' do
             should 'return tags for stat id' do
-              report = ESP::Report.find(:first, params: { status: 'complete' })
+              report = ESP::Report.find(:first, params: { id_eq: 1 })
               skip "make sure you have a complete report" unless report.present?
               stat_id = report.stat.id
               stats = ESP::StatSignature.for_stat(stat_id)

data/test/esp/resources/stat_test.rb

@@ -3,6 +3,14 @@ require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
 module ESP
   class StatTest < ActiveSupport::TestCase
     context ESP::Stat do
+      context '.where' do
+        should 'not be implemented' do
+          assert_raises ESP::NotImplementedError do
+            Stat.where(id_eq: 2)
+          end
+        end
+      end
+
       context '#report' do
         should 'call the api' do
           stat = build(:stat, report_id: 3)
@@ -127,22 +135,58 @@ module ESP
         setup do
           skip "Make sure you run the live calls locally to ensure proper integration" if ENV['CI_SERVER']
           WebMock.allow_net_connect!
-          @team = ESP::Team.last
-          skip "Live DB does not have any teams.  Add a team and run tests again." if @team.blank?
+          @report = ESP::Report.all.detect { |r| r.status == 'complete' }
+          skip "Live DB does not have any reports.  Add a report with stats and run tests again." if @report.blank?
+          @stat = ESP::Stat.for_report(@report.id)
         end
 
         teardown do
           WebMock.disable_net_connect!
         end
 
-        context 'for_report' do
-          should 'return the stat for the report' do
-            report = ESP::Report.last
-            skip "Live DB does not have any reports.  Add a report with stats and run tests again." if report.blank?
+        context '#report' do
+          should 'return a report' do
+            report = @stat.report
+
+            assert_equal @stat.report_id, report.id
+          end
+        end
+
+        context '#regions' do
+          should 'return regions' do
+            regions = @stat.regions
+
+            assert_equal ESP::StatRegion, regions.resource_class
+          end
+        end
+
+        context '#services' do
+          should 'return services' do
+            services = @stat.services
+
+            assert_equal ESP::StatService, services.resource_class
+          end
+        end
+
+        context '#signatures' do
+          should 'return signatures' do
+            signatures = @stat.signatures
+
+            assert_equal ESP::StatSignature, signatures.resource_class
+          end
+        end
 
-            stat = ESP::Stat.for_report(report.id)
+        context '#custom_signautures' do
+          should 'return custom_signautures' do
+            custom_signatures = @stat.custom_signatures
 
-            assert_equal report.id, stat.report.id
+            assert_equal ESP::StatCustomSignature, custom_signatures.resource_class
+          end
+        end
+
+        context 'for_report' do
+          should 'return the stat for the report' do
+            assert_equal @report.id, @stat.report_id
           end
         end
 

data/test/esp/resources/sub_organization_test.rb

@@ -97,6 +97,14 @@ module ESP
           end
         end
 
+        context '.where' do
+          should 'return sub_organization objects' do
+            sub_organizations = ESP::SubOrganization.where(id_eq: @sub_organization.id)
+
+            assert_equal ESP::SubOrganization, sub_organizations.resource_class
+          end
+        end
+
         context '#CRUD' do
           should 'be able to create, update and destroy' do
             sub_organization = ESP::SubOrganization.new(name: 'bob', organization_id: @sub_organization.organization_id)

data/test/esp/resources/suppression/region_test.rb

@@ -4,6 +4,14 @@ module ESP
   class Suppression
     class RegionTest < ActiveSupport::TestCase
       context ESP::Suppression::Region do
+        context '.where' do
+          should 'not be implemented' do
+            assert_raises ESP::NotImplementedError do
+              ESP::Suppression::Region.where(id_eq: 2)
+            end
+          end
+        end
+
         context '#find' do
           should 'not be implemented' do
             assert_raises ESP::NotImplementedError do
@@ -91,7 +99,7 @@ module ESP
 
             context 'for_alert' do
               should 'return error when reason is not supplied' do
-                alert_id = ESP::Report.last.alerts.last.id
+                alert_id = ESP::Report.all.detect { |r| r.status == 'complete' }.alerts.last.id
 
                 suppression = ESP::Suppression::Region.create(alert_id: alert_id)
 
@@ -99,7 +107,7 @@ module ESP
               end
 
               should 'return suppression' do
-                alert_id = ESP::Report.last.alerts.last.id
+                alert_id = ESP::Report.all.detect { |r| r.status == 'complete' }.alerts.last.id
 
                 suppression = ESP::Suppression::Region.create(alert_id: alert_id, reason: 'test')