class AdobeConnect::Base

Provides base interaction with Adobe Connect for a variety of AC Objects

Attributes

errors[R]
id[RW]

Public: SCO-ID from the Adobe Connect instance.

service[R]

Public Class Methods

config() click to toggle source
# File lib/adobe_connect/base.rb, line 84
def self.config
  { :ac_obj_type => 'principal', :delete_method_is_plural => true }
end
create(obj_options) click to toggle source

Public: Create a Connect obj from the given app obj.

obj_options - Generic options (see initialize for required

attributes).

Returns an instance of this class, with an attempted save.

# File lib/adobe_connect/base.rb, line 77
def self.create(obj_options)
  obj = self.new(obj_options)
  obj.save

  obj
end
new(obj_options, service = Service.new) click to toggle source
# File lib/adobe_connect/base.rb, line 10
def initialize(obj_options, service = Service.new)
  set_attrs(obj_options)
  @service  = service
  @errors   = []
end

Public Instance Methods

attrs() click to toggle source
# File lib/adobe_connect/base.rb, line 16
def attrs
  {}
end
delete() click to toggle source

Public: Delete this object form Adobe Connect.

Returns a boolean.

# File lib/adobe_connect/base.rb, line 23
def delete
  response = service.send(:"#{delete_method_prefix}_delete", {:"#{ac_obj_type}_id" => self.id})
  response.at_xpath('//status').attr('code') == 'ok'
end
permissions_update(principal_id, permission_id) click to toggle source

Public: Update permissions on the loaded object for the given principal_id.

principal_id - id of user permission_id - AdobeConnect permission value

Returns a boolean.

# File lib/adobe_connect/base.rb, line 61
def permissions_update(principal_id, permission_id)
  response = service.permissions_update(
    acl_id: self.id,
    principal_id: principal_id,
    permission_id: permission_id
  )

  response.at_xpath('//status').attr('code') == 'ok'
end
save() click to toggle source

Public: Save this object to the Adobe Connect instance.

Returns a boolean.

# File lib/adobe_connect/base.rb, line 31
def save
  response = service.send(:"#{method_prefix}_update", self.attrs)

  if response.at_xpath('//status').attr('code') == 'ok'
    # Load the ID if this was a creation
    self.id = response.at_xpath("//#{ac_obj_node_name}").attr("#{ac_obj_type}-id") if self.id.nil?
    true
  else
    save_errors(response)
    false
  end
end
update_attributes(atrs) click to toggle source

Public: Update attributes of the loaded object and save.

atrs - Generic options (see initialize for required

attributes).

Returns a boolean.

# File lib/adobe_connect/base.rb, line 50
def update_attributes(atrs)
  set_attrs(atrs)
  self.save
end

Private Instance Methods

ac_obj_node_name() click to toggle source
# File lib/adobe_connect/base.rb, line 91
def ac_obj_node_name
  self.class.config[:ac_obj_node_name] || ac_obj_type
end
ac_obj_type() click to toggle source
# File lib/adobe_connect/base.rb, line 95
def ac_obj_type
  self.class.config[:ac_obj_type]
end
delete_method_prefix() click to toggle source
# File lib/adobe_connect/base.rb, line 99
def delete_method_prefix
  prefix = method_prefix
  prefix = prefix.pluralize if self.class.config[:delete_method_is_plural]
  prefix
end
method_prefix() click to toggle source
# File lib/adobe_connect/base.rb, line 105
def method_prefix
  self.class.config[:ac_method_prefix] || ac_obj_type
end
save_errors(response) click to toggle source

Internal: Store request errors in @errors.

response - An AdobeConnect::Response.

Returns nothing.

# File lib/adobe_connect/base.rb, line 114
def save_errors(response)
  @errors = response.xpath('//invalid').map(&:attributes)
end
set_attrs(atrs) click to toggle source

Internal: Update attributes from an attribute hash

atrs - A hash of keys that match attributes of this object and

corresponding values for those attributes.

Returns nothing.

# File lib/adobe_connect/base.rb, line 124
def set_attrs(atrs)
  atrs.each { |key, value| send(:"#{key}=", value) }
end