slack_message 1.3.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb63c39ef18b4b6e6fb1d25e62300fcff41b759f3d59902c10423c306f892007
-  data.tar.gz: 499f1d885b3a00e60af92ff9d0ba17c19f59ba3b1468d178498d08802c9429dd
+  metadata.gz: a2cd232d81a66a48c9543a5b910c335bca7a82474a60472d03f7cffab3fce0d0
+  data.tar.gz: c27312311ff02ee414f2882461fe5ea9b5c07d9d8e99847ae7af33faf4a31283
 SHA512:
-  metadata.gz: b0bf20b89e6ce48e9accb2ccd475d5f999686804d3c952e6a8903958af2f7b1500011f6abd904abba5f2cf73d635498f8c1feae7e4d00aa021b3ab0b6c1a5baa
-  data.tar.gz: 42a8e2ecc5b6ca51ec1ab534e2a91bb500e352e26636f1a5671bf81244a40b321162bed30e1e7e0a78e53490575fbb0052c9d39fb108951f73425269cfafbab5
+  metadata.gz: 69352d5eb8d4f6837f66ba042817bfe0a51c3483356bbc64ded0cbc60fc7e72c084ea39df542a93bf79a6c0a8c4ad860cdb9791f28d807edb5b1c859b13f129f
+  data.tar.gz: 740af84829c6b258b4788b5f83901f242a5732e98737781efb288ee426ed232726823d9fdde453da6c7d83eb55607733e1d4b55757580676921b37abba1c70ad

data/CHANGELOG.md

@@ -2,19 +2,33 @@
 
 ## [Unreleased]
 
+## [1.7.0] - 2021-10-06
+- 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.
+
+## [1.4.0] - 2021-09-27
+- Changed `image` to `accessory_image` to differentiate between the image block
+  and the accessory image within a block.
+
 ## [1.3.0] - 2021-09-27
 - Added ability to use custom names when posting.
 - Added ability to post images within sections.
 - 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/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
@@ -69,7 +91,7 @@ SlackMessage.configure do |config|
 end
 ```
 
-### Usage
+### Posting Messages
 
 As mentioned at the top, posting a message to Slack is dang easy:
 
@@ -192,6 +214,18 @@ SlackMessage.post_to('#general') do
 end
 ```
 
+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:
+
+* Unless you request otherwise, text is always rendered using `mrkdwn`. If you
+  want plaintext, you'll need to ask for it.
+* 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.
+
 What it Doesn't Do
 ------------
 
@@ -206,9 +240,12 @@ 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
+* richer text formatting (ul is currently a hack)
 
 Contributing
 ------------

data/lib/slack_message/api.rb

@@ -17,9 +17,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")
@@ -48,6 +55,8 @@ 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

data/lib/slack_message/configuration.rb

@@ -27,12 +27,12 @@ module SlackMessage::Configuration
 
   ###
 
-  def self.add_profile(handle = :default, name:, url:)
+  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

@@ -1,7 +1,13 @@
 class SlackMessage::Dsl
   attr_reader :body, :default_section, :custom_bot_name
 
-  def initialize
+  EMSPACE = " " # unicode emspace
+
+  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
@@ -25,6 +31,24 @@ class SlackMessage::Dsl
     @body.push({ type: "divider" })
   end
 
+  def image(url, alt_text:, title: nil)
+    finalize_default_section
+
+    config = {
+      type: "image",
+      image_url: url,
+      alt_text: alt_text,
+    }
+
+    if !title.nil?
+      config[:title] = {
+        type: "plain_text", text: title, emoji: true
+      }
+    end
+
+    @body.push(config)
+  end
+
   def context(text)
     finalize_default_section
 
@@ -39,10 +63,12 @@ class SlackMessage::Dsl
 
   def text(*args); default_section.text(*args); end
   def link_button(*args); default_section.link_button(*args); end
-  def image(*args); default_section.image(*args); end
+  def accessory_image(*args); default_section.accessory_image(*args); end
   def blank_line(*args); default_section.blank_line(*args); end
   def link(*args); default_section.link(*args); end
   def list_item(*args); default_section.list_item(*args); end
+  def ul(*args); default_section.ul(*args); end
+  def ol(*args); default_section.ol(*args); end
 
   # end delegation
 
@@ -59,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
@@ -88,6 +118,20 @@ class SlackMessage::Dsl
       end
     end
 
+    def ul(elements)
+      raise Arguments, "please pass an array" unless elements.respond_to?(:map)
+      text(
+        elements.map { |text| "#{EMSPACE}• #{text}" }.join("\n")
+      )
+    end
+
+    def ol(elements)
+      raise Arguments, "please pass an array" unless elements.respond_to?(:map)
+      text(
+        elements.map.with_index(1) { |text, idx| "#{EMSPACE}#{idx}. #{text}" }.join("\n")
+      )
+    end
+
     # styles:  default, primary, danger
     def link_button(label, target, style: :primary)
       if !@body[:accessory].nil?
@@ -118,10 +162,10 @@ class SlackMessage::Dsl
       @body.merge!(config)
     end
 
-    def image(url, alt_text: nil)
+    def accessory_image(url, alt_text: nil)
       if !@body[:accessory].nil?
         previous_type = @body[:accessory][:type]
-        warn "WARNING: Overriding previous #{previous_type} in section to use image instead: #{url}"
+        warn "WARNING: Overriding previous #{previous_type} in section to use accessory image instead: #{url}"
       end
 
       config = {
@@ -146,7 +190,7 @@ class SlackMessage::Dsl
     end
 
     def blank_line
-      text " " # unicode emspace
+      text EMSPACE
     end
 
     def has_content?

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.3.0"
+  gem.version     = "1.7.0"
   gem.summary     = "A nice DSL for composing rich messages in Slack"
   gem.authors     = ["Joe Mastey"]
   gem.email       = 'hello@joemastey.com'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_message
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Joe Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-27 00:00:00.000000000 Z
+date: 2021-10-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec