user_notifier 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15379a4699aae37560c32fb9dce2e882817893b7
-  data.tar.gz: fa27fd436b429727aeb069eda60ae2b0759cc489
+  metadata.gz: 962bf40c71ba6c53d8295649321c24be3121e235
+  data.tar.gz: 00d063c185a4135daade55cc0cb00fbb7774711b
 SHA512:
-  metadata.gz: a03d4da19d187480440b1987f394d7ca2ea7151cca55775f671447c1b8bc65ace63d3935c9c8859a9d3d82caa8a2b6054122a467e094f095c08d2de90062e5ce
-  data.tar.gz: 578fe31fb523895df0fde321e757844338b8d4baa4d28a445c4057b66aa8d1b866c68681acac8050ae4fb1d9ec9b95937f4b2369645da330dc880df19eb1e0da
+  metadata.gz: b4f8191e482b2e57cd4f9c4e152935edbde8a916e2e7756effff3c58346b615024a8c37c07a333fd346be5172c4efcff58840a57d74af081b02c12b60e0b8107
+  data.tar.gz: bb017c0c6cd815b97b586108781c806410471da0c20f9b43cf2ea68f59f919a16d95941fb565d768b6a0176fcf6559d3795b63453839aeb8a8de28b931cbeb69

data/app/mailers/user_notifier/{base_mailer.rb → mailer.rb}

@@ -1,11 +1,11 @@
-class UserNotifier::BaseMailer < ActionMailer::Base
+class UserNotifier::Mailer < ActionMailer::Base
   layout UserNotifier.email_layout
 
   def notify(notification)
     @notification = notification
     old_locale = I18n.locale
     I18n.locale = @notification.locale
