slack-notifier 2.3.0 → 2.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 68824ffcac979f733a61c7b5a77d0d21e8ed1dfe
-  data.tar.gz: '08d9cee6b3a56238304f54756640794f443c78ec'
+SHA256:
+  metadata.gz: 2b0deceb91f70d0812f01b82db70eacb8dbf01d4d1985ca02375ac13b36d829e
+  data.tar.gz: 5ec7d0eb36e91bbee6f510411646b4c57935aa661706b791e1dc0941fa66dbd9
 SHA512:
-  metadata.gz: 65efd0c9618f26051b0f562f3ee46b5e6c697c479a6fe50d2014f77da3fdfb13c1ad6009f255cf6481cb4922d7bcc33b49ce8d4a65fb3372734f422f87189e7d
-  data.tar.gz: 9b636e5fcd4d0bc0c815fb6d3c0625a9f1fd62a366bd24e4f0cd3fbe368eadc0405410ce0786a87b12ccd5fbd4f9968b1d89239cd955e9ed62f6407982a76276
+  metadata.gz: 0d42ebede5966444cf3101f9410f442e3fad0cdd3a9a7a25f67ff8c068c474bbd49f08d120070cca8652ffd351d68e99f90f648090b97469e3519761b167f513
+  data.tar.gz: 950d6e0ebc557de14b56b8ea5982e6057eb54530ec7b5b406f3c28ca22c3aaf26744c2ce6d69654b39bc75c8525d43204687b8adb97c331cf21c91f9629bd97f

data/lib/slack-notifier/config.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
+
 module Slack
   class Notifier
     class Config
       def initialize
         @http_client = Util::HTTPClient
         @defaults    = {}
-        @middleware  = [
-          :format_message,
-          :format_attachments,
-          :at,
-          :channels,
+        @middleware  = %i[
+          format_message
+          format_attachments
+          at
+          channels
         ]
       end
 

data/lib/slack-notifier/payload_middleware/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Slack
   class Notifier
     class PayloadMiddleware

data/lib/slack-notifier/payload_middleware/format_attachments.rb

@@ -1,16 +1,17 @@
 # frozen_string_literal: true
+
 module Slack
   class Notifier
     class PayloadMiddleware
       class FormatAttachments < Base
         middleware_name :format_attachments
 
-        options formats: [:html, :markdown]
+        options formats: %i[html markdown]
 
         def call payload={}
           payload = payload.dup
           attachments = payload.delete(:attachments)
-          attachments = payload.delete("attachments") unless attachments
+          attachments ||= payload.delete("attachments")
 
           attachments = wrap_array(attachments).map do |attachment|
             ["text", :text].each do |key|

data/lib/slack-notifier/payload_middleware/format_message.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
+
 module Slack
   class Notifier
     class PayloadMiddleware
       class FormatMessage < Base
         middleware_name :format_message
 
-        options formats: [:html, :markdown]
+        options formats: %i[html markdown]
 
         def call payload={}
           return payload unless payload[:text]

data/lib/slack-notifier/payload_middleware/stack.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Slack
   class Notifier
     class PayloadMiddleware

data/lib/slack-notifier/payload_middleware.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Slack
   class Notifier
     class PayloadMiddleware

data/lib/slack-notifier/util/escape.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Slack
   class Notifier
     module Util

data/lib/slack-notifier/util/http_client.rb

@@ -2,7 +2,6 @@
 
 require "net/http"
 
-
 module Slack
   class Notifier
     class APIError < StandardError; end
@@ -23,6 +22,7 @@ module Slack
           @params       = params
         end
 
+        # rubocop:disable Layout/IndentHeredoc
         def call
           http_obj.request(request_obj).tap do |response|
             unless response.is_a?(Net::HTTPSuccess)
@@ -33,6 +33,7 @@ MSG
             end
           end
         end
+        # rubocop:enable Layout/IndentHeredoc
 
         private
 

data/lib/slack-notifier/util/link_formatter.rb

@@ -1,40 +1,55 @@
 # frozen_string_literal: true
+
 module Slack
   class Notifier
     module Util
       class LinkFormatter
         # http://rubular.com/r/19cNXW5qbH
-        HTML_PATTERN = / <a (?:.*?) href=['"](.+?)['"] (?:.*?)> (.+?) <\/a> /x
+        HTML_PATTERN = %r{
+          <a
+          (?:.*?)
+          href=['"](.+?)['"]
+          (?:.*?)>
+          (.+?)
+          </a>
+        }x
+
+        # the path portion of a url can contain these characters
+        VALID_PATH_CHARS = '\w\-\.\~\/\?\#\='
 
-        # http://rubular.com/r/guJbTK6x1f
-        MARKDOWN_PATTERN = /\[ ([^\[\]]*?) \] \( ((https?:\/\/.*?) | (mailto:.*?)) \) /x
+        # Attempt at only matching pairs of parens per
+        # the markdown spec http://spec.commonmark.org/0.27/#links
+        #
+        # http://rubular.com/r/y107aevxqT
+        MARKDOWN_PATTERN = %r{
+            \[ ([^\[\]]*?) \]
+            \( ((https?://.*?) | (mailto:.*?)) \)
+            (?! [#{VALID_PATH_CHARS}]* \) )
+        }x
 
         class << self
           def format string, opts={}
-            LinkFormatter.new(string, opts).formatted
+            LinkFormatter.new(string, **opts).formatted
           end
         end
 
         attr_reader :formats
 
-        def initialize string, formats: [:html, :markdown]
+        def initialize string, formats: %i[html markdown]
           @formats = formats
           @orig    = string.respond_to?(:scrub) ? string.scrub : string
         end
 
-        # rubocop:disable Style/GuardClause
+        # rubocop:disable Lint/RescueWithoutErrorClass
         def formatted
           return @orig unless @orig.respond_to?(:gsub)
 
           sub_markdown_links(sub_html_links(@orig))
         rescue => e
-          if RUBY_VERSION < "2.1" && e.message.include?("invalid byte sequence")
-            raise e, "#{e.message}. Consider including the 'string-scrub' gem to strip invalid characters"
-          else
-            raise e
-          end
+          raise e unless RUBY_VERSION < "2.1" && e.message.include?("invalid byte sequence")
+          raise e, "#{e.message}. Consider including the 'string-scrub' gem to strip invalid characters"
         end
-        # rubocop:enable Style/GuardClause
+        # rubocop:enable Lint/RescueWithoutErrorClass
 
         private
 

data/lib/slack-notifier/version.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
+
 module Slack
   class Notifier
-    VERSION = "2.3.0".freeze # rubocop:disable Style/RedundantFreeze
+    VERSION = "2.4.0".freeze # rubocop:disable Style/RedundantFreeze
   end
 end

data/lib/slack-notifier.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require "uri"
 require "json"
 
@@ -43,7 +44,7 @@ module Slack
 
       params[:http_options] = payload.delete(:http_options) if payload.key?(:http_options)
 
-      middleware.call(payload).each do |pld|
+      middleware.call(payload).map do |pld|
         params[:payload] = pld.to_json
         client.post endpoint, params
       end

data/spec/end_to_end_spec.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 # encoding: utf-8
+
 require "spec_helper"
 
 RSpec.describe Slack::Notifier do
@@ -54,15 +55,15 @@ RSpec.describe Slack::Notifier do
                      text: "attachment message [hodor](http://winterfell.com)",
                      fallback: "fallback message" } } =>
     { payload: { attachments: [{ color: "#000",
-                                text: "attachment message <http://winterfell.com|hodor>",
-                                fallback: "fallback message" }] } },
+                                 text: "attachment message <http://winterfell.com|hodor>",
+                                 fallback: "fallback message" }] } },
 
     { attachments: { color: "#000",
                      text: nil,
                      fallback: "fallback message" } } =>
     { payload: { attachments: [{ color: "#000",
-                                text: nil,
-                                fallback: "fallback message" }] } },
+                                 text: nil,
+                                 fallback: "fallback message" }] } },
 
     { text: "hello", http_options: { timeout: 5 } } =>
     { http_options: { timeout: 5 }, payload: { text: "hello" } }

