Class: ACIrb::MO

Inherits:

Object

Object
ACIrb::MO

show all

Defined in:: lib/mo.rb

Overview

A generic managed object class

Direct Known Subclasses

Class Attribute Summary collapse

.child_classes ⇒ Object readonly

for class variables.
.class_name ⇒ Object readonly

for class variables.
.containers ⇒ Object readonly

for class variables.
.naming_props ⇒ Object readonly

for class variables.
.prefix ⇒ Object readonly

for class variables.
.prefixes ⇒ Object readonly

for class variables.
.props ⇒ Object readonly

for class variables.
.read_only ⇒ Object readonly

for class variables.
.ruby_class ⇒ Object readonly

for class variables.

Instance Attribute Summary collapse

#attributes ⇒ Object readonly

for instance variables.
#children ⇒ Object readonly

for instance variables.
#dirty_props ⇒ Object

Returns the value of attribute dirty_props.
#parent ⇒ Object

Returns the value of attribute parent.

Instance Method Summary collapse

#add_child(child) ⇒ Object

Internal: Adds another MO object as a child to this class.
#build_dn ⇒ Object
#child_classes ⇒ Object

Internal: Returns child classes.
#class_name ⇒ Object

Internal: Returns object class name in APIC package.class notation.
#containers ⇒ Object

Internal: Returns containiner classes.
#create(restclient) ⇒ Object
#destroy(restclient) ⇒ Object
#exists(restclient, recurse = false) ⇒ Object
#get_attributes_to_include ⇒ Object
#get_children_to_include ⇒ Object
#hash_to_table(h) ⇒ Object
#initialize(create_parent, create_options = {}) ⇒ MO constructor

A new instance of MO.
#method_missing(name, *args, &block) ⇒ Object
#mo_type ⇒ Object
#naming_props ⇒ Object

Internal: Returns naming properties.
#prefixes ⇒ Object

Internal: Returns class prefixes.
#props ⇒ Object

Internal: Returns class properties.
#read_only ⇒ Object

Interal: Returns boolean for if this class is read only.
#root ⇒ Object
#ruby_class ⇒ Object

Internal: Returns class name as ruby package notation.
#set_prop(key, val) ⇒ Object
#to_hash ⇒ Object
#to_json ⇒ Object
#to_s ⇒ Object
#to_xml ⇒ Object

Constructor Details

#initialize(create_parent, create_options = {}) ⇒ `MO`

Returns a new instance of MO.

# File 'lib/mo.rb', line 61

def initialize(create_parent, create_options = {})
  # always mark dirty unless otherwise specified
  if create_options[:mark_dirty] == false
    mark_dirty = false
  else
    mark_dirty = true
  end
  create_options.delete(:mark_dirty)

  @attributes = {}
  @dirty_props = []
  props.each do |prop, _flags|
    @attributes[prop.to_s] = ''
  end
  @children = []

  if create_parent.nil?
    @parent = nil
  else
    @parent = create_parent
    @parent.add_child(self)
  end

  # for performance reasons, do not use set_prop here
  # and build the dn string after all attributes are set
  create_options.each do |k, v|
    flags = props[k.to_s]
    @attributes[k.to_s] = v.to_s
    @dirty_props.push(k.to_s) if mark_dirty
  end
  @attributes['dn'] = build_dn
  @attributes['rn'] = rn
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(name, *args, &block) ⇒ `Object`

# File 'lib/mo.rb', line 248

def method_missing(name, *args, &block)
  lookup_name = name.to_s
  return @attributes[lookup_name] if @attributes.key? lookup_name
  return set_prop(lookup_name.chomp('='), args[0]) if @attributes.key? lookup_name.chomp('=')
  child_matches = []
  @children.each do |child|
    child_matches.push(child) if child.class.prefix.sub('-', '') == lookup_name
  end
  return child_matches if child_matches.length > 0
  super
end

Class Attribute Details

.child_classes ⇒ `Object` (readonly)

