hertz-courier-email 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8f33e033f5036a05468307ad5fbc8597579f525d
+  data.tar.gz: 15785f77be756740e6b284eb4dda3d7d523ba3a3
+SHA512:
+  metadata.gz: ddfc76602a4dc09f9795a79b7ef430abdba9c2431ffaadf7f545524981613605c52aee644bc5bcd48e134b9688620595863bff497689225bd611782be1fed3ae
+  data.tar.gz: e54753df1ab1327f229c09923b123eae57c98680450cabc63a71ffd7d94b1336e9c2d53e5121cc4d39689854e538622e54a4f94cd335563387f367dfb348c629

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,106 @@
+# Hertz::Courier::Email
+
+[![Dependency Status](https://gemnasium.com/badges/github.com/alessandro1997/hertz-courier-email.svg)](https://gemnasium.com/github.com/alessandro1997/hertz-courier-email)
+[![Code Climate](https://codeclimate.com/github/alessandro1997/hertz-courier-email/badges/gpa.svg)](https://codeclimate.com/github/alessandro1997/hertz-courier-email)
+
+This is a [Hertz](https://github.com/alessandro1997/hertz) courier for sending
+notifications to your users via email throuh ActionMailer.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hertz-courier-email'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install hertz-courier-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:
+
+```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` or an empty
+string) 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
+```
+
+## 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
+```
+
+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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/alessandro1997/hertz-courier-email.
+
+## License
+
+The gem is available as open source under the terms of the
+[MIT License](http://opensource.org/licenses/MIT).
+
+# To do
+
+- [ ] Store notification delivery in the DB to avoid resending

data/Rakefile

@@ -0,0 +1,30 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Hertz'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+load 'rails/tasks/statistics.rake'
+
+Bundler::GemHelper.install_tasks
+
+Rake::TestTask.new(:spec) do |t|
+  t.libs << 'lib'
+  t.libs << 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = false
+end
+
+task default: :spec

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

@@ -0,0 +1,18 @@
+# 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?
+
+          Hertz::Courier::Email::NotificationMailer
+            .notification_email(notification)
+            .deliver_now
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+module Hertz
+  module Courier
+    module Email
+      class NotificationMailer < Hertz::Courier::Email.base_mailer
+        def notification_email(notification)
+          @notification = notification
+
+          mail(
+            to: notification.receiver.hertz_email,
+            subject: notification.email_subject,
+            template_name: view_for(notification)
+          )
+        end
+
+        private
+
+        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,14 @@
+# 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,5 @@
+# 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,10 @@
+# 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,8 @@
+# frozen_string_literal: true
+module Hertz
+  module Courier
+    module Email
+      VERSION = '1.0.0'
+    end
+  end
+end

metadata

@@ -0,0 +1,208 @@
+--- !ruby/object:Gem::Specification
+name: hertz-courier-email
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Alessandro Desantis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.2.6
+- !ruby/object:Gem::Dependency
+  name: hertz
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.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'
+- !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: 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: 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: 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: 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_girl_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: pg
+  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-courier-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.5.1
+signing_key: 
+specification_version: 4
+summary: An ActionMailer courier for Hertz.
+test_files: []