slack_message 1.0.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a57ae906ede72e7fa4d7a1425403bff7ceac205867076da31ba8d134b29cb9d3
-  data.tar.gz: 75c900293ec441d1ce75847617df5b3bb0a427df847a844e423fa9b2de9d803d
+  metadata.gz: 858633fd4b83922e886bbec641c0075aab65aa9551d0a268cab9b51e3f3722fc
+  data.tar.gz: 3bc79397b71344abe4b535424d9913ca8a7f37259b4904da43acc0149674a6c6
 SHA512:
-  metadata.gz: 98ed70ad1291694b3e7c468e7094db4b915ef6ee5539a820473e4aaa62bc163272dddd004dcfec159beeeac828aef6f8f8e78ccf709356bf1ffeb3e804c36bc6
-  data.tar.gz: 10faaa8dee70db69d2437cd436bc67e456919d2a7ad358c5e242ab80f6c6bd44dc665131f4657cf439472f016d2d01626edeae44fe0a1a9306917bea93c6cfce
+  metadata.gz: d8cb6fcfaeeade894cba87671231d49de003917069e597906d53a166a8d2e74a25a1e2f55aaadefbe606b940106f8123afe02b9d820191210bfccd3e8962ce95
+  data.tar.gz: fa49ddfecbd19538bfe91d62f0e7decc88cc52ef42e6d0c880138820671b27d23334dd90fd7a970e080a85221bdbf5b40929e3ee3d6e73db0e039efc1d17acd9

data/.gitignore

