slack_message 1.5.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a3275f61d16198e8a8283d22f1258dc9480ad7b66b977b6505fcfe79ef69fd
-  data.tar.gz: 8cf6cdddbfbfcd1cb476aaa6384de6f94a7030fd813bdeef4aeda70e34811d2a
+  metadata.gz: 455886af2c6e775c37db510da7d5003abd131711107e9a18af2e10a714f9c154
+  data.tar.gz: '029d322491f3e63df60cd61eb2c6528132cce722a4ca0fa2db47fd790702fa04'
 SHA512:
-  metadata.gz: 5a2395b51855660a9eba01115f3dbef9859c554c6365ede4d12c74353e72b117a763c0c526fe211f44b1489281fccb2a8fa3e53cc2883aa8cbc935d932598df8
-  data.tar.gz: af50cc1f1bd0d93124115f34eae72bbe90e9309d79ec862b0a62e4d8b6c7bb0bc5e32e950bc9c7bc86f22fa30787c54d110974dcdd2f320d85b7afc0fb26dcc0
+  metadata.gz: dd4bc35189956140e5409d1d2e325e2cb6b9423e23fbcb6f81399281b10e4447b8c1bed8e8447f7dac59b5282e9c39b4907231225f0858abe6116fe9419b9269
+  data.tar.gz: d91718d74c17d0b1c79485de6311a70a579b1f80916c4328afa813800735b12d29e1069cfdc1721f1954839a6b55d25c0fa292ed41d02350ac0c1665a3475aa2

data/CHANGELOG.md

@@ -2,11 +2,28 @@
 
 ## [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.
+- Fixed API to include JSON since consumers may not have loaded it.
+
+## [1.7.0] - 2021-10-06
+- THIS RELEASE IS BADLY BROKEN.
+- Added new error messages when API configuration is wrong / missing.
+- Fixed issue with `instance_eval` and using methods within block.
+- Fixed issue with sectionless `list_item`.
+
+## [1.6.0] - 2021-10-04
+- Added `:default_channel` and `post_as` to deal with repetitive channel usage.
+
 ## [1.5.0] - 2021-10-01
-- Added `ol` and `ul` to sections w/ some formatting
+- Added `ol` and `ul` to sections w/ some formatting.
 
 ## [1.4.0] - 2021-09-27
-- Moved image to accessory_image to differentiate between the image block
+- Changed `image` to `accessory_image` to differentiate between the image block
   and the accessory image within a block.
 
 ## [1.3.0] - 2021-09-27
@@ -15,13 +32,12 @@
 - Added warnings for potentially invalid URLs.
 
 ## [1.2.0] - 2021-09-26
-- Turns out gemspec was broken. Fixed that.
+- Fixed gemspec, which was entirely broken.
 
 ## [1.1.0] - 2021-09-26
 - Expanded the README significantly w/ usage instructions.
 - Added lots of error handling to requests.
 
 ## [1.0.0] - 2021-09-25
-
 - Added the base gem w/ a DSL for constructing blocks using sections.
 - Added a changelog, apparently.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    slack_message (1.2.0)
