ruby-activeldap 0.4.1 → 0.4.2

data/lib/activeldap.rb

@@ -9,7 +9,7 @@
 # Ruby/ActiveLDAP is a novel way of interacting with LDAP.  Most interaction with
 # LDAP is done using clunky LDIFs, web interfaces, or with painful APIs that
 # required a thick reference manual nearby. Ruby/ActiveLDAP aims to fix that.
-# Inspired by ActiveRecord[http://activerecord.rubyonrails.com], Ruby/ActiveLDAP provides an
+# Inspired by ActiveRecord[http://activerecord.rubyonrails.org], Ruby/ActiveLDAP provides an
 # object oriented interface to LDAP entries.
 # 
 # The target audience is system administrators and LDAP users everywhere that
@@ -27,8 +27,8 @@
 # against Microsoft's ActiveDirectory, despite what the name implies.)
 # 
 # Further reading: 
-# * RFC1777[http://www.faqs.com/rfcs/rfc1777.html] - Lightweight Directory Access Protocol
-# * OpenLDAP[http://www.openldap.com]
+# * RFC1777[http://www.faqs.org/rfcs/rfc1777.html] - Lightweight Directory Access Protocol
+# * OpenLDAP[http://www.openldap.org]
 # 
 # === So why use Ruby/ActiveLDAP?
 # 
@@ -51,18 +51,18 @@
 # 
 # === Requirements
 # 
-# * Ruby[http://www.ruby-lang.com] 1.8.x
-# * Ruby/LDAP[http://ruby-ldap.sourcefcome.net]
-# * Log4r[http://log4r.sourcefcome.net]
-# * (Optional) Ruby/LDAP+GSSAPI[http://caliban.com/files/redhat/RPMS/i386/ruby-ldap-0.8.2-4.i386.rpm]
-# * An LDAP server compatible with Ruby/LDAP: OpenLDAP[http://www.openldap.com], etc
+# * Ruby[http://www.ruby-lang.org] 1.8.x
+# * Ruby/LDAP[http://ruby-ldap.sourceforge.net]
+# * Log4r[http://log4r.sourceforge.net]
+# * (Optional) Ruby/LDAP+GSSAPI[http://caliban.org/files/redhat/RPMS/i386/ruby-ldap-0.8.2-4.i386.rpm]
+# * An LDAP server compatible with Ruby/LDAP: OpenLDAP[http://www.openldap.org], etc
 #   - Your LDAP server must allow root_dse queries to allow for schema queries
-# * Examples also require: Ruby/Password[http://raa.ruby-lang.com/project/ruby-password/]
+# * Examples also require: Ruby/Password[http://raa.ruby-lang.org/project/ruby-password/]
 # 
 # === Installation
 # 
 # Assuming all the requirements are installed, you can install by grabbing the latest tgz file from
-# the download site[http://projects.example.com/libraries/ruby/activeldap/download.html].
+# the download site[http://projects.dataspill.org/libraries/ruby/activeldap/download.html].
 # 
 # The following steps will get the Ruby/ActiveLDAP installed in no time!
 # 
@@ -184,23 +184,23 @@
 # As you can see, this method is used for defining how this class maps in to LDAP.  Let's say that 
 # my LDAP tree looks something like this:
 # 
-#   * dc=example,dc=com
-#   |- ou=People,dc=example,dc=com
-#   |+ ou=Groups,dc=example,dc=com
+#   * dc=dataspill,dc=org
+#   |- ou=People,dc=dataspill,dc=org
+#   |+ ou=Groups,dc=dataspill,dc=org
 #     \
-#      |- cn=develop,ou=Groups,dc=example,dc=com
-#      |- cn=root,ou=Groups,dc=example,dc=com
+#      |- cn=develop,ou=Groups,dc=dataspill,dc=org
+#      |- cn=root,ou=Groups,dc=dataspill,dc=org
 #      |- ...
 # 
 # Under ou=People I store user objects, and under ou=Groups, I store group
 # objects.  What |ldap_mapping| has done is mapped the class in to the LDAP tree
 # abstractly. With the given :dnattr and :prefix, it will only work for entries
