slack-post 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86078125f4d37d83582258b66f07212486dbb43f
-  data.tar.gz: e4f33f59f2e3cb686e647e7512c734d98ab1f106
+  metadata.gz: 97dd6da19fa9488df3be2a71619bfcfed46e902a
+  data.tar.gz: b5168425d44fa2e27a02254c48c0a6d516fb9ea9
 SHA512:
-  metadata.gz: 3a25872cff85e15826d1385b5adff552dc2b5af06f2ab641e770e22685544a9b6127f65fea0a0824c4dd161afd489ab35675368d2decfaf5f11dfa1a31689188
-  data.tar.gz: da6ea5afcd462abf6c2030b9d4c9e94c3b5cec119dde52ab41bdfd1f1b183d5994cc49d159a40dd23247850bb748dfb81803bde6f0a142cec1ec08a55640c230
+  metadata.gz: 15496a4e904cdf047a66d927d8eae901f62ddedfac8b981655bccffca7dc1ad1d06be00ef0a7cf54f22337d7bd57b66757932a05b75c0f7a1ddb6d03b24d7ffc
+  data.tar.gz: d350f4b86c2be2f5248492e8b7a96b3fd28b26c444056cfeb87c0fb18615fb1dcd94a6719773e4e103e611550cb45cb543119efaa213407accc9cbecc5872037

data/README.md

@@ -25,6 +25,31 @@ Slack::Post.configure(
 Slack::Post.post "Domo arigato.", '#general'
 ```
 
+### Attachments
+
+slack-post supports message attachments per Slack's [Attachment](https://api.slack.com/docs/attachments) specification.
+
+Use `Slack::Post.post_with_attachments` to send a message with any number of attachments:
+```ruby
+attachments = [
+  {
+      fallback: "Required text summary...",
+      text: "Optional text that should appear within the attachment",
+      pretext: "Optional text that should appear above the formatted data",
+      color: "#36a64f",
+      fields: [
+          {
+              title: "Required Field Title",
+              value: "Text value of the field.",
+              short: false
+          }
+      ]
+  }
+]
+
+Slack::Post.post_with_attachments "Domo arigato.", attachments, '#general'
+```
+
 ### slack-post Command
 
 slack-post comes with a `slack-post` command so you can send messages from the command line:

data/lib/slack/post.rb

@@ -11,7 +11,7 @@ module Slack
 			channel: '#general'
 		}.freeze
 		
-		def self.post(message,chan=nil,opts={})
+		def self.post_with_attachments(message,attachments,chan=nil,opts={})
 			raise "You need to call Slack::Post.configure before trying to send messages." unless configured?(chan.nil?)
 			pkt = {
 				channel: chan || config[:channel],
@@ -26,6 +26,9 @@ module Slack
 			if opts.has_key?(:icon_emoji) or config.has_key?(:icon_emoji)
 				pkt[:icon_emoji] = opts[:icon_emoji] || config[:icon_emoji]
 			end
+			if attachments.instance_of?(Array) && attachments != []
+				pkt[:attachments] = attachments.map { |a| validated_attachment(a) }
+			end
 			uri = URI.parse(post_url)
 			http = Net::HTTP.new(uri.host, uri.port)
 			http.use_ssl = true
@@ -42,6 +45,18 @@ module Slack
 					raise "There was an error while trying to post. Error was: #{resp.body}"
 			end
 		end
+
+		def self.validated_attachment(attachment)
+			valid_attachment = prune(symbolize_keys(attachment), AttachmentParams)
+			if attachment.has_key?(:fields)
+				valid_attachment[:fields] = attachment[:fields].map { |h| prune(symbolize_keys(h), FieldParams) }
+			end
+			return valid_attachment
+		end
+
+		def self.post(message,chan=nil,opts={})
+			post_with_attachments(message, [], chan, opts)
+		end
 		
 		def self.post_url
 			"https://#{config[:subdomain]}.slack.com/services/hooks/incoming-webhook?token=#{config[:token]}"
@@ -65,16 +80,22 @@ module Slack
 		end
 		
 		KnownConfigParams = [:username,:channel,:subdomain,:token,:icon_url,:icon_emoji].freeze
+		AttachmentParams = [:fallback,:text,:pretext,:color,:fields].freeze
+		FieldParams = [:title,:value,:short].freeze
 		
-		def self.prune(opts)
+		def self.prune(opts, allowed_elements=KnownConfigParams)
 			opts.inject({}) do |acc,(k,v)|
 				k = k.to_sym
-				if KnownConfigParams.include?(k)
+				if allowed_elements.include?(k)
 					acc[k] = v
 				end
 				acc
 			end
 		end
+
+		def self.symbolize_keys(hash)
+			return hash.inject({}){|memo,(k,v)| memo[k.to_sym] = v; memo}
+		end
 		
 	end
 end

data/lib/slack/post/version.rb

@@ -1,5 +1,5 @@
 module Slack
   module Post
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slack-post
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - John Bragg