module ActiveLdap::Configuration::ClassMethods

Constants

CONNECTION_CONFIGURATION_KEYS

Public Instance Methods

configuration(key=nil) click to toggle source
# File lib/active_ldap/configuration.rb, line 92
def configuration(key=nil)
  @@defined_configurations[key || active_connection_name]
end
default_configuration() click to toggle source
# File lib/active_ldap/configuration.rb, line 65
def default_configuration
  DEFAULT_CONFIG.dup
end
define_configuration(key, config) click to toggle source
# File lib/active_ldap/configuration.rb, line 96
def define_configuration(key, config)
  @@defined_configurations[key] = config
end
defined_configurations() click to toggle source
# File lib/active_ldap/configuration.rb, line 100
def defined_configurations
  @@defined_configurations
end
ensure_configuration(config=nil) click to toggle source
# File lib/active_ldap/configuration.rb, line 69
def ensure_configuration(config=nil)
  if config.nil?
    if defined?(LDAP_ENV)
      config = LDAP_ENV
    elsif defined?(Rails)
      config = Rails.env
    else
      config = {}
    end
  end

  if config.is_a?(Symbol) or config.is_a?(String)
    _config = configurations[config.to_s]
    unless _config
      raise ConnectionError,
            _("%s connection is not configured") % config
    end
    config = _config
  end

  config
end
merge_configuration(user_configuration, target=self) click to toggle source
# File lib/active_ldap/configuration.rb, line 129
def merge_configuration(user_configuration, target=self)
  configuration = parent_configuration(target).dup
  prepare_configuration(user_configuration).each do |key, value|
    case key
    when :base
      # Scrub before inserting
      target.base = value.gsub(/['}{#]/, '')
    when :scope, :ldap_scope
      if key == :ldap_scope
        message = _(":ldap_scope configuration option is deprecated. " \
                    "Use :scope instead.")
        ActiveLdap.deprecator.warn(message)
      end
      target.scope = value
      configuration[:scope] = value
    else
      configuration[key] = value
    end
  end
  configuration
end
parent_configuration(target) click to toggle source
# File lib/active_ldap/configuration.rb, line 115
def parent_configuration(target)
  if target.is_a?(Base)
    target = target.class
  else
    target = target.superclass
  end
  while target <= Base
    config = defined_configurations[target.active_connection_key]
    return config if config
    target = target.superclass
  end
  default_configuration
end
prepare_configuration(configuration) click to toggle source
# File lib/active_ldap/configuration.rb, line 151
def prepare_configuration(configuration)
  configuration = configuration.symbolize_keys
  uri = configuration.delete(:uri)
  return configuration unless uri

  begin
    uri = URI.parse(uri)
  rescue URI::InvalidURIError
    raise ConfigurationError.new(_("invalid URI: %s") % uri)
  end
  unless uri.is_a?(URI::LDAP)
    raise ConfigurationError.new(_("not a LDAP URI: %s") % uri.to_s)
  end

  merger = URIConfigurationMerger.new(uri)
  merger.merge(configuration)
end
remove_configuration_by_key(key) click to toggle source
# File lib/active_ldap/configuration.rb, line 104
def remove_configuration_by_key(key)
  @@defined_configurations.delete(key)
end