ldap_disambiguate 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77aa99da0ec6cdae980bbd45439920842ba6722f
-  data.tar.gz: e4b4da761d87935307960e5e53b15f5d41bc89ad
+  metadata.gz: 9b9a7376706b9375a3411d78c6b213126df03c4e
+  data.tar.gz: 62d7444cff4ff36b8be3dc8c85ee2b4c14ef3596
 SHA512:
-  metadata.gz: c91afad6275222eced0dd342d4c8132c7794c75d276c770ecff9e2569d68864431e0ef332e01eb76d2fa64140f09e34819af6092f8e7b2e6fb2d766df66da8a0
-  data.tar.gz: 0af373cebdb8813c3a93513ae17fbd0ebbd8c9735dda7459d7707919f836cb6035f55df2d345cf357bc5ce22cb096aaca3778a2f12b0514f15bdcabf99785452
+  metadata.gz: 54cea172b3246bdb8ecc4bf28e43f39fb56d4a5a19100863bb0fb48dd87bb360be67dc0c9cf5352ad324ddfc8ff5acfff0971f997a72e3fcac07d39309c88dd2
+  data.tar.gz: 8a6b99996fd35383184c8f1aaa2c5892798cdb0c700ad3c2f9b117b3135409646be22e957cd079b4ee01269016fd0523680e5eef55230a36c39e4336b952331b

data/.rubocop.yml

@@ -1,3 +1,5 @@
+inherit_from: .rubocop_todo.yml
+
 AllCops:
   DisplayCopNames: true
   Include:

data/.rubocop_todo.yml

@@ -1,19 +1,40 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2016-03-24 06:26:32 -0400 using RuboCop version 0.37.2.
+# on 2017-09-14 10:19:42 -0400 using RuboCop version 0.49.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
+# Offense count: 5
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/BlockLength:
+  Max: 170
+
 # Offense count: 1
 # Configuration parameters: CountComments.
-Metrics/ClassLength:
-  Max: 111
+Metrics/MethodLength:
+  Max: 11
 
 # Offense count: 1
-Style/Documentation:
+# Configuration parameters: ExpectMatchingDefinition, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Style/FileName:
+  Exclude:
+    - 'Gemfile'
+
+# Offense count: 4
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, EnforcedStyle, SupportedStyles.
+# SupportedStyles: predicate, comparison
+Style/NumericPredicate:
   Exclude:
     - 'spec/**/*'
-    - 'test/**/*'
-    - 'lib/ldap_disambiguate.rb'
+    - 'lib/ldap_disambiguate/ldap_user.rb'
+    - 'lib/ldap_disambiguate/name.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/RedundantFreeze:
+  Exclude:
+    - 'lib/ldap_disambiguate/version.rb'

data/Gemfile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in share_notify.gemspec

data/Rakefile

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # Add your own tasks in files placed in lib/tasks ending in .rake,
 # for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
 begin
@@ -22,6 +23,6 @@ RuboCop::RakeTask.new(:rubocop) do |task|
 end
 
 desc "Run continuous integration tests"
-task ci: [:rubocop, :spec]
+task ci: %i[rubocop spec]
 
 task default: :ci

data/VERSION

@@ -1 +1 @@
-0.0.3
+0.0.4

data/ldap_disambiguate.gemspec

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'ldap_disambiguate/version'

data/lib/ldap_disambiguate.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 # require 'rspec/its'
 require 'net-ldap'
 require 'hydra-ldap'

data/lib/ldap_disambiguate/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LdapDisambiguate
   # This class allows you to use LDAP to disambiguate a text name
   #
@@ -12,7 +13,7 @@ module LdapDisambiguate
       end
 
       def ldap_attrs
-        [:uid, :givenname, :sn, :mail, :eduPersonPrimaryAffiliation, :displayname]
+        %i[uid givenname sn mail eduPersonPrimaryAffiliation displayname]
       end
     end
   end

data/lib/ldap_disambiguate/email.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LdapDisambiguate
   # This class allows you to use LDAP to extract user information
   #  from an email or list of emails
