Permalink
Browse files

gotta add the file in question, yep

  • Loading branch information...
1 parent d859e1e commit 5eced32ace05d091c34371a5297cc932245ba06b @defunkt committed Mar 9, 2008
Showing with 48 additions and 0 deletions.
  1. +48 −0 README.textile
View
@@ -0,0 +1,48 @@
+h2. An Ambitious ActiveLdap Adapter
+
+Write LDAP search filters in Ruby. Awesomeness courtesy of Chris Wanstrath's Ambition library.
+
+You must be using ActiveLdap 0.9 or greater.
+
+h2. Get It
+
+@$ sudo gem install ambitious-activeldap@
+
+
+<pre>
+require 'rubygems'
+require 'ambition/adapters/active_ldap'
+</pre>
+
+h2. Examples
+
+Let @User@ be a subclass of @ActiveLdap::Base@
+
+<ruby>
+User.select { |u| u.givenName == 'Severian' }.each do |user|
+ puts user.name
+end
+</ruby>
+
+Queries don't run until you kick them. This adapter supports only the basic kicker methods: @each@, @each_with_index@, @map@, @entries@, @to_a@.
+
+This adapter also doesn't support the methods that require sorting, slicing, or counting, because OpenLDAP effectively doesn't support such things. ActiveLdap lets you request sorted and sliced result sets, but it does the work in Ruby, so you might as well do it yourself.
+
+You can call @to_s@, but not @to_hash@ on a query. @to_s@ returns the LDAP search filter as a string.
+
+<ruby>
+>> User.select { |m| m.givenName == 'Jonas' }.to_s
+=> "(givenName=Jonas)"
+</ruby>
+
+
+
+h2. Issues.find(:all, :filter => "(type=bug)")
+
+Found a bug? Sweet. Add it at "the Lighthouse":http://err.lighthouseapp.com/projects/466-plugins/tickets/new.
+
+More information on Ambition:
+
+ * "http://ambition.rubyforge.org":http://ambition.rubyforge.org
+ * "http://groups.google.com/group/ambition-rb/":http://groups.google.com/group/ambition-rb/
+

0 comments on commit 5eced32

Please sign in to comment.