tolliver 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6b51e98fd8b3ff0cdfbb2a9e4c3461367d91e84603b8f0dbc173520c34d2625e
+  data.tar.gz: 2cfc09c23fc2e2911c3c6c0bb6f3095a6a929c513fc837e23e9043614dc6682d
+SHA512:
+  metadata.gz: bb9d2b1a57c832ee8b6d24859ada4760bc5b8405c799df7dc28ca252b7bb8dd5cc8a3fdb92df530cc2d12e16072bd49afc1f041eddb7f27c409fe25da3d9ef6a
+  data.tar.gz: e55ef50ab51b8cc260f3e26c542719109ef2a1518dc775b6c2541b0a0d474dd1263894d973ac40784f70e028a9e35751c5502519b56aa62f779b2088fb8bb462

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 Matěj Outlý
+
+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,56 @@
+# Tolliver
+A long serving Junior Postman Tolliver Groat. With this gem you can create 
+notifications based on templates defined by the system administrator and 
+send it in a batch with different delivery methods:
+
+- E-mail
+- SMS
+- Whatever custom delivery method
+
+## Installation
+
+Add gem to your Gemfile:
+
+```ruby
+gem "tolliver"
+```
+
+Add database migrations to you application (you can modify DB structure accordingly before migrating):
+
+    $ rake tolliver:install:migrations
+    $ rake db:migrate
+
+## Configuration
+
+You can configure module through `config/initializers/tolliver.rb` file:
+
+```ruby
+Tolliver.setup do |config|
+  config.mailer_sender = "no-reply@domain.com"
+  config.delivery_kinds = [
+      :email
+  ]
+  config.template_refs = [
+      :user_new_password,
+  ]
+end
+```
+
+Available options:
+
+- notification_model
+- notification_delivery_model
+- notification_receiver_model
+- notification_template_model
+- people_selector_model
+- mailer_sender
+- delivery_kinds
+- template_refs
+
+## Usage
+
+To enter new notification into the system, just call `notify` method:
+
+```ruby
+Tolliver.notify([:sample_notification_ref, param_1, param_2], [receiver_1, receiver_2], options)
+```

data/app/mailers/tolliver/notification_mailer.rb

@@ -0,0 +1,16 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification mailer
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  class NotificationMailer < ::ApplicationMailer
+    include Tolliver::Mailers::NotificationMailer
+  end
+end

data/app/models/tolliver/notification.rb

@@ -0,0 +1,17 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  class Notification < ActiveRecord::Base
+    include Tolliver::Utils::Enum
+    include Tolliver::Models::Notification
+  end
+end

data/app/models/tolliver/notification_delivery.rb

@@ -0,0 +1,19 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification receiver
+# *
+# * Author: Matěj Outlý
+# * Date  : 30. 6. 2017
+# *
+# *****************************************************************************
+
+module Tolliver
+  class NotificationDelivery < ActiveRecord::Base
+    include Tolliver::Utils::Enum
+    include Tolliver::Models::NotificationDelivery
+    include Tolliver::Models::NotificationDelivery::Batch
+    include Tolliver::Models::NotificationDelivery::Instantly
+  end
+end

data/app/models/tolliver/notification_receiver.rb

@@ -0,0 +1,19 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification receiver
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  class NotificationReceiver < ActiveRecord::Base
+    include Tolliver::Utils::Enum
+    include Tolliver::Models::NotificationReceiver
+    include Tolliver::Models::NotificationReceiver::Email
+    include Tolliver::Models::NotificationReceiver::Sms
+  end
+end

data/app/models/tolliver/notification_template.rb

@@ -0,0 +1,17 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification template
+# *
+# * Author: Matěj Outlý
+# * Date  : 9. 5. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  class NotificationTemplate < ActiveRecord::Base
+    include Tolliver::Utils::Enum
+    include Tolliver::Models::NotificationTemplate
+  end
+end

data/app/views/notification_mailer/notify.html.erb

@@ -0,0 +1 @@
+<%= @notification.message.html_safe %>

data/app/views/notification_mailer/notify.text.erb

@@ -0,0 +1 @@
+<%= @notification.message.to_s.strip_tags %>

data/config/locales/cs.yml

@@ -0,0 +1,86 @@
+cs:
+  activerecord:
+    attributes:
+      tolliver/notification:
+        created_at: Vytvořeno
+        subject: Předmět
+        message: Obsah
+        url: URL
+        attachment: Příloha
+        kind: Typ zprávy
+        kind_values:
+          notice: Informace
+          alert: Chyba
+          warning: Varování
+        sender: Odesílatel
+        sent_at: Odesláno
+        done: Hotovo
+        deliveries: Metody doručení
+      tolliver/notification_delivery:
+        sent_at: Odesláno
+        done: Hotovo
+        receivers: Příjemci
+        kind: Doručovací metoda
+        kind_values:
+          email: E-mail
+          sms: SMS
+      tolliver/notification_receiver:
+        receiver: Příjemce
+        state: Stav
+        state_values:
+          created: Vytvořeno
+          sent: Odesláno
+          received: Doručeno
+          accepted: Akceptováno
+          error: Chyba
+        state_colors:
+          created: yellow
+          sent: green
+          received: green
+          accepted: green
+          error: red
+        created_at: Vytvořeno
+        sent_at: Odesláno
+        received_at: Doručeno
+      tolliver/notification_template:
+        ref: Klíč
+        subject: Předmět
+        message: Zpráva
+        disabled: Nevytvářet notifikace
+        disabled_values:
+          bool_yes: Nevytvářet
+          bool_no: Vytvářet
+        disabled_colors:
+          bool_yes: red
+          bool_no: green
+        dry: Neodesílat notifikace
+        dry_values:
+          bool_yes: Neodesílat
+          bool_no: Odesílat
+        dry_colors:
+          bool_yes: red
+          bool_no: green
+    notices:
+      models:
+        tolliver/notification:
+          update: Zpráva byla úspěšně uložena.
+          create: Zpráva byla úspěšně vytvořena.
+          enqueue_for_delivery: Zpráva byla úspěšně zařazena k odeslání.
+          destroy: Zpráva byla úspěšně smazána.
+        tolliver/notification_template:
+          update: Šablona zprávy byla úspěšně uložena.
+    errors:
+      models:
+        tolliver/notification:
+          not_found: Zpráva nebyla nalezena.
+        tolliver/notification_delivery:
+          not_found: Doručovací metoda nebyla nalezena.
+        tolliver/notification_receiver:
+          not_found: Příjemce nebyl nalezen.
+        tolliver/notification_template:
+          not_found: Šablona zprávy nebyla nalezena.
+    mailers:
+      tolliver:
+        notification:
+          notify:
+            subject: "%{url}: Nová systémová zpráva"

