Skip to content

Commit

Permalink
Improved notification lib.
Browse files Browse the repository at this point in the history
  • Loading branch information
@martini
martini committed Dec 28, 2014
1 parent 912ce3f commit cb7b79e
Show file tree
Hide file tree
Showing 2 changed files with 211 additions and 20 deletions.
55 changes: 45 additions & 10 deletions lib/notification_factory.rb
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,18 @@
module NotificationFactory

=begin
result_string = NotificationFactory.build(
:string => 'Hi #{recipient.firstname},',
:objects => {
:ticket => ticket,
:recipient => User.find(2),
},
:locale => 'en',
)
=end

def self.build(data)

data[:string].gsub!( / \#\{ \s* ( .+? ) \s* \} /x ) { |placeholder|
Expand All @@ -9,12 +23,6 @@ def self.build(data)
callback = $1
callback_valid = nil

# use quoted text
callback.gsub!( /\A ( \w+ ) \.body \z/x ) { |item|
callback_valid = true
item = item + '.word_wrap( :line_width => 82 ).message_quote.chomp'
}

# use config params
callback.gsub!( /\A config\.( [\w\.]+ ) \z/x ) { |item|
callback_valid = true
Expand All @@ -28,10 +36,27 @@ def self.build(data)
object_name = $1
object_method = $2

next if !data[:objects][object_name.to_sym]
if data[:objects][object_name.to_sym]
callback_valid = true
item = "data[:objects]['#{object_name}'.to_sym]#{object_method}"
else
item = item
end
}

# use quoted text
callback.gsub!( /\A ( data\[:objects\]\['article'\.to_sym\] ) \.body \z/x ) { |item|
callback_valid = true
item = "data[:objects]['#{object_name}'.to_sym]#{object_method}"
if data[:objects][:article].content_type == 'text/html'
item = item + '.html2text.message_quote.chomp'
else
item = item + '.word_wrap( :line_width => 82 ).message_quote.chomp'
end
}

# do validaton, ignore some methodes
callback.gsub!( /\.(save|destroy|delete|remove|drop|update|create\(|new|all|where|find)/ix ) { |item|
callback_valid = false
}

if callback_valid
Expand All @@ -54,9 +79,19 @@ def self.build(data)
placeholder = Translation.translate( locale, string )
}

return data[:string]
data[:string]
end

=begin
success = NotificationFactory.send(
:to => 'somebody@example.com',
:subject => 'sime subject',
:body => 'some body'
)
=end

def self.send(data)
sender = Setting.get('notification_sender')
Rails.logger.info "NOTICE: SEND NOTIFICATION TO: #{data[:recipient][:email]} (from #{sender})"

This comment has been minimized.

Sign in to view

Copy link
@rkaldung

rkaldung Dec 28, 2014

Contributor

Is it possible to add the reason for the notification?

This comment has been minimized.

Sign in to view

Copy link
@martini

martini Dec 28, 2014

Author Collaborator

That would be great! But how could it look like?

Can you give me 2 example how the message could look (1# just state update, 2# state, priority, owner and a new email)?

This comment has been minimized.

Sign in to view

Copy link
@rkaldung

rkaldung Dec 30, 2014

Contributor

Rails.logger.info "NOTICE: SEND NOTIFICATION TO: #{data[:recipient][:email]} (from #{sender}) for #{ticketno}, reason #{event}"

I did not see any difference between your #1 and #2, I'm only interested in the event which the notification invoked. Are there notifications possible which are fired if a specific combination comes up?

This comment has been minimized.

Sign in to view

Copy link
@martini

martini Dec 30, 2014

Author Collaborator

Oh, ok. You mean just the logger info. #{event} is not problem. JFI, we just have 2 events (create and update). I'll add it....
Expand All @@ -71,4 +106,4 @@ def self.send(data)
true
)
end
end
end
176 changes: 166 additions & 10 deletions test/unit/notification_factory_test.rb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,26 @@
require 'test_helper'

class NotificationFactoryTest < ActiveSupport::TestCase
test 'notifications' do
test 'notifications base' do
ticket = Ticket.create(
:title => 'some title äöüß',
:group => Group.lookup( :name => 'Users'),
:customer_id => 2,
:state => Ticket::State.lookup( :name => 'new' ),
:priority => Ticket::Priority.lookup( :name => '2 normal' ),
:updated_by_id => 1,
:created_by_id => 1,
:title => 'some title äöüß',
:group => Group.lookup( :name => 'Users'),
:customer_id => 2,
:state => Ticket::State.lookup( :name => 'new' ),
:priority => Ticket::Priority.lookup( :name => '2 normal' ),
:updated_by_id => 1,
:created_by_id => 1,
)
article_plain = Ticket::Article.create(
:ticket_id => ticket.id,
:type_id => Ticket::Article::Type.where(:name => 'phone' ).first.id,
:sender_id => Ticket::Article::Sender.where(:name => 'Customer' ).first.id,
:from => 'Zammad Feedback <feedback@example.org>',
:body => 'some text',
:internal => false,
:updated_by_id => 1,
:created_by_id => 1,
)

tests = [
{
:locale => 'en',
Expand Down Expand Up @@ -44,6 +53,16 @@ class NotificationFactoryTest < ActiveSupport::TestCase
:string => '\'i18n(#{ticket.state.name})\' ticket state',
:result => '\'neu\' ticket state',
},
{
:locale => 'de',
:string => 'Subject #{article.from}, Group: #{ticket.group.name}',
:result => 'Subject Zammad Feedback <feedback@example.org>, Group: Users',
},
{
:locale => 'de',
:string => 'Body #{article.body}, Group: #{ticket.group.name}',
:result => 'Body > some text, Group: Users',
},
{
:locale => 'de',
:string => '\#{puts `ls`}',
Expand All @@ -55,11 +74,148 @@ class NotificationFactoryTest < ActiveSupport::TestCase
:string => test[:string],
:objects => {
:ticket => ticket,
:article => article_plain,
:recipient => User.find(2),
},
:locale => test[:locale]
)
assert_equal( test[:result], result, "verify result" )
}

ticket.destroy
end

test 'notifications html' do
ticket = Ticket.create(
:title => 'some title <b>äöüß</b> 2',
:group => Group.lookup( :name => 'Users'),
:customer_id => 2,
:state => Ticket::State.lookup( :name => 'new' ),
:priority => Ticket::Priority.lookup( :name => '2 normal' ),
:updated_by_id => 1,
:created_by_id => 1,
)
article_html = Ticket::Article.create(
:ticket_id => ticket.id,
:type_id => Ticket::Article::Type.where(:name => 'phone' ).first.id,
:sender_id => Ticket::Article::Sender.where(:name => 'Customer' ).first.id,
:from => 'Zammad Feedback <feedback@example.org>',
:body => 'some <b>text</b><br>next line',
:content_type => 'text/html',
:internal => false,
:updated_by_id => 1,
:created_by_id => 1,
)
tests = [
{
:locale => 'de',
:string => 'Subject #{ticket.title}',
:result => 'Subject some title <b>äöüß</b> 2',
},
{
:locale => 'de',
:string => 'Subject #{article.from}, Group: #{ticket.group.name}',
:result => 'Subject Zammad Feedback <feedback@example.org>, Group: Users',
},
{
:locale => 'de',
:string => 'Body #{article.body}, Group: #{ticket.group.name}',
:result => 'Body > some text
> next line, Group: Users',
},
]
tests.each { |test|
result = NotificationFactory.build(
:string => test[:string],
:objects => {
:ticket => ticket,
:article => article_html,
:recipient => User.find(2),
},
:locale => test[:locale]
)
assert_equal( test[:result], result, "verify result" )
}

ticket.destroy
end

test 'notifications attack' do
ticket = Ticket.create(
:title => 'some title <b>äöüß</b> 3',
:group => Group.lookup( :name => 'Users'),
:customer_id => 2,
:state => Ticket::State.lookup( :name => 'new' ),
:priority => Ticket::Priority.lookup( :name => '2 normal' ),
:updated_by_id => 1,
:created_by_id => 1,
)
article_html = Ticket::Article.create(
:ticket_id => ticket.id,
:type_id => Ticket::Article::Type.where(:name => 'phone' ).first.id,
:sender_id => Ticket::Article::Sender.where(:name => 'Customer' ).first.id,
:from => 'Zammad Feedback <feedback@example.org>',
:body => 'some <b>text</b><br>next line',
:content_type => 'text/html',
:internal => false,
:updated_by_id => 1,
:created_by_id => 1,
)
tests = [
{
:locale => 'de',
:string => '\#{puts `ls`}',
:result => '\#{puts `ls`}',
},
{
:locale => 'de',
:string => 'attack#1 #{article.destroy}',
:result => 'attack#1 #{article.destroy}',
},
{
:locale => 'de',
:string => 'attack#2 #{Article.where}',
:result => 'attack#2 #{Article.where}',
},
{
:locale => 'de',
:string => 'attack#1 #{article.
destroy}',
:result => 'attack#1 #{article.
destroy}',
},
{
:locale => 'de',
:string => 'attack#1 #{article.find}',
:result => 'attack#1 #{article.find}',
},
{
:locale => 'de',
:string => 'attack#1 #{article.update}',
:result => 'attack#1 #{article.update}',
},
{
:locale => 'de',
:string => 'attack#1 #{article.all}',
:result => 'attack#1 #{article.all}',
},
{
:locale => 'de',
:string => 'attack#1 #{article.delete}',
:result => 'attack#1 #{article.delete}',
},
]
tests.each { |test|
result = NotificationFactory.build(
:string => test[:string],
:objects => {
:ticket => ticket,
:article => article_html,
:recipient => User.find(2),
},
:locale => test[:locale]
)
assert_equal( result, test[:result], "verify result" )
assert_equal( test[:result], result, "verify result" )
}

ticket.destroy
Expand Down

0 comments on commit cb7b79e

Please sign in to comment.