-# under ou=Groups,dc=example,dc=com using the primary attribute 'cn' as the
+# under ou=Groups,dc=dataspill,dc=org using the primary attribute 'cn' as the
 # beginning of the distinguished name.
 # 
 # Just for clarity, here's how the arguments map out:
 # 
-#   cn=develop,ou=Groups,dc=example,dc=com
+#   cn=develop,ou=Groups,dc=dataspill,dc=org
 #   ^^         ^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^
 #  :dnattr       |         |
 #              :prefix     |
@@ -228,11 +228,11 @@
 # tying objects together across the LDAP tree. Often, user objects will be
 # members of, or belong_to, Group objects.
 # 
-#   * dc=example,dc=com
-#   |+ ou=People,dc=example,dc=com
+#   * dc=dataspill,dc=org
+#   |+ ou=People,dc=dataspill,dc=org
 #    \
-#    |- uid=drewry,ou=People,dc=example,dc=com
-#   |- ou=Groups,dc=example,dc=com
+#    |- uid=drewry,ou=People,dc=dataspill,dc=org
+#   |- ou=Groups,dc=dataspill,dc=org
 # 
 # 
 # In the above tree, one such example would be user 'drewry' who is a part of the
@@ -382,7 +382,7 @@
 #
 #   irb> Base.search(:base => 'dc=example,dc=com', :filter => '(uid=roo*)',
 #                    :scope => LDAP::LDAP_SCOPE_SUBTREE, :attrs => ['uid', 'cn'])
-#   =>  [{"dn"=>"uid=root,ou=People,dc=example,dc=com","cn"=>["root"], "uidNumber"=>["0"]}]
+#   =>  [{"dn"=>"uid=root,ou=People,dc=dataspill,dc=org","cn"=>["root"], "uidNumber"=>["0"]}]
 # You can specify the :filter, :base, :scope, and :attrs, but they all have defaults --
 #  * :filter defaults to objectClass=* - usually this isn't what you want
 #  * :base defaults to the base of the class this is executed from (as set in ldap_mapping)
@@ -438,10 +438,10 @@
 # won't need to call Base.connect. Here is a fully parameterized call:
 # 
 #   Base.connect(
-#     :host => 'ldap.example.com',
+#     :host => 'ldap.dataspill.org',
 #     :port => 389,
-#     :base => 'dc=example,dc=com',
-#     :bind_format => "uid=%s,ou=People,dc=example,dc=com",
+#     :base => 'dc=dataspill,dc=org',
+#     :bind_format => "uid=%s,ou=People,dc=dataspill,dc=org",
 #     :logger => log4r_obj,
 #     :user => 'drewry',
 #     :password_block => Proc.new { 'password12345' },
@@ -880,7 +880,7 @@ require 'activeldap/configuration'
 require 'activeldap/schema2'
 
 module ActiveLDAP
-  VERSION = "0.4.1"
+  VERSION = "0.4.2"
 end
 
 ActiveLDAP::Base.class_eval do

data/lib/activeldap/base.rb

@@ -34,7 +34,7 @@ require 'ldap/schema'
 require 'log4r'
 
 module ActiveLDAP
-  # OO-interface to LDAP assuming pam/nss_ldap-style comanization with Active specifics
+  # OO-interface to LDAP assuming pam/nss_ldap-style organization with Active specifics
   # Each subclass does a ldapsearch for the matching entry.
   # If no exact match, raise an error.
   # If match, change all LDAP attributes in accessor attributes on the object.
@@ -161,7 +161,7 @@ module ActiveLDAP
     # +config+ must be a hash that may contain any of the following fields:
     # :user, :password_block, :logger, :host, :port, :base, :bind_format, :try_sasl, :allow_anonymous
     # :user specifies the username to bind with.
