noch 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b54210e4e2f225f0932fba93629675c8a41750e4acb4eb310bac762903121f32
+  data.tar.gz: 45aac03c31bf11d7809ba716cf3e5f7aaf87ba9e57c3e272eb663cbd8c87952b
+SHA512:
+  metadata.gz: 415fb99e352a6b0bb6358b0dbffe83adbe3fa8303672ee16e27003dca7d04edfeca63021ddd8443312b968f724d51e53140e6f3100683b1c689ede4e28873fcc
+  data.tar.gz: a92daf2edc25e3ce26f72ede45875beca949c66bd76d5ae949e9d8089c61a6b698c98765cbd04c618ee45bb1dad5010cc2ab8eb1197b45ef334057df8ca4f610

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.byebug_history

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in NOCH.gemspec
+gemspec
+
+group :test do
+  gem 'cucumber'
+  gem 'http'
+  gem 'mock_redis'
+end

data/Gemfile.lock

@@ -0,0 +1,131 @@
+PATH
+  remote: .
+  specs:
+    noch (0.1.0)
+      redis
+      slack-ruby-client
+      telegram-bot
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (5.2.3)
+      actionview (= 5.2.3)
+      activesupport (= 5.2.3)
+      rack (~> 2.0)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.2)
+    actionview (5.2.3)
+      activesupport (= 5.2.3)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.0.3)
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    backports (3.15.0)
+    builder (3.2.3)
+    concurrent-ruby (1.1.5)
+    crass (1.0.4)
+    cucumber (3.1.2)
+      builder (>= 2.1.2)
+      cucumber-core (~> 3.2.0)
+      cucumber-expressions (~> 6.0.1)
+      cucumber-wire (~> 0.0.1)
+      diff-lcs (~> 1.3)
+      gherkin (~> 5.1.0)
+      multi_json (>= 1.7.5, < 2.0)
+      multi_test (>= 0.1.2)
+    cucumber-core (3.2.1)
+      backports (>= 3.8.0)
+      cucumber-tag_expressions (~> 1.1.0)
+      gherkin (~> 5.0)
+    cucumber-expressions (6.0.1)
+    cucumber-tag_expressions (1.1.1)
+    cucumber-wire (0.0.1)
+    diff-lcs (1.3)
+    domain_name (0.5.20190701)
+      unf (>= 0.0.5, < 1.0.0)
+    erubi (1.8.0)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday_middleware (0.13.1)
+      faraday (>= 0.7.4, < 1.0)
+    gherkin (5.1.0)
+    gli (2.18.1)
+    hashie (3.6.0)
+    http (4.1.1)
+      addressable (~> 2.3)
+      http-cookie (~> 1.0)
+      http-form_data (~> 2.0)
+      http_parser.rb (~> 0.6.0)
+    http-cookie (1.0.3)
+      domain_name (~> 0.5)
+    http-form_data (2.1.1)
+    http_parser.rb (0.6.0)
+    httpclient (2.8.3)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.2.3)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mini_portile2 (2.4.0)
+    minitest (5.11.3)
+    mock_redis (0.21.0)
+    multi_json (1.13.1)
+    multi_test (0.1.2)
+    multipart-post (2.1.1)
+    nokogiri (1.10.3)
+      mini_portile2 (~> 2.4.0)
+    public_suffix (3.1.1)
+    rack (2.0.7)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.0.4)
+      loofah (~> 2.2, >= 2.2.2)
+    rake (10.5.0)
+    redis (4.1.2)
+    slack-ruby-client (0.14.2)
+      activesupport
+      faraday (>= 0.9)
+      faraday_middleware
+      gli
+      hashie
+      websocket-driver
+    telegram-bot (0.14.2)
+      actionpack (>= 4.0, < 6.0)
+      activesupport (>= 4.0, < 6.0)
+      httpclient (~> 2.7)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.6)
+    websocket-driver (0.7.1)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  cucumber
+  http
+  minitest (~> 5.0)
+  mock_redis
+  noch!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   2.0.1

data/README.md

