ruby_aem

ruby_aem is a Ruby client for Adobe Experience Manager (AEM) API. It is written on top of swagger_aem and provides resource-oriented API and convenient response handling.

| ruby_aem | Supported AEM | Supported Ruby | Documentation | |———-|————————|————————-|———————————————————————————————————————————————————-| | 1.0.2 | 6.0, 6.1, 6.2 | 1.9, 2.0, 2.1, 2.2, 2.3 | API Changes | | 1.0.0 | 6.0, 6.1, 6.2 | 1.9, 2.0, 2.1, 2.2, 2.3 | API Changes | | 0.9.0 | 6.0, 6.1, 6.2 | 1.9, 2.0, 2.1, 2.2, 2.3 | API Changes |

Install

gem install ruby_aem

Usage

Initialise client:

require 'ruby_aem'

aem = RubyAem::Aem.new({
  :username => 'admin',
  :password => 'admin',
  :protocol => 'http',
  :host => 'localhost',
  :port => 4502,
  :debug => false
})

Bundle:

# stop bundle
bundle = aem.bundle('com.adobe.cq.social.cq-social-forum')
result = bundle.stop()

# start bundle
bundle = aem.bundle('com.adobe.cq.social.cq-social-forum')
result = bundle.start()

Configuration property:

config_property = aem.config_property('someinexistingnode', 'Boolean', true)

# set config property
result = config_property.create('author')

Flush agent:

flush_agent = aem.flush_agent('author', 'some-flush-agent')

# create or update flush agent
opts = { log_level: 'info', retry_delay: 60000 }
result = flush_agent.create_update('Some Flush Agent Title', 'Some flush agent description', 'http://somehost:8080', opts)

# check flush agent's existence
result = flush_agent.exists()

# delete flush agent
result = flush_agent.delete()

Group:

# create group
group = aem.group('/home/groups/s/', 'somegroup')

# check group's existence
result = group.exists()

# set group permission
result = group.set_permission('/etc/replication', 'read:true,modify:true')

# add another group as a member
member_group = aem.group('/home/groups/s/', 'somemembergroup')
result = member_group.create()
result = group.add_member('somemembergroup')

# delete group
result = group.delete()

Node:

node = aem.node('/apps/system/', 'somefolder')

# create node
result = node.create('sling:Folder')

# check node's existence
result = node.exists()

# delete node
result = node.delete()

Package:

package = aem.package('somepackagegroup', 'somepackage', '1.2.3')

# upload package located at /tmp/somepackage-1.2.3.zip
opts = { force: true }
result = package.upload('/tmp', opts)

# check whether package is uploaded
result = package.is_uploaded()

# install package
result = package.install()

# check whether package is installed
result = package.is_installed()

# replicate package
result = package.replicate()

# download package to /tmp directory
result = package.download('/tmp')

# create package
result = package.create()

# build package
result = package.build()

# update package filter
result = package.update('[{"root":"/apps/geometrixx","rules":[]},{"root":"/apps/geometrixx-common","rules":[]}]')

# get package filter
result = package.get_filter()

# activate filter
results = package.activate_filter(true, false)

# list all packages
result = package.list_all()

Path:

# check path's existence
path = aem.path('/etc/designs/cloudservices')
result = path.activate(true, false)

# tree activate the path
path = aem.path('/etc/designs')
result = path.activate(true, false)

Replication agent:

replication_agent = aem.replication_agent('author', 'some-replication-agent')

# create or update replication agent
opts = {
  transport_user: 'admin',
  transport_password: 'admin',
  log_level: 'info',
  retry_delay: 60000
}
result = replication_agent.create_update('Some replication Agent Title', 'Some replication agent description', 'http://somehost:8080', opts)

# check replication agent's existence
result = replication_agent.exists()

# delete replication agent
result = replication_agent.delete()

Repository:

repository = aem.repository()

# block repository writes
result = repository.block_writes

# unblock repository writes
result = repository.unblock_writes

User:

user = aem.user('/home/users/s/', 'someuser')

# create user
result = user.create('somepassword')

# check user's existence
result = user.exists()

# set user permission
result = user.set_permission('/etc/replication', 'read:true,modify:true')

# change user password
result = user.change_password('somepassword', 'somenewpassword')

# add user to group
result = user.add_to_group('/home/groups/s/', 'somegroup')

# delete user
result = user.delete()

Result

Each of the above method calls returns a RubyAem::Result, which contains message, RubyAem::Response, and data payload. For example:

bundle = aem.bundle('com.adobe.cq.social.cq-social-forum')
result = bundle.stop()
puts result.message
puts result.response.status_code
puts result.response.body
puts result.response.headers
puts result.data

Error handling

Any API error will be thrown as RubyAem::Error .

begin
  bundle = aem.bundle('com.adobe.cq.social.cq-social-forum')
  result = bundle.stop()
rescue RubyAem::Error => err
  puts err.message
  puts err.result.response.status_code
  puts err.result.response.body
  puts err.result.response.headers
  puts err.result.data
end

Reports