mailtest 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 609959bc9a33b070c2b676661ce2d336ac775766
+  data.tar.gz: 6624c276d23cb5c2186b165d7bdfec6df2104e0b
+SHA512:
+  metadata.gz: 905521f21c4e5c8cf24b5fde50f7d6d767b7fccf706aaf96530be25abab7336d23ccc9463a0f57beff81487c801718b34596ca347ee636ad2e346f8af70ee74c
+  data.tar.gz: 266f7e0a153ced5fa3cc27f0e30b0cfda1a5b159ac25a3e5dcc803ace73ac568156a82c3f92a01f4e4180d5fbca254a8f31212afb8605d32182a8a4c19137d74

data/.envrc

@@ -0,0 +1,7 @@
+if has nix-env ; then
+  use nix -p bundler ruby
+fi
+
+layout ruby
+
+PATH_add ./bin

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.yml

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Peter Hoeg
+
+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.org

@@ -0,0 +1,45 @@
+* Mailtest
+
+This tool sends test messages to a number of receivers specified in a YAML file.
+
+All the messages get a sequence number and a generated "transaction word" in
+order to make the emails easy to search for.
+
+Please keep in mind that as the "transaction word" is randomly generated it may
+end up being something offensive. If it offends you or any of the receivers or
+anybody else who happens to see the generated mails, that is simply too bad - it
+is not our problem.
+
+** Installation
+
+Add this line to your application's Gemfile:
+
+#+BEGIN_SRC ruby
+  gem 'mailtest'
+#+END_SRC
+
+And then execute:
+
+#+BEGIN_SRC shell
+  bundle
+#+END_SRC
+
+Or install it yourself as:
+
+#+BEGIN_SRC shell
+  gem install mailtest
+#+END_SRC
+
+** Usage
+
+bin/mailtest --help will give you the details on how to use it
+
+** Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/peterhoeg/mailtest.
+
+
+** License
+
+The gem is available as open source under the terms of the [[http://opensource.org/licenses/MIT][MIT License]].

data/Rakefile

@@ -0,0 +1,16 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+DIRS = %w[lib test].freeze
+
+Rake::TestTask.new(:test) do |t|
+  t.libs = DIRS
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+Rake::TestTask.new(:bench) do |t|
+  t.libs = DIRS
+  t.test_files = FileList['test/**/*_benchmark.rb']
+end
+
+task default: :test

data/bin/mailtest

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+require 'bundler/setup'
+
+$LOAD_PATH.unshift 'lib'
+require 'mailtest/cli'

data/lib/mailtest.rb

@@ -0,0 +1,7 @@
+$VERBOSE = nil
+
+require 'mailtest/runner'
+require 'mailtest/version'
+
+module Mailtest
+end

data/lib/mailtest/cli.rb

@@ -0,0 +1,86 @@
+$stdout.sync = true
+$stderr.sync = true
+
+require 'main'
+require 'mailtest'
+
+Main do
+  argument('receiver') do
+    required
+    description 'An email address or the file with the list of receivers'
+  end
+
+  argument('from') do
+    required
+    description 'The sender of the email'
+  end
+
+  option('body') do
+    argument :required
+    default <<-EOF
+This is an email test. You can safely ignore this message.
+
+This word does not mean anything: @word@
+    EOF
+    description 'The body of the message'
+  end
+
+  option('subject') do
+    argument :required
+    default '[@index@/@count@]: @word@ test for @receiver@, @timestamp@'
+    description 'The subject of the message'
+  end
+
+  option('cc') do
+    argument :required
+    cast :list_of_string
+    description 'A comma separated list of addresses to keep in CC'
+  end
+
+  option('bcc') do
+    argument :required
+    cast :list_of_string
+    description 'A comma separated list of addresses to keep in BCC'
+  end
+
+  option('domain') do
+    argument :required
+    description 'The domain to add to or replace in the receiver list'
+  end
+
+  option('host') do
+    argument :required
+    default 'localhost'
+    description 'The mail hosts through which we send'
+  end
+
+  option('port') do
+    argument :required
+    cast :int
+    default 25
+    description 'The mail host port through which we send'
+  end
+
+  option('word_length') do
+    argument :required
+    cast :int
+    default 20
+    description 'Minimum length of the random word used'
+  end
+
+  option('debug') do
+    cast :bool
+    description 'Enter debugging mode'
+  end
+
+  option('dry-run') do
+    cast :bool
+    description 'Do we actually send the messages'
+  end
+
+  def run
+    runner = Runner.new(params)
+    runner.run
+    exit_success!
+  end
+end

data/lib/mailtest/runner.rb

@@ -0,0 +1,170 @@
+require 'ap'
+require 'mail'
+require 'progress_bar'
+require 'rainbow'
+require 'random-word'
+require 'yaml'
+
+class Runner
+  def initialize(params)
+    setup_logger!(params['debug'].value)
+    setup_mail!(params)
+    setup_receivers!(params)
+    setup_tokens!(params)
+    @bar = ProgressBar.new(@receivers.count)
+    @dry_run = params['dry-run'].value
+    @messages = []
+
+    create_emails!(params)
+  end
+
+  def run
+    errors = []
+    success = 0
+
+    @logger.info "Sending '#{@tokens[:word]}' to #{@tokens[:count]} recipient(s)"
+
+    @messages.each_with_index do |m, i|
+      receivers = m.to.join(', ')
+      @logger.debug "Sending to: #{receivers} #{x_of_y(i)}"
+      begin
+        m.deliver unless @dry_run
+        success += 1
+      rescue StandardError => e
+        errors << receivers
+        @logger.error Rainbow(e.message).red
+      ensure
+        @bar.increment!
+      end
+    end
+
+    show_result!(success, errors)
+  end
+
+  def debug
+    @messages.each do |m|
+      ap m
+    end
+  end
+
+  private
+
+  def setup_logger!(debug)
+    @logger = Logger.new(STDOUT)
+    @logger.level = debug ? Logger::DEBUG : Logger::INFO
+  end
+
+  def setup_mail!(params)
+    Mail.defaults do
+      delivery_method :smtp,
+                      address: params['host'].value,
+                      port: params['port'].value
+    end
+  end
+
+  def setup_receivers!(params)
+    @logger.debug 'Creating receiver list'
+    receivers = []
+    receiver = params['receiver'].value
+    if File.exist?(receiver)
+      begin
+        receivers = YAML.load_file(receiver)
+      rescue StandardError => e
+        @logger.error e.message
+      end
+      @logger.debug "#{receiver} is a file with email addresses"
+    elsif receiver =~ /,/
+      receivers = receiver.split(',')
+      @logger.debug "#{receiver} is a list of email addresses"
+    elsif valid_email?(receiver)
+      # we expect an array
+      receivers << receiver
+      @logger.debug "#{receiver} is a valid email address"
+    else
+      raise "#{receiver} is neither an email address nor a file with addresses"
+    end
+
+    @receivers = receivers.map do |r|
+      add_or_replace_domain(r, params['domain'].value)
+    end
+
+    @logger.debug "Receivers: #{@receivers}"
+    @count = @receivers.length
+  end
+
+  def setup_tokens!(params)
+    @logger.debug 'Creating tokens'
+    length = params['word_length'].value
+    @tokens = {
+      count: @receivers.count,
+      index: 0,
+      receiver: nil,
+      timestamp: Time.now,
+      word: RandomWord.nouns(not_shorter_than: length).next
+    }
+  end
+
+  def create_emails!(params)
+    @logger.debug 'Creating mails'
+    @receivers.each_with_index do |receiver, i|
+      @tokens[:index] = i + 1
+      @tokens[:receiver] = receiver
+      subjectp = replace_tokens(params['subject'].value)
+      bodyp = replace_tokens(params['body'].value)
+      @messages << Mail.new do
+        from    params['from'].value
+        to      receiver
+        subject subjectp
+        body    bodyp
+        cc      params['cc'].value
+      end
+    end
+  end
+
+  def color_number(number, color, color_zero = false)
+    return number.to_s if number.zero? && !color_zero
+    Rainbow(number.to_s).color(color)
+  end
+
+  def show_result!(success, errors)
+    success_str = color_number(success, :green, true)
+    errors_str = color_number(errors.length, :red)
+
+    @logger.info "Finished: [#{success_str}/#{errors_str}/#{@count}]"
+    if errors.empty?
+      @logger.info Rainbow('Success!').green
+    else
+      @logger.error Rainbow("Errors: #{errors.join(', ')}").red
+    end
+  end
+
+  def valid_email?(str)
+    !str !~ /@/
+  end
+
+  def add_or_replace_domain(receiver, domain)
+    if valid_email?(receiver) && domain
+      user = receiver.split('@')[0]
+      return [user, domain].join('@')
+    elsif valid_email?(receiver)
+      return receiver
+    elsif domain
+      return [receiver, domain].join('@')
+    end
+    @logger.error "Receiver: #{receiver}, domain: #{domain}"
+    raise ArgumentError, 'Unable to read/generate email address'
+  end
+
+  def replace_tokens(str)
+    s = str
+
+    %w[count index receiver timestamp word].each do |t|
+      s = s.gsub("@#{t}@", @tokens[t.to_sym].to_s)
+    end
+    s
+  end
+
+  def x_of_y(x)
+    "[#{x + 1}/#{@tokens[:count]}]"
+  end
+end

data/lib/mailtest/version.rb

@@ -0,0 +1,3 @@
+module Mailtest
+  VERSION = '0.0.4'.freeze
+end

data/mailtest.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mailtest/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mailtest'
+  spec.version       = Mailtest::VERSION
+  spec.authors       = ['Peter Hoeg']
+  spec.email         = ['peter@hoeg.com']
+
+  spec.summary       = 'Generate a test email to a list of receivers.'
+  spec.description   = 'Helps when doing mass email changes or migrations\
+ where you need to verify that everything is set up correctly.'
+  spec.homepage      = 'https://github.com/peterhoeg/mailtest'
+  spec.license       = 'MIT'
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'minitest-reporters'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+
+  spec.add_dependency 'mail'
+  spec.add_dependency 'main'
+  spec.add_dependency 'awesome_print'
+  spec.add_dependency 'progress_bar'
+  spec.add_dependency 'rainbow'
+  spec.add_dependency 'random-word'
+end

metadata

@@ -0,0 +1,212 @@
+--- !ruby/object:Gem::Specification
+name: mailtest
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Peter Hoeg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: minitest
+  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: minitest-reporters
+  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: 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: rubocop
+  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: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: main
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: progress_bar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: random-word
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: |-
+  Helps when doing mass email changes or migrations\
+   where you need to verify that everything is set up correctly.
+email:
+- peter@hoeg.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".envrc"
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.org
+- Rakefile
+- bin/mailtest
+- lib/mailtest.rb
+- lib/mailtest/cli.rb
+- lib/mailtest/runner.rb
+- lib/mailtest/version.rb
+- mailtest.gemspec
+homepage: https://github.com/peterhoeg/mailtest
+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.6.10
+signing_key: 
+specification_version: 4
+summary: Generate a test email to a list of receivers.
+test_files: []