sensu-extension 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dfdd3db0fa88d97218101b74858cefdbcbb8c909
+  data.tar.gz: 7c3e63a492dd1ad24947ceb5f2c0536797f9b600
+SHA512:
+  metadata.gz: 711b0389397edb3a4829547288d3b679e2a8a0ccc884b46b18dda7097af2d9fbc9262f3b57226387c50b6c4351ccdb22e52c2c2a0b4cd6b107e10ed84b3c7c9b
+  data.tar.gz: 95986606220f2a1d18a4a6aa8714bb24dafa53a610485ad44e7ad3112544cd579d6409468b1ed709a4a5f96aae0f02a93deae7e3443a083ad7ab59c5b04bea1e

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby
+notifications:
+  irc:
+    - "irc.freenode.net#sensu"
+addons:
+  code_climate:
+    repo_token: 767b23081fd38d849be07cd85ade8b06120135f8f983b1c7ead44f2ef0272f6d

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sensu-extension.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Heavy Water Operations, LLC.
+
+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,28 @@
+# Sensu::Extension
+
+[![Build Status](https://travis-ci.org/sensu/sensu-extension.svg?branch=master)](https://travis-ci.org/sensu/sensu-extension)
+
+[![Code Climate](https://codeclimate.com/github/sensu/sensu-extension.png)](https://codeclimate.com/github/sensu/sensu-extension)
+[![Code Climate Coverage](https://codeclimate.com/github/sensu/sensu-extension/coverage.png)](https://codeclimate.com/github/sensu/sensu-extension)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sensu-extension'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Documentation can be found [here](http://rubydoc.info/github/sensu/sensu-extension/Sensu/Extension).
+
+## Contributing
+
+1. [Fork it](https://github.com/sensu/sensu-extension/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sensu/extension.rb

@@ -0,0 +1,123 @@
+gem "sensu-em"
+
+require "eventmachine"
+require "sensu/extension/constants"
+
+module Sensu
+  module Extension
+    class Base
+      # @!attribute [rw] logger
+      #   @return [Array] logger provided by Sensu.
+      attr_accessor :logger
+
+      # @!attribute [rw] settings
+      #   @return [Array] settings hash provided by Sensu.
+      attr_accessor :settings
+
+      # Initialize the extension, call post_init() when the
+      # eventmachine reactor starts up.
+      def initialize
+        EM.next_tick do
+          post_init
+        end
+      end
+
+      # Override this method to set the extension's name.
+      def name
+        "base"
+      end
+
+      # Override this method to set the extension's description.
+      def description
+        "extension description (change me)"
+      end
+
+      # Override this method to change the extension's definition, a
+      # hash. You probably don't need to touch this. The hash must
+      # contain :type ("extension") and :name.
+      def definition
+        {
+          :type => "extension",
+          :name => name
+        }
+      end
+
+      # Override this method to do something immediately after the
+      # eventmachine reactor is started. This method is great for
+      # setting up connections etc.
+      def post_init
+        true
+      end
+
+      # Override this method to do something when the extension is
+      # run, you must yield or call the callback with two parameters,
+      # an output string and exit code.
+      #
+      # @param data [Object, nil] provided by Sensu.
+      # @param callback [Proc] provided by Sensu, expecting to be
+      #   called with two parameters, an output string and exit code.
+      def run(data=nil, &callback)
+        callback.call("noop", 0)
+      end
+
+      # Override this method to do something before Sensu stops, such
+      # as connection or file cleanup. You must yield or call the
+      # callback.
+      #
+      # @param callback [Proc] provided by Sensu, expecting to be
+      #   called.
+      def stop(&callback)
+        callback.call
+      end
+
+      # Retrieve the definition object corresponding to a key, acting
+      # like a Hash object. Do not override this method!
+      #
+      # @param key [String, Symbol]
+      # @return [Object] value for key.
+      def [](key)
+        definition[key.to_sym]
+      end
+
+      # Check to see if the definition has a key. Do not override this
+      # method!
+      #
+      # @param key [String, Symbol]
+      # @return [TrueClass, FalseClass]
+      def has_key?(key)
+        definition.has_key?(key.to_sym)
+      end
+
+      # Run the extension with a few safeties. This method wraps
+      # run() with a begin;rescue, and duplicates data before passing
+      # it to ensure the extension doesn't mutate the original. Do
+      # not override this method!
+      #
+      # @param data [Object, nil) to dup() and pass to run().
+      # @param callback [Proc] to pass to run().
+      def safe_run(data=nil, &callback)
+        begin
+          data ? run(data.dup, &callback) : run(&callback)
+        rescue => error
+          callback.call(error.to_s, 2)
+        end
+      end
+
+      # Determine classes that have inherited this class, used by the
+      # extension loader. Do not override this method!
+      #
+      # @return [Array<object>]
+      def self.descendants
+        ObjectSpace.each_object(Class).select do |klass|
+          klass < self
+        end
+      end
+    end
+
+    # Create an extension class for each category from Base.
+    CATEGORIES.each do |category|
+      extension_type = category.to_s.chop
+      Sensu::Extension.const_set(extension_type.capitalize, Class.new(Base))
+    end
+  end
+end

data/lib/sensu/extension/constants.rb

@@ -0,0 +1,5 @@
+module Sensu
+  module Extension
+    CATEGORIES = [:generics, :bridges, :checks, :mutators, :handlers]
+  end
+end

data/sensu-extension.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "sensu-extension"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Sean Porter"]
+  spec.email         = ["portertech@gmail.com"]
+  spec.summary       = "The Sensu extension library"
+  spec.description   = "The Sensu extension library"
+  spec.homepage      = "https://github.com/sensu/sensu-extension"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sensu-em"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/spec/base_spec.rb

@@ -0,0 +1,90 @@
+require File.join(File.dirname(__FILE__), "helpers")
+require "sensu/extension"
+require "logger"
+
+describe "Sensu::Extension::Base" do
+  include Helpers
+
+  before do
+    @extension = Sensu::Extension::Base.new
+  end
+
+  it "can provide the extension API" do
+    @extension.should respond_to(:name, :description, :definition, :safe_run, :stop, :has_key?, :[])
+  end
+
+  it "can provide default method return values" do
+    @extension.post_init.should be_true
+    @extension.name.should eq("base")
+    @extension.description.should eq("extension description (change me)")
+    @extension.definition.should eq({:type => "extension", :name => "base"})
+  end
+
+  it "can have a logger" do
+    @extension.logger = Logger.new("/dev/null")
+    @extension.logger.formatter = Proc.new do |severity, datetime, progname, message|
+      severity.should eq("INFO")
+      message.should eq("test")
+    end
+    @extension.logger.info("test")
+  end
+
+  it "can have settings" do
+    settings = {:foo => 1}
+    @extension.settings = settings
+    @extension.settings.should eq(settings)
+  end
+
+  it "can handle provided callbacks" do
+    async_wrapper do
+      callback = Proc.new do |output, status|
+        output.should eq("noop")
+        status.should eq(0)
+        @extension.stop do
+          async_done
+        end
+      end
+      @extension.run(&callback)
+    end
+  end
+
+  it "can pass event data to run" do
+    async_wrapper do
+      event = {:foo => 1}
+      @extension.safe_run(event) do |output, status|
+        output.should eq("noop")
+        status.should eq(0)
+        async_done
+      end
+    end
+  end
+
+  it "can catch some run errors" do
+    async_wrapper do
+      @extension.safe_run do |output, status|
+        raise "boom" if status == 0
+        output.should eq("boom")
+        status.should eq(2)
+        async_done
+      end
+    end
+  end
+
+  it "can provide hash like access to definition()" do
+    @extension.has_key?(:type).should be_true
+    @extension.has_key?(:name).should be_true
+    @extension[:type].should eq("extension")
+    @extension[:name].should eq("base")
+  end
+
+  it "can provide a list of decendant classes" do
+    expected = [
+      Sensu::Extension::Generic,
+      Sensu::Extension::Bridge,
+      Sensu::Extension::Check,
+      Sensu::Extension::Mutator,
+      Sensu::Extension::Handler
+    ]
+    Sensu::Extension::Base.descendants.should include(*expected)
+  end
+end

data/spec/categories_spec.rb

@@ -0,0 +1,52 @@
+require File.join(File.dirname(__FILE__), "helpers")
+require "sensu/extension"
+
+describe "Sensu::Extension::Generic" do
+  include Helpers
+
+  it "inherits Base" do
+    Sensu::Extension::Generic.superclass.should eq(Sensu::Extension::Base)
+    extension = Sensu::Extension::Generic.new
+    extension.should respond_to(:name, :description, :definition, :safe_run, :stop, :has_key?, :[])
+  end
+end
+
+describe "Sensu::Extension::Bridge" do
+  include Helpers
+
+  it "inherits Base" do
+    Sensu::Extension::Bridge.superclass.should eq(Sensu::Extension::Base)
+    extension = Sensu::Extension::Bridge.new
+    extension.should respond_to(:name, :description, :definition, :safe_run, :stop, :has_key?, :[])
+  end
+end
+
+describe "Sensu::Extension::Check" do
+  include Helpers
+
+  it "inherits Base" do
+    Sensu::Extension::Check.superclass.should eq(Sensu::Extension::Base)
+    extension = Sensu::Extension::Check.new
+    extension.should respond_to(:name, :description, :definition, :safe_run, :stop, :has_key?, :[])
+  end
+end
+
+describe "Sensu::Extension::Mutator" do
+  include Helpers
+
+  it "inherits Base" do
+    Sensu::Extension::Mutator.superclass.should eq(Sensu::Extension::Base)
+    extension = Sensu::Extension::Mutator.new
+    extension.should respond_to(:name, :description, :definition, :safe_run, :stop, :has_key?, :[])
+  end
+end
+
+describe "Sensu::Extension::Handler" do
+  include Helpers
+
+  it "inherits Base" do
+    Sensu::Extension::Handler.superclass.should eq(Sensu::Extension::Base)
+    extension = Sensu::Extension::Handler.new
+    extension.should respond_to(:name, :description, :definition, :safe_run, :stop, :has_key?, :[])
+  end
+end

data/spec/helpers.rb

@@ -0,0 +1,29 @@
+require "rspec"
+require "eventmachine"
+
+unless RUBY_VERSION < "1.9" || RUBY_PLATFORM =~ /java/
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+module Helpers
+  def timer(delay, &callback)
+    periodic_timer = EM::PeriodicTimer.new(delay) do
+      callback.call
+      periodic_timer.cancel
+    end
+  end
+
+  def async_wrapper(&callback)
+    EM.run do
+      timer(10) do
+        raise "test timed out"
+      end
+      callback.call
+    end
+  end
+
+  def async_done
+    EM.stop_event_loop
+  end
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: sensu-extension
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-em
+  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: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: 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: codeclimate-test-reporter
+  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: The Sensu extension library
+email:
+- portertech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sensu/extension.rb
+- lib/sensu/extension/constants.rb
+- sensu-extension.gemspec
+- spec/base_spec.rb
+- spec/categories_spec.rb
+- spec/helpers.rb
+homepage: https://github.com/sensu/sensu-extension
+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.0
+signing_key: 
+specification_version: 4
+summary: The Sensu extension library
+test_files:
+- spec/base_spec.rb
+- spec/categories_spec.rb
+- spec/helpers.rb