trikle-mail 0.0.3 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d1d4893cd70f9c06b996c6fb6e836d286b49d9f1
-  data.tar.gz: 743d5bf00407d3a037ba23d1e5de77fb5b3a824a
+SHA256:
+  metadata.gz: 5d9a65541914cfad901296c5d39cb0fb173ecc85390886f8902f8006d39d37bc
+  data.tar.gz: 0e4ebb9c03c7e2f2a34ab263f6aaa69584cf25095f39e65d89c0a795be503035
 SHA512:
-  metadata.gz: e9e0bd7203ce7a7af339f53129d0f6441c2cb202d0c118309448499eabdac39bbd7869f558d318f7e3ed11d10bb2f63a5bbc758ea8e97c5685d9299ac8c754ce
-  data.tar.gz: f07592534deba8b7ac50d29e44fbbc2f9caffa897e4415f3c0c1390d7a3721a698a32b1e304c518ef93087a0085621252e42c84e39f0dfe5a2f9733cf33bd1c6
+  metadata.gz: a696c2c3cfb540c202ba997a2f6f553a5031f1d389a3665da7af0558106fc1bf845b9383c7389949097d9a2dbd891229cefd57799da25ceb0c053c33832bb0cb
+  data.tar.gz: 1dd588e80b309f9673e1e9c0f968d6b53e0eb30fc38aa10d27516bf5ec4e2977eca3dd506c0378e81ed48724e003d0ffa6928168bfc0c3dd220ad01353f4ebc2

data/bin/trikle-mail

@@ -3,146 +3,60 @@ require 'commander'
 require 'mandrill'
 require 'csv'
 require 'mail'
+require 'triklemailer'
 
 class TrikleMail
   extend Commander::Methods
 
   program :name, 'Trikle Mail'
-  program :version, '0.0.0'
-  program :description, 'Send your bulk email in a trikle over the mandril api'
+  program :version, Triklemailer::VERSION
+  program :description, 'Send your bulk email from the cli in a trikle'
 
-  default_command :run
+  default_command :smtp
 
   command :smtp do |c|
-    c.syntax = 'trikle-mail smtp csv_of_emails.csv [options]'
+    c.syntax = 'trikle-mail csv_of_emails.csv [options]'
     c.description = 'Send a message to each email in the csv using the template'
     c.option '--host STRING', String, 'The host of the mail server e.g. <mail.gmail.com>'
     c.option '--port INTEGER', Integer, 'Port number of the mail server e.g. 587'
+    c.option '--domain STRING', String, 'Domain that emails are comming from'
     c.option '--username STRING', String, 'Username to authenticate with mail server'
     c.option '--password STRING', String, 'Password to authenticate with mail server'
     c.option '--from STRING', String, 'The email address to send the email from'
+    c.option '--bcc STRING', String, 'The email address to bcc each message to'
+    c.option '--subject STRING', String, 'The subject line of the message'
     c.option '--template STRING', String, 'The template to use to send the message'
+    c.option '--attachment STTRING', String, 'The relative file path to your attachement'
     c.option '--html', 'toggle using html to format email, defaults to no'
-    c.option '--subject STRING', String, 'The subject line of the message'
     c.option '--hours INTEGER', Integer, 'The number of hours over which to send the emails'
     c.option '--minutes INTEGER', Integer, 'The number of minutes over which to send the emails'
 
     c.action do |args, options|
