hertz-email 1.1.1 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 43158448cc5f38f5297de7897bbca720660ed53a3b9b54e48a9575d8972f967c
-  data.tar.gz: c41d7b93ecb80fee73ca72dec24066b86f5c598df851cc367118f18d84d9e42a
+  metadata.gz: 1159dc08d8bfa53e8bf76129ea31c31b068c33e608e0c999da6ef467c08f6025
+  data.tar.gz: 1cca543ad0098c75e3a797d303a981886abaad4c3fdcca2070ad4485f1be7390
 SHA512:
-  metadata.gz: 938b7a352b89458aa5ac3345dae591aa7cbfc3aa3751f250d6a8e23f1ce0f505bdebd79da1f03e1a900434ad3b8db82799b535d943eb349c80047265c55874aa
-  data.tar.gz: cd13ccb6e7f76369bc5908f0609878fe0a2ef4d50203397690582210ce898a4f55f467969b9abeac6280ae21c73970f706f7fa96ed4c0a3cd0ee59a66f018de2
+  metadata.gz: 62cf5994a1a89ddb28aeb72d894164ccd318f5eeeca245bf4ded4de552414348404da6d337a0f75997c665695678bb20d349e3c66d41855fa30f2905ef43bc27
+  data.tar.gz: 12992bb11c91405862d1a51a0761554eefc8345c9dfe0eb8305feb726308491fe5826e2618018ac637511d6e505c745bf39d7b7433e942b6f690383e4234cb4b

data/README.md

@@ -1,12 +1,11 @@
-# Hertz::Courier::Email
+# Hertz::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.
+This is a [Hertz](https://github.com/aldesantis/hertz) courier for sending email notifications to 
+your users through ActionMailer.
 
 ## Installation
 
@@ -31,11 +30,11 @@ $ gem install hertz-email
 Then, run the installer generator:
 
 ```console
-$ rails g hertz:courier:email:install
+$ rails g hertz: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:
+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
@@ -47,9 +46,9 @@ class User < ActiveRecord::Base
 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:
+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
@@ -93,7 +92,8 @@ class CommentNotification < Hertz::Notification
 end
 ```
 
-You may also pass more options to the `#mail` method of the mailer by defining a `#email_options` method:
+You may also pass more options to the `#mail` method of the mailer by defining a `#email_options` 
+method:
 
 ```ruby
 class CommentNotification < Hertz::Notification
@@ -106,8 +106,9 @@ class CommentNotification < Hertz::Notification
 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`:
+Finally, you should create a template for every notification you send by email. For 
+`CommentNotification` you'd create a template at 
+`app/views/hertz/email/notification_mailer/comment_notification.html.erb`:
 
 ```erb
 <p>Hey <%= @notification.receiver.hertz_email %>,</p>
@@ -121,7 +122,7 @@ to prevent double deliveries.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/alessandro1997/hertz-email.
+Bug reports and pull requests are welcome on GitHub at https://github.com/aldesantis/hertz-email.
 
 ## License
 

data/Rakefile

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

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Hertz
+  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::Email::NotificationMailer.notification_email(notification).deliver_now
+
+        notification.mark_delivered_with(:email)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Hertz
+  module Email
+    class NotificationMailer < Hertz::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

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

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

data/lib/generators/hertz/{courier/email → email}/templates/initializer.rb

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

data/lib/hertz/email.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'hertz'
+
+require 'hertz/email/engine'
+require 'hertz/email/version'
+
+module Hertz
+  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::Email::NotificationDeliveryJob.perform_later(notification)
+      end
+    end
+  end
+end

data/lib/hertz/email/engine.rb

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

data/lib/hertz/email/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Hertz
+  module Email
+    VERSION = '2.0.1'
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hertz-email
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Alessandro Desantis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-02-14 00:00:00.000000000 Z
+date: 2018-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hertz
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
@@ -194,13 +194,13 @@ 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
+- app/jobs/hertz/email/notification_delivery_job.rb
+- app/mailers/hertz/email/notification_mailer.rb
+- lib/generators/hertz/email/install_generator.rb
+- lib/generators/hertz/email/templates/initializer.rb
+- lib/hertz/email.rb
+- lib/hertz/email/engine.rb
+- lib/hertz/email/version.rb
 homepage: https://github.com/alessandro1997/hertz-email
 licenses:
 - MIT
@@ -221,7 +221,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.7.5
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: An ActionMailer courier for Hertz.

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

@@ -1,20 +0,0 @@
-# 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

@@ -1,38 +0,0 @@
-# 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

@@ -1,15 +0,0 @@
-# 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/hertz/courier/email.rb

@@ -1,28 +0,0 @@
-# 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

@@ -1,11 +0,0 @@
-# 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

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