for class variables



12
13
14

# File 'lib/mo.rb', line 12

def child_classes
  @child_classes
end

.class_name ⇒ `Object` (readonly)

for class variables



12
13
14

# File 'lib/mo.rb', line 12

def class_name
  @class_name
end

.containers ⇒ `Object` (readonly)

for class variables



12
13
14

# File 'lib/mo.rb', line 12

def containers
  @containers
end

.naming_props ⇒ `Object` (readonly)

for class variables



12
13
14

# File 'lib/mo.rb', line 12

def naming_props
  @naming_props
end

.prefix ⇒ `Object` (readonly)

for class variables



12
13
14

# File 'lib/mo.rb', line 12

def prefix
  @prefix
end

.prefixes ⇒ `Object` (readonly)

for class variables



12
13
14

# File 'lib/mo.rb', line 12

def prefixes
  @prefixes
end

.props ⇒ `Object` (readonly)

for class variables



12
13
14

# File 'lib/mo.rb', line 12

def props
  @props
end

.read_only ⇒ `Object` (readonly)

for class variables



12
13
14

# File 'lib/mo.rb', line 12

def read_only
  @read_only
end

.ruby_class ⇒ `Object` (readonly)

for class variables



12
13
14

# File 'lib/mo.rb', line 12

def ruby_class
  @ruby_class
end

Instance Attribute Details

#attributes ⇒ `Object` (readonly)

for instance variables



18
19
20

# File 'lib/mo.rb', line 18

def attributes
  @attributes
end

#children ⇒ `Object` (readonly)

for instance variables



18
19
20

# File 'lib/mo.rb', line 18

def children
  @children
end

#dirty_props ⇒ `Object`

Returns the value of attribute dirty_props.



19
20
21

# File 'lib/mo.rb', line 19

def dirty_props
  @dirty_props
end

#parent ⇒ `Object`

Returns the value of attribute parent.



19
20
21

# File 'lib/mo.rb', line 19

def parent
  @parent
end

Instance Method Details

#add_child(child) ⇒ `Object`

Internal: Adds another MO object as a child to this class

# File 'lib/mo.rb', line 96

def add_child(child)
  unless child.containers.include?(ruby_class)
    fail child.class.to_s + ' cannot be child of ' + self.class.to_s
  end
  @children.each do |mo|
    return nil if mo.dn == child.dn
  end
  @children.push(child)
  child.parent = self
end

#build_dn ⇒ `Object`

# File 'lib/mo.rb', line 212

def build_dn
  if @parent.nil?
    return rn
  else
    parent_dn = '' << @parent.dn
    if parent_dn == ''
      return rn
    else
      parent_dn << '/'
      parent_dn << rn
      return parent_dn
    end
  end
end

#child_classes ⇒ `Object`

Internal: Returns child classes



27
28
29

# File 'lib/mo.rb', line 27

def child_classes
  self.class.child_classes
end

#class_name ⇒ `Object`

Internal: Returns object class name in APIC package.class notation



47
48
49

# File 'lib/mo.rb', line 47

def class_name
  self.class.class_name
end

#containers ⇒ `Object`

Internal: Returns containiner classes



32
33
34

# File 'lib/mo.rb', line 32

def containers
  self.class.containers
end

#create(restclient) ⇒ `Object`

# File 'lib/mo.rb', line 181

def create(restclient)
  self.status = 'created,modified'
  restclient.post(data: self,
                  url: "/api/mo/#{dn}.#{restclient.format}")
  @dirty_props = []
end

#destroy(restclient) ⇒ `Object`

# File 'lib/mo.rb', line 188

def destroy(restclient)
  self.status = 'deleted'
  restclient.post(data: self,
                  url: "/api/mo/#{dn}.#{restclient.format}")
  @dirty_props = []
end

#exists(restclient, recurse = false) ⇒ `Object`

# File 'lib/mo.rb', line 195

