esp_sdk 1.1.0 → 2.0.0.rc1

data/lib/esp/resources/concerns/stat_totals.rb

@@ -0,0 +1,79 @@
+module ESP::StatTotals # :nodoc:
+  # Not Implemented. You cannot create or update a Stat.
+  def save
+    fail ESP::NotImplementedError
+  end
+
+  # Not Implemented. You cannot delete a Stat.
+  def destroy
+    fail ESP::NotImplementedError
+  end
+
+  # We only add new_1w* and old* fields as the new_1w field includes the counts from new_1h and new_1d.
+  def total
+    attributes.select { |a, _v| a.match(/new_1w|old/) }.values.reduce(:+)
+  end
+
+  def total_suppressed
+    attributes.select { |a, _v| a.match(/suppressed_/) }.values.reduce(:+)
+  end
+
+  %w(fail warn error pass info).each do |status|
+    # Defines the following methods:
+    #   Stat#total_pass
+    #   Stat#total_fail
+    #   Stat#total_warn
+    #   Stat#total_error
+    #   Stat#total_info
+    define_method "total_#{status}" do
+      attributes.select { |a, _v| a.match(/new_1w|old/) && a.match(/#{status}/) }.values.reduce(:+)
+    end
+
+    # Defines the following methods:
+    #   Stat#total_new_1h_pass
+    #   Stat#total_new_1h_fail
+    #   Stat#total_new_1h_warn
+    #   Stat#total_new_1h_error
+    #   Stat#total_new_1h_info
+    #   Stat#total_new_1d_pass
+    #   Stat#total_new_1d_fail
+    #   Stat#total_new_1d_warn
+    #   Stat#total_new_1d_error
+    #   Stat#total_new_1d_info
+    #   Stat#total_new_1w_pass
+    #   Stat#total_new_1w_fail
+    #   Stat#total_new_1w_error
+    #   Stat#total_new_1w_info
+    #   Stat#total_new_1w_warn
+    #   Stat#total_old_fail
+    #   Stat#total_old_pass
+    #   Stat#total_old_warn
+    #   Stat#total_old_error
+    #   Stat#total_old_info
+    %w(new_1h new_1d new_1w old).each do |time|
+      define_method "total_#{time}_#{status}" do
+        attributes.select { |a| a.match(/#{time}/) && a.match(/#{status}/) }.values.reduce(:+)
+      end
+    end
+
+    # Defines the following methods:
+    #   Stat#total_suppressed_pass
+    #   Stat#total_suppressed_fail
+    #   Stat#total_suppressed_warn
+    #   Stat#total_suppressed_error
+    define_method "total_suppressed_#{status}" do
+      attributes.select { |a| a.match(/suppressed_/) && a.match(/#{status}/) }.values.reduce(:+)
+    end
+  end
+
+  # Defines the following methods:
+  #   Stat#total_new_1h
+  #   Stat#total_new_1d
+  #   Stat#total_new_1w
+  #   Stat#total_old
+  %w(new_1h new_1d new_1w old).each do |time|
+    define_method "total_#{time}" do
+      attributes.select { |a| a.match(/#{time}/) }.values.reduce(:+)
+    end
+  end
+end

data/lib/esp/resources/contact_request.rb

@@ -0,0 +1,42 @@
+module ESP
+  # Use contact requests to send a support or feature request to Evident.io.
+  class ContactRequest < ESP::Resource
+    # Not Implemented. You cannot search for ContactRequest.
+    def self.find(*)
+      fail ESP::NotImplementedError
+    end
+
+    # Not Implemented. You cannot update a ContactRequest.
+    def update
+      fail ESP::NotImplementedError
+    end
+
+    # Not Implemented. You cannot destroy a ContactRequest.
+    def destroy
+      fail ESP::NotImplementedError
+    end
+
+    # :method: create(attributes={})
+    # Create a contact request.
+    #
+    # ==== Parameter
+    #
+    # +attributes+ | Required | A hash of contact request attributes
+    #
+    # ===== Valid Attributes
+    #
+    # +title+ | Required | Subject of your message
+    #
+    # +description+ | Required | Body of your message
+    #
+    # +request_type+ | Required | Type of contact request. Supported values are `support` for support requests and `feature` for a feature request
+    #
+    #
+    # :call-seq:
+    #  create(attributes={})
+    #
+    # ==== Example
+    #
+    #   contact_request = ESP::ContactRequest.create(request_type: 'feature', title: 'My great feature idea', description: 'This is my idea for a really useful feature...')
+  end
+end

data/lib/esp/resources/custom_signature.rb

@@ -0,0 +1,224 @@
+module ESP
+  class CustomSignature < ESP::Resource
+    ##
+    # The organization this custom signature belongs to.
+    belongs_to :organization, class_name: 'ESP::Organization'
+
+    # 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.
+    #
+    # ==== Parameters
+    #
+    # +arguments+ | Required | A hash of run arguments
+    #
+    # ===== Valid Arguments
+    #
+    # +external_account_id+ | Required | The ID of the external account to run this custom signature against
+    #
+    # +signature+ | Required | The code for this custom signature
+    #
+    # +language+ | Required | The language of the custom signature. Possible values are `ruby` or `javascript`
+    #
+    # +regions+ | Required | Array of region names to run this custom signature against
+    #
+    # ==== Example
+    #   signature = "# Demo Ruby Signature\r\nconfigure do |c|\r\n  # Set regions to run in. Remove this line to run in all regions.\r\n  c.valid_regions     = [:us_east_1]\r\n  # Override region to display as global. Useful when checking resources\r\n  # like IAM that do not have a specific region.\r\n  c.display_as        = :global\r\n  # deep_inspection works with set_data to automically collect\r\n  # data fields for each alert. Not required.\r\n  c.deep_inspection   = [:users]\r\nend\r\n\r\n# Required perform method\r\ndef perform(aws)\r\n  list_users = aws.iam.list_users\r\n  count = list_users[:users].count\r\n\r\n  # Set data for deep_inspection to use\r\n  set_data(list_users)\r\n\r\n  if count == 0\r\n    fail(user_count: count, condition: 'count == 0')\r\n  else\r\n    pass(user_count: count, condition: 'count >= 1')\r\n  end\r\nend\r\n"
+    #   alerts = ESP::CustomSignature.run!(external_account_id: 3, regions: ['us_east_1'], language: 'ruby', signature: signature)
+    def self.run!(arguments = {})
+      result = run(arguments)
+      return result if result.is_a?(ActiveResource::Collection)
+      result.message = result.errors.full_messages.join(' ')
+      fail(ActiveResource::ResourceInvalid.new(result)) # rubocop:disable Style/RaiseArgs
+    end
+
+    # Run a custom signature that has not been saved.  Useful for debugging a custom signature.
+    # Returns a collection of alerts.
+    # If not successful, returns a CustomSignature object with the errors object populated.
+    #
+    # ==== Parameters
+    #
+    # +arguments+ | Required | A hash of run arguments
+    #
+    # ===== Valid Arguments
+    #
+    # +external_account_id+ | Required | The ID of the external account to run this custom signature against
+    #
+    # +signature+ | Required | The code for this custom signature
+    #
+    # +language+ | Required | The language of the custom signature. Possible values are `ruby` or `javascript`
+    #
+    # +regions+ | Required | Array of region names to run this custom signature against
+    #
+    # ==== Example
+    #   signature = "# Demo Ruby Signature\r\nconfigure do |c|\r\n  # Set regions to run in. Remove this line to run in all regions.\r\n  c.valid_regions     = [:us_east_1]\r\n  # Override region to display as global. Useful when checking resources\r\n  # like IAM that do not have a specific region.\r\n  c.display_as        = :global\r\n  # deep_inspection works with set_data to automically collect\r\n  # data fields for each alert. Not required.\r\n  c.deep_inspection   = [:users]\r\nend\r\n\r\n# Required perform method\r\ndef perform(aws)\r\n  list_users = aws.iam.list_users\r\n  count = list_users[:users].count\r\n\r\n  # Set data for deep_inspection to use\r\n  set_data(list_users)\r\n\r\n  if count == 0\r\n    fail(user_count: count, condition: 'count == 0')\r\n  else\r\n    pass(user_count: count, condition: 'count >= 1')\r\n  end\r\nend\r\n"
+    #   alerts = ESP::CustomSignature.run(external_account_id: 3, regions: ['us_east_1'], language: 'ruby', signature: signature)
+    def self.run(arguments = {})
+      arguments = arguments.with_indifferent_access
+      arguments[:regions] = Array(arguments[:regions])
+      new(arguments).run
+    end
+
+    # Run this custom signature instance.
+    # Returns a collection of alerts.
+    # Throws an error if not successful.
+    #
+    # ==== Parameters
+    #
+    # +arguments+ | Required | A hash of run arguments
+    #
+    # ===== Valid Arguments
+    #
+    # +external_account_id+ | Required | The ID of the external account to run this custom signature against
+    #
+    # +regions+ | Required | Array of region names to run this custom signature against
+    #
+    # ==== Example
+    #   custom_signature = ESP::CustomSignature.find(365)
+    #   alerts = custom_signature.run!(external_account_id: 3, regions: ['us_east_1'])
+    def run!(arguments = {})
+      result = run(arguments)
+      return result if result.is_a?(ActiveResource::Collection)
+      self.message = errors.full_messages.join(' ')
+      fail(ActiveResource::ResourceInvalid.new(self)) # rubocop:disable Style/RaiseArgs
+    end
+
+    # Run this custom signature instance.
+    # Returns a collection of alerts.
+    # If not successful, returns a CustomSignature object with the errors object populated.
+    #
+    # ==== Parameters
+    #
+    # +arguments+ | Required | A hash of run arguments
+    #
+    # ===== Valid Arguments
+    #
+    # +external_account_id+ | Required | The ID of the external account to run this custom signature against
+    #
+    # +regions+ | Required | Array of region names to run this custom signature against
+    #
+    # ==== Example
+    #   custom_signature = ESP::CustomSignature.find(365)
+    #   alerts = custom_signature.run(external_account_id: 3, regions: ['us_east_1'])
+    def run(arguments = {})
+      arguments = arguments.with_indifferent_access
+
+      attributes['external_account_id'] ||= arguments[:external_account_id]
+      attributes['regions'] ||= Array(arguments[:regions])
+
+      response = connection.post endpoint, to_json
+      ESP::Alert.send(:instantiate_collection, self.class.format.decode(response.body))
+    rescue ActiveResource::BadRequest, ActiveResource::ResourceInvalid, ActiveResource::ResourceNotFound => error
+      load_remote_errors(error, true)
+      self.code = error.response.code
+      self
+    end
+
+    # Create a suppression for this custom signature.
+    #
+    # ==== Parameter
+    #
+    # +arguments+ | Required | A hash of signature suppression attributes
+    #
+    # ===== Valid Arguments
+    #
+    # +regions+ | Required | An array of region names to suppress.
+    #
+    # +external_account_ids+ | Required | An Array of the external accounts identified by +external_account_id+ to suppress the signature or custom signature on.
+    #
+    # +reason+ | Required | The reason for creating the suppression.
+    #
+    # ==== Example
+    #   suppress(regions: ['us_east_1'], external_account_ids: [5], reason: 'My very good reason for creating this suppression')
+    def suppress(arguments = {})
+      arguments = arguments.with_indifferent_access
+      ESP::Suppression::Signature.create(custom_signature_ids: [id], regions: Array(arguments[:regions]), external_account_ids: Array(arguments[:external_account_ids]), reason: arguments[:reason])
+    end
+
+    ##
+    # :singleton-method: find
+    # Find a CustomSignature by id
+    #
+    # ==== Parameter
+    #
+    # +id+ | Required | The ID of the custom signature to retrieve
+    #
+    # :call-seq:
+    #  find(id)
+
+    # :singleton-method: all
+    # Return a paginated CustomSignature list
+
+    # :singleton-method: create
+    # Create a CustomSignature
+    # :call-seq:
+    #   create(attributes={})
+    #
+    # ==== Parameter
+    #
+    # +attributes+ | Required | A hash of custom signature attributes
+    #
+    # ===== Valid Attributes
+    #
+    # +active+ | Not Required | Flag that determines if this custom signature should run on reports
+    #
+    # +description+ | Not Required | The description of the custom signature that is displayed on alerts
+    #
+    # +identifier+ | Required | The identifier to use for the custom signature. Common format is AWS:<Service>-<Number> such as AWS:IAM-001
+    #
+    # +language+ | Required | The language of the custom signature. Possible values are `ruby` or `javascript`
+    #
+    # +name+ | Required | The name of the custom signature
+    #
+    # +resolution+ | Not Required | Details for how to resolve this custom signature that is displayed on alerts
+    #
+    # +risk_level+ | Required | The risk-level of the problem identified by the custom signature
+    #
+    # +signature+ | Required | The code for this custom signature
+    #
+    # ==== Example
+    #
+    #  signature = "# Demo Ruby Signature\r\nconfigure do |c|\r\n  # Set regions to run in. Remove this line to run in all regions.\r\n  c.valid_regions     = [:us_east_1]\r\n  # Override region to display as global. Useful when checking resources\r\n  # like IAM that do not have a specific region.\r\n  c.display_as        = :global\r\n  # deep_inspection works with set_data to automically collect\r\n  # data fields for each alert. Not required.\r\n  c.deep_inspection   = [:users]\r\nend\r\n\r\n# Required perform method\r\ndef perform(aws)\r\n  list_users = aws.iam.list_users\r\n  count = list_users[:users].count\r\n\r\n  # Set data for deep_inspection to use\r\n  set_data(list_users)\r\n\r\n  if count == 0\r\n    fail(user_count: count, condition: 'count == 0')\r\n  else\r\n    pass(user_count: count, condition: 'count >= 1')\r\n  end\r\nend\r\n"
+    #  custom_signature = ESP::CustomSignature.create(signature: signature, description: "A test custom signature.", identifier: "AWS::IAM::001", language: "ruby", name: "Test Signature", risk_level: "Medium")
+
+    # :method: save
+    # Create or update a CustomSignature
+    #
+    # ===== Valid Attributes
+    #
+    # +active+ | Not Required | Flag that determines if this custom signature should run on reports
+    #
+    # +description+ | Not Required | The description of the custom signature that is displayed on alerts
+    #
+    # +identifier+ | Required | The identifier to use for the custom signature. Common format is AWS:<Service>-<Number> such as AWS:IAM-001
+    #
+    # +language+ | Required | The language of the custom signature. Possible values are `ruby` or `javascript`
+    #
+    # +name+ | Required | The name of the custom signature
+    #
+    # +resolution+ | Not Required | Details for how to resolve this custom signature that is displayed on alerts
+    #
+    # +risk_level+ | Required | The risk-level of the problem identified by the custom signature
+    #
+    # +signature+ | Required | The code for this custom signature
+    #
+    # ==== Example
+    #
+    #  signature = "# Demo Ruby Signature\r\nconfigure do |c|\r\n  # Set regions to run in. Remove this line to run in all regions.\r\n  c.valid_regions     = [:us_east_1]\r\n  # Override region to display as global. Useful when checking resources\r\n  # like IAM that do not have a specific region.\r\n  c.display_as        = :global\r\n  # deep_inspection works with set_data to automically collect\r\n  # data fields for each alert. Not required.\r\n  c.deep_inspection   = [:users]\r\nend\r\n\r\n# Required perform method\r\ndef perform(aws)\r\n  list_users = aws.iam.list_users\r\n  count = list_users[:users].count\r\n\r\n  # Set data for deep_inspection to use\r\n  set_data(list_users)\r\n\r\n  if count == 0\r\n    fail(user_count: count, condition: 'count == 0')\r\n  else\r\n    pass(user_count: count, condition: 'count >= 1')\r\n  end\r\nend\r\n"
+    #  custom_signature = ESP::CustomSignature.new(signature: signature, description: "A test custom signature.", identifier: "AWS::IAM::001", language: "ruby", name: "Test Signature", risk_level: "Medium")
+    #  custom_signature.save
+
+    # :method: destroy
+    # Delete a CustomSignature
+
+    private
+
+    def endpoint
+      if id.present?
+        "#{self.class.prefix}custom_signatures/#{id}/run.json"
+      else
+        "#{self.class.prefix}custom_signatures/run.json"
+      end
+    end
+  end
+end

data/lib/esp/resources/dashboard.rb

@@ -0,0 +1,31 @@
+module ESP
+  class Dashboard < ESP::Resource
+    # Not Implemented. You cannot search for Suppression::Region.
+    #
+    # Regular ARELlike methods are disabled.
+    def self.find(*)
+      fail ESP::NotImplementedError, 'Regular ARELlike methods are disabled.  Use either the .recent method.'
+    end
+
+    # Not Implemented. You cannot create or update a Dashboard.
+    def save
+      fail ESP::NotImplementedError
+    end
+
+    # Not Implemented. You cannot destroy a Dashboard.
+    def destroy
+      fail ESP::NotImplementedError
+    end
+
+    # Returns a Dashboard object with data from reports run in the last 2 hours
+    #
+    # ==== Note
+    #
+    # The dashboard is used internally for the dashboard page on esp.evident.io and is therefore not considered
+    # part of the public API and may change without notice.
+    def self.recent
+      # call find_every directly since find is overridden/not implemented
+      find_every from: "#{prefix}dashboard/recent.#{format.extension}"
+    end
+  end
+end

data/lib/esp/resources/external_account.rb

@@ -0,0 +1,89 @@
+module ESP
+  class ExternalAccount < ESP::Resource
+    ##
+    # The organization the external account belongs to.
+    belongs_to :organization, class_name: 'ESP::Organization'
+
+    ##
+    # The sub_organization the external account belongs to.
+    belongs_to :sub_organization, class_name: 'ESP::SubOrganization'
+
+    ##
+    # The team the external account belongs to.
+    belongs_to :team, class_name: 'ESP::Team'
+
+    # Helper to generate an external id.
+    # Called automatically when creating an ExternalAccount if +external_id+ is not already set.
+    def generate_external_id
+      SecureRandom.uuid
+    end
+
+    # This instance method is called by the #save method when new? is true.
+    def create # :nodoc:
+      attributes['external_id'] ||= generate_external_id
+      super
+    end
+
+    ##
+    # :singleton-method: find
+    # Find an ExternalAccount by id
+    #
+    # ==== Parameter
+    #
+    # +id+ | Required | The ID of the external account to retrieve
+    #
+    # :call-seq:
+    #  find(id)
+
+    # :singleton-method: all
+    # Return a paginated CustomSignature list
+
+    # :singleton-method: create
+    # Create an ExternalAccount.
+    # :call-seq:
+    #   create(attributes={})
+    #
+    # ==== Parameter
+    #
+    # +attributes+ | Required | A hash of external account attributes
+    #
+    # ===== Valid Attributes
+    #
+    # +arn+ | Required | Amazon Resource Name for the IAM role
+    #
+    # +external_id+ | Required | External identifier set on the role.  This will be set by calling #generate_external_id if not already set.
+    #
+    # +name+ | Not Required |  The name for this external account
+    #
+    # +sub_organization_id+ | Required | The ID of the sub organization the external account will belong to
+    #
+    # +team_id+ | Required | The ID of the team the external account will belong to
+    #
+    # ==== Example
+    #
+    #  external_account = ESP::ExternalAccount.create(arn: 'arn:from:aws', external_id: 'c40e6af4-a5a0-422a-9a42-3d7d236c3428', sub_organization_id: 4, team_id: 8)
+
+    # :method: save
+    # Create or update an ExternalAccount.
+    #
+    # ===== Valid Attributes
+    #
+    # +arn+ | Required | Amazon Resource Name for the IAM role
+    #
+    # +external_id+ | Required | External identifier set on the role.  This will be set by calling #generate_external_id if not already set.
+    #
+    # +name+ | Not Required |  The name for this external account
+    #
+    # +sub_organization_id+ | Required | The ID of the sub organization the external account will belong to
+    #
+    # +team_id+ | Required | The ID of the team the external account will belong to
+    #
+    # ==== Example
+    #
+    #  external_account = ESP::ExternalAccount.new(arn: 'arn:from:aws', external_id: 'c40e6af4-a5a0-422a-9a42-3d7d236c3428', sub_organization_id: 4, team_id: 8)
+    #  external_account.save
+
+    # :method: destroy
+    # Delete a CustomSignature
+  end
+end

data/lib/esp/resources/organization.rb

@@ -0,0 +1,61 @@
+module ESP
+  class Organization < ESP::Resource
+    ##
+    # The collection of teams that belong to the organization.
+    has_many :teams, class_name: 'ESP::Team'
+
+    ##
+    # The collection of sub_organizations that belong to the organization.
+    has_many :sub_organizations, class_name: 'ESP::SubOrganization'
+
+    ##
+    # The collection of users that belong to the organization.
+    has_many :users, class_name: 'ESP::User'
+
+    ##
+    # The collection of reports that belong to the organization.
+    has_many :reports, class_name: 'ESP::Report'
+
+    ##
+    # The collection of external_accounts that belong to the organization.
+    has_many :external_accounts, class_name: 'ESP::ExternalAccount'
+
+    ##
+    # The collection of organizations that belong to the organization.
+    has_many :custom_signatures, class_name: 'ESP::CustomSignature'
+
+    # Not Implemented. You cannot create an Organization.
+    def create # :nodoc:
+      fail ESP::NotImplementedError
+    end
+
+    # Not Implemented. You cannot destroy an Organization.
+    def destroy
+      fail ESP::NotImplementedError
+    end
+
+    ##
+    # :singleton-method: find
+    # Find a Organization by id
+    #
+    # ==== Parameter
+    #
+    # +id+ | Required | The ID of the organization to retrieve
+    #
+    # :call-seq:
+    #  find(id)
+
+    # :singleton-method: all
+    # Return a paginated Organization list
+
+    # :singleton-method: create
+    # Not Implemented. You cannot create an Organization.
+
+    # :method: save
+    # Update an Organization.
+    #
+    # ==== Valid Attributes
+    #
+    # +name+ | Not Required | The new name of the organization
+  end
+end

data/lib/esp/resources/region.rb

@@ -0,0 +1,46 @@
+module ESP
+  class Region < ESP::Resource
+    # Not Implemented. You cannot create or update a CloudTrailEvent.
+    def save
+      fail ESP::NotImplementedError
+    end
+
+    # Not Implemented. You cannot destroy a an CloudTrailEvent.
+    def destroy
+      fail ESP::NotImplementedError
+    end
+
+    # Create a suppression for this region.
+    #
+    # ==== Parameter
+    #
+    # +arguments+ | Required | A hash of region suppression attributes
+    #
+    # ===== Valid Arguments
+    #
+    # +external_account_ids+ | Required | An Array of the external accounts identified by +external_account_id+ to suppress the signature or custom signature on.
+    #
+    # +reason+ | Required | The reason for creating the suppression.
+    #
+    # ==== Example
+    #   suppress(external_account_ids: [5], reason: 'My very good reason for creating this suppression')
+    def suppress(arguments = {})
+      arguments = arguments.with_indifferent_access
+      ESP::Suppression::Region.create(regions: [code], external_account_ids: Array(arguments[:external_account_ids]), reason: arguments[:reason])
+    end
+
+    ##
+    # :singleton-method: find
+    # Find a Region by id
+    #
+    # ==== Parameter
+    #
+    # +id+ | Required | The ID of the region to retrieve
+    #
+    # :call-seq:
+    #  find(id)
+
+    # :singleton-method: all
+    # Return a paginated Region list
+  end
+end

data/lib/esp/resources/report.rb

@@ -0,0 +1,100 @@
+module ESP
+  class Report < ESP::Resource
+    ##
+    # The organization the report belongs to.
+    belongs_to :organization, class_name: 'ESP::Organization'
+
+    ##
+    # The sub_organization the report belongs to.
+    belongs_to :sub_organization, class_name: 'ESP::SubOrganization'
+
+    ##
+    # The team the report belongs to.
+    belongs_to :team, class_name: 'ESP::Team'
+
+    # Not Implemented. You cannot create or update a Report.
+    def update
+      fail ESP::NotImplementedError
+    end
+
+    # Not Implemented. You cannot destroy a Report.
+    def destroy
+      fail ESP::NotImplementedError
+    end
+
+    # Enqueue a report to be run for the given team.
+    # Returns a Report object with a status of 'queued' and an id
+    # ==== Attribute
+    #
+    # +team_id+ | Required | The ID of the team to create a report for
+    #
+    # Periodically check the API
+    #   ESP::Report.find(<id>)
+    # until status is 'complete'.
+    #
+    # If not successful, returns a Report object with the errors object populated.
+    def self.create(arguments = {})
+      fail ArgumentError, "You must supply a team id." unless arguments.with_indifferent_access[:team_id].present?
+      super
+    rescue ActiveResource::ResourceNotFound => error
+      new(arguments).tap { |r| r.load_remote_errors(error, true) }
+    end
+
+    # Returns a paginated collection of alerts for the report
+    #
+    # ==== Parameters
+    #
+    # +arguments+ | Not Required | An optional hash of search criteria to filter the returned collection
+    #
+    # ===== Valid Arguments
+    #
+    # +region_id+ | Not Required | Return only alerts for this region.
+    #
+    # +status+ | Not Required | Return only alerts for the give status(es).  Valid values are fail, warn, error, pass, info
+    #
+    # +first_seen+ | Not Required | Return only alerts that have started within a number of hours of the report. For example, first_seen of 3 will return alerts that started showing up within the last 3 hours of the report.
+    #
+    # +suppressed+ | Not Required | Return only suppressed alerts
+    #
+    # +team_id+ | Not Required | Return only alerts for the given team.
+    #
+    # +external_account_id+ | Not Required | Return only alerts for the given external id.
+    #
+    # +service_id+ | Not Required | Return only alerts on signatures with the given service.
+    #
+    # +signature_severity+ | Not Required | Return only alerts for signatures with the given risk_level.  Valid values are Low, Medium, High
+    #
+    # +signature_name+ | Not Required | Return only alerts for signatures with the given name.
+    #
+    # +resource+ | Not Required | Return only alerts for the given resource or tag.
+    #
+    # +signature_identifier+ | Not Required | Return only alerts for signatures with the given identifier.
+    #
+    # ==== Example
+    #
+    #   report = ESP::Report.find(345)
+    #   alerts = report.alerts(status: 'fail', signature_severity: 'High')
+    def alerts(arguments = {})
+      ESP::Alert.for_report(id, arguments)
+    end
+
+    # Returns the stats for this report
+    def stat
+      ESP::Stat.for_report(id)
+    end
+
+    ##
+    # :singleton-method: find
+    # Find a Report by id
+    #
+    # ==== Parameter
+    #
+    # +id+ | Required | The ID of the report to retrieve
+    #
+    # :call-seq:
+    #  find(id)
+
+    # :singleton-method: all
+    # Return a paginated Report list
+  end
+end