tolliver 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0fa6672c057ce36fec360bddd1f1a7360dcdecb6198678838a6150978a8b12
-  data.tar.gz: 13ddc4dba78f936159bc825f4cee588d66941a9ff296d5fe0abd70b6ae02cbf0
+  metadata.gz: 071baa1e13612b56607c74a22057e7a35dff214916a5cb6f8cf2a7640a54facf
+  data.tar.gz: d1b9e7e25cc83abc2ca03e2382dfd965fa8eb2bebd872696aa0e2f578247a7ef
 SHA512:
-  metadata.gz: 4e2ddef5141f52daf5bdfb4d648c2420dad063f2ba1fd06d2753eca7f8e56e66184bfa72a60124ab7203e0821119796a398508df86a555d9fa2d7f77ac289736
-  data.tar.gz: 23a5b86b0b8daac5a8f334e3d2bf53fb42b380fda433550c4742216d7631cd408920436467d85224d07c872b8fb3cb80f7db62d2d1403338e99456d6f4d73372
+  metadata.gz: 165fb812806151315d58b2482ac909d06dfbff0796d6d35eb19640b736988547f89dae17c71aadbfc01603cff4cdbdc82c2f7d9ee94a6d3c9f7a2439858a4f5b
+  data.tar.gz: 7d2ae9b7a4117cffa8f8baa260e338a890d3f9fc6b1a16a046a1b8d803369390179e12263cd46138a653758acf9cd873a31ee3d88100a0c02f3a4518f6cfada7

data/README.md

@@ -5,6 +5,7 @@ send it in a batch with different delivery methods:
 
 - E-mail with SMTP aor Mailgun provider
 - SMS with Plivo provider
+- Slack
 - Whatever custom delivery method
 
 ## 1. Installation
@@ -27,7 +28,6 @@ Add gem to your Gemfile:
 ```ruby
 gem 'plivo'
 ```
-
 ### 1.2. Mailgun support
 
 Add gem to your Gemfile:
@@ -35,6 +35,13 @@ Add gem to your Gemfile:
 ```ruby
 gem 'mailgun-ruby'
 ```
+### 1.3. Slack support
+
+Add gem to your Gemfile:
+
+```ruby
+gem 'slack-ruby-client'
+````
 
 ## 2. Configuration
 
@@ -63,6 +70,7 @@ Available options:
 - sms_sender
 - sms_provider
 - sms_provider_params
+- slack_params
 - delivery_methods
 
 ### 2.1. Plivo support

data/db/migrate/20220805120000_add_slack_id.rb

@@ -0,0 +1,5 @@
+class AddSlackId < ActiveRecord::Migration[6.0]
+  def change
+    add_column :notification_receivers, :receiver_slack_id, :string
+  end
+end

data/lib/tolliver/models/notification.rb

@@ -23,13 +23,7 @@ module Tolliver
         has_many :notification_deliveries, class_name: Tolliver.notification_delivery_model.to_s, dependent: :destroy
         has_many :notification_receivers, class_name: Tolliver.notification_receiver_model.to_s, through: :notification_deliveries
         has_many :notification_attachments, class_name: Tolliver.notification_attachment_model.to_s, dependent: :destroy
-        belongs_to :notification_template, class_name: Tolliver.notification_template_model.to_s
-
-        # *********************************************************************
-        # Validators
-        # *********************************************************************
-
-        validates_presence_of :subject
+        belongs_to :notification_template, class_name: Tolliver.notification_template_model.to_s, optional: true
 
       end
 

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

@@ -0,0 +1,90 @@
+# *****************************************************************************
+# * Copyright (c) 2019 Matěj Outlý
+# *****************************************************************************
+# *
+# * Notification method - Slack
+# *
+# * Author: Matěj Outlý
+# * Date  : 21. 1. 2016
+# *
+# *****************************************************************************
+
+module Tolliver
+  module Services
+    module Methods
+      class Slack
+
+        def is_notification_valid?(notification)
+          return false if notification.message.blank?
+          true
+        end
+
+        def is_notification_delivery_valid?(_)
+          true
+        end
+
+        def is_notification_receiver_valid?(notification_receiver)
+          return false if notification_receiver.receiver_slack_id.blank? && notification_receiver.receiver_email.blank?
+          true
+        end
+
+        def deliver(notification_receiver)
+
+          # Prepare notification
+          notification = notification_receiver.notification_delivery.notification
+
+          # Send message
+          begin
+            ensure_slack_id(notification_receiver)
+            client.chat_postMessage(channel: notification_receiver.receiver_slack_id, text: notification.message)
+            notification_receiver.status = 'sent'
+          rescue StandardError => e
+            notification_receiver.status = 'error'
+            notification_receiver.error_message = e.message
+          end
+
+          # Mark as sent
+          notification_receiver.sent_at = Time.current
+
+          # Save
+          notification_receiver.save
+
+          true
+        end
+
+        private
+
+        def ensure_slack_id(notification_receiver)
+          if notification_receiver.receiver_slack_id.blank?
+            unless notification_receiver.receiver_email.blank?
+              response = client.users_lookupByEmail(email: notification_receiver.receiver_email)
+              if response.ok
+                notification_receiver.receiver_slack_id = response.user.id
+                notification_receiver.save(validate: false)
+              end
+            end
+          end
+          if notification_receiver.receiver_slack_id.blank?
+            raise Tolliver::Errors::StandardError.new('Receiver Slack ID not recognized.')
+          end
+        end
+
+        def client
+          if @client.nil?
+            require 'slack'
+            api_token = Tolliver.slack_params[:api_token]
+            if api_token.blank?
+              raise Tolliver::Errors::StandardError.new('Please provide API Token in Slack params.')
+            end
+            ::Slack.configure do |config|
+              config.token = api_token
+            end
+            @client = ::Slack::Web::Client.new
+          end
+          @client
+        end
+
+      end
+    end
+  end
+end

data/lib/tolliver/services/notification_service.rb

@@ -53,7 +53,7 @@ module Tolliver
             end
 
             # Save to DB
-            notification.save
+            notification.save!
 
             # Attachments
             unless options[:attachments].blank?
@@ -105,7 +105,7 @@ module Tolliver
                 end
 
                 # Must be persisted in DB before receiver created
-                notification_delivery.save
+                notification_delivery.save!
 
                 # Receivers
                 receivers = options[:receivers] || []
@@ -121,13 +121,13 @@ module Tolliver
                   notification_receiver.receiver_phone = receiver[:phone]
                   raise Tolliver::Errors::BadRequest.new('Missing receiver ref.') if notification_receiver.receiver_ref.blank?
                   if notification_delivery.method_service.is_notification_receiver_valid?(notification_receiver) # ignore receiver if not valid
-                    notification_receiver.save
+                    notification_receiver.save!
                     receivers_count += 1
                   end
                 end
                 notification_delivery.sent_count = 0
                 notification_delivery.receivers_count = receivers_count
-                notification_delivery.save
+                notification_delivery.save!
 
               end
 

data/lib/tolliver.rb

@@ -29,6 +29,7 @@ require "tolliver/services/methods/email/smtp"
 require "tolliver/services/methods/email/mailgun"
 require "tolliver/services/methods/sms"
 require "tolliver/services/methods/sms/plivo"
+require "tolliver/services/methods/slack"
 
 # Jobs
 require "tolliver/jobs/delivery_job"
@@ -134,6 +135,7 @@ module Tolliver
   # Available methods:
   # - email
   # - sms
+  # - slack
   # - whatever
   mattr_accessor :delivery_methods
   @@delivery_methods = [
@@ -170,10 +172,14 @@ module Tolliver
 
   # Used SMS provider
   mattr_accessor :sms_provider
-  @@sms_provider = nil
+  @@sms_provider = :plivo
 
   # SMS provider params
   mattr_accessor :sms_provider_params
   @@sms_provider_params = {}
 
+  # Slack provider params
+  mattr_accessor :slack_params
+  @@slack_params = {}
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tolliver
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Matěj Outlý
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-29 00:00:00.000000000 Z
+date: 2022-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -52,6 +52,7 @@ files:
 - db/migrate/20201027150000_create_notification_attachments.rb
 - db/migrate/20210415120000_add_notification_attachments_url.rb
 - db/migrate/20210528120000_add_short_message_and_phone.rb
+- db/migrate/20220805120000_add_slack_id.rb
 - lib/tolliver.rb
 - lib/tolliver/engine.rb
 - lib/tolliver/errors/bad_request.rb
@@ -69,6 +70,7 @@ files:
 - lib/tolliver/services/methods/email.rb
 - lib/tolliver/services/methods/email/mailgun.rb
 - lib/tolliver/services/methods/email/smtp.rb
+- lib/tolliver/services/methods/slack.rb
 - lib/tolliver/services/methods/sms.rb
 - lib/tolliver/services/methods/sms/plivo.rb
 - lib/tolliver/services/notification_service.rb