tolliver 1.0.0 → 2.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b51e98fd8b3ff0cdfbb2a9e4c3461367d91e84603b8f0dbc173520c34d2625e
-  data.tar.gz: 2cfc09c23fc2e2911c3c6c0bb6f3095a6a929c513fc837e23e9043614dc6682d
+  metadata.gz: 5a1110eda739a5bb9763c51608a6a251c356962bc02690b2b5b81d06239d0893
+  data.tar.gz: 4ab466afccc3086a66c4d50ecc7c87214b89aa734553f64b8e7f73c93ec491a5
 SHA512:
-  metadata.gz: bb9d2b1a57c832ee8b6d24859ada4760bc5b8405c799df7dc28ca252b7bb8dd5cc8a3fdb92df530cc2d12e16072bd49afc1f041eddb7f27c409fe25da3d9ef6a
-  data.tar.gz: e55ef50ab51b8cc260f3e26c542719109ef2a1518dc775b6c2541b0a0d474dd1263894d973ac40784f70e028a9e35751c5502519b56aa62f779b2088fb8bb462
+  metadata.gz: 5901317de7117ceca9fcc6396706d018d62d99ebaf69b7361fe2118766c9bf87a6ac684c8169815818b9ac66fe06e9cd6c0326d86ea6f46202abc6352f7d9365
+  data.tar.gz: 65913171587f3632ed28e43a00827b109a84b8497ffd39651f1002da4ce7cc0a57a8ccaa43982ecf1ef949e3e0e45f7b9fc85328009784c2b88e51a29d2a6d3f

data/README.md

@@ -3,8 +3,8 @@ 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
+- E-mail with SMTP aor Mailgun provider
+- SMS with Plivo provider
 - Whatever custom delivery method
 
 ## Installation
@@ -12,7 +12,7 @@ send it in a batch with different delivery methods:
 Add gem to your Gemfile:
 
 ```ruby
-gem "tolliver"
+gem 'tolliver'
 ```
 
 Add database migrations to you application (you can modify DB structure accordingly before migrating):
