slack-notifier 1.5.1 → 2.4.0

data/spec/lib/slack-notifier_spec.rb

@@ -1,163 +1,98 @@
-require 'spec_helper'
+# frozen_string_literal: true
 
-describe Slack::Notifier do
-  subject { described_class.new 'http://example.com' }
+RSpec.describe Slack::Notifier do
+  let(:mock_http) do
+    class_double("Slack::Notifier::Util::HTTPClient", post: :posted)
+  end
+
+  subject { described_class.new "http://example.com", http_client: mock_http }
 
   describe "#initialize" do
     it "sets the given hook_url to the endpoint URI" do
-      expect( subject.endpoint ).to eq URI.parse 'http://example.com'
+      expect(subject.endpoint).to eq URI.parse("http://example.com")
     end
 
     it "sets the default_payload options" do
-      subject = described_class.new 'http://example.com', channel: 'foo'
-      expect( subject.channel ).to eq 'foo'
+      subject = described_class.new "http://example.com", channel: "foo"
+      expect(subject.config.defaults[:channel]).to eq "foo"
     end
 
     it "sets a custom http client" do
-      client  = double("CustomClient")
-      subject = described_class.new 'http://example.com', http_client: client
-      expect( subject.http_client ).to eq client
+      subject = described_class.new "http://example.com", http_client: mock_http
+      expect(subject.config.http_client).to eq mock_http
     end
-  end
 
-  describe "#ping" do
-    before :each do
-      allow( Slack::Notifier::DefaultHTTPClient ).to receive(:post)
-    end
+    describe "when given a block" do
+      it "yields the config object" do
+        test_double = double("Slack::Notifier::Config", defaults: {}, middleware: [])
+        allow_any_instance_of(Slack::Notifier).to receive(:config).and_return(test_double)
 
-    it "passes the message through LinkFormatter" do
-      expect( Slack::Notifier::LinkFormatter ).to receive(:format)
-                                              .with("the message")
+        expect(test_double).to receive(:test_init_method).with("foo")
 
-      described_class.new('http://example.com').ping "the message", channel: 'foo'
-    end
-
-    it "passes attachment messages through LinkFormatter" do
-      expect( Slack::Notifier::LinkFormatter ).to receive(:format)
-                                              .with("the message")
-      expect( Slack::Notifier::LinkFormatter ).to receive(:format)
-                                              .with("attachment message")
-
-      described_class.new('http://example.com').ping "the message", channel: 'foo',
-                                                                    attachments: [{
-                                                                      color: "#000",
-                                                                      text: "attachment message",
-                                                                      fallback: "fallback message"
-                                                                    }]
+        described_class.new "http://example.com" do
+          test_init_method "foo"
+        end
+      end
     end
+  end
 
-    it "allows sending only an attachment" do
-      expect( Slack::Notifier::DefaultHTTPClient ).to receive(:post).with(
-        URI.parse('http://example.com'),
-        payload: '{"channel":"foo","attachments":[{"text":"attachment","fallback":"fallback"}]}'
-      )
-
-      expect{
-        described_class.new('http://example.com')
-                       .ping channel: 'foo',
-                             attachments: [{
-                              text: 'attachment',
-                              fallback: 'fallback'
-                             }]
-      }.not_to raise_error
-    end
+  describe "#ping" do
+    it "calls #post with the message as the text key in #post" do
+      subject = described_class.new "http://example.com"
+      expect(subject).to receive(:post).with text: "message"
 
-    it "passes attachment messages through LinkFormatter, even if a single value is passed" do
-      expect( Slack::Notifier::LinkFormatter ).to receive(:format)
-                                              .with("a random message")
-      expect( Slack::Notifier::LinkFormatter ).to receive(:format)
-                                              .with("attachment message")
-      attachment = {
-        color: "#000",
-        text: "attachment message",
-        fallback: "fallback message"
-      }
-      subject.ping "a random message", attachments: attachment
+      subject.ping "message"
     end
+  end
 
-    context "with a default channel set" do
-
-      before :each do
-        @endpoint_double = instance_double "URI::HTTP"
-        allow( URI ).to receive(:parse)
-                    .and_return(@endpoint_double)
-        subject.channel = '#default'
-      end
-
-      it "does not require a channel to ping" do
-        expect{
-          subject.ping "the message"
-        }.not_to raise_error
-      end
-
-      it "uses default channel" do
-        expect( Slack::Notifier::DefaultHTTPClient ).to receive(:post)
-                          .with @endpoint_double,
-                                payload: '{"channel":"#default","text":"the message"}'
-
-        subject.ping "the message"
+  describe "#post" do
+    def notifier_with_defaults
+      mock_client = mock_http
+      described_class.new "http://example.com" do
+        defaults channel: "default",
+                 user:    "rocket"
+        http_client mock_client
       end
