hertz 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0988dec23d3f623853e523c7fc2e6f530c6dcdc2
-  data.tar.gz: fd300b90871a186b9068f6c94002631c21b928af
+  metadata.gz: 2eef5fc7cb19de80f84d964b0f2d6a537b9abd5b
+  data.tar.gz: 670e53a7387981df2a9bec8983f8e10b4660050a
 SHA512:
-  metadata.gz: 6145eb3c0c8e18ec36dcbcc6901b4003e8d863ec11b60031ca4fe895a752fee78f96197f35c2b9282b8d75bf6c42d203e84797946608adbdeac3ff6e66fb33e1
-  data.tar.gz: e1cfa1891739d7658eb1ad98089d4294f6491ed602ca4a349ba5e35e8ce84486686c329bd448f8331c61433dc6081c3efb34a51e618c163e21da5c296292ebab
+  metadata.gz: 59110519a6b34162d8a194bb4f17dec3c5eb1607c79d211f3ed3c0cb329a9c59a805424bbf9515dbc57e8cc7ae8149182414049a8aab58be7b393da6b66cbdf9
+  data.tar.gz: ae85c1e2303752f2f8414028cbb386894c8f84f41f82cf68177a8a854a908b69650d8563a964b25dd98b7cf0b305e172a5323370eff0eae988b2b9aa75cff360

data/README.md

@@ -1,9 +1,10 @@
 # Hertz
 
+[![Gem Version](https://badge.fury.io/rb/hertz.svg)](https://badge.fury.io/rb/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.
+Hertz is a Ruby on Rails engine for sending in-app notifications to your users.
 
 ## Installation
 
@@ -133,49 +134,12 @@ notification.mark_as_read
 notification.mark_as_unread
 ```
 
-## Built-in couriers
+## Other 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.
+- [hertz-courier-twilio](https://github.com/alessandro1997/hertz-courier-twilio):
+  delivers notifications by SMS with the Twilio API.
+- [hertz-courier-email](https://github.com/alessandro1997/hertz-courier-email):
+  delivers notifications by email with ActionMailer.
 
 ## Contributing
 
@@ -186,3 +150,10 @@ https://github.com/alessandro1997/hertz.
 
 The gem is available as open source under the terms of the
 [MIT License](http://opensource.org/licenses/MIT).
+
+## To do
+
+- [ ] Test `Hertz.configure`
+- [ ] Allow setting common couriers for all notifications
+- [ ] Validate couriers when calling `Hertz::Notifiable.deliver_by`
+- [ ] Extract `Hertz::Courier::Email` into a separate gem

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

@@ -1,5 +1,3 @@
 # 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/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module Hertz
-  VERSION = '0.1.0'
+  VERSION = '1.0.0'
 end

data/lib/hertz.rb

@@ -3,17 +3,9 @@ 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/spec/dummy/app/models/test_notification.rb

@@ -1,7 +1,2 @@
 class TestNotification < Hertz::Notification
-  deliver_by :email
-
-  def email_subject
-    'Test Notification'
-  end
 end

data/spec/dummy/config/database.yml

@@ -1,14 +1,8 @@
-# SQLite version 3.x
-#   gem install sqlite3
-#
-#   Ensure the SQLite 3 gem is defined in your Gemfile
-#   gem 'sqlite3'
-#
 default: &default
   adapter: postgresql
   host: localhost
   username: postgres
-  password: alacritate
+  password: postgres
   pool: 5
   timeout: 5000
 
@@ -16,9 +10,6 @@ development:
   <<: *default
   database: hertz_development
 
-# Warning: The database defined as "test" will be erased and
-# re-generated from your development database when you run "rake".
-# Do not set this db to the same as development or production.
 test:
   <<: *default
   database: hertz_test

data/spec/dummy/config/initializers/hertz.rb

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

data/spec/dummy/db/migrate/20160508094342_remove_email_from_users.rb

@@ -0,0 +1,5 @@
+class RemoveEmailFromUsers < ActiveRecord::Migration
+  def change
+    remove_column :users, :email, :string
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,7 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20160418122437) do
+ActiveRecord::Schema.define(version: 20160508094342) do
 
   # These are extensions that must be enabled in order to support this database
   enable_extension "plpgsql"
@@ -29,7 +29,6 @@ ActiveRecord::Schema.define(version: 20160418122437) do
   create_table "users", force: :cascade do |t|
     t.datetime "created_at", null: false
     t.datetime "updated_at", null: false
-    t.string   "email",      null: false
   end
 
 end

data/spec/dummy/log/development.log

@@ -1,103 +1,32 @@
-   (4.6ms)  CREATE TABLE "schema_migrations" ("version" character varying NOT NULL) 
-   (2.1ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
+  SQL (0.3ms)  CREATE EXTENSION IF NOT EXISTS "plpgsql"
+  SQL (31.9ms)  CREATE EXTENSION IF NOT EXISTS "hstore"
+   (21.0ms)  CREATE TABLE "hertz_notifications" ("id" serial primary key, "type" character varying NOT NULL, "receiver_type" character varying NOT NULL, "receiver_id" integer NOT NULL, "meta" hstore DEFAULT '' NOT NULL, "read_at" timestamp, "created_at" timestamp NOT NULL) 
+   (6.6ms)  CREATE TABLE "users" ("id" serial primary key, "created_at" timestamp NOT NULL, "updated_at" timestamp NOT NULL, "email" character varying NOT NULL) 
+   (7.9ms)  CREATE TABLE "schema_migrations" ("version" character varying NOT NULL) 
+   (8.2ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
+   (0.7ms)  SELECT version FROM "schema_migrations"
+   (1.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20160418122437')
+   (1.4ms)  INSERT INTO "schema_migrations" (version) VALUES ('20160415175837')
+   (1.8ms)  INSERT INTO "schema_migrations" (version) VALUES ('20160415175358')
+  SQL (0.5ms)  CREATE EXTENSION IF NOT EXISTS "plpgsql"
+  SQL (24.4ms)  CREATE EXTENSION IF NOT EXISTS "hstore"
+   (16.8ms)  CREATE TABLE "hertz_notifications" ("id" serial primary key, "type" character varying NOT NULL, "receiver_type" character varying NOT NULL, "receiver_id" integer NOT NULL, "meta" hstore DEFAULT '' NOT NULL, "read_at" timestamp, "created_at" timestamp NOT NULL) 
+   (10.0ms)  CREATE TABLE "users" ("id" serial primary key, "created_at" timestamp NOT NULL, "updated_at" timestamp NOT NULL, "email" character varying NOT NULL) 
+   (9.3ms)  CREATE TABLE "schema_migrations" ("version" character varying NOT NULL) 
+   (13.5ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
+   (1.0ms)  SELECT version FROM "schema_migrations"
+   (1.2ms)  INSERT INTO "schema_migrations" (version) VALUES ('20160418122437')
+   (1.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20160415175837')
+   (1.2ms)  INSERT INTO "schema_migrations" (version) VALUES ('20160415175358')
   ActiveRecord::SchemaMigration Load (0.4ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-  SQL (0.4ms)  CREATE EXTENSION IF NOT EXISTS "plpgsql"
-   (0.4ms)  SELECT version FROM "schema_migrations"
-   (0.7ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
-  SQL (0.6ms)  CREATE EXTENSION IF NOT EXISTS "plpgsql"
-   (4.8ms)  CREATE TABLE "schema_migrations" ("version" character varying NOT NULL) 
-   (2.2ms)  CREATE UNIQUE INDEX  "unique_schema_migrations" ON "schema_migrations"  ("version")
-   (0.3ms)  SELECT version FROM "schema_migrations"
-   (0.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('0')
-  ActiveRecord::SchemaMigration Load (0.5ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-  ActiveRecord::SchemaMigration Load (0.5ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-Migrating to CreateHertzNotifications (20160415175229)
-   (0.3ms)  BEGIN
-   (6.6ms)  CREATE TABLE "hertz_notifications" ("id" serial primary key, "type" character varying NOT NULL, "receiver_type" character varying NOT NULL, "receiver_id" integer NOT NULL, "meta" json NOT NULL, "read_at" timestamp, "created_at" timestamp NOT NULL) 
-  SQL (0.4ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20160415175229"]]
-   (1.3ms)  COMMIT
-  ActiveRecord::SchemaMigration Load (1.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-   (5.1ms)  SELECT t2.oid::regclass::text AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete
-FROM pg_constraint c
-JOIN pg_class t1 ON c.conrelid = t1.oid
-JOIN pg_class t2 ON c.confrelid = t2.oid
-JOIN pg_attribute a1 ON a1.attnum = c.conkey[1] AND a1.attrelid = t1.oid
-JOIN pg_attribute a2 ON a2.attnum = c.confkey[1] AND a2.attrelid = t2.oid
-JOIN pg_namespace t3 ON c.connamespace = t3.oid
-WHERE c.contype = 'f'
-  AND t1.relname = 'hertz_notifications'
-  AND t3.nspname = ANY (current_schemas(false))
-ORDER BY c.conname
-
-  ActiveRecord::SchemaMigration Load (0.5ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.6ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Migrating to RemoveEmailFromUsers (20160508094342)
+   (0.4ms)  BEGIN
+   (0.8ms)  ALTER TABLE "users" DROP "email"
+  SQL (0.5ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20160508094342"]]
+   (2.8ms)  COMMIT
   ActiveRecord::SchemaMigration Load (0.3ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-Migrating to CreateHertzNotifications (20160415175229)
-   (0.2ms)  BEGIN
-   (1.6ms)  DROP TABLE "hertz_notifications"
-  SQL (0.5ms)  DELETE FROM "schema_migrations" WHERE "schema_migrations"."version" = $1  [["version", "20160415175229"]]
-   (1.2ms)  COMMIT
-  ActiveRecord::SchemaMigration Load (0.7ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-  ActiveRecord::SchemaMigration Load (0.5ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-Migrating to CreateHertzNotifications (20160415175358)
-   (0.2ms)  BEGIN
-  SQL (19.0ms)  CREATE EXTENSION IF NOT EXISTS "hstore"
-   (9.6ms)  CREATE TABLE "hertz_notifications" ("id" serial primary key, "type" character varying NOT NULL, "receiver_type" character varying NOT NULL, "receiver_id" integer NOT NULL, "meta" hstore DEFAULT '' NOT NULL, "read_at" timestamp, "created_at" timestamp NOT NULL) 
-  SQL (0.5ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20160415175358"]]
-   (3.4ms)  COMMIT
-  ActiveRecord::SchemaMigration Load (0.5ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-   (2.0ms)  SELECT t2.oid::regclass::text AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete
-FROM pg_constraint c
-JOIN pg_class t1 ON c.conrelid = t1.oid
-JOIN pg_class t2 ON c.confrelid = t2.oid
-JOIN pg_attribute a1 ON a1.attnum = c.conkey[1] AND a1.attrelid = t1.oid
-JOIN pg_attribute a2 ON a2.attnum = c.confkey[1] AND a2.attrelid = t2.oid
-JOIN pg_namespace t3 ON c.connamespace = t3.oid
-WHERE c.contype = 'f'
-  AND t1.relname = 'hertz_notifications'
-  AND t3.nspname = ANY (current_schemas(false))
-ORDER BY c.conname
-
-  ActiveRecord::SchemaMigration Load (0.8ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-Migrating to CreateUsers (20160415175837)
-   (0.2ms)  BEGIN
-   (3.4ms)  CREATE TABLE "users" ("id" serial primary key, "created_at" timestamp NOT NULL, "updated_at" timestamp NOT NULL) 
-  SQL (0.6ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20160415175837"]]
-   (1.8ms)  COMMIT
-  ActiveRecord::SchemaMigration Load (0.7ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-   (2.1ms)  SELECT t2.oid::regclass::text AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete
-FROM pg_constraint c
-JOIN pg_class t1 ON c.conrelid = t1.oid
-JOIN pg_class t2 ON c.confrelid = t2.oid
-JOIN pg_attribute a1 ON a1.attnum = c.conkey[1] AND a1.attrelid = t1.oid
-JOIN pg_attribute a2 ON a2.attnum = c.confkey[1] AND a2.attrelid = t2.oid
-JOIN pg_namespace t3 ON c.connamespace = t3.oid
-WHERE c.contype = 'f'
-  AND t1.relname = 'hertz_notifications'
-  AND t3.nspname = ANY (current_schemas(false))
-ORDER BY c.conname
-
-   (4.0ms)  SELECT t2.oid::regclass::text AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete
-FROM pg_constraint c
-JOIN pg_class t1 ON c.conrelid = t1.oid
-JOIN pg_class t2 ON c.confrelid = t2.oid
-JOIN pg_attribute a1 ON a1.attnum = c.conkey[1] AND a1.attrelid = t1.oid
-JOIN pg_attribute a2 ON a2.attnum = c.confkey[1] AND a2.attrelid = t2.oid
-JOIN pg_namespace t3 ON c.connamespace = t3.oid
-WHERE c.contype = 'f'
-  AND t1.relname = 'users'
-  AND t3.nspname = ANY (current_schemas(false))
-ORDER BY c.conname
-
-
-Hertz::NotificationMailer#notification_email: processed outbound mail in 5.9ms
-  ActiveRecord::SchemaMigration Load (2.7ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-Migrating to AddEmailToUsers (20160418122437)
-   (0.6ms)  BEGIN
-   (25.4ms)  ALTER TABLE "users" ADD "email" character varying NOT NULL
-  SQL (4.6ms)  INSERT INTO "schema_migrations" ("version") VALUES ($1)  [["version", "20160418122437"]]
-   (5.0ms)  COMMIT
-  ActiveRecord::SchemaMigration Load (0.4ms)  SELECT "schema_migrations".* FROM "schema_migrations"
-   (9.6ms)  SELECT t2.oid::regclass::text AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete
+   (2.8ms)  SELECT t2.oid::regclass::text AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete
 FROM pg_constraint c
 JOIN pg_class t1 ON c.conrelid = t1.oid
 JOIN pg_class t2 ON c.confrelid = t2.oid
@@ -109,7 +38,7 @@ WHERE c.contype = 'f'
   AND t3.nspname = ANY (current_schemas(false))
 ORDER BY c.conname
 
-   (9.2ms)  SELECT t2.oid::regclass::text AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete
+   (2.5ms)  SELECT t2.oid::regclass::text AS to_table, a1.attname AS column, a2.attname AS primary_key, c.conname AS name, c.confupdtype AS on_update, c.confdeltype AS on_delete
 FROM pg_constraint c
 JOIN pg_class t1 ON c.conrelid = t1.oid
 JOIN pg_class t2 ON c.confrelid = t2.oid
@@ -121,16 +50,3 @@ WHERE c.contype = 'f'
   AND t3.nspname = ANY (current_schemas(false))
 ORDER BY c.conname
 
-   (1.0ms)  BEGIN
-  SQL (2.1ms)  INSERT INTO "users" ("email", "created_at", "updated_at") VALUES ($1, $2, $3) RETURNING "id"  [["email", "foo@bar.com"], ["created_at", "2016-04-18 15:52:39.396262"], ["updated_at", "2016-04-18 15:52:39.396262"]]
-   (1.4ms)  COMMIT
-   (0.8ms)  BEGIN
-  SQL (1.9ms)  INSERT INTO "hertz_notifications" ("receiver_id", "receiver_type", "meta", "created_at") VALUES ($1, $2, $3, $4) RETURNING "id"  [["receiver_id", 1], ["receiver_type", "User"], ["meta", "\"foo\"=>\"bar\""], ["created_at", "2016-04-18 15:52:39.426606"]]
-   (0.2ms)  ROLLBACK
-   (0.3ms)  BEGIN
-  SQL (0.4ms)  INSERT INTO "users" ("email", "created_at", "updated_at") VALUES ($1, $2, $3) RETURNING "id"  [["email", "foo@bar.com"], ["created_at", "2016-04-18 15:52:50.303993"], ["updated_at", "2016-04-18 15:52:50.303993"]]
-   (0.7ms)  COMMIT
-   (0.2ms)  BEGIN
-  SQL (0.9ms)  INSERT INTO "hertz_notifications" ("type", "receiver_id", "receiver_type", "meta", "created_at") VALUES ($1, $2, $3, $4, $5) RETURNING "id"  [["type", "Hertz::Notification"], ["receiver_id", 2], ["receiver_type", "User"], ["meta", "\"foo\"=>\"bar\""], ["created_at", "2016-04-18 15:52:50.307752"]]
-   (0.5ms)  COMMIT
-  Hertz::Notification Load (0.9ms)  SELECT  "hertz_notifications".* FROM "hertz_notifications"  ORDER BY "hertz_notifications"."id" DESC LIMIT 1