hertz 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0988dec23d3f623853e523c7fc2e6f530c6dcdc2
+  data.tar.gz: fd300b90871a186b9068f6c94002631c21b928af
+SHA512:
+  metadata.gz: 6145eb3c0c8e18ec36dcbcc6901b4003e8d863ec11b60031ca4fe895a752fee78f96197f35c2b9282b8d75bf6c42d203e84797946608adbdeac3ff6e66fb33e1
+  data.tar.gz: e1cfa1891739d7658eb1ad98089d4294f6491ed602ca4a349ba5e35e8ce84486686c329bd448f8331c61433dc6081c3efb34a51e618c163e21da5c296292ebab

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,188 @@
+# Hertz
+
+[![Dependency Status](https://gemnasium.com/badges/github.com/alessandro1997/hertz.svg)](https://gemnasium.com/github.com/alessandro1997/hertz)
+[![Code Climate](https://codeclimate.com/github/alessandro1997/hertz/badges/gpa.svg)](https://codeclimate.com/github/alessandro1997/hertz)
+
+Hertz is a Ruby on Rails engine for sending in-app notification to your users.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'hertz'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install hertz
+```
+
+Then, run the installer generator:
+
+```console
+$ rails g hertz:install
+$ rake db:migrate
+```
+
+Finally, add the following to the model that will receive the notifications
+(e.g. `User`):
+
+```ruby
+class User < ActiveRecord::Base
+  include Hertz::Notifiable
+end
+```
+
+## Usage
+
+### Using couriers
+
+Couriers are what Hertz uses to deliver notifications to your users. For
+instance, you might have a courier for delivering notifications by SMS and
+another one for delivering them by email.
+
+Creating a new courier in Hertz is easy:
+
+```ruby
+module Hertz
+  module Courier
+    class Sms
+      def self.deliver_notification(notification)
+        # ...
+      end
+    end
+  end
+end
+```
+
+Again, you don't have to use couriers if you only display notifications on your
+website using standard AR methods.
+
+### Creating new notification types
+
+In Hertz, every notification is a model. If you want to create a new
+notification type, just create a new model inheriting from
+`Hertz::Notification`:
+
+```ruby
+class CommentNotification < Hertz::Notification
+end
+```
+Since not all notifications might implement interfaces for all couriers, you
+have to manually specify which couriers they implement via `deliver_by`:
+
+```ruby
+class CommentNotification < Hertz::Notification
+  deliver_by :sms, :email
+end
+```
+
+Notifications are not required to implement any couriers.
+
+### Attaching metadata to a notification
+
+You can attach custom metadata to a notification, but make sure it can be
+cleanly stored in an hstore:
+
+```ruby
+notification = CommentNotification.new(meta: { comment_id: comment.id })
+user.notify(notification)
+```
+
+You can then unserialize any data in the model:
+
+```ruby
+class CommentNotification < Hertz::Notification
+  def comment
+    Comment.find(meta['comment_id'])
+  end
+end
+```
+
+Note that you should always access your metadata with string keys, regardless of
+the type you use when attaching it.
+
+### Notifying users
+
+You can use `#notify` for notifying a user:
+
+```ruby
+notification = CommentNotification.new
+user.notify(notification)
+```
+
+You can access a user's notifications with `#notifications`:
+
+```ruby
+current_user.notifications
+current_user.notifications.unread
+```
+
+You can also mark notifications as read/unread:
+
+```ruby
+notification.mark_as_read
+notification.mark_as_unread
+```
+
+## Built-in couriers
+
+### Email
+
+The email courier delivers your notifications by email. 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
+```
+
+You will also need to expose the `hertz_email` method in your receiver class:
+
+```ruby
+class User < ActiveRecord::Base
+  def hertz_email
+    email
+  end
+end
+```
+
+And 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/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.
+
+## 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,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/assets/javascripts/hertz/application.js

@@ -0,0 +1,13 @@
+// This is a manifest file that'll be compiled into application.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or any plugin's vendor/assets/javascripts directory can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// compiled file.
+//
+// Read Sprockets README (https://github.com/rails/sprockets#sprockets-directives) for details
+// about supported directives.
+//
+//= require_tree .

data/app/assets/stylesheets/hertz/application.css

@@ -0,0 +1,15 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the bottom of the
+ * compiled file so the styles you add here take precedence over styles defined in any styles
+ * defined in the other CSS/SCSS files in this directory. It is generally better to create a new
+ * file per style scope.
+ *
+ *= require_tree .
+ *= require_self
+ */

data/app/controllers/hertz/application_controller.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+module Hertz
+  class ApplicationController < ActionController::Base
+    protect_from_forgery with: :exception
+  end
+end

data/app/helpers/hertz/application_helper.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+module Hertz
+  module ApplicationHelper
+  end
+end

data/app/mailers/hertz/notification_mailer.rb

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

data/app/models/hertz/notification.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+module Hertz
+  class Notification < ActiveRecord::Base
+    @couriers = []
+
+    scope :unread, -> { where 'read_at IS NULL' }
+
+    belongs_to :receiver, inverse_of: :notifications, polymorphic: true
+
+    after_create :deliver
+
+    class << self
+      def couriers
+        @couriers ||= []
+      end
+
+      protected
+
+      def deliver_by(*couriers)
+        @couriers = couriers.flatten.map(&:to_sym)
+      end
+    end
+
+    def read?
+      read_at.present?
+    end
+
+    def unread?
+      read_at.nil?
+    end
+
+    def mark_as_read
+      update read_at: Time.zone.now
+    end
+
+    def mark_as_unread
+      update read_at: nil
+    end
+
+    private
+
+    def deliver
+      Hertz::NotificationDeliverer.deliver(self)
+    end
+  end
+end

data/app/views/layouts/hertz/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Hertz</title>
+  <%= stylesheet_link_tag    "hertz/application", media: "all" %>
+  <%= javascript_include_tag "hertz/application" %>
+  <%= csrf_meta_tags %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/config/routes.rb

@@ -0,0 +1,2 @@
+Hertz::Engine.routes.draw do
+end

data/db/migrate/20160415174901_create_hertz_notifications.rb

@@ -0,0 +1,14 @@
+class CreateHertzNotifications < ActiveRecord::Migration
+  def change
+    enable_extension 'hstore'
+
+    create_table :hertz_notifications do |t|
+      t.string :type, null: false
+      t.string :receiver_type, null: false
+      t.integer :receiver_id, null: false
+      t.hstore :meta, default: {}, null: false
+      t.datetime :read_at
+      t.datetime :created_at, null: false
+    end
+  end
+end

data/lib/generators/hertz/install_generator.rb

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

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

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

data/lib/hertz.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+require 'hertz/engine'
+
+require 'hertz/notifiable'
+require 'hertz/notification_deliverer'
+require 'hertz/courier/base'
+require 'hertz/courier/email'
+
+module Hertz
+  mattr_writer :base_mailer
+
+  def self.configure(&block)
+    block.call(self)
+  end
+
+  def self.base_mailer
+    (@@base_mailer || '::ApplicationMailer').constantize
+  end
+end

data/lib/hertz/courier/base.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module Hertz
+  module Courier
+    class Base
+      def self.deliver_notification(_notification)
+        fail NotImplementedError
+      end
+    end
+  end
+end