Module: LdapQuery

Defined in:
lib/ldap_query/error.rb,
lib/ldap_query/query.rb,
lib/ldap_query/config.rb,
lib/ldap_query/filter.rb,
lib/ldap_query/railtie.rb,
lib/ldap_query/version.rb,
lib/ldap_query/connection.rb,
lib/ldap_query/ldap_query.rb,
lib/ldap_query/ldap_helper.rb,
lib/ldap_query/authenticate.rb,
lib/ldap_query/rails_credentials.rb

Overview

Used to initialize and container the LdapQuery modules

Defined Under Namespace

Modules: LdapHelper Classes: AttributeError, Authenticate, Config, ConfigError, Connection, ConnectionError, CredentialsError, Error, Filter, Query, RailsCredentials, Railtie

Constant Summary collapse

VERSION = 
'0.0.1'
EMPTY_ARRAY = 
[].freeze
EMPTY_HASH = 
{}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#config ⇒ Object

Returns the value of attribute config.



5
6
7
 
# File 'lib/ldap_query/ldap_query.rb', line 5

def config
  @config
end

#ldap ⇒ Object

Returns the value of attribute ldap.



5
6
7
 
# File 'lib/ldap_query/ldap_query.rb', line 5

def ldap
  @ldap
end

Class Method Details

.configure(config_hash = {}) ⇒ Class <LdapQuery::Config>

Reconfigure the LdapQuery credential configuration

Parameters:

  • config_hash (Hash) (defaults to: {})

Returns:

Raises:



16
17
18
19
20
21
22
 
# File 'lib/ldap_query/ldap_query.rb', line 16

def self.configure(config_hash = {})
  raise(ConfigError, 'a valid configuration hash must be passed.') unless config_hash.is_a?(Hash)

  # if new a new config_hash hash been passed, create a new Config instance
  @config = LdapQuery::Config.new(config_hash) unless config_hash.empty?
  @config
end