data/spec/integration/ping_integration_test.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 # encoding: utf-8
+
 require_relative "../../lib/slack-notifier"
 
 ruby = if defined?(JRUBY_VERSION)

data/spec/lib/slack-notifier/config_spec.rb

@@ -46,17 +46,17 @@ RSpec.describe Slack::Notifier::Config do
     it "is [:format_message, :format_attachments, :at] if not set" do
       subject = described_class.new
 
-      expect(subject.middleware).to eq [:format_message, :format_attachments, :at, :channels]
+      expect(subject.middleware).to eq %i[format_message format_attachments at channels]
     end
 
     it "takes an array or a splat of args" do
       subject = described_class.new
 
       subject.middleware :layer, :two
-      expect(subject.middleware).to eq [:layer, :two]
+      expect(subject.middleware).to eq %i[layer two]
 
-      subject.middleware [:one, :layer]
-      expect(subject.middleware).to eq [:one, :layer]
+      subject.middleware %i[one layer]
+      expect(subject.middleware).to eq %i[one layer]
     end
 
     it "allows passing options to middleware stack" do

data/spec/lib/slack-notifier/payload_middleware/at_spec.rb

@@ -3,7 +3,7 @@
 RSpec.describe Slack::Notifier::PayloadMiddleware::At do
   it "can handle array at" do
     subject = described_class.new(:notifier)
-    payload = { text: "hello", at: [:john, :ken, :here] }
+    payload = { text: "hello", at: %i[john ken here] }
 
     expect(subject.call(payload)).to eq text: "<@john> <@ken> <!here> hello"
   end

data/spec/lib/slack-notifier/payload_middleware/base_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.describe Slack::Notifier::PayloadMiddleware::Base do
   before(:each) do
     @registry_backup = Slack::Notifier::PayloadMiddleware.registry.dup

data/spec/lib/slack-notifier/payload_middleware/format_attachments_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.describe Slack::Notifier::PayloadMiddleware::FormatAttachments do
   it "passes the text of attachments through linkformatter with options[:formats]" do
     subject = described_class.new(:notifier, formats: [:html])
@@ -10,30 +11,30 @@ RSpec.describe Slack::Notifier::PayloadMiddleware::FormatAttachments do
   it "searches through string or symbol keys" do
     subject = described_class.new(:notifier)
     expect(Slack::Notifier::Util::LinkFormatter).to receive(:format)
-      .with("hello", formats: [:html, :markdown])
+      .with("hello", formats: %i[html markdown])
     subject.call("attachments" => [{ "text" => "hello" }])
 
     subject = described_class.new(:notifier)
     expect(Slack::Notifier::Util::LinkFormatter).to receive(:format)
-      .with("hello", formats: [:html, :markdown])
+      .with("hello", formats: %i[html markdown])
     subject.call(attachments: [{ text: "hello" }])
   end
 
   it "can handle a single attachment" do
     subject = described_class.new(:notifier)
     expect(Slack::Notifier::Util::LinkFormatter).to receive(:format)
-      .with("hello", formats: [:html, :markdown])
+      .with("hello", formats: %i[html markdown])
     subject.call(attachments: { text: "hello" })
   end
 
   it "wraps attachment into array if given as a single hash" do
