slackdraft 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7dcad482dd1834021d0d51df6e59ca8b0ef8bc69
-  data.tar.gz: 055da9c748a5f1ee1a02fb9a2bf608b4cc400d65
+  metadata.gz: b66329da3ad9134da94bf8553fe434c9a1bb7627
+  data.tar.gz: 2c5cd66d67e33b167f454e8d9245969c13447e29
 SHA512:
-  metadata.gz: 8aa49f4ceba089f62f776f8092c58b9d62d306d3d240a4593ca2f7dda4d8044487bc1ebc1fa940dbcbb1e54e47df06cf62e99f99649a678cfc9540393019a286
-  data.tar.gz: 8b5113394c3e2be2c356173b29e2f5b6152577606c3dcdaee9b68d6678658e128fa1a36c80951697cc74aeb68620f13ea3281fec47262a8979362f46b8cedaa4
+  metadata.gz: 9c06d2e9d5a4397b8d3d69ebc0f08f01a5379b1e17a08757c8910118ab2bd02fb1baddfff55b80e5940bdc90d62d65e8d409ff9aa483c43c6353414da1a3a523
+  data.tar.gz: c9203c65521f94a7d8401e065e548e6547188fe24c07d905de50ed9825ea65eba51772a9598ea6583105cf296b8f82651212b206679b6028037708d4469ee895

data/.gitignore

@@ -1,2 +1,3 @@
 /.bundle/
 /vendor/
+Gemfile.lock

data/examples/attachment.rb

@@ -7,24 +7,29 @@ require 'slackdraft'
 url = "https://hooks.slack.com/services/xxxxxxxxxx"
 
 # Create instance
-slack = Slackdraft::Attachment.new(url)
-slack.fallback    = "Fallback text!!!!"
-slack.color = "#439FE0"
-slack.pretext ="Hmm where?"
+attachment = Slackdraft::Attachment.new url
 
-slack.author_name = "Mike"
-slack.author_link = "https://github.com/mikemackintosh"
-slack.author_icon = ":skull:"
+attachment.text = "Test"
+attachment.username = "johndoe"
+attachment.channel = "#slackdraft"
 
-slack.title =  "By Mike Mackintosh"
-slack.title_link = "https://github.com/mikemackintosh"
+attachment.fallback    = "Fallback text!!!!"
+attachment.color = "#439FE0"
+attachment.pretext ="Hmm where?"
 
-slack.text = "This is pretty cool"
+attachment.author_name = "Mike"
+attachment.author_link = "https://github.com/mikemackintosh"
+attachment.author_icon = ":skull:"
 
-slack.add_field("col 1", "blahblahblah")
-slack.add_field("col 2", "derpherp")
+attachment.title =  "By Mike Mackintosh"
+attachment.title_link = "https://github.com/mikemackintosh"
+
+attachment.message = "This is pretty cool"
+
+attachment.add_field("col 1", "blahblahblah")
+attachment.add_field("col 2", "derpherp")
 
 # Send it, and check response
-if slack.send!
+if attachment.send!
   Slackdraft::success("Message successful")
 end

data/examples/attachment_long.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'slackdraft'
+
+# Set URL
+url = "https://hooks.slack.com/services/xxxxxxxxxx"
+
+# Create instance
+slack = Slackdraft::Message.new(url)
+slack.text = "Test"
+slack.username = "johndoe"
+slack.channel = "#slackdraft"
+
+# Create an Attachment
+attachment = Slackdraft::Attachment.new
+attachment.fallback    = "Fallback text!!!!"
+attachment.color = "#439FE0"
+attachment.pretext ="Hmm where?"
+
+attachment.author_name = "Mike"
+attachment.author_link = "https://github.com/mikemackintosh"
+attachment.author_icon = ":skull:"
+
+attachment.title =  "By Mike Mackintosh"
+attachment.title_link = "https://github.com/mikemackintosh"
+
+attachment.message = "This is pretty cool"
+
+attachment.add_field("col 1", "blahblahblah")
+attachment.add_field("col 2", "derpherp")
+
+# Add the attachment back to Slack::Message
+slack.add_attachment(attachment)
+
+# Send it, and check response
+if slack.send!
+  Slackdraft::success("Message successful")
+end

data/examples/formatted/alert.rb