@@ -0,0 +1,79 @@
+# NOCH
+
+NOCH stands for Notify On CHange.
+Suppose you have a job running scheduled to check something. Every execution will have a result and you'll want to notify when something go wrong.
+Ok, if several times the result is the same...Do you want to notify every time the job run for the same result?
+If you do not, NOCH can help you with this kind of situations.
+NOCH will notify when status change its value by using three simple methods
+
+`ok!`
+
+`warning!`
+
+`critical!`
+
+`skip!`
+
+Notifications are sent to Slack channel and or Telegram group
+
+
+
+
+## Requirements
+
+This uses [Redis](https://redis.io/) to save states. If your Redis runs out of the job run, you have to pass `REDIS_HOST` and `REDIS_PORT`
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'noch'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install noch
+
+## Usage
+
+Create a file with a name you want.
+
+```
+# my_alert_script.rb
+
+# SLACK 00000000000000000
+# TELEGRAM 111111111111
+
+include NOCH
+
+if everything_is_ok?
+  ok! "We are rocking!"
+else
+  critical! message: 'mmlpqtp', data: {foo: 'bar'}
+end
+
+```
+
+Run it!
+
+TELEGRAM_TOKEN=<your_telegram_bot_token> TELEGRAM_USER=<your-telegram-user> SLACK_API_TOKEN=<your_slack_api_token> REDIS_HOST=<your-redis-host> REDIS_PORT=<your-redis-port> ruby my_alert_script.rb
+
+## Test
+
+Just run `rake test` to run the tests and ensure all pass.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/romanrod/noch.
+
+
+## TODO
+
+I want to add Telegram for notification messages

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+task :default => :test
+
+task :test do
+  system 'cucumber'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "NOCH"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/NOCH/version.rb

@@ -0,0 +1,3 @@
+module NOCH
+  VERSION = "0.1.0"
+end

data/lib/noch.rb

@@ -0,0 +1,263 @@
+require "NOCH/version"
+require 'slack-ruby-client'
+require 'redis'
+require 'telegram/bot'
+
+module NOCH
+  
+  class Error < StandardError; end
+
+  class << self
+    # Sets default status. Used the first time execution with passed status
+    # @param [String] to: the status to be saved
+    # @return [Hash]
+    def default to, data = nil
+      {
+        "status" => to,
+        "data" => data
+      }
+    end
+    
+    def included(base)
+      @@alert_file = caller.select{|l| l.include? "`include'"}.first.split(".").first
+      @@alert_name = @@alert_file.split('/').last.split('_').map{|w| w.capitalize}.join(" ")
+      @@redis_host = ENV['REDIS_HOST'] || 'localhost'
+      @@redis_port = ENV['REDIS_PORT'] || '6379'
+      @@redis ||= ::Redis.new(host: @@redis_host, port: @@redis_port)
+      @@slack_client = if ENV['SLACK_API_TOKEN']
+        ::Slack.configure do |config|
+          config.token = ENV['SLACK_API_TOKEN']
+        end
+        ::Slack::Web::Client.new
+      end
+      @@telegram_client = if ENV['TELEGRAM_TOKEN'] and ENV['TELEGRAM_USER']
+        ::Telegram::Bot::Client.new(ENV['TELEGRAM_TOKEN'], ENV['TELEGRAM_USER'])
+      end
+    end
+
+    # Returns the name of the alert
+    def alert_name
+      @@alert_name
+    end
+
+    # Returns the current status if the passed status is differente. If there is no current status save passed status with default data
+    # @param [String] to: the status to be evaluated
+    # @return [String] status: if passed value is different
+    # @return [Hash] Data: data to be saved
+    def changed to, data
+      if (current = self.get_status)
+        current_status = ::JSON.parse(current)['status']
+        return current_status if current_status != to
+        to
+      else
+        NOCH.create_object(to, data)
+      end
+    end
+
+    # Returns the current status of the alert
+    # @return [Hash] {"status"=>"ok", "last_change"=>"2019-07-17T22:51:03.081-03:00", "message"=>nil, "data"=>nil}
+    def get_status
+      @@redis.get(@@alert_name)
+    end
+
+    # Sends notification if status change. If not returns nil
+    # @param [String] what: current status
+    # @param [optional] opts: The arguments. Could be String for only message text or a Hash to pass :message and :data
+    # @return [Boolean] true if notification is sent, false if nothing changed
+    # def evaluate_for what, message = nil, data = nil
+    def evaluate_for what, opts = nil
+      if opts.is_a? Hash
+        message = opts.delete(:message)
+        data = opts.delete(:data)
+      else
+        message = opts
+      end
+      raise "Unknown status #{what}. Allowed: ['ok','warning','critical','skip']" unless ['ok','warning','critical','skip'].include? what
+      from = self.changed(what, data)
+      !!(if (from != what)
+          self.set what, message, data
+          self.notify(from, what, message, data) unless what == 'skip'
+      end)
+    end
+
+    # Saves into Redis the alert with `to` as initial status
+    # @param [String] to: the value of the status to be saved
+    # @param [Hash] data: the data to be saved
+    def create_object(to, data)
+      return to if @@redis.set(@@alert_name, self.default(to, data).to_json) == "OK"
+      raise StandardError.new("Status `#{to}` could not be saved")
+    end
+
+    # Saves status, message and data into Redis
+    # @param [String] to: status to save. It could be ['ok','warning','skip','critical']
+    # @param [String] message (optional): The message to be sent on notification
+    # @param [Hash] data(optional): data to be saved for future evaluation if needed
+    def set to, message = nil, data = nil
+      data = {
+        'status' => to,
+        'last_change' => Time.now,
+        'message' => message,
+        'data' => data
+      }
+      @@redis.set @@alert_name, data.to_json
+    end
+
+    # Prints out notification information and sends it
+    # @param [String] from: the previous status
+    # @param [Strig] to: the current status
+    # @param [Hash] data (optional): the data to be saved
+    # @return [Boolean] true if notification sent. false if not
+    def notify from, to, message, data = nil
+      string = "Alert: #{@@alert_name}
+
+[ #{from} ] => [ #{to} ]
+      
+#{message}
+      
+      "
+      string += "
+      
+      Data: 
+      #{data}
+      " if data
+      print string
+      self.send_slack(string)
+      self.send_telegram(string)
+    end
+
+    # Sends message notification through Slack to the given slack channel
+    # @param [String] message: the message string to be sent
+    # @return [Boolean] true if notification sent. false if not
+    def send_slack message = nil
+      channel = self.slack
+      if channel and !!@@slack_client
+        @@slack_client.auth_test
+        if message
+          begin
+            puts "Enviando: #{message}
+            to: #{channel}"
+            @@slack_client.chat_postMessage(channel: channel, text: message, as_user: true)
+            true
+          rescue
+            puts "Error sending message to slack channel #{channel}"
+            false
+          end
+        end
+      end
+    end
+
+    # Returns value for slack token
+    def slack
+      self.matched_line("SLACK")&.strip
+    end
+
+    # Sends message notification through Slack to the given slack channel
+    # @param [String] message: the message string to be sent
+    # @return [Boolean] true if notification sent. false if not
+    def send_telegram message = nil
+      chat_id = self.telegram
+      if chat_id and !!@@telegram_client
+        if message
+          begin
+            puts "Enviando: #{message}
+            to: #{chat_id}"
+            @@telegram_client.send_message(chat_id: chat_id, text: message)
+            true
+          rescue
+            puts "Error sending message to telegram group #{group_id}"
+            false
+          end
+        end
+      end
+    end
+
+    # Returns value for telegram group id
+    def telegram
+      self.matched_line("TELEGRAM")&.strip
+    end  
+
+    # To get config token and/or values, e.g for slack, returns values from line containing arg
+    # @return [String] value for line staring with `# <something> `
+    # @param [String] what = configuration name. E.g. 
+    #
+    #   # SLACK 1234567890987654321
+    #
+    # will return 1234567890987654321 when param what is SLACK
+    #
+    def matched_line what
+      line = self.content.select do |line|
+        line.start_with? "# #{what} "
+      end.first
+      line.split("# #{what.upcase} ").last if line
+    end
+
+    def content
+      @@content ||= IO.read(@@alert_file + ".rb").split("\n")
+    end
+  end
+
+  # Alert methods
+  
+  # use to set status to ok
+  # @param [Hash] opts 
+  #
+  # :message
+  # :data
+  #
+  def ok! opts = nil
+    NOCH.evaluate_for "ok", opts
+  end
+
+  # use to set status to warning
+  # @param [Hash] opts 
+  #
+  # :message
+  # :data
+  #
+  def warning! opts = nil
+    NOCH.evaluate_for "warning", opts
+  end
+
+  # use to set status to critical
+  # @param [Hash] opts 
+  #
+  # :message
+  # :data
+  #
+  def critical! opts = nil
+    NOCH.evaluate_for "critical", opts
+  end
+
+  # @param [Hash] opts 
+  #
+  # :message
+  # :data
+  #
+  def skip! opts = nil
+    NOCH.evaluate_for "skip", opts
+  end
+
+  # Returns the current status. Useful when you save aditional data into status
+  # @return [Hash] {"status"=>"ok", "last_change"=>"2019-07-17T22:51:03.081-03:00", "message"=>nil, "data"=>nil}
+  def get_current
+    JSON.parse(NOCH.get_status)
+  end
+
+  # Returns the last data saved
+  # @return [String] last data saved
+  def last_data
+    get_current['data']
+  end
+
+  def alert_name
+    @@alert_name
+  end
+
+  def inspect
+    {
+      "version" => VERSION,
+      "alert_name" => @@alert_name
+    }
+  end
+
+end

data/noch.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "NOCH/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "noch"
+  spec.version       = NOCH::VERSION
+  spec.authors       = ["Roman"]
+  spec.email         = ["roman.g.rodriguez@gmail.com"]
+
+  spec.summary       = %q{Alerts on status change}
+  spec.description   = %q{Notify alerts when status change}
+  spec.homepage      = "https://github.com/romanrod/noch"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_dependency "redis"
+  spec.add_dependency "slack-ruby-client"
+  spec.add_dependency "telegram-bot"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,136 @@
+--- !ruby/object:Gem::Specification
+name: noch
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Roman
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  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: slack-ruby-client
+  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: telegram-bot
+  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
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: Notify alerts when status change
+email:
+- roman.g.rodriguez@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/NOCH/version.rb
+- lib/noch.rb
+- noch.gemspec
+homepage: https://github.com/romanrod/noch
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.1
+signing_key: 
+specification_version: 4
+summary: Alerts on status change
+test_files: []