activeldap 1.0.2 → 1.0.9

data/lib/active_ldap/adapter/net_ldap.rb

@@ -21,7 +21,6 @@ module ActiveLdap
       }
 
       def connect(options={})
-        @bound = false
         super do |host, port, method|
           config = {
             :host => host,
@@ -41,11 +40,14 @@ module ActiveLdap
       end
 
       def unbind(options={})
-        log("unbind") {@bound = false}
+        super do
+          log("unbind") do
+            @connection.close # Net::LDAP doesn't implement unbind.
+          end
+        end
       end
 
       def bind(options={})
-        @bound = false
         begin
           super
         rescue Net::LDAP::LdapError
@@ -55,16 +57,11 @@ module ActiveLdap
 
       def bind_as_anonymous(options={})
         super do
-          @bound = false
           execute(:bind, {:name => "bind: anonymous"}, {:method => :anonymous})
-          @bound = true
+          true
         end
       end
 
-      def bound?
-        connecting? and @bound
-      end
-
       def search(options={}, &block)
         super(options) do |base, scope, filter, attrs, limit, callback|
           args = {
@@ -97,38 +94,38 @@ module ActiveLdap
       end
 
       def add(dn, entries, options={})
-        super do |dn, entries|
+        super do |_dn, _entries|
           attributes = {}
-          entries.each do |type, key, attrs|
+          _entries.each do |type, key, attrs|
             attrs.each do |name, values|
               attributes[name] = values
             end
           end
-          args = {:dn => dn, :attributes => attributes}
+          args = {:dn => _dn, :attributes => attributes}
           info = args.dup
           execute(:add, info, args)
         end
       end
 
       def modify(dn, entries, options={})
-        super do |dn, entries|
-          info = {:dn => dn, :attributes => entries}
+        super do |_dn, _entries|
+          info = {:dn => _dn, :attributes => _entries}
           execute(:modify, info,
-                  :dn => dn,
-                  :operations => parse_entries(entries))
+                  :dn => _dn,
+                  :operations => parse_entries(_entries))
         end
       end
 
       def modify_rdn(dn, new_rdn, delete_old_rdn, new_superior, options={})
-        super do |dn, new_rdn, delete_old_rdn, new_superior|
+        super do |_dn, _new_rdn, _delete_old_rdn, _new_superior|
           info = {
-            :name => "modify: RDN", :dn => dn, :new_rdn => new_rdn,
-            :delete_old_rdn => delete_old_rdn,
+            :name => "modify: RDN",
+            :dn => _dn, :new_rdn => _new_rdn, :delete_old_rdn => _delete_old_rdn,
           }
           execute(:rename, info,
-                  :olddn => dn,
-                  :newrdn => new_rdn,
-                  :delete_attributes => delete_old_rdn)
+                  :olddn => _dn,
+                  :newrdn => _new_rdn,
+                  :delete_attributes => _delete_old_rdn)
         end
       end
 
@@ -183,24 +180,23 @@ module ActiveLdap
       end
 
       def sasl_bind(bind_dn, options={})
-        super do |bind_dn, mechanism, quiet|
+        super do |_bind_dn, mechanism, quiet|
           normalized_mechanism = mechanism.downcase.gsub(/-/, '_')
           sasl_bind_setup = "sasl_bind_setup_#{normalized_mechanism}"
           next unless respond_to?(sasl_bind_setup, true)
           initial_credential, challenge_response =
-            send(sasl_bind_setup, bind_dn, options)
+            send(sasl_bind_setup, _bind_dn, options)
           args = {
             :method => :sasl,
             :initial_credential => initial_credential,
             :mechanism => mechanism,
             :challenge_response => challenge_response,
           }
-          @bound = false
           info = {
-            :name => "bind: SASL", :dn => bind_dn, :mechanism => mechanism,
+            :name => "bind: SASL", :dn => _bind_dn, :mechanism => mechanism,
           }
           execute(:bind, info, args)
-          @bound = true
+          true
         end
       end
 
@@ -264,15 +260,14 @@ module ActiveLdap
       end
 
       def simple_bind(bind_dn, options={})
-        super do |bind_dn, passwd|
+        super do |_bind_dn, password|
           args = {
             :method => :simple,
-            :username => bind_dn,
-            :password => passwd,
+            :username => _bind_dn,
+            :password => password,
           }
-          @bound = false
-          execute(:bind, {:dn => bind_dn}, args)
-          @bound = true
+          execute(:bind, {:dn => _bind_dn}, args)
+          true
         end
       end
 

