Class: HttpObservatory::Scan

Inherits:
Base
  • Object
show all
Defined in:
lib/http_observatory/models/scan.rb

Overview

Scan Object

github.com/mozilla/http-observatory/blob/master/httpobs/docs/api.md#scan

The scan can exist in one of six states:

  • ABORTED aborted for internal technical reasons

  • FAILED failed to complete, typically due to the site being unavailable or timing out

  • FINISHED completed successfully

  • PENDING issued by the API but not yet picked up by a scanner instance

  • STARTING assigned to a scanning instance

  • RUNNING currently in the process of scanning a website

Instance Attribute Summary collapse

Attributes inherited from Base

#errors

Method Summary

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from HttpObservatory::Base

Instance Attribute Details

#end_timeObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def end_time
  @end_time
end

#gradeObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def grade
  @grade
end

#hiddenObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def hidden
  @hidden
end

#likelihood_indicatorObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def likelihood_indicator
  @likelihood_indicator
end

#response_headersObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def response_headers
  @response_headers
end

#scan_idObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def scan_id
  @scan_id
end

#scoreObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def score
  @score
end

#start_timeObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def start_time
  @start_time
end

#stateObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def state
  @state
end

#tests_failedObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def tests_failed
  @tests_failed
end

#tests_passedObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def tests_passed
  @tests_passed
end

#tests_quantityObject

timestamp for when the scan completed



17
18
19
# File 'lib/http_observatory/models/scan.rb', line 17

def tests_quantity
  @tests_quantity
end