slack_message 2.2.2 → 3.0.0

data/lib/slack_message/dsl.rb

@@ -111,12 +111,14 @@ class SlackMessage::Dsl
   # replace emails w/ real user IDs
   def enrich_text(text_body)
     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)
+      begin
+        raw_email = email_tag.gsub(/[><]/, '')
+        user_id   = SlackMessage::Api::user_id_for(raw_email, profile)
 
-      text_body.gsub!(email_tag, "<@#{user_id}>") if user_id
-    rescue SlackMessage::ApiError => e
-      # swallow errors for not-found users
+        text_body.gsub!(email_tag, "<@#{user_id}>") if user_id
+      rescue SlackMessage::ApiError => e
+        # swallow errors for not-found users
+      end
     end
 
     text_body

data/lib/slack_message/response.rb

@@ -0,0 +1,42 @@
+class SlackMessage::Response
+  attr_reader :channel, :timestamp, :profile_handle, :scheduled_message_id, :original_response
+
+  def initialize(api_response, profile_handle)
+    @original_response = JSON.parse(api_response.body)
+    @ok = @original_response["ok"]
+    @channel = @original_response["channel"]
+
+    @timestamp = @original_response["ts"]
+    @scheduled_message_id = @original_response["scheduled_message_id"]
+
+    @profile_handle = profile_handle
+  end
+
+  def marshal_dump
+    [ @profile_handle, @channel, @timestamp, @original_response, @ok, @original_response ]
+  end
+
+  def marshal_load(data)
+    @profile_handle, @channel, @timestamp, @original_response, @ok, @original_response = data
+  end
+
+  def sent_to_user?
+    channel =~ /^D.*/ # users are D for DM, channels start w/ C
+  end
+
+  def scheduled?
+    !!scheduled_message_id
+  end
+
+  def inspect
+    identifier = if scheduled?
+      "scheduled_message_id=#{scheduled_message_id}"
+    else
+      "timestamp=#{timestamp}"
+    end
+
+    ok_msg = @ok ? "ok" : "error"
+
+    "<SlackMessage::Response #{ok_msg} profile_handle=:#{profile_handle} channel=#{channel} #{identifier}>"
+  end
+end

data/lib/slack_message/rspec.rb

@@ -14,6 +14,8 @@ require 'rspec/mocks'
 # it can be cleaned up properly.
 #
 
+# TODO: testing for scheduled messages, editing and deleting
+
 module SlackMessage::RSpec
   extend RSpec::Matchers::DSL
 
@@ -206,11 +208,11 @@ module SlackMessage::RSpec
       SlackMessage::RSpec.unregister_expectation_listener(self)
 
       @captured_calls
-        .filter { |call| !@channel || call[:channel] == @channel }
-        .filter { |call| !@profile || [call[:profile][:handle], call[:username]].include?(@profile) }
-        .filter { |call| !@content || call.fetch(:blocks).to_s =~ @content }
-        .filter { |call| !@icon || call.fetch(:icon_emoji, call.fetch(:icon_url, '')) == @icon }
-        .filter { |call| !@icon_matching || call.fetch(:icon_emoji, call.fetch(:icon_url, '')) =~ @icon_matching }
+        .select { |call| !@channel || call[:channel] == @channel }
+        .select { |call| !@profile || [call[:profile][:handle], call[:username]].include?(@profile) }
+        .select { |call| !@content || call.fetch(:blocks).to_s =~ @content }
+        .select { |call| !@icon || call.fetch(:icon_emoji, call.fetch(:icon_url, '')) == @icon }
+        .select { |call| !@icon_matching || call.fetch(:icon_emoji, call.fetch(:icon_url, '')) =~ @icon_matching }
         .any?
     end
 

data/lib/slack_message.rb

@@ -1,4 +1,5 @@
 module SlackMessage
+  require 'slack_message/response'
   require 'slack_message/dsl'
   require 'slack_message/api'
   require 'slack_message/configuration'
@@ -21,7 +22,7 @@ module SlackMessage
     Api.user_id_for(email, profile)
   end
 
-  def self.post_to(target, as: :default, &block)
+  def self.post_to(target, as: :default, at: nil, &block)
     profile = Configuration.profile(as)
 
     payload = Dsl.new(block, profile).tap do |instance|
@@ -30,23 +31,53 @@ module SlackMessage
 
     target  = Api::user_id_for(target, profile) if target =~ EMAIL_PATTERN
 
