dcidev_mailer 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3a094879390e6716b70f8229366ba24f1a84c0b1aac5f7565035258326ce071f
-  data.tar.gz: bece3752e7a948a9ad67e1687d8b06be4ac5e54eb90859e6eb802280c14e18b3
+  metadata.gz: a4c888484deeed90b4688c4b671c3dcce1c0cd2e6c8246ef60a7779cfb73bd9f
+  data.tar.gz: 4d90779c9e75604a863487d060db02b8170de0cbdd2785e61478d4b3c20cf0e9
 SHA512:
-  metadata.gz: 707e59fb856b39ee66f8081998167e7df4e2e5307416e8fb3e0c41c5c480334e475639a3c5965e3031997edffb5fb7b6eab005e89891912c14f4918f58290f6c
-  data.tar.gz: edbefefe835b479c602dc4538200fa3ef52246ecd081586ae77bae98ed861c28f53e53ca3e932421c50fe33471e4ae355dc6345f886cd2c7da182899b1164536
+  metadata.gz: 9eca49e59d46f4bb88c6870c3bcd5bb468d6c8ce44c3f346dfbfc29cada557840fb8f3f7af5f65478ee38cda297063e9725b298b7aef423dc37e342870ec9b5a
+  data.tar.gz: 53a043bb683096d6f2d992d49da00c636beb7548753fe3676bbd71a81dea5830f8284e8677657c128a47d7754768f7650d4de2ecc1124f9260f35096ef32bbd4

data/README.md

@@ -1,40 +1,149 @@
+# Tldr
+This gem uses both Mandrill API and ActionMailer to send email.
 