-    params  = {
+    params = {
       attachments: { text: "hello" }
     }
     payload = {
       attachments: [{ text: "hello" }]
     }
-    subject = described_class.new(:notifier);
+    subject = described_class.new(:notifier)
 
     expect(subject.call(params)).to eq payload
   end

data/spec/lib/slack-notifier/payload_middleware/format_message_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.describe Slack::Notifier::PayloadMiddleware::FormatMessage do
   it "passes the text through linkformatter with options[:formats]" do
     subject = described_class.new(:notifier, formats: [:html])
@@ -8,7 +9,7 @@ RSpec.describe Slack::Notifier::PayloadMiddleware::FormatMessage do
 
     subject = described_class.new(:notifier)
     expect(Slack::Notifier::Util::LinkFormatter).to receive(:format)
-      .with("hello", formats: [:html, :markdown])
+      .with("hello", formats: %i[html markdown])
     subject.call(text: "hello")
 
     subject = described_class.new(:notifier, formats: [:markdown])

data/spec/lib/slack-notifier/payload_middleware/stack_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.describe Slack::Notifier::PayloadMiddleware::Stack do
   let(:return_one) do
     double(call: 1)
@@ -113,7 +114,6 @@ RSpec.describe Slack::Notifier::PayloadMiddleware::Stack do
       subject.set(:return_one_twice, :return_one_twice, :return_two)
 
       expect(subject.call(5)).to eq [2, 2, 2, 2]
-
     end
   end
 end

data/spec/lib/slack-notifier/payload_middleware_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.describe Slack::Notifier::PayloadMiddleware do
   before(:each) do
     @registry_backup = described_class.registry.dup

data/spec/lib/slack-notifier/util/http_client_spec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 RSpec.describe Slack::Notifier::Util::HTTPClient do
   describe "::post" do
     it "initializes Util::HTTPClient with the given uri and params then calls" do
@@ -6,7 +7,7 @@ RSpec.describe Slack::Notifier::Util::HTTPClient do
 
       expect(described_class)
         .to receive(:new).with("uri", "params")
-        .and_return(http_post_double)
+                         .and_return(http_post_double)
       expect(http_post_double).to receive(:call)
 
       described_class.post "uri", "params"

data/spec/lib/slack-notifier/util/link_formatter_spec.rb

@@ -1,7 +1,19 @@
 # frozen_string_literal: true
 # encoding: utf-8
+
 # rubocop:disable Metrics/LineLength
 RSpec.describe Slack::Notifier::Util::LinkFormatter do
+  describe "initialize & formatted" do
+    it "can be initialized without format args" do
+      subject = described_class.new("Hello World")
+      expect(subject.formatted()).to eq("Hello World")
+    end
+
+    it "can be initialized with format args" do
+      subject = described_class.new("Hello World", formats: [:html])
+      expect(subject.formatted()).to eq("Hello World")
+    end
+  end
   describe "::format" do
     it "formats html links" do
       formatted = described_class.format("Hello World, enjoy <a href='http://example.com'>this</a>.")
@@ -56,7 +68,7 @@ RSpec.describe Slack::Notifier::Util::LinkFormatter do
       end
     end
 
-    it 'doesn\'t replace valid Japanese' do
+    it "doesn't replace valid Japanese" do
       formatted = described_class.format("こんにちは")
       expect(formatted).to eq "こんにちは"
     end
@@ -71,6 +83,68 @@ RSpec.describe Slack::Notifier::Util::LinkFormatter do
       expect(formatted).to eq "<mailto:john@example.com|John>"
     end
 
+    it "handles links with trailing parentheses" do
+      formatted = described_class.format("Hello World, enjoy [foo(bar)](http://example.com/foo(bar))<a href='http://example.com/bar(foo)'>bar(foo)</a>")
+      expect(formatted).to include("http://example.com/foo(bar)|foo(bar)")
+      expect(formatted).to include("http://example.com/bar(foo)|bar(foo)")
+    end
+
+    it "formats a number of differently formatted links" do
+      input_output = {
+        "Hello World, enjoy [this](http://example.com)." =>
+          "Hello World, enjoy <http://example.com|this>.",
+
+        "Hello World, enjoy [[this](http://example.com) in brackets]." =>
+          "Hello World, enjoy [<http://example.com|this> in brackets].",
+
+        "Hello World, enjoy ([this](http://example.com) in parens)." =>
+          "Hello World, enjoy (<http://example.com|this> in parens).",
+
+        "Hello World, enjoy [](http://example.com)." =>
+          "Hello World, enjoy <http://example.com>.",
+
+        "Hello World, enjoy [link with query](http://example.com?foo=bar)." =>
+          "Hello World, enjoy <http://example.com?foo=bar|link with query>.",
+
+        "Hello World, enjoy [link with fragment](http://example.com/#foo-bar)." =>
+          "Hello World, enjoy <http://example.com/#foo-bar|link with fragment>.",
+
+        "Hello World, enjoy [link with parens](http://example.com/foo(bar)/baz)." =>
+          "Hello World, enjoy <http://example.com/foo(bar)/baz|link with parens>.",
+
+        "Hello World, enjoy [link with query](http://example.com/(parens)?foo=bar)." =>
+          "Hello World, enjoy <http://example.com/(parens)?foo=bar|link with query>.",
+
+        "Hello World, enjoy [link with parens](http://example.com/baz?bang=foo(bar))." =>
+          "Hello World, enjoy <http://example.com/baz?bang=foo(bar)|link with parens>.",
+
+        "Hello World, enjoy [link with fragment](http://example.com/(parens)#foo-bar)." =>
+          "Hello World, enjoy <http://example.com/(parens)#foo-bar|link with fragment>.",
+
+        "Hello World, enjoy [link with fragment](http://example.com/#foo-bar=(baz))." =>
+          "Hello World, enjoy <http://example.com/#foo-bar=(baz)|link with fragment>.",
+
+        "Hello World, enjoy [this](http://example.com?foo=bar)[this2](http://example2.com)." =>
+          "Hello World, enjoy <http://example.com?foo=bar|this><http://example2.com|this2>.",
+
+        "Hello World, enjoy [this](http://example.com?foo=bar) [this2](http://example2.com/#fragment)." =>
+          "Hello World, enjoy <http://example.com?foo=bar|this> <http://example2.com/#fragment|this2>.",
+
+        "Hello World, enjoy [this](http://example.com)<a href='http://example2.com'>this2</a>." =>
+          "Hello World, enjoy <http://example.com|this><http://example2.com|this2>.",
+
+        "Hello world, [John](mailto:john@example.com)." =>
+          "Hello world, <mailto:john@example.com|John>.",
+
+        "Hello World, enjoy [foo(bar)](http://example.com/foo(bar))<a href='http://example.com/bar(foo)'>bar(foo)</a>" =>
+          "Hello World, enjoy <http://example.com/foo(bar)|foo(bar)><http://example.com/bar(foo)|bar(foo)>"
+      }
+
+      input_output.each do |input, output|
+        expect(described_class.format(input)).to eq output
+      end
+    end
+
     context "with a configured stack" do
       it "only formats html if html is the only item in formats" do
         formatted = described_class.format("Hello World, enjoy [this](http://example.com)<a href='http://example2.com'>this2</a>.", formats: [:html])

data/spec/lib/slack-notifier_spec.rb

@@ -91,7 +91,8 @@ RSpec.describe Slack::Notifier do
         payload: '{"test":"stack"}'
       )
 
-      subject.post
+      responses = subject.post
+      expect(responses).to eq([:posted])
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-notifier
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors:
 - Steven Sloan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2021-05-07 00:00:00.000000000 Z
 dependencies: []
 description: " A slim ruby wrapper for posting to slack webhooks "
 email:
@@ -48,7 +48,7 @@ homepage: http://github.com/stevenosloan/slack-notifier
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -63,9 +63,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: A slim ruby wrapper for posting to slack webhooks
 test_files: