sidekiq_mailer 0.0.3 → 0.0.4

data/README.md

@@ -1,6 +1,34 @@
 # Sidekiq::Mailer
 
-TODO: Write a gem description
+Sidekiq::Mailer adds to your ActionMailer classes the ability to send mails asyncronously.
+
+## Usage
+
+If you want to make a specific mailer to work asyncronously just include Sikekiq::Mailer module:
+
+    class MyMailer < ActionMailer::Base
+      include Sidekiq::Mailer
+
+      def welcome(to)
+        ...
+      end
+    end
+
+Now every deliver you make with MyMailer will be asyncronous.
+
+    # Queues the mail to be sent asyncronously by sidekiq
+    MyMailer.welcome('your@email.com').deliver
+
+The default queue used by Sidekiq::Mailer 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 syncronously
+    MyMailer.welcome('your@email.com').deliver!
+
+By default Sidekiq::Mailer will retry to send an email if it failed. But you can [override sidekiq options](https://github.com/andersondias/sidekiq_mailer/wiki/Overriding-sidekiq-options) in your mailer.
 
 ## Installation
 
@@ -16,9 +44,12 @@ Or install it yourself as:
 
     $ gem install sidekiq_mailer
 
-## Usage
+## Testing
+
+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. Therefore you can configure what environments that should be excluded like so:
 
-TODO: Write usage instructions here
+    # config/initializers/sidekiq_mailer.rb
+    Sidekiq::Mailer.excluded_environments = [:test, :cucumber]
 
 ## Contributing
 

data/lib/sidekiq_mailer.rb

@@ -35,7 +35,7 @@ module Sidekiq
         self.sidekiq_options_hash = get_sidekiq_options.merge(stringify_keys(opts || {}))
       end
 
-      DEFAULT_OPTIONS = { 'retry' => false, 'queue' => 'mailer' }
+      DEFAULT_OPTIONS = { 'retry' => true, 'queue' => 'mailer' }
 
       def get_sidekiq_options # :nodoc:
         self.sidekiq_options_hash ||= DEFAULT_OPTIONS

data/lib/sidekiq_mailer/version.rb

@@ -1,5 +1,5 @@
 module Sidekiq
   module Mailer
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/test/sidekiq_mailer_test.rb

@@ -45,6 +45,12 @@ class SidekiqMailerTest < Test::Unit::TestCase
     assert_equal 'mailer', Sidekiq::Mailer::Worker.jobs.first['queue']
   end
 
+  def test_default_sidekiq_options
+    BasicMailer.welcome('test@test.com').deliver
+    assert_equal 'mailer', Sidekiq::Mailer::Worker.jobs.first['queue']
+    assert_equal true, Sidekiq::Mailer::Worker.jobs.first['retry']
+  end
+
   def test_enables_sidekiq_options_overriding
     MailerInAnotherQueue.bye('test@test.com').deliver
     assert_equal 'priority', Sidekiq::Mailer::Worker.jobs.first['queue']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sidekiq_mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors: