Class: Aquatone::Detector

Inherits:

Object

• Object
• Aquatone::Detector

Defined in:

lib/aquatone/detector.rb

Direct Known Subclasses

Aquatone::Detectors::CampaignMonitor, Aquatone::Detectors::Cargo, Aquatone::Detectors::Cloudfront, Aquatone::Detectors::Desk, Aquatone::Detectors::Fastly, Aquatone::Detectors::Feedpress, Aquatone::Detectors::Freshdesk, Aquatone::Detectors::Ghost, Aquatone::Detectors::GithubPages, Aquatone::Detectors::Helpjuice, Aquatone::Detectors::Helpscout, Aquatone::Detectors::Heroku, Aquatone::Detectors::Instapage, Aquatone::Detectors::Pingdom, Aquatone::Detectors::S3, Aquatone::Detectors::Shopify, Aquatone::Detectors::Statuspage, Aquatone::Detectors::Surveygizmo, Aquatone::Detectors::Teamwork, Aquatone::Detectors::Tictail, Aquatone::Detectors::Tumblr, Aquatone::Detectors::Unbounce, Aquatone::Detectors::Uservoice, Aquatone::Detectors::Wpengine, Aquatone::Detectors::Zendesk

Defined Under Namespace

Classes: Error, InvalidMetadataError, MetadataNotSetError

Instance Attribute Summary

• #host ⇒ Object readonly

  Returns the value of attribute host.

• #resource ⇒ Object readonly

  Returns the value of attribute resource.

Class Method Summary

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

Instance Method Summary

• #initialize(host, resource) ⇒ Detector constructor

  A new instance of Detector.

• #positive? ⇒ Boolean
• #run ⇒ Object

Constructor Details

#initialize(host, resource) ⇒ Detector

Returns a new instance of Detector.

# File 'lib/aquatone/detector.rb', line 28

def initialize(host, resource)
  @host     = host
  @resource = resource
end

Instance Attribute Details

#host ⇒ Object (readonly)

Returns the value of attribute host.

# File 'lib/aquatone/detector.rb', line 7

def host
  @host
end

#resource ⇒ Object (readonly)

Returns the value of attribute resource.

# File 'lib/aquatone/detector.rb', line 7

def resource
  @resource
end

Class Method Details

.descendants ⇒ Object

# File 'lib/aquatone/detector.rb', line 18

def self.descendants
  detectors = ObjectSpace.each_object(Class).select { |klass| klass < self }
  detectors.sort { |x, y| x.meta[:service] <=> y.meta[:service] }
end

.meta ⇒ Object

# File 'lib/aquatone/detector.rb', line 9

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

.meta=(meta) ⇒ Object

# File 'lib/aquatone/detector.rb', line 13

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

.sluggified_name ⇒ Object

# File 'lib/aquatone/detector.rb', line 23

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

Instance Method Details

#positive? ⇒ Boolean

Returns:

• (Boolean)

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

def positive?
  run
rescue
  false
end

#run ⇒ Object

# File 'lib/aquatone/detector.rb', line 33

def run
  fail NotImplementedError
end