slackit 1.1.8 → 1.1.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 431900d8de1de483c5ec286d153377213b806327b7d8ea7daf2d65c5d9235af0
-  data.tar.gz: 7801ca3203c61714e556dc04d2629067aec4a9e5f35b0dd1fdf20d3b12c3f156
+  metadata.gz: 19c0142dd96bef5b8b87d09a03e5af539bb14a7bb68f17bab9fbebae61c85879
+  data.tar.gz: af810fb2581d78251284ececd1d924fde680e5b4b8b2db5d5566f5088bed9391
 SHA512:
-  metadata.gz: 9be48b4479323a084105142673bc3b25b42f1a7cc4c85d487494b191ce799f85d9c359e0b547e3b180a5e33cc13bd39595514b508071e9e93ebb69a4ecad54ad
-  data.tar.gz: 854761154513ede83f81596d4c9409c9decd9fbb46291ae7b4e310119a7119dad257ef70520a329124eebeb60a7665d5a2ebc29e4e6ce8248ab31659dcef9227
+  metadata.gz: db62100414a06794a0560cd9c0702fa9f678eb76efaa28d5aed92c7da350fd8524973d5692aedd0e7c966bf78b6c28e6d975f021a1903b695796b77ce105237e
+  data.tar.gz: e471c2e16512f33b7bde41ca5ac5580df4b88551a9694899c961ca2a0df6fd7dd32b9ea0ed0e6894fce72e4665763cea577470844d15e6d96c2a61598cb30624

data/.rubocop.yml

@@ -1,3 +1,6 @@
+AllCops:
+  TargetRubyVersion: 2.5
+
 Layout/CaseIndentation:
     Enabled: false
 

data/.travis.yml

@@ -49,7 +49,7 @@ matrix:
     name: "Link Checker (rvm 2.7)"
     rvm: 2.7
     env:
-    - https://img.shields.io"
+    - WHITELIST="https://img.shields.io"
     - EXCLUDE_FILES="CHANGELOG.md"
     before_install:
       - mkdir travis

data/CHANGELOG.md

@@ -5,9 +5,35 @@ 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)
 
-### [Unreleased](https://github.com/AntiPhotonltd/slackit/compare/v1.1.7...HEAD)
+### [v1.1.10](https://github.com/AntiPhotonltd/slackit/compare/v1.1.9...v1.1.10)
 
-- Fix gemfile ruby version [`[2773bc5]`](https://github.com/AntiPhotonltd/slackit/commit/2773bc55744ad3c6bb50cd461b50406450789d52) [`[TGWolf]`](https://github.com/TGWolf)
+> Released on July, 31st 2020
+
+- Bump version ready for release [`[bf92ada]`](https://github.com/AntiPhotonltd/slackit/commit/bf92ada1d36007e652165546160dc91359a6e833) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Update readme to new verrsion [`[a9263c0]`](https://github.com/AntiPhotonltd/slackit/commit/a9263c04d5405ee46116c0ee4a5a1dbd46e25102) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Update the version of json due to github security alert [`[fa0e80a]`](https://github.com/AntiPhotonltd/slackit/commit/fa0e80a2a5cf21b2e25e534ab0dc67e3805abe0a) [`[TGWolf]`](https://github.com/TGWolf)
+
+- Fix all of the rubocop errors [`[8897f54]`](https://github.com/AntiPhotonltd/slackit/commit/8897f54ec15160461898b206581522bf9d6c77aa) [`[TGWolf]`](https://github.com/TGWolf)
+
+- 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)
+
+> Released on March, 9th 2020
+
+- Fix some new rubocop warnings/errors [`[cc6365d]`](https://github.com/AntiPhotonltd/slackit/commit/cc6365dc5464f9791219499025a0cce110ab2114) [`[TGWolf]`](https://github.com/TGWolf)
+
+- 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)
+
+> Released on March, 9th 2020
+
+- spec.required_ruby_version [`[519c7cb]`](https://github.com/AntiPhotonltd/slackit/commit/519c7cb481c538a46782e16fd17a83fb41a6e467) [`[TGWolf]`](https://github.com/TGWolf)
+
+- 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)
 

data/Gemfile

@@ -1,5 +1,5 @@
 source 'https://rubygems.org'
-ruby ">= 2.5.0"
+ruby '>= 2.5.0'
 
 git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 

data/README.md

@@ -1,18 +1,63 @@
-[![Build Status](https://img.shields.io/travis/AntiPhotonltd/slackit/master?style=for-the-badge&logo=travis)](https://travis-ci.org/AntiPhotonltd/slackit)
-[![Software License](https://img.shields.io/badge/license-MIT-blueviolet?style=for-the-badge)](LICENSE.md)
-[![Release](https://img.shields.io/github/release/AntiPhotonltd/slackit?color=blueviolet&style=for-the-badge&logo=github&label=Latest%20Release)](https://github.com/AntiPhotonltd/slackit/releases/latest)
-[![Last Release](https://img.shields.io/github/release-date/AntiPhotonltd/slackit?color=blueviolet&style=for-the-badge&logo=github)](https://github.com/AntiPhotonltd/slackit/releases/latest)
-[![Github commits (since latest release)](https://img.shields.io/github/commits-since/AntiPhotonltd/slackit/latest?color=blueviolet&style=for-the-badge&logo=github)](https://github.com/AntiPhotonltd/slackit/commits)
-[![Last Commit](https://img.shields.io/github/last-commit/AntiPhotonltd/slackit?color=blueviolet&style=for-the-badge&logo=github)](https://github.com/AntiPhotonltd/slackit/commits/master)
-[![Code Size](https://img.shields.io/github/languages/code-size/AntiPhotonltd/slackit?color=blueviolet&style=for-the-badge&logo=github)](#)
-[![Repo Size](https://img.shields.io/github/repo-size/AntiPhotonltd/slackit?color=blueviolet&style=for-the-badge&logo=github)](#)
-[![Contributors](https://img.shields.io/github/contributors/AntiPhotonltd/slackit?color=blueviolet&style=for-the-badge&logo=github)](https://github.com/AntiPhotonltd/slackit/graphs/contributors)
-[![Wolf](https://img.shields.io/badge/Created%20By-AntiPhoton%20Ltd.-blueviolet?style=for-the-badge)](https://github.com/AntiPhotonltd)
-
-# Slackit
+<h1 align="center">
+    <a href="#"><img src="https://github.com/AntiPhotonltd/branding/blob/master/images/company%20logo/banners/banner-1400-215.png?raw=true" alt="" width="600"></a>
+    <br>
+    Slackit
+    <br>
+</h1>
+
+<h4 align="center">Slackit is a very simply Ruby Gem for posting to a slack incoming webhook.</h4>
+
+<p align="center">
+  <a href="https://travis-ci.org/AntiPhotonltd/slackit">
+    <img src="https://img.shields.io/travis/AntiPhotonltd/slackit/master?style=for-the-badge&logo=travis"
+         alt="Build Status">
+  </a>
+  <a href="https://github.com/AntiPhotonltd/slackit/releases/latest">
+    <img src="https://img.shields.io/github/release/AntiPhotonltd/slackit?color=blueviolet&style=for-the-badge&logo=github&label=Version"
+         alt="Release">
+  </a>
+  <a href="https://github.com/AntiPhotonltd/slackit/releases/latest">
+    <img src="https://img.shields.io/github/release-date/AntiPhotonltd/slackit?color=blueviolet&logo=github&style=for-the-badge"
+         alt="Latest Release">
+  </a>
+  <br/>
+  <a href="https://github.com/AntiPhotonltd/slackit/commits">
+    <img src="https://img.shields.io/github/commits-since/AntiPhotonltd/slackit/latest?color=blueviolet&style=for-the-badge&logo=github"
+         alt="Github commits (since latest release)">
+  </a>
+  <a href="https://github.com/AntiPhotonltd/slackit/commits/master">
+    <img src="https://img.shields.io/github/last-commit/AntiPhotonltd/slackit?color=blueviolet&style=for-the-badge&logo=github"
+         alt="Last Commit">
+  </a>
+  <br />
+    <a href="LICENSE.md">
+    <img src="https://img.shields.io/badge/license-MIT-blueviolet?style=for-the-badge"
+         alt="Software License">
+  </a>
+  <a href="https://github.com/AntiPhotonltd/branding/issues">
+    <img src="https://img.shields.io/github/issues/AntiPhotonltd/branding?logo=github&color=blueviolet&style=for-the-badge"
+         alt="Open an Issue">
+  </a>
+  <a href="https://github.com/AntiPhotonltd/branding/issues?q=is%3Aissue+is%3Aclosed)">
+    <img src="https://img.shields.io/github/issues-closed/AntiPhotonltd/branding?logo=github&color=blueviolet&style=for-the-badge"
+         alt="Open an Issue">
+  </a>
+  <a href="https://github.com/AntiPhotonltd">
+    <img src="https://img.shields.io/badge/Created%20By-AntiPhoton-blueviolet?style=for-the-badge" alt="AntiPhoton Limited">
+  </a>
+</p>
+<hr>
+
+<h1>Slackit <img align="right" src="https://img.shields.io/badge/made%20with-ruby-blueviolet?logo=gnu-bash&logoColor=white&style=for-the-badge" /></h1>
+
 
 Slackit is a very simply Ruby Gem for posting to a slack incoming webhook.
 
+It is now possible to send attachments and blocks however slackit doesn't take responsibility for creating those only for sending them. For more information on how to use those please refer to the Slack API documentation.
+
+* [Attachments](https://api.slack.com/reference/messaging/attachments)
+* [Blocks](https://api.slack.com/block-kit/building)
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -35,13 +80,15 @@ Or install it yourself as:
 require "slackit"
 ```
 
-Initialize client:
+### Initialize client
+
+#### Initialize with minimal options
 
 ```ruby
 client = Slackit.new(webhook_url: "slack webhook url")
 ```
 
-Initialize with options:
+#### Initialize with all options
 
 ```ruby
 client = SlackNotify::Client.new(
@@ -52,22 +99,49 @@ client = SlackNotify::Client.new(
 )
 ```
 
-Initialize via shorthand method:
+#### Initialize via shorthand method
 
 ```Ruby
 client = Slackit.new(options)
 ```
 
+### Sending Messages
+
+#### Simple messages
+
+```Ruby
+client.send_message("This is a test message")
+```
+
+#### Attachments
+
+```Ruby
+client.send_attachment(attachment_json)
+```
+> NOTE: We will test to make sure the json is valid and catch errors thrown by the API for invalid formatting, missing values etc. General error from the api is `missing_text_or_fallback_or_attachments`
+
+#### Blocks
+
+```Ruby
+client.send_block(block_json)
+```
+
+> NOTE: We will test to make sure the json is valid and catch errors thrown by the API for invalid formatting, missing values etc. General error from the api is `invalid_blocks_format`
+
 ### Command Line Usage
 
 ```
 Usage: slackit
     -h, --help                       Display this screen
     -c, --channel string             The channel to send the message to
-    -i, --icon-emoji string          The emoji to use as the channel icon [default: :wolf:]
+    -i, --icon-emoji string          The emoji to use for the channel icon [default: :wolf:]
     -m, --message string             The message to send
     -w, --webhook-url string         The slack incoming webhook url to use
     -u, --username string            The username to send as [default: slackit]
+
+Message type options:
+    -a, --attachment                 Treat the message as an attachment
+    -b, --block                      Treat the message as a block
 ```
 
 ### Pipe message

data/VERSION.txt

@@ -1 +1 @@
-1.1.8
+1.1.10

data/exe/slackit

@@ -12,9 +12,19 @@ require 'slackit'
 def send_message_to_slack(options)
     begin
         s = Slackit.new(options)
-        s.send(options[:message])
-    rescue ArgumentError
-        puts 'You must specify a webhook_url'
+
+        if options[:attachment]
+            s.send_attachment(options[:message])
+        elsif options[:block]
+            s.send_block(options[:message])
+        else
+            s.send_message(options[:message])
+        end
+    rescue ArgumentError => e
+        puts e
+        exit(1)
+    rescue RuntimeError => e
+        puts e
         exit(1)
     end
 end
@@ -29,7 +39,7 @@ end
 # -------------------------------------------------------------------------------- #
 
 def process_arguments
-    options = {}
+    options = { :username => 'slackit', :attachment => false, :block => false }
     # Enforce the presence of
     mandatory = %I[webhook_url message]
 
@@ -59,6 +69,17 @@ def process_arguments
         opts.on('-u', '--username string', 'The username to send as [default: slackit]') do |username|
             options[:username] = username
         end
+
+        opts.separator ''
+        opts.separator 'Message type options:'
+
+        opts.on('-a', '--attachment', 'Treat the message as an attachment') do
+            options[:attachment] = true
+        end
+
+        opts.on('-b', '--block', 'Treat the message as a block') do
+            options[:block] = true
+        end
     end
 
     begin
@@ -72,6 +93,11 @@ def process_arguments
         exit
     end
 
+    if options[:attachment] && options[:block]
+        puts 'Error: You cannot use -a and -b at the same time! - aborting'
+        exit
+    end
+
     exit 0 if send_message_to_slack(options)
 
     exit 1

data/lib/slackit.rb

@@ -3,6 +3,8 @@
 require 'slackit/version'
 require 'httparty'
 
+require 'json'
+
 #
 # To follow
 #
@@ -16,27 +18,67 @@ class Slackit
         raise ArgumentError.new('Webhook URL required') if @webhook_url.nil?
     end
 
-    # sends a notification
-    # returns true after a successfull pust
+    #
+    # Raw message
+    #
+    def send_message(text)
+        text = text.gsub('\\n', "\n") # ensure newlines are not escaped
+
+        payload = { 'text' => text }
+
+        return send_payload(payload)
+    end
+
+    #
+    # Add an alias for backwards compatibility
+    #
     def send(text)
-        # send as json
-        headers = { 'Content-Type' => 'application/json' }
+        return send_message(text)
+    end
 
-        # payload
-        text = text.gsub('\\n', "\n") # ensure newlines are not escaped
-        body = { 'text' => text, 'icon_emoji' => @icon_emoji, 'username' => @username }
+    #
+    # Legacy attachments
+    #
+    def send_attachment(attachment)
+        payload = { 'attachments' => [ convert_to_json(attachment) ] }
+        return send_payload(payload)
+    end
+
+    #
+    # New shiney blocks
+    #
+    def send_block(block)
+        payload = convert_to_json(block)
+        return send_payload(payload)
+    end
+
+    #
+    # Convery the string to json
+    #
+    def convert_to_json(json_string)
+        begin
+            return JSON.parse(json_string)
+        rescue JSON::ParserError
+            raise ArgumentError.new('Invalid json')
+        end
+    end
+
+    def send_payload(payload)
+        headers = { 'Content-Type' => 'application/json' }
 
-        # add the channel if there is one
-        body['channel'] ||= @channel
+        # Add the additional payload items
+        payload['icon_emoji'] ||= @icon_emoji
+        payload['username'] ||= @username
+        payload['channel'] ||= @channel
 
         begin
-            response = HTTParty.post(@webhook_url, body: body.to_json, headers: headers)
+            response = HTTParty.post(@webhook_url, body: payload.to_json, headers: headers)
 
             return true if response.code == 200
 
-            return false
-        rescue HTTParty::Error, SocketError => _e
-            return false
+            raise response
+        rescue HTTParty::Error, SocketError => e
+            raise e
         end
     end
 end

data/lib/slackit/version.rb

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

data/slackit.gemspec

@@ -23,8 +23,10 @@ Gem::Specification.new do |spec|
 
     spec.add_development_dependency 'bundler', '~> 2'
     spec.add_development_dependency 'httparty', '~> 0.16.2'
+    spec.add_development_dependency 'json', '~> 2.3.0'
     spec.add_development_dependency 'rake', '~> 12.3.3'
     spec.add_development_dependency 'rspec', '~> 3.0'
 
     spec.add_runtime_dependency 'httparty', '~> 0.16.2'
+    spec.add_runtime_dependency 'json', '~> 2.3.0'
 end

data/testing/slackit

@@ -0,0 +1,124 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+
+require 'optparse'
+require 'slackit'
+
+# -------------------------------------------------------------------------------- #
+# Send Mssage to Slack                                                             #
+# -------------------------------------------------------------------------------- #
+# This function will take the input arguments and then send the message.           #
+# -------------------------------------------------------------------------------- #
+
+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])
+        end
+    rescue ArgumentError => e
+        puts e
+        exit(1)
+    rescue RuntimeError => e
+        puts e
+        exit(1)
+    end
+end
+
+# -------------------------------------------------------------------------------- #
+# Process Arguments                                                                #
+# -------------------------------------------------------------------------------- #
+# This function will process the input from the command line and work out what it  #
+# is that the user wants to see.                                                   #
+#                                                                                  #
+# This is the main processing function where all the processing logic is handled.  #
+# -------------------------------------------------------------------------------- #
+
+def process_arguments
+    options = { :username => 'slackit', :attachment => false, :block => false }
+    # Enforce the presence of
+    mandatory = %I[webhook_url message]
+
+    optparse = OptionParser.new do |opts|
+        opts.banner = "Usage: #{$PROGRAM_NAME}"
+
+        opts.on('-h', '--help', 'Display this screen') do
+            puts opts
+            exit(1)
+        end
+        opts.on('-c', '--channel string', 'The channel to send the message to') do |channel|
+            options[:channel] = channel
+        end
+
+        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-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|
+            options[:username] = username
+        end
+
+        opts.separator ''
+        opts.separator 'Message type options:'
+
+        opts.on('-a', '--attachment', 'Treat the message as an attachment') do
+            options[:attachment] = true
+        end
+
+        opts.on('-b', '--block', 'Treat the message as a block') do
+            options[:block] = true
+        end
+    end
+
+    begin
+        optparse.parse!
+        options[:message] = ARGF.read unless STDIN.tty? # override message parameter if data is piped in
+        missing = mandatory.select { |param| options[param].nil? }
+        raise OptionParser::MissingArgument.new(missing.join(', ')) unless missing.empty?
+    rescue OptionParser::InvalidOption, OptionParser::MissingArgument => e
+        puts e.to_s
+        puts optparse
+        exit
+    end
+
+    if options[:attachment] && options[:block]
+        puts 'Error: You cannot use -a and -b at the same time! - aborting'
+        exit
+    end
+
+    exit 0 if send_message_to_slack(options)
+
+    exit 1
+end
+
+# -------------------------------------------------------------------------------- #
+# Main()                                                                           #
+# -------------------------------------------------------------------------------- #
+# The main function where all of the heavy lifting and script config is done.      #
+# -------------------------------------------------------------------------------- #
+
+def main
+    process_arguments
+end
+
+main
+
+# -------------------------------------------------------------------------------- #
+# End of Script                                                                    #
+# -------------------------------------------------------------------------------- #
+# This is the end - nothing more to see here.                                      #
+# -------------------------------------------------------------------------------- #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slackit
 version: !ruby/object:Gem::Version
-  version: 1.1.8
+  version: 1.1.10
 platform: ruby
 authors:
 - Tim Gurney aka Wolf
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-03-09 00:00:00.000000000 Z
+date: 2020-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.16.2
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
 description: A simple gem for posting raw messages to a slack incoming webhook.
 email:
 - wolf@tgwolf.com
@@ -109,11 +137,12 @@ files:
 - slackit.gemspec
 - spec/slackit_spec.rb
 - spec/spec_helper.rb
+- testing/slackit
 homepage: https://github.com/AntiPhotonltd/slackit
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -128,8 +157,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A simple gem for posting to a slack incoming webhook.
 test_files: []