emiler 0.2.3 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9087d21f342c6fbf527446f3b9d12a7704d24fc3
-  data.tar.gz: 620b32bfe7e591eb14330ceb04e6c34a83258d5b
+  metadata.gz: 17d680b472c91879a2d30d06c5ff4252df1e2bf5
+  data.tar.gz: e7459390747cc3fb174acdad6f3fadaf137d7270
 SHA512:
-  metadata.gz: e6214d1f660358148d59dce104fb9b223d3896f89905fb45cdb4c1c72d2478c8ffba7f5d762c28efc030330a7db1837683b965355551a22a148c8101a98a6c7c
-  data.tar.gz: c48623402f161cabe1afb70d80ea515a31315f2c16700b61e9e4b797f329958eea4430254e29c1f4105a406c3009d6f71fd220697de74f9e4447a5d46bb10d64
+  metadata.gz: 05b5b0ce5d47397a655ab501b1d30e17066a667754b4c15608145b009b2d0c83dc8fdc0b5ee29fe6e5516d2a36d370f3364996e64630b76f9cf12a0b97518e42
+  data.tar.gz: 930f7d3c786b5744edfcea98e4ff0b0348498a455fd73e31535cd05727461dcc391b4eb6768776fa28899e7e348dd7a27996f83471abd10f1d7185a6fb5a9b4c

data/.rubocop.yml

@@ -54,3 +54,6 @@ Metrics/MethodLength:
 
 Metrics/PerceivedComplexity:
   Max: 20
+
+Metrics/AbcSize:
+  Max: 42

data/emiler.gemspec

@@ -28,4 +28,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'pry', '~> 0.10'
+
+  spec.add_dependency 'phone', '~> 1.2.3'
 end

data/lib/emiler.rb

@@ -1,9 +1,12 @@
 require 'emiler/version'
 require 'emiler/jarowinkler'
 
+require 'phone'
+
 module Emiler
   INEXACT_MATCH_COEFFICIENT = ENV['INEXACT_MATCH_COEFFICIENT'] || 0.8
   RAISE_ON_MALFORMED_EMAIL = ENV['RAISE_ON_MALFORMED_EMAIL']
+  COMPANY_NAME_STOP_WORDS = %w(ltd gmbh inc).freeze
 
   class JW
     attr_reader :jw
@@ -27,36 +30,106 @@ module Emiler
     end
   end
 
-  # rubocop:disable Metrics/AbcSize
-  def similarity e1, e2
-    e1, e2 = [e1, e2].map(&:to_s).map(&:downcase)
-    em1, em2 = [e1, e2].map { |e| e.split '@' }
+  class << self
+    def similarity item1, item2, type: :email
+      type = :default unless private_methods.include? :"similarity_#{type}"
+      item1, item2 = [item1, item2].map(&:to_s).map(&:strip).map(&:downcase)
+      { jw: JW::MATCHER.distance(item1, item2) }.merge send(:"similarity_#{type}", item1, item2)
+    end
+
+    private
 
-    if em1.size != 2 || em2.size != 2
-      raise MalformedEmailError.new(e1, e2) if RAISE_ON_MALFORMED_EMAIL
-      return JW::DUMMY
+    # stub for unknown types; returns empty hash for `similarity` to return jaro-winkler distance only
+    def similarity_default(*)
+      { result: nil }
     end
 
-    jw = JW::MATCHER.distance e1, e2
+    # similarity for company names
+    def similarity_company_name c1, c2
+      return { full: 1.0,
+               distances: [1.0] * c1.split(/\s+/).size,
+               matches: c1.split(/\s+/).size,
+               result: true } if c1 == c2 # exact match
+
+      c1, c2 = [c1, c2].map { |c| c.split(/\s+/).reject(&COMPANY_NAME_STOP_WORDS.method(:include?)) }
+      return { full: 1.0 - (1.0 - INEXACT_MATCH_COEFFICIENT) / 2.0, name: 1.0, result: true } if c1 == c2 # match without stopwords
+
+      dists = c1.product(c2)
+                .map { |(w1, w2)| JW::MATCHER.distance(w1, w2) }
+                .sort
+                .reverse
+      count = [c1, c2].map(&:size).min
+      average = dists.take(count).map.with_index { |e, i| e * (1.0 - i.to_f / count) / count }.reduce(:+)
+      { full: average, distances: dists, matches: dists.count(1.0), result: false }
+    end
 
-    domain = case
-             when em1.last == em2.last then 1 # exact domain match
-             when [em1, em2].map { |e| e.last.split('.')[-2] }.reduce(:==) then INEXACT_MATCH_COEFFICIENT
-             else INEXACT_MATCH_COEFFICIENT / 2.0 * JW::MATCHER.distance(em1.last, em2.last)
-             end
+    # similarity for phone numbers
+    def similarity_phone p1, p2
+      return { full: 1.0,
+               distances: [1.0],
+               result: true } if p1 == p2 # exact match
 
-    name = case
-           when em1.first == em2.first then 1 # exact match
-           when ![em1, em2].map { |e| e.first.scan(/[a-z]+/) }.reduce(:&).empty? then INEXACT_MATCH_COEFFICIENT
-           else INEXACT_MATCH_COEFFICIENT / 2.0 * JW::MATCHER.distance(em1.first, em2.first)
-           end
+      p1, p2 = [p1, p2].map { |p| p.split(/[,;]/) }
+                       .map do |p|
+                         p.map do |e|
+                           phone = e.delete('^0-9')
+                           phone = case phone.length
+                                   when 0..6 then phone
+                                   when 7 then "+3493#{phone}" # consider Barcelona
+                                   when 8..9 then "+34#{phone}" # consider Spain
+                                   else "+#{phone}"
+                                   end
+                           # rubocop:disable Style/RescueModifier
+                           Phoner::Phone.parse(phone) rescue nil # Phoner::CountryCodeError
+                           # rubocop:enable Style/RescueModifier
+                         end.compact
+                       end
 
-    full = domain * (1.0 - INEXACT_MATCH_COEFFICIENT) + name * INEXACT_MATCH_COEFFICIENT
+      dists = p1.product(p2)
+                .reject do |(pp1, pp2)|
+                  pp1.country_code != pp2.country_code ||
+                    pp1.area_code != pp2.area_code ||
+                    pp1.number[0...-2] != pp2.number[0...-2]
+                end.map do |(pp1, pp2)|
+                  case
+                  when pp1.number[-2..-1] == pp2.number[-2..-1] then 1.0
+                  when pp1.number[-2] == pp2.number[-2] then 0.9
+                  else 0.8
+                  end
+                end.sort.reverse
 
-    { jw: jw, full: full, name: name, domain: domain, result: full >= INEXACT_MATCH_COEFFICIENT * INEXACT_MATCH_COEFFICIENT }
+      { full: dists.first || 0.0, distances: dists, result: dists.first && dists.first >= INEXACT_MATCH_COEFFICIENT }
+    end
+
+    # rubocop:disable Metrics/AbcSize
+    # similarity for emails
+    def similarity_email e1, e2
+      return { full: 1.0,
+               name: 1.0,
+               domain: 1.0,
+               result: true } if e1 == e2
+
+      em1, em2 = [e1, e2].map { |e| e.split '@' }
+      if em1.size != 2 || em2.size != 2
+        raise MalformedEmailError.new(e1, e2) if RAISE_ON_MALFORMED_EMAIL
+        return JW::DUMMY
+      end
+
+      domain = case
+               when em1.last == em2.last then 1 # exact domain match
+               when [em1, em2].map { |e| e.last.split('.')[-2] }.reduce(:==) then INEXACT_MATCH_COEFFICIENT
+               else INEXACT_MATCH_COEFFICIENT / 2.0 * JW::MATCHER.distance(em1.last, em2.last)
+               end
+      name =   case
+               when em1.first == em2.first then 1 # exact match
+               when ![em1, em2].map { |e| e.first.scan(/[a-z]+/) }.reduce(:&).empty? then INEXACT_MATCH_COEFFICIENT
+               else INEXACT_MATCH_COEFFICIENT / 2.0 * JW::MATCHER.distance(em1.first, em2.first)
+               end
+      full = domain * (1.0 - INEXACT_MATCH_COEFFICIENT) + name * INEXACT_MATCH_COEFFICIENT
+      { full: full, name: name, domain: domain, result: full >= INEXACT_MATCH_COEFFICIENT * INEXACT_MATCH_COEFFICIENT }
+    end
+    # rubocop:enable Metrics/AbcSize
   end
-  # rubocop:enable Metrics/AbcSize
 
-  private_constant :JW, :MalformedEmailError
-  module_function :similarity
+  private_constant :JW
 end

data/lib/emiler/version.rb

@@ -1,3 +1,3 @@
 module Emiler
-  VERSION = "0.2.3"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: emiler
 version: !ruby/object:Gem::Version
-  version: 0.2.3
+  version: 0.3.0
 platform: ruby
 authors:
 - Aleksei Matiushkin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-27 00:00:00.000000000 Z
+date: 2016-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: phone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.2.3
 description: This library is kinda analogue of Jaro-Winkler distance between two emails.
 email:
 - aleksei.matiushkin@kantox.com