slack_message 1.4.0 → 1.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 858633fd4b83922e886bbec641c0075aab65aa9551d0a268cab9b51e3f3722fc
-  data.tar.gz: 3bc79397b71344abe4b535424d9913ca8a7f37259b4904da43acc0149674a6c6
+  metadata.gz: f3438c93abd1488bafc0ee9f33df94674290b68bd94110e8f2e601d95d3254bc
+  data.tar.gz: 5eee7e715e66042ab6c3ccbc47eedba3e2ddddacd327e1096e3a2d3476b076b0
 SHA512:
-  metadata.gz: d8cb6fcfaeeade894cba87671231d49de003917069e597906d53a166a8d2e74a25a1e2f55aaadefbe606b940106f8123afe02b9d820191210bfccd3e8962ce95
-  data.tar.gz: fa49ddfecbd19538bfe91d62f0e7decc88cc52ef42e6d0c880138820671b27d23334dd90fd7a970e080a85221bdbf5b40929e3ee3d6e73db0e039efc1d17acd9
+  metadata.gz: ddc5ace3b66e6977b164accfeec16c67450ed8fbd182939e85aa1d56c251319f203c4527d75d410c2858bbfa7540889a83ed08aed12890488944077edf1867ed
+  data.tar.gz: 16601f240ee826b8cadbd03429b5fd431ba21a5b159c1ca3c70932da362b54388c32115544bf782c45f9e2b1c603801d82e2fd6827e7020abfcaed18669601ee

data/CHANGELOG.md

@@ -2,8 +2,25 @@
 
 ## [Unreleased]
 
+## [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.
+
 ## [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
@@ -12,13 +29,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,20 @@ 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.
+* 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
 ------------
 
@@ -206,10 +242,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

@@ -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")
@@ -48,6 +56,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
@@ -61,6 +67,8 @@ class SlackMessage::Dsl
   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
 
@@ -77,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
@@ -106,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?
@@ -164,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.4.0"
+  gem.version     = "1.7.1"
   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

@@ -7,9 +7,10 @@ RSpec.describe SlackMessage do
 
   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 +64,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')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_message
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.7.1
 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