Class: Blazer::SlackNotifier
- Inherits:
-
Object
- Object
- Blazer::SlackNotifier
- Defined in:
- app/mailers/blazer/slack_notifier.rb
Class Method Summary collapse
-
.escape(str) ⇒ Object
api.slack.com/docs/message-formatting#how_to_escape_characters - Replace the ampersand, &, with & - Replace the less-than sign, < with < - Replace the greater-than sign, > with > That’s it.
- .failing_checks(channel, checks) ⇒ Object
- .pluralize(*args) ⇒ Object
- .post(url, payload) ⇒ Object
-
.query_url(id) ⇒ Object
checks shouldn’t have variables, but in any case, avoid passing variable params to url helpers (known unsafe parameters are removed, but blacklist isn’t ideal).
- .state_change(check, state, state_was, rows_count, error, check_type) ⇒ Object
Class Method Details
.escape(str) ⇒ Object
api.slack.com/docs/message-formatting#how_to_escape_characters
-
Replace the ampersand, &, with &
-
Replace the less-than sign, < with <
-
Replace the greater-than sign, > with >
That’s it. Don’t HTML entity-encode the entire message.
55 56 57 |
# File 'app/mailers/blazer/slack_notifier.rb', line 55 def self.escape(str) str.gsub("&", "&").gsub("<", "<").gsub(">", ">") if str end |
.failing_checks(channel, checks) ⇒ Object
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 |
# File 'app/mailers/blazer/slack_notifier.rb', line 30 def self.failing_checks(channel, checks) text = checks.map do |check| "<#{query_url(check.query_id)}|#{escape(check.query.name)}> #{escape(check.state)}" end payload = { channel: channel, attachments: [ { title: escape("#{pluralize(checks.size, "Check")} Failing"), text: text.join("\n"), color: "warning" } ] } post(Blazer.slack_webhook_url, payload) end |
.pluralize(*args) ⇒ Object
59 60 61 |
# File 'app/mailers/blazer/slack_notifier.rb', line 59 def self.pluralize(*args) ActionController::Base.helpers.pluralize(*args) end |
.post(url, payload) ⇒ Object
70 71 72 73 74 75 76 77 |
# File 'app/mailers/blazer/slack_notifier.rb', line 70 def self.post(url, payload) uri = URI.parse(url) http = Net::HTTP.new(uri.host, uri.port) http.use_ssl = true http.open_timeout = 3 http.read_timeout = 5 http.post(uri.request_uri, payload.to_json) end |
.query_url(id) ⇒ Object
checks shouldn’t have variables, but in any case, avoid passing variable params to url helpers (known unsafe parameters are removed, but blacklist isn’t ideal)
66 67 68 |
# File 'app/mailers/blazer/slack_notifier.rb', line 66 def self.query_url(id) Blazer::Engine.routes.url_helpers.query_url(id, ActionMailer::Base.) end |
.state_change(check, state, state_was, rows_count, error, check_type) ⇒ Object
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 |
# File 'app/mailers/blazer/slack_notifier.rb', line 5 def self.state_change(check, state, state_was, rows_count, error, check_type) check.split_slack_channels.each do |channel| text = if error error elsif rows_count > 0 && check_type == "bad_data" pluralize(rows_count, "row") end payload = { channel: channel, attachments: [ { title: escape("Check #{state.titleize}: #{check.query.name}"), title_link: query_url(check.query_id), text: escape(text), color: state == "passing" ? "good" : "danger" } ] } post(Blazer.slack_webhook_url, payload) end end |