Class: ESP::Tag

Inherits:
Resource show all
Defined in:
lib/esp/resources/tag.rb

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Dirty

#changed_attributes, #original_attributes, #original_attributes=

Methods included from LoadWithOriginalAttributes

#load

Class Method Details

.find(id) ⇒ Object .find(scope, options) ⇒ Object

Find a Tag by id

call-seq -> super.find(id)

Overloads:

  • .find(id) ⇒ Object

    Parameters:

    • id (Integer, Numeric) —

      Required ID of the tag to retrieve.

  • .find(scope, options) ⇒ Object

    This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

    call-seq -> super.all(options)

    Parameters:

    • scope (Object) —

      Example: :all

    • options (Hash) —

      params: { alert_id: Integer }

    Raises:

    • (ArgumentError) —

      if no alert_id is supplied.



50
51
52
53
54
55
56
57
 
# File 'lib/esp/resources/tag.rb', line 50

def self.find(*arguments)
  scope = arguments.slice!(0)
  options = (arguments.slice!(0) || {}).with_indifferent_access
  return super(scope, options) if scope.is_a?(Numeric) || options[:from].present?
  params = options.fetch(:params, {}).with_indifferent_access
  alert_id = params.delete(:alert_id)
  for_alert(alert_id)
end

.for_alert(alert_id = nil) ⇒ ActiveResource::PaginatedCollection<ESP::Tag>

Returns a paginated collection of tags for the given alert_id Convenience method to use instead of find since an alert_id is required to return tags.

Examples:

alerts = ESP::Tag.for_alert(1194)

Parameters:

  • alert_id (Integer, Numeric) (defaults to: nil) —

    Required ID of the alert to list tags for.

Returns:

Raises:

  • (ArgumentError) —

    if no alert_id is supplied.



32
33
34
35
36
 
# File 'lib/esp/resources/tag.rb', line 32

def self.for_alert(alert_id = nil)
  fail ArgumentError, "You must supply an alert id." unless alert_id.present?
  from = "#{prefix}alerts/#{alert_id}/tags.json"
  find(:all, from: from)
end

.where ⇒ void

This method returns an undefined value.

Not Implemented. You cannot search for a Tag.



20
21
22
 
# File 'lib/esp/resources/tag.rb', line 20

def self.where(*)
  fail ESP::NotImplementedError
end

Instance Method Details

#destroy ⇒ void

This method returns an undefined value.

Not Implemented. You cannot destroy a Tag.



13
14
15
 
# File 'lib/esp/resources/tag.rb', line 13

def destroy
  fail ESP::NotImplementedError
end

#save ⇒ void

This method returns an undefined value.

Not Implemented. You cannot create or update a Tag.



6
7
8
 
# File 'lib/esp/resources/tag.rb', line 6

def save
  fail ESP::NotImplementedError
end