@@ -0,0 +1 @@
+slack_message*.gem

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.3

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Changelog
+
+## [Unreleased]
+
+## [1.4.0] - 2021-09-27
+- Moved 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.
+
+## [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/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+  * Other conduct which could reasonably be considered inappropriate in a
+    professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at jmmastey@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,40 @@
+PATH
+  remote: .
+  specs:
+    slack_message (1.2.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    coderay (1.1.3)
+    diff-lcs (1.4.4)
+    method_source (1.0.0)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rb-readline (0.5.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  pry (= 0.14.1)
+  rb-readline (= 0.5.5)
+  rspec (= 3.10.0)
+  slack_message!
+
+BUNDLED WITH
+   2.1.4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2021 Joseph Mastey
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,224 @@
+SlackMessage: a Friendly DSL for Slack
+=============
+
+SlackMessage is a wrapper over the [Block Kit
+API](https://app.slack.com/block-kit-builder/) to make it easy to read and
+write messages to slack in your ruby application. It has zero dependencies and
+is built to be opinionated to keep your configuration needs low.
+
+Posting a message to Slack should be this easy:
+
+```ruby
+SlackMessage.post_to('#general') do
+  text "We did it @here! :thumbsup:"
+end
+```
+
+To install, just add `slack_message` to your bundle and you're ready to go.
+
+
+Usage
+------------
+
+### Configuration
+
+To get started, you'll need to configure at least one profile to use to post
+to slack. Get a [Webhook URL](https://slack.com/help/articles/115005265063-Incoming-webhooks-for-Slack)
+from Slack and configure it like this:
+
+```ruby
+SlackMessage.configure do |config|
+  webhook_url = 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX'
+
+  config.add_profile(name: 'Slack Notifier', url: webhook_url)
+end
+```
+
+You should probably keep that webhook in a safe place like `ENV`. If using this
+gem with Rails, place this code in somewhere like
+`config/initializers/slack_message.rb`.
+
+#### Additional Profiles
+
+If you want to post to multiple different webhook addresses (say, if you have
+several different bots that post to different channels as different identities),
+you can configure those profiles as well, by giving each of them a name:
+
+```ruby
+SlackMessage.configure do |config|
+  # default profile
+  config.add_profile(name: 'Slack Notifier', url: ENV['SLACK_WEBHOOK_URL'])
+
+  # additional profiles (see below for usage)
+  config.add_profile(:prod_alert_bot, name: 'Prod Alert Bot', url: ENV['SLACK_PROD_ALERT_WEBHOOK_URL'])
+  config.add_profile(:sidekiq_bot, name: 'Sidekiq Bot', url: ENV['SLACK_SIDEKIQ_WEBHOOK_URL'])
+end
+```
+
+#### Configuring User Search
+
+Slack's API no longer allows you to send DMs to users by username. You need to
+look up a user's internal ID and send to that ID. Thankfully, there is a lookup
+by email endpoint for this. If you'd like to post messages to users by their
+email address, you'll need a
+[separate API Token](https://api.slack.com/tutorials/tracks/getting-a-token):
+
+```ruby
+SlackMessage.configure do |config|
+  config.api_token = 'xoxb-11111111111-2222222222-33333333333333333'
+end
+```
+
+### Posting Messages
+
+As mentioned at the top, posting a message to Slack is dang easy:
+
+```ruby
+SlackMessage.post_to('#general') do
+  text "We did it @here! :thumbsup:"
+end
+```
+
+That's it! SlackMessage will automatically serialize for the API like this:
+
+```json
+[{"type":"section","text":{"type":"mrkdwn","text":"We did it! :thumbsup:"}}]
+```
+
+Details like remembering that Slack made a mystifying decision to force you to
+request "mrkdwn", or requiring your text to be wrapped into a section are handled
+for you.
+
+Building up messages is meant to be as user-friendly as possible:
+
+```ruby
+SlackMessage.build do
+  text "haiku are easy"
+  text "but sometimes they don't make sense"
+  text "refrigerator"
+
+  context "- unknown author"
+end
+```
+
+SlackMessage will combine your text declarations and add any necessary wrappers
+automatically:
+
+```json
+[
+  {
+    "type": "section",
+    "text": {
+      "type": "mrkdwn",
+      "text": "haiku are easy\nbut sometimes they don't make sense\nrefrigerator"
+    }
+  },
+  {
+    "type": "context",
+    "elements": [
+      {
+        "type": "mrkdwn",
+        "text": "- unknown author"
+      }
+    ]
+  }
+]
+```
+
+If you've configured an API key for user search (see above in configuration),
+it's just as easy to send messages directly to users:
+
+```ruby
+SlackMessage.post_to('hello@joemastey.com') do
+  text "We did it! :thumbsup:"
+end
+```
+
+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
+possibilities of blocks, see Slack's [Block Kit
+Builder](https://app.slack.com/block-kit-builder/) to understand the structure
+better. There are lots of options:
+
+```ruby
+SlackMessage.post_to('#general') 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
+
+  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 their 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", "https://yoursite.com/sidekiq", style: :danger
+end
+```
+
+You can also use a custom name when sending a message:
+
+```ruby
+SlackMessage.post_to('#general') do
+  bot_name "CoffeeBot"
+
+  text ":coffee::clock: Time to take a break!"
+end
+```
+
+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.
+
+Since this gem was built out of an existing need that _didn't_ include most of
+the block API, I'd be inclined to merge features that sustainably expand the
+DSL to include more of the block API itself.
+
+Also, some behaviors that are still planned but not yet added:
+
+* 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
+
+Contributing
+------------
+
+Contributions are very welcome. Fork, fix, submit pulls.
+
+Contribution is expected to conform to the [Contributor Covenant](https://github.com/jmmastey/slack_message/blob/master/CODE_OF_CONDUCT.md).
+
+License
+------------
+
+This software is released under the [MIT License](https://github.com/jmmastey/slack_message/blob/master/MIT-LICENSE).

data/lib/slack_message/api.rb

@@ -0,0 +1,57 @@
+require 'net/http'
+require 'net/https'
+
+class SlackMessage::Api
+  def self.user_id_for(email)
+    token = SlackMessage.configuration.api_token
+
+    uri = URI("https://slack.com/api/users.lookupByEmail?email=#{email}")
+    request = Net::HTTP::Get.new(uri).tap do |req|
+      req['Authorization']  = "Bearer #{token}"
+      req['Content-type']   = "application/json"
+    end
+
+    response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) do |http|
+      http.request(request)
+    end
+
+    if response.code != "200"
+      raise "Got an error back from the Slack API (HTTP #{response.code}):\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")
+      raise "Received error response from Slack during user lookup:\n#{response.body}"
+    end
+
+    payload["user"]["id"]
+  end
+
+  def self.post(payload, target, profile)
+    profile[:url] = profile[:url]
+
+    uri     = URI.parse(profile[:url])
+    params  = {
+      channel: target,
+      username: profile[:name],
+      blocks: payload
+    }.to_json
+
+    response = Net::HTTP.post_form uri, { payload: params }
+
+    # let's try to be helpful about error messages
+    if response.body == "invalid_token"
+      raise "Couldn't send slack message because the URL for profile '#{profile[:handle]}' is wrong."
+    elsif response.body == "channel_not_found"
+      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 != "200"
+      raise "Got an error back from the Slack API (HTTP #{response.code}):\n#{response.body}"
+    end
+
+    response
+  end
+end

data/lib/slack_message/configuration.rb

@@ -0,0 +1,47 @@
+module SlackMessage::Configuration
+  @@api_token = nil
+  @@profiles = {}
+
+  def self.reset
+    @@api_token = nil
+    @@profiles  = {}
+  end
+
+  def self.configure
+    yield self
+  end
+
+  ###
+
+  def self.api_token=(token)
+    @@api_token = token
+  end
+
+  def self.api_token
+    unless @@api_token.is_a? String
+      raise ArgumentError, "Please set an API token to use API features."
+    end
+
+    @@api_token
+  end
+
+  ###
+
+  def self.add_profile(handle = :default, name:, url:)
+    if @@profiles.include?(handle)
+      warn "WARNING: Overriding profile '#{handle}' in SlackMessage config"
+    end
+
+    @@profiles[handle] = { name: name, url: url, handle: handle }
+  end
+
+  def self.profile(handle, custom_name: nil)
+    unless @@profiles.include?(handle)
+      raise ArgumentError, "Unknown SlackMessage profile '#{handle}'."
+    end
+
+    @@profiles[handle].tap do |profile|
+      profile[:name] = custom_name if !custom_name.nil?
+    end
+  end
+end

data/lib/slack_message/dsl.rb

@@ -0,0 +1,205 @@
+class SlackMessage::Dsl
+  attr_reader :body, :default_section, :custom_bot_name
+
+  def initialize
+    @body = []
+    @default_section = Section.new
+    @custom_bot_name = nil
+  end
+
+  # allowable top-level entities within a block
+
+  def section(&block)
+    finalize_default_section
+
+    section = Section.new.tap do |s|
+      s.instance_eval(&block)
+    end
+
+    @body.push(section.render)
+  end
+
+  def divider
+    finalize_default_section
+
+    @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
+
+    @body.push({ type: "context", elements: [{
+      type: "mrkdwn", text: text
+    }]})
+  end
+
+  # end entities
+
+  # delegation to allow terse syntax without e.g. `section`
+
+  def text(*args); default_section.text(*args); end
+  def link_button(*args); default_section.link_button(*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
+
+  # end delegation
+
+  # custom bot name
+
+  def bot_name(name)
+    @custom_bot_name = name
+  end
+
+  # end bot name
+
+  def render
+    finalize_default_section
+    @body
+  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)
+    end
+
+    @default_section = Section.new
+  end
+
+  class Section
+    attr_reader :body
+
+    def initialize
+      @body = { type: "section" }
+      @list = List.new
+    end
+
+    def text(msg)
+      if @body.include?(:text)
+        @body[:text][:text] << "\n#{msg}"
+
+      else
+        @body.merge!({ text: { type: "mrkdwn", text: msg } })
+      end
+    end
+
+    # styles:  default, primary, danger
+    def link_button(label, target, style: :primary)
+      if !@body[:accessory].nil?
+        previous_type = @body[:accessory][:type]
+        warn "WARNING: Overriding previous #{previous_type} in section to use link_button instead: #{label}"
+      end
+
+      unless /(^|\s)((https?:\/\/)?[\w-]+(\.[\w-]+)+\.?(:\d+)?(\/\S*)?)/i =~ target
+        warn "WARNING: Passing a probably-invalid URL to link button #{label} (url: '#{target}')"
+      end
+
+      config = {
+        accessory: {
+          type: "button",
+          url: target,
+          text: {
+            type: "plain_text",
+            text: label,
+            emoji: true
+          },
+        }
+      }
+
+      if style != :default
+        config[:accessory][:style] = style
+      end
+
+      @body.merge!(config)
+    end
+
+    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 accessory image instead: #{url}"
+      end
+
+      config = {
+        accessory: {
+          type: "image",
+          image_url: url
+        }
+      }
+
+      config[:accessory][:alt_text] = alt_text if !alt_text.nil?
+
+      @body.merge!(config)
+    end
+
+    # for markdown links
+    def link(label, target)
+      "<#{target}|#{label}>"
+    end
+
+    def list_item(title, value)
+      @list.add(title, value)
+    end
+
+    def blank_line
+      text " " # unicode emspace
+    end
+
+    def has_content?
+      @body.keys.length > 1 || @list.any?
+    end
+
+    def render
+      body[:fields] = @list.render if @list.any?
+      body
+    end
+  end
+
+  class List
+    def initialize
+      @items = []
+    end
+
+    def any?
+      @items.any?
+    end
+
+    def add(title, value)
+      @items.push(["*#{title}*", value])
+    end
+
+    def render
+      @items.push([' ', ' ']) if @items.length % 2 == 1
+      @items.each_slice(2).flat_map do |(first, second)|
+        [
+          { type: "mrkdwn", text: first[0] },
+          { type: "mrkdwn", text: second[0] },
+          { type: "mrkdwn", text: first[1] },
+          { type: "mrkdwn", text: second[1] },
+      ]
+      end
+    end
+  end
+end

data/lib/slack_message.rb

@@ -16,11 +16,14 @@ module SlackMessage
   end
 
   def self.post_to(target, as: :default, &block)
-    payload = build(&block)
-    profile = Configuration.profile(as)
+    payload = Dsl.new.tap do |instance|
+      instance.instance_eval(&block)
+    end
+
+    profile = Configuration.profile(as, custom_name: payload.custom_bot_name)
     target  = user_id_for(target) if target =~ /^\S{1,}@\S{2,}\.\S{2,}$/
 
-    Api.post(payload, target, profile)
+    Api.post(payload.render, target, profile)
   end
 
   def self.build(&block)

data/slack_message.gemspec

@@ -0,0 +1,24 @@
+Gem::Specification.new do |gem|
+  gem.name        = 'slack_message'
+  gem.version     = "1.4.0"
+  gem.summary     = "A nice DSL for composing rich messages in Slack"
+  gem.authors     = ["Joe Mastey"]
+  gem.email       = 'hello@joemastey.com'
+  gem.homepage    = 'https://rubygemgem.org/gems/slack_message'
+  gem.licenses    = 'MIT'
+
+  glob = lambda { |patterns| gem.files & Dir[*patterns] }
+
+  gem.files       = `git ls-files`.split($/)
+  gem.test_files  = glob['{spec/{**/}*_spec.rb']
+
+  gem.metadata    = {
+    "homepage_uri"    => "http://github.com/jmmastey/slack_message",
+    "changelog_uri"   => "https://github.com/jmmastey/slack_message/blob/master/CHANGELOG.md",
+    "source_code_uri" => "http://github.com/jmmastey/slack_message",
+  }
+
+  gem.add_development_dependency "rspec", "3.10.0"
+  gem.add_development_dependency "pry", "0.14.1"
+  gem.add_development_dependency "rb-readline", "0.5.5"
+end

data/spec/slack_message_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+RSpec.describe SlackMessage do
+  it "includes a bunch of stuff" do
+    expect(SlackMessage).to respond_to(:post_to)
+  end
+
+  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" }})
+
+      result = SlackMessage.user_id_for("hello@joemastey.com")
+      expect(result).to eq("ABC123")
+    end
+  end
+
+  describe "DSL" do
+    describe "#build" do
+      it "renders some JSON" do
+        expected_output = [
+          { type: "section",
+            text: { text: "foo", type: "mrkdwn" }
+          }
+        ]
+
+        output = SlackMessage.build do
+          text "foo"
+        end
+
+        expect(output).to eq(expected_output)
+      end
+    end
+  end
+
+  describe "configuration" do
+    after do
+      SlackMessage.configuration.reset
+    end
+
+    it "allows you to set an API key" do
+      SlackMessage.configure do |config|
+        config.api_token = "abc123"
+      end
+
+      expect(SlackMessage.configuration.api_token).to eq("abc123")
+    end
+
+    it "raises errors for missing configuration" do
+      SlackMessage.configure do |config|
+        #config.api_token = "abc123"
+      end
+
+      expect {
+        SlackMessage.configuration.api_token
+      }.to raise_error(ArgumentError)
+    end
+
+    it "lets you add and fetch profiles" do
+      SlackMessage.configure do |config|
+        config.add_profile(name: 'default profile', url: 'http://hooks.slack.com/1234/')
+        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')
+
+      expect {
+        SlackMessage.configuration.profile(:missing)
+      }.to raise_error(ArgumentError)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+require_relative '../lib/slack_message'
+
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause
+# this file to always be loaded, without a need to explicitly require it in any
+# files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need
+# it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+
+RSpec.configure do |config|
+  # This allows you to limit a spec run to individual examples or groups
+  # you care about by tagging them with `:focus` metadata. When nothing
+  # 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
+
+  # Limits the available syntax to the non-monkey patched syntax that is
+  # recommended. For more details, see:
+  #   - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
+  #   - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_message
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Joe Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-09-26 00:00:00.000000000 Z
+date: 2021-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -58,7 +58,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- MIT-LICENSE
+- README.md
 - lib/slack_message.rb
+- lib/slack_message/api.rb
+- lib/slack_message/configuration.rb
+- lib/slack_message/dsl.rb
+- slack_message.gemspec
+- spec/slack_message_spec.rb
+- spec/spec_helper.rb
 homepage: https://rubygemgem.org/gems/slack_message
 licenses:
 - MIT