idlemailer 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8d819328c9078fad1d2b23bb0e41f82ea045a6ed
-  data.tar.gz: 69e86a4d70cd73d3b111a6453b1ea99417404310
+  metadata.gz: 347bc7e19b8427031ed9246730a710ca7ad8893f
+  data.tar.gz: 4e44c6a7525787ab0576655f863fa31b5d1359ff
 SHA512:
-  metadata.gz: 097584f74932d8ffd5a20bf50e461615db4620add820db67a80ad9c3c37bd26fb9bc0c9b669cb521f09e7ea8077ed6b4949e9c76c3b9b9961ecc58123d2c1d7a
-  data.tar.gz: 35786b42c65c99b839bdee043439acfda4a92e5d58388fa31b8dd234b715a9278587419e04490886702ac076fee6402f6cac0d4b7bcdcc5d21368944a7e31ba8
+  metadata.gz: 707144b2594688f8b838dc2eb3aa35f553c2f9bc188a0be8f6f812ccc7e801005a1068691ca8cf54d699564037e4a5fe0bb0f8e4c491425915dedc3e2ae8ef28
+  data.tar.gz: a349486802b1245cf60dd885b85dfbbb74ea266ee077a0ff0f1b366d864fb2004fd7718ecac63d674ce2bf667d8c2f64dced20935c78aae4f9371fd8a1f931e2

data/README.md

@@ -1,6 +1,6 @@
 # IdleMailer
 