+    end
 
-      it "allows override channel to be set" do
-        expect( Slack::Notifier::DefaultHTTPClient ).to receive(:post)
-                          .with @endpoint_double,
-                                payload: '{"channel":"new","text":"the message"}'
+    it "uses the defaults set on initialization" do
+      subject = notifier_with_defaults
 
-        subject.ping "the message", channel: "new"
-      end
+      expect(mock_http).to receive(:post).with(
+        URI.parse("http://example.com"),
+        payload: '{"channel":"default","user":"rocket","text":"hello"}'
+      )
 
+      subject.post text: "hello"
     end
 
-    context "with default webhook" do
-      it "posts with the correct endpoint & data" do
-          @endpoint_double = instance_double "URI::HTTP"
-          allow( URI ).to receive(:parse)
-                      .with("http://example.com")
-                      .and_return(@endpoint_double)
+    it "allows overriding the set defaults" do
+      subject = notifier_with_defaults
 
-          expect( Slack::Notifier::DefaultHTTPClient ).to receive(:post)
-                            .with @endpoint_double,
-                                  payload: '{"channel":"channel","text":"the message"}'
+      expect(mock_http).to receive(:post).with(
+        URI.parse("http://example.com"),
+        payload: '{"channel":"new","user":"ship","text":"hello"}'
+      )
 
-          described_class.new("http://example.com").ping "the message", channel: "channel"
-      end
+      subject.post text: "hello", channel: "new", user: "ship"
     end
 
-    context "with a custom http_client set" do
-      it "uses it" do
-        endpoint_double = instance_double "URI::HTTP"
-        allow( URI ).to receive(:parse)
-                    .with("http://example.com")
-                    .and_return(endpoint_double)
-        client = double("CustomClient")
-        expect( client ).to receive(:post)
-                        .with endpoint_double,
-                        payload: '{"text":"the message"}'
-
-        described_class.new('http://example.com',http_client: client).ping "the message"
-      end
-    end
-  end
+    it "calls the middleware stack with the payload" do
+      subject = notifier_with_defaults
+      stack   = instance_double("Slack::Notifier::PayloadMiddleware::Stack")
+      subject.instance_variable_set(:@middleware, stack)
 
-  describe "#channel=" do
-    it "sets the given channel" do
-      subject.channel = "#foo"
-      expect( subject.channel ).to eq "#foo"
-    end
-  end
+      expect(stack).to receive(:call)
+        .with(channel: "default", user: "rocket")
+        .and_return([test: "stack"])
 
-  describe "#username=" do
-    it "sets the given username" do
-      subject.username = "foo"
-      expect( subject.username ).to eq "foo"
-    end
-  end
+      expect(mock_http).to receive(:post).with(
+        URI.parse("http://example.com"),
+        payload: '{"test":"stack"}'
+      )
 