@@ -20,37 +20,95 @@ Add database migrations to you application (you can modify DB structure accordin
     $ rake tolliver:install:migrations
     $ rake db:migrate
 
+### Plivo support
+
+Add gem to your Gemfile:
+
+```ruby
+gem 'plivo'
+```
+
+### Mailgun support
+
+Add gem to your Gemfile:
+
+```ruby
+gem 'mailgun-ruby'
+```
+
 ## 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 = [
+  config.email_sender = 'no-reply@domain.com'
+  config.delivery_methods = [
       :email
   ]
-  config.template_refs = [
-      :user_new_password,
-  ]
 end
 ```
 
 Available options:
 
 - notification_model
+- notification_attachment_model
 - notification_delivery_model
 - notification_receiver_model
 - notification_template_model
-- people_selector_model
-- mailer_sender
-- delivery_kinds
-- template_refs
+- email_sender
+- email_sender_name
+- email_provider
+- email_provider_params
+- sms_sender
+- sms_provider
+- sms_provider_params
+- delivery_methods
+
+### Plivo support
 
+Set Plivo as SMS provider and add Plivo auth ID and token into Tolliver configuration file:
+
+```ruby
+Tolliver.setup do |config|
+  ...
+  config.sms_provider = :plivo
+  config.sms_provider_params = {
+    auth_id: 'secret',
+    auth_token: 'secret'
+  }
+end
+```
+
+### Mailgun support
+
+Set Mailgun as e-mail provider and add Mailgun API key and domain into Tolliver configuration file:
+
+```ruby
+Tolliver.setup do |config|
+  ...
+  config.email_provider = :mailgun
+  config.email_provider_params = {
+      api_key: 'key-secret',
+      domain: 'domain.tld'
+  }
+end
+```
+ 
 ## 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)
+Tolliver.notify(
+  template: :template_ref, 
+  params: [
+    {key: :key_1, value: :value_1},
+    {key: :key_2, value: :value_2}
+  ], 
+  receivers: [
+    {ref: :receiver_1, contact: "receiver_1@domain.tld"},
+    {ref: :receiver_2, contact: "receiver_2@domain.tld"}, 
+  ]
+)
 ```

data/app/models/tolliver/notification.rb

@@ -11,7 +11,6 @@
 
 module Tolliver
   class Notification < ActiveRecord::Base
-    include Tolliver::Utils::Enum
     include Tolliver::Models::Notification
   end
 end

data/app/models/tolliver/notification_attachment.rb

@@ -0,0 +1,16 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification attachment
+# *
+# * Author: Matěj Outlý
+# * Date  : 27. 10. 2020
+# *
+# *****************************************************************************
+
+module Tolliver
+  class NotificationAttachment < ActiveRecord::Base
+    include Tolliver::Models::NotificationAttachment
+  end
+end

data/app/models/tolliver/notification_delivery.rb

@@ -2,7 +2,7 @@
 # * Copyright (c) 2019 Matěj Outlý
 # *****************************************************************************
 # *
-# * Notification receiver
+# * Notification delivery
 # *
 # * Author: Matěj Outlý
 # * Date  : 30. 6. 2017
@@ -13,7 +13,5 @@ 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

@@ -13,7 +13,5 @@ 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

@@ -11,7 +11,6 @@
 
 module Tolliver
   class NotificationTemplate < ActiveRecord::Base
-    include Tolliver::Utils::Enum
     include Tolliver::Models::NotificationTemplate
   end
 end

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

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

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

@@ -0,0 +1 @@
+<%= ActionController::Base.helpers.strip_tags(@notification.message.to_s) %>

data/config/locales/en.yml

@@ -11,7 +11,7 @@ en:
         kind_values:
           notice: Information
           alert: Error
-          warning: Worning
+          warning: Warning
         sender: Sender
         sent_at: Sent
         done: Done

data/db/migrate/20160121093817_create_notifications.rb

@@ -1,4 +1,4 @@
-class CreateNotifications < ActiveRecord::Migration
+class CreateNotifications < ActiveRecord::Migration[6.0]
   def change
     create_table :notifications do |t|
 
@@ -8,21 +8,10 @@ class CreateNotifications < ActiveRecord::Migration
       # 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

@@ -1,4 +1,4 @@
-class CreateNotificationReceivers < ActiveRecord::Migration
+class CreateNotificationReceivers < ActiveRecord::Migration[6.0]
   def change
     create_table :notification_receivers do |t|
 
@@ -9,11 +9,13 @@ class CreateNotificationReceivers < ActiveRecord::Migration
 
       # Relations
       t.integer :notification_delivery_id, index: true
-      t.integer :receiver_id, index: true
-      t.string :receiver_type, index: true
+
+      # Receiver
+      t.string :receiver_ref, index: true
+      t.string :receiver_contact
 
       # State
-      t.string :state
+      t.string :status
       t.string :error_message
 
     end

data/db/migrate/20160509144238_create_notification_templates.rb

@@ -1,4 +1,4 @@
-class CreateNotificationTemplates < ActiveRecord::Migration
+class CreateNotificationTemplates < ActiveRecord::Migration[6.0]
   def change
     create_table :notification_templates do |t|
 
@@ -6,15 +6,15 @@ class CreateNotificationTemplates < ActiveRecord::Migration
       t.timestamps null: true
 
       # Identification
-      t.string :ref
+      t.string :ref, index: true
 
       # Message
       t.string :subject
       t.text :message
 
       # Handlers
-      t.boolean :disabled
-      t.boolean :dry
+      t.boolean :is_disabled
+      t.boolean :is_dry
 
     end
   end

data/db/migrate/20170630190600_create_notification_deliveries.rb

@@ -1,4 +1,4 @@
-class CreateNotificationDeliveries < ActiveRecord::Migration
+class CreateNotificationDeliveries < ActiveRecord::Migration[6.0]
   def change
     create_table :notification_deliveries do |t|
 
@@ -9,8 +9,15 @@ class CreateNotificationDeliveries < ActiveRecord::Migration
       # Relations
       t.integer :notification_id, index: true
 
-      # Delivery kind (email, SMS, mailboxer, ...)
-      t.string :kind
+      # Delivery method (email, SMS, ...)
+      t.string :method
+
+      # Sender
+      t.string :sender_ref, index: true
+      t.string :sender_contact
+
+      # Postpone
+      t.boolean :is_postponed
 
       # Statistics
       t.integer :receivers_count

data/db/migrate/20201027150000_create_notification_attachments.rb

@@ -0,0 +1,17 @@
+class CreateNotificationAttachments < ActiveRecord::Migration[6.0]
+  def change
+    create_table :notification_attachments do |t|
+
+      # Timestamps
+      t.timestamps null: true
+
+      # Relations
+      t.integer :notification_id, index: true
+
+      # Data
+      t.string :name
+      t.string :attachment
+
+    end
+  end
+end

data/db/migrate/20210415120000_add_notification_attachments_url.rb

@@ -0,0 +1,6 @@
+class AddNotificationAttachmentsUrl < ActiveRecord::Migration[6.0]
+  def change
+    change_column :notification_attachments, :attachment, :text
+    add_column :notification_attachments, :url, :string
+  end
+end

data/lib/tolliver.rb

@@ -14,17 +14,25 @@ require "tolliver/engine"
 
 # Models
 require "tolliver/models/notification"
+require "tolliver/models/notification_attachment"
 require "tolliver/models/notification_delivery"
-require "tolliver/models/notification_delivery/batch"
-require "tolliver/models/notification_delivery/instantly"
 require "tolliver/models/notification_receiver"
-require "tolliver/models/notification_receiver/email"
-require "tolliver/models/notification_receiver/sms"
 require "tolliver/models/notification_template"
 
 # Services
-require "tolliver/services/notification"
-require "tolliver/services/delivery"
+require "tolliver/services/notification_service"
+require "tolliver/services/delivery_service"
+require "tolliver/services/policies/batch"
+require "tolliver/services/policies/instantly"
+require "tolliver/services/methods/email"
+require "tolliver/services/methods/email/smtp"
+require "tolliver/services/methods/email/mailgun"
+require "tolliver/services/methods/sms"
+require "tolliver/services/methods/sms/plivo"
+
+# Jobs
+require "tolliver/jobs/delivery_job"
+require "tolliver/jobs/batch_policy_job"
 
 # Mailers
 require "tolliver/mailers/notification_mailer"
@@ -32,6 +40,11 @@ require "tolliver/mailers/notification_mailer"
 # Utils
 require "tolliver/utils/enum"
 
+# Errors
+require "tolliver/errors/standard_error"
+require "tolliver/errors/bad_request"
+require "tolliver/errors/not_found"
+
 module Tolliver
 
   # This will keep Rails Engine from generating all table prefixes with the engines name
@@ -42,8 +55,21 @@ module Tolliver
   # Services
   # *************************************************************************
 
-  include Tolliver::Services::Notification
-  include Tolliver::Services::Delivery
+  def self.notify(options)
+    Tolliver::Services::NotificationService.instance.notify(options)
+  end
+
+  def self.deliver(notification)
+    Tolliver::Services::DeliveryService.instance.deliver(notification)
+  end
+
+  def self.enqueue_for_delivery(notification)
+    Tolliver::Services::DeliveryService.instance.enqueue_for_delivery(notification)
+  end
+
+  def self.reset_delivery(notification)
+    Tolliver::Services::DeliveryService.instance.reset_delivery(notification)
+  end
 
   # *************************************************************************
   # Configuration
@@ -54,18 +80,6 @@ module Tolliver
     yield self
   end
 
-  # *************************************************************************
-  # SMS
-  # *************************************************************************
-
-  def self.sms_provider_obj
-    if @sms_provider_obj.nil?
-      sms_provider_class_name = "Tolliver::Services::Sms::#{Tolliver.sms_provider.to_s.to_camel}"
-      @sms_provider_obj = sms_provider_class_name.constantize.new(Tolliver.sms_provider_params)
-    end
-    return @sms_provider_obj
-  end
-
   # *************************************************************************
   # Config options
   # *************************************************************************
@@ -79,6 +93,15 @@ module Tolliver
 
   @@notification_model = "Tolliver::Notification"
 
+  # Notification attachment model
+  mattr_accessor :notification_attachment_model
+
+  def self.notification_attachment_model
+    return @@notification_attachment_model.constantize
+  end
+
+  @@notification_attachment_model = "Tolliver::NotificationAttachment"
+
   # Notification delivery model
   mattr_accessor :notification_delivery_model
 
@@ -106,33 +129,14 @@ module Tolliver
 
   @@notification_template_model = "Tolliver::NotificationTemplate"
 
-  # People selector model
-  mattr_accessor :people_selector_model
-
-  def self.people_selector_model
-    return @@people_selector_model.constantize
-  end
-
-  @@people_selector_model = nil
-
-  # Available notification template refs. For each defined ref there will be
-  # an automatically created record in the notification_templates table.
-  # System administrator can define content of this template via admin
-  # interface.
-  mattr_accessor :template_refs
-  @@template_refs = [
-#		:some_notification_ref_1,
-#		:some_notification_ref_2,
-  ]
-
-  # Delivery kinds
+  # Delivery methods
   #
-  # Available kinds:
+  # Available methods:
   # - email
   # - sms
   # - whatever
-  mattr_accessor :delivery_kinds
-  @@delivery_kinds = [
+  mattr_accessor :delivery_methods
+  @@delivery_methods = [
       :email
   ]
 
@@ -144,24 +148,32 @@ module Tolliver
   mattr_accessor :load_balance
   @@load_balance = nil
 
-  # Mailer sender
-  mattr_accessor :mailer_sender
-  #@@mailer_sender = "test@domain.com" to be set in module initializer if needed
+  # E-mail sender
+  mattr_accessor :email_sender
+  #@@email_sender = "test@domain.com" to be set in module initializer if needed
+
+  # E-mail sender name
+  mattr_accessor :email_sender_name
+  #@@email_sender_name = "Test sender" to be set in module initializer if needed
+
+  # Used e-mail provider
+  mattr_accessor :email_provider
+  @@email_provider = :smtp
 
-  # Mailer sender name
-  mattr_accessor :mailer_sender_name
-  #@@mailer_sender_name = "Test sender" to be set in module initializer if needed
+  # E-mail provider params
+  mattr_accessor :email_provider_params
+  @@email_provider_params = {}
+
+  # Used SMS provider
+  mattr_accessor :sms_sender
+  #@@sms_sender = "+420 123 456 789" to be set in module initializer if needed
 
   # Used SMS provider
   mattr_accessor :sms_provider
-  @@sms_provider = :plivo
+  @@sms_provider = nil
 
   # SMS provider params
   mattr_accessor :sms_provider_params
   @@sms_provider_params = {}
 
-  # Used SMS provider
-  mattr_accessor :sms_sender
-  #@@sms_sender = "+420 123 456 789" to be set in module initializer if needed
-
 end