ldap_disambiguate 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 76ca8867744e6cb0102707bf64529554acdccd14
-  data.tar.gz: 3a7fc8ab6ca648fd67d0113ca541968123d37f37
+  metadata.gz: 3e7e4f4bcbf3f618e74f3cfb914cb11ccf49cad2
+  data.tar.gz: c6c4ac00bfab448d2685ccdced45e98da58ba1f2
 SHA512:
-  metadata.gz: b25d698df46f01b22f019cbfa79f337729e4be4f655862d6261623df0a58aaafd5fc2e13de26ab0d2345a943ca5e2a1bb76eaec044b4aeac7dc0fb101a45aa3e
-  data.tar.gz: ded15695850d2820b7cb4c98662fc8f6a58efb93b7478647b20e966437a7830d8144c4bf10f086254f9091e00a6637cb1dd26aa46e50514b44d3d8fb6373d5f3
+  metadata.gz: f9067937965edf6fbd2e7f225c333ea9adc35a2d0bde3c4009c0501c28440366a2826c0c61156565726b70165fe2b91343d149dd30a6e0ab10086f4e2557668d
+  data.tar.gz: de9965cae77d76570b13a6d3c4f7b6819c101710c34724179787bd388361d75617086eca5496ae212ae9bb393ce9bef25918a46cf9093f3e40fe13b45c3309d7

data/.rubocop.yml

@@ -41,17 +41,17 @@ Style/SingleLineBlockParams:
 Style/SignalException:
   Enabled: false
 
-RSpec/ExampleWording:
-  CustomTransform:
-    be: is
-    have: has
-    not: does not
-    NOT: does NOT
-  IgnoredWords:
-    - only
-
-RSpec/FilePath:
-  Enabled: false
-
-RSpec/InstanceVariable:
-  Enabled: false
+#RSpec/ExampleWording:
+#  CustomTransform:
+#    be: is
+#    have: has
+#    not: does not
+#    NOT: does NOT
+#  IgnoredWords:
+#    - only
+#
+#RSpec/FilePath:
+#  Enabled: false
+#
+#RSpec/InstanceVariable:
+#  Enabled: false

data/Gemfile

@@ -6,4 +6,3 @@ gemspec
 
 gem 'byebug'
 gem 'rubocop', require: false
-gem 'rubocop-rspec', require: false

data/Rakefile

@@ -18,7 +18,6 @@ RSpec::Core::RakeTask.new(:spec)
 
 desc "Run style checker"
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.requires << 'rubocop-rspec'
   task.fail_on_error = true
 end
 

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.0.2

data/ldap_disambiguate.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'hydra-ldap'
   s.add_dependency 'net-ldap', '0.13.0'
   s.add_dependency 'namae', '0.9.3'
+  s.add_dependency 'mail', '~> 2.6'
 
   s.add_development_dependency 'bundler', '~> 1.11'
   s.add_development_dependency 'rake', '~> 10.0'

data/lib/ldap_disambiguate.rb

@@ -4,6 +4,7 @@ require 'net-ldap'
 require 'hydra-ldap'
 require 'namae'
 require 'logger'
+require 'mail'
 
 def logger
   Logger.new(STDOUT)
@@ -19,4 +20,5 @@ module LdapDisambiguate
   autoload :Name, 'ldap_disambiguate/name'
   autoload :Email, 'ldap_disambiguate/email'
   autoload :LdapUser, 'ldap_disambiguate/ldap_user'
+  autoload :MultipleUserError, 'ldap_disambiguate/multiple_user_error'
 end

data/lib/ldap_disambiguate/base.rb

@@ -7,24 +7,8 @@ module LdapDisambiguate
       private
 
       def ldap_attributes_for_id(id)
-        attrs = LdapUser.directory_attributes(id, ldap_attrs)
-        return nil if attrs.count < 1
-        [results_hash(attrs.first)]
-      end
-
-      def results_hash(opts)
-        {
-          id:          fetch(opts, :uid).first,
-          given_name:  fetch(opts, :givenname).first,
-          surname:     fetch(opts, :sn).first,
-          email:       fetch(opts, :mail).first,
-          affiliation: fetch(opts, :eduPersonPrimaryAffiliation, []),
-          displayname: fetch(opts, :displayname).first
-        }
-      end
-
-      def fetch(opts, key, default = [''])
-        opts[key].blank? ? default : opts[key]
+        users = LdapUser.directory_attributes(id, ldap_attrs)
+        users.count < 1 ? nil : users
       end
 
       def ldap_attrs

data/lib/ldap_disambiguate/email.rb

@@ -16,12 +16,17 @@ module LdapDisambiguate
         parts = email_list.split(' ')
         emails = parts.reject { |part| !part.include?('@') }
         results = []
-        Array(emails).each do |email|
-          id = email.split('@')[0]
-          results << (ldap_attributes_for_id(id) || [results_hash(mail: [email])]).first
+        Array(emails).each do |email_str|
+          email = Mail::Address.new(email_str)
+          results << (ldap_attributes_for_id(email.local) || ldap_attributes_for_email(email.address) || [LdapUser.results_hash(mail: [email.address])]).first
         end
         results
       end
+
+      def ldap_attributes_for_email(email)
+        users = LdapUser.query_ldap_by_mail(email, ldap_attrs)
+        users.count < 1 ? nil : users
+      end
     end
   end
 end

data/lib/ldap_disambiguate/ldap_user.rb

@@ -6,16 +6,14 @@ module LdapDisambiguate
     class << self
       def directory_attributes(login, attrs = [])
         filter = Net::LDAP::Filter.eq('uid', login)
-        get_ldap_response(:get_user, filter, attrs)
+        result = get_ldap_response(filter, attrs)
+        format_users(result, attrs)
       end
 
-      def query_ldap_by_name_or_id(id_or_name_part)
-        filter = Net::LDAP::Filter.construct("(& (| (uid=#{id_or_name_part}* ) (givenname=#{id_or_name_part}*) (sn=#{id_or_name_part}*)) #{person_filter})")
-        users  = get_ldap_response(:get_user, filter, %w(uid displayname))
-
-        # handle the issue that searching with a few letters returns more than 1000 items wich causes an error in the system
-        users = get_user_by_partial_id(id_or_name_part) if size_limit_exceeded?
-        users.map { |u| { id: u[:uid].first, text: "#{u[:displayname].first} (#{u[:uid].first})" } }
+      def query_ldap_by_mail(email, attrs = [])
+        filter = Net::LDAP::Filter.construct("(& (| (psmailid=#{email} ) (mail=#{email}) (psmailbox=#{email}) (edupersonprincipalname=#{email})) #{person_filter})")
+        users  = get_users(filter, attrs)
+        format_users(users, attrs)
       end
 
       def query_ldap_by_name(given_name, surname, attrs = [])
@@ -32,33 +30,51 @@ module LdapDisambiguate
 
       def get_users(name_filter, attrs = [])
         attrs = (attrs + default_attributes).uniq
-        person_filter = '(| (eduPersonPrimaryAffiliation=STUDENT) (eduPersonPrimaryAffiliation=FACULTY) (eduPersonPrimaryAffiliation=STAFF) (eduPersonPrimaryAffiliation=EMPLOYEE) (eduPersonPrimaryAffiliation=RETIREE) (eduPersonPrimaryAffiliation=EMERITUS) (eduPersonPrimaryAffiliation=MEMBER)))'
         filter = Net::LDAP::Filter.construct("(& (& #{name_filter}) #{person_filter})")
-        get_ldap_response(:get_user, filter, attrs)
+        get_ldap_response(filter, attrs)
+      end
+
+      def results_hash(opts)
+        {
+          id:          fetch(opts, :uid).first,
+          given_name:  fetch(opts, :givenname).first,
+          surname:     fetch(opts, :sn).first,
+          email:       fetch(opts, :mail).first,
+          affiliation: fetch(opts, :eduPersonPrimaryAffiliation, []),
+          displayname: fetch(opts, :displayname).first
+        }
       end
 
       private
 
+      def fetch(opts, key, default = [''])
+        opts[key].blank? ? default : opts[key]
+      end
+
       def format_users(users, attrs)
         user_attrs = attrs - default_attributes
         users.map { |u| format_user(u, user_attrs) }
       end
 
       def format_user(user, extra_attrs)
-        hash = { id: user[:uid].first, given_name: user[:givenname].first, surname: user[:sn].first, email: user[:mail].first, affiliation: user[:eduPersonPrimaryAffiliation] }
+        hash = results_hash(user)
         extra_attrs.each { |attr| hash[attr] = user[attr].first }
         hash
       end
 
-      def get_user_by_partial_id(_id)
-        filter = Net::LDAP::Filter.construct("(& (uid=#{id_or_name_part}* ) #{person_filter})")
-        get_ldap_response(:get_user, filter, %w(uid displayname))
+      def get_user_by_partial_id(id)
+        filter = Net::LDAP::Filter.construct("(& (uid=#{id}* ) #{person_filter})")
+        get_ldap_response(filter, %w(uid displayname))
       end
 
