Class: ScoutScout

Inherits:

Object

• Object
• ScoutScout

Includes:

HTTParty

Defined in:

lib/scout_scout.rb,
lib/scout_scout/version.rb

Defined Under Namespace

Classes: Alert, Client, Descriptor, Plugin

Constant Summary

VERSION =

'0.0.3'

Instance Method Summary

• #alerts ⇒ Array

  Recent alerts across all clients on this account.

• #clients ⇒ Array

  All clients on this account.

• #initialize(scout_account_name, username, password) ⇒ ScoutScout constructor

  A new instance of ScoutScout.

Constructor Details

#initialize(scout_account_name, username, password) ⇒ ScoutScout

Returns a new instance of ScoutScout.

# File 'lib/scout_scout.rb', line 15

def initialize(scout_account_name, username, password)
  self.class.account = scout_account_name
  self.class.basic_auth username, password
end

Instance Method Details

#alerts ⇒ Array

Recent alerts across all clients on this account

Returns:

• (Array) —

  An array of ScoutScout::Alert objects

# File 'lib/scout_scout.rb', line 23

def alerts
  response = self.class.get("/#{self.class.account}/activities.xml")
  response['alerts'].map { |alert| ScoutScout::Alert.new(alert) }
end

#clients ⇒ Array

All clients on this account

Returns:

• (Array) —

  An array of ScoutScout::Client objects

# File 'lib/scout_scout.rb', line 31

def clients
  response = self.class.get("/#{self.class.account}/clients.xml")
  response['clients'].map { |client| ScoutScout::Client.new(client) }
end