@@ -14,7 +15,7 @@ module LdapDisambiguate
 
       def email_in_name(email_list)
         parts = email_list.split(' ')
-        emails = parts.reject { |part| !part.include?('@') }
+        emails = parts.select { |part| part.include?('@') }
         results = []
         Array(emails).each do |email_str|
           email = Mail::Address.new(email_str)

data/lib/ldap_disambiguate/ldap_user.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LdapDisambiguate
   # This class provides an api for quering LDAP with different portions of the user's
   # information (name parts or id)
@@ -17,7 +18,7 @@ module LdapDisambiguate
       end
 
       def query_ldap_by_name(given_name, surname, attrs = [])
-        return if given_name.blank? # this method only work if we have a first name to play with
+        return [] if given_name.blank? # this method only work if we have a first name to play with
 
         first_names = given_name.split(/[\s.]+/)
         users = []
@@ -64,7 +65,7 @@ module LdapDisambiguate
 
       def get_user_by_partial_id(id)
         filter = Net::LDAP::Filter.construct("(& (uid=#{id}* ) #{person_filter})")
-        get_ldap_response(filter, %w(uid displayname))
+        get_ldap_response(filter, %w[uid displayname])
       end
 
       def get_ldap_response(filter, attributes)
@@ -103,14 +104,20 @@ module LdapDisambiguate
 
       def name_filters(first_name, middle_name, surname)
         filters = []
-        filters << "(givenname=#{first_name}*) (givenname=* #{middle_name}*) (sn=#{surname})" unless middle_name.blank?
+        if middle_name.blank?
+          filters << "(givenname=#{first_name}) (sn=#{surname})"
+          filters << "(givenname=#{first_name}*) (sn=#{surname})"
+        else
+          filters << "(givenname=#{first_name}*) (givenname=* #{middle_name}*) (sn=#{surname})"
+          middle_initial = middle_name[0]
+          filters << "(givenname=#{first_name}* #{middle_initial}*) (sn=#{surname})"
+        end
         filters << "(givenname=#{first_name}) (sn=#{surname})"
-        filters << "(givenname=#{first_name}*) (sn=#{surname})"
         filters
       end
 
       def default_attributes
-        [:uid, :givenname, :sn, :mail, :eduPersonPrimaryAffiliation, :displayname]
+        %i[uid givenname sn mail eduPersonPrimaryAffiliation displayname]
       end
 
       def cache

data/lib/ldap_disambiguate/multiple_user_error.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LdapDisambiguate
   # This error is thrown if we get more than one user back from ldap for an input
   #

data/lib/ldap_disambiguate/name.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LdapDisambiguate
   # This class allows you to use LDAP to disambiguate a text name
   #
@@ -8,55 +9,46 @@ module LdapDisambiguate
         return if name.blank?
         results = ldap_attributes_for_id(name) # text includes login id
         results ||= Email.disambiguate(name) # text includes email(s)
-        results ||= text_only_names(name) # straight text we need to query ldap
+        results ||= lookup_text_only_names(name) # straight text we need to query ldap
         results
       end
 
+      def clear_cache
+        @email_for_name_cache = {}
+      end
+
       private
 
-      def text_only_names(multi_name)
-        results = []
-        multi_name.split(/and|;/).each do |n|
-          result = text_only_name(n)
-          results << result unless result.blank?
+      def lookup_text_only_names(multi_name)
+        results = separate_names(multi_name).map do |name|
+          lookup_name(clean_name(name))
         end
-        results
+        results.reject(&:blank?)
       end
 
-      def text_only_name(name)
-        name = clean_name(name)
+      def lookup_name(name)
         query_result = email_for_name(name)
         query_result ||= title_after_name(name) # try again without the titles
-        return query_result
+        query_result
       rescue MultipleUserError
         return nil
       end
 
-      # titles after the name that namae had trouble parsing
-      def title_after_name(text_name)
-        result = nil
-        if text_name.count(',') > 0
-          new_name = text_name.split(',')[0]
-          result = email_for_name(new_name) if new_name.count(' ') > 0
-        end
-        result
-      end
-
       def email_for_name(text_name)
-        return '' if text_name.blank?
-        return email_for_name_cache[text_name] unless email_for_name_cache[text_name].blank?
+        return '' if text_name.blank? || word_count(text_name) < 2
+        return email_for_name_cache[text_name] if email_for_name_cache.key?(text_name)
 
-        email_for_name_cache[text_name] = find_email_for_name(text_name)
-        email_for_name_cache[text_name]
+        email_for_name_cache[text_name] = translate_name_to_email(text_name)
       end
 
-      def email_for_name_cache
-        @email_for_name_cache ||= {}
+      # titles after the name that namae had trouble parsing
+      def title_after_name(text_name)
+        email_for_name(remove_titles(text_name))
       end
 
-      def find_email_for_name(text_name)
-        text_name.gsub!(/[^\w\s,']/, ' ')
+      def translate_name_to_email(text_name)
         parsed = Namae::Name.parse(text_name)
+
         result = try_name(parsed.given, parsed.family)
         result ||= title_before_name(parsed)
         result ||= two_words_in_last_name(text_name)
@@ -65,42 +57,69 @@ module LdapDisambiguate
 
       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.blank? || possible_users.count == 0
         raise(MultipleUserError, "too name results for #{given} #{family}") if possible_users.count > 1
         possible_users.first
       end
 
+      def title_before_name(parsed)
+        return unless parsed.given && multi_word?(parsed.given)
+
+        parts = name_parts(parsed.given, 1)
+        return if only_initial?(parts[:family])
+
+        try_name(parts[:family], parsed.family)
+      end
+
+      def two_words_in_last_name(text_name)
+        return unless word_count(text_name) > 2
+
+        parts = name_parts(text_name, 2)
+        try_name(parts[:given], parts[:family])
+      end
+
       def name_parts(text_name, last_name_count)
-        parts = text_name.split(' ')
+        return if word_count(text_name) < (last_name_count + 1)
+
+        parts = split_name_parts(text_name)
         first_name_count = parts.count - last_name_count
-        return nil if first_name_count < 1
         { given: parts.first(first_name_count).join(' '), family: parts.last(last_name_count).join(' ') }
       end
 
-      # take first name and break it into first and last with last name conatining one word
-      def title_before_name(parsed)
-        return unless parsed
-        result = nil
-        if parsed.given && parsed.given.count(' ') >= 1
-          parts = name_parts(parsed.given, 1)
-          result = try_name(parts[:family], parsed.family)
-        end
-        result
+      def clean_name(name)
+        name.gsub(/\([^)]*\)/, '')
+            .gsub(/[^\w\s,']/, ' ')
+            .strip.squeeze(' ')
       end
 
-      def two_words_in_last_name(text_name)
-        result = nil
-        if text_name.strip.count(' ') > 2
-          parts = name_parts(text_name, 2)
-          result = try_name(parts[:given], parts[:family])
-        end
-        result
+      def multi_word?(name)
+        word_count(name) > 1
       end
 
-      def clean_name(name)
-        name.gsub(/\([^)]*\)/, '').strip
+      def word_count(name)
+        name.squeeze(' ').count(' ') + 1
       end
-  end
+
+      def split_name_parts(name)
+        name.split(' ')
+      end
+
+      def only_initial?(name)
+        name.size <= 1
+      end
+
+      def separate_names(multi_name)
+        multi_name.split(/ and |;/)
+      end
+
+      def remove_titles(name)
+        name.split(',')[0]
+      end
+
+      def email_for_name_cache
+        @email_for_name_cache ||= {}
+      end
+    end
   end
 end

data/lib/ldap_disambiguate/version.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module LdapDisambiguate
-  VERSION = '0.0.3'.freeze
+  VERSION = '0.0.4'.freeze
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ldap_disambiguate
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Carolyn Cole