alerty 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ec90bd21ce7f831f3a1a688bc29b41eaeec57261
+  data.tar.gz: 0aa77f32295f188671b203cbdc797b30dcb1f707
+SHA512:
+  metadata.gz: aa300f5950d396569873bfc8773999a6e9c0ea0d8d903458927b77701c808aa9cb6c7369e91f94c397865e97a6d93fe66db0203db8f11baaf7e8ec6188c31462
+  data.tar.gz: b903dacd0f3df02636e17ff068f34769a65fc76e5b7570600a49896410f655d27e30cb638db7bb186bdec8917c3c1ab330dc0dcc5c59f2ade48fbbbcff305acc

data/.gitignore

@@ -0,0 +1,18 @@
+*~
+.bundle
+.pryrc
+.rvmrc
+.rbenv-version
+.ruby-version
+.yardoc
+.DS_Store
+Gemfile.lock
+coverage
+doc
+log
+tmp
+vendor
+*.swp
+pkg/
+.env
+log/alerty.log

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+# 0.0.1 (2015/08/13)
+
+first version

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Naotoshi Seo
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# alerty
+
+Send an alert if a given command failed. 
+
+## How Useful?
+
+I use `alerty` to run commands in cron. With `alerty`, we can send an alert if a cron command fails.
+
+## Installation
+
+```
+gem install alerty
+```
+
+## Configuration
+
+You can write a configuration file located at `/etc/sysconfig/alerty` (You can configure this path by `ALERTY_CONFIG_FILE` environment variable, or `-c` option):
+
+```
+log_level: 'debug'
+plugins:
+  - type: stdout
+```
+
+[example/alerty.yml](./example/alerty.yml)
+
+### CLI Example
+
+```
+$ alerty -c example.yml -- ls -l /something_not_exist
+```
+
+### CLI Help
+
+```
+$ bin/alerty -h
+    -c, --config CONFIG_PATH         config file path (default: /etc/sysconfig/alerty)
+    -t, --timeout SECONDS            timeout the command (default: no timeout)
+    -l, --lock LOCK_FILE             exclusive lock file not to run the same command duplicatedly (default: no lock)
+```
+
+## Plugins
+
+Following plugins are available:
+
+* [alerty-plugin-ikachan](https://github.com/sonots/alerty-plugin-ikachan)
+
+## ChangeLog
+
+See [CHANGELOG.md](CHANGELOG.md) for details.
+
+### ToDo
+
+* Add tests
+
+### Licenses
+
+See [LICENSE](LICENSE)

data/Rakefile

@@ -0,0 +1,22 @@
+# -*- coding: utf-8; -*-
+require "bundler/gem_tasks"
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new :spec do |spec|
+    spec.pattern = FileList['spec/**/*_spec.rb']
+  end
+  task default: :spec
+rescue LoadError, NameError
+  # OK, they can be absent on non-development mode.
+end
+
+desc "irb console"
+task :console do
+  require_relative "lib/alerty"
+  require 'irb'
+  require 'irb/completion'
+  ARGV.clear
+  IRB.start
+end
+task :c => :console

data/alerty.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |gem|
+  gem.name          = "alerty"
+  gem.version       = '0.0.1'
+  gem.author        = ['Naotoshi Seo']
+  gem.email         = ['sonots@gmail.com']
+  gem.homepage      = 'https://github.com/sonots/alerty'
+  gem.summary       = "Send an alert if a given command failed"
+  gem.description   = "Send an alert if a given command failed"
+  gem.licenses      = ['MIT']
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.require_paths = ["lib"]
+
+  gem.add_runtime_dependency 'hashie'
+  gem.add_runtime_dependency 'oneline_log_formatter'
+  gem.add_runtime_dependency 'frontkick'
+
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'pry'
+  gem.add_development_dependency 'pry-nav'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'bundler'
+end

data/bin/alerty

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require_relative '../lib/alerty/cli'
+Alerty.new.run

data/example.yml

@@ -0,0 +1,6 @@
+log_path: log/alerty.log
+log_level: debug
+plugins:
+  - type: stdout
+  - type: file
+    path: log/failure.log

data/lib/alerty/cli.rb

@@ -0,0 +1,55 @@
+require 'optparse'
+require_relative '../alerty'
+
+class Alerty
+  def parse_options(argv = ARGV)
+    op = OptionParser.new
+    op.banner += ' -- command'
+
+    (class<<self;self;end).module_eval do
+      define_method(:usage) do |msg|
+        puts op.to_s
+        puts "error: #{msg}" if msg
+        exit 1
+      end
+    end
+
+    opts = {
+      config: '/etc/sysconfig/alerty',
+      timeout: nil,
+      exclusive: nil,
+    }
+
+    op.on('-c', '--config CONFIG_FILE', "config file path (default: #{opts[:config]})") {|v|
+      opts[:config] = v
+    }
+    op.on('-t', '--timeout SECONDS', "timeout the command (default: no timeout)") {|v|
+      opts[:timeout] = v.to_i
+    }
+    op.on('-l', '--lock LOCK_FILE', "exclusive lock file to prevent running a command duplicatedly (default: no lock)") {|v|
+      opts[:exclusive] = v
+    }
+
+    op.parse!(argv)
+
+    opts[:command] = argv.join(' ')
+
+    if opts[:command].empty?
+      usage "No command is given"
+    end
+
+    opts
+  end
+
+  def run
+    begin
+      opts = parse_options
+    rescue OptionParser::InvalidOption => e
+      usage e.message
+    end
+
+    Config.configure(config_path: opts[:config]) if opts[:config]
+    Config.plugins # load plugins in early stage
+    Command.new(command: opts[:command], opts: opts).run!
+  end
+end

data/lib/alerty/command.rb

@@ -0,0 +1,26 @@
+require 'frontkick'
+
+class Alerty
+  class Command
+    def initialize(command: , opts: {})
+      @command = command
+      @opts = opts
+    end
+
+    def run!
+      result = Frontkick.exec("#{@command} 2>&1", @opts)
+      if result.success?
+        exit 0
+      else
+        Config.plugins.each do |plugin|
+          begin
+            plugin.alert(result.stdout)
+          rescue => e
+            Alerty.logger.warn "#{e.class} #{e.message} #{e.backtrace.join("\n")}"
+          end
+        end
+        exit result.exitstatus
+      end
+    end
+  end
+end

data/lib/alerty/config.rb

@@ -0,0 +1,36 @@
+require 'yaml'
+require 'hashie/mash'
+
+class Alerty
+  class Config
+    class << self
+      def configure(config_path: )
+        @config_path = config_path
+      end
+
+      def config_path
+        @config_path ||= ENV['ALERTY_CONFIG_PATH'] || '/etc/sysconfig/alerty'
+      end
+
+      def config
+        @config ||= Hashie::Mash.new(YAML.load_file(config_path))
+      end
+
+      def log_path
+        config.log_path || 'STDOUT'
+      end
+
+      def log_level
+        config.log_level || 'warn'
+      end
+
+      def plugins
+        @plugins ||= config.fetch('plugins').map do |plugin|
+          require "alerty/plugin/#{plugin.type}"
+          class_name = "Alerty::Plugin::#{StringUtil.camelize(plugin.type)}" 
+          Object.const_get(class_name).new(plugin)
+        end
+      end
+    end
+  end
+end

data/lib/alerty/error.rb

@@ -0,0 +1,6 @@
+class Alerty
+  class Error < StandardError
+  end
+  class ConfigError < Error
+  end
+end

data/lib/alerty/logger.rb

@@ -0,0 +1,21 @@
+require 'logger'
+require 'oneline_log_formatter'
+
+class Alerty
+  class Logger < ::Logger
+    def initialize(logdev, shift_age = 0, shift_size = 1048576)
+      logdev = STDOUT if logdev == 'STDOUT'
+      super(logdev, shift_age, shift_size)
+      @formatter = OnelineLogFormatter.new
+    end
+
+    def level=(level)
+      level = eval("::Logger::#{level.upcase}") if level.is_a?(String)
+      super(level)
+    end
+
+    def write(msg)
+      @logdev.write msg
+    end
+  end
+end

data/lib/alerty/plugin/file.rb

@@ -0,0 +1,16 @@
+class Alerty
+  class Plugin
+    class File
+      def initialize(config)
+        raise ConfigError.new('file: path is not configured') unless config.path
+        @path = config.path
+      end
+
+      def alert(msg)
+        ::File.open(@path, 'a') do |io|
+          io.puts msg
+        end
+      end
+    end
+  end
+end

data/lib/alerty/plugin/stdout.rb

@@ -0,0 +1,12 @@
+class Alerty
+  class Plugin
+    class Stdout
+      def initialize(config)
+      end
+
+      def alert(msg)
+        $stdout.puts msg
+      end
+    end
+  end
+end

data/lib/alerty/string_util.rb

@@ -0,0 +1,10 @@
+class Alerty
+  class StringUtil
+    def self.camelize(string)
+      string = string.sub(/^[a-z\d]*/) { $&.capitalize }
+      string.gsub!(/(?:_|(\/))([a-z\d]*)/i) { $2.capitalize }
+      string.gsub!(/\//, '::')
+      string
+    end
+  end
+end

data/lib/alerty.rb

@@ -0,0 +1,13 @@
+require_relative 'alerty/string_util'
+require_relative 'alerty/error'
+require_relative 'alerty/config'
+require_relative 'alerty/command'
+require_relative 'alerty/logger'
+
+class Alerty
+  def self.logger
+    @logger ||= Logger.new(Config.log_path).tap do |logger|
+      logger.level = Config.log_level
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+ENV['RACK_ENV'] = 'test'
+Bundler.require :test
+
+require 'pry'
+require 'alerty'
+
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+end

metadata

@@ -0,0 +1,178 @@
+--- !ruby/object:Gem::Specification
+name: alerty
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Naotoshi Seo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  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: oneline_log_formatter
+  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: frontkick
+  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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Send an alert if a given command failed
+email:
+- sonots@gmail.com
+executables:
+- alerty
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- alerty.gemspec
+- bin/alerty
+- example.yml
+- lib/alerty.rb
+- lib/alerty/cli.rb
+- lib/alerty/command.rb
+- lib/alerty/config.rb
+- lib/alerty/error.rb
+- lib/alerty/logger.rb
+- lib/alerty/plugin/file.rb
+- lib/alerty/plugin/stdout.rb
+- lib/alerty/string_util.rb
+- log/.gitkeep
+- spec/spec_helper.rb
+homepage: https://github.com/sonots/alerty
+licenses:
+- MIT
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Send an alert if a given command failed
+test_files:
+- spec/spec_helper.rb