ar_mailer_aws 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9adfef61dff172c54ea70efa899faf4aad601259
-  data.tar.gz: ae1a8d5225adfc1e9b405cf3cc43af0d5db2cf74
+  metadata.gz: 3dd90bd47a71a1620f476900cbe42fc21af4ab19
+  data.tar.gz: 3c607c4b6dc0c61ae76d1150dbd7c50607bb516a
 SHA512:
-  metadata.gz: bbc40383861fe35ca24d7e64449fa07182b2308cd1ea1f031a7f0c464ee52041a565008553449f06325b9d4ce99ed24787419137f96d852cc7c27f366ca71217
-  data.tar.gz: 2ab44794c4737b4cdce57dedcef9cd26e89306e7bcd1c63b7b72cc277fd935537a0a959ba0872bfef97d721d10785381b72819618522aaf9b5b3ad2530617271
+  metadata.gz: cc3555770509151eec235ef0ab845f595e5a762ca4d29646a0418dea2d2085e41709327051edb8c39df0267839e49040df55724e673c1f2b48a763f73e9fd57f
+  data.tar.gz: ffb2299d7e309349fc9a102213109d98fedfe5140c69a0f6f582f127fb004dd29a73b1ea25f1f949f39f86def4e78262bb4ac12ca619095cca18b5f083f1d9fb

data/.gitignore

@@ -19,4 +19,7 @@ tmp
 .idea
 .rvmrc
 .rspec
+.ruby-version
+.ruby-gemset
+unused
 TODO

data/CHANGELOG.md

@@ -0,0 +1,50 @@
+### 0.1.0
+
+* backwards incompatible changes
+  * added `send_attempts_count` column
+  * New configuration syntax:
+    ```ruby
+      # Your system wide Amazon config
+      AWS.config(
+          :access_key_id => 'YOUR_ACCESS_KEY_ID',
+          :secret_access_key => 'YOUR_SECRET_ACCESS_KEY'
+      )
+
+      ArMailerAWS.setup do |config|
+        # Current delivery method
+        config.client = :amazon_ses
+
+        # Delivery method client log i.e. smtp, amazon, mandrill
+        # config.client_logger = Logger.new('path/to/log/file')
+
+        # Configure your delivery method client
+        config.client_config = {
+            # Amazon SES config, system wide config will be used if not defined
+            # amazon_ses: {
+            #     access_key_id: 'YOUR_ACCESS_KEY_ID',
+            #     secret_access_key: 'YOUR_SECRET_ACCESS_KEY',
+            #     log_level: :debug
+            #     #region: 'eu-west-1',
+            # },
+
+            # Mandrill config
+            # mandrill: {
+            #     key: 'YOUR_MANDRILL_KEY'
+            # },
+
+            # Your smtp config, just like rails `smtp_settings`
+            # smtp: Rails.application.config.action_mailer.smtp_settings
+        }
+
+        # `ar_mailer_aws` logger i.e. mailer daemon
+        #config.logger = Logger.new('path/to/log/file')
+
+        # Error notification handler
+        #config.error_proc = lambda do |email, exception|
+        #  ExceptionNotifier.notify_exception(exception, data: {email: email.attributes})
+        #end
+
+        # batch email class
+        # email_class = 'BatchEmail'
+      end
+    ```

data/README.md

