Sidekiq::RedmineMailer (develop state but it works)

(important add to development environment config.action_mailer.perform_deliveries = true)

Redmine Integration

Rewrites sidekiq_mailer version "0.0.8" for redmine integration

Adds the ability convert args of methods to easy objects before write to queue and back after read from guegue but before send to method

If filter for converting does not exist mailer will skip sidekiq

Example Redmine Plugin Example

ActionDispatch::Callbacks.to_prepare do
  Mailer.send(:include, Sidekiq::RedmineMailer)
  
  #before write to queue convert to easy objects
  class Sidekiq::RedmineMailer::BeforeFilter::Mailer
    def issue_add(args)
      #args - array of method args 
      args.map{|a| a.is_a?(Array) ? (a.map(&:id))  : (a.id)}
    end

    def document_added(args)
      [args.first.id, User.current.id]
    end
  end
  #before send to method convert easy objects from queue to back 
  class Sidekiq::RedmineMailer::AfterFilter::Mailer
    def issue_add(params)
      #sleep 1
      i = 0
      issue_ = nil
      issue_id, to_users, cc_users = *params
      while issue_.nil? and i < 10
        (sleep 0.3) if i > 0
        i += 1
        issue_ = Issue.find_by_id(issue_id)
      end

      to_users_ = to_users.map{|user_id| User.find_by_id(user_id)}
      cc_users_ = cc_users.map{|user_id| User.find_by_id(user_id)}
      params_ = []
      params_ << issue_
      params_ << to_users_
      params_ << cc_users_
      params_
    end

    def document_added(params)
      document_id, user_current_id = *params
      document = Document.find_by_id(document_id)
      User.current = User.find_by_id(user_current_id)

      params = []
      params << document
    end
  end

  
end

#You cane override method use_sidekiq_mailer?
#this method turn on/off Sidekiq::RedmineMailer 
class Sidekiq::RedmineMailer::UseSidekiqMailer
  def use_sidekiq_mailer?
    true #true/false  defaulte true
  end
end

Sidekiq::RedmineMailer adds to your ActionMailer classes the ability to send mails asynchronously.

Usage

If you want to make a specific mailer to work asynchronously just include Sidekiq::RedmineMailer module:

class MyMailer < ActionMailer::Base
  include Sidekiq::RedmineMailer

  def welcome(to)
    ...
  end
end

class Sidekiq::RedmineMailer::BeforeFilter::MyMailer
  def welcome(args)
    return args
  end

end
#before send to method convert easy objects from queue to back 
class Sidekiq::RedmineMailer::AfterFilter::MyMailer
  def welcome(params)
    return params
  end
end

Now every deliver you make with MyMailer will be asynchronous.

# Queues the mail to be sent asynchronously by sidekiq
MyMailer.welcome('your@email.com').deliver

The default queue used by Sidekiq::RedmineMailer is 'mailer'. So, in order to send mails with sidekiq you need to start a worker using:

sidekiq -q mailer

If you want to skip sidekiq you should use the 'deliver!' method:

# Mail will skip sidekiq and will be sent synchronously
MyMailer.welcome('your@email.com').deliver!

By default Sidekiq::RedmineMailer will retry to send an email if it failed. But you can override sidekiq options in your mailer.

Installation

Add this line to your application's Gemfile:

gem "sidekiq_redmine_mailer", :git => "https://github.com/AlexeyAlexey/sidekiq_redmine_mailer"

And then execute:

$ bundle

Testing

rake test TEST=test/test_redmine_sidekiq_mailer.rb rake test TEST=test/test_redmine_sidekiq_mailer_redmine.rb

Delayed e-mails is an awesome thing in production environments, but for e-mail specs/tests in testing environments it can be a mess causing specs/tests to fail because the e-mail haven't been sent directly

Contributing

1. Fork it
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Added some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request