def exists(restclient, recurse = false)
  options = {}
  options[:subtree] = 'full' if recurse
  if restclient.lookupByDn(dn, options)
    if recurse == true
      children.each do |child|
        unless child.exists(restclient, recurse = true)
          return false
        end
      end
    end
    return true
  else
    return false
  end
end

#get_attributes_to_include ⇒ `Object`

# File 'lib/mo.rb', line 129

def get_attributes_to_include
  incl_attr = {}
  @attributes.each do |key, value|
    if props[key.to_s]['isDn'] == true || props[key.to_s]['isRn'] == true || @dirty_props.include?(key) || naming_props.include?(key)
      incl_attr[key.to_s] = value
    end
  end
  incl_attr
end

#get_children_to_include ⇒ `Object`

# File 'lib/mo.rb', line 139

def get_children_to_include
  incl_children = []
  @children.each do |child|
    incl_children.push(child) if child.read_only == false
  end
  incl_children
end

#hash_to_table(h) ⇒ `Object`

# File 'lib/mo.rb', line 232

def hash_to_table(h)
  len = h.keys.map(&:length).max
  ret = []
  h.each do |k, v|
    ret.push(('%' + len.to_s + 's: %s') % [k.to_s, v.to_s])
  end
  ret
end

#mo_type ⇒ `Object`



227
228
229

# File 'lib/mo.rb', line 227

def mo_type
  self.class.class_name.delete('.')
end

#naming_props ⇒ `Object`

Internal: Returns naming properties



37
38
39

# File 'lib/mo.rb', line 37

def naming_props
  self.class.naming_props
end

#prefixes ⇒ `Object`

Internal: Returns class prefixes



22
23
24

# File 'lib/mo.rb', line 22

def prefixes
  self.class.prefixes
end

#props ⇒ `Object`

Internal: Returns class properties



42
43
44

# File 'lib/mo.rb', line 42

def props
  self.class.props
end

#read_only ⇒ `Object`

Interal: Returns boolean for if this class is read only



57
58
59

# File 'lib/mo.rb', line 57

def read_only
  self.class.read_only
end

#root ⇒ `Object`

# File 'lib/mo.rb', line 123

def root
  p = self
  p = p.parent until p.parent.nil?
  p
end

#ruby_class ⇒ `Object`

Internal: Returns class name as ruby package notation



52
53
54

# File 'lib/mo.rb', line 52

def ruby_class
  self.class.ruby_class
end

#set_prop(key, val) ⇒ `Object`

# File 'lib/mo.rb', line 107

def set_prop(key, val)
  key = key.to_s
  val = val.to_s

  return if key == 'dn' || key == 'rn'

  @attributes[key] = val
  @dirty_props.push(key)

  if naming_props.include? key
    dn_str = build_dn
    @attributes['dn'] = dn_str
    @attributes['rn'] = rn
  end
end

#to_hash ⇒ `Object`

# File 'lib/mo.rb', line 162

def to_hash
  h = {}
  h[mo_type.to_s] = {}
  h[mo_type.to_s]['attributes'] = {}
  get_attributes_to_include.each do |key, value|
    h[mo_type.to_s]['attributes'][key.to_s] = value
  end
  h[mo_type.to_s]['attributes']['dn'] = dn
  h[mo_type.to_s]['children'] = [] if children.length > 0
  get_children_to_include.each do |child|
    h[mo_type.to_s]['children'].push(child.to_hash)
  end
  h
end

#to_json ⇒ `Object`



177
178
179

# File 'lib/mo.rb', line 177

def to_json
  JSON.dump(to_hash)
end

#to_s ⇒ `Object`

# File 'lib/mo.rb', line 231

def to_s
  def hash_to_table(h)
    len = h.keys.map(&:length).max
    ret = []
    h.each do |k, v|
      ret.push(('%' + len.to_s + 's: %s') % [k.to_s, v.to_s])
    end
    ret
  end
  header_table = hash_to_table(
    'Class' => class_name
  )
  attribute_table = hash_to_table(attributes)
  header_table.push(attribute_table)
  header_table.join("\n")