@@ -3,7 +3,7 @@
 [![Build Status](https://travis-ci.org/leschenko/ar_mailer_aws.png?branch=master)](https://travis-ci.org/leschenko/ar_mailer_aws)
 [![Dependency Status](https://gemnasium.com/leschenko/ar_mailer_aws.png)](https://gemnasium.com/leschenko/ar_mailer_aws)
 
-Daemon for sending butches of emails via Amazon Simple Email Service (Amazon SES) using ActiveRecord for storing messages.
+Daemon for sending batches of emails via SMTP, Amazon Simple Email Service (Amazon SES) or Mandrill using ActiveRecord for storing messages.
 ArMailerAWS handles daily quotas, maximum number of emails send per second (max send rate),
 batch email sending, expiring undelivered emails.
 
@@ -53,6 +53,7 @@ List available options:
 
     $ bundle exec ar_mailer_aws --help
 
+There are some configuration, see your generated `config/initializer/ar_mailer_aws.rb`
 
 ## Contributing
 

data/ar_mailer_aws.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Alex Leschenko']
   spec.email         = %w(leschenko.al@gmail.com)
   spec.description   = %q{Daemon for sending butches of emails via Amazon SES using ActiveRecord for storing messages. Handles daily quotas, max send rate.}
-  spec.summary       = %q{Send butches of emails via Amazon SES}
+  spec.summary       = %q{Send batches of emails via Amazon SES}
   spec.homepage       = 'https://github.com/leschenko/ar_mailer_aws'
   spec.license       = 'MIT'
 
@@ -19,9 +19,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = %w(lib)
 
   spec.add_dependency 'daemons', '~> 1.1.9'
-  spec.add_dependency 'aws-sdk', '~> 1.0'
   spec.add_dependency 'activesupport', '>= 3.0'
 
+  spec.add_development_dependency 'aws-sdk', '~> 1.0'
+  spec.add_development_dependency 'mandrill-api', '~> 1.0.49'
+  spec.add_development_dependency 'mail', '~> 2.5.4'
+
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rspec'

data/bin/ar_mailer_aws

@@ -22,7 +22,7 @@ unless name == 'rspec'
   end
 end
 
-options = ArMailerAWS.parse_options(ARGV)
+options = ArMailerAWS::OptionsParser.parse_options(ARGV)
 daemon_options = {}
 daemon_options.update(dir_mode: :normal, dir: options.pid_dir) if options.pid_dir
 
@@ -30,7 +30,7 @@ Daemons.run_proc(options.app_name || 'ar_mailer_aws', daemon_options) do
   # handle log files
   if defined? Rails
     ActiveRecord::Base.establish_connection
-    logger = ActiveSupport::BufferedLogger.new(Rails.root.join("log/#{Rails.env}.log"))
+    logger = Rails.logger.class.new(Rails.root.join("log/#{Rails.env}.log"))
     ActiveRecord::Base.logger = logger unless Rails.env.production?
     Rails.logger = ActionMailer::Base.logger = logger
   end
@@ -38,7 +38,7 @@ Daemons.run_proc(options.app_name || 'ar_mailer_aws', daemon_options) do
     ArMailerAWS.logger.reopen
     ArMailerAWS.logger.info 'Started daemon'
   end
-  AWS.config.logger.reopen if AWS.config.logger.respond_to?(:reopen)
+  ArMailerAWS.client_logger.reopen if ArMailerAWS.client_logger.respond_to?(:reopen)
 
   # run mailer
   ArMailerAWS.run(options)

data/lib/ar_mailer_aws.rb

@@ -1,5 +1,6 @@
 require 'ar_mailer_aws/version'
-require 'ar_mailer_aws/sender'
+require 'ar_mailer_aws/options_parser'
+require 'ar_mailer_aws/clients/base'
 require 'ar_mailer_aws/mailer'
 require 'ar_mailer_aws/railtie' if defined? Rails
 require 'active_support/core_ext'
@@ -10,9 +11,27 @@ module ArMailerAWS
   mattr_accessor :email_class
   @@email_class = 'BatchEmail'
 
+  # mailer client
+  mattr_accessor :client
+
+  # available clients
+  mattr_accessor :available_clients
+  @@available_clients = {
+      amazon_ses: 'ArMailerAWS::Clients::AmazonSES',
+      smtp: 'ArMailerAWS::Clients::SMTP',
+      mandrill: 'ArMailerAWS::Clients::Mandrill'
+  }
+
+  # mailer client credentials
+  mattr_accessor :client_config
+  @@client_config = {}
+
+  # mailer client logger
+  mattr_accessor :client_logger
+
+  # DEPRECATED
   # options to AWS::SimpleEmailService initializer
   mattr_accessor :ses_options
-  @@ses_options = {}
 
   # ar_mailer_aws logger
   mattr_accessor :logger
@@ -27,96 +46,25 @@ module ArMailerAWS
     end
 
     def run(options)
-      sender = Sender.new(options)
+      client_klass = find_client_klass
+      raise("Can not find client #{client}") unless client_klass
+      client_instance = client_klass.new(options)
       loop do
-        sender.send_batch
-        sleep sender.options.delay
+        client_instance.send_batch
+        sleep client_instance.options.delay
       end
     end
 
-    def parse_options(args)
-      start_i = args.index('--').try(:succ) || 0
-      args = args[start_i..-1]
-      options = OpenStruct.new
-
-      OptionParser.new do |opts|
-        options.batch_size = 100
-        options.delay = 180
-        options.quota = 10_000
-        options.rate = 5
-        options.max_age = 3600 * 24 * 7
-
-        opts.banner = <<-TXT.strip_heredoc
-          Usage: ar_mailer_aws <command> <options> -- <application options>
-
-          * where <command> is one of:
-            start         start an instance of the application
-            stop          stop all instances of the application
-            restart       stop all instances and restart them afterwards
-            reload        send a SIGHUP to all instances of the application
-            run           start the application and stay on top
-            zap           set the application to a stopped state
-            status        show status (PID) of application instances
-
-          * where <options> may contain several of the following:
-
-              -t, --ontop                      Stay on top (does not daemonize)
-              -f, --force                      Force operation
-              -n, --no_wait                    Do not wait for processes to stop
-
-          * and where <application options> may contain several of the following:
-
-        TXT
-
-        opts.on('-b', '--batch-size BATCH_SIZE', 'Maximum number of emails to send per delay',
-                "Default: #{options.batch_size}", Integer) do |batch_size|
-          options.batch_size = batch_size
-        end
-
-        opts.on('-d', '--delay DELAY', 'Delay between checks for new mail in the database',
-                "Default: #{options.delay}", Integer) do |delay|
-          options.delay = delay
-        end
-
-        opts.on('-q', '--quota QUOTA', 'Daily quota for sending emails', "Default: #{options.quota}", Integer) do |quota|
-          options.quota = quota
+    def find_client_klass
+      if client
+        if client.is_a?(Symbol)
+          available_clients[client].try(:constantize)
+        elsif client.is_a?(Class)
+          client
         end
-
-        opts.on('-r', '--rate RATE', 'Maximum number of emails send per second',
-                "Default: #{options.rate}", Integer) do |rate|
-          options.rate = rate
-        end
-
-        opts.on('-m', '--max-age MAX_AGE',
-                'Maxmimum age for an email. After this',
-                'it will be removed from the queue.',
-                'Set to 0 to disable queue cleanup.',
-                "Default: #{options.max_age} seconds", Integer) do |max_age|
-          options.max_age = max_age
-        end
-
-        opts.on('-p', '--pid-dir DIRECTORY', 'Directory for storing pid file',
-                'Default: Stored in current directory (named `ar_mailer_aws.pid`)') do |pid_dir|
-          options.pid_dir = pid_dir
-        end
-
-        opts.on('--app-name APP_NAME', 'Name for the daemon app',
-                'Default: ar_mailer_aws') do |app_name|
-          options.app_name = app_name
-        end
-
-        opts.on('-v', '--[no-]verbose', 'Run verbosely') do |v|
-          options.verbose = v
-        end
-
-        opts.on_tail('-h', '--help', 'Show this message') do
-          puts opts
-          exit
-        end
-
-      end.parse!(args)
-
-      options
+      else
+        available_clients[client_config.keys.first].try(:constantize)
+      end
     end
 
   end

data/lib/ar_mailer_aws/clients/amazon_ses.rb

@@ -0,0 +1,49 @@
+# too early require aws-sdk breaks mailer, need to be required by rails app
+#require 'aws-sdk'
+
+module ArMailerAWS
+  module Clients
+    class AmazonSES < Base
+
+      def initialize(options={})
+        super
+        if ArMailerAWS.client_config[:amazon_ses].blank? && ArMailerAWS.client == :amazon_ses
+          ArMailerAWS.client_config[:amazon_ses] = AWS.config.to_h
+        end
+        if ArMailerAWS.ses_options && settings.blank?
+          ActiveSupport::Deprecation.warn('`ArMailerAWS.ses_options` is deprecated, use `ArMailerAWS.client_config[:amazon_ses]` instead')
+          @settings = ArMailerAWS.client_config[:amazon_ses] = ArMailerAWS.ses_options
+        end
+        @service = AWS::SimpleEmailService.new settings
+      end
+
+      def send_emails(emails)
+        emails.each do |email|
+          return if exceed_quota?
+          begin
+            check_rate
+            send_email(email)
+          rescue => e
+            handle_email_error(e, email)
+          end
+        end
+      end
+
+      def send_email(email)
+        log "send email to #{email.to}"
+        @service.send_raw_email email.mail, from: email.from, to: email.to
+        email.destroy
+        @sent_count += 1
+      end
+
+      def sent_last_24_hours
+        @sent_last_24_hours ||= begin
+          count = @service.quotas[:sent_last_24_hours]
+          log "#{count} emails sent last 24 hours"
+          count
+        end
+      end
+
+    end
+  end
+end

data/lib/ar_mailer_aws/clients/base.rb

@@ -0,0 +1,117 @@
+module ArMailerAWS
+  module Clients
+
+    autoload :SMTP, 'ar_mailer_aws/clients/smtp'
+    autoload :AmazonSES, 'ar_mailer_aws/clients/amazon_ses'
+    autoload :Mandrill, 'ar_mailer_aws/clients/mandrill'
+
+    class Base
+      attr_reader :options, :model, :service
+
+      def initialize(options={})
+        @options = options.is_a?(Hash) ? OpenStruct.new(options) : options
+        @model = ArMailerAWS.email_class.constantize
+        @day = Date.today
+        @sent_count = 0
+        @sent_per_second = 0
+      end
+
+      def settings
+        @settings ||= begin
+          config_key = self.class.name.split('::').last.underscore.to_sym
+          ArMailerAWS.client_config[config_key] or raise("Provide setting via `ArMailerAWS.client_config[:#{config_key}]`")
+        end
+      end
+
+      def send_batch
+        cleanup
+        emails = find_emails
+        log "found #{emails.length} emails to deliver"
+        send_emails(emails) unless emails.empty?
+      end
+
+      def send_emails(emails)
+        raise NotImplementedError
+      end
+
+      def find_emails
+        @model.where('last_send_attempt_at IS NULL OR last_send_attempt_at < ?', Time.now - 300).limit(options.batch_size)
+      end
+
+      def cleanup
+        max_age = options.max_age.to_i
+        max_attempts = options.max_attempts.to_i
+        return if max_age.zero? && max_attempts.zero?
+
+        scope = @model
+        scope = scope.where('last_send_attempt_at IS NOT NULL AND created_at < ?', Time.now - max_age) unless max_age.zero?
+        scope = scope.where('send_attempts_count > ?', max_attempts) unless max_attempts.zero?
+
+        log "expired #{scope.destroy_all.length} emails"
+      end
+
+      private
+
+      def check_rate
+        if @sent_per_second == options.rate
+          sleep 1
+          @sent_per_second = 0
+        else
+          @sent_per_second += 1
+        end
+      end
+
+      def handle_email_error(e, email, options={})
+        log "ERROR sending email #{email.id} - #{email.inspect}: #{e.message}\n   #{e.backtrace.join("\n   ")}", :error
+        ArMailerAWS.error_proc.call(email, e) if ArMailerAWS.error_proc
+        email.increment!(:send_attempts_count) if options[:email_error]
+        email.update_column(:last_send_attempt_at, Time.now)
+      end
+
+      def exceed_quota?
+        return false unless options.quota
+        if @day == Date.today
+          is_exceed_quota = options.quota <= @sent_count + sent_last_24_hours
+          log("exceed daily quota in #{@quota}, sent #{@sent_count} (total #{@sent_last_24_hours})") if is_exceed_quota
+          is_exceed_quota
+        else
+          @sent_count = 0
+          @sent_last_24_hours = nil
+          false
+        end
+      end
+
+      def sent_last_24_hours
+        0
+      end
+
+      def log(msg, level=:info)
+        formatted_msg = "[#{Time.now}] batch_mailer: #{msg}"
+        puts formatted_msg if options.verbose
+        if logger
+          logger.send(level, msg)
+        elsif options.verbose && Object.const_defined?('Rails')
+          Rails.logger.send(level, formatted_msg)
+        end
+      end
+
+      def logger
+        ArMailerAWS.logger
+      end
+
+      def client_log(msg, level=:info)
+        formatted_msg = "[#{Time.now}] batch_mailer_client: #{msg}"
+        puts formatted_msg if options.verbose
+        if client_logger
+          client_logger.send(level, msg)
+        elsif options.verbose && Object.const_defined?('Rails')
+          Rails.logger.send(level, formatted_msg)
+        end
+      end
+
+      def client_logger
+        ArMailerAWS.client_logger
+      end
+    end
+  end
+end