-      def get_ldap_response(_method, filter, attributes)
+      def get_ldap_response(filter, attributes)
+        return cache[filter.to_s] if cache.key?(filter.to_s)
         tries.times.each do
           result = Hydra::LDAP.get_user(filter, attributes)
-          return result unless unwilling?
+          unless unwilling?
+            cache[filter.to_s] = result
+            return result
+          end
           sleep(sleep_time)
         end
         nil
@@ -82,7 +98,7 @@ module LdapDisambiguate
       end
 
       def person_filter
-        '(| (eduPersonPrimaryAffiliation=STUDENT) (eduPersonPrimaryAffiliation=FACULTY) (eduPersonPrimaryAffiliation=STAFF) (eduPersonPrimaryAffiliation=EMPLOYEE))))'
+        '(| (eduPersonPrimaryAffiliation=STUDENT) (eduPersonPrimaryAffiliation=FACULTY) (eduPersonPrimaryAffiliation=STAFF) (eduPersonPrimaryAffiliation=EMPLOYEE) (eduPersonPrimaryAffiliation=RETIREE) (eduPersonPrimaryAffiliation=EMERITUS) (eduPersonPrimaryAffiliation=MEMBER)))'
       end
 
       def name_filters(first_name, middle_name, surname)
@@ -95,7 +111,11 @@ module LdapDisambiguate
       end
 
       def default_attributes
-        [:uid, :givenname, :sn, :mail, :eduPersonPrimaryAffiliation]
+        [:uid, :givenname, :sn, :mail, :eduPersonPrimaryAffiliation, :displayname]
+      end
+
+      def cache
+        @cache ||= {}
       end
     end
   end

data/lib/ldap_disambiguate/multiple_user_error.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+module LdapDisambiguate
+  # This error is thrown if we get more than one user back from ldap for an input
+  #
+  class MultipleUserError < RuntimeError
+  end
+end

data/lib/ldap_disambiguate/name.rb

@@ -17,15 +17,21 @@ module LdapDisambiguate
       def text_only_names(multi_name)
         results = []
         multi_name.split(/and|;/).each do |n|
-          n.gsub!(/\([^)]*\)/, '')
-          n.strip!
-          query_result = email_for_name(n)
-          query_result ||= title_after_name(n) # try again without the titles
-          results << query_result unless query_result.blank?
+          result = text_only_name(n)
+          results << result unless result.blank?
         end
         results
       end
 
+      def text_only_name(name)
+        name = clean_name(name)
+        query_result = email_for_name(name)
+        query_result ||= title_after_name(name) # try again without the titles
+        return query_result
+      rescue MultipleUserError
+        return nil
+      end
+
       # titles after the name that namae had trouble parsing
       def title_after_name(text_name)
         result = nil
@@ -54,19 +60,14 @@ module LdapDisambiguate
         result = try_name(parsed.given, parsed.family)
         result ||= title_before_name(parsed)
         result ||= two_words_in_last_name(text_name)
-
-        logger.error("got zero for #{text_name}") if result.nil?
         result
       end
 
       def try_name(given, family)
         return nil if family.blank?
         possible_users = LdapUser.query_ldap_by_name(given, family, ldap_attrs)
-        return nil if possible_users.count == 0
-        if possible_users.count > 1
-          logger.error("Returning #{possible_users.first} but got more than name for given name #{given} and family name #{name}")
-          return nil
-        end
+        return nil if possible_users.blank? || possible_users.count == 0
+        raise(MultipleUserError, "too name results for #{given} #{family}") if possible_users.count > 1
         possible_users.first
       end
 
@@ -90,12 +91,16 @@ module LdapDisambiguate
 
       def two_words_in_last_name(text_name)
         result = nil
-        if text_name.count(' ') > 2
+        if text_name.strip.count(' ') > 2
           parts = name_parts(text_name, 2)
           result = try_name(parts[:given], parts[:family])
         end
         result
       end
+
+      def clean_name(name)
+        name.gsub(/\([^)]*\)/, '').strip
+      end
   end
   end
 end

data/lib/ldap_disambiguate/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module LdapDisambiguate
-  VERSION = '0.0.1'.freeze
+  VERSION = '0.0.2'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ldap_disambiguate
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Carolyn Cole
@@ -52,6 +52,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.9.3
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -129,6 +143,7 @@ files:
 - lib/ldap_disambiguate/base.rb
 - lib/ldap_disambiguate/email.rb
 - lib/ldap_disambiguate/ldap_user.rb
+- lib/ldap_disambiguate/multiple_user_error.rb
 - lib/ldap_disambiguate/name.rb
 - lib/ldap_disambiguate/version.rb
 homepage: https://github.com/psu-stewardship/ldap_disambiguate