Source

Treequel /

Filename Size Date modified Message
bin
docs
examples
experiments
lib
misc
spec
155 B
560 B
141 B
2.9 KB
1.5 KB
1.8 KB
10.2 KB
1.4 KB
1.1 KB
= Treequel - an honest LDAP library

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 (http://sequel.rubyforge.org/), 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. You can also browse them in a web browser 
via the project page:

  http://deveiate.org/projects/Treequel/browser/examples


== Contributing

You can check out the current development source with Mercurial from the
following URL:

    http://repo.deveiate.org/Treequel

You can submit bug reports, suggestions, and read more about future plans at
the project page:

    http://deveiate.org/projects/Treequel


== License

See the included LICENSE file for licensing details.


== Authors

* Michael Granger
* Mahlon E. Smith


== Contributors

A special thanks to Ben Bleything, who was part of the initial brainstorm that
led to the creation of this library.