-      title_row, *data_rows = CSV.read(args[0])
-
-      data_hashes = data_rows.map do |row|
-        title_row.map.with_index do |title, index|
-          [title.downcase.to_sym, row[index]]
-        end.to_h
-      end
-
-      options.default({hours: 0, minutes: 0, html: false})
-
-      time_range = ((options.hours * 60 * 60) + (options.minutes * 60)) /
-        data_hashes.length.to_f
-
-      data_hashes.each do |hash|
-
-        mail = Mail.new do
-          from hash.fetch(:from, options.from)
-          to hash.fetch(:to, hash.fetch(:email) { raise 'no email address found in to column!' })
-          subject hash.fetch(:subject, options.subject)
-
-          if options.html
-            html_part do
-              content_type 'text/html; charset=UTF-8'
-              body File.read(hash.fetch(:template, options.template)) % hash
-            end
-          else
-            text_part do
-              body File.read(hash.fetch(:template, options.template)) % hash
-            end
-          end
+      recipients = CSV.new(File.new(args[0]), headers: true, header_converters: :symbol).map(&:to_h)
+      sent_file_name = "./#{['sent', options.template.split('.').first].join('_')}.csv"
+      sent =
+        if File.exists?(sent_file_name)
+          CSV.new(File.new(sent_file_name), headers: true, header_converters: :symbol).map { |r| r[:email] }
+        else
+          []
         end
 
-        mail.delivery_method :smtp, {
-          address: hash.fetch(:host, options.host),
-          port: hash.fetch(:port, options.port),
-          user_name: hash.fetch(:username, options.username),
-          password: hash.fetch(:password, options.password),
-          authentication: :login,
-          enable_starttls_auto: true
-        }
-
-        puts mail.deliver!
-        random_wait_time = rand(0..time_range)
-        puts "waiting #{random_wait_time} seconds"
-        sleep(random_wait_time)
-      end
-    end
-  end
-
-  command :run do |c|
-    c.syntax = 'trikle-mail csv_of_emails.csv [options]'
-    c.description = 'Send a message to each email address in the csv'
-    c.option '--apikey STRING', String, 'The Mandrill API key'
-    c.option '--from_email STRING', String, 'The email address of the sender'
-    c.option '--from_name STRING', String, 'The name of the sender'
-    c.option '--subject STRING', String, 'The subject line of the message'
-    c.option '--template STRING', String, 'The template slug of the message template'
-    c.option '--subaccount STRING', String, 'The mandril subaccount for this batch of email'
-    c.option '--hours INTEGER', Integer, 'The number of hours over which to send the emails'
-    c.option '--minutes INTEGER', Integer, 'The number of minutes over which to send the emails'
-
-    c.action do |args, options|
-      api = Mandrill::API.new(options.apikey)  
-
-      title_row, *data_rows = CSV.read(args[0])
-
-      data_hashes = data_rows.map do |row|
-        title_row.map.with_index do |title, index|
-          [title.downcase, row[index]]
-        end.to_h
-      end
-
-      options.default({hours: 0, minutes: 0})
-      time_range = ((options.hours * 60 * 60) + (options.minutes * 60)) /
-        data_hashes.length.to_f
-
-      data_hashes.each do |hash|
-        response = api.messages.send_template(
-          hash['template'] || options.template,
-          [],
-          {
-            subaccount: hash['subaccount'] || options.subaccount,
-            subject: hash['subject'] || options.subject,
-            from_email: hash['from_email'] || options.from_email,
-            from_name: hash['from_name'] || options.from_name,
-            to: [{
-              email: hash['email'],
-              name: hash['name'],
-              type: 'to'
-            }],
-            merge_vars: [{
-              rcpt: hash['email'],
-              vars: hash.map { |key, value| { name: key, content: value } }
-            }]
-          }
-        )
-        TrikleMail.log(response)
-        random_wait_time = rand(0..time_range)
-        puts "waiting #{random_wait_time} seconds"
-        sleep(random_wait_time)
-      end
-    end
-  end
-
-  def self.log(json)
-    Array(json).each do |entry|
-      # write to log file
-      File.open('./log.json', 'a') { |f| f.write(JSON.dump(entry) + "\n") }
-      # write nicely to cli
-      puts [
-        entry['status'],
-        'email to',
-        entry['email'],
-        entry['reject_reason'] ? "becuase #{entry['reject_reason']}" : ''
-      ].join(' ')
+      mail_options = Triklemailer::Options.new(
+        template: File.read(options.template),
+        template_name: options.template,
+        is_html: options.template.end_with?('html'),
+        from: options.from,
+        bcc: options.bcc,
+        subject: options.subject,
+        port: options.port,
+        host: options.host,
+        username: options.username,
+        password: options.password,
+        domain: options.domain,
+        attachment: options.attachment
+      )
+
+      Triklemailer.send_mail(mail_options, recipients, sent)
     end
   end
 end