-A lightweight alternative to ActionMailer for hipsters who use Ruby but not Rails. Powered by [mail](http://www.rubydoc.info/gems/mail). Great for API-only backends that need to send email.
+A lightweight (~100 line) alternative to ActionMailer for hipsters who use Ruby but not Rails. Powered by [mail](http://www.rubydoc.info/gems/mail). Great for API-only backends that need to send email.
 
 ## Installation
 
@@ -11,68 +11,81 @@ A lightweight alternative to ActionMailer for hipsters who use Ruby but not Rail
 
 IdleMailer is all about providing mailer classes and templates. But [the mail gem](http://www.rubydoc.info/gems/mail) has a great API, so you have unfettered access to it in your mailers through the "mail" object.
 
-    # Define your mailer class
-    class WidgetMailer
-      include IdleMailer::Mailer
+```ruby
+# Define your mailer class
+class WidgetMailer
+  include IdleMailer::Mailer
 
-      def initialize(user, widget)
-        mail.to = user.email
-        mail.subject = "Widget #{widget.sku}"
-        @widget = widget
-      end
-    end
+  def initialize(user, widget)
+    mail.to = user.email
+    mail.subject = "Widget #{widget.sku}"
+    @widget = widget
+  end
+end
 
-    # Create widget.html.erb and/or widget.text.erb templates.
-    # They'll have access to instance variables like @widget above.
+# Create widget.html.erb and/or widget.text.erb templates.
+# They'll have access to instance variables like @widget above.
 
-    # Send your mail
-    mailer = WidgetMailer.new(current_user, widget)
-    mailer.deliver
+# Send your mail
+mailer = WidgetMailer.new(current_user, widget)
+mailer.deliver
+```
 
 ## Configure
 
 These are the default options. Salt to taste.
 
-    IdleMailer.config do |config|
-      # Directory containing the mailer templates
-      config.templates = Pathname.new(Dir.getwd).join('templates')
-
-      # Name of the layout template. Here, the file(s) would be named
-      # mailer_layout.html.erb and/or mailer_layout.text.erb.
-      config.layout = 'mailer_layout'
-
-      # Email delivery method (mail gem). Set to :test when testing or when developing locally
-      config.delivery_method = :smtp
-
-      # Delivery options (mail gem)
-      config.delivery_options = {
-        user_name: ENV['MAIL_USER'],
-        password: ENV['MAIL_PASSWORD'],
-        domain: ENV['MAIL_DOMAIN'],
-        address: ENV['MAIL_ADDRESS'],
-        port: ENV['MAIL_PORT'] || 587,
-        authentication: ENV['MAIL_AUTHENTICATION'] || 'plain',
-        enable_starttls_auto: (ENV['MAIL_TLS'] ? true : false)
-      }
-
-      # Default "from" address for all mailers
-      config.default_from = nil
-
-      # Write all deliveries to $stdout
-      config.log = false
-    end
+```ruby
+IdleMailer.config do |config|
+  # Directory containing the mailer templates
+  config.templates = Pathname.new(Dir.getwd).join('templates')
+
+  # Name of the layout template. Here, the file(s) would be named
+  # mailer_layout.html.erb and/or mailer_layout.text.erb.
+  config.layout = 'mailer_layout'
+
+  # Email delivery method (mail gem). Set to :test when testing or when developing locally
+  config.delivery_method = :smtp
+
+  # Delivery options (mail gem)
+  config.delivery_options = {
+    user_name: ENV['MAIL_USER'],
+    password: ENV['MAIL_PASSWORD'],
+    domain: ENV['MAIL_DOMAIN'],
+    address: ENV['MAIL_ADDRESS'],
+    port: ENV['MAIL_PORT'] || 587,
+    authentication: ENV['MAIL_AUTHENTICATION'] || 'plain',
+    enable_starttls_auto: (ENV['MAIL_TLS'] ? true : false)
+  }
+
+  # Default "from" address for all mailers
+  config.default_from = nil
+
+  # Log sent emails (require 'logger')
+  # config.logger = Logger.new($stdout)
+  # config.logger = Logger.new('log/mailers.log')
+  config.logger = nil
+
+  # Write full message body to log (if enabled). Otherwise, only message headers are logged.
+  config.log_body = false
+end
+```
 
 ## Testing
 
 Put the mailer in testing mode:
 
-    IdleMailer.config do |config|
-      config.delivery_method = :test
-    end
+```ruby
+IdleMailer.config do |config|
+  config.delivery_method = :test
+end
+```
 
 Then use mail gem's built in testing helpers in your specs:
 
-    sent = Mail::TestMailer.deliveries.any? { |mail| mail.to.include? @user.email }
+```ruby
+sent = Mail::TestMailer.deliveries.any? { |mail| mail.to.include? @user.email }
+```
 
 ## License
 

data/lib/idlemailer/config.rb

@@ -5,8 +5,9 @@ module IdleMailer
   #   delivery_method Symbol like :smtp or :test (see the mail gem for all options)
   #   delivery_options Hash of delivery options (see the mail gem for all options)
   #   default_from Default "from" address if it's left blank
-  #   log When true, writes delivered messages to $stdout (default false)
-  Config = Struct.new(:templates, :layout, :delivery_method, :delivery_options, :default_from, :log)
+  #   logger a Logger object for logging email
+  #   log_body if true, the entire message body will be logged (instead of just the headers) (default false)
+  Config = Struct.new(:templates, :layout, :delivery_method, :delivery_options, :default_from, :logger, :log_body)
   @config = Config.new
 
   # Takes a block and hands it an IdleMailer::Config object

data/lib/idlemailer/defaults.rb

@@ -12,5 +12,6 @@ IdleMailer.config do |config|
     enable_starttls_auto: (ENV['MAIL_TLS'] ? true : false)
   }
   config.default_from = nil
-  config.log = false
+  config.logger = nil
+  config.log_body = false
 end

data/lib/idlemailer/message.rb

@@ -8,13 +8,11 @@ module IdleMailer
 
     # Initialize a new message
     def initialize(mail, mailer)
-      @mail = mail
-      @mailer = mailer
+      @mail, @mailer = mail, mailer
     end
 
     # Deliver mail
     def deliver!
-      mail.from IdleMailer.config.default_from if mail.from.nil?
       if has_template? 'html'
         html_body = layout('html') { body('html') }
         mail.html_part do
@@ -26,9 +24,11 @@ module IdleMailer
         text_body = layout('text') { body('text') }
         mail.text_part { body text_body }
       end
-      mail.delivery_method IdleMailer.config.delivery_method, IdleMailer.config.delivery_options
+      config = IdleMailer.config
+      mail.from config.default_from if mail.from.nil?
+      mail.delivery_method config.delivery_method, config.delivery_options
       message = mail.deliver
-      $stdout.puts message if IdleMailer.config.log
+      config.logger.info(config.log_body ? message.to_s : message) if config.logger
       message
     end
 
@@ -55,7 +55,11 @@ module IdleMailer
     end
 
     def template_name
-      @name ||= mailer.class.name.sub(/Mailer$/, '').gsub(/([a-z])([A-Z])/, "\\1_\\2").downcase
+      @name ||= mailer.class.name.
+        gsub(/::/, File::SEPARATOR).
+        sub(/Mailer$/, '').
+        gsub(/([a-z])([A-Z])/, "\\1_\\2").
+        downcase
     end
 
     def template_path(name, type)

data/lib/idlemailer/version.rb

@@ -1,5 +1,5 @@
 # IdleMailer module
 module IdleMailer
   # Version number
-  VERSION = '0.0.3'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: idlemailer
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-11 00:00:00.000000000 Z
+date: 2017-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mail
@@ -58,8 +58,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: A lightweight alternative to ActionMailer
 test_files: []
+has_rdoc: