fde-slack-notification 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b075fa4ed98e1df95a32d2ccf2b69b688a809f6010ffeeb02045a610f97a4845
-  data.tar.gz: 380b9150c38755338e3a36b87c5ebf2444130c69c29e926fc5484c8391abdd6e
+  metadata.gz: a20eba73bb6a23557f8c50bf62e18db309acc10d3a2c614044410e58d21159cd
+  data.tar.gz: f69a8ff4a3e7dc9f1e77fec4fd1620465482f3b5f984651db8699c6ec20df2c9
 SHA512:
-  metadata.gz: 28ab900d7b7eb426ef8af17e71508ad1b1896262ace21247bbb9bc8eca4d72f3208f16f70cf80ce6158f53443c75c60678dfc84cb77ef5d1ed4b7bfe4d919a0f
-  data.tar.gz: 30aac486d6a6448dee049a93799ad5f433a3a99714daee2f5e5dd69f1be97713d1285dabde23f7da38742365843abc7853269d541687d4dd11e583c52cc0a82e
+  metadata.gz: 2a349ab08a8f708b3931a7fb3989783ded0ec850e0c5f82cf8162e157ea035cdc3e70994ac4b8374e980d51c0dc341ddadb4a685ea9deef9c376a4f44959fd72
+  data.tar.gz: 87e1206d0651f531c8d7447a1672dec6b7aa50ce5f3e8f40ec8b57db69ad0ea4af19b5fda592fa070d3a5dd7bc30388835db6c0201d9a9c55d6b7e13080ba5c4

data/README.md

@@ -3,3 +3,87 @@
 [![Code Climate](https://codeclimate.com/github/fashion-data-exchange/slack-notification/badges/gpa.svg)](https://codeclimate.com/github/fashion-data-exchange/slack-notification)
 
 # Slack::Notification
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'fde-slack-notification'
+```
+And then execute:
+
+```bash
+bundle install
+```
+
+### Authorization
+
+The client requires the following environment variables to be set:
+
+```bash
+SLACK_FD_WEBHOOK_URL =  'https://hooks.slack.com' //Your slack hook here
+```
+
+### Usage
+
+In order to send a notification to slack, you can write a method like the following.
+
+```ruby
+  def notifier
+    message = FDE::Slack::Message.new(
+      'your message title',
+      fields,
+      {
+        title_link:
+          {
+            title: 'title',
+            title_link: 'title',
+            thumb_url: 'author_icon'
+          },
+        footer: FDE::Slack::Footer.new('footer_text).to_h
+      }
+    )
+
+    message.info(channel)
+  end
+  
+  
+  # create a hash for your required fields
+    def fields
+      [
+        {
+          title: 'Field 1',
+          value: 'value 1',
+          short: false
+        },
+        {
+          title: 'Field 2',
+          value: 'value 2',
+          short: false
+        },  
+      ]
+    end
+
+```
+
+### Configuration
+
+To set the hook_url value, you may have an initializer under `config/initializers` like this
+
+```ruby
+require "slack/notification"
+
+FDE::Slack::Notification.configure do |config|
+  config.webhook = 'hook_url'
+end
+```
+
+
+### Styling
+
+Any of these methods can be used to get the following colored sidebars
+
+1. message.info(channel) # BLUE
+2. message.success(channel) # GREEN
+3. message.error(channel) # RED
+4. message.warning(channel) # YELLOW

data/fde-slack-notification.gemspec

@@ -30,17 +30,17 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency "slack-notifier", "~> 1.5", ">= 1.5.1"
+  spec.add_runtime_dependency "slack-notifier", "~> 2.0"
   spec.add_runtime_dependency "dotenv", "~> 2.2", ">= 2.2.1"
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 2"
   spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "rdoc", "~> 5.1", ">= 5.1"
+  spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "rdoc", "~> 5"
   spec.add_development_dependency "vcr", "~> 3.0.3", ">= 3.0.3"
   spec.add_development_dependency 'webmock', '~> 3.0', '>= 3.0.1'
 
-  spec.add_development_dependency "pry", "~> 0.10"
-  spec.add_development_dependency "pry-remote", "~> 0.1"
-  spec.add_development_dependency "pry-nav", "~> 0.2"
+  spec.add_development_dependency "pry", "~> 0"
+  spec.add_development_dependency "pry-remote", "~> 0"
+  spec.add_development_dependency "pry-nav", "~> 0"
 end

data/lib/slack/message.rb

@@ -72,7 +72,7 @@ module FDE
         )
         begin 
           notifier.ping message_hash
-        rescue Slack::Notifier::APIError
+        rescue ::Slack::Notifier::APIError
           raise FDE::Slack::Message::Error
         end
       end

data/lib/slack/notification/version.rb

@@ -1,7 +1,7 @@
 module FDE
   module Slack
     module Notification
-      VERSION = "1.1.1"
+      VERSION = "1.2.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fde-slack-notification
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Felix Langenegger
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-19 00:00:00.000000000 Z
+date: 2020-02-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: slack-notifier
@@ -16,20 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.5.1
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: dotenv
   requirement: !ruby/object:Gem::Requirement
@@ -56,14 +50,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -84,34 +78,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.1'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -158,42 +146,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-remote
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: pry-nav
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0'
 description: A simple slack client to send messages into a slack channel
 email:
 - f.langenegger@fadendaten.ch