activeldap 1.0.0 → 1.0.1

data/CHANGES

@@ -1,3 +1,13 @@
+1.0.1:
+  * Fixed GetText integration.
+  * Fixed ActiveLdap::Base.find with ActiveLdap::DN. (Reported by Jeremy Pruitt)
+  * Fixed associated bugs. (Reported by CultureSpy)
+  * Supported ActiveLdap::Base#attribute_present? with nonexistence attribute.
+    (Reported by Matt Mencel)
+  * Added ActiveLdap::Base#.to_ldif_record.
+  * Improved inspect.
+  * Supported ActiveSupport 2.1.0.
+
 1.0.0:
   * Fixed GSSAPI auth failure. [#18764] (Reported by Lennon Day-Reynolds)
   * Supported Symbol as :dn_attribute_value. [#18921] (Requested by Nobody)

data/README

@@ -29,7 +29,6 @@ PREREQUISITES
 NOTES
 
   * Only GSSAPI SASL support exists due to Ruby/LDAP limitations
-  * The API is subject to change as this package slowly approaches 1.0.0
 
 
 INSTALL
@@ -100,7 +99,7 @@ list, please point out.
 * Kevin McCarthy: Patches.
 * Perry Smith: Patches, bug reports and indications.
 * Marc Dequènes: API suggestions.
-* Jeremy Pruitt: A bug report.
+* Jeremy Pruitt: Bug reports.
 * Bodaniel Jeanes:
   * A suggestion for behavior on simple bind with empty password.
   * Bug reports.
@@ -108,3 +107,5 @@ list, please point out.
 * David Morton: An API improvement idea.
 * Lennon Day-Reynolds: Bug reports.
 * Tilo: A bug report.
+* Matt Mencel: A bug report.
+* CultureSpy: A bug report.

data/examples/al-admin/po/en/al-admin.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: AL Admin 1.0.0\n"
+"Project-Id-Version: AL Admin 1.0.1\n"
 "POT-Creation-Date: 2008-02-09 14:25+0900\n"
 "PO-Revision-Date: 2007-08-19 09:44+0900\n"
 "Last-Translator: Kouhei Sutou <kou@cozmixng.org>\n"

data/examples/al-admin/po/ja/al-admin.po

@@ -5,7 +5,7 @@
 #
 msgid ""
 msgstr ""
-"Project-Id-Version: AL Admin 1.0.0\n"
+"Project-Id-Version: AL Admin 1.0.1\n"
 "POT-Creation-Date: 2008-02-09 14:25+0900\n"
 "PO-Revision-Date: 2007-11-04 16:02+0900\n"
 "Last-Translator: Kouhei Sutou <kou@cozmixng.org>\n"

data/examples/al-admin/po/nl/al-admin.po

@@ -6,7 +6,7 @@
 # Ace Suares <ace@suares.an>, 2007,2008.
 msgid ""
 msgstr ""
-"Project-Id-Version: AL Admin 1.0.0\n"
+"Project-Id-Version: AL Admin 1.0.1\n"
 "POT-Creation-Date: 2008-02-09 14:25+0900\n"
 "PO-Revision-Date: 2007-08-24 22:03+0900\n"
 "Last-Translator: Ace Suares <ace@suares.an>\n"

data/examples/al-admin/vendor/plugins/exception_notification/lib/exception_notifier.rb

@@ -33,25 +33,25 @@ class ExceptionNotifier < ActionMailer::Base
   @@sections = %w(request session environment backtrace)
   cattr_accessor :sections
 
-  def self.reloadable?; false; end
+  self.template_root = "#{File.dirname(__FILE__)}/../views"
+
+  def self.reloadable?() false end
 
   def exception_notification(exception, controller, request, data={})
+    content_type "text/plain"
+
     subject    "#{email_prefix}#{controller.controller_name}##{controller.action_name} (#{exception.class}) #{exception.message.inspect}"
 
     recipients exception_recipients
     from       sender_address
 
     body       data.merge({ :controller => controller, :request => request,
-                  :exception => exception, :host => request.env["HTTP_HOST"],
+                  :exception => exception, :host => (request.env["HTTP_X_FORWARDED_HOST"] || request.env["HTTP_HOST"]),
                   :backtrace => sanitize_backtrace(exception.backtrace),
                   :rails_root => rails_root, :data => data,
                   :sections => sections })
   end
 
-  def template_root
-    "#{File.dirname(__FILE__)}/../views"
-  end
-
   private
 
     def sanitize_backtrace(trace)
@@ -60,8 +60,7 @@ class ExceptionNotifier < ActionMailer::Base
     end
 
     def rails_root
-      return @rails_root if @rails_root
-      @rails_root = Pathname.new(RAILS_ROOT).cleanpath.to_s
+      @rails_root ||= Pathname.new(RAILS_ROOT).cleanpath.to_s
     end
 
 end

data/examples/al-admin/vendor/plugins/exception_notification/lib/exception_notifier_helper.rb

@@ -72,6 +72,7 @@ module ExceptionNotifierHelper
   
   def filter_sensitive_post_data_from_env(env_key, env_value)
     return env_value unless exclude_raw_post_parameters?
-    (env_key =~ /RAW_POST_DATA/i) ? PARAM_FILTER_REPLACEMENT : env_value
+    return PARAM_FILTER_REPLACEMENT if (env_key =~ /RAW_POST_DATA/i)
+    return @controller.filter_parameters({env_key => env_value}).values[0]
   end
 end

data/examples/al-admin/vendor/plugins/exception_notification/views/exception_notifier/_environment.rhtml

@@ -1,6 +1,6 @@
 <% max = @request.env.keys.max { |a,b| a.length <=> b.length } -%>
 <% @request.env.keys.sort.each do |key| -%>
-* <%= "%*-s: %s" % [max.length, key, filter_sensitive_post_data_from_env(key, @request.env[key].to_s.strip)] %>
+* <%= "%-*s: %s" % [max.length, key, filter_sensitive_post_data_from_env(key, @request.env[key].to_s.strip)] %>
 <% end -%>
 
 * Process: <%= $$ %>

data/examples/al-admin/vendor/plugins/exception_notification/views/exception_notifier/_request.rhtml

@@ -1,3 +1,4 @@
-* URL: <%= @request.protocol %><%= @host %><%= @request.request_uri %>
+* URL       : <%= @request.protocol %><%= @host %><%= @request.request_uri %>
+* IP address: <%= @request.env["HTTP_X_FORWARDED_FOR"] || @request.env["REMOTE_ADDR"] %>
 * Parameters: <%= filter_sensitive_post_data_parameters(@request.parameters).inspect %>
 * Rails root: <%= @rails_root %>

data/lib/active_ldap.rb

@@ -917,12 +917,18 @@ end
 
 require_gem_if_need.call("active_support", "activesupport")
 
-if Dependencies.respond_to?(:load_paths)
-  Dependencies.load_paths << File.expand_path(File.dirname(__FILE__))
+if ActiveSupport.const_defined?(:Dependencies)
+  dependencies = ActiveSupport::Dependencies
+else
+  dependencies = Dependencies
+end
+
+if dependencies.respond_to?(:load_paths)
+  dependencies.load_paths << File.expand_path(File.dirname(__FILE__))
 end
 
 module ActiveLdap
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end
 
 if RUBY_PLATFORM.match('linux')

data/lib/active_ldap/action_controller/ldap_benchmarking.rb

@@ -0,0 +1,36 @@
+module ActiveLdap
+  module ActionController
+    module LdapBenchmarking
+      def self.included(base)
+        base.class_eval do
+          alias_method_chain :render, :active_ldap_benchmark
+          alias_method_chain :rendering_runtime, :active_ldap
+        end
+      end
+
+      protected
+      def render_with_active_ldap_benchmark(*args, &block)
+        if logger
+          @ldap_runtime_before_render = ActiveLdap::Base.reset_runtime
+          result = render_without_active_ldap_benchmark(*args, &block)
+          @ldap_runtime_after_render = ActiveLdap::Base.reset_runtime
+          @rendering_runtime -= @ldap_runtime_after_render
+          result
+        else
+          render_without_active_ldap_benchmark(*args, &block)
+        end
+      end
+
+      private
+      def rendering_runtime_with_active_ldap(runtime)
+        result = rendering_runtime_without_active_ldap(runtime)
+        ldap_runtime = ActiveLdap::Base.reset_runtime
+        ldap_runtime += @ldap_runtime_before_render || 0
+        ldap_runtime += @ldap_runtime_after_render || 0
+        ldap_percentage = ldap_runtime * 100 / runtime
+        result + (" | LDAP: %.5f (%d%%)" % [ldap_runtime, ldap_percentage])
+      end
+    end
+  end
+end
+

data/lib/active_ldap/adapter/jndi.rb

@@ -82,7 +82,7 @@ module ActiveLdap
             :name => "modify: RDN", :dn => dn, :new_rdn => new_rdn,
             :delete_old_rdn => delete_old_rdn,
           }
-          execute(:modify_rdn, dn, new_rdn, delete_old_rdn)
+          execute(:modify_rdn, info, dn, new_rdn, delete_old_rdn)
         end
       end
 

data/lib/active_ldap/adapter/jndi_connection.rb

@@ -103,7 +103,7 @@ module ActiveLdap
         controls = SearchControls.new
         controls.search_scope = scope
 
-        if attrs && !attrs.empty?
+        unless attrs.blank?
           controls.returning_attributes = attrs.to_java(:string)
         end
 
@@ -168,6 +168,7 @@ module ActiveLdap
         if password
           context.add_to_environment(Context::SECURITY_CREDENTIALS, password)
         end
+        context.reconnect(nil)
         @context = context
       end
 

data/lib/active_ldap/association/belongs_to_many.rb

@@ -6,7 +6,11 @@ module ActiveLdap
       private
       def insert_entry(entry)
         old_value = entry[@options[:many], true]
-        new_value = old_value + @owner[@options[:foreign_key_name], true]
+        foreign_key_name = @options[:foreign_key_name]
+        if foreign_key_name == "dn"
+          old_value = dn_values_to_string_values(old_value)
+        end
+        new_value = old_value + @owner[foreign_key_name, true]
         new_value = new_value.uniq.sort
         if old_value != new_value
           entry[@options[:many]] = new_value
@@ -17,7 +21,11 @@ module ActiveLdap
       def delete_entries(entries)
         entries.each do |entry|
           old_value = entry[@options[:many], true]
-          new_value = old_value - @owner[@options[:foreign_key_name], true]
+          foreign_key_name = @options[:foreign_key_name]
+          if foreign_key_name == "dn"
+            old_value = dn_values_to_string_values(old_value)
+          end
+          new_value = old_value - @owner[foreign_key_name, true]
           new_value = new_value.uniq.sort
           if old_value != new_value
             entry[@options[:many]] = new_value

data/lib/active_ldap/association/collection.rb

@@ -78,6 +78,16 @@ module ActiveLdap
 
         result && self
       end
+
+      def dn_values_to_string_values(values)
+        values.collect do |value|
+          if value.is_a?(DN)
+            value.to_s
+          else
+            value
+          end
+        end
+      end
     end
   end
 end

data/lib/active_ldap/association/has_many_utils.rb

@@ -8,18 +8,22 @@ module ActiveLdap
 
         requested_targets = @owner[@options[requested_target_key], true]
 
-        components = requested_targets.reject(&:nil?)
-        unless foreign_base_key == "dn"
-          components = components.collect do |value|
-            [foreign_base_key, value]
-          end
-        end
-
-        if components.empty?
+        requested_targets = requested_targets.reject(&:nil?)
+        if requested_targets.empty?
           targets = []
         elsif foreign_base_key == "dn"
-          targets = foreign_class.find(components, find_options)
+          requested_targets = requested_targets.collect do |target|
+            if target.is_a?(DN)
+              target.to_s
+            else
+              target
+            end
+          end
+          targets = foreign_class.find(requested_targets, find_options)
         else
+          components = requested_targets.collect do |value|
+            [foreign_base_key, value]
+          end
           options = find_options(:filter => [:or, *components])
           targets = foreign_class.find(:all, options)
         end

data/lib/active_ldap/association/has_many_wrap.rb

@@ -9,7 +9,11 @@ module ActiveLdap
       private
       def insert_entry(entry)
         old_value = @owner[@options[:wrap], true]
-        new_value = (old_value + entry[primary_key, true]).uniq.sort
+        _primary_key = primary_key
+        if _primary_key == "dn"
+          old_value = dn_values_to_string_values(old_value)
+        end
+        new_value = (old_value + entry[_primary_key, true]).uniq.sort
         if old_value != new_value
           @owner[@options[:wrap]] = new_value
           @owner.save
@@ -18,7 +22,11 @@ module ActiveLdap
 
       def delete_entries(entries)
         old_value = @owner[@options[:wrap], true]
-        new_value = old_value - entries.collect {|entry| entry[primary_key]}
+        _primary_key = primary_key
+        if _primary_key == "dn"
+          old_value = dn_values_to_string_values(old_value)
+        end
+        new_value = old_value - entries.collect {|entry| entry[_primary_key]}
         new_value = new_value.uniq.sort
         if old_value != new_value
           @owner[@options[:wrap]] = new_value

data/lib/active_ldap/associations.rb

@@ -44,7 +44,7 @@ module ActiveLdap
       #
       def belongs_to(association_id, options={})
         validate_belongs_to_options(options)
-        klass = options[:class] || Inflector.classify(association_id)
+        klass = options[:class] || association_id.to_s.classify
         foreign_key = options[:foreign_key]
         primary_key = options[:primary_key]
         many = options[:many]
@@ -96,8 +96,8 @@ module ActiveLdap
       #            :wrap => "memberUid" # Group#memberUid
       def has_many(association_id, options = {})
         validate_has_many_options(options)
-        klass = options[:class] || Inflector.classify(association_id)
-        foreign_key = options[:foreign_key] || association_id.to_s + "_id"
+        klass = options[:class] || association_id.to_s.classify
+        foreign_key = options[:foreign_key] || "#{association_id}_id"
         primary_key = options[:primary_key]
         set_associated_class(association_id, klass)
 

data/lib/active_ldap/base.rb

@@ -105,6 +105,14 @@ module ActiveLdap
   class StrongAuthenticationRequired < Error
   end
 
+  class DistinguishedNameInputInvalid < Error
+    attr_reader :input
+    def initialize(input=nil)
+      @input = input
+      super(_("invalid distinguished name (DN) to parse: %s") % @input.inspect)
+    end
+  end
+
   class DistinguishedNameInvalid < Error
     attr_reader :dn, :reason
     def initialize(dn, reason=nil)
@@ -293,6 +301,13 @@ module ActiveLdap
       # Hide new in Base
       private :new
 
+      def inherited(sub_class)
+        super
+        sub_class.module_eval do
+          include GetTextSupport
+        end
+      end
+
       # Connect and bind to LDAP creating a class variable for use by
       # all ActiveLdap objects.
       #
@@ -420,7 +435,52 @@ module ActiveLdap
         dn_attribute
       end
 
+      def inspect
+        if self == Base
+          super
+        else
+          class_names = []
+          must = []
+          may = []
+          class_names = classes.collect do |object_class|
+            must.concat(object_class.must)
+            may.concat(object_class.may)
+            object_class.name
+          end
+          detail = ["objectClass:<#{class_names.join(', ')}>",
+                    "must:<#{inspect_attributes(must)}>",
+                    "may:<#{inspect_attributes(may)}>"].join(", ")
+          "#{super}(#{detail})"
+        end
+      end
+
       private
+      def inspect_attributes(attributes)
+	inspected_attribute_names = {}
+        attributes.collect do |attribute|
+          if inspected_attribute_names.has_key?(attribute.name)
+            nil
+          else
+            inspected_attribute_names[attribute.name] = true
+            inspect_attribute(attribute)
+          end
+        end.compact.join(', ')
+      end
+
+      def inspect_attribute(attribute)
+        syntax = attribute.syntax
+        result = "#{attribute.name}"
+        if syntax and !syntax.description.blank?
+          result << ": #{syntax.description}"
+        end
+        properties = []
+        properties << "read-only" if attribute.read_only?
+        properties << "binary" if attribute.binary?
+        properties << "binary-required" if attribute.binary_required?
+        result << "(#{properties.join(', ')})" unless properties.empty?
+        result
+      end
+
       def validate_ldap_mapping_options(options)
         options.assert_valid_keys(VALID_LDAP_MAPPING_OPTIONS)
       end
@@ -466,7 +526,7 @@ module ActiveLdap
           end
           dn_attribute || "cn"
         else
-          Inflector.underscore(Inflector.demodulize(name))
+          name.demodulize.underscore
         end
       end
 
@@ -474,7 +534,7 @@ module ActiveLdap
         if name.empty?
           nil
         else
-          "ou=#{Inflector.pluralize(Inflector.demodulize(name))}"
+          "ou=#{name.demodulize.pluralize}"
         end
       end
     end
@@ -685,7 +745,7 @@ module ActiveLdap
     # Add available attributes to the methods
     def methods(inherited_too=true)
       target_names = entry_attribute.all_names
-      target_names -= ['objectClass', Inflector.underscore('objectClass')]
+      target_names -= ['objectClass', 'objectClass'.underscore]
       super + target_names.uniq.collect do |x|
         [x, "#{x}=", "#{x}?", "#{x}_before_type_cast"]
       end.flatten
@@ -748,12 +808,16 @@ module ActiveLdap
       end
     end
 
+    def to_ldif_record
+      super(dn, normalize_data(@data))
+    end
+
     def to_ldif
-      super(dn, @data)
+      Ldif.new([to_ldif_record]).to_s
     end
 
     def to_xml(options={})
-      root = options[:root] || Inflector.underscore(self.class.name)
+      root = options[:root] || self.class.name.underscore
       result = "<#{root}>\n"
       result << "  <dn>#{dn}</dn>\n"
       normalize_data(@data).sort_by {|key, values| key}.each do |key, values|
@@ -879,18 +943,36 @@ module ActiveLdap
     end
 
     def inspect
-      abbreviate_instance_variables do
-        super
-      end
+      object_classes = entry_attribute.object_classes
+      inspected_object_classes = object_classes.collect do |object_class|
+        object_class.name
+      end.join(', ')
+      must_attributes = must.collect(&:name).sort.join(', ')
+      may_attributes = may.collect(&:name).sort.join(', ')
+      inspected_attributes = attribute_names.sort.collect do |name|
+        inspect_attribute(name)
+      end.join(', ')
+      result = "\#<#{self.class} objectClass:<#{inspected_object_classes}>, "
+      result << "must:<#{must_attributes}>, may:<#{may_attributes}>, "
+      result << "#{inspected_attributes}>"
+      result
     end
 
-    def pretty_print(q)
-      abbreviate_instance_variables do
-        q.pp_object(self)
+    private
+    def inspect_attribute(name)
+      values = get_attribute(name, true)
+      values.collect do |value|
+        if value.is_a?(String) and value.length > 50
+          "#{value[0, 50]}...".inspect
+        elsif value.is_a?(Date) || value.is_a?(Time)
+          "#{value.to_s(:db)}"
+        else
+          value.inspect
+        end
       end
+      "#{name}: #{values.inspect}"
     end
 
-    private
     def attribute_name_resolvable_without_connection?
       @entry_attribute and @local_entry_attribute
     end
@@ -903,26 +985,6 @@ module ActiveLdap
       @local_entry_attribute ||= connection.entry_attribute([])
     end
 
-    def abbreviate_instance_variables
-      @abbreviating ||= nil
-      connection, @connection = @connection, nil
-      schema, @schema = @schema, nil
-      entry_attribute, @entry_attribute = @entry_attribute, nil
-      local_entry_attribute, @local_entry_attribute = @local_entry_attribute, nil
-      real_names, @real_names = @real_names, nil
-      unless @abbreviating
-        @abbreviating = true
-      end
-      yield
-    ensure
-      @connection = connection
-      @schema = schema
-      @entry_attribute = entry_attribute
-      @local_entry_attribute = local_entry_attribute
-      @real_names = real_names
-      @abbreviating = false
-    end
-
     def extract_object_class(attributes)
       classes = []
       attrs = {}
@@ -1006,6 +1068,7 @@ module ActiveLdap
     # Return the value of the attribute called by method_missing?
     def get_attribute(name, force_array=false)
       name, value = get_attribute_before_type_cast(name, force_array)
+      return value if name.nil?
       attribute = schema.attribute(name)
       type_cast(attribute, value)
     end