slackdraft 0.7.6c → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5e50ebf5183cb3d283edc5f715557586975a11b6
-  data.tar.gz: ff7919f5e9d145855528f2a86c0c039611deabbb
+  metadata.gz: 7dcad482dd1834021d0d51df6e59ca8b0ef8bc69
+  data.tar.gz: 055da9c748a5f1ee1a02fb9a2bf608b4cc400d65
 SHA512:
-  metadata.gz: f87c2bf0b4f5d15be3f3ebfe550e1112a20eef70d18dda20a1f56d9bc280aa03bf003abd939a547adf4b7d59d46da3011ddbae0f15eb9b19ac6adf635e4ce489
-  data.tar.gz: 25bbb8556fe4b30fe21cfe6569532f45df7724aeaa8954fb340990f2b0bdf5f56e691da00e2ff18c3e4a1f61827f5e0b39f231edbf6f747d07015a2793cf7886
+  metadata.gz: 8aa49f4ceba089f62f776f8092c58b9d62d306d3d240a4593ca2f7dda4d8044487bc1ebc1fa940dbcbb1e54e47df06cf62e99f99649a678cfc9540393019a286
+  data.tar.gz: 8b5113394c3e2be2c356173b29e2f5b6152577606c3dcdaee9b68d6678658e128fa1a36c80951697cc74aeb68620f13ea3281fec47262a8979362f46b8cedaa4

data/.travis.yml

@@ -0,0 +1 @@
+language: ruby

data/Gemfile.lock

@@ -1,8 +1,11 @@
 PATH
   remote: .
   specs:
-    slackdraft (0.7.6c)
+    slackdraft (0.7.7)
+      fattr
       httparty
+      methadone
+      paint
 
 GEM
   remote: https://rubygems.org/
@@ -11,11 +14,15 @@ GEM
     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)

data/README.md

@@ -1,2 +1,70 @@
 # slackdraft
-Simplest way to format messages to Slack
+Simplest way to send messages to Slack.
+
+![TravisCI](https://travis-ci.org/mikemackintosh/slackdraft.svg)
+
+# Installation
+
+Like any other gem:
+
+    gem install slackdraft
+
+
+# Ruby Usage
+
+Usage is very simple:
+
+    require 'slackdraft'
+    url = "https://slack/webhook/url"
+    slack = Slackdraft::Message.new(url)
+    
+    # Url of the icon or emoji
+    # slack.icon_url    = "https://..."
+    slack.icon_emoji  = ":fire:"
+    
+    # Set the bot username
+    slack.username    = "SlackDraft"
+    
+    # Set the channel
+    slack.channel     = "#general"
+    
+    # Set text
+    slack.text         = "Your message here! _*And can have* formatting_"
+    
+    # Or you can pass text in as an array
+    # slack.text        = ["Your message here!", ">_*And can have* formatting_"]
+
+    # Send the message
+    slack.send!
+      #-> true/false
+
+For more examples, see the `examples/` directory.
+
+# Command-line Usage
+
+It's dumb simple. Instead of using `curl`, use this:
+
+    slackdraft -u mike \
+        -c "#slackdraft" \
+        -m "This is our *formammted message*" \
+        https://hooks.slack.com/services/xxxxxxx
+
+> **Note**: The CLI version does not support Slack Attachments
+
+## Help text
+
+    $ slackdraft -h
+    Usage: slackdraft [options] url
+
+    Slack with less Kurt Russell
+
+    v0.7.7
+
+    Options:
+        -h, --help                       Show command line help
+            --version                    Show help/version info
+        -c, --channel CHANNEL            Channel to send message to
+        -u, --username USER              User to send message as
+        -m, --message MESSAGE            Message to send
+        -e, --emoji EMOJI                Emoji to prefix message with
+        -i, --icon ICON                  Icon to prefix message with

data/bin/slackdraft

@@ -2,12 +2,59 @@
 # coding: utf-8
 
 require 'slackdraft'
+require 'methadone'
 
-slack = Slackdraft::Message.new 'https://hooks.slack.com/services/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'
-#slack.icon = "this"
-#slack.icon_emoji = ":fire:"
-slack.channel = "#slackdraft"
-slack.text = ["Testing *formatting* and", "> this should be"]
-slack.send!
+class App
+  include Methadone::Main
 
-puts slack.inspect
+  leak_exceptions true
+
+  # Set Version
+  version Slackdraft::VERSION
+  description "Slack with less Kurt Russell"
+
+  # This is the main instructions
+  main do |url|
+
+    # Create instance
+    slack = Slackdraft::Message.new(url)
+    slack.icon_url    = options[:icon]
+    slack.icon_emoji  = options[:emoji]
+    slack.username    = options[:username]
+    slack.channel     = options[:channel]
+    slack.text        = options[:message]
+
+    # Send it, and check response
+    if slack.send!
+      Slackdraft::success("Message successful")
+    end
+    
+  end
+
+  # These are the options
+  on('-c', '--channel CHANNEL', "Channel to send message to")
+  on('-u', '--username USER',   "User to send message as")
+  on('-m', '--message MESSAGE', "Message to send")
+  on('-e', '--emoji EMOJI',     "Emoji to prefix message with")
+  on('-i', '--icon ICON',       "Icon to prefix message with")
+  
+  # Grab to webhook url
+  arg :url
+
+  begin
+
+    # No Args?
+    if ARGV.empty?
+      Slackdraft::fatal("No options given; see slackdraft --help for options.")
+    end
+
+    go!
+
+ rescue Interrupt
+    print "\b\b\n"; # Remove ^C from screen
+    Slackdraft::fatal("Caught interrupt; exiting.")
+  rescue => e
+    Slackdraft::fatal("An error occurred: #{e.class.name}: #{e.message}")
+  end
+
+end

data/examples/attachment.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/env ruby
+# coding: utf-8
+
+require 'slackdraft'
+
+# Set URL
+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?"
+
+slack.author_name = "Mike"
+slack.author_link = "https://github.com/mikemackintosh"
+slack.author_icon = ":skull:"
+
+slack.title =  "By Mike Mackintosh"
+slack.title_link = "https://github.com/mikemackintosh"
+
+slack.text = "This is pretty cool"
+
+slack.add_field("col 1", "blahblahblah")
+slack.add_field("col 2", "derpherp")
+
+# Send it, and check response
+if slack.send!
+  Slackdraft::success("Message successful")
+end

data/lib/slackdraft/attachment.rb

@@ -0,0 +1,52 @@
+module Slackdraft
+
+  class Attachment < Base
+
+    fattr fallback: "This message was sent with Slackdraft"
+    fattr color: "#439FE0"
+    fattr pretext: nil
+
+    fattr author_name: nil
+    fattr author_link: nil
+    fattr author_icon: nil
+
+    fattr title: nil
+    fattr title_link: nil
+
+    fattr text: nil
+    fattr fields: []
+
+    fattr image_url: nil
+
+    # Short defines if it's 1 column or not, default: not
+    def add_field(title, value, short=true)
+        fields.push({:title => title, :value => value, :short => short })
+    end
+
+    # Generate the payload for slack attachments
+    def generate_payload
+        payload = {}
+        payload[:fallback]    = self.fallback    unless self.fallback.nil?
+        payload[:color]       = self.color       unless self.color.nil?
+        payload[:pretext]     = self.pretext     unless self.pretext.nil?
+        payload[:author_name] = self.author_name unless self.author_name.nil?
+        payload[:author_link] = self.author_link unless self.author_link.nil?
+        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?
+        
+        unless self.fields.nil?
+            payload[:fields]      = self.fields if self.fields.length > 0
+        end
+
+        payload[:image_url]   = self.image_url   unless self.image_url.nil?
+
+        puts payload.inspect
+
+        payload
+    end
+
+  end
+
+end

data/lib/slackdraft/base.rb

@@ -0,0 +1,37 @@
+module Slackdraft
+  class Base
+    
+    fattr endpoint: 'https://hooks.slack.com/services/'
+
+    # Init the class
+    def initialize(token, &block)
+      if /^https?/.match(token)
+        @target = token
+      else 
+        @target = "#{self.endpoint}#{@token}"
+      end
+
+      instance_eval(&block) if block_given?
+    end
+
+    def target
+      @target
+    end
+
+    # Send the message!
+    def send!
+      
+      # Send the request
+      request = HTTParty.post(self.target, :body => {
+        :payload => generate_payload.to_json
+      })
+
+      unless request.code.eql? 200
+        false
+      end
+
+      true
+
+    end
+  end
+end

data/lib/slackdraft/message.rb

@@ -0,0 +1,65 @@
+module Slackdraft
+  class Message < Slackdraft::Base
+
+    # Attributes
+    fattr username:   'slackdraft'
+    fattr channel:    '#general'
+    fattr icon_emoji: ':fire:'
+    fattr icon_url:   ''
+    fattr text:       ''
+
+    # Set the api call username
+    def username
+      return 'slackdraft' if @username.nil?
+      @username
+    end
+
+    # Set the destination channel
+    def channel
+      return '#general' if @channel.nil?
+      @channel
+    end
+
+    # Set the icon URL and default to the emoji
+    def icon_url
+      @icon_url || icon_emoji
+    end
+
+    # Set the emoji
+    def icon_emoji
+      return ':fire:' if @icon_emoji.nil?
+    end
+
+    def refchannel(channel)
+      "<#C024BE7LR|#{channel}>"
+    end
+
+    def refuser(user)
+      "<@U024BE7LH|#{user}>"
+    end
+
+    # Set the text of the message
+    def text
+      
+      if @text.kind_of?(Array)
+        return @text.join("\n")
+      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
+    end
+
+  end
+end

data/lib/slackdraft/version.rb

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

data/lib/slackdraft.rb

@@ -1,83 +1,34 @@
 require 'httparty'
 require 'json'
 require 'cgi'
+require 'fattr'
+require 'paint'
 
+require 'slackdraft/base'
+require 'slackdraft/message'
 require 'slackdraft/version'
-#require 'slackdraft/attachment'
-#require 'slackdraft/message'
+require 'slackdraft/attachment'
 
 module Slackdraft
-  class Message
-    
-    # Attributes
-    attr_writer :username
-    attr_writer :channel
-    attr_writer :icon_url
-    attr_writer :icon_emoji
-    attr_writer :text
-
-    # Init the class
-    def initialize(url)
-      @webhookuri = url
-    end
-
-    # Set the api call username
-    def username
-      @username ||= 'slackdraft'
-    end
-
-    # Set the destination channel
-    def channel
-      @channel || '#general'
-    end
-
-    # Set the icon URL and default to the emoji
-    def icon_url
-      @icon_url || icon_emoji
-    end
-
-    # Set the emoji
-    def icon_emoji
-      @icon_emoji || ':fire:'
-    end
-
-    # Set the text of the message
-    def text
-        @text.join("\n")
-        puts @text
-    end
-
-    # Send the message!
-    def send!
-
-      puts @channel
-      puts @username
-
-      request = HTTParty.post(@webhookuri, :body => {
-        :payload => {
-          :channel => @channel,
-          :username => @username,
-          :text => @text,
-          :icon_emoji => @icon_emoji,
-        }.to_json
-      })
-
-      puts request.code
-      puts request.body
-    end
-
+  
+  def self.success(message)
+    puts " #{Paint['[✓]', :bright, :green]} #{Paint[message, :bright, :white]}"
+    exit!
+  end
+   
+  def self.info(message)
+    puts " #{Paint['[i]', :bright, :blue]} #{Paint[message, :bright, :white]}"
+    exit!
   end
 
-  class Attachment
-    attr_writer :fallback
-    attr_writer :text
-    attr_writer :pretext
-    attr_writer :color
-    attr_writer :fields
-
-    def initialize
-
-    end
-
+  def self.warning(message)
+    puts " #{Paint['[!]', :bright, :orange]} #{Paint[message, :bright, :white]}"
+    exit!
   end
+  
+  def self.fatal(message)
+    puts " #{Paint['[x]', :bright, :red]} #{Paint[message, :bright, :white]}"
+    exit!
+  end
+
 end

data/slackdraft.gemspec

@@ -9,8 +9,8 @@ Gem::Specification.new do |s|
   s.name        = 'slackdraft'
   s.version     = Slackdraft::VERSION
   s.date        = '2015-02-14'
-  s.summary     = "Slack messaging with half the Kurt Russel"
-  s.description = "Slack messaging with half the Kurt Russel"
+  s.summary     = "Slack messaging with half the Kurt Russell"
+  s.description = "Slack messaging with half the Kurt Russell"
   s.authors     = ["Mike Mackintosh"]
   s.email       = 'm@zyp.io'
   s.homepage    =
@@ -24,6 +24,9 @@ Gem::Specification.new do |s|
   s.test_files    = s.files.grep(%r{^(test|spec|features)/})
 
   s.add_dependency 'httparty'
+  s.add_dependency 'fattr'
+  s.add_dependency 'paint'
+  s.add_dependency 'methadone'
 
   s.add_development_dependency "bundler"
   s.add_development_dependency "rake"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slackdraft
 version: !ruby/object:Gem::Version
-  version: 0.7.6c
+  version: 1.0.0
 platform: ruby
 authors:
 - Mike Mackintosh
@@ -24,6 +24,48 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: fattr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: paint
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: methadone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,7 +122,7 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: Slack messaging with half the Kurt Russel
+description: Slack messaging with half the Kurt Russell
 email: m@zyp.io
 executables:
 - slackdraft
@@ -90,13 +132,18 @@ files:
 - .gitignore
 - .rock.yml
 - .rspec
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/slackdraft
+- examples/attachment.rb
 - lib/slackdraft.rb
+- lib/slackdraft/attachment.rb
+- lib/slackdraft/base.rb
+- lib/slackdraft/message.rb
 - lib/slackdraft/version.rb
 - slackdraft.gemspec
 homepage: http://github.com/mikemackintosh/slackdraft
@@ -114,13 +161,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
-summary: Slack messaging with half the Kurt Russel
+summary: Slack messaging with half the Kurt Russell
 test_files: []