slack_message 1.7.1 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f3438c93abd1488bafc0ee9f33df94674290b68bd94110e8f2e601d95d3254bc
-  data.tar.gz: 5eee7e715e66042ab6c3ccbc47eedba3e2ddddacd327e1096e3a2d3476b076b0
+  metadata.gz: 455886af2c6e775c37db510da7d5003abd131711107e9a18af2e10a714f9c154
+  data.tar.gz: '029d322491f3e63df60cd61eb2c6528132cce722a4ca0fa2db47fd790702fa04'
 SHA512:
-  metadata.gz: ddc5ace3b66e6977b164accfeec16c67450ed8fbd182939e85aa1d56c251319f203c4527d75d410c2858bbfa7540889a83ed08aed12890488944077edf1867ed
-  data.tar.gz: 16601f240ee826b8cadbd03429b5fd431ba21a5b159c1ca3c70932da362b54388c32115544bf782c45f9e2b1c603801d82e2fd6827e7020abfcaed18669601ee
+  metadata.gz: dd4bc35189956140e5409d1d2e325e2cb6b9423e23fbcb6f81399281b10e4447b8c1bed8e8447f7dac59b5282e9c39b4907231225f0858abe6116fe9419b9269
+  data.tar.gz: d91718d74c17d0b1c79485de6311a70a579b1f80916c4328afa813800735b12d29e1069cfdc1721f1954839a6b55d25c0fa292ed41d02350ac0c1665a3475aa2

data/CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## [Unreleased]
 
+## [1.8.0] - 2021-10-07
+- Added the ability to test in RSpec
+
 ## [1.7.1] - 2021-10-06
 - Fixed literally a syntax issue.
 - Fixed specs.

data/README.md