-    # :bind_format specifies the string to substitute the username into on bind.  e.g. uid=%s,ou=People,dc=example,dc=com. Overrides @@bind_format.
+    # :bind_format specifies the string to substitute the username into on bind.  e.g. uid=%s,ou=People,dc=dataspill,dc=org. Overrides @@bind_format.
     # :password_block specifies a Proc object that will yield a String to be used as the password when called.
     # :logger specifies a preconfigured Log4r::Logger to be used for all logging
     # :host overrides the configuration.rb @@host setting with the LDAP server hostname
@@ -466,6 +466,7 @@ module ActiveLDAP
     # If multiple values exist for dnattr, the first one put here will be authoritative
     # TODO: Add support for relative distinguished names
     def initialize(val='')
+      @@logger.debug("stub: initialize(#{val.inspect}) called")
       if val.class != String
         raise TypeError, "Object key must be a String"
       end
@@ -510,9 +511,12 @@ module ActiveLDAP
             # Save DN
             @dn = m.dn
             # Load up data into tmp
+	    @@logger.debug("loading entry: #{@dn}")
             m.attrs.each do |attr|
               # Load with subtypes just like @data
+	      @@logger.debug("calling make_subtypes for m.vals(attr).dup")
               safe_attr, value = make_subtypes(attr, m.vals(attr).dup)
+	      @@logger.debug("finished make_subtypes for #{attr}")
               @ldap_data[safe_attr] = value
             end
           end
@@ -546,6 +550,7 @@ module ActiveLDAP
     # Return attribute methods so that a program can determine available
     # attributes dynamically without schema awareness
     def attributes
+      @@logger.debug("stub: attributes called")
       return @attr_methods.keys
     end
 
@@ -557,6 +562,7 @@ module ActiveLDAP
     # removing defined attributes that are no longer valid
     # given the new objectclasses.
     def objectClass=(val)
+      @@logger.debug("stub: objectClass=(#{val.inspect}) called")
       if val.class != Array
         raise TypeError, 'objectClass must be an Array'
       end
@@ -622,6 +628,7 @@ module ActiveLDAP
     #
     # Return whether the entry exists in LDAP or not
     def exists?
+      @@logger.debug("stub: exists? called")
       return @exists
     end
 
@@ -629,6 +636,7 @@ module ActiveLDAP
     #
     # Return the authoritative dn
     def dn
+      @@logger.debug("stub: dn called")
       return @dn.dup
     end
 
@@ -638,6 +646,7 @@ module ActiveLDAP
     # - Verify that every 'MUST' specified in the schema has a value defined
     # - Enforcement of undefined attributes is handled in the objectClass= method
     def validate
+      @@logger.debug("stub: validate called")
       @must.each do |oc|
          oc[1].each do |req_attr|
           # TODO: should I ever check if key exists? bug if it doesnt...
@@ -648,6 +657,7 @@ module ActiveLDAP
           end
         end
       end
+      @@logger.debug("stub: validate finished")
     end
 
 
@@ -655,6 +665,7 @@ module ActiveLDAP
     #
     # Delete this entry from LDAP
     def delete
+      @@logger.debug("stub: delete called")
       begin
         @@conn.delete(@dn)
         @exists = false
@@ -671,6 +682,7 @@ module ActiveLDAP
     # TODO: Binary data support
     # TODO: Relative DN support
     def write
+      @@logger.debug("stub: write called")
       # Validate against the objectClass requirements
       validate
 
@@ -686,7 +698,10 @@ module ActiveLDAP
         # Expand subtypes to real ldap_data entries
         # We can't reuse @ldap_data because an exception would leave
         # an object in an unknown state
+        @@logger.debug("#write: dup'ing @ldap_data")
         ldap_data = @ldap_data.dup
