email_predictor 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bc3838f87246bf751929a1a07b00a62cf648efd7
+  data.tar.gz: 683347dace43d89d75630ffb7f442c4650c3b6d7
+SHA512:
+  metadata.gz: a0edcd07228ff5348e4916bde3d1ad59f18c6dcc90a5a3f491fc9930b913a0a55620e2c9ba1602f8fe779679ed961ce9bedab5114ae149d65743edadb624fda5
+  data.tar.gz: 1e5e6c64a48d2d9a02e8a4d03c301b4a14bc22bee60c7ba938c5ea6efac316f721e0aedf3fad3f26e7b0d2ccdbb6557700540ea3e5fb0577b8f1b356fd2a4465

data/lib/email_predictor/base.rb

@@ -0,0 +1,17 @@
+module EmailPredictor
+  class Base
+
+    attr_reader :name
+
+    def initialize(opts)
+      @name = opts[:name].downcase
+    end
+
+    #Validate that the name should be in format of firstname lastname
+    def validate!
+      unless @name.split(" ").count.eql?(2)
+        raise TypeError.new("Oops, the name is not in valid format.  Should be like 'Firstname lastname', Eg: John Ferguson")
+      end
+    end
+  end
+end

data/lib/email_predictor/data_analyser.rb

@@ -0,0 +1,66 @@
+#This is responsible for predicting the rules on the knowledge of existing data.
+# Usage
+
+# EmailPredictor::DataAnalyser.all
+# This gives the analysis for all the existing records
+
+# To find for a particular company
+# Usage
+# EmailPredictor::DataAnalyser.find('google')
+module EmailPredictor
+
+  class DataAnalyser
+
+    attr_reader :company,:rules
+
+    def initialize(opts)
+      @company = opts[:company]
+      @rules   = opts[:rules]
+    end
+
+    class << self
+      def all
+        collection = []
+        group_by_company.each_pair do |key,value|
+          collection << new(company: key,rules: get_rules(value))
+        end
+        collection
+      end
+
+
+      def get_rules(employees)
+        EmailPredictor::Rules.get(employees)
+      end
+
+      #Sample dataset
+      #TODO: should be flexible and via a .yml or .json file
+      def dataset
+        {
+          'John Ferguson' => 'john.ferguson@alphasights.com',
+          'Damon Aw'      => 'damon.aw@alphasights.com',
+          'Linda Li'      => 'linda.li@alphasights.com',
+          'Larry Page'    => 'larry.p@google.com',
+          'Sergey Brin'   => 's.brin@google.com',
+          'Steve Jobs'    => 's.j@apple.com'
+        }
+      end
+
+      def find(company)
+        all.find {|i| i.company == company}
+      end
+
+      # We need to group the dataset by the company and the number of people associated with
+      # it
+      def group_by_company
+        hsh = Hash.new
+        dataset.each_pair do |key,value|
+          company      = value.split('@')[1].split('.')[0] #get the company name
+          username     = value.split('@')[0]
+          hsh[company] ||= []
+          hsh[company] << { name: key,username: username }
+        end
+        hsh
+      end
+    end
+  end
+end

data/lib/email_predictor/predictor.rb

@@ -0,0 +1,43 @@
+#This is reponsible for the call to the engine.
+# A sample usage can look like
+
+# EmailPredictor::Predictor.predict(name: 'Ankit Gupta',company: 'google')
+
+module EmailPredictor
+  class Predictor < Base
+
+    attr_reader :company,:predicted_emails,:message
+
+    def initialize(opts = {})
+      super
+      @company          = opts[:company]
+      @predicted_emails = []
+      validate!
+    end
+
+    class << self
+      def predict(opts)
+        obj = new(opts).predict
+        obj
+      end
+    end
+
+    def predict
+      obj = EmailPredictor::Rules.new(name: @name)
+      unless applicable_rules.empty?
+        applicable_rules.collect do |rule|
+          @predicted_emails << "#{obj.send(rule)}@#{@company}.com"
+          @message = 'Successfully predicted emails.'
+        end
+      else
+        @message = "Prediction cannot be done for #{@name.titleize} as we don't have any historical data for #{@company} company."
+      end
+      self
+    end
+
+    def applicable_rules
+      data_analyser = EmailPredictor::DataAnalyser.find(@company)
+      data_analyser ? data_analyser.rules : []
+    end
+  end
+end

data/lib/email_predictor/rules.rb

@@ -0,0 +1,78 @@
+# This is responsible for the prediction of existing data
+module EmailPredictor
+  class Rules < Base
+
+    attr_reader :name,:username
+
+    def initialize(opts = {})
+      super
+      @username = opts[:username]
+      validate!
+    end
+
+    def some_fake_rule
+      "Holla!"
+    end
+
+    def first_name_dot_last_name
+      "#{first_name}.#{last_name}"
+    end
+
+    def first_name_dot_last_initial
+      "#{first_name}.#{last_name_initial}"
+    end
+
+    def first_initial_dot_last_name
+      "#{first_name_initial}.#{last_name}"
+    end
+
+    def first_initial_dot_last_initial
+      "#{first_name_initial}.#{last_name_initial}"
+    end
+
+    def first_name
+      @name.split(' ').first
+    end
+
+    def last_name
+      @name.split(' ').last
+    end
+
+    def first_name_initial
+      first_name[0,1]
+    end
+
+    def last_name_initial
+      last_name[0,1]
+    end
+
+    def username_first
+      @username.split('.').first
+    end
+
+    def username_last
+      @username.split('.').last
+    end
+
+    def predict
+      if first_name.eql?(username_first) && last_name.eql?(username_last)
+        'first_name_dot_last_name'
+      elsif first_name_initial.eql?(username_first) && last_name.eql?(username_last)
+        'first_initial_dot_last_name'
+      elsif first_name_initial.eql?(username_first) && last_name_initial.eql?(username_last)
+        'first_initial_dot_last_initial'
+      elsif first_name.eql?(username_first) && last_name_initial.eql?(username_last)
+        'first_name_dot_last_initial'
+      end
+    end
+
+    class << self
+      def get(employees)
+        employees.collect do |employee|
+          rule = new(employee)
+          rule.predict
+        end.uniq
+      end
+    end
+  end
+end

data/lib/email_predictor.rb

@@ -0,0 +1,5 @@
+require 'active_support/inflector'
+require 'email_predictor/base'
+require 'email_predictor/data_analyser'
+require 'email_predictor/predictor'
+require 'email_predictor/rules'

metadata

@@ -0,0 +1,128 @@
+--- !ruby/object:Gem::Specification
+name: email_predictor
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- ankit8898
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: rspec-collection_matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.4'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 10.4.2
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: Predict emails on a historical pattern for a company
+email: ankit.gupta8898@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/email_predictor.rb
+- lib/email_predictor/base.rb
+- lib/email_predictor/data_analyser.rb
+- lib/email_predictor/predictor.rb
+- lib/email_predictor/rules.rb
+homepage: https://rubygems.org/gems/email_predictor
+licenses:
+- MIT
+metadata: {}
+post_install_message: Thanks for installing!
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5
+signing_key: 
+specification_version: 4
+summary: This is an email predictor!
+test_files: []