@@ -0,0 +1,44 @@
+#!/usr/bin/env ruby
+lib = File.expand_path('../../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+# TODO: Change color based on alert type
+
+# Require Slackdraft
+require 'slackdraft'
+
+# Set the webhook
+WEBHOOK = ENV['SLACK_EP'] ||= "https://...."
+
+# Create instance
+slack = Slackdraft::Format::Alert.new WEBHOOK
+
+# Username to send message as
+slack.username = "MikeMackintosh"
+
+# Where to send alert to
+slack.channel = "#slackdraft"
+
+# Service that is alerting
+slack.service = "Slack Communications"
+
+# Header message (smaller text)
+slack.header = "New Alert Received!"
+
+# Alert message
+slack.alert = "Shit is going down"
+
+# Severity
+slack.severity = 4
+
+# Name and link to originator bot
+slack.bot = "SlackDraft Alert"
+slack.botlink = "http://github.com/mikemackintosh"
+
+# Add a link here to your runbook/wiki on how to fix
+slack.runbook = "https://github.com/mikemackintosh"
+
+# Send it, and check response
+if slack.send!
+  Slackdraft::success("Message successful")
+end

data/lib/slackdraft.rb

@@ -8,6 +8,7 @@ require 'slackdraft/base'
 require 'slackdraft/message'
 require 'slackdraft/version'
 require 'slackdraft/attachment'
+require 'slackdraft/format/init'
 
 module Slackdraft
   

data/lib/slackdraft/attachment.rb

@@ -1,22 +1,29 @@
 module Slackdraft
 
-  class Attachment < Base
+  class Attachment < Slackdraft::Message
 
     fattr fallback: "This message was sent with Slackdraft"
-    fattr color: "#439FE0"
-    fattr pretext: nil
+    fattr color:    "#439FE0"
+    fattr pretext:  nil
 
     fattr author_name: nil
     fattr author_link: nil
     fattr author_icon: nil
 
-    fattr title: nil
+    fattr title:      nil
     fattr title_link: nil
 
-    fattr text: nil
-    fattr fields: []
+    fattr message:    nil
+    fattr fields:     []
 
-    fattr image_url: nil
+    fattr image_url:  nil
+
+    # Capture the url if we pass it in
+    def initialize(url=nil)
+      unless url.nil?
+        @target = url
+      end
+    end
 
     # Short defines if it's 1 column or not, default: not
     def add_field(title, value, short=true)
@@ -24,7 +31,7 @@ module Slackdraft
     end
 
     # Generate the payload for slack attachments
-    def generate_payload
+    def generate_attachment
         payload = {}
         payload[:fallback]    = self.fallback    unless self.fallback.nil?
         payload[:color]       = self.color       unless self.color.nil?
@@ -34,7 +41,7 @@ module Slackdraft
         payload[:author_icon] = self.author_icon unless self.author_icon.nil?
         payload[:title]       = self.title       unless self.title.nil?
         payload[:title_link]  = self.title_link  unless self.title_link.nil?
-        payload[:text]        = self.text        unless self.text.nil?
+        payload[:text]        = self.message     unless self.message.nil?
         
         unless self.fields.nil?
             payload[:fields]      = self.fields if self.fields.length > 0
@@ -42,11 +49,20 @@ module Slackdraft
 
         payload[:image_url]   = self.image_url   unless self.image_url.nil?
 
-        puts payload.inspect
-
         payload
     end
 
+    # To hash, for use in Message
+    def to_h
+        generate_attachment
+    end
+
+    # Send it directly from Attachment
+    def send!
+        add_attachment(generate_attachment)
+        super
+    end
+
   end
 
 end

data/lib/slackdraft/format/alert.rb

@@ -0,0 +1,126 @@
+module Slackdraft
+
+  class Format
+
+    fattr :service
+    fattr :type
+    fattr :alert
+    fattr header: nil
+    fattr severity: nil
+    fattr runbook: nil
+    fattr bot: "slackdraft"
+    fattr botlink: nil
+    #fattr message: nil
+
+    class Alert < Slackdraft::Attachment
+      def send!
+        parse
+        super
+      end
+
+      # Parse the alert message
+      def parse
+        @title = @service
+        
+        unless @header.nil?
+          @text = @header
+        end
+
+        @message = @alert
+        @fallback = @alert
+
+        unless @bot.nil?
+          @author_name = @bot
+          unless @botlink.nil?
+            @author_name = @botlink
+          end
+        end
+
+        unless @severity.nil?
+          add_field("Severity", @severity)
+        end
+
+        unless @runbook.nil?
+          add_field("Runbook", @runbook)
+        end
+      end
+
+      # Set the alert text
+      def service=(service)
+        @service = service
+      end      
+      def service(service)
+        @service = service
+      end
+      alias_method :system=, :service=
+      alias_method :system, :service
+
+      
+      # Set the alert text
+      def bot=(bot)
+        @bot = bot
+      end      
+      def bot(bot)
+        @bot = bot
+      end
+      alias_method :alerter=, :bot=
+      alias_method :alerter, :bot
+      
+      # Set the alert text
+      def botlink=(botlink)
+        @botlink = botlink
+      end      
+      def botlink(botlink)
+        @botlink = botlink
+      end
+      alias_method :alerterlink=, :botlink=
+      alias_method :alerterlink, :botlink
+
+      # Set the alert text
+      def type=(type)
+        @type = type
+      end      
+      def type(type)
+        @type = type
+      end
+
+      # Set the alert text
+      def alert=(alert)
+        @alert = alert
+      end
+      def alert(alert)
+        @alert = alert
+      end
+
+      # Set the alert text
+      def header=(header)
+        @header = header
+      end
+      def alert(header)
+        @header = header
+      end
+
+      # Set the severity
+      def sev=(severity)
+        @severity = severity
+      end
+      def sev(severity)
+        @severity = severity
+      end
+      alias_method :severity, :sev
+      alias_method :severity=, :sev=
+
+      # Set the severity
+      def runbook=(runbook)
+        @runbook = runbook
+      end
+      def runbook(runbook)
+        @runbook = runbook
+      end
+      alias_method :fix_url, :runbook
+
+    end
+
+  end
+
+end

data/lib/slackdraft/format/init.rb

@@ -0,0 +1 @@
+require_relative 'alert'

data/lib/slackdraft/message.rb

@@ -7,6 +7,7 @@ module Slackdraft
     fattr icon_emoji: ':fire:'
     fattr icon_url:   ''
     fattr text:       ''
+    fattr attachments: []
 
     # Set the api call username
     def username
@@ -20,6 +21,11 @@ module Slackdraft
       @channel
     end
 
+    # Add an attachment
+    def add_attachment(attachment)
+      self.attachments.push(attachment.to_h)
+    end
+
     # Set the icon URL and default to the emoji
     def icon_url
       @icon_url || icon_emoji
@@ -30,10 +36,12 @@ module Slackdraft
       return ':fire:' if @icon_emoji.nil?
     end
 
+    # Reference a channel
     def refchannel(channel)
       "<#C024BE7LR|#{channel}>"
     end
 
+    # Reference a user
     def refuser(user)
       "<@U024BE7LH|#{user}>"
     end
@@ -46,17 +54,17 @@ module Slackdraft
       end
       
       @text
-
     end
 
     # Generate the payload if stuff was provided
     def generate_payload
         payload = {}
-        payload[:channel]    = self.channel    unless self.channel.nil?
-        payload[:username]   = self.username   unless self.username.nil?
-        payload[:icon_url]   = self.icon_url   unless self.icon_url.nil?
-        payload[:icon_emoji] = self.icon_emoji unless self.icon_emoji.nil?
-        payload[:text]       = self.text       unless self.text.nil?
+        payload[:channel]     = self.channel    unless self.channel.nil?
+        payload[:username]    = self.username   unless self.username.nil?
+        payload[:icon_url]    = self.icon_url   unless self.icon_url.nil?
+        payload[:icon_emoji]  = self.icon_emoji unless self.icon_emoji.nil?
+        payload[:text]        = self.text       unless self.text.nil?
+        payload[:attachments] = self.attachments unless self.attachments.empty?
 
         payload
     end

data/lib/slackdraft/version.rb

@@ -1,3 +1,3 @@
 module Slackdraft
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slackdraft
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mike Mackintosh
@@ -134,17 +134,21 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/slackdraft
 - examples/attachment.rb
+- examples/attachment_long.rb
+- examples/formatted/alert.rb
 - lib/slackdraft.rb
 - lib/slackdraft/attachment.rb
 - lib/slackdraft/base.rb
+- lib/slackdraft/format/alert.rb
+- lib/slackdraft/format/init.rb
 - lib/slackdraft/message.rb
 - lib/slackdraft/version.rb
+- slackdraft-1.0.0.gem
 - slackdraft.gemspec
 homepage: http://github.com/mikemackintosh/slackdraft
 licenses:

data/Gemfile.lock

@@ -1,53 +0,0 @@
-PATH
-  remote: .
-  specs:
-    slackdraft (0.7.7)
-      fattr
-      httparty
-      methadone
-      paint
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    addressable (2.3.7)
-    crack (0.4.2)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.2.5)
-    fattr (2.2.2)
-    httparty (0.13.3)
-      json (~> 1.8)
-      multi_xml (>= 0.5.2)
-    json (1.8.2)
-    methadone (1.8.0)
-      bundler
-    multi_xml (0.5.5)
-    paint (0.9.0)
-    rake (10.4.2)
-    rspec (3.2.0)
-      rspec-core (~> 3.2.0)
-      rspec-expectations (~> 3.2.0)
-      rspec-mocks (~> 3.2.0)
-    rspec-core (3.2.0)
-      rspec-support (~> 3.2.0)
-    rspec-expectations (3.2.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-mocks (3.2.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.2.0)
-    rspec-support (3.2.1)
-    safe_yaml (1.0.4)
-    webmock (1.20.4)
-      addressable (>= 2.3.6)
-      crack (>= 0.3.2)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  rake
-  rspec
-  slackdraft!
-  webmock