slackit 1.1.10 → 1.1.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 19c0142dd96bef5b8b87d09a03e5af539bb14a7bb68f17bab9fbebae61c85879
-  data.tar.gz: af810fb2581d78251284ececd1d924fde680e5b4b8b2db5d5566f5088bed9391
+  metadata.gz: ffac7badefe83f4137bae067ecd1b64aff9c0bd0dcab7ed9292f885f875f6847
+  data.tar.gz: 65bc3f113eb2622a8e321ee63b66147364fd4e57d5ec47573fd0f1be3ef4ecd8
 SHA512:
-  metadata.gz: db62100414a06794a0560cd9c0702fa9f678eb76efaa28d5aed92c7da350fd8524973d5692aedd0e7c966bf78b6c28e6d975f021a1903b695796b77ce105237e
-  data.tar.gz: e471c2e16512f33b7bde41ca5ac5580df4b88551a9694899c961ca2a0df6fd7dd32b9ea0ed0e6894fce72e4665763cea577470844d15e6d96c2a61598cb30624
+  metadata.gz: 49cdf3c9cb84a8d3d2eaac5b059fe4a7879ede779a1052b9b755487dcca1f5c7b44a06b7641aeba5acc25a714a6b315ab84395534a7311b314bc5b3f108c6ac6
+  data.tar.gz: e451640c4d2565909f4354834dd19eea3872883bc2fff0bc804bb1fc8ed938c5183325cbc9690153634661e8c9ad79adc6c0d47af15ffdec6a68e719eb1be498

data/.rubocop.yml

@@ -25,6 +25,9 @@ Layout/LineLength:
 Layout/SpaceInsideArrayLiteralBrackets:
     Enabled: false
 
+Lint/RescueException:
+    Enabled: false
+
 Metrics/AbcSize:
     Enabled: false
 

data/CHANGELOG.md

