alerty 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3ae60fa6de1c6a296b2aaefc0429cf84d716a9f8
-  data.tar.gz: b499e6edb6b41470af44ffad38c07f21ea5daff4
+  metadata.gz: ca4e9b30326bd03ff18ef0c79614f9134716221f
+  data.tar.gz: d4cbe7d427ebc8ab5a967d7dd2a3226c4b98f4d8
 SHA512:
-  metadata.gz: f88a28b14ce75957b38708936969d8e77fa1f2a8b2789ddbb838fb23ca1af0a9efb3e0cba9b06b92a107f783908727389822c8988f036591f26dee7e03935ddf
-  data.tar.gz: 3bd9c34db9e0140f0e096e284dea90dc23fdee11d3a43772bd0f57c363c2a4e47034d0ffeec197bd75437f97932f8bfee3bc6e0aa9584503ff01359e76140eba
+  metadata.gz: e8a5cb471fcd6d320d29412474bfc860e49877bbda411c7ae71f6f3c8342d8edb196da7517697bd8822edd9bfb952a7dec85bc9439433aa0148c4c3ae5569571
+  data.tar.gz: e8f6947ff4dad1cb48abaef96f00f11c7706d8422091ee3444d469e89fe69dbb3270b74a9dbf42942f5016eb4cc34bc73ec5eb50b2b35704a667bf090846c231

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1.*
+  - 2.2.*
+  - 2.3.*
+  - 2.4.*
+before_install:
+  - gem update bundler

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 0.4.0 (2017/09/29)
+
+Enhancements:
+
+* [experimental] send alert from stdin
+
 # 0.3.0 (2017/03/20)
 
 Enhancements:

data/README.md

@@ -58,6 +58,16 @@ Usage: alerty [options] -- command
         --dotenv                     Load environment variables from .env file with dotenv
 ```
 
+### Experimental: Send alert from STDIN
+
+This interface allows us to send notification even if a command does not fail.
+
+CLI Example:
+
+```
+$ echo 'this is a test' | alerty -c example.yml
+```
+
 ## Plugins
 
 Following plugins are available:

data/lib/alerty.rb

@@ -13,4 +13,23 @@ class Alerty
       logger.level = Config.log_level
     end
   end
+
+  # @param [Hash] record
+  # @option record [String] :hostname
+  # @option record [String] :command
+  # @option record [Integer] :exitstatus
+  # @option record [String] :output
+  # @option record [Float] :started_at unix timestamp
+  # @option record [Float] :duration
+  # @option record [Integer] :retries number of being retried
+  def self.send(record)
+    PluginFactory.plugins.each do |plugin|
+      begin
+        plugin.alert(record)
+      rescue => e
+        puts "#{e.class} #{e.message} #{e.backtrace.join("\n")}" if Config.debug?
+        Alerty.logger.warn "#{e.class} #{e.message} #{e.backtrace.join("\n")}"
+      end
+    end
+  end
 end

data/lib/alerty/cli.rb

@@ -1,4 +1,5 @@
 require 'optparse'
+require 'socket'
 require_relative '../alerty'
 
 class Alerty
@@ -55,11 +56,7 @@ class Alerty
       }
 
       op.parse!(argv)
-      opts[:command] = argv.join(' ')
-
-      if opts[:command].empty?
-        raise OptionParser::InvalidOption.new("No command is given")
-      end
+      opts[:command] = argv.join(' ') || ''
 
       opts
     end
@@ -73,8 +70,23 @@ class Alerty
   
       Config.configure(opts)
       PluginFactory.plugins # load plugins in early stage
-      command = Command.new(command: opts[:command])
-      command.run!
+
+      if !opts[:command].empty?
+        command = Command.new(command: opts[:command])
+        record = command.run
+        unless record[:exitstatus] == 0
+          Alerty.send(record)
+          exit record[:exitstatus]
+        end
+      else
+        begin
+          stdin = $stdin.read_nonblock(100 * 1024 * 1024)
+          record = {hostname: Socket.gethostname, output: stdin}
+          Alerty.send(record)
+        rescue IO::EAGAINWaitReadable => e
+          usage 'command argument or STDIN is required'
+        end
+      end
     end
   end
 end

data/lib/alerty/command.rb

@@ -10,7 +10,7 @@ class Alerty
       @hostname = Socket.gethostname
     end
 
-    def run!
+    def run
       record = {}
       with_retry do |retries|
         started_at = Time.now
@@ -50,17 +50,7 @@ class Alerty
         Alerty.logger.info { "result: #{record.to_json}" }
         record
       end
-      unless record[:exitstatus] == 0
-        PluginFactory.plugins.each do |plugin|
-          begin
-            plugin.alert(record)
-          rescue => e
-            puts "#{e.class} #{e.message} #{e.backtrace.join("\n")}" if Config.debug?
-            Alerty.logger.warn "#{e.class} #{e.message} #{e.backtrace.join("\n")}"
-          end
-        end
-        exit record[:exitstatus]
-      end
+      record
     end
 
     private

data/lib/alerty/version.rb

@@ -1,3 +1,3 @@
 class Alerty
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

data/spec/cli_spec.rb

@@ -7,10 +7,6 @@ describe Alerty::CLI do
   OUTPUT_FILE = File.join(File.dirname(__FILE__), 'cli_spec.out')
 
   describe '#parse_options' do
-    it 'incorrect' do
-      expect { Alerty::CLI.new.parse_options([]) }.to raise_error(OptionParser::InvalidOption)
-    end
-
     it 'command' do
       expect(Alerty::CLI.new.parse_options(['--', 'ls', '-l'])[:command]).to eql('ls -l')
     end
@@ -21,28 +17,48 @@ describe Alerty::CLI do
   end
 
   describe '#run' do
-    context 'with success' do
-      before :all do
-        FileUtils.rm(OUTPUT_FILE, force: true)
-        system("#{File.join(BIN_DIR, 'alerty')} -c #{CONFIG_PATH} -- echo foo")
-        sleep 0.1
+    context 'with command' do
+      context 'with success' do
+        before :all do
+          FileUtils.rm(OUTPUT_FILE, force: true)
+          system("#{File.join(BIN_DIR, 'alerty')} -c #{CONFIG_PATH} -- echo foo")
+          sleep 0.1
+        end
+
+        it 'should not output' do
+          expect(File.size?(OUTPUT_FILE)).to be_falsey
+        end
+
+        it { expect($?.exitstatus).to eq(0) }
       end
 
-      it 'should not output' do
-        expect(File.size?(OUTPUT_FILE)).to be_falsey
+      context 'with failure' do
+        before :all do
+          FileUtils.rm(OUTPUT_FILE, force: true)
+          system("#{File.join(BIN_DIR, 'alerty')} -c #{CONFIG_PATH} -- [ a = b ]")
+          sleep 0.1
+        end
+
+        it 'should output' do
+          expect(File.size?(OUTPUT_FILE)).to be_truthy
+        end
+
+        it { expect($?.exitstatus).to eq(1) }
       end
     end
 
-    context 'with failure' do
+    context 'with stdin' do
       before :all do
         FileUtils.rm(OUTPUT_FILE, force: true)
-        system("#{File.join(BIN_DIR, 'alerty')} -c #{CONFIG_PATH} -- [ a = b ]")
+        open("| #{File.join(BIN_DIR, 'alerty')} -c #{CONFIG_PATH}", 'w') {|f| f.puts 'test' }
         sleep 0.1
       end
 
       it 'should output' do
         expect(File.size?(OUTPUT_FILE)).to be_truthy
       end
+
+      it { expect($?.exitstatus).to eq(0) }
     end
   end
 end

data/spec/command_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
 describe Alerty::Command do
-  describe 'run!' do
+  describe 'run' do
     context 'Frontkick.exec' do
       before do
         Alerty::Config.configure(
@@ -21,7 +21,7 @@ describe Alerty::Command do
           exclusive: '/tmp/lock',
           popen2e: true,
         }).and_return(Frontkick::Result.new(exit_code: 0))
-        expect { command.run! }.not_to raise_error
+        command.run
       end
     end
 
@@ -48,8 +48,8 @@ describe Alerty::Command do
           exclusive: nil,
           popen2e: true,
         }).and_return(Frontkick::Result.new(stdout: 'foo', exit_code: 1))
-        stdout = capture_stdout { expect { command.run! }.to raise_error(SystemExit) }
-        expect(JSON.parse(stdout)["output"]).to eql("foo")
+        record = command.run
+        expect(record[:output]).to eql("foo")
       end
     end
 
@@ -76,8 +76,8 @@ describe Alerty::Command do
           exclusive: '/tmp/lock',
           popen2e: true,
         }).and_raise(Frontkick::Timeout.new(111, 'sleep 1', true))
-        stdout = capture_stdout { expect { command.run! }.to raise_error(SystemExit) }
-        expect(JSON.parse(stdout)["output"]).to include("timeout")
+        record = command.run
+        expect(record[:output]).to include("timeout")
       end
     end
 
@@ -104,8 +104,8 @@ describe Alerty::Command do
           exclusive: '/tmp/lock',
           popen2e: true,
         }).and_raise(Frontkick::Locked)
-        stdout = capture_stdout { expect { command.run! }.to raise_error(SystemExit) }
-        expect(JSON.parse(stdout)["output"]).to include("lock")
+        record = command.run
+        expect(record[:output]).to include("lock")
       end
     end
 
@@ -131,8 +131,8 @@ describe Alerty::Command do
           exclusive: nil,
           popen2e: true,
         }).and_return(Frontkick::Result.new(stdout: 'foo', exit_code: 1))
-        stdout = capture_stdout { expect { command.run! }.to raise_error(SystemExit) }
-        expect(JSON.parse(stdout)["retries"]).to eql(1)
+        record = command.run
+        expect(record[:retries]).to eql(1)
       end
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: alerty
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Naotoshi Seo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-20 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
@@ -145,6 +145,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE
@@ -191,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
 summary: Send an alert if a given command failed