slack_message 3.0.0 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 62f8b7feb3289a37b79cb887dc4e7846c037a8c72290138afe611682a066a884
-  data.tar.gz: 73e391d721ace67ad31ae69b7a17eae3578d4f85a2bcd111a5cb1966b68c85cd
+  metadata.gz: '098b332b278741ef63ef105fc7e79cbc7ef131a03dca79b0ed40a1d86001cae1'
+  data.tar.gz: 40a4028d38c154fdb1d1835e0f536adc2e57671223290e43a139be1d70a359c3
 SHA512:
-  metadata.gz: cb28febfda107047351955825d1cd84dafdf553147b9f0101573944f3d5290c6d3e84a4d1190e63888f6c8ba851ac70da9eb774f1a01a04372d19520b7df8779
-  data.tar.gz: 3438883916204aec8a16a8dfa80b52506d4f640fc69161ad6e8efea1b5a136e97fc15f8b990c2529f3bbfb1f4380a989a0827cbe8f810af08a42bf3a2b6df382
+  metadata.gz: f99700c2fcb33cc7ad9e671f250dc23efffd47e6f4e36d9fdc7740c9ed1a8d4b224b523b6870b13cb3b164a0ae720f93824fae803368083919d776ec2c221236
+  data.tar.gz: 1fb9ccc9bf2f9b9fabca5e1cdcdbcde87100f1c056613f0af1450f344bc82adcc5f7366d2f6ab8fb54e34f241018464283c750f2a0d022a67112b9570fc1287e

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 # Changelog
 
+## [3.0.1] - 2021-12-22
+- Major overhaul of error handling and expansion on which errors trigger
+  friendly messages for users.
+- More additions to the docs, and working github pages integration.
+- It's my birthday!
+
 ## [3.0.0] - 2021-12-19
 - Return a more structured object from successful message sends.
 - Add the ability to edit or delete a message.

data/README.md

@@ -12,8 +12,14 @@ SlackMessage.post_to('#general') do
   text "We did it @here! :thumbsup:"
 end
 ```
+ 
+### The Docs
 
-#### Posting
+You'll find much more information about how to use SlackMessage by visiting
+[the docs](https://jmmastey.github.io/slack_message).
+ 
+
+### Posting
 
 SlackMessage is able to build all kinds of rich messages for you, and has been
 a real joy to use for the author at least. To understand a bit more about the
@@ -48,12 +54,7 @@ SlackMessage.post_to('#general') do
 end
 ```
 
-### The Docs
-
-You'll find much more information about how to use SlackMessage by visiting
-[the docs](https://jmmastey.github.io/slack_message).
-
-#### Opinionated Stances
+### Opinionated Stances
 
 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.
@@ -61,6 +62,8 @@ options and abilities, which makes them powerful, but makes them a pain to use.
 Accordingly, SlackMessage is developed with some strong opinions in mind:
 
 * SlackMessage has no dependencies. Your lockfile is enough of a mess already.
+* A DSL that focuses on code that is easy to write, read, and maintain. Only
+  features that can be implemented with that in mind are included.
 * 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.
@@ -71,28 +74,22 @@ Accordingly, SlackMessage is developed with some strong opinions in mind:
   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
-  possible should occur just once via configuration and not on every call.
+* Configuration is kept simple, with helpers for frequently reused bots.
 
 Some behaviors that are still planned but not yet added:
 
 * any interactive elements at all: https://api.slack.com/interactivity/handling
 * multiple recipients: https://api.slack.com/methods/conversations.open
-* more interesting return types for your message
-* richer text formatting (for instance, `ul` is currently a hack)
 * more mrkdwn syntax, like quotes or code blocks
-* more and better organized testing capability
+* more and better organized testing capability (scheduled messages, editing, deleting)
 * posting ephemeral messages: https://api.slack.com/methods/chat.postEphemeral
-* some Rspec test harness for scheduled messages, editing, deleting (probably going to need a test overhaul)
 
-Contributing
-------------
+### Contributing
 
 Contributions are very welcome. Fork, fix, submit pull. Since simplicity of API is a strong priority, so opening an issue to discuss possible interface changes would be wise.
 
 Contribution is expected to conform to the [Contributor Covenant](https://github.com/jmmastey/slack_message/blob/master/CODE_OF_CONDUCT.md).
 
-License
-------------
+### License
 
 This software is released under the [MIT License](https://github.com/jmmastey/slack_message/blob/master/MIT-LICENSE).

data/docs/01_configuration.md

@@ -95,18 +95,18 @@ end
 You will now see warnings detailing all params sent to the API.
 
 ```ruby
-  {
-    :channel=>"#general",
-    :username=>"Builds",
-    :blocks=>[
-      {:type=>"section", :text=>{
-        :type=>"mrkdwn",
-        :text=>"Build Stability is Looking Ruff :dog:"
-      }}
-    ],
-    :text=>"Build Issues",
-    :post_at=>1639421171,
-  }
+{
+  :channel=>"#general",
+  :username=>"Builds",
+  :blocks=>[
+    {:type=>"section", :text=>{
+      :type=>"mrkdwn",
+      :text=>"Build Stability is Looking Ruff :dog:"
+    }}
+  ],
+  :text=>"Build Issues",
+  :post_at=>1639421171,
+}
 ```
 
 Note this includes data that is not included in `SlackMessage.build`.

data/docs/03_message_dsl.md

@@ -152,11 +152,54 @@ end
 #   :style=>:danger}}]
 ```
 
-#### Lists and List Items
+#### Ordered and Unordered Lists
 
-- list_item, ul, ol
+The Slack API doesn't have native support for HTML-style ordered and unordered
+lists, but there are convenience methods in SlackMessage to render a close
+approximation.
 
-### Including Multiple Sections
+```ruby
+SlackMessage.build do
+  section do
+    text '*Pet Goodness Tiers*'
+
+    ol([
+      'tiny pigs',
+      'reptiles',
+      'dogs',
+      'cats',
+    ])
+  end
+
+  section do
+    text '_voted by_'
+    ul(['Joe', 'Emily', 'Sophia', 'Matt'])
+  end
+end
+```
+
+Because Slack automatically collapses leading whitespace, indention of lists is
+handled using unicode emspaces. Bullets for unordered lists are also unicode
+characters to avoid being read as markdown.
+
+#### List Items (e.g. HTML dt & dd)
+
+When trying to represent title / value lists, you can use the "list item" block
+type to pass a set of values. Slack does not allow you to customize how many
+items are shown per line, so you'll just have to work with it.
+
+```ruby
+SlackMessage.build do
+  text 'Import results are available!'
+
+  list_item 'Import Date', Date.today.to_s
+  list_item 'Items Imported', 55_000
+  list_item 'Errors', 23
+  list_item 'Bad Values', errors.map(&:to_s)
+end
+```
+
+#### Including Multiple Sections
 
 Adding more sections is trivial. Simply declare each section and it will be
 separated in the rendered message. This can often occur when looping.
@@ -200,10 +243,10 @@ section. Because of how implicit sections are built, it may look like this works
 for simple messages. You may have troubles when you start adding more
 complicated elements to your messages.
 
-### Images
-- image, accessory_image
+#### Images
+TODO: image, accessory_image
 
-### Footers (Context)
+#### Footers (Context)
 
 Slack allows you to add a small additional piece of text to your message, which
 will be rendered in italics and small text. It can support both links and emoji,
@@ -228,7 +271,7 @@ end
 Context does not belong to a section, and is per-message, not per-section.
 Specifying more than one context will simply overwrite previous calls.
 
-### Bot Customization
+#### Bot Customization
 
 By default - and with scheduled messages - Slack will use the name and icon of
 the Slack app whose API key you configured. As seen before, it's
@@ -253,7 +296,7 @@ The `bot_icon` can be specified as either an emoji (`:example:`), or a URL
 pointing to an image (`http://mysite.com/shipit.png`). Any other value seems to
 cause an error.
 
-### Custom Notification Text
+#### Custom Notification Text
 
 For users who have notifications turned on, Slack will provide a small message
 preview when you send them a message. By default, this preview will take the

data/docs/_config.yml

@@ -0,0 +1,6 @@
+plugins:
+  - jekyll-relative-links
+relative_links:
+  enabled: true
+  collections: true
+theme: jekyll-theme-midnight

data/docs/index.md

@@ -1,7 +1,49 @@
-* [Configuration](https://jmmastey.github.io/slack_message/01_configuration)
+* [Getting Started / Configuration](https://jmmastey.github.io/slack_message/01_configuration)
 * [Posting a Message](https://jmmastey.github.io/slack_message/02_posting_a_message)
 * [The SlackMessage DSL](https://jmmastey.github.io/slack_message/03_message_dsl)
 * [Editing Messages](https://jmmastey.github.io/slack_message/04_editing_messages)
 * [Deleting Messages](https://jmmastey.github.io/slack_message/05_deleting_messages)
 * [Mentions / Notifying Users](https://jmmastey.github.io/slack_message/06_notifying_users)
 * [Testing](https://jmmastey.github.io/slack_message/07_testing)
+
+SlackMessage is a gem that makes it easy to send messages to Slack from your
+application. _Really_ easy.
+
+```ruby
+SlackMessage.post_to('#general') do
+  text "We did it @here! :thumbsup:"
+end
+```
+
+And not just simple messages. You can compose complicated messages quickly in a
+DSL that's focused on usability and maintainability. It can be tough to
+maintain code in other similar gems, but not here.
+
+```ruby
+SlackMessage.post_to('hello@joemastey.com') do
+  section do
+    text "A job has generated some output for you to review."
+    text 'And More' * 10
+    link_button "See Results", "https://google.com"
+  end
+
+  section do
+    text ":unlock-new: New Data Summary"
+
+    list_item "Date", "09/05/2021"
+    list_item "Total Imported", 45_004
+    list_item "Total Errors", 5
+  end
+
+  divider
+
+  section do
+    text "See more here: #{link('result', 'https://google.com')}"
+  end
+
+  context "Kicked off by <hello@joemastey.com> at **9:05am**"
+end
+```
+
+It has no dependencies and minimal configuration needs, so you can get up and
+running quickly.

data/lib/slack_message/api.rb

@@ -10,6 +10,10 @@ module SlackMessage::Api
       raise ArgumentError, "Tried to find profile by invalid email address '#{email}'"
     end
 
+    if SlackMessage::Configuration.debugging?
+      warn [email, profile].inspect
+    end
+
     response = look_up_user_by_email(email, profile)
 
     if response.code != "200"
@@ -24,14 +28,7 @@ module SlackMessage::Api
       raise SlackMessage::ApiError, "Unable to parse JSON response from Slack API\n#{response.body}"
     end
 
-    if payload.include?("error") && payload["error"] == "invalid_auth"
-      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 SlackMessage::ApiError, "Received error response from Slack during user lookup:\n#{response.body}"
-    end
-
+    SlackMessage::ErrorHandling.raise_user_lookup_errors(response, target, profile)
     payload["user"]["id"]
   end
 
@@ -69,26 +66,8 @@ module SlackMessage::Api
     end
 
     response = post_message(profile, params)
-    body  = JSON.parse(response.body)
-    error = body.fetch("error", "")
-
-    # TODO: if a scheduled message w/ a short timer is "time_in_past", warn the user?
-
-    # let's try to be helpful about error messages
-    if ["token_revoked", "token_expired", "invalid_auth", "not_authed"].include?(error)
-      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 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 SlackMessage::ApiError, "Tried to send Slack message to non-existent channel or user '#{target}'"
-    elsif error == "invalid_arguments"
-      raise SlackMessage::ApiError, "Tried to send Slack message with invalid payload."
-    elsif response.code == "302"
-      raise SlackMessage::ApiError, "Got 302 response while posting to Slack. Check your API key for profile '#{profile[:handle]}'."
-    elsif response.code != "200"
-      raise SlackMessage::ApiError, "Got an error back from the Slack API (HTTP #{response.code}):\n#{response.body}"
-    end
 
+    SlackMessage::ErrorHandling.raise_post_response_errors(response, params, profile)
     SlackMessage::Response.new(response, profile[:handle])
   end
 
@@ -97,7 +76,7 @@ module SlackMessage::Api
       channel: message.channel,
       ts: message.timestamp,
       blocks: payload.render,
-      text: payload.custom_notification # TODO: ???
+      text: payload.custom_notification
     }
 
     if params[:blocks].length == 0
@@ -112,8 +91,7 @@ module SlackMessage::Api
     body  = JSON.parse(response.body)
     error = body.fetch("error", "")
 
-    # TODO: error messaging
-
+    SlackMessage::ErrorHandling.raise_post_response_errors(response, message, profile)
     SlackMessage::Response.new(response, profile[:handle])
   end
 
@@ -130,10 +108,13 @@ module SlackMessage::Api
       }
     end
 
-    response = delete_message(profile, params)
+    if SlackMessage::Configuration.debugging?
+      warn params.inspect
+    end
 
-    # TODO error handling (incl for already scheduled-and-sent messages)
+    response = delete_message(profile, params)
 
+    SlackMessage::ErrorHandling.raise_delete_response_errors(response, message, profile)
     response
   end
 

data/lib/slack_message/error_handling.rb

@@ -0,0 +1,124 @@
+class SlackMessage::ErrorHandling
+  PERMISSIONS_ERRORS = ["token_revoked", "token_expired", "invalid_auth", "not_authed",
+                        "team_access_not_granted", "no_permission", "missing_scope",
+                        "not_allowed_token_type", "ekm_access_denied"]
+
+  def self.raise_post_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 send Slack message because the serialized message had an invalid format"
+    elsif error == "channel_not_found"
+      raise SlackMessage::ApiError, "Tried to send Slack message to non-existent channel or user '#{params[:channel]}'"
+
+    # scheduling messages
+    elsif error == "invalid_time"
+      raise SlackMessage::ApiError, "Couldn't schedule Slack message because you requested an invalid time '#{params[:post_at]}'"
+    elsif error == "time_in_past"
+      raise SlackMessage::ApiError, "Couldn't schedule Slack message because you requested a time in the past (or too close to now) '#{params[:post_at]}'"
+    elsif error == "time_too_far"
+      raise SlackMessage::ApiError, "Couldn't schedule Slack message because you requested a time more than 120 days in the future '#{params[:post_at]}'"
+
+
+    elsif PERMISSIONS_ERRORS.include?(error)
+      raise SlackMessage::ApiError, "Couldn't send Slack message because the API key for profile '#{profile[:handle]}' is wrong, or the app has insufficient permissions (#{error})"
+    elsif error == "message_too_long"
+      raise SlackMessage::ApiError, "Tried to send Slack message, but the message was too long"
+    elsif error == "invalid_arguments"
+      raise SlackMessage::ApiError, "Tried to send Slack message with invalid payload"
+    elsif ["rate_limited", "ratelimited"].include?(error)
+      raise SlackMessage::ApiError, "Couldn't send Slack message because you've reached your rate limit"
+    elsif response.code == "302"
+      raise SlackMessage::ApiError, "Got 302 response while posting to Slack. Check your API key for profile '#{profile[:handle]}'"
+    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}"
+    end
+  end
+
+  def self.raise_update_response_errors(response, message, 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"
+    elsif error == "channel_not_found"
+      raise SlackMessage::ApiError, "Tried to update Slack message to non-existent channel or user '#{message.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}'"
+    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"
+      raise SlackMessage::ApiError, "Couldn't update message because it's too old"
+
+
+    elsif PERMISSIONS_ERRORS.include?(error)
+      raise SlackMessage::ApiError, "Couldn't update Slack message because the API key for profile '#{profile[:handle]}' is wrong, or the app has insufficient permissions (#{error})"
+    elsif error == "message_too_long"
+      raise SlackMessage::ApiError, "Tried to update Slack message, but the message was too long"
+    elsif error == "invalid_arguments"
+      raise SlackMessage::ApiError, "Tried to update Slack message with invalid payload"
+    elsif ["rate_limited", "ratelimited"].include?(error)
+      raise SlackMessage::ApiError, "Couldn't update Slack message because you've reached your rate limit"
+    elsif response.code == "302"
+      raise SlackMessage::ApiError, "Got 302 response while updating a message. Check your API key for profile '#{profile[:handle]}'"
+    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}"
+    end
+  end
+
+  def self.raise_delete_response_errors(response, message, profile)
+    body  = JSON.parse(response.body)
+    error = body.fetch("error", "")
+
+    if error == "channel_not_found"
+      raise SlackMessage::ApiError, "Tried to delete Slack message in non-existent channel '#{message.channel}'"
+
+    elsif error == "invalid_scheduled_message_id"
+      raise SlackMessage::ApiError, "Can't delete message because the ID was invalid, or the message has already posted (#{message.scheduled_message_id})"
+    elsif error == "message_not_found"
+      raise SlackMessage::ApiError, "Tried to delete Slack message, but the message wasn't found (timestamp '#{message.timestamp}' for channel '#{message.channel}')"
+    elsif error == "cant_delete_message"
+      raise SlackMessage::ApiError, "Can't delete message because '#{profile[:handle]}' doesn't have permission to"
+    elsif error == "compliance_exports_prevent_deletion"
+      raise SlackMessage::ApiError, "Can't delete message because team compliance settings prevent it"
+
+
+    elsif PERMISSIONS_ERRORS.include?(error)
+      raise SlackMessage::ApiError, "Couldn't delete Slack message because the API key for profile '#{profile[:handle]}' is wrong, or the app has insufficient permissions (#{error})"
+    elsif ["rate_limited", "ratelimited"].include?(error)
+      raise SlackMessage::ApiError, "Couldn't delete Slack message because you've reached your rate limit"
+    elsif response.code == "302"
+      raise SlackMessage::ApiError, "Got 302 response while deleting a message. Check your API key for profile '#{profile[:handle]}'"
+    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}"
+    end
+  end
+
+  def self.raise_user_lookup_response_errors(payload)
+    error = payload["error"]
+
+    if error == "users_not_found"
+      raise SlackMessage::ApiError, "Couldn't find a user with the email '#{email}'"
+
+
+    elsif PERMISSIONS_ERRORS.include?(error)
+      raise SlackMessage::ApiError, "Couldn't look up users because the API key for profile '#{profile[:handle]}' is wrong, or the app has insufficient permissions (#{error})"
+    elsif error
+      raise SlackMessage::ApiError, "Received error response from Slack during user lookup:\n#{response.body}"
+    elsif response.code == "302"
+      raise SlackMessage::ApiError, "Got 302 response during user lookup. Check your API key for profile '#{profile[:handle]}'"
+    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 user lookup:\n#{response.body}"
+    end
+  end
+end

data/lib/slack_message/rspec.rb

@@ -14,12 +14,15 @@ require 'rspec/mocks'
 # it can be cleaned up properly.
 #
 
-# TODO: testing for scheduled messages, editing and deleting
+# TODO: test helpers for scheduled messages, editing and deleting, and
+# notification text. And realistically, overhaul all this.
 
 module SlackMessage::RSpec
   extend RSpec::Matchers::DSL
 
   @@listeners = []
+  @@custom_response = {}
+  @@response_code = '200'
 
   def self.register_expectation_listener(expectation_instance)
     @@listeners << expectation_instance
@@ -29,6 +32,11 @@ module SlackMessage::RSpec
     @@listeners.delete(expectation_instance)
   end
 
+  def self.reset_custom_responses
+    @@custom_response = {}
+    @@response_code = '200'
+  end
+
   FauxResponse = Struct.new(:code, :body)
 
   def self.included(_)
@@ -38,22 +46,24 @@ module SlackMessage::RSpec
         listener.record_call(params.merge(profile: profile))
       end
 
-      response = {"ok"=>true,
-       "channel"=>"D12345678",
-       "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}}]}}
-
-      return FauxResponse.new('200', response.to_json)
+      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)
@@ -63,6 +73,18 @@ module SlackMessage::RSpec
     end
   end
 
+  def self.respond_with(response = {}, code: '200')
+    raise ArgumentError, "custom response must be a hash" unless response.is_a? Hash
+
+    @@custom_response = response
+    @@response_code = code
+  end
+
+  def self.reset_mock_response
+    @@custom_response = {}
+    @@response_code = '200'
+  end
+
   # w/ channel
   matcher :post_slack_message_to do |expected|
     match do |actual|

data/lib/slack_message.rb

@@ -1,6 +1,7 @@
 module SlackMessage
   require 'slack_message/response'
   require 'slack_message/dsl'
+  require 'slack_message/error_handling'
   require 'slack_message/api'
   require 'slack_message/configuration'
 

data/slack_message.gemspec

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

@@ -111,10 +111,6 @@ RSpec.describe SlackMessage do
       }.to post_slack_message_with_icon_matching(/thisperson/)
     end
 
-    it "lets you assert notification text" do
-      # TODO :|
-    end
-
     it "can assert more generally too tbh" do
       expect {
         SlackMessage.post_to('#general') { text "foo" }
@@ -123,8 +119,6 @@ RSpec.describe SlackMessage do
   end
 
   describe "API convenience" do
-    let(:profile) { SlackMessage::Configuration.profile(:default) }
-
     before do
       SlackMessage.configure do |config|
         config.clear_profiles!
@@ -158,5 +152,57 @@ RSpec.describe SlackMessage do
     end
   end
 
-  # tests for actual sending methods? what would actually be useful?
+  describe "error handling" do
+    before do
+      SlackMessage.configure do |config|
+        config.clear_profiles!
+        config.add_profile(name: 'default profile', api_token: 'abc123')
+        config.add_profile(:schmoebot, name: 'Schmoe', api_token: 'abc123', icon: ':schmoebot:', default_channel: '#schmoes')
+      end
+    end
+
+    after 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')
+
+      expect {
+        SlackMessage.post_to('#general') { text 'nuh uh' }
+      }.to raise_error(SlackMessage::ApiError)
+    end
+
+    it "raises errors w/ updates too" do
+      message = SlackMessage.post_to('#general') { text 'nuh uh' }
+
+      SlackMessage::RSpec.respond_with('error' => 'bad choice')
+
+      expect {
+        SlackMessage.update(message) { text 'nuh uh' }
+      }.to raise_error(SlackMessage::ApiError)
+    end
+
+    it "even raises errors during deletes" do
+      message = SlackMessage.post_to('#general') { text 'nuh uh' }
+
+      SlackMessage::RSpec.respond_with('error' => 'bad choice')
+
+      expect {
+        SlackMessage.delete(message) { text 'nuh uh' }
+      }.to raise_error(SlackMessage::ApiError)
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_message
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.0.1
 platform: ruby
 authors:
 - Joe Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-20 00:00:00.000000000 Z
+date: 2021-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -73,11 +73,13 @@ files:
 - docs/05_deleting_messages.md
 - docs/06_notifying_users.md
 - docs/07_testing.md
+- docs/_config.yml
 - docs/index.md
 - lib/slack_message.rb
 - lib/slack_message/api.rb
 - lib/slack_message/configuration.rb
 - lib/slack_message/dsl.rb
+- lib/slack_message/error_handling.rb
 - lib/slack_message/response.rb
 - lib/slack_message/rspec.rb
 - slack_message.gemspec