data/config/locales/en.yml

@@ -0,0 +1,86 @@
+en:
+  activerecord:
+    attributes:
+      tolliver/notification:
+        created_at: Created
+        subject: Subject
+        message: Message
+        url: URL
+        attachment: Attachment
+        kind: Message type
+        kind_values:
+          notice: Information
+          alert: Error
+          warning: Worning
+        sender: Sender
+        sent_at: Sent
+        done: Done
+        deliveries: Methods of delivery
+      tolliver/notification_delivery:
+        sent_at: Sent
+        done: Done
+        receivers: Receivers
+        kind: Delivery type
+        kind_values:
+          email: E-mail
+          sms: SMS
+      tolliver/notification_receiver:
+        receiver: Receiver
+        state: Status
+        state_values:
+          created: Created
+          sent: Sent
+          received: Received
+          accepted: Accepted
+          error: Error
+        state_colors:
+          created: yellow
+          sent: green
+          received: green
+          accepted: green
+          error: red
+        created_at: Created
+        sent_at: Sent
+        received_at: Received
+      tolliver/notification_template:
+        ref: Reference
+        subject: Subject
+        message: Message
+        disabled: Disable notifications
+        disabled_values:
+          bool_yes: Disable
+          bool_no: Enable
+        disabled_colors:
+          bool_yes: red
+          bool_no: green
+        dry: Don't send notifications
+        dry_values:
+          bool_yes: Don't send
+          bool_no: Send
+        dry_colors:
+          bool_yes: red
+          bool_no: green
+    notices:
+      models:
+        tolliver/notification:
+          update: Message was successfully saved.
+          create: Message was successfully created.
+          enqueue_for_delivery: Message was successfully enqueued for delivery.
+          destroy: Message was successfully deleted.
+        tolliver/notification_template:
+          update: Template was successfully saved.
+    errors:
+      models:
+        tolliver/notification:
+          not_found: Message was not found.
+        tolliver/notification_delivery:
+          not_found: Delivery method was not found.
+        tolliver/notification_receiver:
+          not_found: Receier was not found.
+        tolliver/notification_template:
+          not_found: Template was not found.
+    mailers:
+      tolliver:
+        notification:
+          notify:
+            subject: "%{url}: New system notification"

data/config/routes.rb

@@ -0,0 +1,13 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Routes
+# *
+# * Author: Matěj Outlý
+# * Date  : 26. 11. 2015
+# *
+# *****************************************************************************
+
+Tolliver::Engine.routes.draw do
+end

data/db/migrate/20160121093817_create_notifications.rb

@@ -0,0 +1,28 @@
+class CreateNotifications < ActiveRecord::Migration
+  def change
+    create_table :notifications do |t|
+
+      # Timestamps
+      t.timestamps null: true
+
+      # Association to template
+      t.integer :notification_template_id, index: true
+
+      # Kind
+      t.string :kind
+
+      # Message
+      t.string :subject
+      t.text :message
+
+      # Attachments
+      t.string :url
+      t.string :attachment
+
+      # Sender
+      t.integer :sender_id, index: true
+      t.string :sender_type, index: true
+
+    end
+  end
+end

data/db/migrate/20160121094838_create_notification_receivers.rb

@@ -0,0 +1,21 @@
+class CreateNotificationReceivers < ActiveRecord::Migration
+  def change
+    create_table :notification_receivers do |t|
+
+      # Timestamps
+      t.timestamps null: true
+      t.datetime :sent_at
+      t.datetime :received_at
+
+      # Relations
+      t.integer :notification_delivery_id, index: true
+      t.integer :receiver_id, index: true
+      t.string :receiver_type, index: true
+
+      # State
+      t.string :state
+      t.string :error_message
+
+    end
+  end
+end

data/db/migrate/20160509144238_create_notification_templates.rb

@@ -0,0 +1,21 @@
+class CreateNotificationTemplates < ActiveRecord::Migration
+  def change
+    create_table :notification_templates do |t|
+
+      # Timestamps
+      t.timestamps null: true
+
+      # Identification
+      t.string :ref
+
+      # Message
+      t.string :subject
+      t.text :message
+
+      # Handlers
+      t.boolean :disabled
+      t.boolean :dry
+
+    end
+  end
+end