@@ -214,6 +214,36 @@ SlackMessage.post_to('#general') do
 end
 ```
 
+### Testing
+
+You can do some basic testing against SlackMessage, at least if you use RSpec!
+You'll need to require and include the testing behavior like this, in your
+spec_helper file:
+
+```ruby
+require 'slack_message/rspec'
+
+RSpec.configure do |config|
+  include SlackMessage::RSpec
+
+  # your other config
+end
+```
+
+This will stop API calls for posting messages, and will allow you access to
+some custom matchers:
+
+```ruby
+expect {
+  SlackMessage.post_to('#general') { text "foo" }
+}.to post_slack_message_to('#general').with_content_matching(/foo/)
+```
+
+Be forewarned, I'm frankly not that great at more complicated RSpec matchers,
+so I'm guessing there are some bugs. Also, because the content of a message
+gets turned into a complex JSON object, matching against content isn't capable
+of very complicated regexes.
+
 Opinionated Stances
 ------------
 

data/lib/slack_message/api.rb

@@ -45,9 +45,9 @@ class SlackMessage::Api
       channel: target,
       username: profile[:name],
       blocks: payload
-    }.to_json
+    }
 
-    response = Net::HTTP.post_form uri, { payload: params }
+    response = execute_post_form(uri, params, profile[:handle])
 
     # let's try to be helpful about error messages
     if response.body == "invalid_token"
@@ -64,4 +64,8 @@ class SlackMessage::Api
 
     response
   end
+
+  def self.execute_post_form(uri, params, _profile)
+    Net::HTTP.post_form uri, { payload: params.to_json }
+  end
 end

data/lib/slack_message/configuration.rb

@@ -27,6 +27,10 @@ module SlackMessage::Configuration
 
   ###
 
+  def self.clear_profiles! # test harness, mainly
+    @@profiles = {}
+  end
+
   def self.add_profile(handle = :default, name:, url:, default_channel: nil)
     if @@profiles.include?(handle)
       warn "WARNING: Overriding profile '#{handle}' in SlackMessage config"

data/lib/slack_message/rspec.rb

@@ -0,0 +1,108 @@
+require 'rspec/expectations'
+require 'rspec/mocks'
+
+# Honestly, this code is what happens when you do not understand the RSpec
+# custom expectation API really at all, but you really want to create your
+# matcher. This code is soo baaad.
+
+module SlackMessage::RSpec
+  extend RSpec::Matchers::DSL
+
+  @@listeners = []
+
+  def self.register_expectation_listener(expectation_instance)
+    @@listeners << expectation_instance
+  end
+
+  def self.unregister_expectation_listener(expectation_instance)
+    @@listeners.delete(expectation_instance)
+  end
+
+  FauxResponse = Struct.new(:code, :body)
+
+  def self.included(_)
+    SlackMessage::Api.singleton_class.undef_method(:execute_post_form)
+    SlackMessage::Api.define_singleton_method(:execute_post_form) do |uri, params, profile|
+      @@listeners.each do |listener|
+        listener.record_call(params.merge(profile: profile, uri: uri))
+      end
+
+      return FauxResponse.new('200', 'ok')
+    end
+  end
+
+  matcher :post_slack_message_to do |expected|
+    match do |actual|
+      @instance ||= PostTo.new
+      @instance.with_channel(expected)
+
+      actual.call
+      @instance.enforce_expectations
+    end
+
+    chain :with_content_matching do |content_expectation|
+      @instance ||= PostTo.new
+      @instance.with_content_matching(content_expectation)
+    end
+
+    failure_message { @instance.failure_message }
+    failure_message_when_negated { @instance.failure_message_when_negated }
+
+    supports_block_expectations
+  end
+
+  class PostTo
+    def initialize
+      @captured_calls = []
+      @content_expectation = nil
+      @channel = nil
+
+      SlackMessage::RSpec.register_expectation_listener(self)
+    end
+
+    def record_call(deets)
+      @captured_calls.push(deets)
+    end
+
+    def with_channel(channel)
+      @channel = channel
+    end
+
+    def with_content_matching(content_expectation)
+      raise ArgumentError unless content_expectation.is_a? Regexp
+      @content_expectation = content_expectation
+    end
+
+    def enforce_expectations
+      SlackMessage::RSpec.unregister_expectation_listener(self)
+      matching_messages.any? { |msg| body_matches_expectation?(msg.fetch(:blocks)) }
+    end
+
+    def matching_messages
+      @captured_calls.select { |c| c[:channel] == @channel }
+    end
+
+    def body_matches_expectation?(sent)
+      return true unless @content_expectation
+
+      sent.to_s =~ @content_expectation
+    end
+
+    def failure_message
+      if @content_expectation
+        "expected block to post slack message to '#{@channel}' with content matching #{@content_expectation.inspect}"
+      else
+        "expected block to post slack message to '#{@channel}'"
+      end
+    end
+
+    # TODO: does content_matching even make sense for negated test?
+    def failure_message_when_negated
+      if @content_expectation
+        "expected block not to post slack message to '#{@channel}' with content matching #{@content_expectation.inspect}"
+      else
+        "expected block not to post slack message to '#{@channel}'"
+      end
+    end
+  end
+end

data/slack_message.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = 'slack_message'
-  gem.version     = "1.7.1"
+  gem.version     = "1.8.0"
   gem.summary     = "A nice DSL for composing rich messages in Slack"
   gem.authors     = ["Joe Mastey"]
   gem.email       = 'hello@joemastey.com'

data/spec/slack_message_spec.rb

@@ -1,10 +1,6 @@
 require 'spec_helper'
 
 RSpec.describe SlackMessage do
-  it "includes a bunch of stuff" do
-    expect(SlackMessage).to respond_to(:post_to)
-  end
-
   describe "API convenience" do
     it "can grab user IDs" do
       SlackMessage.configure { |c| c.api_token = "asdf" }
@@ -72,4 +68,31 @@ RSpec.describe SlackMessage do
       }.to raise_error(ArgumentError)
     end
   end
+
+  describe "custom expectations" do
+    before do
+      SlackMessage.configure do |config|
+        config.clear_profiles!
+        config.add_profile(name: 'default profile', url: 'http://hooks.slack.com/1234/')
+      end
+    end
+
+    it "can assert expectations against posts" do
+      expect {
+        SlackMessage.post_to('#lieutenant') { text "foo" }
+      }.not_to post_slack_message_to('#general')
+
+      expect {
+        SlackMessage.post_to('#general') { text "foo" }
+      }.to post_slack_message_to('#general').with_content_matching(/foo/)
+    end
+
+    it "is not stateful" do
+      expect {
+        SlackMessage.post_to('#general') { text "foo" }
+      }.to post_slack_message_to('#general')
+
+      expect { }.not_to post_slack_message_to('#general')
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,4 +1,5 @@
 require_relative '../lib/slack_message'
+require_relative '../lib/slack_message/rspec'
 
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
@@ -49,4 +50,6 @@ RSpec.configure do |config|
   # test failures related to randomization by passing the same `--seed` value
   # as the one that triggered the failure.
   Kernel.srand config.seed
+
+  include SlackMessage::RSpec
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_message
 version: !ruby/object:Gem::Version
-  version: 1.7.1
+  version: 1.8.0
 platform: ruby
 authors:
 - Joe Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-06 00:00:00.000000000 Z
+date: 2021-10-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -70,6 +70,7 @@ files:
 - lib/slack_message/api.rb
 - lib/slack_message/configuration.rb
 - lib/slack_message/dsl.rb
+- lib/slack_message/rspec.rb
 - slack_message.gemspec
 - spec/slack_message_spec.rb
 - spec/spec_helper.rb