slack_message 3.2.0 → 3.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bdc04bd65ae2c98be234fbea88cec4d5373553bdb758a28959ef7c2515e8420c
-  data.tar.gz: 68beb2e7a60e6cb6b4f2904e1f5335e934b447070b29c9362caca0ce2148fad5
+  metadata.gz: 0b35e974e04457e2d9e3b55af0c5c7562d0381c76477e9a85143c66e8d605071
+  data.tar.gz: 21892df8e52b365ade154424d2c98a55434efb541e144d046d208fe8b1243f24
 SHA512:
-  metadata.gz: f6f5ca7c5ced4e495439429eb9aba32fbb4567f64eff04ff3eff9ba5e05caab3faac995d18e830e58a9bb432c40a4cc4ecc4e383cff71bf7fa7e4cf4f8b47e75
-  data.tar.gz: 5ad0999dd393d908a3ddd1e8e83d82f01ff8296f5178f7817cabd73553987c37a82107034d50a20c52a671fd12af5d6771e20962dbc0dcccc7eb135865a9a465
+  metadata.gz: 720e5bcf8d91f355939474b09f9d2a9830178037dca5c067ecfc4c6585631673e2ea13d888338ff1fb7a3d25ae1009b5f1a97f7a8244f1f06696b437227f6260
+  data.tar.gz: b7fa2c16e3d5a31ac18605bda1e1eacdd367c6e94f34779c50964a92c679b8edcdc1168d3fa808392401669f55bbeae30aec607ec44a2cfd55b916d0ad0fe70d

data/CHANGELOG.md

@@ -1,7 +1,13 @@
 # Changelog
 
+## [3.3.0] - 2022-07-21
+- Differentiate errors for bad JSON versus invalid block data.
+- Expand tests to cover many more cases.
+- Add validation for block size limit in Slack API.
+- Add CI check to prevent checkin of `fit`, `fcontext` etc.
+
 ## [3.2.0] - 2022-06-23
-- Fix bugs introduced by accidental checkin of incomplete refactor
+- Fix bugs introduced by accidental checkin of incomplete refactor.
 
 ## [3.1.0] - 2022-04-18
 - Methods from the calling context can now be called within a section block.

data/lib/slack_message/api.rb

@@ -41,6 +41,10 @@ module SlackMessage::Api
       raise ArgumentError, "Tried to send an entirely empty message."
     end
 
+    if params[:blocks].length > 50
+      raise ArgumentError, "Message cannot contain more than 50 blocks."
+    end
+
     icon = payload.custom_bot_icon || profile[:icon]
     if icon =~ /^:\w+:$/
       params[:icon_emoji] = icon
@@ -80,15 +84,17 @@ module SlackMessage::Api
       raise ArgumentError, "Tried to send an entirely empty message."
     end
 
+    if params[:blocks].length > 50
+      raise ArgumentError, "Message cannot contain more than 50 blocks."
+    end
+
     if SlackMessage::Configuration.debugging?
       warn params.inspect
     end
 
     response = update_message(profile, params)
-    body  = JSON.parse(response.body)
-    error = body.fetch("error", "")
 
-    SlackMessage::ErrorHandling.raise_post_response_errors(response, message, profile)
+    SlackMessage::ErrorHandling.raise_update_response_errors(response, params, profile)
     SlackMessage::Response.new(response, profile[:handle])
   end
 

data/lib/slack_message/error_handling.rb

@@ -7,8 +7,10 @@ class SlackMessage::ErrorHandling
     body  = JSON.parse(response.body)
     error = body.fetch("error", "")
 
-    if ["invalid_blocks", "invalid_blocks_format"].include?(error)
-      raise SlackMessage::ApiError, "Couldn't send Slack message because the serialized message had an invalid format"
+    if error == "invalid_blocks"
+      raise SlackMessage::ApiError, "Couldn't send Slack message because the request contained invalid blocks:\n#{blocks_message(params[:blocks])}"
+    elsif error == "invalid_blocks_format"
+      raise SlackMessage::ApiError, "Couldn't send Slack message because blocks is not a valid JSON object or doesn't match the Block Kit syntax:\n#{blocks_message(params[:blocks])}"
     elsif error == "channel_not_found"
       raise SlackMessage::ApiError, "Tried to send Slack message to non-existent channel or user '#{params[:channel]}'"
 
