mail-notify 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69a9c571a11fcd6408c96f59ee72d96a26d3dc6a219e94bed97d0bb4968246b9
-  data.tar.gz: e209c731e194acdd646c15bbeb797825c2a9fff3967ae2734ea028fb7e931111
+  metadata.gz: 96ca2326f9ce5a6c1124e2a58d562a6969ebad1ea464940413e638fe5a7b4213
+  data.tar.gz: e5d02076848631d09ece955616b65a0c167eec463caad492037453a7ebf1cbff
 SHA512:
-  metadata.gz: b3fa78ee0398c01f41b045be39c623dc3a1cd969947b9f22539910e2be37f2779be89470a62e23f9f64d82160a30936b6c7516b2c5cac9e5d4a49dba4d76967b
-  data.tar.gz: 56b927b676e0da0bf58774ba09336c975a04d995ab87a9c973b8379262a26be0c33f2ead74996e1aa0d6ee127e5ffbd31968eb3479b459110f3da6a8fe1113a5
+  metadata.gz: '090eed8f5a382930f3b21b359397605710f7e9108d5d9a2f6711e2d48185c93f22267604ced049d68580aa6250efe138f3d442a37af7eca98c84314f5ccf5545'
+  data.tar.gz: 01152410ad1d43ff204f18e758625466bd773d331cb1bfb7d3ea68d61fd6861d06045db47e4525f8ff4fb733867c9817644889285943caa738d5924b0a41fde8

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 .DS_Store
 /Gemfile.lock
+/spec/dummy/log/test.log

data/.rubocop.yml

@@ -1,5 +1,7 @@
 Metrics/LineLength:
   Max: 91
+  Exclude:
+    - 'spec/dummy/**/*'
 
 Style/Documentation:
   Exclude:

data/README.md

@@ -1,4 +1,7 @@
-[![CircleCI](https://circleci.com/gh/pezholio/mail-notify.svg?style=svg)](https://circleci.com/gh/pezholio/mail-notify)
+[![CircleCI Status](https://img.shields.io/circleci/project/github/pezholio/mail-notify.svg?style=flat-square)](https://circleci.com/gh/pezholio/mail-notify)
+[![Coverage Status](https://img.shields.io/coveralls/github/pezholio/mail-notify.svg?style=flat-square)](https://coveralls.io/github/pezholio/mail-notify)
+[![Gem Version](http://img.shields.io/gem/v/mail-notify.svg?style=flat-square)](https://rubygems.org/gems/mail-notify)
+[![License](http://img.shields.io/:license-mit-blue.svg)](https://mit-license.org/)
 
 # Mail::Notify
 
@@ -78,6 +81,10 @@ class MyMailer < Mail::Notify::Mailer
 end
 ```
 
+## Previews
+
+If you're using ActionMailer with Rails, [previews](https://guides.rubyonrails.org/action_mailer_basics.html#previewing-emails) are supported too, and work in the same way as standard previews. Currently they're shown without any branding, but this may change in future.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -86,7 +93,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mail-notify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/pezholio/mail-notify. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -94,4 +101,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Mail::Notify project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/mail-notify/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Mail::Notify project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/pezholio/mail-notify/blob/master/CODE_OF_CONDUCT.md).

data/lib/mail/notify.rb

@@ -7,6 +7,10 @@ require 'mail/notify/railtie' if defined? Rails
 require 'mail/notify/delivery_method'
 require 'mail/notify/personalisation'
 require 'mail/notify/mailer'
+require 'mail/notify/message'
+require 'mail/notify/mailers_controller'
+
+Mail::Message.include Mail::Notify::Message
 
 module Mail
   module Notify

data/lib/mail/notify/delivery_method.rb

@@ -15,6 +15,12 @@ module Mail
         send_email
       end
 
+      def preview(mail)
+        personalisation = Personalisation.new(mail).to_h
+        template_id = mail[:template_id].to_s
+        client.generate_template_preview(template_id, personalisation: personalisation)
+      end
+
       private
 
       def client

data/lib/mail/notify/mailers_controller.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Mail
+  module Notify
+    module MailersController
+      def preview
+        @email_action = File.basename(params[:path])
+        return super unless @preview.email_exists?(@email_action)
+
+        @email = @preview.call(@email_action, params)
+
+        return super unless notify?
+
+        return render_part if params[:part]
+
+        render_preview_wrapper
+      end
+
+      private
+
+      def render_part
+        response.content_type = 'text/html'
+        render plain: @email.preview.html.html_safe
+      end
+
+      def render_preview_wrapper
+        @part = @email
+        render action: 'email', layout: false, formats: %w[html]
+      end
+
+      def notify?
+        @email.delivery_method.class == Mail::Notify::DeliveryMethod
+      end
+    end
+  end
+end

data/lib/mail/notify/message.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Mail
+  module Notify
+    module Message
+      def preview
+        delivery_method.preview(self) if delivery_method.respond_to?(:preview)
+      end
+    end
+  end
+end

data/lib/mail/notify/railtie.rb

@@ -6,6 +6,12 @@ module Mail
       initializer 'mail-notify.add_delivery_method', before: 'action_mailer.set_configs' do
         ActionMailer::Base.add_delivery_method(:notify, Mail::Notify::DeliveryMethod)
       end
+
+      initializer 'mail-notify.action_controller' do
+        ActiveSupport.on_load(:action_controller, run_once: true) do
+          Rails::MailersController.send(:prepend, Mail::Notify::MailersController)
+        end
+      end
     end
   end
 end

data/lib/mail/notify/version.rb

@@ -2,6 +2,6 @@
 
 module Mail
   module Notify
-    VERSION = '0.0.3'
+    VERSION = '0.1.0'
   end
 end

data/mail-notify.gemspec

@@ -26,10 +26,12 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.0'
   spec.add_development_dependency 'coveralls', '~> 0.8.22'
   spec.add_development_dependency 'pry', '~> 0.12.0'
+  spec.add_development_dependency 'rails', '~> 5.2'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rspec-rails', '~> 3.8'
   spec.add_development_dependency 'rubocop', '~> 0.63'
+  spec.add_development_dependency 'sqlite3', '~> 1.4.1'
 
   spec.add_dependency 'actionmailer', '~> 5.0'
-  spec.add_dependency 'notifications-ruby-client', '~> 2.0'
+  spec.add_dependency 'notifications-ruby-client', '~> 3.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mail-notify
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Stuart Harrison
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +81,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rspec-rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.8'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.63'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.4.1
 - !ruby/object:Gem::Dependency
   name: actionmailer
   requirement: !ruby/object:Gem::Requirement
@@ -114,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.1'
 description: 
 email:
 - pezholio@gmail.com
@@ -139,7 +167,6 @@ files:
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -149,6 +176,8 @@ files:
 - lib/mail/notify.rb
 - lib/mail/notify/delivery_method.rb
 - lib/mail/notify/mailer.rb
+- lib/mail/notify/mailers_controller.rb
+- lib/mail/notify/message.rb
 - lib/mail/notify/personalisation.rb
 - lib/mail/notify/railtie.rb
 - lib/mail/notify/version.rb