ucb_ldap 2.0.0.pre1 → 2.0.0.pre3

data/lib/{ucb_ldap_person.rb → ucb_ldap/person.rb}

@@ -1,148 +1,157 @@
-
-module UCB::LDAP
-  ##
-  # =UCB::LDAP::Person
-  #
-  # Class for accessing the People tree of the UCB LDAP directory.
-  # 
-  # You can search by specifying your own filter:
-  # 
-  #   e = Person.search(:filter => {:uid => 123})
-  #   
-  # Or you can use a convenience search method:
-  # 
-  #   e = Person.find_by_uid("123")
-  #   
-  # Access attributes as if they were instance methods:  
-  # 
-  #   e = Person.find_by_uid("123")
-  #   
-  #   e.givenname    #=> "John"
-  #   e.sn           #=> "Doe"
-  #   
-  # Methods with friendly names are provided for accessing attribute values:
-  # 
-  #   e = Person.person_by_uid("123")
-  #   
-  #   e.firstname    #=> "John"
-  #   e.lastname     #=> "Doe"
-  # 
-  # There are other convenience methods:
-  # 
-  #   e = Person.person_by_uid("123")
-  #   
-  #   e.affiliations        #=> ["EMPLOYEE-TYPE-STAFF"]
-  #   e.employee?           #=> true
-  #   e.employee_staff?     #=> true
-  #   e.employee_academic?  #=> false
-  #   e.student?            #=> false
-  # 
-  # == Other Parts of the Tree
-  #
-  # You can access other parts of the LDAP directory through Person
-  # instances:
-  #
-  #   p = Person.find_by_uid("123")
-  #
-  #   p.org_node          #=> Org
-  #   p.affiliations      #=> Array of Affiliation
-  #   p.addresses         #=> Array of Address
-  #   p.job_appointments  #=> Array of JobAppointment
-  #   p.namespaces        #=> Array of Namespace
-  #   p.student_terms     #=> Array of StudentTerm
-  #
-  # ==Attributes
-  # 
-  # See Ldap::Entry for general information on accessing attribute values.
-  #
-  class Person < Entry
-    class RecordNotFound < StandardError; end
-    
-    include AffiliationMethods
-    include GenericAttributes
-    
-    @entity_name = 'person'
-    @tree_base = 'ou=people,dc=berkeley,dc=edu'
-    
-    class << self
-      ##
-      # Returns an instance of Person for given _uid_.
-      #
-      def find_by_uid(uid)
-        uid = uid.to_s
-        find_by_uids([uid]).first
-      end
-      alias :person_by_uid :find_by_uid  
-      
-      ##
-      # Returns an +Array+ of Person for given _uids_.
-      #
-      def find_by_uids(uids)
-        return [] if uids.size == 0
-        filters = uids.map{|uid| Net::LDAP::Filter.eq("uid", uid)}
-        search(:filter => self.combine_filters(filters, '|'))
-      end
-      alias :persons_by_uids :find_by_uids 
-
-      ##
-      # Exclude test entries from search results unless told otherwise.
-      #
-      def search(args) #:nodoc:
-        results = super
-        include_test_entries? ? results : results.reject { |person| person.test? }
-      end
-
-      ##
-      # If <tt>true</tt> test entries are included in search results
-      # (defalut is <tt>false</tt>).
-      #
-      def include_test_entries?
-        @include_test_entries ? true : false
-      end
-
-      ##
-      # Setter for include_test_entries?
-      #
-      def include_test_entries=(include_test_entries)
-        @include_test_entries = include_test_entries
-      end
-    end
-
-    
-    def deptid
-      berkeleyEduPrimaryDeptUnit
-    end
-    alias :dept_code :deptid
-    
-    def dept_name
-      berkeleyEduUnitCalNetDeptName
-    end
-    
-    ##
-    # Returns +Array+ of JobAppointment for this Person.
-    # Requires a bind with access to job appointments.
-    # See UCB::LDAP.authenticate().
-    #
-    def job_appointments
-      @job_appointments ||= JobAppointment.find_by_uid(uid)
-    end
-    
-    ##
-    # Returns +Array+ of StudentTerm for this Person.
-    # Requires a bind with access to student terms.
-    # See UCB::LDAP.authenticate().
-    #
-    def student_terms
-      @student_terms ||= StudentTerm.find_by_uid(uid)
-    end
-    
-    ##
-    # Returns instance of UCB::LDAP::Org corresponding to 
-    # primary department.
-    #
-    def org_node
-      @org_node ||= UCB::LDAP::Org.find_by_ou(deptid)
-    end
-    
-  end
-end
+require_relative 'person/affiliation_methods'
+require_relative 'person/common_attributes'
+
+module UCB::LDAP
+  ##
+  # =UCB::LDAP::Person
+  #
+  # Class for accessing the People tree of the UCB LDAP directory.
+  #
+  # You can search by specifying your own filter:
+  #
+  #   e = Person.search(:filter => {:uid => 123})
+  #
+  # Or you can use a convenience search method:
+  #
+  #   e = Person.find_by_uid("123")
+  #
+  # Access attributes as if they were instance methods:
+  #
+  #   e = Person.find_by_uid("123")
+  #
+  #   e.givenname    #=> "John"
+  #   e.sn           #=> "Doe"
+  #
+  # Methods with friendly names are provided for accessing attribute values:
+  #
+  #   e = Person.person_by_uid("123")
+  #
+  #   e.firstname    #=> "John"
+  #   e.lastname     #=> "Doe"
+  #
+  # There are other convenience methods:
+  #
+  #   e = Person.person_by_uid("123")
+  #
+  #   e.affiliations        #=> ["EMPLOYEE-TYPE-STAFF"]
+  #   e.employee?           #=> true
+  #   e.employee_staff?     #=> true
+  #   e.employee_academic?  #=> false
+  #   e.student?            #=> false
+  #
+  # == Other Parts of the Tree
+  #
+  # You can access other parts of the LDAP directory through Person
+  # instances:
+  #
+  #   p = Person.find_by_uid("123")
+  #
+  #   p.org_node          #=> Org
+  #   p.affiliations      #=> Array of Affiliation
+  #   p.addresses         #=> Array of Address
+  #   p.job_appointments  #=> Array of JobAppointment
+  #   p.namespaces        #=> Array of Namespace
+  #   p.student_terms     #=> Array of StudentTerm
+  #
+  # ==Attributes
+  #
+  # See Ldap::Entry for general information on accessing attribute values.
+  #
+  class Person < Entry
+    class RecordNotFound < StandardError;
+    end
+
+    include UCB::LDAP::AffiliationMethods
+    include UCB::LDAP::CommonAttributes
+
+    @entity_name = 'person'
+    @tree_base = 'ou=people,dc=berkeley,dc=edu'
+
+
+    ##
+    # Returns an instance of Person for given _uid_.
+    #
+    def self.find_by_uid(uid)
+      uid = uid.to_s
+      find_by_uids([uid]).first
+    end
+
+    def self.person_by_uid(uid)
+      find_by_uid(uid)
+    end
+
+    ##
+    # Returns an +Array+ of Person for given _uids_.
+    #
+    def self.find_by_uids(uids)
+      return [] if uids.size == 0
+      filters = uids.map { |uid| Net::LDAP::Filter.eq("uid", uid) }
+      search(:filter => self.combine_filters(filters, '|'))
+    end
+
+    def self.persons_by_uids(uids)
+      find_by_uids(uids)
+    end
+
+    ##
+    # Exclude test entries from search results unless told otherwise.
+    #
+    def self.search(args) #:nodoc:
+      results = super
+      include_test_entries? ? results : results.reject { |person| person.test? }
+    end
+
+    ##
+    # If <tt>true</tt> test entries are included in search results
+    # (defalut is <tt>false</tt>).
+    #
+    def self.include_test_entries?
+      @include_test_entries ? true : false
+    end
+
+    ##
+    # Setter for include_test_entries?
+    #
+    def self.include_test_entries=(include_test_entries)
+      @include_test_entries = include_test_entries
+    end
+
+
+    def deptid
+      berkeleyEduPrimaryDeptUnit
+    end
+
+    alias :dept_code :deptid
+
+    def dept_name
+      berkeleyEduUnitCalNetDeptName
+    end
+
+    ##
+    # Returns +Array+ of JobAppointment for this Person.
+    # Requires a bind with access to job appointments.
+    # See UCB::LDAP.authenticate().
+    #
+    def job_appointments
+      @job_appointments ||= JobAppointment.find_by_uid(uid)
+    end
+
+    ##
+    # Returns +Array+ of StudentTerm for this Person.
+    # Requires a bind with access to student terms.
+    # See UCB::LDAP.authenticate().
+    #
+    def student_terms
+      @student_terms ||= StudentTerm.find_by_uid(uid)
+    end
+
+    ##
+    # Returns instance of UCB::LDAP::Org corresponding to
+    # primary department.
+    #
+    def org_node
+      @org_node ||= UCB::LDAP::Org.find_by_ou(deptid)
+    end
+
+  end
+end

data/lib/{person → ucb_ldap/person}/affiliation_methods.rb

@@ -1,24 +1,23 @@
-
-
-module UCB::LDAP
+module UCB
+  module LDAP
     module AffiliationMethods
-      
+
       ##
       # Returns an <tt>Array</tt> of Person's affiliations.
       #
       def affiliations
         @affiliations ||= berkeleyEduAffiliations.map { |a| a.upcase }
       end
-      
+
       ##
       # Returns <tt>true</tt> if entry's affiliations contain _affiliation_.
-      # 
+      #
       # Case-insensitive.
       #
       def has_affiliation?(affiliation)
         affiliations.include?(affiliation.upcase)
       end
-      
+
       ##
       # Returns <tt>true</tt> if Person's affiliations contain at least one affiliation of a particular type.
       #
@@ -29,14 +28,14 @@ module UCB::LDAP
       #
       def has_affiliation_of_type?(affiliation_type)
         aff_type_string = affiliation_type.to_s.upcase
-        affiliations.find{|a| a =~ /^#{aff_type_string}-TYPE-/} ? true : false
+        affiliations.find { |a| a =~ /^#{aff_type_string}-TYPE-/ } ? true : false
       end
 
 
       ############################################
       #  Determine if the person is an EMPLOYEE  #
       ############################################
-      
+
       ##
       # Returns <tt>true</tt> if entry has the "staff" affiliation.
       #
@@ -60,11 +59,11 @@ module UCB::LDAP
         has_affiliation_of_type?(:employee) && !employee_expired?
       end
 
-     
+
       ##########################################
       #  Determine if the person is a STUDENT  #
       ##########################################
-      
+
       ##
       # Returns +true+ if is an expired student.
       #
@@ -83,7 +82,7 @@ module UCB::LDAP
       def student_not_registered?
         has_affiliation? 'STUDENT-TYPE-NOT REGISTERED'
       end
-      
+
       ##
       # Returns <tt>true</tt> if entry has a studend affiliation and
       # is not expired.
@@ -93,7 +92,7 @@ module UCB::LDAP
       end
 
 
-      ##############################################      
+      ##############################################
       #  Determine if the persone is an AFFILIATE  #
       ##############################################
 
@@ -102,7 +101,7 @@ module UCB::LDAP
       end
 
       def affiliate_staff_retiree?
-        has_affiliation? 'AFFILIATE-TYPE-STAFF RETIREE'  
+        has_affiliation? 'AFFILIATE-TYPE-STAFF RETIREE'
       end
 
       def affiliate_emeritus?
@@ -112,9 +111,9 @@ module UCB::LDAP
       def affiliate_directory_only?
         has_affiliation? 'AFFILIATE-TYPE-DIRECTORY ONLY'
       end
-      
+
       ##
-      # Note: there are actually 2 types of visting affiliaties, visiting student and 
+      # Note: there are actually 2 types of visting affiliaties, visiting student and
       # visiting scholars.  But for now we will generalize.
       #
       def affiliate_visiting?
@@ -132,7 +131,7 @@ module UCB::LDAP
       def affiliate_lbl_op_staff?
         has_affiliation? 'AFFILIATE-TYPE-LBLOP STAFF'
       end
-     
+
       def affiliate_committee_member?
         has_affiliation? 'AFFILIATE-TYPE-COMMITTEE MEMBER'
       end
@@ -148,13 +147,13 @@ module UCB::LDAP
       def affiliate_hhmi_researcher?
         has_affiliation? 'AFFILIATE-TYPE-HHMI RESEARCHER'
       end
-     
+
       def affiliate_concurrent_enrollment?
         has_affiliation? 'AFFILIATE-TYPE-CONCURR ENROLL'
       end
 
       def affiliate_temp_agency?
-        has_affiliation? 'AFFILIATE-TYPE-TEMP AGENCY'  
+        has_affiliation? 'AFFILIATE-TYPE-TEMP AGENCY'
       end
 
       def affiliate_departmental?
@@ -198,7 +197,7 @@ module UCB::LDAP
       end
 
       def affiliate_advcon_i_house_resident?
-        has_affiliation? 'AFFILIATE-TYPE-ADVCON-I-HOUSE-RESIDENT'  
+        has_affiliation? 'AFFILIATE-TYPE-ADVCON-I-HOUSE-RESIDENT'
       end
 
       def affiliate_advcon_student?
@@ -220,6 +219,8 @@ module UCB::LDAP
       def affiliate_expiration_date
         Date.parse(berkeleyEduAffExpDate.to_s)
       end
-    
-  end 
+
+    end
+
+  end
 end

data/lib/ucb_ldap/person/common_attributes.rb

@@ -0,0 +1,63 @@
+module UCB
+  module LDAP
+    module CommonAttributes
+
+      # Returns +true+ if the entry represents a test entry.
+      def test?
+        berkeleyEduTestIDFlag
+      end
+
+      def uid
+        super.first
+      end
+
+      def firstname
+        givenname.first
+      end
+
+      alias :first_name :firstname
+
+      def lastname
+        sn.first
+      end
+
+      alias :last_name :lastname
+
+      def email
+        mail.first
+      end
+
+      def phone
+        telephoneNumber.first
+      end
+
+      # Returns +Array+ of Affiliation for this Person. Requires a bind with access to affiliations.
+      # See UCB::LDAP.authenticate().
+      def affiliate_affiliations
+        @affiliate_affiliations ||= Affiliation.find_by_uid(uid)
+      end
+
+      # Returns +Array+ of Namespace for this Person.
+      # Requires a bind with access to namespaces.
+      # See UCB::LDAP.authenticate().
+      def namespaces
+        @namespaces ||= Namespace.find_by_uid(uid)
+      end
+
+      # Returns +Array+ of Service for this Person.
+      # Requires a bind with access to services.
+      # See UCB::LDAP.authenticate().
+      def services
+        @services ||= Service.find_by_uid(uid)
+      end
+
+      # Returns +Array+ of Address for this Person.
+      # Requires a bind with access to addresses.
+      # See UCB::LDAP.authenticate().
+      def addresses
+        @addresses ||= Address.find_by_uid(uid)
+      end
+
+    end
+  end
+end