-    Api.post(payload, target, profile)
+    Api.post(payload, target, profile, at)
   end
 
-  def self.post_as(profile_name, &block)
+  def self.post_as(profile_name, at: nil, &block)
     profile = Configuration.profile(profile_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]
     payload = Dsl.new(block, profile).tap do |instance|
       instance.instance_eval(&block)
     end
 
-    target  = profile[:default_channel]
     target  = Api::user_id_for(target, profile) if target =~ EMAIL_PATTERN
 
-    Api.post(payload, target, profile)
+    Api.post(payload, target, profile, at)
+  end
+
+  def self.update(message, &block)
+    unless message.is_a?(SlackMessage::Response)
+      raise ArgumentError, "You must pass in a SlackMessage::Response to update a message"
+    end
+
+    if message.scheduled?
+      raise ArgumentError, "Sorry, scheduled messages cannot be updated. You will need to delete the message and schedule a new one."
+    end
+
+    profile = Configuration.profile(message.profile_handle)
+    payload = Dsl.new(block, profile).tap do |instance|
+      instance.instance_eval(&block)
+    end
+
+    Api.update(payload, message, profile)
+  end
+
+  def self.delete(message)
+    unless message.is_a?(SlackMessage::Response)
+      raise ArgumentError, "You must pass in a SlackMessage::Response to delete a message"
+    end
+
+    if message.sent_to_user?
+      raise ArgumentError, "It's not possible to delete messages sent directly to users."
+    end
+
+    profile = Configuration.profile(message.profile_handle)
+    Api.delete(message, profile)
   end
 
   def self.build(profile_name = :default, &block)

data/slack_message.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |gem|
   gem.name        = 'slack_message'
-  gem.version     = "2.2.2"
+  gem.version     = "3.0.0"
   gem.summary     = "A nice DSL for composing rich messages in Slack"
   gem.authors     = ["Joe Mastey"]
   gem.email       = 'hello@joemastey.com'
@@ -18,6 +18,8 @@ Gem::Specification.new do |gem|
     "source_code_uri" => "http://github.com/jmmastey/slack_message",
   }
 
+  gem.required_ruby_version = '>= 2.5.0'
+
   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"

data/spec/slack_message_spec.rb

@@ -142,13 +142,21 @@ RSpec.describe SlackMessage do
       expect {
         SlackMessage.post_to('#general') { text("Not Tagged: hello@joemastey.com ") }
       }.to post_to_slack.with_content_matching(/hello@joemastey.com/)
+    end
 
-
-      allow(SlackMessage::Api).to receive(:user_id_for).and_raise(SlackMessage::ApiError)
+    it "is graceful about those failures" do
+      allow(SlackMessage::Api).to receive(:user_id_for).with('nuffin@nuffin.nuffin', any_args).and_raise(SlackMessage::ApiError)
+      allow(SlackMessage::Api).to receive(:user_id_for).with('hello@joemastey.com', any_args).and_return('ABC123')
 
       expect {
         SlackMessage.post_to('#general') { text("Not User: <nuffin@nuffin.nuffin>") }
       }.to post_to_slack.with_content_matching(/\<nuffin@nuffin.nuffin\>/)
+
+      expect {
+        SlackMessage.post_to('#general') { text("Not User: <nuffin@nuffin.nuffin>, User: <hello@joemastey.com>") }
+      }.to post_to_slack.with_content_matching(/ABC123/)
     end
   end
+
+  # tests for actual sending methods? what would actually be useful?
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slack_message
 version: !ruby/object:Gem::Version
-  version: 2.2.2
+  version: 3.0.0
 platform: ruby
 authors:
 - Joe Mastey
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-30 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -64,13 +64,21 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - MIT-LICENSE
 - README.md
+- docs/01_configuration.md
+- docs/02_posting_a_message.md
+- docs/03_message_dsl.md
+- docs/04_editing_messages.md
+- docs/05_deleting_messages.md
+- docs/06_notifying_users.md
+- docs/07_testing.md
+- 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/response.rb
 - lib/slack_message/rspec.rb
 - slack_message.gemspec
 - spec/slack_message_spec.rb
@@ -90,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/Gemfile.lock

@@ -1,40 +0,0 @@
-PATH
-  remote: .
-  specs:
-    slack_message (2.2.2)
-
-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