Class: Aquatone::Collector

Inherits:

Object

• Object
• Aquatone::Collector

Defined in:

lib/aquatone/collector.rb

Direct Known Subclasses

Aquatone::Collectors::Censys, Aquatone::Collectors::Crtsh, Aquatone::Collectors::Dictionary, Aquatone::Collectors::Dnsdb, Aquatone::Collectors::Gtr, Aquatone::Collectors::Hackertarget, Aquatone::Collectors::Netcraft, Aquatone::Collectors::Passivetotal, Aquatone::Collectors::Riddler, Aquatone::Collectors::Shodan, Aquatone::Collectors::Threatcrowd, Aquatone::Collectors::Virustotal

Defined Under Namespace

Classes: Error, InvalidMetadataError, MetadataNotSetError, MissingKeyRequirement

Constant Summary

DEFAULT_PRIORITY =

1

Instance Attribute Summary

• #domain ⇒ Object readonly

  Returns the value of attribute domain.

• #hosts ⇒ Object readonly

  Returns the value of attribute hosts.

Class Method Summary

• .descendants ⇒ Object
• .meta ⇒ Object
• .meta=(meta) ⇒ Object
• .priority ⇒ Object
• .sluggified_name ⇒ Object

Instance Method Summary

• #execute! ⇒ Object
• #initialize(domain) ⇒ Collector constructor

  A new instance of Collector.

• #run ⇒ Object

Constructor Details

#initialize(domain) ⇒ Collector

Returns a new instance of Collector.

# File 'lib/aquatone/collector.rb', line 31

def initialize(domain)
  check_key_requirements!
  @domain = domain
  @hosts  = []
end

Instance Attribute Details

#domain ⇒ Object (readonly)

Returns the value of attribute domain.

# File 'lib/aquatone/collector.rb', line 8

def domain
  @domain
end

#hosts ⇒ Object (readonly)

Returns the value of attribute hosts.

# File 'lib/aquatone/collector.rb', line 8

def hosts
  @hosts
end

Class Method Details

.descendants ⇒ Object

# File 'lib/aquatone/collector.rb', line 21

def self.descendants
  collectors = ObjectSpace.each_object(Class).select { |klass| klass < self }
  collectors.sort { |x, y| x.priority <=> y.priority }
end

.meta ⇒ Object

# File 'lib/aquatone/collector.rb', line 12

def self.meta
  @meta || fail(MetadataNotSetError, "Metadata has not been set")
end

.meta=(meta) ⇒ Object

# File 'lib/aquatone/collector.rb', line 16

def self.meta=(meta)
  validate_metadata(meta)
  @meta = meta
end

.priority ⇒ Object

# File 'lib/aquatone/collector.rb', line 46

def self.priority
  meta[:priority] || DEFAULT_PRIORITY
end

.sluggified_name ⇒ Object

# File 'lib/aquatone/collector.rb', line 26

def self.sluggified_name
  return meta[:slug].downcase if meta[:slug]
  meta[:name].strip.downcase.gsub(/[^a-z0-9]+/, '-').gsub("--", "-")
end

Instance Method Details

#execute! ⇒ Object

# File 'lib/aquatone/collector.rb', line 41

def execute!
  run
  hosts
end

#run ⇒ Object

# File 'lib/aquatone/collector.rb', line 37

def run
  fail NotImplementedError
end