-  describe "#escape" do
-    it "escapes sequences of < > &, but not quotes" do
-      message = %q(I've heard "Do > with <" & that sounds ridiculous.)
-      expected = %q(I've heard "Do &gt; with &lt;" &amp; that sounds ridiculous.)
-      expect( subject.escape(message) ).to eq expected
+      responses = subject.post
+      expect(responses).to eq([:posted])
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,13 +1,28 @@
-require 'rspec'
-require 'slack-notifier'
+# frozen_string_literal: true
 
-if ENV['DEBUG']
-  require 'pry'
-end
+require "rspec"
+require "slack-notifier"
+require "pry" if ENV["DEBUG"]
 
 RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
   config.mock_with :rspec do |mocks|
     mocks.verify_doubled_constant_names = true
     mocks.verify_partial_doubles        = true
   end
+
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+  config.disable_monkey_patching!
+
+  config.example_status_persistence_file_path = "spec/examples.txt"
+  config.warnings = ENV["DEBUG"] ? false : true
+
+  config.default_formatter = "doc" if config.files_to_run.one?
+
+  config.order = :random
+  Kernel.srand config.seed
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack-notifier
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 2.4.0
 platform: ruby
 authors:
 - Steven Sloan
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-12-01 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:
@@ -18,19 +18,37 @@ extensions: []
 extra_rdoc_files: []
 files:
 - lib/slack-notifier.rb
-- lib/slack-notifier/default_http_client.rb
-- lib/slack-notifier/link_formatter.rb
+- lib/slack-notifier/config.rb
+- lib/slack-notifier/payload_middleware.rb
+- lib/slack-notifier/payload_middleware/at.rb
+- lib/slack-notifier/payload_middleware/base.rb
+- lib/slack-notifier/payload_middleware/channels.rb
+- lib/slack-notifier/payload_middleware/format_attachments.rb
+- lib/slack-notifier/payload_middleware/format_message.rb
+- lib/slack-notifier/payload_middleware/stack.rb
+- lib/slack-notifier/util/escape.rb
+- lib/slack-notifier/util/http_client.rb
+- lib/slack-notifier/util/link_formatter.rb
 - lib/slack-notifier/version.rb
+- spec/end_to_end_spec.rb
 - spec/integration/ping_integration_test.rb
-- spec/lib/slack-notifier/default_http_client_spec.rb
-- spec/lib/slack-notifier/link_formatter_spec.rb
+- spec/lib/slack-notifier/config_spec.rb
+- spec/lib/slack-notifier/payload_middleware/at_spec.rb
+- spec/lib/slack-notifier/payload_middleware/base_spec.rb
+- spec/lib/slack-notifier/payload_middleware/channels_spec.rb
+- spec/lib/slack-notifier/payload_middleware/format_attachments_spec.rb
+- spec/lib/slack-notifier/payload_middleware/format_message_spec.rb
+- spec/lib/slack-notifier/payload_middleware/stack_spec.rb
+- spec/lib/slack-notifier/payload_middleware_spec.rb
+- spec/lib/slack-notifier/util/http_client_spec.rb
+- spec/lib/slack-notifier/util/link_formatter_spec.rb
 - spec/lib/slack-notifier_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/stevenosloan/slack-notifier
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -45,14 +63,22 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5.1
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: A slim ruby wrapper for posting to slack webhooks
 test_files:
+- spec/end_to_end_spec.rb
 - spec/integration/ping_integration_test.rb
-- spec/lib/slack-notifier/default_http_client_spec.rb
-- spec/lib/slack-notifier/link_formatter_spec.rb
+- spec/lib/slack-notifier/config_spec.rb
+- spec/lib/slack-notifier/payload_middleware/at_spec.rb
+- spec/lib/slack-notifier/payload_middleware/base_spec.rb
+- spec/lib/slack-notifier/payload_middleware/channels_spec.rb
+- spec/lib/slack-notifier/payload_middleware/format_attachments_spec.rb
+- spec/lib/slack-notifier/payload_middleware/format_message_spec.rb
+- spec/lib/slack-notifier/payload_middleware/stack_spec.rb
+- spec/lib/slack-notifier/payload_middleware_spec.rb
+- spec/lib/slack-notifier/util/http_client_spec.rb
+- spec/lib/slack-notifier/util/link_formatter_spec.rb
 - spec/lib/slack-notifier_spec.rb
 - spec/spec_helper.rb

data/lib/slack-notifier/default_http_client.rb

@@ -1,51 +0,0 @@
-module Slack
-  class Notifier
-
-    class DefaultHTTPClient
-
-      class << self
-        def post uri, params
-          DefaultHTTPClient.new( uri, params ).call
-        end
-      end
-
-      attr_reader :uri, :params, :http_options
-
-      def initialize uri, params
-        @uri          = uri
-        @http_options = params.delete(:http_options) || {}
-        @params       = params
-      end
-
-      def call
-        http_obj.request request_obj
-      end
-
-      private
-
-        def request_obj
-          req = Net::HTTP::Post.new uri.request_uri
-          req.set_form_data params
-
-          return req
-        end
-
-        def http_obj
-          http = Net::HTTP.new uri.host, uri.port
-          http.use_ssl = (uri.scheme == "https")
-
-          http_options.each do |opt, val|
-            if http.respond_to? "#{opt}="
-              http.send "#{opt}=", val
-            else
-              warn "Net::HTTP doesn't respond to `#{opt}=`, ignoring that option"
-            end
-          end
-
-          return http
-        end
-
-    end
-
-  end
-end

data/lib/slack-notifier/link_formatter.rb

@@ -1,62 +0,0 @@
-module Slack
-  class Notifier
-    class LinkFormatter
-
-      class << self
-
-        def format string
-          LinkFormatter.new(string).formatted
-        end
-
-      end
-
-      def initialize string
-        @orig = if string.respond_to? :scrub
-          string.scrub
-        else
-          string
-        end
-      end
-
-      def formatted
-        @orig.gsub( html_pattern ) do |match|
-          link = Regexp.last_match[1]
-          text = Regexp.last_match[2]
-          slack_link link, text
-        end.gsub( markdown_pattern ) do |match|
-          link = Regexp.last_match[2]
-          text = Regexp.last_match[1]
-          slack_link link, text
-        end
-
-      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
-      end
-
-      private
-
-        def slack_link link, text=nil
-          out = "<#{link}"
-          out << "|#{text}" if text && !text.empty?
-          out << ">"
-
-          return out
-        end
-
-        # http://rubular.com/r/19cNXW5qbH
-        def html_pattern
-          / <a (?:.*?) href=['"](.+?)['"] (?:.*?)> (.+?) <\/a> /x
-        end
-
-        # http://rubular.com/r/guJbTK6x1f
-        def markdown_pattern
-          /\[ ([^\[\]]*?) \] \( ((https?:\/\/.*?) | (mailto:.*?)) \) /x
-        end
-
-    end
-  end
-end

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

@@ -1,37 +0,0 @@
-require 'spec_helper'
-
-describe Slack::Notifier::DefaultHTTPClient do
-
-  describe "::post" do
-    it "initializes DefaultHTTPClient with the given uri and params then calls" do
-      http_post_double = instance_double("Slack::Notifier::DefaultHTTPClient")
-
-      expect( described_class ).to receive(:new)
-                               .with( 'uri', 'params' )
-                               .and_return( http_post_double )
-      expect( http_post_double ).to receive(:call)
-
-      described_class.post 'uri', 'params'
-    end
-
-    # http_post is really tested in the integration spec,
-    # where the internals are run through
-  end
-
-  describe "#initialize" do
-    it "allows setting of options for Net::HTTP" do
-      net_http_double = instance_double("Net::HTTP")
-      http_client     = described_class.new( URI.parse('http://example.com'), http_options: { open_timeout: 5 })
-
-      allow( Net::HTTP ).to receive(:new)
-                        .and_return(net_http_double)
-      allow( net_http_double ).to receive(:use_ssl=)
-      allow( net_http_double ).to receive(:request)
-
-      expect( net_http_double ).to receive(:open_timeout=).with(5)
-
-      http_client.call
-    end
-  end
-
-end

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

@@ -1,78 +0,0 @@
-# encoding: utf-8
-require 'spec_helper'
-
-describe Slack::Notifier::LinkFormatter do
-
-  describe "::format" do
-
-    it "formats html links" do
-      formatted = described_class.format("Hello World, enjoy <a href='http://example.com'>this</a>.")
-      expect( formatted ).to include("<http://example.com|this>")
-    end
-
-    it "formats markdown links" do
-      formatted = described_class.format("Hello World, enjoy [this](http://example.com).")
-      expect( formatted ).to include("<http://example.com|this>")
-    end
-
-    it "formats markdown links in brackets" do
-      formatted = described_class.format("Hello World, enjoy [[this](http://example.com) in brackets].")
-      expect( formatted ).to eq("Hello World, enjoy [<http://example.com|this> in brackets].")
-    end
-
-    it "formats markdown links with no title" do
-      formatted = described_class.format("Hello World, enjoy [](http://example.com).")
-      expect( formatted ).to include("<http://example.com>")
-    end
-
-    it "handles multiple html links" do
-      formatted = described_class.format("Hello World, enjoy <a href='http://example.com'>this</a><a href='http://example2.com'>this2</a>.")
-      expect( formatted ).to include("<http://example.com|this>")
-      expect( formatted ).to include("<http://example2.com|this2>")
-    end
-
-    it "handles multiple markdown links" do
-      formatted = described_class.format("Hello World, enjoy [this](http://example.com)[this2](http://example2.com).")
-      expect( formatted ).to include("<http://example.com|this>")
-      expect( formatted ).to include("<http://example2.com|this2>")
-    end
-
-    it "handles mixed html & markdown links" do
-      formatted = described_class.format("Hello World, enjoy [this](http://example.com)<a href='http://example2.com'>this2</a>.")
-      expect( formatted ).to include("<http://example.com|this>")
-      expect( formatted ).to include("<http://example2.com|this2>")
-    end
-
-    if "".respond_to? :scrub
-      context "when on ruby 2.1+ or have string-scrub installed" do
-        it "handles invalid unicode sequences" do
-          expect {
-            described_class.format("This sequence is invalid: \255")
-          }.not_to raise_error
-        end
-
-        it "replaces invalid unicode sequences with the unicode replacement character" do
-          formatted = described_class.format("\255")
-          expect(formatted).to eq "\uFFFD"
-        end
-      end
-    end
-
-    it "doesn't replace valid Japanese" do
-      formatted = described_class.format("こんにちは")
-      expect(formatted).to eq "こんにちは"
-    end
-
-    it "handles mailto links in markdown" do
-      formatted = described_class.format("[John](mailto:john@example.com)")
-      expect(formatted).to eq "<mailto:john@example.com|John>"
-    end
-
-    it "handles mailto links in html" do
-      formatted = described_class.format("<a href='mailto:john@example.com'>John</a>")
-      expect(formatted).to eq "<mailto:john@example.com|John>"
-    end
-
-  end
-
-end