predict_email 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a280c17a8357a36c827be8904494e1d03671615b
+  data.tar.gz: e0e22ad84d8cd93688bb4e4bfcd0463f3af997b2
+SHA512:
+  metadata.gz: 3b92770f87ff58a9ab73c104c3693e357737b135bc6aec1ef3bd677a40e225f62ed46dace71aaddb0916a7b580574530e842cd5cb6ead175faab4903c320bace
+  data.tar.gz: d3449c513eae05f1434380c8262005e41babb38231eab6c158022d963358ca59f45de371b26514fb8c827e72da025a89afb54c55ab5060db3ff6758f97b515f2

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+cache: bundler
+
+rvm:
+  - ruby
+  - 2.1.1
+
+script: 'bundle exec rake'
+
+notifications:
+  email:
+    recipients:
+      - kyledoherty22@gmail.com
+    on_failure: change
+    on_success: never

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in hola_kyle.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: .
+  specs:
+    predict_email (0.0.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coveralls (0.7.1)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
+    diff-lcs (1.2.5)
+    docile (1.1.5)
+    mime-types (2.3)
+    multi_json (1.10.1)
+    netrc (0.7.7)
+    rake (10.3.2)
+    rest-client (1.7.2)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    simplecov (0.9.0)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.6)
+  coveralls
+  predict_email!
+  rake
+  rspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 kylefdoherty
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,32 @@
+# PredictEmail
+[![Code Climate](https://codeclimate.com/repos/53ff211a6956807cee01ecad/badges/9f8afa9a0ff41f8e85ff/gpa.svg)](https://codeclimate.com/repos/53ff211a6956807cee01ecad/feed)
+[![Build Status](https://travis-ci.org/kylefdoherty/email-prediction.svg?branch=master)](https://travis-ci.org/kylefdoherty/email-prediction)
+[![Coverage Status](https://img.shields.io/coveralls/kylefdoherty/email-prediction.svg)](https://coveralls.io/r/kylefdoherty/email-prediction?branch=master)
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'predict_email'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install predict_email
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/predict_email/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+
+
+# Default directory to look in is `/specs`
+# Run with `rake spec`
+RSpec::Core::RakeTask.new(:spec) do |task|
+  task.rspec_opts = ['--color']
+end
+
+task :default => :spec
+
+

data/ToDo.md

@@ -0,0 +1,5 @@
+ToDo.md
+- get gem all setup & push to rubygems.org
+- setup Travis, codecoverage etc. & add badges to readme 
+- complete readme describing exactly how to use the gem 
+- TEST it out 

data/bin/predict_email

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'predict_email'
+
+PredictEmail::Cli::App.new

data/lib/predict_email/app.rb

@@ -0,0 +1,58 @@
+require_relative 'predict_email'
+
+module PredictEmail
+  module Cli
+    class App 
+
+
+      def parse_input(user_input)
+        user_input.split(',')
+      end 
+
+      def valid_input(user_input)
+        name, company = parse_input(user_input)
+        if name.split(" ").size != 2 || company == nil
+          p "Please enter a first and last name along with the company, such as: 'Steve Jobs', 'Apple.com'"
+          user_input = gets.strip
+          valid_input(user_input) 
+        else
+          return user_input    
+        end 
+      end 
+
+      def initialize
+        prediction = PredictEmail.new
+
+        puts "Enter a name and company website, such as: 'Steve Jobs', 'Apple.com' OR type 'exit' to leave."
+        user_input = gets.strip
+        
+        until user_input == 'exit'
+
+          puts "\n"
+          name, company = parse_input(valid_input(user_input))
+          p "PREDICTION: #{prediction.predict_email(name, company.strip)}"
+          puts "\n"
+          p "Enter a name and company website, such as: 'Steve Jobs', 'Apple.com'"
+          user_input = gets.strip
+
+        end 
+      end
+
+
+
+
+    end 
+  end 
+end 
+
+if $0 == __FILE__
+  PredictEmail::Cli::App.new
+end 
+
+
+
+
+
+
+
+

data/lib/predict_email/csv/sample_data.csv

@@ -0,0 +1,7 @@
+Damon Aw,damon.aw@alphasights.com
+John Ferguson,john.ferguson@alphasights.com
+Kyle Doherty,kyle_doherty@flatironschool.com
+Larry Page,larry.p@google.com
+Linda Li,linda.li@alphasights.com
+Sergey Brin,s.brin@google.com
+Steve Jobs,s.j@apple.com

data/lib/predict_email/find_pattern.rb

@@ -0,0 +1,64 @@
+require 'csv'
+
+module PredictEmail
+  class FindPattern
+    attr_reader :emails
+
+    def initialize 
+      @emails = CSV.read(Dir.pwd + '/lib/predict_email/csv/sample_data.csv').inject({}) do |result, element|
+        result[element.first] = element.last
+        result
+      end 
+    end 
+
+    def normalize_company_name(company)
+      company.downcase.gsub(/\s+/, "")
+    end 
+
+    def find_contacts(company)
+      company = normalize_company_name(company)
+      emails.select {|k,v| v.include?(company) }
+    end 
+
+    def split_email(email)
+      email[/[^@]+/].downcase.split('.')
+    end
+
+    def email_pattern(contact)
+      first_name, last_name = contact.first.downcase.split(' ')
+      before_dot, after_dot = split_email(contact.last)
+
+        if first_name == before_dot && last_name == after_dot
+          "first_name_dot_last_name"
+        elsif first_name == before_dot && last_name[0] == after_dot
+          "first_name_dot_last_initial"
+        elsif first_name[0] == before_dot && last_name == after_dot
+          "first_initial_dot_last_name"
+        elsif first_name[0] == before_dot && last_name[0] == after_dot
+          "first_initial_dot_last_initial"
+        else 
+          nil
+        end 
+    end 
+
+    def find_patterns(company)
+      patterns = []
+
+      if find_contacts(company).empty? 
+        patterns << nil
+      else 
+   
+        find_contacts(company).each do |contact|
+          patterns << email_pattern(contact)
+        end 
+
+      end 
+        patterns = patterns.uniq
+    end 
+  end 
+end 
+
+
+if $0 == __FILE__
+  test = PredictEmail::FindPattern.new
+end 

data/lib/predict_email/predict_email.rb

@@ -0,0 +1,64 @@
+require_relative 'find_pattern'
+
+module PredictEmail
+  class PredictEmail
+
+    def predict_email(name, company)
+      patterns = FindPattern.new.find_patterns(company)
+      if patterns.first 
+        emails = patterns.map {|pat| self.send(pat.to_sym, name, company)}
+        "#{company} uses #{patterns.size} email #{pluralize_pattern(patterns)}: #{patterns_to_string(patterns)}. We predict #{name}'s email to be: #{emails_to_string(emails)}."
+      else 
+        "Sorry, we can't predict the email for this person."
+      end 
+    end 
+
+    def patterns_to_string(patterns)
+      patterns.join(", ")
+    end 
+
+    def emails_to_string(emails)
+      emails.join(", ").gsub(", ", " OR ")
+    end 
+
+    def split_name(name)
+      name.downcase.split(" ")
+    end 
+
+    def first_name_dot_last_name(name, company)
+      first, last = split_name(name)
+      "#{first}.#{last}@#{company}"
+    end 
+
+    def first_name_dot_last_initial(name, company)
+      first, last = split_name(name)
+      "#{first}.#{last[0]}@#{company}"
+    end 
+
+    def first_initial_dot_last_name(name, company)
+      first, last = split_name(name)
+      "#{first[0]}.#{last}@#{company}"
+    end 
+
+    def first_initial_dot_last_initial(name,company)
+      first, last = split_name(name)
+      "#{first[0]}.#{last[0]}@#{company}"
+    end 
+
+    def pluralize_pattern(patterns)
+      patterns.size > 1 ? 'patterns' : 'pattern'
+    end 
+
+  end 
+end 
+
+ 
+
+  
+
+
+
+
+
+
+

data/lib/predict_email/version.rb

@@ -0,0 +1,3 @@
+module PredictEmail
+  VERSION = "0.0.1"
+end

data/lib/predict_email.rb

@@ -0,0 +1,4 @@
+require "predict_email/version"
+require "predict_email/app"
+require "predict_email/find_pattern"
+require "predict_email/predict_email"

data/predict_email.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'predict_email/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "predict_email"
+  spec.version       = PredictEmail::VERSION
+  spec.authors       = ["kylefdoherty"]
+  spec.email         = ["kyledoherty22@gmail.com"]
+  spec.summary       = %q{Gem that allows you to predict a persons email from their name and company name.}
+  spec.description   = %q{Can add a csv with names and emails and then predict what a person's email will be by looking at patterns used by other people from same company.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = ["predict_email"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "coveralls"
+end

data/spec/find_pattern_spec.rb

@@ -0,0 +1,73 @@
+require_relative 'spec_helper'
+
+describe PredictEmail::FindPattern do 
+
+  let(:prediction) { PredictEmail::FindPattern.new }
+
+  let(:sample_emails) {
+    {
+      "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",
+      "Kyle Doherty" => "kyle_doherty@flatironschool.com"
+    }
+  }
+
+
+  #create class that has patterns & sample data
+  describe '#new' do 
+    it 'is an instance of PredictEmail' do 
+      expect(prediction).to be_instance_of(PredictEmail::FindPattern)
+    end
+
+    it 'has the sample data on initialization' do 
+      expect(prediction.emails).to eq(sample_emails)
+    end 
+  end 
+
+  #method that takes in name and company and figures out which pattern(s) that company uses
+
+  #first need to get the emails for that company we already have
+  describe '#find_contacts' do 
+    alphasights_emails = {"John Ferguson" => "john.ferguson@alphasights.com", 
+                          "Damon Aw" => "damon.aw@alphasights.com", 
+                          "Linda Li" => "linda.li@alphasights.com"}
+
+    it 'takes the name and company and returns what pattern(s) that company uses for emails' do 
+      expect(prediction.find_contacts("alphasights")).to eq(alphasights_emails)
+    end 
+  end 
+
+  #loop through the emails we have and figure out what each uses 
+  #and store them in a patterns collection 
+
+  describe '#find_patterns' do 
+    context 'compnay uses one email pattern' do 
+      it 'returns the pattern(s) that company uses' do 
+        expect(prediction.find_patterns('Alphasights.com')).to eq(['first_name_dot_last_name'])
+      end 
+    end     
+
+    context 'compnay uses more than one email pattern' do 
+      it 'returns the pattern(s) that company uses' do 
+        expect(prediction.find_patterns('google.com')).to eq(['first_name_dot_last_initial','first_initial_dot_last_name' ])
+      end 
+    end 
+
+    context 'company email pattern is not one of four checking for' do 
+      it 'returns that it can not predict that pattern' do 
+        expect(prediction.find_patterns('flatironschool.com')).to eq([nil])
+      end 
+    end 
+
+    context 'no emails are returned for that company' do 
+      it 'returns that there are no contacts for that company' do 
+        expect(prediction.find_patterns('partnersgroup.com')).to eq([nil])
+      end 
+    end 
+  end 
+
+end 

data/spec/predict_email_spec.rb

@@ -0,0 +1,77 @@
+require_relative 'spec_helper'
+
+describe PredictEmail::PredictEmail do 
+
+  let(:prediction) { PredictEmail::PredictEmail.new }
+
+  describe '#predict_email' do 
+
+    context 'company uses one pattern' do 
+      it "predicts the person's email and returns pattern and predicted email" do 
+
+        expected_response = "alphasights.com uses 1 email pattern: first_name_dot_last_name. We predict Peter Wong's email to be: peter.wong@alphasights.com."
+     
+        expect(prediction.predict_email( "Peter Wong", "alphasights.com")).to eq(expected_response)
+      end 
+    end 
+
+    context 'company uses more than one pattern' do 
+      it "predicts the person's email and returns patterns and predicted emails" do
+        expected_response = "google.com uses 2 email patterns: first_name_dot_last_initial, first_initial_dot_last_name. We predict Craig Silverstein's email to be: craig.s@google.com OR c.silverstein@google.com."
+
+        expect(prediction.predict_email("Craig Silverstein", "google.com")).to eq(expected_response)
+
+      end  
+    end 
+
+    context 'company uses more than one pattern' do 
+      it "tells user can't predict the email for this person" do
+        expected_response = "Sorry, we can't predict the email for this person."
+
+        expect(prediction.predict_email("Avi Flombaum", "flatironschool.com")).to eq(expected_response)
+
+      end  
+    end 
+
+    context 'no contacts for that company' do 
+      it "tells user can't predict email for this person" do
+        expected_response = "Sorry, we can't predict the email for this person."
+
+        expect(prediction.predict_email("Rust Cohle", "truedetective.com")).to eq(expected_response)
+
+      end  
+    end 
+
+  end 
+
+
+  describe '#first_name_dot_last_name' do 
+    it 'converts the name to appropriate email' do 
+      expect(prediction.first_name_dot_last_name("Peter Wong", "alphasights.com")).to eq('peter.wong@alphasights.com')
+    end 
+  end 
+
+  describe '#first_name_dot_last_initial' do 
+    it 'converts the name to appropriate email' do 
+      expect(prediction.first_name_dot_last_initial("Craig Silverstein", "google.com")).to eq('craig.s@google.com')
+    end 
+  end 
+
+  describe '#first_initial_dot_last_name' do 
+    it 'converts the name to appropriate email' do 
+      expect(prediction.first_initial_dot_last_name("Marty Hart", "truedetective.com")).to eq('m.hart@truedetective.com')
+    end 
+  end 
+
+  describe '#first_initial_dot_last_initial' do 
+    it 'converts the name to appropriate email' do 
+      expect(prediction.first_initial_dot_last_initial("Marty Hart", "truedetective.com")).to eq('m.h@truedetective.com')
+    end 
+  end
+
+end 
+
+
+
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rspec'
+
+require 'coveralls'
+Coveralls.wear!
+
+require_relative '../lib/predict_email/find_pattern'
+require_relative '../lib/predict_email/predict_email'

metadata

@@ -0,0 +1,126 @@
+--- !ruby/object:Gem::Specification
+name: predict_email
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- kylefdoherty
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-08-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Can add a csv with names and emails and then predict what a person's
+  email will be by looking at patterns used by other people from same company.
+email:
+- kyledoherty22@gmail.com
+executables:
+- predict_email
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ToDo.md
+- bin/predict_email
+- lib/predict_email.rb
+- lib/predict_email/app.rb
+- lib/predict_email/csv/sample_data.csv
+- lib/predict_email/find_pattern.rb
+- lib/predict_email/predict_email.rb
+- lib/predict_email/version.rb
+- predict_email.gemspec
+- spec/find_pattern_spec.rb
+- spec/predict_email_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Gem that allows you to predict a persons email from their name and company
+  name.
+test_files:
+- spec/find_pattern_spec.rb
+- spec/predict_email_spec.rb
+- spec/spec_helper.rb