+        @@logger.debug("#write: dup finished @ldap_data")
+        @@logger.debug("#write: expanding subtypes in @ldap_data")
         ldap_data.keys.each do |key|
           ldap_data[key].each do |value|
             if value.class == Hash
@@ -700,9 +715,13 @@ module ActiveLDAP
             end
           end
         end
+        @@logger.debug("#write: subtypes expanded for @ldap_data")
 
         # Expand subtypes to real data entries, but leave @data alone
+        @@logger.debug("#write: dup'ing @data")
         data = @data.dup
+        @@logger.debug("#write: finished dup'ing @data")
+        @@logger.debug("#write: expanding subtypes for @data")
         data.keys.each do |key|
           data[key].each do |value|
             if value.class == Hash
@@ -716,10 +735,12 @@ module ActiveLDAP
             end
           end
         end
+        @@logger.debug("#write: subtypes expanded for @data")
 
         # Now that all the subtypes will be treated as unique attributes
         # we can see what's changed and add anything that is brand-spankin'
         # new.
+        @@logger.debug("#write: traversing ldap_data determining replaces and deletes")
         ldap_data.each do |pair|
           suffix = ''
           binary = 0
@@ -749,6 +770,8 @@ module ActiveLDAP
             end
           end
         end
+        @@logger.debug("#write: finished traversing ldap_data")
+        @@logger.debug("#write: traversing data determining adds")
         data.each do |pair|
           suffix = ''
           binary = 0
@@ -766,14 +789,20 @@ module ActiveLDAP
             entry.push(LDAP.mod(LDAP::LDAP_MOD_ADD|binary, name + suffix, value)) unless value.empty?
           end
         end
+        @@logger.debug("#write: traversing data complete")
         begin
+          @@logger.debug("#write: modifying #{@dn}")
           @@conn.modify(@dn, entry)
+          @@logger.debug("#write: modify successful")
         rescue => detail
           raise WriteError, "Could not update LDAP entry: #{detail}"
         end
       else # add everything!
+        @@logger.debug("#write: adding all attribute value pairs")
+        @@logger.debug("#write: adding #{@attr_methods[dnattr()].inspect} = #{data[@attr_methods[dnattr()]].inspect}")
         entry.push(LDAP.mod(LDAP::LDAP_MOD_ADD, @attr_methods[dnattr()], 
           data[@attr_methods[dnattr()]]))
+        @@logger.debug("#write: adding objectClass = #{data[@attr_methods['objectClass']].inspect}")
         entry.push(LDAP.mod(LDAP::LDAP_MOD_ADD, 'objectClass', 
           data[@attr_methods['objectClass']]))
         @data.each do |pair|
@@ -785,13 +814,18 @@ module ActiveLDAP
           end
         end
         begin
+          @@logger.debug("#write: adding #{@dn}")
           @@conn.add(@dn, entry)
+          @@logger.debug("#write: add successful")
           @exists = true
         rescue LDAP::ResultError => detail
           raise WriteError, "Could not add LDAP entry: #{detail}"
         end
       end
+      @@logger.debug("#write: resetting @ldap_data to a dup of @data")
       @ldap_data = @data.dup
+      @@logger.debug("#write: @ldap_data reset complete")
+      @@logger.debug("stub: write exitted")
     end
 
 
@@ -803,6 +837,7 @@ module ActiveLDAP
     #       using class_eval instead of using method_missing.  This would
     #       give tab completion in irb.
     def method_missing(name, *args)
+      @@logger.debug("stub: called method_missing(#{name.inspect}, #{args.inspect})")
       key = name.to_s
       case key
         when /^(\S+)=$/
@@ -827,6 +862,7 @@ module ActiveLDAP
      # Hashes are for subtypes
      # Arrays are for multiple entries
      def attribute_input_handler(attr, value)
+       @@logger.debug("stub: called attribute_input_handler(#{attr.inspect}, #{value.inspect})")
        if attr.nil?
          raise RuntimeError, 'attr argument must not be nil.'
        end
@@ -871,6 +907,7 @@ module ActiveLDAP
     # e.g. userCertificate;binary => "some_bin"
     #      becomes userCertificate => {"binary" => "some_bin"}
     def make_subtypes(attr, value)
+      @@logger.debug("stub: called make_subtypes(#{attr.inspect}, #{value.inspect})")
       return [attr, value] unless attr.match(/;/)
 
       ret_attr, *subtypes = attr.split(/;/)
@@ -882,6 +919,7 @@ module ActiveLDAP
     # This is a recursive function for building
     # nested hashed from multi-subtyped values
     def make_subtypes_helper(subtypes, value)
+      @@logger.debug("stub: called make_subtypes_helper(#{subtypes.inspect}, #{value.inspect})")
       return value if subtypes.size == 0
       return {subtypes[0] => make_subtypes_helper(subtypes[1..-1], value)}
     end
@@ -891,6 +929,7 @@ module ActiveLDAP
     # Extracts all of the subtypes from a given set of nested hashes
     # and returns the attribute suffix and the final true value
     def extract_subtypes(value)
+      @@logger.debug("stub: called extract_subtypes(#{value.inspect})")
       subtype = ''
       ret_val = value
       if value.class == Hash
@@ -969,7 +1008,7 @@ module ActiveLDAP
        mechanisms = @@conn.root_dse[0]['supportedSASLMechanisms']
        # Use GSSAPI if available
        # Currently only GSSAPI is supported with Ruby/LDAP from
-       # http://caliban.com/files/redhat/RPMS/i386/ruby-ldap-0.8.2-4.i386.rpm
+       # http://caliban.org/files/redhat/RPMS/i386/ruby-ldap-0.8.2-4.i386.rpm
        # TODO: Investigate further SASL support
        if mechanisms.respond_to? :member? and mechanisms.member? 'GSSAPI'
          begin
@@ -989,6 +1028,7 @@ module ActiveLDAP
      # Returns the value of self.class.base
      # This is just syntactic sugar
      def base
+       @@logger.debug("stub: called base")
        self.class.base
      end
 
@@ -997,6 +1037,7 @@ module ActiveLDAP
      # Returns the value of self.class.required_classes
      # This is just syntactic sugar
      def required_classes
+       @@logger.debug("stub: called required_classes")
        self.class.required_classes
      end
 
@@ -1005,6 +1046,7 @@ module ActiveLDAP
      # Returns the value of self.class.dnattr
      # This is just syntactic sugar
      def dnattr
+       @@logger.debug("stub: called dnattr")
        self.class.dnattr
      end
 
@@ -1012,6 +1054,7 @@ module ActiveLDAP
      #
      # Return the value of the attribute called by method_missing?
      def attribute_method(method, arrays = false)
+       @@logger.debug("stub: called attribute_method(#{method.inspect}, #{arrays.inspect}")
        attr = @attr_methods[method]
 
        # Return a copy of the stored data
@@ -1024,6 +1067,7 @@ module ActiveLDAP
      #
      # Set the value of the attribute called by method_missing?
      def attribute_method=(method, arg)
+       @@logger.debug("stub: called attribute_method=(#{method.inspect}, #{arg.inspect}")
        # Copy input
        begin
          value = arg.dup
@@ -1039,6 +1083,7 @@ module ActiveLDAP
        @data[attr] = value
 
        # Return a copy of what got saved
+       @@logger.debug("stub: exitting attribute_method=")
        return @data[attr].dup
      end
 
@@ -1048,6 +1093,7 @@ module ActiveLDAP
      # Make a method entry for _every_ alias of a valid attribute and map it
      # onto the first attribute passed in.
      def define_attribute_methods(attr)
+       @@logger.debug("stub: called define_attribute_methods(#{attr.inspect})")
        if @attr_methods.has_key? attr
          return
        end
@@ -1062,6 +1108,7 @@ module ActiveLDAP
     # Returns the array form of a value, or not an array if
     # false is passed in.
     def array_of(value, to_a = true)
+      @@logger.debug("stub: called array_of(#{value.inspect}, #{to_a.inspect})")
       if to_a
         case value.class.to_s
           when 'Array'

data/lib/activeldap/configuration.rb

@@ -8,11 +8,11 @@ module ActiveLDAP
  module Configuration
     @@host = "localhost"
     @@port = 389
-    @@bind_format = "uid=%s,ou=People,dc=example,dc=com"
+    @@bind_format = "uid=%s,ou=People,dc=dataspill,dc=org"
 
     # Make the return value the string that is your LDAP base
     def Base.base
-      'dc=example,dc=com'
+      'dc=dataspill,dc=org'
     end
 
     # This is optionally set to the array of objectClass names

data/lib/activeldap/schema2.rb

@@ -3,6 +3,7 @@ require 'ldap/schema'
 
 module LDAP
   class Schema2 < Schema
+    @@cache = {}
   
     # attr
     # 
@@ -16,13 +17,29 @@ module LDAP
       return '' if type.empty?
       return '' if at.empty?
 
+      # Check already parsed options first
+      if @@cache.has_key? sub \
+        and @@cache[sub].has_key? type \
+        and @@cache[sub][type].has_key? at
+          return @@cache[sub][type][at].dup
+      end
+
+      # Initialize anything that is required
+      unless @@cache.has_key? sub
+        @@cache[sub] = {}
+      end
+      
+      unless @@cache[sub].has_key? type
+        @@cache[sub][type] = {}
+      end
+
       at = at.upcase
       self[sub].each do |s|
         line = '' 
         if type[0..0] =~ /[0-9]/
-          line = s if s =~ /\(\s+#{type}\s+([A-Z]|\))/
+          line = s if s =~ /\(\s+#{type}\s+(?:[A-Z]|\))/
         else
-          line = s if s =~ /NAME\s+\(?.*'#{type}'.*\)?\s+([A-Z]|\))/
+          line = s if s =~ /NAME\s+\(?.*'#{type}'.*\)?\s+(?:[A-Z]|\))/
         end
 
         # I need to check, but I think some of these matchs
@@ -30,25 +47,31 @@ module LDAP
         multi = ''
         case line
           when /#{at}\s+[\)A-Z]/
+            @@cache[sub][type][at] = ['TRUE']
             return ['TRUE']
           when /#{at}\s+'(.+?)'/
+            @@cache[sub][type][at] = [$1]
             return [$1]
           when /#{at}\s+\((.+?)\)/
             multi = $1
           when /#{at}\s+\(([\w\d\s\.]+)\)/
             multi = $1
           when /#{at}\s+([\w\d\.]+)/
+            @@cache[sub][type][at] = [$1]
             return [$1]
         end
         # Split up multiple matches
         # if oc then it is sep'd by $
         # if attr then bu spaces
         if multi.match(/\$/)
-          return multi.split("$").collect{|attr| attr.strip}
+          @@cache[sub][type][at] = multi.split("$").collect{|attr| attr.strip}
+          return @@cache[sub][type][at].dup
         elsif not multi.empty?
-          return multi.gsub(/'/, '').split(' ').collect{|attr| attr.strip}
+          @@cache[sub][type][at] = multi.gsub(/'/, '').split(' ').collect{|attr| attr.strip}
+          return @@cache[sub][type][at].dup
         end
       end
+      @@cache[sub][type][at] = []
       return []
     end
 

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.8.1
 specification_version: 1
 name: ruby-activeldap
 version: !ruby/object:Gem::Version 
-  version: 0.4.1
-date: 2004-10-06
+  version: 0.4.2
+date: 2004-10-07
 summary: Ruby/ActiveLDAP is a object-oriented API to LDAP
 require_paths: 
   - lib