tolliver 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 560d3dcb05343bbf964e6a418c95bc4960d7cd9ba6e8e01698455a93077a99ed
-  data.tar.gz: 8365863b679d97581dbd9d2288dd4043f4040a283e4f649ce1b86ba4aa882454
+  metadata.gz: 1e7ab72e7ba150c2828de6e3f3defebf06f50bbf09495b9f3bafcc32d4858cf0
+  data.tar.gz: 4dd7b0a65c105f2f11fcf336675a515d41cac6cc278580fd24951891073b60dc
 SHA512:
-  metadata.gz: 353704eedb8fd167d864ac1d19fd738eb81fd644bfe3072ee78d4b08087a0d04f699acbd3c75d2487505f399a95856cf5bfdd80ed49f10fbf42eb6d17eb60bd6
-  data.tar.gz: 719f0dc978ab83ecbb6eba6c0a1814d52318b3b3f18c5d415249ba475478767aaf75cea4b210666dc0f7eefa40c00657e86d6585f47076525aa094dd23011b5d
+  metadata.gz: 4c538087c0161c0968e4f2f4fa31c8ce6ad1a54ea1ee0b924b851f81aa537ed631c839cadb0e258b86a5ba24dee3affa2b5b6dc46983c1f5d16960b91cf562a4
+  data.tar.gz: 05fa597679610a2694f6397992040c4463b9bb9d9458e7f1193431e302c7e2446c67c096838273b5c4fcc42e714f0d53a61d0612abc3a114e6f1ab1b6af06eab

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
@@ -20,13 +20,29 @@ 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.email_sender = 'no-reply@domain.com'
   config.delivery_methods = [
       :email
   ]
@@ -42,11 +58,43 @@ Available options:
 - notification_template_model
 - 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:

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

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

data/lib/tolliver.rb

@@ -25,7 +25,10 @@ require "tolliver/services/delivery"
 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"
 
 # Mailers
 require "tolliver/mailers/notification_mailer"
@@ -149,16 +152,24 @@ module Tolliver
   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
+
+  # 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

data/lib/tolliver/mailers/notification_mailer.rb

@@ -18,7 +18,7 @@ module Tolliver
 
         # Sender
         @sender_email = Tolliver.email_sender
-        raise Tolliver::Errors::StandardError.new("Please specify sender.") if @sender_email.nil?
+        raise Tolliver::Errors::StandardError.new("Please specify e-mail sender.") if @sender_email.nil?
         unless Tolliver.email_sender_name.blank?
           @sender_email = "#{Tolliver.email_sender_name} <#{@sender_email}>"
         end
@@ -33,7 +33,7 @@ module Tolliver
         end
 
         # Mail
-        mail(from: @sender_email, to: @notification_receiver.receiver_contact, subject: @notification.subject)
+        mail(from: @sender_email, to: @notification_receiver.receiver_contact.to_s, subject: @notification.subject)
       end
 
     end

data/lib/tolliver/services/methods/email.rb

@@ -15,11 +15,14 @@ module Tolliver
       class Email
 
         def deliver(notification_receiver)
+          return false if provider.nil?
+
+          # Prepare notification
           notification = notification_receiver.notification_delivery.notification
 
           # Send email
           begin
-            Tolliver::NotificationMailer.notify(notification, notification_receiver).deliver_now
+            provider.deliver(notification, notification_receiver)
             notification_receiver.status = 'sent'
           #rescue Net::SMTPFatalError, Net::SMTPSyntaxError
           rescue StandardError => e
@@ -36,6 +39,16 @@ module Tolliver
           true
         end
 
+        protected
+
+        def provider
+          if @provider.nil? && Tolliver.email_provider
+            provider_class_name = "Tolliver::Services::Methods::Email::#{Tolliver.email_provider.to_s.camelize}"
+            @provider = provider_class_name.constantize.new(Tolliver.email_provider_params)
+          end
+          @provider
+        end
+
       end
     end
   end

data/lib/tolliver/services/methods/email/mailgun.rb

@@ -0,0 +1,55 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Mailgun e-mail provider
+# *
+# * Author: Matěj Outlý
+# * Date  : 1. 12. 2017
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Services
+    module Methods
+      class Email
+        class Mailgun
+
+          def initialize(params = {})
+            require 'mailgun-ruby'
+            if params[:api_key].blank? || params[:domain].blank?
+              raise Tolliver::Errors::StandardError.new('Please provide API key and domain in e-mail provider params.')
+            end
+            @client = ::Mailgun::Client.new(params[:api_key])
+            @domain = params[:domain]
+          end
+
+          def deliver(notification, notification_receiver)
+
+            # Sender
+            raise Tolliver::Errors::StandardError.new("Please specify e-mail sender.") if Tolliver.email_sender.nil?
+
+            # Message builder
+            message = ::Mailgun::MessageBuilder.new
+            message.from(Tolliver.email_sender, {'full_name' => Tolliver.email_sender_name})
+            message.add_recipient(:to, notification_receiver.receiver_contact.to_s)
+            message.reply_to(notification_receiver.notification_delivery.sender_contact.to_s) unless notification_receiver.notification_delivery.sender_contact.blank?
+            message.subject(notification.subject)
+            message.body_text(ActionController::Base.helpers.strip_tags(notification.message.to_s))
+            message.body_html(notification.message)
+            notification.notification_attachments.each do |notification_attachment|
+              message.add_attachment(StringIO.new(notification_attachment.attachment), notification_attachment.name)
+            end
+            response = @client.send_message(@domain, message)
+            if response.code != 200
+              raise Tolliver::Errors::StandardError.new(response.body)
+            end
+
+            true
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/tolliver/services/methods/email/smtp.rb

@@ -0,0 +1,28 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * SMTP e-mail provider
+# *
+# * Author: Matěj Outlý
+# * Date  : 1. 12. 2017
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Services
+    module Methods
+      class Email
+        class Smtp
+
+          def initialize(params = {}) end
+
+          def deliver(notification, notification_receiver)
+            Tolliver::NotificationMailer.notify(notification, notification_receiver).deliver_now
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/tolliver/services/methods/sms.rb

@@ -15,11 +15,14 @@ module Tolliver
       class Sms
 
         def deliver(notification_receiver)
+          return false if provider.nil?
+
+          # Prepare notification
           notification = notification_receiver.notification_delivery.notification
 
           # Send SMS
           begin
-            provider.deliver(notification_receiver.receiver_contact, notification.message.strip_tags)
+            provider.deliver(notification, notification_receiver)
             notification_receiver.status = 'sent'
           rescue StandardError => e
             notification_receiver.status = 'error'
@@ -38,7 +41,7 @@ module Tolliver
         protected
 
         def provider
-          if @provider.nil?
+          if @provider.nil? && Tolliver.sms_provider
             provider_class_name = "Tolliver::Services::Methods::Sms::#{Tolliver.sms_provider.to_s.camelize}"
             @provider = provider_class_name.constantize.new(Tolliver.sms_provider_params)
           end

data/lib/tolliver/services/methods/sms/plivo.rb

@@ -9,24 +9,23 @@
 # *
 # *****************************************************************************
 
-require 'plivo'
-
 module Tolliver
   module Services
     module Methods
-      module Sms
+      class Sms
         class Plivo
 
           def initialize(params = {})
+            require 'plivo'
             if params[:auth_id].blank? || params[:auth_token].blank?
-              raise Tolliver::Errors::StandardError.new('Please provide Auth ID and Auth Token in provider params.')
+              raise Tolliver::Errors::StandardError.new('Please provide Auth ID and Auth Token in SMS provider params.')
             end
             @auth_id = params[:auth_id]
             @auth_token = params[:auth_token]
             @api = ::Plivo::RestAPI.new(@auth_id, @auth_token)
           end
 
-          def deliver(receiver, message)
+          def deliver(notification, notification_receiver)
 
             # Check message length.
             if message.bytesize > 200
@@ -36,8 +35,8 @@ module Tolliver
             # Request API
             response = @api.send_message({
                                              'src' => Tolliver.sms_sender, # TODO: This should be improved to take sender from number pool and remember number / message mapping
-                                             'dst' => receiver.to_s,
-                                             'text' => message.to_s,
+                                             'dst' => notification_receiver.receiver_contact.to_s,
+                                             'text' => ActionController::Base.helpers.strip_tags(notification.message.to_s),
                                              'method' => 'POST'
                                          })
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tolliver
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Matěj Outlý
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-28 00:00:00.000000000 Z
+date: 2020-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -63,6 +63,8 @@ files:
 - lib/tolliver/models/notification_template.rb
 - lib/tolliver/services/delivery.rb
 - lib/tolliver/services/methods/email.rb
+- lib/tolliver/services/methods/email/mailgun.rb
+- lib/tolliver/services/methods/email/smtp.rb
 - lib/tolliver/services/methods/sms.rb
 - lib/tolliver/services/methods/sms/plivo.rb
 - lib/tolliver/services/notification.rb