hertz-email 1.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 43158448cc5f38f5297de7897bbca720660ed53a3b9b54e48a9575d8972f967c
+  data.tar.gz: c41d7b93ecb80fee73ca72dec24066b86f5c598df851cc367118f18d84d9e42a
+SHA512:
+  metadata.gz: 938b7a352b89458aa5ac3345dae591aa7cbfc3aa3751f250d6a8e23f1ce0f505bdebd79da1f03e1a900434ad3b8db82799b535d943eb349c80047265c55874aa
+  data.tar.gz: cd13ccb6e7f76369bc5908f0609878fe0a2ef4d50203397690582210ce898a4f55f467969b9abeac6280ae21c73970f706f7fa96ed4c0a3cd0ee59a66f018de2

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Alessandro Desantis
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,128 @@
+# Hertz::Courier::Email
+
+[![Build Status](https://travis-ci.org/aldesantis/hertz-email.svg?branch=master)](https://travis-ci.org/aldesantis/hertz-email)
+[![Dependency Status](https://gemnasium.com/badges/github.com/aldesantis/hertz-email.svg)](https://gemnasium.com/github.com/aldesantis/hertz-email)
+[![Coverage Status](https://coveralls.io/repos/github/aldesantis/hertz-email/badge.svg?branch=master)](https://coveralls.io/github/aldesantis/hertz-email?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c71c1821b56b288ea71a/maintainability)](https://codeclimate.com/github/aldesantis/hertz-email/maintainability)
+
+This is a [Hertz](https://github.com/alessandro1997/hertz) courier for sending email notifications to your users through
+ActionMailer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hertz-email'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install hertz-email
+```
+
+Then, run the installer generator:
+
+```console
+$ rails g hertz:courier:email:install
+```
+
+You will also need to expose the `hertz_email` method in your receiver class. This can be either a single email or an 
+array of emails:
+
+```ruby
+class User < ActiveRecord::Base
+  include Hertz::Notifiable
+
+  def hertz_email
+    email
+  end
+end
+```
+
+If `#hertz_email` returns an empty value (i.e. `false`, `nil`, an empty string or an empty array) at the time the job is 
+executed, the notification will not be delivered. This allows you to programmatically enable/disable email notifications 
+for a user:
+
+```ruby
+class User
+  include Hertz::Notifiable
+
+  def hertz_email
+    email if email_verified?
+  end
+end
+```
+
+Or even to choose what addresses they can receive emails to:
+
+```ruby
+class User
+  include Hertz::Notifiable
+
+  def hertz_email
+    emails.select(&:verified?)
+  end
+end
+```
+
+## Usage
+
+In order to use this courier, add `:email` to `#deliver_by` in the notification model(s):
+
+```ruby
+class CommentNotification < Hertz::Notification
+  deliver_by :email
+end
+```
+
+Now, add the `#email_subject` method in your notification class:
+
+```ruby
+class CommentNotification < Hertz::Notification
+  def email_subject
+    'You have a new comment!'
+  end
+end
+```
+
+You may also pass more options to the `#mail` method of the mailer by defining a `#email_options` method:
+
+```ruby
+class CommentNotification < Hertz::Notification
+  def email_options
+    {
+      # generate a custom Reply-To address for the receiver
+      reply_to: "replies+#{receiver.id}@example.com" 
+    }
+  end
+end
+```
+
+Finally, you should create a template for every notification you send by email. For `CommentNotification` you'd create a
+template at `app/views/hertz/courier/email/notification_mailer/comment_notification.html.erb`:
+
+```erb
+<p>Hey <%= @notification.receiver.hertz_email %>,</p>
+<p>you've got a new comment!</p>
+```
+
+As you can see, templates have access to the `@notification` instance variable.
+
+**NOTE:** This courier uses the [deliveries API](https://github.com/alessandro1997/hertz#tracking-delivery-status)
+to prevent double deliveries.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alessandro1997/hertz-email.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/jobs/hertz/courier/email/notification_delivery_job.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Hertz
+  module Courier
+    module Email
+      class NotificationDeliveryJob < ActiveJob::Base
+        queue_as :default
+
+        def perform(notification)
+          return unless notification.receiver.hertz_email.present?
+          return if notification.delivered_with?(:email)
+
+          Hertz::Courier::Email::NotificationMailer.notification_email(notification).deliver_now
+
+          notification.mark_delivered_with(:email)
+        end
+      end
+    end
+  end
+end

data/app/mailers/hertz/courier/email/notification_mailer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Hertz
+  module Courier
+    module Email
+      class NotificationMailer < Hertz::Courier::Email.base_mailer
+        def notification_email(notification)
+          @notification = notification
+          mail email_options_for(notification)
+        end
+
+        private
+
+        def email_options_for(notification)
+          options = {
+            to: notification.receiver.hertz_email,
+            subject: notification.email_subject,
+            template_name: view_for(notification)
+          }
+
+          if notification.respond_to?(:email_options)
+            options = options.merge(notification.email_options)
+          end
+
+          options
+        end
+
+        def view_for(notification)
+          if notification.respond_to?(:email_template)
+            notification.email_template
+          else
+            notification.class.to_s.underscore
+          end
+        end
+      end
+    end
+  end
+end

data/lib/generators/hertz/courier/email/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Hertz
+  module Courier
+    module Email
+      class InstallGenerator < Rails::Generators::Base
+        source_root File.expand_path('../templates', __FILE__)
+
+        def copy_initializer_file
+          copy_file 'initializer.rb', 'config/initializers/hertz_email.rb'
+        end
+      end
+    end
+  end
+end

data/lib/generators/hertz/courier/email/templates/initializer.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Hertz::Courier::Email.configure do |config|
+  # Your base mailer class, for delivering notifications by email.
+  config.base_mailer = '::ApplicationMailer'
+end

data/lib/hertz/courier/email.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'hertz'
+
+require 'hertz/courier/email/engine'
+require 'hertz/courier/email/version'
+
+module Hertz
+  module Courier
+    module Email
+      class << self
+        mattr_writer :base_mailer
+
+        def base_mailer
+          (@base_mailer || '::ApplicationMailer').constantize
+        end
+
+        def configure
+          yield(self)
+        end
+
+        def deliver_notification(notification)
+          Hertz::Courier::Email::NotificationDeliveryJob.perform_later(notification)
+        end
+      end
+    end
+  end
+end

data/lib/hertz/courier/email/engine.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Hertz
+  module Courier
+    module Email
+      class Engine < ::Rails::Engine
+        isolate_namespace Hertz::Courier::Email
+      end
+    end
+  end
+end

data/lib/hertz/courier/email/version.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module Hertz
+  module Courier
+    module Email
+      VERSION = '1.1.1'
+    end
+  end
+end

metadata

@@ -0,0 +1,228 @@
+--- !ruby/object:Gem::Specification
+name: hertz-email
+version: !ruby/object:Gem::Version
+  version: 1.1.1
+platform: ruby
+authors:
+- Alessandro Desantis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hertz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: database_cleaner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot_rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fuubar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.21'
+- !ruby/object:Gem::Dependency
+  name: rspec-activejob
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- desa.alessandro@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/jobs/hertz/courier/email/notification_delivery_job.rb
+- app/mailers/hertz/courier/email/notification_mailer.rb
+- lib/generators/hertz/courier/email/install_generator.rb
+- lib/generators/hertz/courier/email/templates/initializer.rb
+- lib/hertz/courier/email.rb
+- lib/hertz/courier/email/engine.rb
+- lib/hertz/courier/email/version.rb
+homepage: https://github.com/alessandro1997/hertz-email
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.5
+signing_key: 
+specification_version: 4
+summary: An ActionMailer courier for Hertz.
+test_files: []