subexec-notifications 1.0.0

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+_yardoc
+coverage
+doc/
+gemfiles/*
+Gemfile.lock
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,12 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+install:
+  - gem install bundler
+  - gem install rake
+  - gem install appraisal
+before_script:
+  - bundle install
+  - rake appraisal:setup
+script:
+  - rake appraisal test

data/Appraisals

@@ -0,0 +1,16 @@
+
+appraise 'v30' do
+  gem 'activesupport', '~> 3.0.0'
+end
+
+appraise 'v31' do
+  gem 'activesupport', '~> 3.1.0'
+end
+
+appraise 'v32' do
+  gem 'activesupport', '~> 3.2.0'
+end
+
+appraise 'v40' do
+  gem 'activesupport', '~> 4.0.0'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'ruby_gntp', require: false
+

data/Guardfile

@@ -0,0 +1,6 @@
+
+guard 'minitest' do
+  watch(%r|^lib/.*|)                      { "test/cases" }
+  watch(%r|^test/test_helper\.rb|)        { "test/cases" }
+  watch(%r|^test/cases/(.*)_test\.rb|)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Ken Collins
+
+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,64 @@
+# Subexec::Notifications
+
+Instrumentation for [`Subexec`](https://github.com/nulayer/subexec) commands using `ActiveSupport::Notifications`.
+
+
+## Usage
+
+Read the full document documentation for [`ActiveSupport::Notifications`](http://apidock.com/rails/ActiveSupport/Notifications) first. All `Subexec` events can be subscribed to using the `subexec.run` key.
+
+```ruby
+ActiveSupport::Notifications.subscribe('subexec.run') do |*args|
+  Subscribers::SubexecLibrato.new(*args)
+end
+```
+
+The payload for events return the `Subexec` instance via the `:sub` key as well as the hostname of the machine running the command via the `:hostname` key. For example:
+
+```ruby
+module Subscribers
+  class SubexecLibrato < Base
+
+    def initialize(*args)
+      @event = ActiveSupport::Notifications::Event.new(*args)
+      process
+    end
+
+    def process
+      sub = @event.payload[:sub]
+      duration = @event.duration
+      command = sub.command.split.first
+      source = @event.payload[:hostname]
+      Librato::Metrics.submit 'subexec:run' => {type: command, value: duration, source: source}
+    end
+
+  end
+end
+```
+
+
+## Learn More
+
+* [Digging Deep with ActiveSupport::Notifications](https://speakerdeck.com/nextmat/digging-deep-with-activesupportnotifications)
+
+
+## Contributing
+
+The subexec-notifications gem is tested against ActiveSupport v3.x to v4.x. We run our tests on [Travis CI](http://travis-ci.org/customink/subexec-notifications) in both Ruby 1.9 and 2.0. Check the `.travis.yml` file for the latest build information. 
+
+If you detect a problem, open up a github issue or fork the repo and help out. After you fork or clone the repository, the following commands will get you up and running on the test suite. 
+
+```shell
+$ bundle install
+$ bundle exec rake appraisal:setup
+$ bundle exec rake appraisal test
+```
+
+We use the [appraisal](https://github.com/thoughtbot/appraisal) gem from Thoughtbot to help us generate the individual gemfiles for each ActiveSupport version and to run the tests locally against each generated Gemfile. The `rake appraisal test` command actually runs our test suite against all ActiveSupport versions in our `Appraisal` file. If you want to run the tests for a specific ActiveSupport version, use `rake -T` for a list. For example, the following command will run the tests for ActiveSupport v3.2 only.
+
+```shell
+$ bundle exec rake appraisal:v32 test
+```
+
+Our current build status is:
+[![Build Status](https://travis-ci.org/customink/subexec-notifications.png?branch=master)](https://travis-ci.org/customink/subexec-notifications)

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'appraisal'
+
+Rake::TestTask.new   do |t|
+  t.libs = ['lib','test']
+  t.test_files = Dir.glob('test/**/*_test.rb').sort
+  t.verbose = true
+end
+
+task :default => :test
+
+desc "Setup Appraisal."
+task 'appraisal:setup' do
+  Rake::Task['appraisal:cleanup'].invoke
+  Rake::Task['appraisal:gemfiles'].invoke
+  Rake::Task['appraisal:install'].invoke
+end

data/lib/subexec-notifications.rb

@@ -0,0 +1 @@
+require 'subexec/notifications'

data/lib/subexec/notifications.rb

@@ -0,0 +1,12 @@
+require 'socket'
+require 'subexec'
+require 'active_support/concern'
+require 'active_support/core_ext/module/aliasing'
+require 'active_support/notifications'
+require 'subexec/notifications/version'
+require 'subexec/notifications/extensions'
+
+class Subexec
+  module Notifications
+  end
+end

data/lib/subexec/notifications/extensions.rb

@@ -0,0 +1,27 @@
+class Subexec
+  module Notifications
+    module Extensions
+
+      extend ActiveSupport::Concern
+
+      included do
+        alias_method_chain :run!, :notifications
+      end
+
+      def run_with_notifications!
+        ActiveSupport::Notifications.instrument "subexec.run", notification_payload do
+          run_without_notifications!
+        end
+      end
+
+      private
+
+      def notification_payload
+        { sub: self, hostname: Socket.gethostname }
+      end
+
+    end
+  end
+end
+
+Subexec.send :include, Subexec::Notifications::Extensions

data/lib/subexec/notifications/version.rb

@@ -0,0 +1,5 @@
+class Subexec
+  module Notifications
+    VERSION = '1.0.0'
+  end
+end

data/subexec-notifications.gemspec

@@ -0,0 +1,25 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'subexec/notifications/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'subexec-notifications'
+  spec.version       = Subexec::Notifications::VERSION
+  spec.authors       = ['Ken Collins']
+  spec.email         = ['ken@metaskills.net']
+  spec.summary       = 'Instrumentation for Subexec commands using ActiveSupport::Notifications'
+  spec.description   = spec.summary
+  spec.homepage      = 'http://github.com/customink/subexec-notifications'
+  spec.license       = 'MIT'
+  spec.files         = `git ls-files`.split($/)
+  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_runtime_dependency     'subexec'
+  spec.add_runtime_dependency     'activesupport', '>= 3.0'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
+  spec.add_development_dependency 'guard-minitest'
+  spec.add_development_dependency 'rake'
+end

data/test/cases/notifications_test.rb

@@ -0,0 +1,42 @@
+require 'test_helper'
+
+class Subexec
+  module Notifications
+    class NotificationsTest < TestCase
+
+      it 'runs a basic command' do
+        sub = Subexec.run "echo 'hello'"
+        sub.timeout.must_be_instance_of Fixnum
+        sub.exitstatus.must_equal       0
+        sub.pid.must_be_instance_of     Fixnum
+        sub.output.must_equal           "hello\n"
+        sub.command.must_equal          "echo 'hello'"
+        sub.lang.must_equal             "C"
+      end
+
+      it 'instrements events' do
+        subscribed { Subexec.run "echo 'hello'" }
+        event.name.must_equal             'subexec.run'
+        event.duration.must_be_close_to   15, 30
+        event.payload.must_be_instance_of Hash
+      end
+
+      it 'payload includes the Subexec object' do
+        subscribed { Subexec.run "echo 'Subexec Object'" }
+        sub = event.payload[:sub]
+        sub.must_be_instance_of   Subexec
+        sub.command.must_equal    "echo 'Subexec Object'"
+        sub.exitstatus.must_equal 0
+      end
+
+      it 'payload includes the hostname' do
+        Socket.stub :gethostname, 'vm22.bigcompany.com' do
+          subscribed { Subexec.run "echo 'Important Work'" }
+          event.payload[:hostname].must_equal 'vm22.bigcompany.com'
+        end
+      end
+
+
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,37 @@
+require 'bundler' ; Bundler.require :development, :test
+require 'subexec-notifications'
+require 'minitest/spec'
+require 'minitest/mock'
+require 'minitest/autorun'
+
+class Subexec
+  module Notifications
+    class TestCase < MiniTest::Spec
+
+      let(:callback)  { lambda { |*args| event(*args) } }
+
+      after do
+        clear_event!
+      end
+
+
+      private
+
+      def subscribed(name="subexec.run")
+        subscriber = ActiveSupport::Notifications.subscribe(name, &callback)
+        yield
+      ensure
+        ActiveSupport::Notifications.unsubscribe(subscriber)
+      end
+
+      def event(*args)
+        @event ||= ActiveSupport::Notifications::Event.new(*args)
+      end
+
+      def clear_event!
+        @event = nil
+      end
+
+    end
+  end
+end

metadata

@@ -0,0 +1,181 @@
+--- !ruby/object:Gem::Specification
+name: subexec-notifications
+version: !ruby/object:Gem::Version
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors:
+- Ken Collins
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: subexec
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  type: :runtime
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: bundler
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: minitest
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: guard-minitest
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+- !ruby/object:Gem::Dependency
+  name: rake
+  type: :development
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  prerelease: false
+description: Instrumentation for Subexec commands using ActiveSupport::Notifications
+email:
+- ken@metaskills.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Appraisals
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/subexec-notifications.rb
+- lib/subexec/notifications.rb
+- lib/subexec/notifications/extensions.rb
+- lib/subexec/notifications/version.rb
+- subexec-notifications.gemspec
+- test/cases/notifications_test.rb
+- test/test_helper.rb
+homepage: http://github.com/customink/subexec-notifications
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 1852404599446323047
+      version: '0'
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      segments:
+      - 0
+      hash: 1852404599446323047
+      version: '0'
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Instrumentation for Subexec commands using ActiveSupport::Notifications
+test_files:
+- test/cases/notifications_test.rb
+- test/test_helper.rb