ldapmapper 1.0.0 → 1.0.1

data/lib/ldapmapper.rb

@@ -9,8 +9,15 @@
 # * 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 $
+# * VCS Version:: $Id$
 #
+# === Websites : 
+# *   http://www.ultragreen.net
+# *   http://ldapmapper.rubyforge.org
+#
+# === Contact : 
+#   Romain GEORGES <romain@ultragreen.net>  
+# 
 # == Exemples :
 #
 #   #!/usr/local/bin/ruby
@@ -94,7 +101,7 @@ module Ldapmapper
   
   # identity lib
   # version of the library
-  LIB_VERSION='1.0.0'
+  LIB_VERSION='1.0.1'
   # name of the author
   AUTHOR='Romain GEORGES'
   # date of creation
@@ -108,18 +115,25 @@ module Ldapmapper
     # attributs for LDAP connection
     
     # hostname of the LDAP server
+    #  default : 'localhost'
     attr_accessor :host_ldap 
     # TCP/IP port of the LDAP server
-    attr_accessor :port_ldap 
+    #  default : 389
+    attr_accessor :port_ldap
     # LDAP scope for search
+    #  dafault : LDAP::LDAP_SCOPE_SUBTREE
     attr_accessor :scope_ldap 
     # current filter for search
+    #  default : '(objectClass=*)'
     attr_accessor :filter_ldap 
     # LDAP base DN for the instance
+    #  no default get by LDAP bind for ROOT DSE record
     attr_accessor :basedn_ldap 
     # credential for the instance
+    #  no default get by instance initializer
     attr_accessor :passdn_ldap 
     # LDAP rootdn for LDAP
+    #  default 'cn=root'
     attr_accessor :rootdn_ldap
     
     # constructor for LdapTemplate
@@ -150,12 +164,16 @@ module Ldapmapper
   class LdapMapper < LdapTemplate
     
     # DN binding point attribut
+    #   no default get by instance initializer
     attr_accessor :dn_ldap
     # Hash of attributes with optional or mandatory aspects in value
+    #  no default get by LDAP query on Schema
     attr_accessor :list_attributs_type
     # Array of objectclass for the current record
+    #  no default, could be empty for nonexistants mapping get by LDIF LDAP query    
     attr_accessor :list_objectclass
     # Hash of attributes in LDIF mapping, value should be an array in case of multivalue data
+    #  no default, could be empty for nonexistants mapping get by LDIF LDAP query
     attr_accessor :list_attributs
     
     # constructor with dn_ldap initialisation
@@ -348,8 +366,10 @@ module Ldapmapper
 	   _table_res = _e.to_hash()['objectClass']
 	}
       }
-    ensure
       return _table_res
+    rescue
+      raise LdapmapperGetObjectclassesError
+      return Array::new
     end
   end
 
@@ -366,8 +386,10 @@ module Ldapmapper
       _conn.bind {
 	_my_basedn = _conn.root_dse[0]["namingContexts"].to_s
       }
-    ensure
       return _my_basedn
+    rescue
+      raise LdapmapperGetDSEError
+      return Array::new
     end
   end
 
@@ -384,9 +406,10 @@ module Ldapmapper
         _schema = _conn.schema()
 	_my_list_attributs = _schema.alias(_attribute)
       }
-      
-    ensure
       return _my_list_attributs
+    rescue 
+      raise LdapmapperGetSchemaError
+      return Array::new
     end
   end
 
@@ -407,8 +430,10 @@ module Ldapmapper
 	  _table_res.push(_e.dn)
 	}
       }
-    ensure
       return _table_res
+    rescue 
+      raise LdapmapperGetDnError
+      return Array::new
     end
     
   end
@@ -433,10 +458,12 @@ module Ldapmapper
 	  end
 	}
       }
-    ensure
       _my_list_attributs["dn"] = "MUST"
       _my_list_attributs["objectClass"] = "MUST"
       return _my_list_attributs      
+    rescue
+      raise LdapmapperGetSchemaError
+      return Hash::new
     end
   end
   
@@ -455,6 +482,7 @@ module Ldapmapper
 	}
       }
     rescue
+      raise LdapmapperGetLdifError
       return Hash::new
     end
   end
@@ -477,6 +505,7 @@ module Ldapmapper
 	_conn.add("#{_dn}", _data)
 	return true
       rescue LDAP::ResultError
+	raise LdapmapperAddLdifError
 	return false
       end
     }
@@ -501,6 +530,7 @@ module Ldapmapper
         _conn.add("#{_dn}", _data)
 	return true
       rescue LDAP::ResultError
+	raise LdapmapperModLdifError
         return false
       end
     }
@@ -516,7 +546,23 @@ module Ldapmapper
     puts "Date release : #{DATE}"
     puts "Observation : #{OBS}"
   end
-  
+
+  # exceptions definitions 
+  # raise when a modification of a record failed
+  class LdapmapperModLdifError < Exception; end
+  # raise when an adding of a record failed
+  class LdapmapperAddLdifError < Exception; end
+  # raise when the retrieving of a record failed
+  class LdapmapperGetLdifError < Exception; end 
+   # raise when the retrieving of Schema's data failed
+  class LdapmapperGetSchemaError < Exception; end 
+  # raise when the browsing of an LDAP tree failed
+  class LdapmapperGetDnError < Exception; end  
+  # raise when the retrieving of root DSE record failed
+  class LdapmapperGetDSEError < Exception; end  
+  # raise when the retrieving of objectclasses list failed
+  class LdapmapperGetObjectclassesError < Exception; end  
+
 end
 
 #==END==#

metadata

@@ -1,46 +1,55 @@
 --- !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"
+  version: 1.0.1
+platform: ruby
+authors: 
+- Romain GEORGES
 autorequire: 
-default_executable: 
 bindir: 
+cert_chain: []
+
+date: 2009-12-16 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: "Ldapmapper : provide CRUD object for LDAP data manipulations"
+email: romain@ultragreen.net
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/ldapmapper.rb
 has_rdoc: true
-required_ruby_version: !ruby/object:Gem::Version::Requirement 
+homepage: http://www.ultragreen.net/projects/ldapmapper
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
       version: 1.8.1
   version: 
-platform: ruby
-signing_key: 
-cert_chain: 
-authors: []
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
 
-files: 
-- lib/CVS
-- lib/ldapmapper.rb
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: "Ldapmapper : CRUD Objects for LDAP mapping"
 test_files: 
 - test/testldapmapper.rb
-rdoc_options: []
-
-extra_rdoc_files: []
-
-executables: []
-
-extensions: []
-
-requirements: []
-
-dependencies: []
-