end

#to_xml ⇒ `Object`

# File 'lib/mo.rb', line 147

def to_xml
  # TODO: Use nokogiri here
  #   https://github.com/sparklemotion/nokogiri/wiki/Cheat-sheet
  x = REXML::Element.new mo_type.to_s

  get_attributes_to_include.each do |key, value|
    x.attributes[key.to_s] = value
  end

  get_children_to_include.each do |child|
    x.add_element(child.to_xml)
  end
  x
end

Class: ACIrb::MO

Overview

Direct Known Subclasses

Class Attribute Summary collapse

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(create_parent, create_options = {}) ⇒ MO

Dynamic Method Handling

#method_missing(name, *args, &block) ⇒ Object

Class Attribute Details

.child_classes ⇒ Object (readonly)

.class_name ⇒ Object (readonly)

.containers ⇒ Object (readonly)

.naming_props ⇒ Object (readonly)

.prefix ⇒ Object (readonly)

.prefixes ⇒ Object (readonly)

.props ⇒ Object (readonly)

.read_only ⇒ Object (readonly)

.ruby_class ⇒ Object (readonly)

Instance Attribute Details

#attributes ⇒ Object (readonly)

#children ⇒ Object (readonly)

#dirty_props ⇒ Object

#parent ⇒ Object

Instance Method Details

#add_child(child) ⇒ Object

#build_dn ⇒ Object

#child_classes ⇒ Object

#class_name ⇒ Object

#containers ⇒ Object

#create(restclient) ⇒ Object

#destroy(restclient) ⇒ Object

#exists(restclient, recurse = false) ⇒ Object

#get_attributes_to_include ⇒ Object

#get_children_to_include ⇒ Object

#hash_to_table(h) ⇒ Object

#mo_type ⇒ Object

#naming_props ⇒ Object

#prefixes ⇒ Object

#props ⇒ Object

#read_only ⇒ Object

#root ⇒ Object

#ruby_class ⇒ Object

#set_prop(key, val) ⇒ Object

#to_hash ⇒ Object

#to_json ⇒ Object

#to_s ⇒ Object

#to_xml ⇒ Object

#initialize(create_parent, create_options = {}) ⇒ `MO`

#method_missing(name, *args, &block) ⇒ `Object`

.child_classes ⇒ `Object` (readonly)

.class_name ⇒ `Object` (readonly)

.containers ⇒ `Object` (readonly)

.naming_props ⇒ `Object` (readonly)

.prefix ⇒ `Object` (readonly)

.prefixes ⇒ `Object` (readonly)

.props ⇒ `Object` (readonly)

.read_only ⇒ `Object` (readonly)

.ruby_class ⇒ `Object` (readonly)

#attributes ⇒ `Object` (readonly)

#children ⇒ `Object` (readonly)

#dirty_props ⇒ `Object`

#parent ⇒ `Object`

#add_child(child) ⇒ `Object`

#build_dn ⇒ `Object`

#child_classes ⇒ `Object`

#class_name ⇒ `Object`

#containers ⇒ `Object`

#create(restclient) ⇒ `Object`

#destroy(restclient) ⇒ `Object`

#exists(restclient, recurse = false) ⇒ `Object`

#get_attributes_to_include ⇒ `Object`

#get_children_to_include ⇒ `Object`

#hash_to_table(h) ⇒ `Object`

#mo_type ⇒ `Object`

#naming_props ⇒ `Object`

#prefixes ⇒ `Object`

#props ⇒ `Object`

#read_only ⇒ `Object`

#root ⇒ `Object`

#ruby_class ⇒ `Object`

#set_prop(key, val) ⇒ `Object`

#to_hash ⇒ `Object`

#to_json ⇒ `Object`

#to_s ⇒ `Object`

#to_xml ⇒ `Object`