esp_sdk 1.1.0 → 2.0.0.rc1

data/test/esp/resources/dashboard_test.rb

@@ -0,0 +1,71 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class DashboardTest < ActiveSupport::TestCase
+    context ESP::Dashboard do
+      context '#find' do
+        should 'not be implemented' do
+          assert_raises ESP::NotImplementedError do
+            ESP::Dashboard.find(4)
+          end
+        end
+      end
+
+      context '#create' do
+        should 'not be implemented' do
+          assert_raises ESP::NotImplementedError do
+            ESP::Dashboard.create(name: 'test')
+          end
+        end
+      end
+
+      context '#update' do
+        should 'not be implemented' do
+          d = build(:dashboard)
+          assert_raises ESP::NotImplementedError do
+            d.save
+          end
+        end
+      end
+
+      context '#destroy' do
+        should 'not be implemented' do
+          d = build(:dashboard)
+          assert_raises ESP::NotImplementedError do
+            d.destroy
+          end
+        end
+      end
+
+      context '.recent' do
+        should 'call the api and return an array of dashboard objects' do
+          stubbed_dashboard = stub_request(:get, %r{dashboard/recent.json*}).to_return(body: json_list(:dashboard, 2))
+
+          dashboard = ESP::Dashboard.recent
+
+          assert_requested(stubbed_dashboard)
+          assert_equal ESP::Dashboard, dashboard.resource_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 '.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

data/test/esp/resources/external_account_test.rb

@@ -0,0 +1,125 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class ExternalAccountTest < ActiveSupport::TestCase
+    context ESP::ExternalAccount do
+      context '#organization' do
+        should 'call the api' do
+          external_account = build(:external_account, organization_id: 4)
+          stub_org = stub_request(:get, %r{organizations/#{external_account.organization_id}.json*}).to_return(body: json(:organization))
+
+          external_account.organization
+
+          assert_requested(stub_org)
+        end
+      end
+
+      context '#sub_organization' do
+        should 'call the api' do
+          external_account = build(:external_account, sub_organization_id: 4)
+          stub_sub_org = stub_request(:get, %r{sub_organizations/#{external_account.sub_organization_id}.json*}).to_return(body: json(:sub_organization))
+
+          external_account.sub_organization
+
+          assert_requested(stub_sub_org)
+        end
+      end
+
+      context '#team' do
+        should 'call the api' do
+          external_account = build(:external_account, team_id: 4)
+          stub_team = stub_request(:get, %r{teams/#{external_account.team_id}.json*}).to_return(body: json(:team))
+
+          external_account.team
+
+          assert_requested(stub_team)
+        end
+      end
+
+      context '#create' do
+        should "use the external_id in the params if supplied" do
+          stub_request(:post, /external_accounts.json*/).to_return(body: json(:external_account))
+
+          ESP::ExternalAccount.create(external_id: '32145', name: 'bob')
+
+          assert_requested(:post, /external_accounts.json*/) do |req|
+            body = JSON.parse(req.body)
+            assert_equal '32145', body['data']['attributes']['external_id']
+          end
+        end
+
+        should "generate the external_id if not supplied in the params" do
+          ESP::ExternalAccount.any_instance.stubs(:generate_external_id).returns('12345')
+          stub_request(:post, /external_accounts.json*/).to_return(body: json(:external_account))
+
+          ESP::ExternalAccount.create(name: 'bob')
+
+          assert_requested(:post, /external_accounts.json*/) do |req|
+            body = JSON.parse(req.body)
+            assert_equal '12345', body['data']['attributes']['external_id']
+          end
+          assert_received(ESP::ExternalAccount.any_instance, :generate_external_id)
+        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!
+          @external_account = ESP::ExternalAccount.last
+          skip "Live DB does not have any external_accounts.  Add a external_account and run tests again." if @external_account.blank?
+        end
+
+        teardown do
+          WebMock.disable_net_connect!
+        end
+
+        context '#organization' do
+          should 'return an organization' do
+            org = @external_account.organization
+
+            assert_equal @external_account.organization_id, org.id
+          end
+        end
+
+        context '#sub_organization' do
+          should 'return a sub_organization' do
+            sub_org = @external_account.sub_organization
+
+            assert_equal @external_account.sub_organization_id, sub_org.id
+          end
+        end
+
+        context '#team' do
+          should 'return a team' do
+            team = @external_account.team
+
+            assert_equal ESP::Team, team.class
+          end
+        end
+
+        context '#CRUD' do
+          should 'be able to create, update and destroy' do
+            skip "There are to many dependencies to validate an external account to create or update one. Besides esp_web, esp_query has to be running and there must be valid AWS keys assigned as well."
+
+            external_account = ESP::ExternalAccount.create(name: 'bob', arn: @external_account.arn, sub_organization_id: @external_account.sub_organization_id, team_id: @external_account.team_id)
+
+            assert_predicate external_account, :new?
+            assert_contains external_account.errors, "The account for this ARN is already being checked by Dev"
+
+            refute_predicate @external_account, :new?
+            @external_account.name = @external_account.name
+
+            assert_predicate @external_account, :save
+
+            external_account = build(:external_account, id: 999)
+
+            assert_raises ActiveResource::ResourceNotFound do
+              external_account.destroy
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/resources/organization_test.rb

@@ -0,0 +1,175 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class OrganizationTest < ActiveSupport::TestCase
+    context ESP::Organization do
+      context '#create' do
+        should 'not be implemented' do
+          organization = build(:organization)
+          assert_raises ESP::NotImplementedError do
+            organization.save
+          end
+        end
+      end
+
+      context '#destroy' do
+        should 'not be implemented' do
+          organization = build(:organization)
+          assert_raises ESP::NotImplementedError do
+            organization.destroy
+          end
+        end
+      end
+
+      context '#teams' do
+        should 'call the api' do
+          organization = build(:organization)
+          stub_request(:get, /teams.json*/).to_return(body: json_list(:organization, 2))
+
+          organization.teams
+
+          assert_requested(:get, /teams.json*/) do |req|
+            assert_equal "filter[organization_id_eq]=#{organization.id}", URI.unescape(req.uri.query)
+          end
+        end
+      end
+
+      context '#sub_organizations' do
+        should 'call the api' do
+          organization = build(:organization)
+          stub_request(:get, /sub_organizations.json*/).to_return(body: json_list(:sub_organization, 2))
+
+          organization.sub_organizations
+
+          assert_requested(:get, /sub_organizations.json*/) do |req|
+            assert_equal "filter[organization_id_eq]=#{organization.id}", URI.unescape(req.uri.query)
+          end
+        end
+      end
+
+      context '#users' do
+        should 'call the api' do
+          organization = build(:organization)
+          stub_request(:get, /users.json*/).to_return(body: json_list(:user, 2))
+
+          organization.users
+
+          assert_requested(:get, /users.json*/) do |req|
+            assert_equal "filter[organization_id_eq]=#{organization.id}", URI.unescape(req.uri.query)
+          end
+        end
+      end
+
+      context '#reports' do
+        should 'call the api' do
+          organization = build(:organization)
+          stub_request(:get, /reports.json*/).to_return(body: json_list(:report, 2))
+
+          organization.reports
+
+          assert_requested(:get, /reports.json*/) do |req|
+            assert_equal "filter[organization_id_eq]=#{organization.id}", URI.unescape(req.uri.query)
+          end
+        end
+      end
+
+      context '#external_accounts' do
+        should 'call the api' do
+          organization = build(:organization)
+          stub_request(:get, /external_accounts.json*/).to_return(body: json_list(:external_account, 2))
+
+          organization.external_accounts
+
+          assert_requested(:get, /external_accounts.json*/) do |req|
+            assert_equal "filter[organization_id_eq]=#{organization.id}", URI.unescape(req.uri.query)
+          end
+        end
+      end
+
+      context '#custom_signatures' do
+        should 'call the api' do
+          organization = build(:organization)
+          stub_request(:get, /custom_signatures.json*/).to_return(body: json_list(:custom_signature, 2))
+
+          organization.custom_signatures
+
+          assert_requested(:get, /custom_signatures.json*/) do |req|
+            assert_equal "filter[organization_id_eq]=#{organization.id}", URI.unescape(req.uri.query)
+          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!
+          @organization = ESP::Organization.last
+          skip "Live DB does not have any sub organizations.  Add a sub organization and run tests again." if @organization.blank?
+        end
+
+        teardown do
+          WebMock.disable_net_connect!
+        end
+
+        context '#teams' do
+          should 'return teams' do
+            teams = @organization.teams
+
+            assert_equal ESP::Team, teams.resource_class
+          end
+        end
+
+        context '#sub_organizations' do
+          should 'return a sub_organization' do
+            sub_organizations = @organization.sub_organizations
+
+            assert_equal ESP::SubOrganization, sub_organizations.resource_class
+          end
+        end
+
+        context '#users' do
+          should 'return an array of users' do
+            users = @organization.users
+
+            assert_equal ESP::User, users.resource_class
+          end
+        end
+
+        context '#reports' do
+          should 'return an array of reports' do
+            reports = @organization.reports
+
+            assert_equal ESP::Report, reports.resource_class
+          end
+        end
+
+        context '#external_accounts' do
+          should 'return an array of external_accounts' do
+            external_accounts = @organization.external_accounts
+
+            assert_equal ESP::ExternalAccount, external_accounts.resource_class
+          end
+        end
+
+        context '#custom_signatures' do
+          should 'return an array of custom_signatures' do
+            custom_signatures = @organization.custom_signatures
+
+            assert_equal ESP::CustomSignature, custom_signatures.resource_class
+          end
+        end
+
+        context '#CRUD' do
+          should 'be able to update' do
+            @organization.name = @organization.name
+            @organization.save
+
+            assert_nothing_raised do
+              ESP::Organization.find(@organization.id)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/resources/region_test.rb

@@ -0,0 +1,84 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class RegionTest < ActiveSupport::TestCase
+    context ESP::Region do
+      context '#create' do
+        should 'not be implemented' do
+          assert_raises ESP::NotImplementedError do
+            ESP::Region.create(code: 'test')
+          end
+        end
+      end
+
+      context '#update' do
+        should 'not be implemented' do
+          region = build(:region)
+          assert_raises ESP::NotImplementedError do
+            region.save
+          end
+        end
+      end
+
+      context '#destroy' do
+        should 'not be implemented' do
+          region = build(:region)
+          assert_raises ESP::NotImplementedError do
+            region.destroy
+          end
+        end
+      end
+
+      context '.find' do
+        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(:region))
+
+          region = ESP::Region.find(5)
+
+          assert_requested(stub_region)
+          assert_equal ESP::Region, region.class
+        end
+      end
+
+      context '#suppress' do
+        should 'call the api' do
+          stub_request(:post, %r{suppressions/regions.json*}).to_return(body: json(:suppression_region))
+          region = build(:region)
+
+          suppression = region.suppress(external_account_ids: [5], reason: 'because')
+
+          assert_requested(:post, %r{suppressions/regions.json*}) do |req|
+            body = JSON.parse(req.body)
+            assert_equal 'because', body['data']['attributes']['reason']
+            assert_equal [region.code], body['data']['attributes']['regions']
+            assert_equal [5], body['data']['attributes']['external_account_ids']
+          end
+          assert_equal ESP::Suppression::Region, 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 '#CRUD' do
+          should 'be able to read' do
+            region = ESP::Region.last
+
+            assert_not_nil region
+
+            region = ESP::Region.find(region.id)
+
+            assert_not_nil region
+          end
+        end
+      end
+    end
+  end
+end

data/test/esp/resources/report_test.rb

@@ -0,0 +1,180 @@
+require File.expand_path(File.dirname(__FILE__) + '/../../test_helper')
+
+module ESP
+  class ReportTest < ActiveSupport::TestCase
+    context ESP::Report do
+      context '#update' do
+        should 'not be implemented' do
+          r = build(:report)
+          r.stubs(:new?).returns(false)
+
+          assert_raises ESP::NotImplementedError do
+            r.save
+          end
+        end
+      end
+
+      context '#destroy' do
+        should 'not be implemented' do
+          r = build(:report)
+
+          assert_raises ESP::NotImplementedError do
+            r.destroy
+          end
+        end
+      end
+
+      context '#organization' do
+        should 'call the api' do
+          report = build(:report, organization_id: 4)
+          stub_org = stub_request(:get, %r{organizations/#{report.organization_id}.json*}).to_return(body: json(:organization))
+
+          report.organization
+
+          assert_requested(stub_org)
+        end
+      end
+
+      context '#sub_organization' do
+        should 'call the api' do
+          report = build(:report, sub_organization_id: 4)
+          stub_sub_org = stub_request(:get, %r{sub_organizations/#{report.sub_organization_id}.json*}).to_return(body: json(:sub_organization))
+
+          report.sub_organization
+
+          assert_requested(stub_sub_org)
+        end
+      end
+
+      context '#team' do
+        should 'call the api' do
+          report = build(:report, team_id: 4)
+          stub_team = stub_request(:get, %r{teams/#{report.team_id}.json*}).to_return(body: json(:team))
+
+          report.team
+
+          assert_requested(stub_team)
+        end
+      end
+
+      context '#alerts' do
+        should 'call the api for the report and the passed in params' do
+          report = build(:report)
+          stub_request(:get, %r{reports/#{report.id}/alerts.json*}).to_return(body: json_list(:alert, 2))
+
+          report.alerts(status: 'pass')
+
+          assert_requested(:get, %r{reports/#{report.id}/alerts.json*}) do |req|
+            assert_equal "filter[status]=pass", URI.unescape(req.uri.query)
+          end
+        end
+      end
+
+      context '#stat' do
+        should 'call the api and return a stat' do
+          report = build(:report)
+          stub_stat = stub_request(:get, %r{reports/#{report.id}/stats.json*}).to_return(body: json(:stat))
+
+          stat = report.stat
+
+          assert_requested(stub_stat)
+          assert_equal ESP::Stat, stat.class
+        end
+      end
+
+      context '.create' do
+        should 'raise an error if team_id is not provided' do
+          error = assert_raises ArgumentError do
+            ESP::Report.create
+          end
+          assert_equal "You must supply a team id.", error.message
+        end
+
+        should 'call api and return a report' do
+          stubbed_report = stub_request(:post, /reports.json*/).to_return(body: json(:report))
+
+          report = ESP::Report.create(team_id: 3)
+
+          assert_requested(stubbed_report)
+          assert_equal ESP::Report, report.class
+        end
+
+        should 'call the api and return an error if an error is returned' do
+          stub_request(:post, /reports.json*/).to_return(body: json(:report))
+          error = ActiveResource::ResourceInvalid.new('oh boy')
+          error_response = json(:error)
+          response = mock(body: error_response)
+          error.stubs(:response).returns(response)
+          ESP::Report.connection.expects(:post).raises(error)
+
+          assert_nothing_raised do
+            r = ESP::Report.create(team_id: 3)
+            assert_equal JSON.parse(error_response)['errors'].first['title'], r.errors.full_messages.first
+          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!
+          @report = ESP::Report.last
+          skip "Live DB does not have any reports.  Add a report and run tests again." if @report.blank?
+        end
+
+        teardown do
+          WebMock.disable_net_connect!
+        end
+
+        context '#organization' do
+          should 'return an organization' do
+            org = @report.organization
+
+            assert_equal @report.organization_id, org.id
+          end
+        end
+
+        context '#sub_organization' do
+          should 'return a sub_organization' do
+            sub_org = @report.sub_organization
+
+            assert_equal @report.sub_organization_id, sub_org.id
+          end
+        end
+
+        context '#team' do
+          should 'return a team' do
+            team = @report.team
+
+            assert_equal ESP::Team, team.class
+          end
+        end
+
+        context '#alerts' do
+          should 'return an array of alerts' do
+            alerts = @report.alerts
+
+            assert_equal ESP::Alert, alerts.resource_class
+          end
+        end
+
+        context '#stat' do
+          should 'return a stat' do
+            stat = @report.stat
+
+            assert_equal ESP::Stat, stat.class
+          end
+        end
+
+        context '.create' do
+          should 'return an error if a bad team_id is passed' do
+            assert_nothing_raised do
+              r = ESP::Report.create(team_id: 999)
+              assert_equal "Couldn't find Team", r.errors.full_messages.first
+            end
+          end
+        end
+      end
+    end
+  end
+end