-    subject = render_to_string(template: "notifications_mailer/subjects/#{@notification.template_name}")
+    subject = render_to_string(template: "user_notifier/mailer/#{@notification.template_name}_subject")
     m = mail({
       from: address_format(UserNotifier.system_email, @notification.from_name),
       reply_to: address_format(@notification.from_email, @notification.from_name),

data/app/models/user_notifier/base.rb

@@ -1,17 +1,19 @@
 class UserNotifier::Base < ActiveRecord::Base
   self.abstract_class = true
-  belongs_to UserNotifier.user_class_name
 
-  def self.notify_once(template_name, user, filter, params = {})
-    notify(template_name, user, params) if is_unique?(template_name, filter)
+  def self.notify_once(template_name, user, source = nil, params = {})
+    notify(template_name, user, source, params) if is_unique?(template_name, {self.user_association_name => user})
   end
 
-  def self.notify(template_name, user, params = {})
+  def self.notify(template_name, user, source = nil, params = {})
+    source ||= user
     create!({
       template_name: template_name,
       locale: I18n.locale,
       from_email: UserNotifier.from_email,
-      from_name: UserNotifier.from_name
+      from_name: UserNotifier.from_name,
+      source: source,
+      self.user_association_name => user
     }.merge(params)).tap{|n| n.deliver }
   end
 
@@ -21,10 +23,15 @@ class UserNotifier::Base < ActiveRecord::Base
 
   def deliver!
     UserNotifier::EmailWorker.perform_async(self.class.name.to_s, self.id)
-    self.update_attributes sent_at: Time.now()
   end
 
   private
+  def self.user_association_name
+    UserNotifier.user_class_name.downcase.to_sym
+  end
+
+  belongs_to user_association_name
+
   def self.is_unique?(template_name, filter)
     filter.nil? || self.where(filter.merge(template_name: template_name)).empty?
   end

data/app/workers/user_notifier/email_worker.rb

@@ -18,6 +18,6 @@ class UserNotifier::EmailWorker
   end
 
   def mailer
-    UserNotifier::BaseMailer
+    UserNotifier::Mailer
   end
 end

data/lib/generators/user_notifier/notification/USAGE

@@ -0,0 +1,2 @@
+Description:
+  Generates migration for notification model.

data/lib/generators/user_notifier/notification/notification_generator.rb

@@ -0,0 +1,26 @@
+require 'rails/generators/active_record'
+
+module UserNotifier
+  module Generators
+    class NotificationGenerator < ActiveRecord::Generators::Base
+      source_root File.expand_path(File.join(File.dirname(__FILE__), 'templates'))
+
+      def notifications_table_name
+        "#{table_name.singularize}_notifications"
+      end
+
+      def copy_migration
+        migration_template "migration.rb", "db/migrate/create_#{notifications_table_name}.rb"
+      end
+
+      private
+      def user_model_name
+        UserNotifier.user_class_name.downcase
+      end
+
+      def is_user_model?
+        table_name.singularize == user_model_name
+      end
+    end
+  end
+end

data/lib/generators/user_notifier/notification/templates/migration.rb

@@ -0,0 +1,13 @@
+class Create<%= notifications_table_name.camelize %> < ActiveRecord::Migration
+  def change
+    create_table :<%= notifications_table_name %> do |t|
+      t.integer :<%= user_model_name %>_id, null: false
+      <%= "t.integer :#{table_name.singularize}_id, null: false" unless is_user_model? %>
+      t.text :from_email, null: false
+      t.text :from_name, null: false
+      t.text :template_name, null: false
+      t.text :locale, null: false
+      t.timestamp :sent_at
+    end
+  end
+end

data/lib/user_notifier/configuration.rb

@@ -4,7 +4,7 @@ module UserNotifier
 
     DEFAULT_SYSTEM_EMAIL      = nil
     DEFAULT_EMAIL_LAYOUT      = 'email'
-    DEFAULT_USER_CLASS_NAME   = :user
+    DEFAULT_USER_CLASS_NAME   = 'User'
     DEFAULT_FROM_EMAIL        = 'no-reply@yourdomain'
     DEFAULT_FROM_NAME         = 'please configure a default from name'
 

data/lib/user_notifier/models/has_notifications.rb

@@ -3,9 +3,16 @@ module UserNotifier
     extend ActiveSupport::Concern
 
     included do
-      def notify template_name, user=nil
+      def notify template_name, user=nil, source=nil, params={}
         user ||= self
-        self.notifications.notify(template_name, user)
+        source ||= self
+        self.notifications.notify(template_name, user, source, params)
+      end
+
+      def notify_once template_name, user=nil, source=nil, params={}
+        user ||= self
+        source ||= self
+        self.notifications.notify_once(template_name, user, source, params)
       end
     end
 
@@ -13,7 +20,7 @@ module UserNotifier
       private
       def set_association
         create_notification_class
-        self.has_many :notifications, class_name: notification_class_name
+        self.has_many :notifications, class_name: notification_class_name, dependent: :destroy
       end
 
       def notification_class_name
@@ -27,6 +34,12 @@ module UserNotifier
             self.table_name = base_class_name.tableize
           end
           self.parent.const_set base_class_name, klass
+
+          source_name = self.table_name.singularize
+          if self.model_name.to_s.downcase != UserNotifier.user_class_name.downcase
+            klass.belongs_to source_name.to_sym, inverse_of: :notifications
+          end
+          klass.belongs_to :source, class_name: self.model_name.to_s, foreign_key: "#{source_name}_id", inverse_of: :notifications
         end
       end
     end

data/lib/user_notifier/version.rb

@@ -1,3 +1,3 @@
 module UserNotifier
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/dummy/app/models/order.rb

@@ -0,0 +1,3 @@
+class Order < ActiveRecord::Base
+  has_notifications
+end

data/spec/dummy/db/migrate/20140709164530_create_orders.rb

@@ -0,0 +1,10 @@
+class CreateOrders < ActiveRecord::Migration
+  def change
+    create_table :orders do |t|
+      t.integer :user_id
+      t.text :title
+
+      t.timestamps
+    end
+  end
+end

data/spec/dummy/db/migrate/20140709170259_create_order_notifications.rb

@@ -0,0 +1,13 @@
+class CreateOrderNotifications < ActiveRecord::Migration
+  def change
+    create_table :order_notifications do |t|
+      t.integer :user_id, null: false
+      t.integer :order_id, null: false
+      t.text :from_email, null: false
+      t.text :from_name, null: false
+      t.text :template_name, null: false
+      t.text :locale, null: false
+      t.timestamp :sent_at
+    end
+  end
+end

data/spec/dummy/db/schema.rb

@@ -11,7 +11,24 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema.define(version: 20140625183616) do
+ActiveRecord::Schema.define(version: 20140709170259) do
+
+  create_table "order_notifications", force: true do |t|
+    t.integer  "user_id",       null: false
+    t.integer  "order_id",      null: false
+    t.text     "from_email",    null: false
+    t.text     "from_name",     null: false
+    t.text     "template_name", null: false
+    t.text     "locale",        null: false
+    t.datetime "sent_at"
+  end
+
+  create_table "orders", force: true do |t|
+    t.integer  "user_id"
+    t.text     "title"
+    t.datetime "created_at"
+    t.datetime "updated_at"
+  end
 
   create_table "user_notifications", force: true do |t|
     t.integer  "user_id"

data/spec/dummy/log/development.log

@@ -31,3 +31,79 @@ Migrating to CreateUserNotifications (20140625183616)
    (0.2ms)  SELECT version FROM "schema_migrations"
    (166.5ms)  INSERT INTO "schema_migrations" (version) VALUES ('20140625183616')
    (178.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20140625163719')
+  ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+  ActiveRecord::SchemaMigration Load (0.3ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+   (350.4ms)  CREATE TABLE "user_notifications" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "user_id" integer, "from_email" text, "from_name" text, "template_name" text, "locale" text, "sent_at" datetime) 
+   (165.6ms)  CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" text, "email" text, "created_at" datetime, "updated_at" datetime) 
+   (167.7ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.2ms)  select sqlite_version(*)
+   (154.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.3ms)  SELECT version FROM "schema_migrations"
+   (154.9ms)  INSERT INTO "schema_migrations" (version) VALUES ('20140625183616')
+   (167.1ms)  INSERT INTO "schema_migrations" (version) VALUES ('20140625163719')
+  ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Migrating to CreateOrders (20140709164530)
+   (0.1ms)  begin transaction
+   (0.6ms)  CREATE TABLE "orders" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "user_id" integer, "title" text, "created_at" datetime, "updated_at" datetime) 
+  SQL (0.2ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20140709164530"]]
+   (205.2ms)  commit transaction
+  ActiveRecord::SchemaMigration Load (0.1ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+   (154.0ms)  CREATE TABLE "orders" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "user_id" integer, "title" text, "created_at" datetime, "updated_at" datetime) 
+   (165.5ms)  CREATE TABLE "user_notifications" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "user_id" integer, "from_email" text, "from_name" text, "template_name" text, "locale" text, "sent_at" datetime) 
+   (165.5ms)  CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" text, "email" text, "created_at" datetime, "updated_at" datetime) 
+   (167.7ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.2ms)  select sqlite_version(*)
+   (165.7ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.4ms)  SELECT version FROM "schema_migrations"
+   (166.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('20140709164530')
+   (166.9ms)  INSERT INTO "schema_migrations" (version) VALUES ('20140625183616')
+   (189.6ms)  INSERT INTO "schema_migrations" (version) VALUES ('20140625163719')
+  ActiveRecord::SchemaMigration Load (0.2ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+Migrating to CreateOrderNotifications (20140709170259)
+   (0.1ms)  begin transaction
+   (0.6ms)  CREATE TABLE "order_notifications" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "user_id" integer NOT NULL, "order_id" integer NOT NULL, "from_email" text NOT NULL, "from_name" text NOT NULL, "template_name" text NOT NULL, "locale" text NOT NULL, "sent_at" datetime) 
+  SQL (0.3ms)  INSERT INTO "schema_migrations" ("version") VALUES (?)  [["version", "20140709170259"]]
+   (183.2ms)  commit transaction
+  ActiveRecord::SchemaMigration Load (0.3ms)  SELECT "schema_migrations".* FROM "schema_migrations"
+   (168.3ms)  CREATE TABLE "order_notifications" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "user_id" integer NOT NULL, "order_id" integer NOT NULL, "from_email" text NOT NULL, "from_name" text NOT NULL, "template_name" text NOT NULL, "locale" text NOT NULL, "sent_at" datetime) 
+   (165.5ms)  CREATE TABLE "orders" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "user_id" integer, "title" text, "created_at" datetime, "updated_at" datetime) 
+   (143.2ms)  CREATE TABLE "user_notifications" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "user_id" integer, "from_email" text, "from_name" text, "template_name" text, "locale" text, "sent_at" datetime) 
+   (143.2ms)  CREATE TABLE "users" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "name" text, "email" text, "created_at" datetime, "updated_at" datetime) 
+   (143.8ms)  CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL) 
+   (0.2ms)  select sqlite_version(*)
+   (143.5ms)  CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version")
+   (0.4ms)  SELECT version FROM "schema_migrations"
+   (154.8ms)  INSERT INTO "schema_migrations" (version) VALUES ('20140709170259')
+   (166.9ms)  INSERT INTO "schema_migrations" (version) VALUES ('20140709164530')
+   (167.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('20140625183616')
+   (167.0ms)  INSERT INTO "schema_migrations" (version) VALUES ('20140625163719')
+  User Load (1.8ms)  SELECT "users".* FROM "users"
+   (0.2ms)  begin transaction
+  SQL (0.5ms)  INSERT INTO "users" ("created_at", "email", "updated_at") VALUES (?, ?, ?)  [["created_at", "2014-07-09 21:02:55.250061"], ["email", "teste@gmail.com"], ["updated_at", "2014-07-09 21:02:55.250061"]]
+   (174.8ms)  commit transaction
+  User Load (0.4ms)  SELECT  "users".* FROM "users"   ORDER BY "users"."id" ASC LIMIT 1
+   (0.2ms)  begin transaction
+  SQL (0.4ms)  INSERT INTO "orders" ("created_at", "title", "updated_at", "user_id") VALUES (?, ?, ?, ?)  [["created_at", "2014-07-09 21:03:20.607453"], ["title", "teste"], ["updated_at", "2014-07-09 21:03:20.607453"], ["user_id", 1]]
+   (138.1ms)  commit transaction
+  OrderNotification Load (0.2ms)  SELECT "order_notifications".* FROM "order_notifications"  WHERE "order_notifications"."order_id" = ?  [["order_id", 1]]
+   (0.2ms)  begin transaction
+  SQL (0.8ms)  INSERT INTO "order_notifications" ("from_email", "from_name", "locale", "order_id", "template_name", "user_id") VALUES (?, ?, ?, ?, ?, ?)  [["from_email", "no-reply@yourdomain"], ["from_name", "please configure a default from name"], ["locale", "en"], ["order_id", 1], ["template_name", "test"], ["user_id", 1]]
+   (186.2ms)  commit transaction
+  OrderNotification Load (0.5ms)  SELECT "order_notifications".* FROM "order_notifications"
+  OrderNotification Load (0.6ms)  SELECT "order_notifications".* FROM "order_notifications"
+  OrderNotification Load (0.5ms)  SELECT  "order_notifications".* FROM "order_notifications"   ORDER BY "order_notifications"."id" ASC LIMIT 1
+  OrderNotification Load (0.6ms)  SELECT  "order_notifications".* FROM "order_notifications"   ORDER BY "order_notifications"."id" ASC LIMIT 1
+  OrderNotification Load (0.6ms)  SELECT  "order_notifications".* FROM "order_notifications"   ORDER BY "order_notifications"."id" ASC LIMIT 1
+  OrderNotification Load (0.5ms)  SELECT  "order_notifications".* FROM "order_notifications"   ORDER BY "order_notifications"."id" ASC LIMIT 1
+  OrderNotification Load (0.4ms)  SELECT  "order_notifications".* FROM "order_notifications"   ORDER BY "order_notifications"."id" ASC LIMIT 1
+  Order Load (0.6ms)  SELECT  "orders".* FROM "orders"   ORDER BY "orders"."id" ASC LIMIT 1
+  Order Load (0.6ms)  SELECT  "orders".* FROM "orders"   ORDER BY "orders"."id" ASC LIMIT 1
+  OrderNotification Load (0.3ms)  SELECT "order_notifications".* FROM "order_notifications"  WHERE "order_notifications"."order_id" = ?  [["order_id", 1]]
+  Order Load (0.2ms)  SELECT  "orders".* FROM "orders"   ORDER BY "orders"."id" ASC LIMIT 1
+  OrderNotification Load (0.3ms)  SELECT "order_notifications".* FROM "order_notifications"  WHERE "order_notifications"."order_id" = ?  [["order_id", 1]]
+  Order Load (0.3ms)  SELECT  "orders".* FROM "orders"   ORDER BY "orders"."id" ASC LIMIT 1
+  OrderNotification Load (0.6ms)  SELECT  "order_notifications".* FROM "order_notifications"  WHERE "order_notifications"."order_id" = ?  ORDER BY "order_notifications"."id" ASC LIMIT 1  [["order_id", 1]]
+  Order Load (0.6ms)  SELECT  "orders".* FROM "orders"  WHERE "orders"."id" = ? LIMIT 1  [["id", 1]]
+  Order Load (0.3ms)  SELECT  "orders".* FROM "orders"   ORDER BY "orders"."id" ASC LIMIT 1
+  OrderNotification Load (0.3ms)  SELECT  "order_notifications".* FROM "order_notifications"  WHERE "order_notifications"."order_id" = ?  ORDER BY "order_notifications"."id" ASC LIMIT 1  [["order_id", 1]]
+  Order Load (0.7ms)  SELECT  "orders".* FROM "orders"  WHERE "orders"."id" = ? LIMIT 1  [["id", 1]]