ldapmapper 1.0.0

data/lib/ldapmapper.rb

@@ -0,0 +1,522 @@
+#!/Usr/bin/env ruby
+#
+# = LdapMapper : LDAP CRUD Object 
+#
+# == Copyright Ultragreen (c) 2005
+#
+# == About :
+# 
+# * Author:: Romain GEORGES 
+# * type:: class definition Ruby
+# * obj:: Generic LDAP class 
+# * CVS Version:: $Id: ldapmapper.rb,v 1.1.1.1 2006/09/09 10:57:45 lecid Exp $
+#
+# == Exemples :
+#
+#   #!/usr/local/bin/ruby
+#   require 'rubygems'
+#   require_gem 'ldapmapper'
+#   include Ldapmapper
+#   _basedn = 'dc=__domaine__,dc=__tld__'
+#   _dn = "ou=toto,#{_basedn}"
+#   record = LdapMapper.new(_dn,'__secret__',"cn=root,#{_basedn}")
+#   puts "- Could create it ? : #{record.can_create?}"
+#   puts "- Already exist ? : #{record.exist?}"
+#   puts "- Is it a node ? : #{record.is_node?}"
+#   puts "- Is it the base ? : #{record.is_base?}"
+#   if record.exist? then
+#     puts "- ObjectClasses list :"
+#     record.list_objectclass.each{|objectclass|
+#       puts "  * #{objectclass}"
+#     }
+#     puts "- Attributes list : "
+#     record.list_attributs.each{|attribute,value|
+#       if value.size > 1 then
+#         puts "* #{attribute} ="
+#         value.each{|val| puts "  - #{val}"
+#         }
+#       else
+#         puts "* #{attribute} = #{value}"
+#       end
+#     }
+#     puts record.description
+#     record.description = `date`
+#     record.commit!
+#   elsif record.can_create?
+#     record.add_objectclass!('organizationalUnit')
+#     record.ou = 'toto'
+#     record.description = "Test"
+#     p record.must
+#     p record.may
+#     record.commit!
+#   else
+#     puts "kaboum!"
+#   end
+#
+# <b>first running :</b>
+#
+#    - Could create it ? : true
+#    - Already exist ? : false
+#    - Is it a node ? : false
+#    - Is it the base ? : false
+#    ["ou", "objectClass", "dn"]
+#    ["physicalDeliveryOfficeName", "l", "st", "telexNumber", "destinationIndicator", "businessCategory",
+#    "postalAddress", "telephoneNumber", "searchGuide", "internationaliSDNNumber", "preferredDeliveryMethod",
+#    "description", "postalCode", "teletexTerminalIdentifier", "userPassword", "street",
+#    "registeredAddress", "postOfficeBox", "facsimileTelephoneNumber", "seeAlso", "x121Address"]
+#
+# <b>second ruuning :</b>
+#
+#    - Could create it ? : false
+#    - Already exist ? : true
+#    - Is it a node ? : false
+#    - Is it the base ? : false
+#    - ObjectClasses list :
+#      * top
+#      * organizationalUnit
+#    - Attributes list : 
+#      * description = Jeu  7 sep 2006 16:11:44 CEST
+#      * ou = toto
+#      * objectClass =
+#        - top
+#        - organizationalUnit
+#      * dn = ou=toto,dc=ultragreen,dc=net
+#    Jeu  7 sep 2006 16:11:44 CEST 
+
+
+# require the LDAP's scheme and LDAP librairies
+require 'ldap'
+require "ldap/schema"
+
+
+# General module for LDAP CRUD Ojects
+module Ldapmapper
+  
+  # identity lib
+  # version of the library
+  LIB_VERSION='1.0.0'
+  # name of the author
+  AUTHOR='Romain GEORGES'
+  # date of creation
+  DATE='30/07/2005'
+  # valuable observations
+  OBS='Generic LDAP class'
+  
+  # generic class for LDAP object 
+  class LdapTemplate
+    
+    # attributs for LDAP connection
+    
+    # hostname of the LDAP server
+    attr_accessor :host_ldap 
+    # TCP/IP port of the LDAP server
+    attr_accessor :port_ldap 
+    # LDAP scope for search
+    attr_accessor :scope_ldap 
+    # current filter for search
+    attr_accessor :filter_ldap 
+    # LDAP base DN for the instance
+    attr_accessor :basedn_ldap 
+    # credential for the instance
+    attr_accessor :passdn_ldap 
+    # LDAP rootdn for LDAP
+    attr_accessor :rootdn_ldap
+    
+    # constructor for LdapTemplate
+    #
+    # _passdn is required, _rootdn, _host, _filter, _port and _scope are optionals
+    #
+    # return a boolean
+    def initialize(_passdn,_rootdn='cn=root',_host='localhost', _filter='(objectClass=*)', _port=389, _scope=LDAP::LDAP_SCOPE_SUBTREE)  
+      @host_ldap = _host # default localhost
+      @port_ldap = _port # default 389
+      @scope_ldap = _scope # default to SUBTREE
+      @filter_ldap = _filter # default (objectClass=*)
+      @basedn_ldap = get_basedn(_host,_port)
+      @passdn_ldap = _passdn # no default
+      @rootdn_ldap = _rootdn # default cn=root 
+      return true
+    end
+    
+  end
+  
+  # Mapping LDAP object class 
+  #
+  # This is the real CRUD Class 
+  # 
+  # contructor arguments :
+  #
+  # _dn and _passdn are required, _rootdn, _host and  _port are optionals
+  class LdapMapper < LdapTemplate
+    
+    # DN binding point attribut
+    attr_accessor :dn_ldap
+    # Hash of attributes with optional or mandatory aspects in value
+    attr_accessor :list_attributs_type
+    # Array of objectclass for the current record
+    attr_accessor :list_objectclass
+    # Hash of attributes in LDIF mapping, value should be an array in case of multivalue data
+    attr_accessor :list_attributs
+    
+    # constructor with dn_ldap initialisation
+    #
+    # _dn and _passdn are required, _rootdn, _host and  _port are optionals
+    #
+    # return a boolean 
+    def initialize(_dn,_passdn, _rootdn='cn=root',_host = 'localhost', _port = 389)
+      _scope = LDAP::LDAP_SCOPE_SUBTREE
+      _filter = '(objectClass=*)'
+      super(_passdn, _rootdn, _host, _filter, _port, _scope )
+      @dn_ldap = _dn
+      @list_objectclass = Array::new
+      @list_attributs_type = Hash::new
+      @list_attributs = Hash::new
+      add_objectclass!
+    end
+   
+    # add an objectclass in the list and map attribut 
+    # 
+    # _objectclass is optional
+    # 
+    # return an Hash
+    def add_objectclass!(_objectclass = 'top')
+      @list_objectclass = @list_objectclass.concat(get_objectclass_list(self.dn_ldap,self.host_ldap,self.port_ldap))
+      @list_objectclass.push(_objectclass).uniq!
+      @list_attributs_type = get_attributs_list(self.list_objectclass,self.host_ldap,self.port_ldap)
+      @list_attributs = map_record(self.dn_ldap,self.host_ldap,self.port_ldap)
+      if not @list_attributs.nil? then
+        @list_attributs.each{|_key,_value|
+          @list_attributs_type.each{|_attr,_trash|
+            if self.get_alias(_key).include?(_attr)
+              @list_attributs.delete(_key)
+              @list_attributs[_attr] = _value
+            end
+          }
+        }
+      end
+      @list_attributs["objectClass"] = @list_objectclass
+      @list_attributs_type.each_key {|_key|
+        eval("
+        def #{_key.downcase}
+          return @list_attributs['#{_key}']
+        end
+        def #{_key.downcase}=(_value)
+          @list_attributs['#{_key}'] = _value
+        end
+	")
+      }
+    end
+    
+    # existance of an LDAP instance test method
+    #
+    # return a boolean
+    def exist?
+      if list_arbitrary_node(self.dn_ldap,self.host_ldap,self.port_ldap).empty? then
+        return false
+      else
+        return true
+      end
+    end
+    
+    # test methode for LDAP instance situation node or termination  
+    #
+    # return a boolean
+    def is_node?
+      if  list_arbitrary_node(self.dn_ldap,self.host_ldap,self.port_ldap).length > 1 then
+	return true
+      else
+	return false
+      end
+    end
+    
+    # test methode to check the ability to create the instance, already exist or not bindable
+    #
+    # return a boolean 
+    def can_create?
+      return false if self.is_base? 
+      if list_arbitrary_node(self.get_previous,self.host_ldap,self.port_ldap).length >= 1 and not self.exist? then
+	return true
+      else
+	return false
+      end
+    end
+    
+    # return true if the dn to search is the basedn of the tree
+    #
+    # return a boolean
+    def is_base?
+      if self.dn_ldap == self.basedn_ldap then
+	return true
+      else
+	return false
+      end
+    end
+
+    # return the list of the attributes how must be present for add a record
+    #
+    # return an Array 
+    def must
+      _must_list = Array::new
+      self.list_attributs_type.each{|_key,_value|
+	_must_list.push(_key) if _value == 'MUST'  
+      }
+      _must_list.delete('dn') if _must_list.include?('dn')
+      return _must_list.delete('dn')
+    end
+
+    # return the attributes list how may be present in the record 
+    #
+    # return an Array
+    def may
+      _must_list = Array::new
+      self.list_attributs_type.each{|_key,_value|
+        _must_list.push(_key) if _value == 'MAY'
+      }
+      return _must_list
+    end
+
+    # return true if the must attributes is completed in record before commit!
+    #
+    # return a boolean
+    def valid?
+      _result = true
+      self.must.each{|attribute|
+	_result = false if not self.list_attributs.include?(attribute)
+      }
+      return _result
+    end
+
+    # get the previous record if exist and if the record is not the basedn
+    #
+    # return a String
+    def get_previous
+      _rec_res = String::new('')
+      if not self.is_base? then
+	_rdn = String::new('')
+	_dn_table = Array::new
+	_rdn,*_dn_table = self.dn_ldap.split(',')
+	_rec_res = _dn_table.join(',')
+      end
+      return _rec_res
+    end
+    
+    # method to list dn after the node in the the LDAP tree for the first level, 
+    #
+    # return an Array
+    def list_node
+      _my_res = Array::new
+      _my_res = list_arbitrary_node(self.dn_ldap,self.host_ldap,self.port_ldap,LDAP::LDAP_SCOPE_ONELEVEL) 
+      _my_res.delete(self.dn_ldap) if _my_res.include?(self.dn_ldap)
+      return _my_res
+    end
+    
+    # commit the modification or the adding of the object in LDAP server 
+    #
+    # return a boolean
+    def commit!
+      if self.exist? and self.valid? then
+	# case modifying an LDAP object
+	mod_object(self.dn_ldap, self.list_attributs,  self.rootdn_ldap, self.basedn_ldap, self.passdn_ldap, self.host_ldap, self.port_ldap)
+	return true
+      elsif self.can_create? and self.valid? then
+	# case creating new object  
+	add_object(self.dn_ldap, self.list_attributs,  self.rootdn_ldap, self.basedn_ldap, self.passdn_ldap, self.host_ldap, self.port_ldap)
+	return true
+      else
+	return false
+	# case can't commit
+      end
+    end
+    
+  end
+  
+  
+  # global method that list objectclass for a speficique dn 
+  #
+  # server free methode 
+  #
+  # _dn is required, _host, _port, _scope and _filter are optionals
+  #
+  # return an Array
+  def get_objectclass_list(_dn,_host='localhost',_port=389,_scope=LDAP::LDAP_SCOPE_BASE,_filter='(objectClass=*)')
+    _table_res = Array::new
+    begin
+      _conn = LDAP::Conn.new(_host,_port)
+      _conn.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
+      _conn.bind {
+	_conn.search(_dn,_scope,_filter){|_e|
+	   _table_res = _e.to_hash()['objectClass']
+	}
+      }
+    ensure
+      return _table_res
+    end
+  end
+
+  # get the base dn of an LDAP tree
+  #
+  # _host and _port are optionals
+  #
+  # return a String
+  def get_basedn(_host='localhost',_port=389)
+    _my_basedn = String::new('')
+    begin
+      _conn = LDAP::Conn.new(_host,_port)
+      _conn.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
+      _conn.bind {
+	_my_basedn = _conn.root_dse[0]["namingContexts"].to_s
+      }
+    ensure
+      return _my_basedn
+    end
+  end
+
+  # get the alias list of an attribute in Schema 
+  #
+  # _attribute is required, _host and _port are optionals
+  #
+  # return an Array
+  def get_alias(_attribute,_host='localhost',_port=389) 
+    _my_list_attributs = Array::new
+    begin
+      _conn = LDAP::Conn.new(_host, _port)
+      _conn.bind{
+        _schema = _conn.schema()
+	_my_list_attributs = _schema.alias(_attribute)
+      }
+      
+    ensure
+      return _my_list_attributs
+    end
+  end
+
+  #  global method that list dn after the precised dn in the LDAP tree
+  #
+  # server free methode
+  #
+  # _dn id required, _host, _port, _scope, _filter are optionals
+  #
+  # return an Array
+  def list_arbitrary_node(_dn,_host=localhost,_port=389,_scope=LDAP::LDAP_SCOPE_SUBTREE,_filter='(objectClass=*)')
+    _table_res = Array::new
+    begin
+      _conn = LDAP::Conn.new(_host,_port)
+      _conn.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
+      _conn.bind {
+	_conn.search(_dn,_scope,_filter){|_e|
+	  _table_res.push(_e.dn)
+	}
+      }
+    ensure
+      return _table_res
+    end
+    
+  end
+  
+  # get the attributs list of an objectclass list 
+  # 
+  # server free method
+  #
+  # _list_objectclass is required, _host and _port are optionals
+  #
+  # return an Hash
+  def get_attributs_list(_list_objectclass,_host='localhost',_port=389)
+    _my_list_attributs = Hash::new
+    begin
+      _conn = LDAP::Conn.new(_host, _port)
+      _conn.bind{
+	_schema = _conn.schema()
+	_list_objectclass.each{|objectclass|
+	  if objectclass != 'top' then
+	    _schema.must(objectclass).each{|attributs| _my_list_attributs[attributs] = 'MUST'}
+	    _schema.may(objectclass).each{|attributs| _my_list_attributs[attributs] = 'MAY'}
+	  end
+	}
+      }
+    ensure
+      _my_list_attributs["dn"] = "MUST"
+      _my_list_attributs["objectClass"] = "MUST"
+      return _my_list_attributs      
+    end
+  end
+  
+  # map the attributs of class at run time for the current LDAP Object at precise DN
+  # 
+  # _dn is required, _host, _port, _scope and _filter are optionals
+  # 
+  # return an Hash
+  def map_record(_dn,_host='localhost',_port=389,_scope=LDAP::LDAP_SCOPE_SUBTREE,_filter='(objectClass=*)')
+    begin
+      _conn = LDAP::Conn.new(_host,_port)
+      _conn.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
+      _conn.bind {
+	_conn.search(_dn,_scope,_filter){|_e|
+	  return _e.to_hash()
+	}
+      }
+    rescue
+      return Hash::new
+    end
+  end
+  
+  # add an ldap object 
+  # 
+  # _dn, _record, _rootdn, _basedn and _passdn are required, _host and _port are optional
+  # 
+  # return a boolean
+  def add_object(_dn, _record,  _rootdn, _basedn, _passdn, _host='localhost',_port=389)
+    _conn = LDAP::Conn.new(_host, _port)
+    _conn.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
+    _record.delete('dn')
+    _conn.bind("#{_rootdn}", "#{_passdn}"){
+      begin
+	_data = self.list_attributs
+	_data.each{|_key,_value|
+	  _data[_key] = _value.to_a 
+	}
+	_conn.add("#{_dn}", _data)
+	return true
+      rescue LDAP::ResultError
+	return false
+      end
+    }
+  end
+
+  # modify an ldap object
+  # 
+  # _dn, _record, _rootdn, _basedn and _passdn are required, _host and _port are optional
+  # 
+  # return a boolean
+  def mod_object(_dn, _record,  _rootdn, _basedn, _passdn, _host='localhost',_port=389)
+    _conn = LDAP::Conn.new(_host, _port)
+    _conn.set_option(LDAP::LDAP_OPT_PROTOCOL_VERSION, 3)
+    _record.delete('dn')
+    _conn.bind("#{_rootdn}", "#{_passdn}"){
+      begin
+	_conn.delete("#{_dn}")
+	_data = self.list_attributs
+        _data.each{|_key,_value|
+          _data[_key] = _value.to_a
+        }
+        _conn.add("#{_dn}", _data)
+	return true
+      rescue LDAP::ResultError
+        return false
+      end
+    }
+  end
+  
+  # run description of the library in interactive mode  
+  if $0 == __FILE__ then
+    puts "#{File::basename(__FILE__)}:"
+    puts 'this is a RUBY library file'
+    puts "Copyright (c) Ultragreen"
+    puts "Version : #{LIB_VERSION}"
+    puts "Author : #{AUTHOR}"
+    puts "Date release : #{DATE}"
+    puts "Observation : #{OBS}"
+  end
+  
+end
+
+#==END==#

data/test/testldapmapper.rb

@@ -0,0 +1,11 @@
+#!/usr/local/bin/ruby
+
+require "ldapmapper"
+require 'test/unit'
+
+class TestLdapMapper < Test::Unit::TestCase
+
+  def test_simple
+    assert_equal(true,LdapMapper.new('ou=fetchmail,ou=mail,dc=ultragreen,dc=net','cn=root,dc=ultragreen,dc=net','l7isg00d').exist?)	
+  end
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification 
+rubygems_version: 0.8.11
+specification_version: 1
+name: ldapmapper
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+date: 2006-09-08 00:00:00 +02:00
+summary: "Ldapmapper : CRUD Objects for LDAP mapping"
+require_paths: 
+- lib
+email: romain@ultragreen.net
+homepage: http://www.ultragreen.net
+rubyforge_project: 
+description: "Ldapmapper : provide CRUD object for LDAP data manipulations"
+autorequire: 
+default_executable: 
+bindir: 
+has_rdoc: true
+required_ruby_version: !ruby/object:Gem::Version::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.8.1
+  version: 
+platform: ruby
+signing_key: 
+cert_chain: 
+authors: []
+
+files: 
+- lib/CVS
+- lib/ldapmapper.rb
+test_files: 
+- test/testldapmapper.rb
+rdoc_options: []
+
+extra_rdoc_files: []
+
+executables: []
+
+extensions: []
+
+requirements: []
+
+dependencies: []
+