data/lib/active_ldap/adapter/net_ldap_ext.rb

@@ -18,12 +18,6 @@ module Net
       def original_attribute_names
         @original_attribute_names.compact.uniq
       end
-
-      def each_attribute
-        attribute_names.sort_by {|name| name.to_s}.each do |name|
-          yield name, self[name]
-        end
-      end
     end
   end
 end

data/lib/active_ldap/association/proxy.rb

@@ -3,12 +3,13 @@ module ActiveLdap
     class Proxy
       alias_method :proxy_respond_to?, :respond_to?
       alias_method :proxy_extend, :extend
+      delegate :to_param, :to => :target
 
       def initialize(owner, options)
         @owner = owner
         @options = options
-        extend(options[:extend]) if options[:extend]
         reset
+        extend(options[:extend]) if options[:extend]
       end
 
       def respond_to?(symbol, include_priv=false)

data/lib/active_ldap/attributes.rb

@@ -26,10 +26,41 @@ module ActiveLdap
           value.values.all? {|val| blank_value?(val)}
         when Array
           value.all? {|val| blank_value?(val)}
+        when String
+          /\A\s*\z/ =~ value
+        when nil
+          true
         else
           value.blank?
         end
       end
+
+      def remove_blank_value(value)
+        case value
+        when Hash
+          result = {}
+          value.each do |k, v|
+            result[k] = remove_blank_value(v) || []
+          end
+          result
+        when Array
+          result = []
+          value.each do |v|
+            v = remove_blank_value(v)
+            next if v.nil?
+            result << v
+          end
+          result
+        when String
+          if /\A\s*\z/ =~ value
+            nil
+          else
+            value
+          end
+        else
+          value
+        end
+      end
     end
 
     module Normalizable

data/lib/active_ldap/base.rb

@@ -44,6 +44,24 @@ module ActiveLdap
   # Multiple entries become lists.
   # If this isn't read-only then lists become multiple entries, etc.
 
+  class << self
+    include GetTextSupport
+    def const_missing(id)
+      case id
+      when :ConnectionNotEstablished
+        message =
+          _("ActiveLdap::ConnectionNotEstablished has been deprecated " \
+            "since 1.1.0. " \
+            "Please use ActiveLdap::ConnectionNotSetup instead.")
+        ActiveSupport::Deprecation.warn(message)
+        const_set("ConnectionNotEstablished", ConnectionNotSetup)
+        ConnectionNotEstablished
+      else
+        super
+      end
+    end
+  end
+
   class Error < StandardError
     include GetTextSupport
   end
@@ -155,13 +173,16 @@ module ActiveLdap
     NEAREST_MARK = "|@|"
     private
     def detect_nearest(line, column)
-      nearest = @ldif.to_a[line - 1] || ""
+      lines = Compatible.string_to_lines(@ldif).to_a
+      nearest = lines[line - 1] || ""
       if column - 1 == nearest.size # for JRuby 1.0.2 :<
         nearest << NEAREST_MARK
       else
         nearest[column - 1, 0] = NEAREST_MARK
       end
-      nearest = "#{@ldif.to_a[line - 2]}#{nearest}" if nearest == NEAREST_MARK
+      if nearest == NEAREST_MARK
+        nearest = "#{lines[line - 2]}#{nearest}"
+      end
       nearest
     end
 
@@ -182,7 +203,7 @@ module ActiveLdap
 
     def numbered_ldif
       return @ldif if @ldif.blank?
-      lines = @ldif.to_a
+      lines = Compatible.string_to_lines(@ldif)
       format = "%#{Math.log10(lines.size).truncate + 1}d: %s"
       i = 0
       lines.collect do |line|
@@ -207,7 +228,7 @@ module ActiveLdap
   class OperationNotPermitted < Error
   end
 
-  class ConnectionNotEstablished < Error
+  class ConnectionNotSetup < Error
   end
 
   class AdapterNotSpecified < Error
@@ -288,7 +309,6 @@ module ActiveLdap
           end
           def #{sym}; self.class.#{sym}; end
           def self.#{sym}=(value); @#{sym} = value; end
-          def #{sym}=(value); self.class.#{sym} = value; end
         EOS
       end
     end
@@ -340,13 +360,24 @@ module ActiveLdap
       #   search() requests. Be warned.
       # :retry_on_timeout - whether to reconnect when timeouts occur. Defaults
       #   to true
