ampersat 0.0.1 → 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6232057d580f3bbeb66de8d6149fbd19f1d70c67
+  data.tar.gz: 2d3ab791c9798b8b7326f0c20f44bf19c949b052
+SHA512:
+  metadata.gz: 93eddae22b005d6f6b6b56b271cec43d81071f68fdc62d4ad886c65c69b79e4c107cfc290d43e830c8bd2b0ab77955e3c9a5a8c7d70e77e33b7bf03eccdb3574
+  data.tar.gz: 8c74fd344c52e67a5523d17dd0a35762ca421b107e74946c2bef50d7eb55cb5fe898c67b1785c34de1458ce232171dc4f8142207673010ff59578d718ec97331

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - 2.1.0
+  - 1.9.3

data/Gemfile

@@ -1,4 +1,4 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
 # Specify your gem's dependencies in ampersat.gemspec
 gemspec

data/README.md

@@ -1,5 +1,7 @@
 # Calculate Most Common Domains From Email List
 
+[![Build Status](https://secure.travis-ci.org/garethrees/ampersat.png)](http://travis-ci.org/garethrees/ampersat) [![Code Climate](https://codeclimate.com/github/garethrees/ampersat.png)](https://codeclimate.com/github/garethrees/ampersat)
+
 It's worth checking what email clients your subscribers are using so that you can make sure your emails look good when they view them.
 
 This gem looks at your subscribers CSV and lists the domains in order of popularity*.
@@ -10,24 +12,37 @@ This gem looks at your subscribers CSV and lists the domains in order of popular
 
 ### Install
 
-		gem install ampersat
+`gem install ampersat`
+
+### As CLI
+
+```shell
+$ ampersat domains --file=~/test.csv
+example.com: 2
+example.org: 1
+example.net: 1
+```
 
 ### In irb
 
-		$ irb
-		> require 'ampersat'
-		    => true
-		> Ampersat.domains("/path/to/csv")
-		=> [["example.com", 2], ["example.org", 1], ["example.net", 1]]
+```ruby
+$ irb
+> require 'ampersat'
+    => true
+> Ampersat.domains('/path/to/csv')
+=> [['example.com', 2], ['example.org', 1], ['example.net', 1]]
+```
 
 ### In Your App
 
-		domains = Ampersat.domains("/Users/gareth/test.csv")
+```ruby
+domains = Ampersat.domains('/Users/gareth/test.csv')
 
-		domains.each do |domain, count|
-			puts "#{domain}: #{count}"
-		end
+domains.each do |domain, count|
+  puts "#{domain}: #{count}"
+end
 
-		# example.com: 2
-		# example.org: 1
-		# example.net: 1
+# example.com: 2
+# example.org: 1
+# example.net: 1
+```

data/Rakefile

@@ -1,5 +1,7 @@
 require 'bundler/gem_tasks'
 
+task :default => [:test]
+
 task :test do
   exec('rspec spec/.')
 end

data/ampersat.gemspec

@@ -1,24 +1,29 @@
 # -*- encoding: utf-8 -*-
-$:.push File.expand_path("../lib", __FILE__)
-require "ampersat/version"
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ampersat/version'
 
 Gem::Specification.new do |s|
-  s.name        = "ampersat"
+  s.name        = 'ampersat'
   s.version     = Ampersat::VERSION
-  s.authors     = ["Gareth Rees"]
-  s.email       = ["gareth.h.rees@gmail.com"]
-  s.homepage    = "http://github.com/garethrees/ampersat"
-  s.summary     = "Calculates which email domains your subscribers use"
-  s.description = "Calculates which email domains your subscribers use"
+  s.authors     = ['Gareth Rees', 'Robert Coleman']
+  s.email       = ['gareth.h.rees@gmail.com', 'github@robert.net.nz']
+  s.homepage    = 'http://github.com/garethrees/ampersat'
+  s.summary     = 'Calculates which email domains your subscribers use'
+  s.description = 'Calculates which email domains your subscribers use'
 
   s.rubyforge_project = "ampersat"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ["lib"]
+  s.require_paths = ['lib']
 
   s.add_development_dependency 'rake'
-  s.add_development_dependency "rspec", "~> 2.7"
-
+  s.add_development_dependency 'rspec', '~> 2.7'
+  s.add_dependency 'thor', '~> 0.19.1'
+  s.add_dependency 'public_suffix', '~> 1.4.4'
+  s.add_dependency 'ruby-progressbar', '~> 1.5.1'
+  s.add_dependency 'celluloid', '0.15.2'
+  s.add_dependency 'celluloid-pmap', '~> 0.1.0'
 end

data/bin/ampersat

@@ -0,0 +1,12 @@
+#!/usr/bin/env ruby
+require 'pathname'
+bin_file = Pathname.new(__FILE__).realpath
+$:.unshift File.expand_path('../../lib', bin_file)
+
+Signal.trap('INT') do
+  puts "\nSIGINT recieved.. terminated."
+  exit 1
+end
+
+require 'ampersat/cli'
+Ampersat::CLI.start

data/lib/ampersat.rb

@@ -1,21 +1,53 @@
-require "ampersat/version"
-require "csv"
+require 'csv'
+require 'public_suffix'
+require 'ruby-progressbar'
+require 'resolv'
+require 'celluloid/pmap'
 
 module Ampersat
 
-  def self.domains(email_list)
+  def self.domains(email_list, column=0)
     domains = Hash.new(0)
-    
+
     CSV.foreach(email_list) do |row|
-      domain = Ampersat.find_domain(row.first)
-      domains[domain] = domains[domain] +1
+      domain = Ampersat.find_domain(row[column])
+      domains[domain] = domains[domain] + 1
+    end
+
+    domains.sort_by {|key, value| - value}
+  end
+
+  def self.mxs(email_list, column=0)
+    mxs = {}
+    domains = Ampersat.domains(email_list, column)
+    progressbar = ProgressBar.create(format: '%t: %c / %C |%B|', starting_at: 0, total: domains.length)
+    domains.pmap(100) do |domain, qty|
+      mx = Ampersat.find_mx(domain)
+      mxs[mx] ||= {}
+      mxs[mx]['domains'] ||= []
+      mxs[mx]['domains'] << domain
+      mxs[mx]['addresses'] ||= 0
+      mxs[mx]['addresses'] = mxs[mx]['addresses'] + qty
+      progressbar.increment
     end
 
-    domains.sort_by {|key, value| -value}    
+    mxs.sort_by {|key, value| - value['addresses'] }
   end
 
   def self.find_domain(email)
-    email.split('@').last
+    email.split('@').last.downcase
+  end
+
+  def self.find_mx(domain)
+    @mxs ||= {}
+    @mxs[domain] ||= begin
+      Resolv::DNS.open(nameserver: '8.8.8.8') do |dns|
+        next unless PublicSuffix.valid?(domain)
+        response = dns.getresources(domain, Resolv::DNS::Resource::IN::MX)
+        next unless response.any?
+        response.collect { |r| r.exchange.to_s.downcase }.sort.first
+      end
+    end
   end
 
 end

data/lib/ampersat/cli.rb

@@ -0,0 +1,30 @@
+require 'thor'
+require 'ampersat'
+
+module Ampersat
+  class CLI < Thor
+
+    default_task :help
+
+    desc 'domains </path/to/file.csv>', 'Analyse a CSV, returning domain list'
+    method_option :column, type: :numeric, default: 0
+    method_option :file, required: true, type: :string
+    def domains
+      domains = Ampersat.domains(File.expand_path(options[:file]), options[:column])
+      domains.each do |domain, count|
+        puts "#{ domain }: #{ count }"
+      end
+    end
+
+    desc 'mx </path/to/file.csv>', 'Analyse a CSV, returning MX list'
+    method_option :column, type: :numeric, default: 0
+    method_option :file, required: true, type: :string
+    def mx
+      mxs = Ampersat.mxs(File.expand_path(options[:file]), options[:column])
+      mxs.each do |mx, value|
+        puts "#{ mx } - #{ value['addresses'] }: #{ value['domains'].join(', ') }"
+      end
+    end
+
+  end
+end

data/lib/ampersat/version.rb

@@ -1,3 +1,3 @@
 module Ampersat
-  VERSION = "0.0.1"
+  VERSION = '1.0.0'
 end

data/spec/ampersat_spec.rb

@@ -1,30 +1,49 @@
 # encoding: utf-8
-path = File.expand_path(File.dirname(__FILE__) + "/../lib/")
+path = File.expand_path(File.dirname(__FILE__) + '/../lib/')
 $LOAD_PATH.unshift(path) unless $LOAD_PATH.include?(path)
-require "ampersat"
-
+require 'ampersat'
 
 describe Ampersat do
 
-  let(:csv_path) { File.expand_path(File.dirname(__FILE__) + "/support/test.csv") }
-  let(:email) { "test@example.com" }
-  let(:multiple_emails) { "jim@example.com, tom@example.com, bob@example.org, james@example.net" }
+  let(:csv_path) { File.expand_path(File.dirname(__FILE__) + '/support/test.csv') }
+  let(:email) { 'test@example.com' }
+  let(:multiple_emails) { 'jim@example.com, tom@example.com, bob@example.org, james@example.net' }
 
-  it "should return the sum of each email provider" do
-    expected_result = [["example.com", 2], ["example.org", 1], ["example.net", 1]]
+  it 'should return the sum of each email provider' do
+    expected_result = [['example.com', 3], ['example.org', 2], ['example.net', 1]]
     Ampersat.domains(csv_path).should == expected_result
   end
 
-  it "should return the email providers with the most common first" do
-    incorrect_result = [["example.org", 1],["example.com", 2], ["example.net", 1]]
+  it 'should return the email providers with the most common first' do
+    incorrect_result = [['example.org', 2],['example.com', 3], ['example.net', 1]]
     Ampersat.domains(csv_path).should_not == incorrect_result
 
-    expected_result = [["example.com", 2], ["example.org", 1], ["example.net", 1]]
+    expected_result = [['example.com', 3], ['example.org', 2], ['example.net', 1]]
     Ampersat.domains(csv_path).should == expected_result
   end
 
-  it "should find the domain of an email address" do
-    Ampersat.find_domain(email).should == "example.com"
+  it 'should find the domain of an email address' do
+    Ampersat.find_domain(email).should == 'example.com'
+  end
+
+  describe 'column' do
+    let(:csv_path) { File.expand_path(File.dirname(__FILE__) + '/support/multiple-columns.csv') }
+    let(:email) { 'test@example.com' }
+    let(:multiple_emails) { 'jim@example.com, tom@example.com, bob@example.org, james@example.net' }
+    let(:column) { 1 }
+
+    it 'should return the sum of each email provider' do
+      expected_result = [['example.com', 3], ['example.org', 2], ['example.net', 1]]
+      Ampersat.domains(csv_path, column).should == expected_result
+    end
+
+    it 'should return the email providers with the most common first' do
+      incorrect_result = [['example.org', 2],['example.com', 3], ['example.net', 1]]
+      Ampersat.domains(csv_path, column).should_not == incorrect_result
+
+      expected_result = [['example.com', 3], ['example.org', 2], ['example.net', 1]]
+      Ampersat.domains(csv_path, column).should == expected_result
+    end
   end
 
-end
+end

data/spec/support/multiple-columns.csv

@@ -0,0 +1,6 @@
+foo,tim@example.com,
+bar,tom@example.com,
+foo,ted@example.com,
+foo,bob@example.org,
+foo,bill@example.org,
+foo,jim@example.net

data/spec/support/test.csv

@@ -1,4 +1,6 @@
-jim@example.com,
+tim@example.com,
 tom@example.com,
+ted@example.com,
 bob@example.org,
-james@example.net
+bill@example.org,
+jim@example.net

metadata

@@ -1,79 +1,161 @@
 --- !ruby/object:Gem::Specification
 name: ampersat
 version: !ruby/object:Gem::Version
-  version: 0.0.1
-  prerelease: 
+  version: 1.0.0
 platform: ruby
 authors:
 - Gareth Rees
+- Robert Coleman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-30 00:00:00.000000000Z
+date: 2014-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &5275780 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *5275780
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &5275490 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *5275490
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.19.1
+- !ruby/object:Gem::Dependency
+  name: public_suffix
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.4
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.5.1
+- !ruby/object:Gem::Dependency
+  name: celluloid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: celluloid-pmap
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
 description: Calculates which email domains your subscribers use
 email:
 - gareth.h.rees@gmail.com
-executables: []
+- github@robert.net.nz
+executables:
+- ampersat
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
 - ampersat.gemspec
+- bin/ampersat
 - lib/ampersat.rb
+- lib/ampersat/cli.rb
 - lib/ampersat/version.rb
 - spec/ampersat_spec.rb
+- spec/support/multiple-columns.csv
 - spec/support/test.csv
 homepage: http://github.com/garethrees/ampersat
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: ampersat
-rubygems_version: 1.8.11
+rubygems_version: 2.2.0
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Calculates which email domains your subscribers use
 test_files:
 - spec/ampersat_spec.rb
+- spec/support/multiple-columns.csv
 - spec/support/test.csv