data/lib/triklemailer.rb

@@ -0,0 +1,109 @@
+require 'mail'
+require 'csv'
+
+module Triklemailer
+  VERSION = '0.0.9'
+  Options = Struct.new(
+    :template, :template_name, :is_html, :from, :subject,
+    :host, :port, :username, :password, :bcc, :domain,
+    :attachment,
+    keyword_init: true
+  )
+
+  # It should take:
+  # * A list of emails and data
+  # * SMTP account details
+  # * A template
+  # * SMTP Server details
+  # 
+  # and it should send an email to each email address from the csv using
+  # the template provided, filled in with the meta data provided for the
+  # email address. When each email is sent it should record that in a
+  # separate csv called sent_<template-name>.csv. Failures to send a
+  # messages should not be recorded. When sending emails it should check
+  # the sent_<template-name>.csv and if it exists, only send emails to 
+  # email address not included in the sent_<template-name>.csv file.
+  #
+  # Read provided csv
+  # Check for sent_ csv
+  # For each email, meta_data in provided csv
+  #   If email in sent_ csv
+  #     Next email
+  #
+  #   Read template file
+  #   Apply meta_data to template file
+  #   Send email with data from cli or meta data with template
+  #   If there was an error sending
+  #     Next email
+  #   Record email sent to template in sent_ csv
+  #
+  def self.send_mail(options, recipients, sent)
+    cleaned_template = options.template.gsub(/%(?!{)/, '%%')
+
+    recipients.
+      reject { |recipient| sent.include?(recipient[:email]) }.
+      each do |recipient|
+      mail = Mail.new do
+        from recipient.fetch(:from, options.from)
+        to recipient.fetch(:to, recipient.fetch(:email) {
+          raise "Some rows are missing either a 'to' or 'email' column."
+        })
+        bcc options.bcc if options.bcc
+        subject recipient.fetch(:subject, options.subject)
+
+        if options.is_html
+          html_part do
+            content_type 'text/html; charset=UTF-8'
+            body cleaned_template % recipient
+          end
+        else
+          text_part do
+            body cleaned_template % recipient
+          end
+        end
+
+        add_file(File.expand_path(options.attachment)) if options.attachment
+      end
+
+      if block_given?
+        yield(mail, recipient)
+      else
+        mail.delivery_method :smtp, {
+          address: recipient.fetch(:host, options.host),
+          port: recipient.fetch(:port, options.port),
+          user_name: recipient.fetch(:username, options.username),
+          password: recipient.fetch(:password, options.password),
+          authentication: :login,
+          enable_starttls_auto: true
+        }
+      end
+
+      begin
+        mail.deliver!
+        # might fail in here though...
+        log_sent(
+          recipient.fetch(:to, recipient[:email]),
+          options.template_name)
+      rescue => e
+        puts "Failed to send email to #{recipient[:email]}."
+        puts e.class
+        puts e
+        puts e.backtrace
+        next
+      end
+    end
+  end
+
+  def self.log_sent(email, template)
+    log_file_name = "./#{['sent', template.split('.').first].join('_')}.csv"
+
+    CSV.open(
+      log_file_name,
+      'a',
+      write_headers: !File.exists?(log_file_name),
+      headers: ['email', 'sent_at']
+    ) do |csv|
+      csv << [email, Time.now]
+    end
+  end
+end

metadata

@@ -1,11 +1,11 @@
 --- !ruby/object:Gem::Specification
 name: trikle-mail
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.9
 platform: ruby
 authors:
 - Jasper Lyons
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
 date: 2017-10-18 00:00:00.000000000 Z
@@ -38,6 +38,62 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: mail
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  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: Send bulk email in a trickle over mandrill
 email: jasper.lyons@gmail.com
 executables:
@@ -46,11 +102,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bin/trikle-mail
+- lib/triklemailer.rb
 homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -65,10 +122,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: Send a trickle of mail
 test_files: []
-has_rdoc: