ar_mailer_revised 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0aef767abd393af9428a1bbea305cd024d6cf994
-  data.tar.gz: 4011b3fa47058260ebdeb930c6c2c49ba9396539
+  metadata.gz: 0b1e7179059d80144067968beac5f41151eda097
+  data.tar.gz: 42554e87ed8bfb15baef54d94a7c0e28e0c7b515
 SHA512:
-  metadata.gz: f7f9318aa6523598867b1d62c968d8d3fdc49ecd3842a0922c5525b7a0a87539f2a5c85c95a5048bd4858f8ed8d0687c3eb3a22aadfb58e66f863ce406d5548f
-  data.tar.gz: 3b51d939495ce060b28aae0fac4df7df49eeec32374d881ce67533badc69d41b6edee65260062f526cd2db53e70b35e0f34d1bb730d4308ab9c285824ad05def
+  metadata.gz: 0cb4f0f7c22ebf0e85ff61ded487ac20acf38036e0b8f45dd074923f153aeda836e416af01d73fa14263fe9f2203f76e7b8a653d938e8408f2d670899ccd2d2e
+  data.tar.gz: 827bb354ebb58010182591543be6ee60774146de9e5b9f5eda8649f39daf44d6c309c2cd986b3bb7a73e7e9812ce4b133099507b4b6b3613d6b4d0d846f966db

data/README.md

@@ -1,9 +1,10 @@
 # ArMailerRevised
 
