mail-notify 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b6b11dc10c2fb12b2ad57606156b3d2e555ee0f5ae47c1b5ed65aa5edda4f7e3
-  data.tar.gz: 69d53a7e7cd2cb27f1a918247faa02945df6c07b57be1ff017418556cfdf9dd4
+  metadata.gz: 5a39b418b67958ee80a979be7f33d0367c9b122914d3640bfc65e59db8fd6ba8
+  data.tar.gz: 48fe8389d949853835b6f4cba7510cb1f2aea18c47899bb56bb2e52ddcc17eb4
 SHA512:
-  metadata.gz: 771e26cd9314ea752907d9bf7e09e213581247c32582b1a4663be105f5c9a4aabec30797e4ad8cbd831b83c354b1e4ed4cbeafc7f79781f9ce9d17da80ce151c
-  data.tar.gz: 14d36787c4dfab3458c31bdf3382fbfe760a82b78d4041ca48a9c5ccc9821534993dd68ae56da1826bff78ebba3dcf540b41920d6a2e32fcb5a9addd0d033e37
+  metadata.gz: 04e90ef052082fb609bd0e5ca3b680df6794d05a21b133c2ee268d4292ae1175eb35c7e2aaaff4085317a74ad413e06d3f7edb072d8f7c6e1e4b715d10582129
+  data.tar.gz: 8a874ac8124e9a1126d887fc5ba8d543ac999a30fa26c6ab3703c1f2e9a56aa6e6861b4c495f7fc7e64b7f523dad010d54b5e8353019968d00d9b7133f82c55c

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 .DS_Store
+/Gemfile.lock

data/.rubocop.yml

@@ -5,6 +5,8 @@ Style/Documentation:
   Exclude:
     - 'spec/**/*'
     - 'test/**/*'
-    - 'lib/mail/notify.rb'
-    - 'lib/mail/notify/delivery_method.rb'
-    - 'lib/mail/notify/railtie.rb'
+    - 'lib/**/*'
+
+Metrics/BlockLength:
+  Exclude:
+    - 'spec/**/*'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    mail-notify (0.1.0)
+    mail-notify (0.0.2)
       actionmailer (~> 5.0)
       notifications-ruby-client (~> 2.0)
 

data/README.md

@@ -20,8 +20,7 @@ Or install it yourself as:
 
     $ gem install mail-notify
 
-Then, add the following to your `config/environments/*.rb` (where * is `test`, `development`, `production` or 
-whatever other environment(s) you have) file(s):
+Then, add the following to your `config/environments/*.rb` (where * is `test`, `development`, `production` or whatever other environment(s) you have) file(s):
 
 ```ruby
 config.action_mailer.delivery_method = :notify
@@ -30,34 +29,54 @@ config.action_mailer.notify_settings = {
 }
 ```
 
-## Usage
+### Mailers
 
-This gem assumes you have a very simple template set up in Notify, with a `((subject))` variable
-in the subject line, and a `((body))` variable in the body field, as below:
+There are two options for using `Mail::Notify`, either templating in Rails with a view, or templating in Notify. Whichever way you choose, you'll need your mailers to inherit from `Mail::Notify::Mailer` like so:
 
-![Example screenshot](docs/screenshot.png)
+```ruby
+class MyMailer < Mail::Notify::Mailer
+end
+```
 
-Support for further customisations may come further down the road.
+#### With a view
 
-### Mailers
+Out of the box, Notify offers support for templating, with some rudimentary logic included. If you'd rather have your templating logic included with your source code for ease of access, or you want to do some more complex logic that's not supported by Notify, you can template your mailer views in erb.
+
+For this to work with Notify, you'll need a very simple template set up in Notify, with a `((subject))` variable in the subject line, and a `((body))` variable in the body field, as below:
+
+![Example screenshot](docs/screenshot.png)
 
-Using mailers is pretty much identical to as if you were using any other action_mailer delivery method, the only difference is you'll need to add your `template_id` to your call to `mail`, eg:
+Next, in your mailer you'll need to call `view_mail` with the first parameter being the ID of the notify template, followed by a hash of email headers e.g:
 
 ```ruby
-class MyMailer < ApplicationMailer
+class MyMailer < Mail::Notify::Mailer
     def send_email
-        mail(
+        notify_mail('YOUR_TEMPLATE_ID_GOES_HERE',
           to: 'mail@somewhere.com',
-          subject: 'Subject line goes here',
-          template_id: 'YOUR_TEMPLATE_ID_GOES_HERE'
+          subject: 'Subject line goes here'
         )
     end
 end
 ```
 
-### Views
+Your view can then be a simple `text.erb` file. You can add some markdown for headers, bullet points and links etc. These are handled in the same way as standard action_mailer views.
 
-Views should be simple `text.erb` files. You can add some markdown for headers, bullet points and links etc. These are handled in the same way as standard action_mailer views.
+#### With Notify templating
+
+You can also send your customisations in the more traditional way, and do your templating in Notify if you prefer. For this, you'll need to call `template_mail`, again with the first parameter being the ID of the template, and a hash of email headers, including your personalisations, e.g:
+
+```ruby
+class MyMailer < Mail::Notify::Mailer
+    def send_email
+        template_mail('YOUR_TEMPLATE_ID_GOES_HERE',
+          to: 'mail@somewhere.com',
+          personalisations: {
+              foo: 'bar'
+          }
+        )
+    end
+end
+```
 
 ## Development
 

data/lib/mail/notify.rb

@@ -5,6 +5,8 @@ require 'notifications/client'
 require 'mail/notify/version'
 require 'mail/notify/railtie' if defined? Rails
 require 'mail/notify/delivery_method'
+require 'mail/notify/personalisation'
+require 'mail/notify/mailer'
 
 module Mail
   module Notify

data/lib/mail/notify/delivery_method.rb

@@ -10,7 +10,9 @@ module Mail
       end
 
       def deliver!(mail)
-        initialize_params(mail)
+        @mail = mail
+        @personalisation = Personalisation.new(@mail)
+        initialize_params
         send_email
       end
 
@@ -20,14 +22,11 @@ module Mail
         @client ||= Notifications::Client.new(@settings[:api_key])
       end
 
-      def initialize_params(mail)
+      def initialize_params
         @email_params = {
-          email_address: mail.to.first,
-          template_id: mail[:template_id].to_s,
-          personalisation: {
-            body: mail.body.raw_source,
-            subject: mail.subject
-          }
+          email_address: @mail.to.first,
+          template_id: @mail[:template_id].to_s,
+          personalisation: @personalisation.to_h
         }
       end
 

data/lib/mail/notify/mailer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Mail
+  module Notify
+    class Mailer < ActionMailer::Base
+      def view_mail(template_id, headers)
+        mail(headers.merge(template_id: template_id))
+      end
+
+      def template_mail(template_id, headers)
+        mail(headers.merge(body: '', subject: '', template_id: template_id))
+      end
+    end
+  end
+end

data/lib/mail/notify/personalisation.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Mail
+  module Notify
+    class Personalisation
+      def initialize(mail)
+        @body = mail.body.raw_source
+        @subject = mail.subject
+        @personalisation = mail[:personalisation]&.unparsed_value || {}
+      end
+
+      def to_h
+        merged_options.reject { |_k, v| v.blank? }
+      end
+
+      private
+
+      def merged_options
+        {
+          body: @body,
+          subject: @subject
+        }.merge(@personalisation)
+      end
+    end
+  end
+end

data/lib/mail/notify/version.rb

@@ -2,6 +2,6 @@
 
 module Mail
   module Notify
-    VERSION = '0.0.1'
+    VERSION = '0.0.2'
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mail-notify
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Stuart Harrison
@@ -148,6 +148,8 @@ files:
 - docs/screenshot.png
 - lib/mail/notify.rb
 - lib/mail/notify/delivery_method.rb
+- lib/mail/notify/mailer.rb
+- lib/mail/notify/personalisation.rb
 - lib/mail/notify/railtie.rb
 - lib/mail/notify/version.rb
 - mail-notify.gemspec