slack_message 2.1.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e92b2faa8e8b8118a0e168cef488d64b94255c841d774909647ede3d9a9faf6b
-  data.tar.gz: d494af801908aa9f5cf25141b012df26e23a69f8ef9389c3c8bb580c46641133
+  metadata.gz: 4b476b987543e7a38fd316de55186ddee859dfc1bd71817b14ddd13b2cb79f59
+  data.tar.gz: 80932a2d8e1bcac51239ea7724cd42f419dadfb7061fd939f359c2f4a5743777
 SHA512:
-  metadata.gz: 6fceee6aeb36f7fc6b855c1ce90f647b67ce480c78e62ec2fe45bbfc347e6c9efa6ca910804c51b0edb12321953d96014ac137572d2140328109444f68512ca4
-  data.tar.gz: a9fe4697d85ac2f91197a39dacc46d1740c251f8472dcb91e8ba2132caac5c9f029cb5f88894f39542e1436ce554562d87108661863c2574655e64c866c5115e
+  metadata.gz: c6273ff440e4aa2fd9c4dba40c7e45e4c3840d02d7619dafb11d516f9a3541172499e0e81f1966103a89332bb3911fb96818984fadc0195faa27c9b5e1692fcb
+  data.tar.gz: fc1a7df622d0cfd0c10311a70478cba43b893d7cde189d4f55dd997196e544145f8ce855a4b82af920f4320314907a6fe91bb39fddf3ba5e9460d4b8a4cbb33a

data/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        ruby-version: [3.0, 2.7, 2.6]
+    runs-on: ${{ matrix.os }}
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+      - name: Install dependencies
+        run: bundle install
+      - name: Run tests
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -1,6 +1,26 @@
 # Changelog
 
-## [Unreleased]
+## [2.3.0] - 2021-11-30
+- Formally require minimum version of ruby. It wouldn't have worked anyway,
+  but worth actually specifying.
+
+## [2.2.2] - 2021-11-30
+- Add github workflow for automatic CI runs. Stolen from another project.
+
+## [2.2.1] - 2021-11-20
+- Trying to fetch user ID for a string that isn't email-like raises an error.
+- In tests, fetching user IDs is mocked out to prevent network requests.
+- Tightened up and clarified README.
+- Some internal cleanup and restructuring of modules.
+
+## [2.2.0] - 2021-11-20
+- When sending text, it is now possible to mention users and have their user
+  IDs automatically converted using `<email@email.com>` within text nodes.
+- It's now possible to override notification text.
+- Errors received from the Slack API now raise `SlackMessage::ApiError`.
+- Re-exposed a top-level method for getting user IDs, `SlackMessage.user_id`.
+- Raising some better errors when no message payload is present.
+- Using `build` now requires a profile, so configuration must exist.
 
 ## [2.1.0] - 2021-11-01
 - Change to use Slack Apps for all profiles. This should allow growth toward

data/Gemfile.lock

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

data/README.md

@@ -15,23 +15,25 @@ end
 
 To install, just add `slack_message` to your bundle and you're ready to go.
 
-Opinionated Stances
-------------
+#### Opinionated Stances
 
 Slack's API has a lot of options available to you! But this gem takes some
-opinionated stances on how to make use of that API. For instance:
+opinionated stances about usage to try to minimize the pain of integrating
+with it. For example:
 
-* No dependencies. Your lockfile is enough of a mess already.
+* SlackMessage has no dependencies. Your lockfile is enough of a mess already.
+* The code to build a message should look a lot like the message itself. Code
+  that is simple to read and understand is a priority.
 * Webhooks are passé. Only Slack Apps are supported now.
 * Unless you request otherwise, text is always rendered using `mrkdwn`. If you
   want plaintext, you'll need to ask for it. Same for the `emoji` flag.
 * As many API semantics as possible are hidden. For instance, if you post to