-ENV : 
-```
-DEFAULT_EMAIL_SENDER 
-USE_MANDRILL_MAILER 
-[EMAIL_PROVIDER]_SMTP_ADDRESS
- [EMAIL_PROVIDER]_SMTP_DOMAIN 
- [EMAIL_PROVIDER]_SMTP_PASSWORD 
- [EMAIL_PROVIDER]_SMTP_USERNAME 
- [EMAIL_PROVIDER]_SMTP_PORT 
- [EMAIL_PROVIDER]_SMTP_AUTO_TLS 
- [EMAIL_PROVIDER]_SMTP_TLS
+# Setup
+
+Add this to your `.env`
+```env
+BASE_URL_FE=
+DEFAULT_EMAIL_SENDER= 
+USE_MANDRILL_MAILER= 
+MANDRILL_SMTP_ADDRESS=
+MANDRILL_SMTP_DOMAIN= 
+MANDRILL_SMTP_PASSWORD= 
+MANDRILL_SMTP_USERNAME= 
+MANDRILL_SMTP_PORT= 
+MANDRILL_SMTP_AUTO_TLS= 
+MANDRILL_SMTP_TLS=
+
+MAILER_SMTP_ADDRESS=
+MAILER_SMTP_DOMAIN= 
+MAILER_SMTP_PASSWORD= 
+MAILER_SMTP_USERNAME= 
+MAILER_SMTP_PORT= 
+MAILER_SMTP_AUTO_TLS= 
+MAILER_SMTP_TLS=
  ```
- 
- mandril 
 
+Add this to `config/initializer/mailer.rb`
+```ruby
+ActionMailer::Base.delivery_method = :smtp  
+
+# change it to your helper class name
+ActionMailer::Base.add_delivery_method :mandrill_mailer, MandrillMailer  
+  
+# uncomment if neccessary
+smtp_settings = {  
+  address: ENV["USE_MANDRILL_MAILER"].to_i == 1 ?  ENV['MANDRILL_SMTP_ADDRESS'] : ENV["MAILER_SMTP_ADDRESS"],  
+  # authentication: ENV["USE_MANDRILL_MAILER"].to_i == 1 ? 'plain' : nil,  
+  domain:  ENV["USE_MANDRILL_MAILER"].to_i == 1 ?  ENV['MANDRILL_SMTP_DOMAIN'] : ENV["MAILER_SMTP_DOMAIN"],  
+  enable_starttls_auto:  ENV["USE_MANDRILL_MAILER"].to_i == 1 ? true : false,  
+  tls: ENV["USE_MANDRILL_MAILER"].to_i == 1 ? true : false,  
+  # password:  ENV["USE_MANDRILL_MAILER"].to_i == 1 ?  ENV['MANDRILL_SMTP_PASSWORD'] : ENV["MAILER_SMTP_PASSWORD"],  
+  port:  ENV["USE_MANDRILL_MAILER"].to_i == 1 ?  ENV['MANDRILL_SMTP_PORT'] : ENV["MAILER_SMTP_PORT"],  
+  # user_name:  ENV["USE_MANDRILL_MAILER"].to_i == 1 ?  ENV['MANDRILL_SMTP_USERNAME'] : ENV["MAILER_SMTP_USERNAME"],  
+ # openssl_verify_mode: "none",}  
+  
+if ENV["USE_MANDRILL_MAILER"].to_i == 1  
+ smtp_settings[:authentication] = 'plain'  
+  smtp_settings[:password] = ENV['MANDRILL_SMTP_PASSWORD']  
+  smtp_settings[:user_name] = ENV['MANDRILL_SMTP_USERNAME']  
+end  
+  
+ActionMailer::Base.smtp_settings = smtp_settings  
+  
+ActionMailer::Base.default_url_options = { :host => ENV["BASE_URL_FE"] }  
+ActionMailer::Base.register_preview_interceptor(ActionMailer::InlinePreviewInterceptor)  
+  
+# Don't care if the mailer can't send.  
+ActionMailer::Base.raise_delivery_errors = true  
+ActionMailer::Base.perform_deliveries = true  
+ActionMailer::Base.perform_caching = false  
+  
+MandrillMailer.configure do |config|  
+  config.api_key = ENV["MANDRILL_SMTP_PASSWORD"]  
+  config.deliver_later_queue_name = :default  
+end
 ```
-response = ::DcidevMailer::Mandrill.send_email(  
-  subject: email_template.subject,  
-  html_body: email_template.wording,  
-  header_url: email_template.header.try(:url),  
-  footer_url: email_template.footer.try(:url),  
-  to: customer.email,  
-  # from: "from@gmail.com",  
-  attachments: attachments,  
-  email_template_path: "cimb_mailer/email.html.erb"  
-)
+ 
+
+ # How to Use 
+
+### Mandrill Example
+
+
+```ruby
+class MandrillMailer  
+  class << self  
+ def send_email(customer: nil, email_template: nil, attachments: nil, description: nil)  
+      raise "invalid customer" if customer.nil?  
+      raise "invalid template" if email_template.nil?  
+      begin  
+  response = ::DcidevMailer::Mandrill.send_email(  
+          subject: email_template.subject,  
+          html_body: MailerHelper.format_wording(email_template.wording, customer),  
+          header_url: email_template.header.try(:url),  
+          footer_url: email_template.footer.try(:url),  
+          to: customer.email,  
+          cc: nil,
+          bcc: nil,
+          from: ENV['DEFAULT_EMAIL_SENDER'],  
+          attachments: attachments,  
+          email_template_path: "mail/blast.html.erb" # specify template file location
+  )  
+      rescue => e  
+ error_message = "[SEND EMAIL] " + e.try(:to_s)  
+      ensure  
+  EmailHistory.create(application: customer.application, template: email_template, status: response[0]["status"] == "sent" ? :sent : :failed, mail_provider_id: response[0]["_id"], form_cetak_attachment: attachments.present?, error_message: response[0]["reject_reason"]) if response.present?  
+          ApplicationHistory.log(description: error_message || description, application: customer.application)  
+      end  
+ end endend
 ```
 
-action mailer
+### Action Mailer Example
+```ruby
+class MortgageMailer  
+  class << self  
+ def email(customer: nil, template: nil, file_attachments: nil, description: nil)  
+      begin  
+  raise "invalid customer" if customer.nil?  
+        raise "invalid template" if template.nil?  
+        raise "email is empty" if customer.email.nil?  
+ 
+        wording, _ = DcidevMailer.format_image_from_html(template.wording)  
+        wording = MailerHelper.format_wording(wording,customer)  
+  
+        DcidevMailer::RailsMailer.email(  
+          html_body: wording,  
+          header_url: template.header.try(:url),  
+          footer_url: template.footer.try(:url),  
+          file_attachments: file_attachments,  
+          to: customer.email,  
+          cc: nil,
+          bcc: nil,
+          subject: template.subject,  
+          from: ENV['DEFAULT_EMAIL_SENDER'],  
+          template_path: "mail/blast.html.erb"  # specify template file location
+  )  
+      rescue => e  
+ error_message = "[SEND EMAIL] " + e.try(:to_s)  
+      ensure  
+		  EmailHistory.create(status: error_message.present? ? :failed : :sent, error_message: error_message, application: customer.application, template: template, form_cetak_attachment: file_attachments.present?)  
+	      ApplicationHistory.log(description: error_message || description, application: customer.application)  
+      end  
+ end end  
+end
 ```
-          DcidevMailer::Rails.email(
-    html_body: template.wording,
-    header_url: template.header.try(:url),
-    footer_url: template.footer.try(:url),
-    file_attachments: file_attachments,
-    to: customer.email,
-    subject: template.subject
-  )
+
+### Helpers
+```ruby
+# convert all image URL in <img src="url"> to <img src="cid:xxxx">
+DcidevMailer::format_image_from_html(html)
+
+# format array of attachment files
+DcidevMailer::format_attachments(attachments)
+
+# format email header & footer url to be embedded to html body
+# refer to class DcidevMailer::Mandrill or DcidevMailer::Rails to understand more of this method
+DcidevMailer::format_header_footer(header_url: "", footer_url: "", locals: {}, images: {})
 ```

data/lib/dcidev_mailer/errors/invalid_body.rb

@@ -0,0 +1,9 @@
+module DcidevMailer
+  module Errors
+    class InvalidBody < StandardError
+      def to_s
+        "Email body must be HTML string"
+      end
+    end
+  end
+end

data/lib/dcidev_mailer/errors/invalid_recipients.rb

@@ -0,0 +1,9 @@
+module DcidevMailer
+  module Errors
+    class InvalidRecipients < StandardError
+      def to_s
+        "Must have at lease one recipient"
+      end
+    end
+  end
+end

data/lib/dcidev_mailer/errors/invalid_template.rb

@@ -0,0 +1,9 @@
+module DcidevMailer
+  module Errors
+    class InvalidTemplate < StandardError
+      def to_s
+        "Missing email template"
+      end
+    end
+  end
+end

data/lib/dcidev_mailer/mandrill.rb

@@ -5,23 +5,21 @@ module DcidevMailer
         default from: ENV['DEFAULT_EMAIL_SENDER']
 
         class << self
-            def send_email(subject: "", html_body: "", to: nil, cc: nil, bcc: nil, from: nil, attachments: nil, email_template_path: "", header_url: "", footer_url: "")
+            def send_email(subject: "", html_body: "", to: nil, from: nil, attachments: nil, email_template_path: "", header_url: "", footer_url: "")
                 ac = ActionController::Base.new
                 wording, images = DcidevMailer.format_image_from_html(html_body)
                 locals = {wording: wording, header: nil, footer: nil}
                 locals, images = DcidevMailer.format_header_footer(header_url: header_url, footer_url: footer_url, locals: locals, images: images) if header_url.present? && footer_url.present?
                 html_body = ac.render_to_string(template: email_template_path, locals: locals)
                 attachments = DcidevMailer.format_attachments(attachments) if attachments.present?
-                self.send_mail(subject, to,cc, bcc, html_body, attachments, images, from).deliver_now
+                self.send_mail(subject, to, html_body, attachments, images, from).deliver_now
             end
 
-            def send_mail(subject, to, cc, bcc, html, attachments = nil, images = nil, from = nil)
+            def send_mail(subject, to, html, attachments = nil, images = nil, from = nil)
                 mandrill_mail subject: subject,
                                 from: from,
                               # to: "dev.puntodamar@gmail.com",
                               to: to,
-                              cc: cc,
-                              bcc: bcc,
                               # to: { email: invitation.email, name: 'Honored Guest' },
                               html: html,
                               view_content_link: true,

data/lib/dcidev_mailer/rails_mailer.rb

@@ -0,0 +1,79 @@
+# require 'mail'
+require 'action_mailer'
+require 'action_view'
+require 'mail'
+require 'dcidev_mailer/errors/invalid_recipients'
+require 'dcidev_mailer/errors/invalid_body'
+require 'dcidev_mailer/errors/invalid_template'
+module DcidevMailer
+  class RailsMailer < ActionMailer::Base
+
+    def email(html_body: "", header_url: "", footer_url: "", file_attachments: nil, to: nil, cc: nil, bcc: nil, from: nil, subject: "", template_path: "")
+      raise DcidevMailer::Errors::InvalidRecipients unless to.present?
+      raise DcidevMailer::Errors::InvalidBody unless html_body.present? && html_body.is_a?(String)
+      raise DcidevMailer::Errors::InvalidTemplate unless template_path.present?
+      wording, images = DcidevMailer.format_image_from_html(html_body)
+
+      locals = { wording: wording, header: nil, footer: nil }
+      locals, images = DcidevMailer.format_header_footer(header_url: header_url, footer_url: footer_url, locals: locals, images: images) if header_url.present? && footer_url.present?
+
+      if file_attachments.present?
+        file_attachments.each do |a|
+          am.attachments[a[:name].to_s] = a[:content] unless a[:content].nil?
+        end
+      end
+
+      attachments.inline['header'] = File.read(Utility.download_to_file(header_url)) rescue nil if header_url.present?
+      attachments.inline['footer'] = File.read(Utility.download_to_file(footer_url)) rescue nil if footer_url.present?
+
+      mail(
+        to: to,
+        cc: cc,
+        bcc: bcc,
+        subject: subject,
+        format: "text/html",
+        from: from,
+        # template_path: "dcidev_mailer/rails_mailer",
+        # template_name: 'a',
+      ) do |format|
+        format.html {
+          render locals: locals, html: ActionController::Base.new.render_to_string(template: template_path, locals: locals)
+
+        }
+      end
+    end
+
+
+    # def self.method_missing(method_name, html_body: "", header_url: "", footer_url: "", file_attachments: nil, to: nil, cc: nil, bcc: nil, from: nil, subject: "")
+    #   raise DcidevMailer::Errors::InvalidRecipients unless to.present?
+    #   raise DcidevMailer::Errors::InvalidBody unless html_body.present? && html_body.is_a?(String)
+    #   wording, images = DcidevMailer.format_image_from_html(html_body)
+    #
+    #   locals = { wording: wording, header: nil, footer: nil }
+    #   locals, images = DcidevMailer.format_header_footer(header_url: header_url, footer_url: footer_url, locals: locals, images: images) if header_url.present? && footer_url.present?
+    #
+    #   if file_attachments.present?
+    #     file_attachments.each do |a|
+    #       am.attachments[a[:name].to_s] = a[:content] unless a[:content].nil?
+    #     end
+    #   end
+    #
+    #   attachments.inline['header'] = File.read(Utility.download_to_file(header_url)) rescue nil if header_url.present?
+    #   attachments.inline['footer'] = File.read(Utility.download_to_file(footer_url)) rescue nil if footer_url.present?
+    #
+    #   mail(
+    #     to: to,
+    #     cc: cc,
+    #     bcc: bcc,
+    #     subject: subject,
+    #     format: "text/html",
+    #     from: from,
+    #   ) do |format|
+    #     format.html {
+    #       render locals: locals
+    #     }
+    #   end
+    # end
+
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dcidev_mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Punto Damar P
@@ -47,8 +47,11 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/dcidev_mailer.rb
+- lib/dcidev_mailer/errors/invalid_body.rb
+- lib/dcidev_mailer/errors/invalid_recipients.rb
+- lib/dcidev_mailer/errors/invalid_template.rb
 - lib/dcidev_mailer/mandrill.rb
-- lib/dcidev_mailer/rails.rb
+- lib/dcidev_mailer/rails_mailer.rb
 homepage:
 licenses: []
 metadata: {}

data/lib/dcidev_mailer/rails.rb

@@ -1,29 +0,0 @@
-require 'mail'
-
-module DcidevMailer
-    class Rails < ActionMailer::Base
-        default from: ENV['DEFAULT_EMAIL_SENDER']
-
-        class << self
-            def email(html_body: "", header_url: "", footer_url: "", file_attachments: nil, to: "", from: nil, subject: "")
-                wording, images = DcidevMailer.format_image_from_html(html_body)
-                locals = {wording: wording, header: nil, footer: nil}
-                locals, images = DcidevMailer.format_header_footer(header_url: header_url, footer_url: footer_url, locals: locals, images: images) if header_url.present? && footer_url.present?
-
-                if file_attachments.present?
-                    file_attachments.each do |a|
-                      attachments[a[:name].to_s] = a[:content] unless a[:content].nil?
-                    end
-                end
-
-                attachments.inline['header'] = File.read(Utility.download_to_file(header_url)) rescue nil if header_url.present?
-                attachments.inline['footer'] = File.read(Utility.download_to_file(footer_url)) rescue nil if footer_url.present?
-          
-                mail(to: to, subject: subject, format: "text/html", from: from) do |format|
-                    format.html {
-                      render locals: locals
-                    }
-            end
-        end
-    end
-end