activeldap 4.0.3 → 4.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 68d1e26bd0a299b5afa18d537f9c0dc973798acb
-  data.tar.gz: 354eae82bd94b70f77d0f3a62b66ec45cc69afef
+  metadata.gz: 4c12549921e8f9d7aa8674add95bc2f48f82afdd
+  data.tar.gz: dd5633df0f5fc5ce5241ff4d77545bc243b8becb
 SHA512:
-  metadata.gz: 248bab09098603beb4c65c1a4a01461f2330a82a7bc1d65eaca4cd8c1ce393d9a6a7457dd6fbf5e653ca97af5c91b85c3d13c5f92aea487f839b589896f1f1d0
-  data.tar.gz: 4d502e9d14654390f95c1d2dae264144e28490662dd3739c492b9413b107ba809ceb2aed0b0baa40ae3eb8adcc1b8d9627dad66f4b6701edf5446e986b83625d
+  metadata.gz: 8ef5b66f2ece4f6eea6b6c46db97df52e97dd72b3d80e47d4027ed135346780f90de594b3bce5a2cae221d1f186fb3e225627600a8bd786b2326713388064efa
+  data.tar.gz: 580ccd4daf6d3625358be6c7ccba2f3a64aee0722dd8e9d7b2bc354c32120915692d42c59287054b1edb6cb37aee42f6b2cacfd4b0d5ead69be200b6e75f2008

data/README.textile

@@ -14,7 +14,7 @@ flexible as ActiveRecord, but it is still trivial to define
 new objects and manipulate them with minimal difficulty.
 
 For example and usage - read the
-"document":http://ruby-activeldap.rubyforge.org/.
+"document":http://activeldap.github.io/.
 
 h2. Prerequisites
 
@@ -29,8 +29,8 @@ See the above links for installation.
 JRuby doesn't need to install new library because JRuby
 has builtin LDAP support. Ruby users need one of them:
 
-* "Ruby/LDAP":http://rubyforge.org/projects/ruby-ldap/
-* "Net::LDAP":http://rubyforge.org/projects/net-ldap/
+* "Ruby/LDAP":http://ruby-ldap.sourceforge.net/
+* "Net::LDAP":http://rubyldap.com/
 
 See the above links for installation.
 =:

data/doc/text/news.textile

@@ -1,5 +1,46 @@
 h1. News
 
+h2(#release-4-0-4). 4.0.4: 2014-10-11
+
+h3. Improvements
+
+* Migrated to commit mail mailing list to "Google
+  Groups":https://groups.google.com/forum/?hl=ja#!forum/activeldap-commit
+  from RubyForge. Thanks to RubyForge! RubyForge was very helpful!
+* Update project homepage URL in README.
+  [GitHub#103] [Patch by Adam Whittingham]
+* Removed needless @Enumerable@ inclusion in @ActiveLdap::Base@.
+  [GitHub#104] [Patch by Murray Steele]
+* {ActiveLdap::Populate.ensure_base}: Supported ou entry creation in base DN.
+* Added @follow_referrals@ configuration. You can disable auto
+  referrals following by specifying @false@. It is useful when you
+  can't access referrals.
+
+  This configuration is enabled by default.
+
+  This configuration works only with ruby-ldap adapter.
+
+  [GitHub#99] [Suggested by hadmut]
+
+* Supported @bindname@ extension in LDAP URL such as
+  @ldap://host/dc=base,dc=name????bindname=cn%3Dadmin%2Cdc%3Dexample%2Cdc%3Dcom%3F@.
+
+h3. Fixes
+
+* Fixed a bug logging is failed on removing a connection.
+  [GitHub#94] [Reported by Francisco Miguel Biete]
+* Fixed homepage URL in RubyGems.
+  [GitHub#95] [Patch by Vít Ondruch]
+* Fixed a bug that DN in LDAP URL is used as bind DN not base DN.
+
+h3. Thanks
+
+* Francisco Miguel Biete
+* Vít Ondruch
+* Adam Whittingham
+* Murray Steele
+* hadmut
+
 h2(#4-0-3). 4.0.3: 2014-05-15
 
 h3. Improvements

data/examples/useradd

@@ -25,6 +25,8 @@ end
 
 ActiveLdap::Base.setup_connection(:password_block => pwb,
                                   :allow_anonymous => false)
+ActiveLdap::Populate.ensure_base
+ActiveLdap::Populate.ensure_ou(User.prefix)
 
 if User.exists?(name)
   $stderr.puts("User #{name} already exists.")

data/lib/active_ldap/adapter/base.rb

@@ -8,13 +8,26 @@ module ActiveLdap
     class Base
       include GetTextSupport
 
-      VALID_ADAPTER_CONFIGURATION_KEYS = [:host, :port, :method, :timeout,
-                                          :retry_on_timeout, :retry_limit,
-                                          :retry_wait, :bind_dn, :password,
-                                          :password_block, :try_sasl,
-                                          :sasl_mechanisms, :sasl_quiet,
-                                          :allow_anonymous, :store_password,
-                                          :scope, :sasl_options]
+      VALID_ADAPTER_CONFIGURATION_KEYS = [
+        :host,
+        :port,
+        :method,
+        :timeout,
+        :retry_on_timeout,
+        :retry_limit,
+        :retry_wait,
+        :bind_dn,
+        :password,
+        :password_block,
+        :try_sasl,
+        :sasl_mechanisms,
+        :sasl_quiet,
+        :allow_anonymous,
+        :store_password,
+        :scope,
+        :sasl_options,
+        :follow_referrals,
+      ]
 
       @@row_even = true
 
@@ -24,12 +37,14 @@ module ActiveLdap
         @bound = false
         @bind_tried = false
         @entry_attributes = {}
+        @follow_referrals = nil
         @configuration = configuration.dup
         @logger = @configuration.delete(:logger)
         @configuration.assert_valid_keys(VALID_ADAPTER_CONFIGURATION_KEYS)
         VALID_ADAPTER_CONFIGURATION_KEYS.each do |name|
           instance_variable_set("@#{name}", configuration[name])
         end
+        @follow_referrals = true if @follow_referrals.nil?
         @instrumenter = ActiveSupport::Notifications.instrumenter
       end
 
@@ -246,6 +261,15 @@ module ActiveLdap
         end
       end
 
+      def follow_referrals?(options={})
+        option_follow_referrals = options[:follow_referrals]
+        if option_follow_referrals.nil?
+          @follow_referrals
+        else
+          option_follow_referrals
+        end
+      end
+
       def prepare_connection(options)
       end
 
@@ -658,8 +682,10 @@ module ActiveLdap
 
       def log(name, info=nil)
         result = nil
-        payload = {:name => name}
-        payload[:info] = info if info
+        payload = {
+          :name => name,
+          :info => info || {},
+        }
         @instrumenter.instrument("log_info.active_ldap", payload) do
           result = yield if block_given?
         end

data/lib/active_ldap/adapter/ldap.rb

@@ -189,6 +189,9 @@ module ActiveLdap
       def prepare_connection(options={})
         operation(options) do
           @connection.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
+          unless follow_referrals?(options)
+            @connection.set_option(LDAP::LDAP_OPT_REFERRALS, 0)
+          end
         end
       end
 

data/lib/active_ldap/base.rb

@@ -656,8 +656,6 @@ module ActiveLdap
     self.recommended_classes = []
     self.excluded_classes = []
 
-    include Enumerable
-
     ### All instance methods, etc
 
     # new

data/lib/active_ldap/configuration.rb

@@ -1,3 +1,5 @@
+require "English"
+require "cgi"
 require 'uri'
 begin
   require 'uri/ldaps'
@@ -43,6 +45,7 @@ module ActiveLdap
     DEFAULT_CONFIG[:timeout] = 0 # in seconds; 0 <= Never timeout
     # Whether or not to retry on timeouts
     DEFAULT_CONFIG[:retry_on_timeout] = true
+    DEFAULT_CONFIG[:follow_referrals] = true
 
     DEFAULT_CONFIG[:logger] = nil
 
@@ -96,7 +99,7 @@ module ActiveLdap
       def remove_connection_related_configuration(config)
         config.reject do |key, value|
           CONNECTION_CONFIGURATION_KEYS.include?(key)
-	end
+        end
       end
 
       def merge_configuration(user_configuration, target=self)
@@ -135,12 +138,49 @@ module ActiveLdap
           raise ConfigurationError.new(_("not a LDAP URI: %s") % uri.to_s)
         end
 
-        uri_configuration = {:port => uri.port}
-        uri_configuration[:host] = uri.host if uri.host
-        uri_configuration[:bind_dn] = uri.dn if uri.dn
-        uri_configuration[:scope] = uri.scope if uri.scope
-        uri_configuration[:method] = :ssl if uri.is_a?(URI::LDAPS)
-        uri_configuration.merge(configuration)
+        merger = URIConfigurationMerger.new(uri)
+        merger.merge(configuration)
+      end
+
+      class URIConfigurationMerger
+        def initialize(uri)
+          @uri = uri
+        end
+
+        def merge(configuration)
+          uri_configuration = {:port => @uri.port}
+          uri_configuration[:host] = @uri.host if @uri.host
+          uri_configuration[:base] = @uri.dn if @uri.dn
+          extensions = parse_extensions
+          bindname_extension = extensions["bindname"]
+          if bindname_extension
+            uri_configuration[:bind_dn] = bindname_extension[:value]
+            uri_configuration[:allow_anonymous] = !bindname_extension[:critical]
+          end
+          uri_configuration[:scope] = @uri.scope if @uri.scope
+          uri_configuration[:method] = :ssl if @uri.is_a?(URI::LDAPS)
+          uri_configuration.merge(configuration)
+        end
+
+        private
+        def parse_extensions
+          extensions = {}
+          (@uri.extensions || "").split(",").collect do |extension|
+            name, value = extension.split("=", 2)
+            case name
+            when /\A!/
+              critical = true
+              name = $POSTMATCH
+            else
+              critical = false
+            end
+            extensions[name] = {
+              :critical => critical,
+              :value => CGI.unescape(value || ""),
+            }
+          end
+          extensions
+        end
       end
     end
   end

data/lib/active_ldap/log_subscriber.rb

@@ -23,19 +23,20 @@ module ActiveLdap
       return unless logger.debug?
 
       payload = event.payload
+      info = payload[:info] || {}
       label = payload[:name]
-      label += ": FAILED" if payload[:info][:exception]
+      label += ": FAILED" if info[:exception]
       name = 'LDAP: %s (%.1fms)' % [label, event.duration]
-      info = payload[:info].inspect
+      inspected_info = info.inspect
 
       if odd?
         name = color(name, CYAN, true)
-        info = color(info, nil, true)
+        inspected_info = color(inspected_info, nil, true)
       else
         name = color(name, MAGENTA, true)
       end
 
-      debug "  #{name} #{info}"
+      debug "  #{name} #{inspected_info}"
     end
 
     def odd?

data/lib/active_ldap/populate.rb

@@ -12,16 +12,27 @@ module ActiveLdap
         name, value = rdn.to_a[0]
         prefix = suffixes.join(",")
         suffixes.unshift("#{name}=#{value}")
-        next unless name == "dc"
         begin
-          ensure_dc(value, prefix, base_class)
+          case name.downcase
+          when "dc"
+            ensure_dc(value, prefix, base_class)
+          when "ou"
+            ensure_ou(value,
+                      :base => prefix,
+                      :base_class => base_class)
+          end
         rescue ActiveLdap::OperationNotPermitted
         end
       end
     end
 
-    def ensure_ou(name, base_class=nil)
-      base_class ||= Base
+    def ensure_ou(name, options={})
+      if options.is_a?(Class)
+        base_class = options
+        options = {}
+      else
+        base_class = options[:base_class] || Base
+      end
       name = name.to_s if name.is_a?(DN)
       name = name.gsub(/\Aou\s*=\s*/i, '')
 
@@ -29,6 +40,7 @@ module ActiveLdap
       ou_class.ldap_mapping(:dn_attribute => "ou",
                             :prefix => "",
                             :classes => ["top", "organizationalUnit"])
+      ou_class.base = options[:base]
       return if ou_class.exist?(name)
       ou_class.new(name).save!
     end

data/lib/active_ldap/version.rb

@@ -1,3 +1,3 @@
 module ActiveLdap
-  VERSION = "4.0.3"
+  VERSION = "4.0.4"
 end

data/test/al-test-utils.rb

@@ -82,7 +82,7 @@ module AlTestUtils
     @@certificate = nil
     def certificate
       return @@certificate if @@certificate
-      if File.exists?(certificate_path)
+      if File.exist?(certificate_path)
         @@certificate = read_binary_file(certificate_path)
         return @@certificate
       end

data/test/test_base.rb

@@ -811,7 +811,7 @@ class TestBase < Test::Unit::TestCase
                           :classes => ["top", "organizationalUnit"])
     assert_equal(["ou=Groups,#{current_configuration['base']}",
                   "ou=Users,#{current_configuration['base']}"],
-                 ou_class.find(:all).collect(&:dn).sort)
+                 ou_class.find(:all).collect(&:dn).collect(&:to_s).sort)
   end
 
   def test_ldap_mapping_validation

data/test/test_configuration.rb

@@ -6,25 +6,26 @@ class TestConfiguration < Test::Unit::TestCase
   priority :normal
   def test_prepare_configuration_with_silent_uri
     configuration = {
-      :bind_dn => "cn=admin,dc=example,dc=com",
+      :base => "dc=example,dc=com",
       :password => "secret",
-      :uri => "ldap://example.com/cn=ignore,dc=me"
+      :uri => "ldap://example.com/dc=ignore,dc=me"
     }
     prepared_configuration =
       ActiveLdap::Base.prepare_configuration(configuration)
     assert_equal({
                    :host => "example.com",
                    :port => 389,
-                   :bind_dn => "cn=admin,dc=example,dc=com",
+                   :base => "dc=example,dc=com",
                    :password => "secret",
                  },
                  prepared_configuration)
   end
 
   def test_prepare_configuration_with_detailed_uri
+    bind_dn = "cn=admin,dc=example,dc=com"
     configuration = {
       :host => "example.net",
-      :uri => "ldaps://example.com/cn=admin,dc=example,dc=com??sub"
+      :uri => "ldaps://example.com/dc=example,dc=com??sub??!bindname=#{CGI.escape(bind_dn)}"
     }
     prepared_configuration =
       ActiveLdap::Base.prepare_configuration(configuration)
@@ -32,8 +33,10 @@ class TestConfiguration < Test::Unit::TestCase
                    :host => "example.net",
                    :port => 636,
                    :method => :ssl,
-                   :bind_dn => "cn=admin,dc=example,dc=com",
+                   :base => "dc=example,dc=com",
                    :scope => "sub",
+                   :bind_dn => "cn=admin,dc=example,dc=com",
+                   :allow_anonymous => false,
                  },
                  prepared_configuration)
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: activeldap
 version: !ruby/object:Gem::Version
-  version: 4.0.3
+  version: 4.0.4
 platform: ruby
 authors:
 - Will Drewry
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-13 00:00:00.000000000 Z
+date: 2014-10-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -326,7 +326,7 @@ files:
 - test/test_usermod-lang-add.rb
 - test/test_usermod.rb
 - test/test_validation.rb
-homepage: http://ruby-activeldap.rubyforge.org/
+homepage: http://activeldap.github.io/
 licenses:
 - Ruby's
 - GPLv2 or later