-  something that looks like an email address, `slack_message` is going to try to
-  look it up as an email address.
+  something that looks like an email address, `slack_message` is going to try
+  to look it up as an email address.
 * A few little hacks on the block syntax, such as adding a `blank_line` (which
   doesn't exist in the API), or leading spaces.
-* Configuration should be as simple as possible. But as much work as possible
-  should be moved from callers into configuration.
+* Configuration is kept as simple as possible. But, as much heavy lifting as
+  possible should occur just once via configuration and not on every call.
 
 Usage
 ------------
@@ -173,9 +175,7 @@ It's just as easy to send messages directly to users. SlackMessage will look for
 targets that are email-addressish, and look them up for you automatically:
 
 ```ruby
-user_email = 'hello@joemastey.com'
-
-SlackMessage.post_to(user_email) do
+SlackMessage.post_to('hello@joemastey.com') do
   text "You specifically did it! :thumbsup:"
 end
 ```
@@ -207,15 +207,13 @@ SlackMessage.post_to('#general') do
     text "See more here: #{link('result', 'https://google.com')}"
   end
 
-  text ":rocketship: hello@joemastey.com"
+  text ":rocketship: <hello@joemastey.com>"
 
   context ":custom_slack_emoji: An example footer *with some markdown*."
 end
 ```
 
 SlackMessage will compose this into Block Kit syntax and send it on its way!
-For now you'll need to read a bit of the source code to get the entire API. Sorry,
-working on it.
 
 If you've defined multiple profiles in configuration, you can specify which to
 use for your message by specifying its name:
@@ -223,6 +221,7 @@ use for your message by specifying its name:
 ```ruby
 SlackMessage.post_to('#general', as: :sidekiq_bot) do
   text ":octagonal_sign: A job has failed permanently and needs to be rescued."
+
   link_button "Sidekiq Dashboard", sidekiq_dashboard_url, style: :danger
 end
 ```
@@ -238,6 +237,55 @@ SlackMessage.post_to('#general') do
 end
 ```
 
+#### Notifying Users
+
+There are several supported ways to tag and notify users. Mentioned above, it's
+possible to DM a user by email:
+
+```ruby
+SlackMessage.post_to('hello@joemastey.com') do
+  text "Hi there!"
+end
+```
+
+You can also mention a user by email within a channel by wrapping their name
+in tags:
+
+```ruby
+SlackMessage.post_to('#general') do
+  bot_name "CoffeeBot"
+  bot_icon ":coffee:"
+
+  text ":coffee: It's your turn to make coffee <hello@joemastey.com>."
+end
+```
+
+Emails that are not wrapped in tags will be rendered as normal email addresses.
+Additionally, Slack will automatically convert a number of channel names and
+tags you're probably already used to:
+
+```ruby
+SlackMessage.post_to('#general') do
+  bot_name "CoffeeBot"
+  bot_icon ":coffee:"
+
+  text "@here There's no coffee left! Let #general know when you fix it."
+end
+```
+
+By default, the desktop notification for a message will be the text of the 
+message itself. However, you can customize desktop notifications if you prefer:
+
+```ruby
+SlackMessage.post_to('hello@joemastey.com') do
+  bot_name "CoffeeBot"
+  bot_icon ":coffee:"
+
+  notification_text "It's a coffee emergency!"
+  text "There's no coffee left!"
+end
+```
+
 ### Testing
 
 You can do some basic testing against SlackMessage, at least if you use RSpec!
@@ -254,8 +302,8 @@ RSpec.configure do |config|
 end
 ```
 
-This will stop API calls for posting messages, and will allow you access to
-some custom matchers:
+This will prevent API calls from leaking in your tests, and will allow you
+access to some custom matchers:
 
 ```ruby
 expect {
@@ -291,23 +339,24 @@ of very complicated regexes.
 What it Doesn't Do
 ------------
 
-This gem is intended to stay fairly simple. Other gems have lots of config
-options and abilities, which is wonderful, but overall complicates usage. If
-you want to add a feature, open an issue on Github first to see if it's likely
-to be merged. This gem was built out of an existing need that _didn't_ include
-most of the block API, but I'd be inclined to merge features that sustainably
-expand the DSL to include more useful features.
+This gem is intended to stay simple. Other Slack gems have lots of config
+options and abilities, which makes them powerful, but makes them a pain to use.
+If you want to add a feature, open an issue on Github first to see if it's
+likely to be merged. This gem was built out of an existing need that _didn't_
+include all of the block API, but I'd be inclined to merge features that
+sustainably expand the DSL to include more useful features.
 
 Some behaviors that are still planned but not yet added:
 
 * some API documentation amirite?
-* allow custom http_options in configuration
+* custom http_options in configuration
 * more of BlockKit's options
-* any interactive elements at all (I don't understand them yet)
+* any interactive elements at all
 * editing / updating messages
 * multiple recipients
-* more interesting return types for your message (probably related to the above)
+* more interesting return types for your message
 * richer text formatting (for instance, `ul` is currently a hack)
+* more and better organized testing capability
 
 Contributing
 ------------

data/lib/slack_message/api.rb

@@ -2,47 +2,51 @@ require 'net/http'
 require 'net/https'
 require 'json'
 
-class SlackMessage::Api
-  def self.user_id_for(email, profile)
-    uri = URI("https://slack.com/api/users.lookupByEmail?email=#{email}")
-    request = Net::HTTP::Get.new(uri).tap do |req|
-      req['Authorization']  = "Bearer #{profile[:api_token]}"
-      req['Content-type']   = "application/json; charset=utf-8"
-    end
+module SlackMessage::Api
+  extend self
 
-    response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
-      http.request(request)
+  def user_id_for(email, profile)
+    unless email =~ SlackMessage::EMAIL_PATTERN
+      raise ArgumentError, "Tried to find profile by invalid email address '#{email}'"
     end
 
+    response = look_up_user_by_email(email, profile)
+
     if response.code != "200"
-      raise "Got an error back from the Slack API (HTTP #{response.code}):\n#{response.body}"
+      raise SlackMessage::ApiError, "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."
+      raise SlackMessage::ApiError, "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}"
+      raise SlackMessage::ApiError, "Unable to parse JSON response from Slack API\n#{response.body}"
     end
 
     if payload.include?("error") && payload["error"] == "invalid_auth"
-      raise "Received an error because your authentication token isn't properly configured:\n#{response.body}"
+      raise SlackMessage::ApiError, "Received an error because your authentication token isn't properly configured."
+    elsif payload.include?("error") && payload["error"] == "users_not_found"
+      raise SlackMessage::ApiError, "Couldn't find a user with the email '#{email}'."
     elsif payload.include?("error")
-      raise "Received error response from Slack during user lookup:\n#{response.body}"
+      raise SlackMessage::ApiError, "Received error response from Slack during user lookup:\n#{response.body}"
     end
 
     payload["user"]["id"]
   end
 
-  def self.post(payload, target, profile)
+  def post(payload, target, profile)
     params  = {
       channel: target,
       username: payload.custom_bot_name || profile[:name],
       blocks: payload.render,
-      text: payload.notification_text,
+      text: payload.custom_notification,
     }
 
+    if params[:blocks].length == 0
+      raise ArgumentError, "Tried to send an entirely empty message."
+    end
+
     icon = payload.custom_bot_icon || profile[:icon]
     if icon =~ /^:\w+:$/
       params[:icon_emoji] = icon
@@ -58,24 +62,39 @@ class SlackMessage::Api
 
     # let's try to be helpful about error messages
     if ["token_revoked", "token_expired", "invalid_auth", "not_authed"].include?(error)
-      raise "Couldn't send slack message because the API key for profile '#{profile[:handle]}' is wrong."
+      raise SlackMessage::ApiError, "Couldn't send slack message because the API key for profile '#{profile[:handle]}' is wrong."
     elsif ["no_permission", "ekm_access_denied"].include?(error)
-      raise "Couldn't send slack message because the API key for profile '#{profile[:handle]}' isn't allowed to post messages."
+      raise SlackMessage::ApiError, "Couldn't send slack message because the API key for profile '#{profile[:handle]}' isn't allowed to post messages."
     elsif error == "channel_not_found"
-      raise "Tried to send Slack message to non-existent channel or user '#{target}'"
+      raise SlackMessage::ApiError, "Tried to send Slack message to non-existent channel or user '#{target}'"
     elsif error == "invalid_arguments"
-      raise "Tried to send Slack message with invalid payload."
+      raise SlackMessage::ApiError, "Tried to send Slack message with invalid payload."
     elsif response.code == "302"
-      raise "Got 302 response while posting to Slack. Check your API key for profile '#{profile[:handle]}'."
+      raise SlackMessage::ApiError, "Got 302 response while posting to Slack. Check your API key for profile '#{profile[:handle]}'."
     elsif response.code != "200"
-      raise "Got an error back from the Slack API (HTTP #{response.code}):\n#{response.body}"
+      raise SlackMessage::ApiError, "Got an error back from the Slack API (HTTP #{response.code}):\n#{response.body}"
     end
 
     response
   end
 
-  # mostly test harness
-  def self.post_message(profile, params)
+  private
+
+  # mostly for test harnesses
+
+  def look_up_user_by_email(email, profile)
+    uri = URI("https://slack.com/api/users.lookupByEmail?email=#{email}")
+    request = Net::HTTP::Get.new(uri).tap do |req|
+      req['Authorization']  = "Bearer #{profile[:api_token]}"
+      req['Content-type']   = "application/json; charset=utf-8"
+    end
+
+    Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+      http.request(request)
+    end
+  end
+
+  def post_message(profile, params)
     uri = URI("https://slack.com/api/chat.postMessage")
     request = Net::HTTP::Post.new(uri).tap do |req|
       req['Authorization']  = "Bearer #{profile[:api_token]}"
@@ -87,6 +106,4 @@ class SlackMessage::Api
       http.request(request)
     end
   end
-
-  private_class_method :post_message
 end

data/lib/slack_message/dsl.rb

@@ -1,19 +1,21 @@
 class SlackMessage::Dsl
-  attr_reader :body, :default_section, :custom_bot_name, :custom_bot_icon
-  attr_accessor :notification_text
+  attr_reader :body, :default_section, :custom_bot_name, :custom_bot_icon, :profile
+  attr_accessor :custom_notification
 
-  EMSPACE = " " # unicode emspace
+  EMSPACE = " " # unicode emspace, Slack won't compress this
 
-  def initialize(block)
+  def initialize(block, profile)
     # 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(self)
-    @custom_bot_name = nil
-    @custom_bot_icon = nil
-    @notification_text = nil
+    @body             = []
+    @profile          = profile
+    @default_section  = Section.new(self)
+
+    @custom_bot_name      = nil
+    @custom_bot_icon      = nil
+    @custom_notification  = nil
   end
 
   # allowable top-level entities within a block
@@ -56,9 +58,11 @@ class SlackMessage::Dsl
     finalize_default_section
 
     if text == "" || text.nil?
-      raise ArgumentError, "tried to create a context block without a value"
+      raise ArgumentError, "Cannot create a context block without a value."
     end
 
+    text = self.enrich_text(text)
+
     @body.push({ type: "context", elements: [{
       type: "mrkdwn", text: text
     }]})
@@ -79,7 +83,7 @@ class SlackMessage::Dsl
 
   # end delegation
 
-  # custom bot name
+  # bot / notification overrides
 
   def bot_name(name)
     @custom_bot_name = name
@@ -89,6 +93,10 @@ class SlackMessage::Dsl
     @custom_bot_icon = icon
   end
 
+  def notification_text(msg)
+    @custom_notification = msg
+  end
+
   # end bot name
 
   def render
@@ -100,6 +108,20 @@ class SlackMessage::Dsl
     @caller_self.send meth, *args, &blk
   end
 
+  # replace emails w/ real user IDs
+  def enrich_text(text_body)
+    text_body.scan(SlackMessage::EMAIL_TAG_PATTERN).each do |email_tag|
+      raw_email = email_tag.gsub(/[><]/, '')
+      user_id   = SlackMessage::Api::user_id_for(raw_email, profile)
+
+      text_body.gsub!(email_tag, "<@#{user_id}>") if user_id
+    rescue SlackMessage::ApiError => e
+      # swallow errors for not-found users
+    end
+
+    text_body
+  end
+
   private
 
   # when doing things that would generate new top-levels, first try
@@ -123,9 +145,11 @@ class SlackMessage::Dsl
 
     def text(msg)
       if msg == "" || msg.nil?
-        raise ArgumentError, "tried to create text node without a value"
+        raise ArgumentError, "Cannot create a text node without a value."
       end
 
+      msg = @parent.enrich_text(msg)
+
       if @body.include?(:text)
         @body[:text][:text] << "\n#{msg}"
 
@@ -135,19 +159,21 @@ class SlackMessage::Dsl
     end
 
     def ul(elements)
-      raise ArgumentError, "please pass an array" unless elements.respond_to?(:map)
+      raise ArgumentError, "Please pass an array when creating a ul." unless elements.respond_to?(:map)
+
+      msg = elements.map { |text| "#{EMSPACE}• #{text}" }.join("\n")
+      msg = @parent.enrich_text(msg)
 
-      text(
-        elements.map { |text| "#{EMSPACE}• #{text}" }.join("\n")
-      )
+      text(msg)
     end
 
     def ol(elements)
-      raise ArgumentError, "please pass an array" unless elements.respond_to?(:map)
+      raise ArgumentError, "Please pass an array when creating an ol." unless elements.respond_to?(:map)
 
-      text(
-        elements.map.with_index(1) { |text, idx| "#{EMSPACE}#{idx}. #{text}" }.join("\n")
-      )
+      msg = elements.map.with_index(1) { |text, idx| "#{EMSPACE}#{idx}. #{text}" }.join("\n")
+      msg = @parent.enrich_text(msg)
+
+      text(msg)
     end
 
     # styles:  default, primary, danger
@@ -205,9 +231,10 @@ class SlackMessage::Dsl
 
     def list_item(title, value)
       if value == "" || value.nil?
-        raise ArgumentError, "can't create a list item for '#{title}' without a value"
+        raise ArgumentError, "Can't create a list item for '#{title}' without a value."
       end
 
+      value = @parent.enrich_text(value)
       @list.add(title, value)
     end
 
@@ -220,10 +247,14 @@ class SlackMessage::Dsl
     end
 
     def render
+      unless has_content?
+        raise ArgumentError, "Can't create a section with no content."
+      end
+
       body[:fields] = @list.render if @list.any?
 
-      if body[:text] && body[:text][:text] && !@parent.notification_text
-        @parent.notification_text = body[:text][:text]
+      if body[:text] && body[:text][:text] && !@parent.custom_notification
+        @parent.notification_text(body[:text][:text])
       end
 
       body

data/lib/slack_message/rspec.rb

@@ -30,7 +30,7 @@ module SlackMessage::RSpec
   FauxResponse = Struct.new(:code, :body)
 
   def self.included(_)
-    SlackMessage::Api.singleton_class.undef_method(:post_message)
+    SlackMessage::Api.undef_method(:post_message)
     SlackMessage::Api.define_singleton_method(:post_message) do |profile, params|
       @@listeners.each do |listener|
         listener.record_call(params.merge(profile: profile))
@@ -53,6 +53,12 @@ module SlackMessage::RSpec
 
       return FauxResponse.new('200', response.to_json)
     end
+
+    SlackMessage::Api.undef_method(:look_up_user_by_email)
+    SlackMessage::Api.define_singleton_method(:look_up_user_by_email) do |email, profile|
+      response = {"ok"=>true, "user"=>{"id"=>"U5432CBA"}}
+      return FauxResponse.new('200', response.to_json)
+    end
   end
 
   # w/ channel

data/lib/slack_message.rb

@@ -3,6 +3,11 @@ module SlackMessage
   require 'slack_message/api'
   require 'slack_message/configuration'
 
+  EMAIL_TAG_PATTERN = /<[^@ \t\r\n\<]+@[^@ \t\r\n]+\.[^@ \t\r\n]+>/
+  EMAIL_PATTERN = /^\S{1,}@\S{2,}\.\S{2,}$/
+
+  class ApiError < RuntimeError; end
+
   def self.configuration
     Configuration
   end
@@ -11,35 +16,43 @@ module SlackMessage
     configuration.configure(&block)
   end
 
+  def self.user_id(email, profile_name = :default)
+    profile = Configuration.profile(profile_name)
+    Api.user_id_for(email, profile)
+  end
+
   def self.post_to(target, as: :default, &block)
-    payload = Dsl.new(block).tap do |instance|
+    profile = Configuration.profile(as)
+
+    payload = Dsl.new(block, profile).tap do |instance|
       instance.instance_eval(&block)
     end
 
-    profile = Configuration.profile(as)
-    target  = Api::user_id_for(target, profile) if target =~ /^\S{1,}@\S{2,}\.\S{2,}$/
+    target  = Api::user_id_for(target, profile) if target =~ EMAIL_PATTERN
 
     Api.post(payload, 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)
     if profile[:default_channel].nil?
       raise ArgumentError, "Sorry, you need to specify a default_channel for profile #{profile_name} to use post_as"
     end
 
+    payload = Dsl.new(block, profile).tap do |instance|
+      instance.instance_eval(&block)
+    end
+
     target  = profile[:default_channel]
-    target  = Api::user_id_for(target, profile) if target =~ /^\S{1,}@\S{2,}\.\S{2,}$/
+    target  = Api::user_id_for(target, profile) if target =~ EMAIL_PATTERN
 
     Api.post(payload, target, profile)
   end
 
-  def self.build(&block)
-    Dsl.new(block).tap do |instance|
+  def self.build(profile_name = :default, &block)
+    profile = Configuration.profile(profile_name)
+
+    Dsl.new(block, profile).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     = "2.1.0"
+  gem.version     = "2.3.0"
   gem.summary     = "A nice DSL for composing rich messages in Slack"
   gem.authors     = ["Joe Mastey"]
   gem.email       = 'hello@joemastey.com'
@@ -18,6 +18,8 @@ Gem::Specification.new do |gem|
     "source_code_uri" => "http://github.com/jmmastey/slack_message",
   }
 
+  gem.required_ruby_version = '>= 2.6.0'
+
   gem.add_development_dependency "rspec", "3.10.0"
   gem.add_development_dependency "pry", "0.14.1"
   gem.add_development_dependency "rb-readline", "0.5.5"

data/spec/slack_message_spec.rb

@@ -1,31 +1,14 @@
 require 'spec_helper'
 
 RSpec.describe SlackMessage do
-  describe "API convenience" do
-    before do
-      SlackMessage.configure do |config|
-        config.add_profile(name: 'default profile', api_token: 'abc123')
-      end
-    end
-
-    after do
-      SlackMessage.configuration.reset
-    end
-
-    it "can grab user IDs" do
-      profile = SlackMessage::Configuration.profile(:default)
-      allow(Net::HTTP).to receive(:start).and_return(
-        double(code: "200", body: '{ "user": { "id": "ABC123" }}')
-      )
-
-      result = SlackMessage::Api.user_id_for("hello@joemastey.com", profile)
-      expect(result).to eq("ABC123")
-    end
-  end
-
   describe "DSL" do
     describe "#build" do
       it "renders some JSON" do
+        SlackMessage.configure do |config|
+          config.clear_profiles!
+          config.add_profile(name: 'default profile', api_token: 'abc123')
+        end
+
         expected_output = [
           { type: "section",
             text: { text: "foo", type: "mrkdwn" }
@@ -42,12 +25,9 @@ RSpec.describe SlackMessage do
   end
 
   describe "configuration" do
-    after do
-      SlackMessage.configuration.reset
-    end
-
     it "lets you add and fetch profiles" do
       SlackMessage.configure do |config|
+        config.clear_profiles!
         config.add_profile(name: 'default profile', api_token: 'abc123')
         config.add_profile(:nonstandard, name: 'another profile', api_token: 'abc123')
       end
@@ -141,4 +121,34 @@ RSpec.describe SlackMessage do
       }.to post_to_slack.with_content_matching(/foo/)
     end
   end
+
+  describe "API convenience" do
+    let(:profile) { SlackMessage::Configuration.profile(:default) }
+
+    before do
+      SlackMessage.configure do |config|
+        config.clear_profiles!
+        config.add_profile(name: 'default profile', api_token: 'abc123')
+      end
+    end
+
+    it "converts user IDs within text when tagged properly" do
+      allow(SlackMessage::Api).to receive(:user_id_for).and_return('ABC123')
+
+      expect {
+        SlackMessage.post_to('#general') { text("Working: <hello@joemastey.com> ") }
+      }.to post_to_slack.with_content_matching(/ABC123/)
+
+      expect {
+        SlackMessage.post_to('#general') { text("Not Tagged: hello@joemastey.com ") }
+      }.to post_to_slack.with_content_matching(/hello@joemastey.com/)
+
+
+      allow(SlackMessage::Api).to receive(:user_id_for).and_raise(SlackMessage::ApiError)
+
+      expect {
+        SlackMessage.post_to('#general') { text("Not User: <nuffin@nuffin.nuffin>") }
+      }.to post_to_slack.with_content_matching(/\<nuffin@nuffin.nuffin\>/)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_message
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Joe Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-02 00:00:00.000000000 Z
+date: 2021-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,6 +58,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
 - ".ruby-version"
 - CHANGELOG.md
@@ -89,7 +90,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.6.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="