+[![Gem Version](https://badge.fury.io/rb/ar_mailer_revised.svg)](http://badge.fury.io/rb/ar_mailer_revised)
 [![Code Climate](https://codeclimate.com/github/Stex/ar_mailer_revised.png)](https://codeclimate.com/github/Stex/ar_mailer_revised)
-![Travis CI](https://travis-ci.org/Stex/ar_mailer_revised.svg?branch=rails_4)
+[![Build Status](https://travis-ci.org/Stex/ar_mailer_revised.svg?branch=rails_4)](https://travis-ci.org/Stex/ar_mailer_revised)
 
-[ArMailer](https://github.com/seattlerb/ar_mailer) was a great gem which allows you to store emails in your application's database and batch deliver
+[ArMailer](https://github.com/seattlerb/ar_mailer) is a great gem which allows you to store emails in your application's database and batch deliver
 them later using a background task.
 
 However, it was not compatible with newer versions of Rails and also lacking some of the functionality I needed in my applications.
@@ -57,11 +58,15 @@ add them to the migration before migrating.
 First of all, you have to set ActionMailer to use the gem's delivery method.
 This can be done per environment or globally for the application using either
 
-    config.action_mailer.delivery_method = :activerecord
+```ruby
+config.action_mailer.delivery_method = :activerecord
+```
 
 or - not inside a configuration file
 
-    ActionMailer::Base.delivery_method = :activerecord
+```ruby
+ActionMailer::Base.delivery_method = :activerecord
+```
     
 ### SMTP-Settings
 
@@ -88,13 +93,15 @@ ArMailerRevised uses the normal ActionMailer::Base templates, so you can write
 deliver-methods like you would for direct email sending.
 On delivering, the email will be stored in the database and not being sent diretly.
 
-    class TestMailer < ActionMailer::Base
-      default from: 'from@example.com'
-    
-      def basic_email
-        mail(to: 'basic_email@example.com', subject: 'Basic Email Subject', body: 'Basic Email Body')
-      end
-    end
+```ruby
+class TestMailer < ActionMailer::Base
+  default from: 'from@example.com'
+
+  def basic_email
+    mail(to: 'basic_email@example.com', subject: 'Basic Email Subject', body: 'Basic Email Body')
+  end
+end
+```
     
 ### Setting a custom delivery time
 
@@ -103,10 +110,12 @@ the resulting email record. One of them is +ar_mailer_delivery_time+.
 This method sets a time which determines the earliest sending time for this email, 
 in other words: If you set this time, the email won't be sent prior to it.
 
-    def delayed_email
-      ar_mailer_delivery_time Time.now + 2.hours
-      mail(to: 'delayed_email@example.com', subject: 'Delayed Email Subject', :body => 'Delayed Email Body')
-    end
+```ruby
+def delayed_email
+  ar_mailer_delivery_time Time.now + 2.hours
+  mail(to: 'delayed_email@example.com', subject: 'Delayed Email Subject', :body => 'Delayed Email Body')
+end
+```
     
 **Important**: It may happen that the Rails logging output of the generated mail may still contain
 custom attributes (like the delivery time) in its header. This happens because ActionMailer will
@@ -117,19 +126,21 @@ log the email before actually delivering it. The generated email will **not** co
 It is possible to set own SMTP settings for each email in the system which will then be used for delivery.
 These settings may contain everything the global settings do (see above).
 
-    def custom_smtp_email
-      ar_mailer_smtp_settings({
-        :address   => 'localhost',
-        :port      => 25,
-        :domain    => 'localhost.localdomain',
-        :user_name => 'some.user',
-        :password  => 'some.password',
-        :authentication => :plain,
-        :enable_starttls_auto => true
-      })
-        
-      mail(to: 'custom_smtp_email@example.com', subject: 'Custom SMTP Email Subject', :body => 'Custom SMTP Email Body')
-    end
+```ruby
+def custom_smtp_email
+  ar_mailer_smtp_settings({
+    :address   => 'localhost',
+    :port      => 25,
+    :domain    => 'localhost.localdomain',
+    :user_name => 'some.user',
+    :password  => 'some.password',
+    :authentication => :plain,
+    :enable_starttls_auto => true
+  })
+    
+  mail(to: 'custom_smtp_email@example.com', subject: 'Custom SMTP Email Subject', :body => 'Custom SMTP Email Body')
+end
+```
 
 **Important**: As the mailer has to use the password to connect to the SMTP server, it is stored in the database in plain text!
 If this means a security issue to you, please use only the global settings which are loaded from the environment and not stored in the database.
@@ -145,10 +156,12 @@ You can add custom attributes to the email table simply by altering the generate
     
 In the email delivering method, these attributes may then be filled with the actual data using the `ar_mailer_attribute` helper method:
 
-    def custom_attribute_email
-      ar_mailer_attribute :a_number, 42
-      mail(to: 'custom_attribute_email@example.com', subject: 'Custom Attribute Email Subject', :body => 'Custom Attribute Email Body')
-    end
+```ruby
+def custom_attribute_email
+  ar_mailer_attribute :a_number, 42
+  mail(to: 'custom_attribute_email@example.com', subject: 'Custom Attribute Email Subject', :body => 'Custom Attribute Email Body')
+end
+```
     
 ### Sending Emails
 
@@ -158,9 +171,17 @@ be accessed from the application's root directory.
 It accepts the argument `-h` (or `--help`), showing all available options.
 If you call it without options, it will run a single batch sending in the foreground and exist afterwards.
 
-There will be daemon functionality in the future (mostly to avoid loading the application envirionment
+There will be daemon functionality in the future (mostly to avoid loading the application environment
 every single time emails are being sent), for now I suggest using a gem like [whenever](https://github.com/javan/whenever)
 to run the executable every X minutes.
+
+An entry in whenever's `schedule.rb` might look like this:
+
+```ruby
+every 5.minutes do
+ command "cd #{path} && bundle exec ar_sendmail -c #{path} -e production -b 25 --log-file './log/ar_mailer.log' --log-level info"
+end
+```
     
 ### SMTP settings for common providers (to be extended)
 

data/lib/ar_mailer_revised/email_scaffold.rb

@@ -23,7 +23,7 @@ module ArMailerRevised
 
       #Applies a +limit+ to the finder if batch_size is set
       scope :with_batch_size, lambda { |batch_size|
-        batch_size ? {:limit => batch_size} : {}
+        limit(batch_size) if batch_size
       }
     end
 

data/lib/ar_mailer_revised/mailman.rb

@@ -240,6 +240,10 @@ module ArMailerRevised
       end
     end
 
+    #----------------------------------------------------------------
+    #                    Email Record Alteration
+    #----------------------------------------------------------------
+
     #
     # Adjusts the last send attempt timestamp in the given
     # email to the current time.

data/lib/ar_mailer_revised/version.rb

@@ -1,3 +1,3 @@
 module ArMailerRevised
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ar_mailer_revised
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Stefan Exner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-29 00:00:00.000000000 Z
+date: 2014-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler