esp_sdk 1.1.0 → 2.0.0.rc1

data/test/esp/resources/resource_test.rb

@@ -0,0 +1,183 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class ResourceTest < ActiveSupport::TestCase
+    context ESP::Resource do
+      context 'with ESP::Team' do
+        should 'set the Content-Type to application/vnd.api+json' do
+          stub_request(:get, %r{teams/3.json*}).to_return(body: json(:team))
+
+          ESP::Team.find(3)
+
+          assert_requested(:get, %r{teams/3.json*}) do |req|
+            assert_equal ActiveResource::Formats::JsonAPIFormat.mime_type, req.headers['Content-Type']
+          end
+        end
+
+        should 'set the HMAC needed Authorization header' do
+          ESP.access_key_id ||= ApiAuth.generate_secret_key
+          ESP.secret_access_key ||= ApiAuth.generate_secret_key
+          ESP::Team.hmac_access_id = ESP.access_key_id
+          ESP::Team.hmac_secret_key = ESP.secret_access_key
+          stub_request(:get, %r{teams/3.json*}).to_return(body: json(:team))
+
+          ESP::Team.find(3)
+
+          assert_requested(:get, %r{teams/3.json*}) do |req|
+            # Remove non word chars to prevent regex matching errors.
+            assert_match(/APIAuth#{ESP.access_key_id.gsub(/\W/, '')}/, req.headers['Authorization'].gsub(/\W/, ''))
+          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)
+
+            h = t.serializable_hash
+
+            assert_equal t.id, h['data']['id']
+            assert_equal 'teams', h['data']['type']
+            assert_equal t.name, h['data']['attributes']['name']
+          end
+
+          should 'should not include the id if it is not present' do
+            t = build(:team, id: nil)
+
+            h = t.serializable_hash
+
+            assert_equal false, h['data'].key?('id')
+          end
+        end
+
+        context '.find' do
+          should 'call the show method when finding by single id' do
+            stub_request(:get, %r{teams/3.json*}).to_return(body: json(:team))
+
+            ESP::Team.find(3)
+
+            assert_requested(:get, %r{teams/3.json*})
+          end
+
+          should 'build query string inside filter param and ad _eq when single value' do
+            stub_request(:get, /teams.json*/).to_return(body: json_list(:team, 2))
+
+            ESP::Team.find(:all, params: { id: 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_equal '3', query['filter']['id_eq']
+            end
+          end
+
+          should 'build query string inside filter param and ad _in when multiple values' do
+            stub_request(:get, /teams.json*/).to_return(body: json_list(:team, 2))
+
+            ESP::Team.find(:all, params: { id: [3, 4] })
+
+            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_in')
+              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))
+
+          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']
+          end
+        end
+
+        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')
+
+          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
+
+        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')
+
+          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
+
+        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 } })
+
+          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
+
+        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 } })
+
+          assert_equal '/api/v2/teams.json', teams.from
+        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
+
+        teardown do
+          WebMock.disable_net_connect!
+        end
+
+        context 'with ESP::Team' 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
+      end
+    end
+  end
+end

data/test/esp/resources/service_test.rb

@@ -0,0 +1,64 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class ServiceTest < ActiveSupport::TestCase
+    context ESP::Service do
+      context '#signatures' do
+        should 'call the api' do
+          s = build(:service)
+          stub_request(:get, /signatures.json*/).to_return(body: json_list(:signature, 2))
+
+          s.signatures
+
+          assert_requested(:get, /signatures.json*/) do |req|
+            assert_equal "filter[service_id_eq]=#{s.id}", URI.unescape(req.uri.query)
+          end
+        end
+      end
+
+      context '#create' do
+        should 'not be implemented' do
+          assert_raises ESP::NotImplementedError do
+            ESP::Service.create(name: 'test')
+          end
+        end
+      end
+
+      context '#destroy' do
+        should 'not be implemented' do
+          s = build(:service)
+          assert_raises ESP::NotImplementedError do
+            s.destroy
+          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!
+          @service = ESP::Service.last
+          skip "Live DB does not have any services.  Add a service and run tests again." if @service.blank?
+        end
+
+        teardown do
+          WebMock.disable_net_connect!
+        end
+
+        context '#signatures' do
+          should 'return an array of signatures' do
+            signatures = @service.signatures
+
+            assert_equal ESP::Signature, signatures.resource_class
+          end
+        end
+
+        context '#CRUD' do
+          should 'be able to read' do
+            assert_not_nil @service, @service.inspect
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/resources/signature_test.rb

@@ -0,0 +1,177 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class SignatureTest < ActiveSupport::TestCase
+    context ESP::Signature do
+      context '#service' do
+        should 'call the api' do
+          s = build(:signature, service_id: 4)
+          stubbed_service = stub_request(:get, %r{services/#{s.service_id}.json*}).to_return(body: json(:service))
+
+          s.service
+
+          assert_requested(stubbed_service)
+        end
+      end
+
+      context '#create' do
+        should 'not be implemented' do
+          assert_raises ESP::NotImplementedError do
+            ESP::Signature.create(name: 'test')
+          end
+        end
+      end
+
+      context '#update' do
+        should 'not be implemented' do
+          signature = build(:signature)
+          assert_raises ESP::NotImplementedError do
+            signature.save
+          end
+        end
+      end
+
+      context '#destroy' do
+        should 'not be implemented' do
+          s = build(:signature)
+          assert_raises ESP::NotImplementedError do
+            s.destroy
+          end
+        end
+      end
+
+      context '#run' do
+        should 'call the api and pass params' do
+          signature = build(:signature)
+          stub_request(:post, %r{signatures/#{signature.id}/run.json*}).to_return(body: json_list(:alert, 2))
+
+          alerts = signature.run(external_account_id: 3, regions: 'param2')
+
+          assert_requested(:post, %r{signatures/#{signature.id}/run.json}) do |req|
+            body = JSON.parse req.body
+            assert_equal 3, body['data']['attributes']['external_account_id']
+            assert_equal ['param2'], body['data']['attributes']['regions']
+          end
+          assert_equal ESP::Alert, alerts.resource_class
+        end
+
+        should 'not throw an error if an error is returned' do
+          signature = build(:signature)
+          error = ActiveResource::BadRequest.new('')
+          error_response = json(:error)
+          response = mock(body: error_response, code: '400')
+          error.stubs(:response).returns(response)
+          ActiveResource::Connection.any_instance.expects(:post).raises(error)
+
+          assert_nothing_raised do
+            result = signature.run(external_account_id: 3, regions: 'param2')
+            assert_equal JSON.parse(error_response)['errors'].first['title'], result.errors.full_messages.first
+          end
+        end
+      end
+
+      context '.run!' do
+        should 'call the api and pass params' do
+          signature = build(:signature)
+          stub_request(:post, %r{signatures/#{signature.id}/run.json*}).to_return(body: json_list(:alert, 2))
+
+          alerts = signature.run!(external_account_id: 3, regions: 'param2')
+
+          assert_requested(:post, %r{signatures/#{signature.id}/run.json}) do |req|
+            body = JSON.parse req.body
+            assert_equal 3, body['data']['attributes']['external_account_id']
+            assert_equal ['param2'], body['data']['attributes']['regions']
+          end
+          assert_equal ESP::Alert, alerts.resource_class
+        end
+
+        should 'throw an error if an error is returned' do
+          signature = build(:signature)
+          error = ActiveResource::BadRequest.new('')
+          error_response = json(:error)
+          response = mock(body: error_response, code: '400')
+          error.stubs(:response).returns(response)
+          ActiveResource::Connection.any_instance.expects(:post).raises(error)
+
+          error = assert_raises ActiveResource::ResourceInvalid do
+            result = signature.run!(external_account_id: 3, regions: 'param2')
+            assert_equal JSON.parse(error_response)['errors'].first['title'], result.errors.full_messages.first
+          end
+          assert_equal "Failed.  Response code = 400.  Response message = #{JSON.parse(error_response)['errors'].first['title']}.", error.message
+        end
+      end
+
+      context '#suppress' do
+        should 'call the api' do
+          stub_request(:post, %r{suppressions/signatures.json*}).to_return(body: json(:suppression_signature))
+          signature = build(:signature)
+
+          suppression = signature.suppress(regions: ['us_east_1'], external_account_ids: [5], reason: 'because')
+
+          assert_requested(:post, %r{suppressions/signatures.json*}) do |req|
+            body = JSON.parse(req.body)
+            assert_equal 'because', body['data']['attributes']['reason']
+            assert_equal [signature.id], body['data']['attributes']['signature_ids']
+            assert_equal ['us_east_1'], body['data']['attributes']['regions']
+            assert_equal [5], body['data']['attributes']['external_account_ids']
+          end
+          assert_equal ESP::Suppression::Signature, suppression.class
+        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 '#service' do
+          should 'return a service' do
+            signature = ESP::Signature.first
+
+            service = signature.service
+
+            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, regions: 'us_east_1')
+
+            assert_equal ESP::Alert, alerts.resource_class
+          end
+
+          should 'return errors' do
+            signature = ESP::Signature.first
+            external_account_id = 999
+
+            signature = signature.run(external_account_id: external_account_id, regions: ['us_east_1'])
+
+            assert_equal "Couldn't find ExternalAccount", signature.errors.full_messages.first
+          end
+        end
+
+        context '#CRUD' do
+          should 'be able to read' do
+            signature = ESP::Signature.last
+
+            assert_not_nil signature
+
+            signature = ESP::Signature.find(signature.id)
+
+            assert_not_nil signature
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/resources/stat_custom_signature_test.rb

@@ -0,0 +1,115 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class Stat
+    class CustomSignatureTest < ActiveSupport::TestCase
+      context ESP::StatCustomSignature do
+        context '.for_stat' do
+          should 'throw an error if stat id is not supplied' do
+            error = assert_raises ArgumentError do
+              ESP::StatCustomSignature.for_stat
+            end
+            assert_equal 'You must supply a stat id.', error.message
+          end
+
+          should 'call the api' do
+            stub_custom_signature = stub_request(:get, %r{stats/5/custom_signatures.json*}).to_return(body: json_list(:stat_custom_signature, 2))
+
+            custom_signatures = ESP::StatCustomSignature.for_stat(5)
+
+            assert_requested(stub_custom_signature)
+            assert_equal ESP::StatCustomSignature, custom_signatures.resource_class
+          end
+        end
+
+        context '.find' do
+          should 'throw an error if stat_id is not supplied' do
+            error = assert_raises ArgumentError do
+              ESP::StatCustomSignature.find(:all, params: { id: 3 })
+            end
+            assert_equal 'You must supply a stat id.', error.message
+          end
+
+          should 'call the show api and return a custom_signature if searching by id' do
+            stub_custom_signature = stub_request(:get, %r{custom_signatures/5.json*}).to_return(body: json(:stat_custom_signature))
+
+            custom_signature = ESP::StatCustomSignature.find(5)
+
+            assert_requested(stub_custom_signature)
+            assert_equal ESP::StatCustomSignature, custom_signature.class
+          end
+
+          should 'call the api and return custom_signatures when stat_id is supplied' do
+            stub_custom_signature = stub_request(:get, %r{stats/5/custom_signatures.json*}).to_return(body: json_list(:stat_custom_signature, 2))
+
+            custom_signatures = ESP::StatCustomSignature.find(:all, params: { stat_id: 5 })
+
+            assert_requested(stub_custom_signature)
+            assert_equal ESP::StatCustomSignature, custom_signatures.resource_class
+          end
+        end
+
+        context '#create' do
+          should 'not be implemented' do
+            assert_raises ESP::NotImplementedError do
+              ESP::StatCustomSignature.create(name: 'test')
+            end
+          end
+        end
+
+        context '#update' do
+          should 'not be implemented' do
+            custom_signature = ESP::StatCustomSignature.new
+            assert_raises ESP::NotImplementedError do
+              custom_signature.save
+            end
+          end
+        end
+
+        context '#destroy' do
+          should 'not be implemented' do
+            s = ESP::StatCustomSignature.new
+            assert_raises ESP::NotImplementedError do
+              s.destroy
+            end
+          end
+        end
+
+        context '#custom_signature' do
+          should 'call the show api and return the custom_signature' do
+            custom_signature_stat = ESP::StatCustomSignature.new(custom_signature_id: 3)
+
+            stub_custom_signature = stub_request(:get, %r{custom_signatures/#{custom_signature_stat.custom_signature_id}.json*}).to_return(body: json(:custom_signature))
+
+            custom_signature = custom_signature_stat.custom_signature
+
+            assert_requested(stub_custom_signature)
+            assert_equal ESP::CustomSignature, custom_signature.class
+          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 '.for_stat' do
+            should 'return tags for stat id' do
+              report = ESP::Report.find(:first, params: { status: 'complete' })
+              skip "make sure you have a complete report" unless report.present?
+              stat_id = report.stat.id
+              stats = ESP::StatCustomSignature.for_stat(stat_id)
+
+              assert_equal ESP::StatCustomSignature, stats.resource_class
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/resources/stat_region_test.rb

@@ -0,0 +1,114 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class Stat
+    class RegionTest < ActiveSupport::TestCase
+      context ESP::StatRegion do
+        context '.for_stat' do
+          should 'throw an error if stat id is not supplied' do
+            error = assert_raises ArgumentError do
+              ESP::StatRegion.for_stat
+            end
+            assert_equal 'You must supply a stat id.', error.message
+          end
+
+          should 'call the api' do
+            stub_region = stub_request(:get, %r{stats/5/regions.json*}).to_return(body: json_list(:stat_region, 2))
+
+            regions = ESP::StatRegion.for_stat(5)
+
+            assert_requested(stub_region)
+            assert_equal ESP::StatRegion, regions.resource_class
+          end
+        end
+        context '.find' do
+          should 'throw an error if stat_id is not supplied' do
+            error = assert_raises ArgumentError do
+              ESP::StatRegion.find(:all, params: { id: 3 })
+            end
+            assert_equal 'You must supply a stat id.', error.message
+          end
+
+          should 'call the show api and return a region if searching by id' do
+            stub_region = stub_request(:get, %r{regions/5.json*}).to_return(body: json(:stat_region))
+
+            region = ESP::StatRegion.find(5)
+
+            assert_requested(stub_region)
+            assert_equal ESP::StatRegion, region.class
+          end
+
+          should 'call the api and return regions when stat_id is supplied' do
+            stub_region = stub_request(:get, %r{stats/5/regions.json*}).to_return(body: json_list(:stat_region, 2))
+
+            regions = ESP::StatRegion.find(:all, params: { stat_id: 5 })
+
+            assert_requested(stub_region)
+            assert_equal ESP::StatRegion, regions.resource_class
+          end
+        end
+
+        context '#create' do
+          should 'not be implemented' do
+            assert_raises ESP::NotImplementedError do
+              ESP::StatRegion.create(name: 'test')
+            end
+          end
+        end
+
+        context '#update' do
+          should 'not be implemented' do
+            region = ESP::StatRegion.new
+            assert_raises ESP::NotImplementedError do
+              region.save
+            end
+          end
+        end
+
+        context '#destroy' do
+          should 'not be implemented' do
+            s = ESP::StatRegion.new
+            assert_raises ESP::NotImplementedError do
+              s.destroy
+            end
+          end
+        end
+
+        context '#region' do
+          should 'call the show api and return the region' do
+            region_stat = ESP::StatRegion.new(region_id: 3)
+
+            stub_region = stub_request(:get, %r{regions/#{region_stat.region_id}.json*}).to_return(body: json(:region))
+
+            region = region_stat.region
+
+            assert_requested(stub_region)
+            assert_equal ESP::Region, region.class
+          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 '.for_stat' do
+            should 'return tags for stat id' do
+              report = ESP::Report.find(:first, params: { status: 'complete' })
+              skip "make sure you have a complete report" unless report.present?
+              stat_id = report.stat.id
+              stats = ESP::StatRegion.for_stat(stat_id)
+
+              assert_equal ESP::StatRegion, stats.resource_class
+            end
+          end
+        end
+      end
+    end
+  end
+end