@@ -34,21 +36,23 @@ class SlackMessage::ErrorHandling
     elsif response.code != "200"
       raise SlackMessage::ApiError, "Got an error back from the Slack API (HTTP #{response.code}):\n#{response.body}"
     elsif !(error.nil? || error == "")
-      raise SlackMessage::ApiError, "Received error response from Slack during message posting:\n#{response.body}"
+      raise SlackMessage::ApiError, "Received error response '#{error}' from Slack during message posting:\n#{response.body}"
     end
   end
 
-  def self.raise_update_response_errors(response, message, profile)
+  def self.raise_update_response_errors(response, params, profile)
     body  = JSON.parse(response.body)
     error = body.fetch("error", "")
 
-    if ["invalid_blocks", "invalid_blocks_format"].include?(error)
-      raise SlackMessage::ApiError, "Couldn't update Slack message because the serialized message had an invalid format"
+    if error == "invalid_blocks"
+      raise SlackMessage::ApiError, "Couldn't update Slack message because the request contained invalid blocks:\n#{blocks_message(params[:blocks])}"
+    elsif error == "invalid_blocks_format"
+      raise SlackMessage::ApiError, "Couldn't update Slack message because blocks is not a valid JSON object or doesn't match the Block Kit syntax:\n#{blocks_message(params[:blocks])}"
     elsif error == "channel_not_found"
-      raise SlackMessage::ApiError, "Tried to update Slack message to non-existent channel or user '#{message.channel}'"
+      raise SlackMessage::ApiError, "Tried to update Slack message to non-existent channel or user '#{params[:channel]}'"
 
     elsif error == "message_not_found"
-      raise SlackMessage::ApiError, "Tried to update Slack message, but the message wasn't found (timestamp '#{message.timestamp}' for channel '#{message.channel}'"
+      raise SlackMessage::ApiError, "Tried to update Slack message, but the message wasn't found (timestamp '#{params[:ts]}' for channel '#{params[:channel]}'"
     elsif error == "cant_update_message"
       raise SlackMessage::ApiError, "Couldn't update message because the message type isn't able to be updated, or #{profile[:handle]} isn't allowed to update it"
     elsif error == "edit_window_closed"
@@ -68,7 +72,7 @@ class SlackMessage::ErrorHandling
     elsif response.code != "200"
       raise SlackMessage::ApiError, "Got an error back from the Slack API (HTTP #{response.code}):\n#{response.body}"
     elsif !(error.nil? || error == "")
-      raise SlackMessage::ApiError, "Received error response from Slack during message update:\n#{response.body}"
+      raise SlackMessage::ApiError, "Received error response '#{error}' from Slack during message update:\n#{response.body}"
     end
   end
 
@@ -98,7 +102,7 @@ class SlackMessage::ErrorHandling
     elsif response.code != "200"
       raise SlackMessage::ApiError, "Got an error back from the Slack API (HTTP #{response.code}):\n#{response.body}"
     elsif !(error.nil? || error == "")
-      raise SlackMessage::ApiError, "Received error response from Slack during message delete:\n#{response.body}"
+      raise SlackMessage::ApiError, "Received error response '#{error}' from Slack during message delete:\n#{response.body}"
     end
   end
 
@@ -127,4 +131,12 @@ class SlackMessage::ErrorHandling
       raise SlackMessage::ApiError, "Received error response from Slack during user lookup:\n#{response.body}"
     end
   end
+
+  def self.blocks_message(blocks)
+    if SlackMessage::Configuration.debugging?
+      JSON.pretty_generate(blocks)
+    else
+      "[Enable debugging in configuration to view block data.]"
+    end
+  end
 end

data/lib/slack_message/rspec.rb

@@ -40,30 +40,32 @@ module SlackMessage::RSpec
   FauxResponse = Struct.new(:code, :body)
 
   def self.included(_)
-    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))
+    [:post_message, :update_message, :delete_message].each do |method|
+      SlackMessage::Api.undef_method(method)
+      SlackMessage::Api.define_singleton_method(method) do |profile, params|
+        @@listeners.each do |listener|
+          listener.record_call(params.merge(profile: profile))
+        end
+
+        response = {
+         "ok" => true,
+         "channel" => "C12345678",
+         "ts" => "1635863996.002300",
+         "message" => { "type"=>"message", "subtype"=>"bot_message",
+                       "text"=>"foo",
+                       "ts"=>"1635863996.002300",
+                       "username"=>"SlackMessage",
+                       "icons"=>{"emoji"=>":successkid:"},
+                       "bot_id"=>"B1234567890",
+                       "blocks"=> [{"type"=>"section",
+                                    "block_id"=>"hAh7",
+                                    "text"=>{"type"=>"mrkdwn", "text"=>"foo", "verbatim"=>false}}
+                       ]
+         }
+        }.merge(@@custom_response).to_json
+
+        return FauxResponse.new(@@response_code, response)
       end
-
-      response = {
-       "ok" => true,
-       "channel" => "C12345678",
-       "ts" => "1635863996.002300",
-       "message" => { "type"=>"message", "subtype"=>"bot_message",
-                     "text"=>"foo",
-                     "ts"=>"1635863996.002300",
-                     "username"=>"SlackMessage",
-                     "icons"=>{"emoji"=>":successkid:"},
-                     "bot_id"=>"B1234567890",
-                     "blocks"=> [{"type"=>"section",
-                                  "block_id"=>"hAh7",
-                                  "text"=>{"type"=>"mrkdwn", "text"=>"foo", "verbatim"=>false}}
-                     ]
-       }
-      }.merge(@@custom_response).to_json
-
-      return FauxResponse.new(@@response_code, response)
     end
 
     SlackMessage::Api.undef_method(:look_up_user_by_email)

data/slack_message.gemspec

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

@@ -176,18 +176,6 @@ RSpec.describe SlackMessage do
       SlackMessage::RSpec.reset_mock_response
     end
 
-    it "raises nice error messages when API methods return errors" do
-      SlackMessage::RSpec.respond_with({'error' => 'nuffin'})
-
-      expect {
-        SlackMessage.post_to('#general') { text 'nuh uh' }
-      }.to raise_error(SlackMessage::ApiError)
-
-      expect {
-        SlackMessage.post_as(:schmoebot) { text 'nuh uh' }
-      }.to raise_error(SlackMessage::ApiError)
-    end
-
     it "raises for redirects" do
       SlackMessage::RSpec.respond_with(code: '302')
 
@@ -196,24 +184,83 @@ RSpec.describe SlackMessage do
       }.to raise_error(SlackMessage::ApiError)
     end
 
-    it "raises errors w/ updates too" do
+    it "even raises errors during deletes" do
       message = SlackMessage.post_to('#general') { text 'nuh uh' }
 
       SlackMessage::RSpec.respond_with({'error' => 'bad choice'})
 
       expect {
-        SlackMessage.update(message) { text 'nuh uh' }
+        SlackMessage.delete(message)
       }.to raise_error(SlackMessage::ApiError)
     end
 
-    it "even raises errors during deletes" do
-      message = SlackMessage.post_to('#general') { text 'nuh uh' }
+    shared_examples 'post api error message' do |error, error_message|
+      it "responds to posts with error code '#{error}' with the expected message" do 
+        SlackMessage::RSpec.respond_with({'error' => error})
 
-      SlackMessage::RSpec.respond_with({'error' => 'bad choice'})
+        expect {
+          SlackMessage.post_to('#general') { text 'nuh uh' }
+        }.to raise_error(SlackMessage::ApiError).with_message(error_message)
 
-      expect {
-        SlackMessage.delete(message) { text 'nuh uh' }
-      }.to raise_error(SlackMessage::ApiError)
+        expect {
+          SlackMessage.post_as(:schmoebot) { text 'nuh uh' }
+        }.to raise_error(SlackMessage::ApiError).with_message(error_message)
+      end
+    end
+
+    shared_examples 'update api error message' do |error, error_message|
+      it "responds to updates with error code '#{error}' with the expected message" do
+        message = SlackMessage.post_to('#general') { text 'nuh uh' }
+
+        SlackMessage::RSpec.respond_with({'error' => error})
+
+        expect {
+          SlackMessage.update(message) { text 'nuh uh' }
+        }.to raise_error(SlackMessage::ApiError).with_message(error_message)
+      end
+    end
+
+    shared_examples 'delete api error message' do |error, error_message|
+      it "responds to updates with error code '#{error}' with the expected message" do
+        message = SlackMessage.post_to('#general') { text 'nuh uh' }
+
+        SlackMessage::RSpec.respond_with({'error' => error})
+
+        expect {
+          SlackMessage.delete(message)
+        }.to raise_error(SlackMessage::ApiError).with_message(error_message)
+      end
     end
+
+    shared_examples 'block api error message' do |error, error_message|
+      include_examples 'post api error message', error, error_message
+      include_examples 'update api error message', error, error_message
+    end
+
+    include_examples 'block api error message', 'nuffin', /Received error response 'nuffin' from Slack/
+    include_examples 'block api error message', 'invalid_blocks', /because the request contained invalid blocks:\n\[Enable debugging in configuration to view block data\.\]/
+    include_examples 'block api error message', 'invalid_blocks_format', /because blocks is not a valid JSON object or doesn't match the Block Kit syntax:\n\[Enable debugging in configuration to view block data\.\]/
+    include_examples 'block api error message', 'channel_not_found', /Slack message to non-existent channel or user/
+    include_examples 'block api error message', 'invalid_auth', /because the API key for profile '.*' is wrong, or the app has insufficient permissions \(invalid_auth\)/
+    include_examples 'block api error message', 'message_too_long', /but the message was too long/
+    include_examples 'block api error message', 'invalid_arguments', /with invalid payload/
+    include_examples 'block api error message', 'rate_limited', /because you've reached your rate limit/
+
+    # Scheduling messages
+    include_examples 'post api error message', 'invalid_time', /because you requested an invalid time/
+    include_examples 'post api error message', 'time_in_past', /because you requested a time in the past \(or too close to now\)/
+    include_examples 'post api error message', 'time_too_far', /because you requested a time more than 120 days in the future/
+
+    # Updating messages
+    include_examples 'update api error message', 'message_not_found', /but the message wasn't found/
+
+    # Deleting messages
+    include_examples 'delete api error message', 'nuffin', /Received error response 'nuffin' from Slack/
+    include_examples 'delete api error message', 'invalid_scheduled_message_id', /Can't delete message because the ID was invalid, or the message has already posted/
+    include_examples 'delete api error message', 'message_not_found', /but the message wasn't found/
+    include_examples 'delete api error message', 'cant_delete_message', /Can't delete message because 'default' doesn't have permission to/
+    include_examples 'delete api error message', 'compliance_exports_prevent_deletion', /Can't delete message because team compliance settings prevent it/
+    include_examples 'delete api error message', 'invalid_auth', /because the API key for profile '.*' is wrong, or the app has insufficient permissions \(invalid_auth\)/
+    include_examples 'delete api error message', 'rate_limited', /because you've reached your rate limit/
   end
 end

data/spec/spec_helper.rb

@@ -26,7 +26,11 @@ RSpec.configure do |config|
   # is tagged with `:focus`, all examples get run. RSpec also provides
   # aliases for `it`, `describe`, and `context` that include `:focus`
   # metadata: `fit`, `fdescribe` and `fcontext`, respectively.
-  config.filter_run_when_matching :focus
+  if ENV['CI'] == "true"
+    config.filter_run_when_matching :focus => lambda { raise ArgumentError, "Don't filter tests on checked in code." }
+  else
+    config.filter_run_when_matching :focus
+  end
 
   # Limits the available syntax to the non-monkey patched syntax that is
   # recommended. For more details, see:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_message
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.3.0
 platform: ruby
 authors:
 - Joe Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-06-23 00:00:00.000000000 Z
+date: 2022-07-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec