slackit 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3734e3042dec6c637d1f79d9ec03b40de59af16e35c764ef36727b9d26d72ae5
-  data.tar.gz: ea202040a7466fa8ffcf97b1bb168229c6bd443242aae2122472ce1841ea8081
+  metadata.gz: dd46600c8819cc9d3ae4c44b2c94f7f1904436da707d3177872536e3ffe23d33
+  data.tar.gz: 72a88c29045497006e754242478125959c4003f17cc7360a93aba624f5d0293f
 SHA512:
-  metadata.gz: e3c8ca7bfcf4a1da6ef92b0e01ad7c9034d079823dabbd8b5a9127b21ddb2180be4ab815b45536c90855816bf505231b9de5b168f52dc54233ea76dc476f85ca
-  data.tar.gz: 339844366ac2722d53fb1f51a4e258e4f3354be03e9294495be50ffb22d16f5f34b4698ba41948ab1e6983c155c1e327ffc8dbf8cec30f6cfa793d77dbfa6862
+  metadata.gz: 66d6c556a9958eb0eccd414f2d1fa03622235b055aa8e4af289808fbbd937f8e75d0f45639df83b70fb4cb6609e1215172157eafd3a7f060548083ed71694688
+  data.tar.gz: 186f2310fc4b6a7ccf2d2660b6cc7338abbe676c79f066055e75e877cd1ac34220e5b346738a70bad3015a271223412a013fc1c04cf445eb715e8b9467f5735f

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 1.1.0 (January 22, 2019)
+
+IMPROVEMENTS:
+
+* Made the parameter list a map to make it easier to pass different combinations of options. ([@TGWolf][])
+* Added additional testing to ensure a new class instance is created. ([@TGWolf][])
+* Specifying no channel will now send the message to '#general'. ([@TGWolf][])
+* Added better error handling to the CLI tool. ([@TGWolf][])
+
 ## 1.0.1 (January 22, 2019)
 
 BUG FIX:

data/README.md

@@ -28,12 +28,31 @@ Or install it yourself as:
 
 ## Usage
 
-Using this Gem is VERY simply, everything apart from the webhook and the message are optional.
+```ruby
+require "slackit"
+```
+
+Initialize client:
+
+```ruby
+client = Slackit.new(webhook_url: "slack webhook url")
+```
+
+Initialize with options:
 
 ```ruby
-  s = Slackit.new(webhook, channel, username, emoji)
+client = SlackNotify::Client.new(
+  webhook_url: "slack webhook url",
+  channel: "#development",
+  username: "mybot",
+  icon_emoji: ":shipit:",
+)
+```
 
-  s.send(message)
+Initialize via shorthand method:
+
+```Ruby
+client = Slackit.new(options)
 ```
 
 ### Command Line Usage
@@ -42,9 +61,9 @@ Using this Gem is VERY simply, everything apart from the webhook and the message
 Usage: slackit
     -h, --help                       Display this screen
     -c, --channel string             The channel to send the message to
-    -e, --emoji string               The emoji to use [default: :wolf:]
+    -i, --icon-emoji string          The emoji to use as the channel icon [default: :wolf:]
     -m, --message string             The message to send
-    -w, --webhook string             The slack incoming webhook to use
+    -w, --webhook-url string         The slack incoming webhook url to use
     -u, --username string            The username to send as [default: slackit]
 ```
 
@@ -56,6 +75,8 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Testing
 
+For local testing make sure that you run `bundle exec rspec spec` and then `rake install` to install the gem locally.
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/AntiPhotonltd/slackit. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

data/exe/slackit

@@ -10,9 +10,13 @@ require 'slackit'
 # -------------------------------------------------------------------------------- #
 
 def send_message_to_slack(options)
-    s = Slackit.new(options[:webhook], options[:channel], options[:username], options[:emoji])
-
-    s.send(options[:message])
+    begin
+        s = Slackit.new(webhook_url: options[:webhook_url], channel: options[:channel], username: options[:username], icon_emoji: options[:icon_emoji])
+        s.send(options[:message])
+    rescue ArgumentError
+        puts "You must specify a webhook_url"
+        exit(1)
+    end
 end
 
 # -------------------------------------------------------------------------------- #
@@ -27,7 +31,7 @@ end
 def process_arguments
     options = {}
     # Enforce the presence of
-    mandatory = %I[webhook message]
+    mandatory = %I[webhook_url message]
 
     optparse = OptionParser.new do |opts|
         opts.banner = "Usage: #{$PROGRAM_NAME}"
@@ -40,16 +44,16 @@ def process_arguments
             options[:channel] = channel
         end
 
-        opts.on('-e', '--emoji string', 'The emoji to use [default: :wolf:]') do |emoji|
-            options[:emoji] = emoji
+        opts.on('-i', '--icon-emoji string', 'The emoji to use for the channel icon [default: :wolf:]') do |icon_emoji|
+            options[:icon_emoji] = icon_emoji
         end
 
         opts.on('-m', '--message string', 'The message to send') do |message|
             options[:message] = message
         end
 
-        opts.on('-w', '--webhook string', 'The slack incoming webhook to use') do |webhook|
-            options[:webhook] = webhook
+        opts.on('-w', '--webhook-url string', 'The slack incoming webhook url to use') do |webhook_url|
+            options[:webhook_url] = webhook_url
         end
 
         opts.on('-u', '--username string', 'The username to send as [default: slackit]') do |username|

data/lib/slackit/version.rb

@@ -1,3 +1,3 @@
 class Slackit
-    VERSION = '1.0.1'.freeze
+    VERSION = '1.1.0'.freeze
 end

data/lib/slackit.rb

@@ -5,11 +5,13 @@ require 'httparty'
 # To follow
 #
 class Slackit
-    def initialize(webhook_url, channel = false, username = 'SlackIT', icon_emoji = ':wolf:')
-        @webhook_url = webhook_url
-        @channel = channel
-        @username = username
-        @icon_emoji = icon_emoji
+    def initialize(options = {})
+        @webhook_url  = options[:webhook_url]
+        @username     = options[:username]
+        @channel      = options[:channel]
+        @icon_emoji   = options[:icon_emoji]
+
+        raise ArgumentError.new('Webhook URL required') if @webhook_url.nil?
     end
 
     # sends a notification
@@ -22,7 +24,7 @@ class Slackit
         body = { 'text': text, 'icon_emoji': @icon_emoji, username: @username }
 
         # add the channel if there is one otherwise the default channel
-        body['channel'] = @channel if @channel
+        body['channel'] = @channel || '#general'
 
         begin
             response = HTTParty.post(@webhook_url, body: body.to_json, headers: headers)

data/spec/slackit_spec.rb

@@ -4,4 +4,8 @@ RSpec.describe Slackit do
     it 'has a version number' do
         expect(Slackit::VERSION).not_to be nil
     end
+
+    it 'returns a client instance' do
+        expect(Slackit.new(webhook_url: 'someurl')).to be_a Slackit
+    end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: slackit
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Tim Gurney aka Wolf