slack_message 2.2.0 → 2.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 368533ab7e4dae44ffbef5ccf8afef048def96d964a6af64c294c23ba617dfa3
-  data.tar.gz: f9397472bbc5c5db81dd1c9d7715e5015f4ec455948e7a29afbb11ef8c8a3d01
+  metadata.gz: '008fdfc2e46435b3bb49aae67e30b3ef354ca0c923c935c918088ee25eec7bda'
+  data.tar.gz: 2fe7d85c853361d12f02f58d19e4bef43ffc81d3683ef5f8b3776657eb86c5ae
 SHA512:
-  metadata.gz: 5cce143a95d508694221f1c667428f850ce7aa537e73f61c1869498b68a5751afe2ac386215b96702a1a27bcad3758c474ba09870a1cd7a31a7c33a17ebd4d53
-  data.tar.gz: 7f81e1876f231899588b174c87c4a0a3ca3bcbc4057216092311b300cff7d23d6541083b5e481e811795042538e2e6713b1a9f5eb5f6eba345e79960335cad91
+  metadata.gz: 1c5cc5b43f1813b55b6d1433da88ca661bc692a21785ffad1c2e13c459f0d2b4cb6bbf6251f5e774924a73e8e60f8c2517deaf71a0a1f74f57b2094e822e82ac
+  data.tar.gz: 0bb8d97ef6338703e601bd964405c090823ceded7cfa3045d42618a575397ca057591f6aad1cad6d1a74a7f4b877de11bced2d566424c75b53d80d2ce018cda0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [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.

data/README.md

@@ -15,19 +15,21 @@ 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 is kept as simple as possible. But, as much heavy lifting as
@@ -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
 ```
@@ -261,16 +260,16 @@ SlackMessage.post_to('#general') do
 end
 ```
 
-Emails that are not wrapped in tags will be rendered as normal clickable email
-addresses. Additionally, Slack will automatically convert a number of channel
-names and tags you're probably already used to:
+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!"
+  text "@here There's no coffee left! Let #general know when you fix it."
 end
 ```
 
@@ -303,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 {
@@ -340,12 +339,12 @@ 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:
 
@@ -357,6 +356,7 @@ Some behaviors that are still planned but not yet added:
 * multiple recipients
 * 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,18 +2,16 @@ 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 SlackMessage::ApiError, "Got an error back from the Slack API (HTTP #{response.code}):\n#{response.body}"
     elsif response.body == ""
@@ -37,7 +35,7 @@ class SlackMessage::Api
     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],
@@ -80,8 +78,23 @@ class SlackMessage::Api
     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]}"
@@ -93,6 +106,4 @@ class SlackMessage::Api
       http.request(request)
     end
   end
-
-  private_class_method :post_message
 end

data/lib/slack_message/dsl.rb

@@ -2,7 +2,7 @@ class SlackMessage::Dsl
   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, profile)
     # Delegate missing methods to caller scope. Thanks 2008:
@@ -108,11 +108,9 @@ class SlackMessage::Dsl
     @caller_self.send meth, *args, &blk
   end
 
-  EMAIL_TAG_PATTERN = /<[^@ \t\r\n\<]+@[^@ \t\r\n]+\.[^@ \t\r\n]+>/
-
   # replace emails w/ real user IDs
   def enrich_text(text_body)
-    text_body.scan(EMAIL_TAG_PATTERN).each do |email_tag|
+    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)
 

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,9 @@ 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
@@ -25,7 +28,7 @@ module SlackMessage
       instance.instance_eval(&block)
     end
 
-    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
@@ -41,7 +44,7 @@ module SlackMessage
     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

data/slack_message.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = 'slack_message'
-  gem.version     = "2.2.0"
+  gem.version     = "2.2.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

@@ -132,15 +132,6 @@ RSpec.describe SlackMessage do
       end
     end
 
-    it "can grab user IDs" do
-      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
-
     it "converts user IDs within text when tagged properly" do
       allow(SlackMessage::Api).to receive(:user_id_for).and_return('ABC123')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack_message
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.1
 platform: ruby
 authors:
 - Joe Mastey