wiki:WikiStart
Last modified 13 months ago

Treequel

Treequel is an LDAP toolkit for Ruby. It is intended to allow quick, easy access to LDAP directories in a manner consistent with LDAP's hierarchical, free-form nature.

It's inspired by and modeled after  Sequel, a kick-ass database library.

Examples

Here are a few short examples to whet your appetite: 

# Connect to the directory at the specified URL
dir = Treequel.directory( 'ldap://ldap.company.com/dc=company,dc=com' )

# Get a list of email addresses of every person in the directory (as
# long as people are under ou=people)
dir.ou( :people ).filter( :mail ).map( :mail ).flatten

# Get a list of all IP addresses for all hosts in any ou=hosts group
# in the whole directory:
dir.filter( :ou => :hosts ).collection.filter( :ipHostNumber ).
  map( :ipHostNumber ).flatten

# Get all people in the directory in the form of a hash of names 
# keyed by email addresses
dir.ou( :people ).filter( :mail ).to_hash( :mail, :cn )

More elaborate examples of real-world usage can be found in the examples directory in the distribution. Treequel comes with  full API documentation, and we're working on  a manual with lots of examples as well.

Downloads

Development

You can check out the current development source with Mercurial like so: 

hg clone http://repo.deveiate.org/Treequel

We're also keeping some notes as we work which may give you a better idea of what we're doing, and upcoming features can be found in the milestones in the roadmap.

Trac Information

For a complete list of local wiki pages, see TitleIndex.