dcidev_mailer 0.0.6 → 0.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 99da00135ff089f563f8843ac8eed71aff180563e8257c0c3ad50a5fea4627e1
-  data.tar.gz: 9c07e164bde039359ef9ec2ab2102d0277d733970218f64ac6033e0639f838b2
+  metadata.gz: 1d5db8d1b62f6e33eb11d13d17387303403cdc9fbf3db7cfa19fd1df952be63b
+  data.tar.gz: e4bc5416ecc528cb1296937bacc7a0beb60cefed862b53a9291d490b8be6ac99
 SHA512:
-  metadata.gz: defa57723a34010ec7fb48f680fd331dfa063c15b3790d976e8612718b9ee9550a260400d729a410bd79fad7bcc16de7aa41d4f326c3fa340d1a939eb04ddb51
-  data.tar.gz: 60066e1f871cf6b8d56ea407ca01472e3fd8ee9848f34bd063852cca20e2d1ecdb99e8d2d964bd18eb67f9bfc1db724a241736bc4a7c10ad96f812993eb2d092
+  metadata.gz: bed99b742d0ab530425775cae53704fa6f3599a00b894a6fd51d1e45d43b936c56eeadd4c13c513c3bf22e2b32a64ad118d37ae32b12f9f915e97e916b257d5c
+  data.tar.gz: 6c69261bc24fabd8b53ed829045e44ff9ced03f9b1ef909ba6a30809a89e386d4477121c6f7a478dc7cde467844969c4e3c0a82977c5d810a98eee7706f334d8

data/README.md

@@ -1,40 +1,160 @@
+# 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
+require 'dcidev_mailer/mandrill'
+
+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, # can be a string / array
+                bcc: nil, # can be a string / array
+                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 
+end
 ```
 
-action mailer
+### Action Mailer Example
+```ruby
+require 'dcidev_mailer/rails_mailer'
+
+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, # can be a string / array
+                    bcc: nil, # can be a string / array
+                    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/mandrill.rb

@@ -1,25 +1,27 @@
-require "mandrill"
+require 'mandrill'
 
 module DcidevMailer
     class Mandrill < MandrillMailer::MessageMailer
         default from: ENV['DEFAULT_EMAIL_SENDER']
 
         class << self
-            def send_email(subject: "", html_body: "", to: nil, from: nil, attachments: nil, email_template_path: "", header_url: "", footer_url: "")
+            def send_email(subject: '', html_body: '', to: nil, cc: nil, bcc: 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 = { 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, html_body, attachments, images, from).deliver_now
+                self.send_mail(subject, to, cc, bcc, html_body, attachments, images, from).deliver_now
             end
 
-            def send_mail(subject, to, html, attachments = nil, images = nil, from = nil)
+            def send_mail(subject, to, cc, bcc, html, attachments = nil, images = nil, from = nil)
                 mandrill_mail subject: subject,
-                                from: from,
+                              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/{mail.rb → rails_mailer.rb}

@@ -16,10 +16,11 @@ module DcidevMailer
 
       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?
-
+      
+      file_attachments = DcidevMailer.format_attachments(file_attachments) if file_attachments.present?
       if file_attachments.present?
         file_attachments.each do |a|
-          am.attachments[a[:name].to_s] = a[:content] unless a[:content].nil?
+          attachments[a[:name].to_s] = a[:content] unless a[:content].nil?
         end
       end
 
@@ -76,4 +77,4 @@ module DcidevMailer
     # end
 
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dcidev_mailer
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.10
 platform: ruby
 authors:
 - Punto Damar P
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-10 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mimemagic
@@ -50,8 +50,8 @@ files:
 - lib/dcidev_mailer/errors/invalid_body.rb
 - lib/dcidev_mailer/errors/invalid_recipients.rb
 - lib/dcidev_mailer/errors/invalid_template.rb
-- lib/dcidev_mailer/mail.rb
 - lib/dcidev_mailer/mandrill.rb
+- lib/dcidev_mailer/rails_mailer.rb
 homepage:
 licenses: []
 metadata: {}