@@ -5,11 +5,19 @@ All notable changes to this project will be documented in this file.
 
 This changelog was automatically generated using [Caretaker](https://github.com/AntiPhotonltd/slackit) by [Wolf Software](https://github.com/WolfSoftware)
 
-### [v1.1.10](https://github.com/AntiPhotonltd/slackit/compare/v1.1.9...v1.1.10)
+### [Unreleased](https://github.com/AntiPhotonltd/slackit/compare/v1.1.10...HEAD)
+
+- Pre-release push and test [`[head]`](https://github.com/AntiPhotonltd/slackit/commit/) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Fix rake and bundle errors [`[4eb94e5]`](https://github.com/AntiPhotonltd/slackit/commit/4eb94e573cae25be2b616f25b6987b510b7f6395) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Added better validation of slack webhook urls including a cli option to validate a hook, also replace httpary with net/http for more control [`[150b522]`](https://github.com/AntiPhotonltd/slackit/commit/150b522104e285c7cb59b1366fa132c06ec68518) [`[TGWolf]`](https://github.com/TGWolf)
+
+### [v1.1.9](https://github.com/AntiPhotonltd/slackit/compare/v1.1.8...v1.1.9)
 
 > Released on July, 31st 2020
 
-- Bump version ready for release [`[bf92ada]`](https://github.com/AntiPhotonltd/slackit/commit/bf92ada1d36007e652165546160dc91359a6e833) [`[TGWolf]`](https://github.com/TGWolf)
+- Bump version ready for release [`[1f236b2]`](https://github.com/AntiPhotonltd/slackit/commit/1f236b290312173c2b25a9f1f08e65f181b68648) [`[TGWolf]`](https://github.com/TGWolf)
 
 - Update readme to new verrsion [`[a9263c0]`](https://github.com/AntiPhotonltd/slackit/commit/a9263c04d5405ee46116c0ee4a5a1dbd46e25102) [`[TGWolf]`](https://github.com/TGWolf)
 
@@ -19,7 +27,7 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - Add attachments and blocks [`[3a84400]`](https://github.com/AntiPhotonltd/slackit/commit/3a844009d445b3684032fb5546baa95ebf219fd9) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.1.9](https://github.com/AntiPhotonltd/slackit/compare/v1.1.8...v1.1.9)
+### [v1.1.8](https://github.com/AntiPhotonltd/slackit/compare/v1.1.7...v1.1.8)
 
 > Released on March, 9th 2020
 
@@ -27,7 +35,7 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - Fix a typo in link checking job [`[e8ba2a6]`](https://github.com/AntiPhotonltd/slackit/commit/e8ba2a61b6b44adabdbf03d2160a8693f5f41b0a) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.1.8](https://github.com/AntiPhotonltd/slackit/compare/v1.1.7...v1.1.8)
+### [v1.1.7](https://github.com/AntiPhotonltd/slackit/compare/v1.1.6...v1.1.7)
 
 > Released on March, 9th 2020
 
@@ -35,7 +43,7 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - Fix gemfile ruby version [`[fb0d2dc]`](https://github.com/AntiPhotonltd/slackit/commit/fb0d2dc6618b9fcf04c8730b827ad7e0fbc0001c) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.1.7](https://github.com/AntiPhotonltd/slackit/compare/v1.1.6...v1.1.7)
+### [v1.1.6](https://github.com/AntiPhotonltd/slackit/compare/v1.1.5...v1.1.6)
 
 > Released on March, 9th 2020
 
@@ -55,7 +63,7 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - badges [`[d2c017b]`](https://github.com/AntiPhotonltd/slackit/commit/d2c017b7b1548c2544b24a8fc5d4d12f6d54c915) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.1.6](https://github.com/AntiPhotonltd/slackit/compare/v1.1.5...v1.1.6)
+### [v1.1.5](https://github.com/AntiPhotonltd/slackit/compare/v1.1.4...v1.1.5)
 
 > Released on September, 30th 2019
 
@@ -67,7 +75,7 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - typos [`[5cd43c8]`](https://github.com/AntiPhotonltd/slackit/commit/5cd43c86649e93fd8a97ec6a598a5295f4812267) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.1.5](https://github.com/AntiPhotonltd/slackit/compare/v1.1.4...v1.1.5)
+### [v1.1.4](https://github.com/AntiPhotonltd/slackit/compare/v1.1.3...v1.1.4)
 
 > Released on June, 28th 2019
 
@@ -81,7 +89,7 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - travis cleanup [`[6278daa]`](https://github.com/AntiPhotonltd/slackit/commit/6278daafa0b58d54aa22c0c1d62d3c72ccf25dd8) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.1.4](https://github.com/AntiPhotonltd/slackit/compare/v1.1.3...v1.1.4)
+### [v1.1.3](https://github.com/AntiPhotonltd/slackit/compare/v1.1.2...v1.1.3)
 
 > Released on March, 13th 2019
 
@@ -89,7 +97,7 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - typos [`[1250bbb]`](https://github.com/AntiPhotonltd/slackit/commit/1250bbb9399a102a9ef9844620347b12d80304a9) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.1.3](https://github.com/AntiPhotonltd/slackit/compare/v1.1.2...v1.1.3)
+### [v1.1.2](https://github.com/AntiPhotonltd/slackit/compare/v1.1.1...v1.1.2)
 
 > Released on February, 6th 2019
 
@@ -97,7 +105,7 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - Add multiline message support [`[#2]`](https://github.com/AntiPhotonltd/slackit/pull/2) [`[TGWolf]`](https://github.com/TGWolf) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.1.2](https://github.com/AntiPhotonltd/slackit/compare/v1.1.1...v1.1.2)
+### [v1.1.1](https://github.com/AntiPhotonltd/slackit/compare/v1.1.0...v1.1.1)
 
 > Released on January, 31st 2019
 
@@ -105,7 +113,7 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - Add ability to pipe message [`[#1]`](https://github.com/AntiPhotonltd/slackit/pull/1) [`[TGWolf]`](https://github.com/TGWolf) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.1.1](https://github.com/AntiPhotonltd/slackit/compare/v1.1.0...v1.1.1)
+### [v1.1.0](https://github.com/AntiPhotonltd/slackit/compare/v1.0.1...v1.1.0)
 
 > Released on January, 22nd 2019
 
@@ -117,7 +125,7 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - typo [`[7db1903]`](https://github.com/AntiPhotonltd/slackit/commit/7db1903b8bfed04f22dd61f43b17918fcb2de5c8) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.1.0](https://github.com/AntiPhotonltd/slackit/compare/v1.0.1...v1.1.0)
+### [v1.0.1](https://github.com/AntiPhotonltd/slackit/compare/v1.0.0...v1.0.1)
 
 > Released on January, 22nd 2019
 
@@ -131,7 +139,7 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - Added testing section to README [`[4f53027]`](https://github.com/AntiPhotonltd/slackit/commit/4f53027cb09017419509736420067804fd06eedb) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.0.1](https://github.com/AntiPhotonltd/slackit/compare/v1.0.0...v1.0.1)
+### [v1.0.0](https://github.com/AntiPhotonltd/slackit/releases/v1.0.0)
 
 > Released on January, 22nd 2019
 
@@ -139,10 +147,6 @@ This changelog was automatically generated using [Caretaker](https://github.com/
 
 - Tweak README [`[431ad5e]`](https://github.com/AntiPhotonltd/slackit/commit/431ad5e9e7b3c3633e9488bf33e07d7ed4816331) [`[TGWolf]`](https://github.com/TGWolf)
 
-### [v1.0.0](https://github.com/AntiPhotonltd/slackit/releases/v1.0.0)
-
-> Released on January, 21st 2019
-
 - Make the cli actually do something useful [`[b21dd45]`](https://github.com/AntiPhotonltd/slackit/commit/b21dd45f0669abc7e9cb48befd8933dfde259e45) [`[TGWolf]`](https://github.com/TGWolf)
 
 - Badges [`[a5832d4]`](https://github.com/AntiPhotonltd/slackit/commit/a5832d408c40effd71b1c11b704c6997a505e5e2) [`[TGWolf]`](https://github.com/TGWolf)

data/README.md

@@ -91,7 +91,7 @@ client = Slackit.new(webhook_url: "slack webhook url")
 #### Initialize with all options
 
 ```ruby
-client = SlackNotify::Client.new(
+client = Slackit.new(
   webhook_url: "slack webhook url",
   channel: "#development",
   username: "mybot",
@@ -105,6 +105,25 @@ client = SlackNotify::Client.new(
 client = Slackit.new(options)
 ```
 
+#### Validating the webhook url
+
+Firstly slackit will check to ensure that the webhook url starts with `https://hooks.slack.com/services`, this is the slack standard for all invalid webhook urls.
+
+Secondly slackit will attempt to validate the webhook url, by making a HTTP `GET` request, if the response to the request is a redirect to `https://api.slack.com` then the url is deemed to be invalid.
+
+This checking can be bypassed by supplying the `-V` command line option to tell slackit this is a `valid` url, this is useful if you know that the URL is valid and working and removes the additional overhead of repeated testing for each message.
+
+If you want to manually validate a url you can do this using the command line option -v
+
+```
+slackit -v -w <slack webhook url>
+```
+
+This will run the GET test and also send a test message to the `general` channel to ensure that the supplied token is also valid, if this comes back with a success you `should` be safe to use the -V option from then on.
+
+> Normal error handling during the post of a message will always be carried out.
+
+
 ### Sending Messages
 
 #### Simple messages
@@ -139,17 +158,25 @@ Usage: slackit
     -w, --webhook-url string         The slack incoming webhook url to use
     -u, --username string            The username to send as [default: slackit]
 
+Webhook Validation:
+    -v, --validation-test            Run a webbook validation test
+    -V, --validated-webhook          Flag the webhook as validated (skips constant validation)
+
 Message type options:
     -a, --attachment                 Treat the message as an attachment
     -b, --block                      Treat the message as a block
 ```
 
-### Pipe message
+#### Pipe message
 
 Alternatively to using the `-m` parameter, you can pipe your message instead:
 
     $ echo 'Hello world!' | slackit -w ...
 
+#### Return values
+
+For all sucessful sending slackit will return a value of 0. For all errors it will return the value of 1.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/exe/slackit

@@ -2,6 +2,7 @@
 
 require 'optparse'
 require 'slackit'
+require 'cmessages'
 
 # -------------------------------------------------------------------------------- #
 # Send Mssage to Slack                                                             #
@@ -13,20 +14,20 @@ def send_message_to_slack(options)
     begin
         s = Slackit.new(options)
 
-        if options[:attachment]
-            s.send_attachment(options[:message])
-        elsif options[:block]
-            s.send_block(options[:message])
-        else
-            s.send_message(options[:message])
+        unless options[:validation_test]
+            if options[:attachment]
+                s.send_attachment(options[:message])
+            elsif options[:block]
+                s.send_block(options[:message])
+            else
+                s.send_message(options[:message])
+            end
         end
-    rescue ArgumentError => e
-        puts e
-        exit(1)
-    rescue RuntimeError => e
-        puts e
+    rescue Exception => e
+        e.to_s.error
         exit(1)
     end
+    exit(0)
 end
 
 # -------------------------------------------------------------------------------- #
@@ -70,6 +71,19 @@ def process_arguments
             options[:username] = username
         end
 
+        opts.separator ''
+        opts.separator 'Webhook Validation:'
+
+        opts.on('-v', '--validation-test', 'Run a webbook validation test') do
+            options[:validation_test] = true
+            options[:message] = 'This is a webhook validation test message'
+            options[:channel] = 'general'
+        end
+
+        opts.on('-V', '--validated-webhook', 'Flag the webhook as validated (skips constant validation)') do
+            options[:validated_webhook] = true
+        end
+
         opts.separator ''
         opts.separator 'Message type options:'
 

data/lib/slackit.rb

@@ -1,21 +1,52 @@
 # frozen_string_literal: true
 
 require 'slackit/version'
-require 'httparty'
-
+require 'net/http'
+require 'uri'
 require 'json'
+require 'cmessages'
 
 #
 # To follow
 #
 class Slackit
     def initialize(options = {})
-        @webhook_url  = options[:webhook_url]
-        @username     = options[:username]
-        @channel      = options[:channel]
-        @icon_emoji   = options[:icon_emoji]
+        @webhook_url       = options[:webhook_url]
+        @username          = options[:username]
+        @channel           = options[:channel]
+        @icon_emoji        = options[:icon_emoji]
+
+        @validation_test   = options[:validation_test]
+        @validated_webhook = options[:validated_webhook]
 
         raise ArgumentError.new('Webhook URL required') if @webhook_url.nil?
+
+        if @validation_test
+            if valid_webhook(@webhook_url)
+                @channel = 'general'
+                send_message('This is a validation message')
+                "#{@webhook_url} is a valid url".success
+            else
+                "#{@webhook_url} is NOT a valid url".error
+            end
+            return
+        end
+
+        raise ArgumentError.new("Invalid webhook URL: #{@webhook_url} - should start with https://hooks.slack.com/services/") unless @webhook_url.start_with?('https://hooks.slack.com/services/')
+
+        return if valid_webhook(@webhook_url)
+
+        raise ArgumentError.new("Invalid webhook URL: #{@webhook_url} - please check your configuration") unless valid_webhook(@webhook_url)
+    end
+
+    def valid_webhook(url)
+        uri = URI.parse(url)
+
+        r = Net::HTTP.get_response(uri)
+
+        return false if (r.code == '301') || (r.code == '302')
+
+        return true
     end
 
     #
@@ -72,12 +103,21 @@ class Slackit
         payload['channel'] ||= @channel
 
         begin
-            response = HTTParty.post(@webhook_url, body: payload.to_json, headers: headers)
+            uri = URI.parse(@webhook_url)
+            http = Net::HTTP.new(uri.host, uri.port)
+            http.use_ssl = true
+            request = Net::HTTP::Post.new(uri.request_uri, headers)
+            request.body = payload.to_json
+            response = http.request(request)
+
+            return true if response.code == '200'
+
+            raise "Invalid webhook URL: #{@webhook_url} - please check your configuration" if response.code == '301' || response.code == '302'
 
-            return true if response.code == 200
+            raise "Unknown error for webhook URL: #{@webhook_url}" if response.body.empty?
 
-            raise response
-        rescue HTTParty::Error, SocketError => e
+            raise response.body
+        rescue Exception => e
             raise e
         end
     end

data/lib/slackit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Slackit
-    VERSION = '1.1.10'
+    VERSION = '1.1.11'
 end

data/slackit.gemspec

@@ -22,11 +22,15 @@ Gem::Specification.new do |spec|
     spec.required_ruby_version = '>= 2.5'
 
     spec.add_development_dependency 'bundler', '~> 2'
-    spec.add_development_dependency 'httparty', '~> 0.16.2'
+    spec.add_development_dependency 'cmessages', '~> 1.0.0'
     spec.add_development_dependency 'json', '~> 2.3.0'
+#    spec.add_development_dependency 'net-http', '~> 0.1.0'
     spec.add_development_dependency 'rake', '~> 12.3.3'
     spec.add_development_dependency 'rspec', '~> 3.0'
+    spec.add_development_dependency 'uri', '~> 0.10.0'
 
-    spec.add_runtime_dependency 'httparty', '~> 0.16.2'
+    spec.add_runtime_dependency 'cmessages', '~> 1.0.0'
+#    spec.add_runtime_dependency 'net-http', '~> 0.1.0'
     spec.add_runtime_dependency 'json', '~> 2.3.0'
+    spec.add_runtime_dependency 'uri', '~> 0.10.0'
 end

data/spec/slackit_spec.rb

@@ -6,8 +6,4 @@ 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

data/testing/slackit

@@ -4,6 +4,7 @@ require 'bundler/setup'
 
 require 'optparse'
 require 'slackit'
+require 'cmessages'
 
 # -------------------------------------------------------------------------------- #
 # Send Mssage to Slack                                                             #
@@ -15,20 +16,20 @@ def send_message_to_slack(options)
     begin
         s = Slackit.new(options)
 
-        if options[:attachment]
-            s.send_attachment(options[:message])
-        elsif options[:block]
-            s.send_block(options[:message])
-        else
-            s.send_message(options[:message])
+        unless options[:validation_test]
+            if options[:attachment]
+                s.send_attachment(options[:message])
+            elsif options[:block]
+                s.send_block(options[:message])
+            else
+                s.send_message(options[:message])
+            end
         end
-    rescue ArgumentError => e
-        puts e
-        exit(1)
-    rescue RuntimeError => e
-        puts e
+    rescue Exception => e
+        e.to_s.error
         exit(1)
     end
+    exit(0)
 end
 
 # -------------------------------------------------------------------------------- #
@@ -72,6 +73,19 @@ def process_arguments
             options[:username] = username
         end
 
+        opts.separator ''
+        opts.separator 'Webhook Validation:'
+
+        opts.on('-v', '--validation-test', 'Run a webbook validation test') do
+            options[:validation_test] = true
+            options[:message] = 'This is a webhook validation test message'
+            options[:channel] = 'general'
+        end
+
+        opts.on('-V', '--validated-webhook', 'Flag the webhook as validated (skips constant validation)') do
+            options[:validated_webhook] = true
+        end
+
         opts.separator ''
         opts.separator 'Message type options:'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slackit
 version: !ruby/object:Gem::Version
-  version: 1.1.10
+  version: 1.1.11
 platform: ruby
 authors:
 - Tim Gurney aka Wolf
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-07-31 00:00:00.000000000 Z
+date: 2020-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,19 +25,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: cmessages
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -81,19 +81,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: uri
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 0.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: cmessages
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.2
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -108,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: uri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
 description: A simple gem for posting raw messages to a slack incoming webhook.
 email:
 - wolf@tgwolf.com