-      # See lib/configuration.rb for defaults for each option
-      def establish_connection(config=nil)
+      # See lib/active_ldap/configuration.rb for defaults for each option
+      def setup_connection(config=nil)
         super
         ensure_logger
         nil
       end
 
+      # establish_connection is deprecated since 1.1.0. Please use
+      # setup_connection() instead.
+      def establish_connection(config=nil)
+        message =
+          _("ActiveLdap::Base.establish_connection has been deprecated " \
+            "since 1.1.0. " \
+            "Please use ActiveLdap::Base.setup_connection instead.")
+        ActiveSupport::Deprecation.warn(message)
+        setup_connection(config)
+      end
+
       def create(attributes=nil, &block)
         if attributes.is_a?(Array)
           attributes.collect {|attrs| create(attrs, &block)}
@@ -473,7 +504,7 @@ module ActiveLdap
         end
       end
 
-      def self_and_descendents_from_active_ldap
+      def self_and_descendants_from_active_ldap
         klass = self
         classes = [klass]
         while klass != klass.base_class
@@ -483,11 +514,17 @@ module ActiveLdap
       rescue
         [self]
       end
-      alias_method(:self_and_descendents_from_active_record,
-                   :self_and_descendents_from_active_ldap)
+      if ActiveRecord::Base.respond_to?(:self_and_descendents_from_active_record)
+        # ActiveRecord 2.2.2 has a typo. :<
+        alias_method(:self_and_descendents_from_active_record,
+                     :self_and_descendants_from_active_ldap)
+      else
+        alias_method(:self_and_descendants_from_active_record,
+                     :self_and_descendants_from_active_ldap)
+      end
 
       def human_name(options={})
-        defaults = self_and_descendents_from_active_ldap.collect do |klass|
+        defaults = self_and_descendants_from_active_ldap.collect do |klass|
           if klass.name.blank?
             nil
           else
@@ -563,20 +600,16 @@ module ActiveLdap
       end
 
       def default_dn_attribute
-        if name.empty?
-          dn_attribute = nil
-          parent_class = ancestors[1]
-          if parent_class.respond_to?(:dn_attribute)
-            dn_attribute = parent_class.dn_attribute
-          end
-          dn_attribute || "cn"
-        else
-          name.demodulize.underscore
+        dn_attribute = nil
+        parent_class = ancestors[1]
+        if parent_class.respond_to?(:dn_attribute)
+          dn_attribute = parent_class.dn_attribute
         end
+        dn_attribute || "cn"
       end
 
       def default_prefix
-        if name.empty?
+        if name.blank?
           nil
         else
           "ou=#{name.demodulize.pluralize}"
@@ -666,7 +699,7 @@ module ActiveLdap
 
     def attribute_present?(name)
       values = get_attribute(name, true)
-      !values.empty? or values.any? {|x| not (x and x.empty?)}
+      !values.empty? or values.any? {|x| !(x and x.empty?)}
     end
 
     # exist?
@@ -863,7 +896,7 @@ module ActiveLdap
 
     def to_xml(options={})
       options = options.dup
-      options[:root] ||= self.class.name.underscore
+      options[:root] ||= (self.class.name || '').underscore
       except = options[:except]
       if except
         options[:except] = except.collect do |name|
@@ -883,7 +916,7 @@ module ActiveLdap
 
     def have_attribute?(name, except=[])
       real_name = to_real_attribute_name(name)
-      real_name and !except.include?(real_name)
+      !real_name.nil? and !except.include?(real_name)
     end
     alias_method :has_attribute?, :have_attribute?
 
@@ -930,7 +963,7 @@ module ActiveLdap
       end
       config = {:bind_dn => dn, :allow_anonymous => false}.merge(config)
       config[:password_block] ||= block if block_given?
-      establish_connection(config)
+      setup_connection(config)
 
       before_connection = @connection
       begin
@@ -970,8 +1003,8 @@ module ActiveLdap
       end.join(",")
     end
 
-    undef_method :base=
     def base=(object_local_base)
+      ensure_update_dn
       @dn = nil
       @base = object_local_base
     end
@@ -981,7 +1014,6 @@ module ActiveLdap
       @scope || scope_of_class
     end
 
-    undef_method :scope=
     def scope=(scope)
       self.class.validate_scope(scope)
       @scope = scope
@@ -1061,6 +1093,8 @@ module ActiveLdap
 
     def initialize_by_ldap_data(dn, attributes)
       init_base
+      dn = Compatible.convert_to_utf8_encoded_object(dn)
+      attributes = Compatible.convert_to_utf8_encoded_object(attributes)
       @dn = dn
       @new_entry = false
       @dn_is_base = false
@@ -1084,7 +1118,7 @@ module ActiveLdap
       obj
     end
 
-    def to_real_attribute_name(name, allow_normalized_name=false)
+    def to_real_attribute_name(name, allow_normalized_name=true)
       return name if name.nil?
       if allow_normalized_name
         entry_attribute.normalize(name, allow_normalized_name) ||
@@ -1356,8 +1390,12 @@ module ActiveLdap
 
         next if v == value
 
+        x = value
+        value = self.class.remove_blank_value(value) || []
+        next if v == value
+
         # Create mod entries
-        if value.empty?
+        if self.class.blank_value?(value)
           # Since some types do not have equality matching rules,
           # delete doesn't work
           # Replacing with nothing is equivalent.
@@ -1372,7 +1410,11 @@ module ActiveLdap
       end
       data.each do |k, v|
         value = v || []
-        next if ldap_data.has_key?(k) or value.empty?
+        next if ldap_data.has_key?(k)
+
+        value = self.class.remove_blank_value(value) || []
+        next if self.class.blank_value?(value)
+
 
         # Detect subtypes and account for them
         # REPLACE will function like ADD, but doesn't hit EQUALITY problems
@@ -1393,7 +1435,9 @@ module ActiveLdap
       oc_value = data['objectClass']
       attributes.push(['objectClass', oc_value])
       data.each do |key, value|
-        next if value.empty? or key == 'objectClass' or key == dn_attr
+        next if key == 'objectClass' or key == dn_attr
+        value = self.class.remove_blank_value(value)
+        next if self.class.blank_value?(value)
 
         attributes.push([key, value])
       end

data/lib/active_ldap/compatible.rb

@@ -0,0 +1,44 @@
+module ActiveLdap
+  module Compatible
+    module_function
+    if "".respond_to?(:force_encoding)
+      def convert_to_utf8_encoded_object(object)
+        case object
+        when Array
+          object.collect {|element| convert_to_utf8_encoded_object(element)}
+        when Hash
+          encoded = {}
+          object.each do |key, value|
+            key = convert_to_utf8_encoded_object(key)
+            value = convert_to_utf8_encoded_object(value)
+            encoded[key] = value
+          end
+          encoded
+        when String
+          encoded = object.dup
+          encoded.force_encoding("utf-8")
+          encoded = object unless encoded.valid_encoding?
+          encoded
+        else
+          object
+        end
+      end
+    else
+      def convert_to_utf8_encoded_object(object)
+        object
+      end
+    end
+
+    if "".respond_to?(:lines)
+      def string_to_lines(string)
+        string.lines.to_a
+      end
+    else
+      def string_to_lines(string)
+        ary = []
+        string.each_line{|l| ary << l}
+        ary
+      end
+    end
+  end
+end

data/lib/active_ldap/configuration.rb

@@ -31,14 +31,14 @@ module ActiveLdap
     DEFAULT_CONFIG[:password] = nil
     DEFAULT_CONFIG[:store_password] = true
     DEFAULT_CONFIG[:allow_anonymous] = true
-    DEFAULT_CONFIG[:sasl_quiet] = false
+    DEFAULT_CONFIG[:sasl_quiet] = true
     DEFAULT_CONFIG[:try_sasl] = false
     # See http://www.iana.org/assignments/sasl-mechanisms
     DEFAULT_CONFIG[:sasl_mechanisms] = ["GSSAPI", "DIGEST-MD5",
                                         "CRAM-MD5", "EXTERNAL"]
 
-    DEFAULT_CONFIG[:retry_limit] = 3
-    DEFAULT_CONFIG[:retry_wait] = 3
+    DEFAULT_CONFIG[:retry_limit] = 1
+    DEFAULT_CONFIG[:retry_wait] = 1
     DEFAULT_CONFIG[:timeout] = 0 # in seconds; 0 <= Never timeout
     # Whether or not to retry on timeouts
     DEFAULT_CONFIG[:retry_on_timeout] = true

data/lib/active_ldap/connection.rb

@@ -55,7 +55,7 @@ module ActiveLdap
       def clear_active_connection_name
         @active_connection_name = nil
         ObjectSpace.each_object(Class) do |klass|
-          if klass < self and !klass.name.empty?
+          if klass < self and !klass.name.blank?
             klass.instance_variable_set("@active_connection_name", nil)
           end
         end
@@ -81,9 +81,9 @@ module ActiveLdap
           config = adapter
           self.connection = instantiate_adapter(config)
         elsif adapter.nil?
-          raise ConnectionNotEstablished
+          raise ConnectionNotSetup
         else
-          establish_connection(adapter)
+          setup_connection(adapter)
         end
       end
 
@@ -115,15 +115,15 @@ module ActiveLdap
       def retrieve_connection
         conn = nil
         name = active_connection_name
-        raise ConnectionNotEstablished unless name
+        raise ConnectionNotSetup unless name
         conn = active_connections[name]
         if conn.nil?
           config = configuration(name)
-          raise ConnectionNotEstablished unless config
+          raise ConnectionNotSetup unless config
           self.connection = config
           conn = active_connections[name]
         end
-        raise ConnectionNotEstablished if conn.nil?
+        raise ConnectionNotSetup if conn.nil?
         conn
       end
 
@@ -136,12 +136,12 @@ module ActiveLdap
         config = configuration(key)
         conn = active_connections[key]
         remove_configuration_by_configuration(config)
-        active_connections.delete_if {|key, value| value == conn}
+        active_connections.delete_if {|_key, value| value == conn}
         conn.disconnect! if conn
         config
       end
 
-      def establish_connection(config=nil)
+      def setup_connection(config=nil)
         config = ensure_configuration(config)
         remove_connection
 
@@ -151,6 +151,15 @@ module ActiveLdap
         define_configuration(key, merge_configuration(config))
       end
 
+      def establish_connection(config=nil)
+        message =
+          _("ActiveLdap::Connection.establish_connection has been deprecated " \
+            "since 1.1.0. " \
+            "Please use ActiveLdap::Connection.setup_connection instead.")
+        ActiveSupport::Deprecation.warn(message)
+        setup_connection(config)
+      end
+
       # Return the schema object
       def schema
         connection.schema
@@ -164,7 +173,7 @@ module ActiveLdap
 
       private
       def active_connection_key(k=self)
-        k.name.empty? ? k.object_id : k.name
+        k.name.blank? ? k.object_id : k.name
       end
 
       def determine_active_connection_name
@@ -191,11 +200,22 @@ module ActiveLdap
       end
 
       def guess_available_adapter
-        Object.respond_to?(:java) ? "jndi" : "ldap"
+        if Object.respond_to?(:java)
+          "jndi"
+        else
+          ldap_ldif_path = $LOAD_PATH.find do |path|
+            File.exist?(File.join(path, "ldap", "ldif.rb"))
+          end
+          if ldap_ldif_path
+            "ldap"
+          else
+            "net-ldap"
+          end
+        end
       end
     end
 
-    def establish_connection(config=nil)
+    def setup_connection(config=nil)
       config = self.class.ensure_configuration(config)
       config = self.class.configuration.merge(config)
       config = self.class.merge_configuration(config, self)
@@ -204,6 +224,15 @@ module ActiveLdap
       self.class.define_configuration(dn, config)
     end
 
+    def establish_connection(config=nil)
+      message =
+        _("ActiveLdap::Connection#establish_connection has been deprecated " \
+          "since 1.1.0. " \
+          "Please use ActiveLdap::Connection#setup_connection instead.")
+      ActiveSupport::Deprecation.warn(message)
+      setup_connection(config)
+    end
+
     def remove_connection
       self.class.remove_connection(dn)
       @connection = nil
@@ -235,7 +264,7 @@ module ActiveLdap
         config = adapter
         @connection = self.class.instantiate_adapter(config)
       else
-        establish_connection(adapter)
+        setup_connection(adapter)
       end
     end
 

data/lib/active_ldap/distinguished_name.rb

@@ -124,6 +124,7 @@ module ActiveLdap
             result << scanner[1]
           end
         end
+        result.force_encoding("utf-8") if result.respond_to?(:force_encoding)
         result
       end
 

data/lib/active_ldap/get_text.rb

@@ -1,11 +1,4 @@
 if Object.const_defined?(:GetText)
-  require 'active_record/version'
-  active_record_version = [ActiveRecord::VERSION::MAJOR,
-                           ActiveRecord::VERSION::MINOR,
-                           ActiveRecord::VERSION::TINY]
-  if (active_record_version <=> [2, 2, 0]) < 0
-    require "gettext/active_record"
-  end
   ActiveLdap.const_set("GetText", GetText)
 end