+    slack_message (1.7.1)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -55,6 +55,28 @@ SlackMessage.configure do |config|
 end
 ```
 
+If you frequently ping the same channel with the same bot, and don't want to
+continually specify the channel name, you can specify a default channel and
+post using the `post_as` method. It is otherwise identical to `post_to`, but
+allows you to omit the channel argument:
+
+```ruby
+SlackMessage.configure do |config|
+  config.add_profile(:prod_alert_bot,
+    name: 'Prod Alert Bot',
+    url: ENV['SLACK_PROD_ALERT_WEBHOOK_URL'],
+    default_channel: '#red_alerts'
+  )
+end
+
+SlackMessage.post_as(:prod_alert_bot) do
+  text ":ambulance: weeooo weeooo something went wrong"
+end
+```
+
+Note that `post_as` does not allow you to choose a channel (because that's just
+the same as using `post_to`), so you really do have to specify `default_channel`.
+
 #### Configuring User Search
 
 Slack's API no longer allows you to send DMs to users by username. You need to
@@ -192,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
 ------------
 
@@ -203,6 +255,8 @@ opinionated stances on how to make use of that API. For instance:
 * Generally, same goes for the `emoji` flag on almost every text element.
 * It's possible to ask for a `blank_line` in sections, even though that concept
   isn't real. In this case, a text line containing only an emspace is rendered.
+* It's easy to configure a bot for consistent name / channel use. My previous
+  use of SlackNotifier led to frequently inconsistent names.
 
 What it Doesn't Do
 ------------
@@ -218,11 +272,11 @@ DSL to include more of the block API itself.
 
 Also, some behaviors that are still planned but not yet added:
 
+* some API documentation amirite?
 * allow custom http_options in configuration
 * more of BlockKit's options
 * any interactive elements at all (I don't understand them yet)
 * more interesting return types for your message
-* some way to specify default channel for a given profile (and omit param to post_to)
 * richer text formatting (ul is currently a hack)
 
 Contributing

data/lib/slack_message/api.rb

@@ -1,5 +1,6 @@
 require 'net/http'
 require 'net/https'
+require 'json'
 
 class SlackMessage::Api
   def self.user_id_for(email)
@@ -17,9 +18,16 @@ class SlackMessage::Api
 
     if response.code != "200"
       raise "Got an error back from the Slack API (HTTP #{response.code}):\n#{response.body}"
+    elsif response.body == ""
+      raise "Received empty 200 response from Slack when looking up user info. Check your API key."
+    end
+
+    begin
+      payload = JSON.parse(response.body)
+    rescue
+      raise "Unable to parse JSON response from Slack API\n#{response.body}"
     end
 
-    payload = JSON.parse(response.body)
     if payload.include?("error") && payload["error"] == "invalid_auth"
       raise "Received an error because your authentication token isn't properly configured:\n#{response.body}"
     elsif payload.include?("error")
@@ -37,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"
@@ -48,10 +56,16 @@ class SlackMessage::Api
       raise "Tried to send Slack message to non-existent channel or user '#{target}'"
     elsif response.body == "missing_text_or_fallback_or_attachments"
       raise "Tried to send Slack message with invalid payload."
+    elsif response.code == "302"
+      raise "Got 302 response while posting to Slack. Check your webhook URL for '#{profile[:handle]}'."
     elsif response.code != "200"
       raise "Got an error back from the Slack API (HTTP #{response.code}):\n#{response.body}"
     end
 
     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,12 +27,16 @@ module SlackMessage::Configuration
 
   ###
 
-  def self.add_profile(handle = :default, name:, url:)
+  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"
     end
 
-    @@profiles[handle] = { name: name, url: url, handle: handle }
+    @@profiles[handle] = { name: name, url: url, handle: handle, default_channel: default_channel }
   end
 
   def self.profile(handle, custom_name: nil)

data/lib/slack_message/dsl.rb

@@ -3,7 +3,11 @@ class SlackMessage::Dsl
 
   EMSPACE = " " # unicode emspace
 
-  def initialize
+  def initialize(block)
+    # Delegate missing methods to caller scope. Thanks 2008:
+    # https://www.dan-manges.com/blog/ruby-dsls-instance-eval-with-delegation
+    @caller_self = eval("self", block.binding)
+
     @body = []
     @default_section = Section.new
     @custom_bot_name = nil
@@ -81,13 +85,17 @@ class SlackMessage::Dsl
     @body
   end
 
+  def method_missing(meth, *args, &blk)
+    @caller_self.send meth, *args, &blk
+  end
+
   private
 
   # when doing things that would generate new top-levels, first try
   # to finish the implicit section.
   def finalize_default_section
     if default_section.has_content?
-      @body.push(default_section.body)
+      @body.push(default_section.render)
     end
 
     @default_section = Section.new

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/lib/slack_message.rb

@@ -11,12 +11,12 @@ module SlackMessage
     configuration.configure(&block)
   end
 
-  def self.user_id_for(email)
+  def self.user_id_for(email) # spooky undocumented public method 👻
     Api::user_id_for(email)
   end
 
   def self.post_to(target, as: :default, &block)
-    payload = Dsl.new.tap do |instance|
+    payload = Dsl.new(block).tap do |instance|
       instance.instance_eval(&block)
     end
 
@@ -26,8 +26,24 @@ module SlackMessage
     Api.post(payload.render, target, profile)
   end
 
+  def self.post_as(profile_name, &block)
+    payload = Dsl.new(block).tap do |instance|
+      instance.instance_eval(&block)
+    end
+
+    profile = Configuration.profile(profile_name, custom_name: payload.custom_bot_name)
+    if profile[:default_channel].nil?
+      raise ArgumentError, "Sorry, you need to specify a default_channel for profile #{profile_name} to use post_as"
+    end
+
+    target  = profile[:default_channel]
+    target  = user_id_for(target) if target =~ /^\S{1,}@\S{2,}\.\S{2,}$/
+
+    Api.post(payload.render, target, profile)
+  end
+
   def self.build(&block)
-    Dsl.new.tap do |instance|
+    Dsl.new(block).tap do |instance|
       instance.instance_eval(&block)
     end.send(:render)
   end

data/slack_message.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = 'slack_message'
-  gem.version     = "1.5.0"
+  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,15 +1,12 @@
 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
-      allow(SlackMessage::Api).to receive(:api_request)
-        .with(/hello@joemastey.com/)
-        .and_return({ "user" => { "id" => "ABC123" }})
+      SlackMessage.configure { |c| c.api_token = "asdf" }
+      allow(Net::HTTP).to receive(:start).and_return(
+        double(code: "200", body: '{ "user": { "id": "ABC123" }}')
+      )
 
       result = SlackMessage.user_id_for("hello@joemastey.com")
       expect(result).to eq("ABC123")
@@ -63,7 +60,6 @@ RSpec.describe SlackMessage do
         config.add_profile(:nonstandard, name: 'another profile', url: 'http://hooks.slack.com/1234/')
       end
 
-
       expect(SlackMessage.configuration.profile(:default)[:name]).to eq('default profile')
       expect(SlackMessage.configuration.profile(:nonstandard)[:name]).to eq('another profile')
 
@@ -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.5.0
+  version: 1.8.0
 platform: ruby
 authors:
 - Joe Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-10-01 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