knife-santoku 0.1.4

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Kevin Nuckolls
+
+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,98 @@
+# Knife-Santoku 
+A drop in replacement for knife that helps you build out processes around Chef.
+
+![Santoku](http://upload.wikimedia.org/wikipedia/commons/a/aa/Kitchen-knife-santoku-form.jpg)
+http://en.wikipedia.org/wiki/Santoku
+
+## Overview
+
+Santoku is primarily used for firing off notifications when knife commands are run. There are two concepts in Santoku: callbacks, and notifiers. Santoku fires off callbacks before and after any knife command is run. Callbacks can be any arbitrary ruby code in config/santoku-before.rb or config/santoku-after.rb. However, they are primarily made up of regexp matcher functions that fire off notifications to Santoku notification plugins. 
+
+Right now only Hipchat support has been written. More work will be done to let you drop your own notification classes into the  lib/santoku/ folder of your chef repo to build integrations with your favorite systems. If you build out something and would like it added to the master project just send me a pull request.
+
+You don't have to use Santoku for notifications, that's just what it was originally built for.
+
+## Usage
+
+Just run knife commands with the santoku command instead of knife. 
+
+For example, any time you would have run this:
+
+	knife cookbook upload rabbitmq
+
+just run it with santoku instead
+
+	santoku cookbook upload rabbitmq
+	
+And if you reallly love santoku just make it an alias, put it in your profile, and forget all about it:
+
+	alias knife="santoku"
+
+## Configuration
+
+Put something like this in your config/santoku-before.rb or config/santoku-after.rb. These matchers will make sure that only commands that alter the chef server send off a notification.
+
+	match /spork/ do
+	  notify :hipchat, "Someone used the spork plugin"
+	end
+
+	match /from file/ do
+	  notify :hipchat
+	end
+
+	require 'etc'
+	match /cookbook upload (.*)/ do |cookbook|
+	  notify :hipchat, "#{Etc.getlogin} finished uploading #{cookbook}"
+	end
+
+	match /create/ do
+	  notify :hipchat
+	end
+
+	match /delete/ do
+	  notify :hipchat
+	end
+
+	match /bootstrap/ do 
+	  notify :hipchat
+	end
+	
+Put this in config/santoku-config.yml
+
+	hipchat:
+	    token: "your_hipchat_api_token"
+	    room: "developers"
+	    from: "Knife"
+	    notify: false
+	    color:  "yellow"
+
+After configuring all of that you should start receiving notifications in your hipchat room whenever someone alters something on the server with knife. This can easily be adapted to add in notifications to other services.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'knife-santoku'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install knife-santoku
+
+## Todo
+* Add in the logic for end user drop in notification plugins
+* Better tests
+* Merge real callback functionality into the upstream knife codebase.
+  * Santoku only lets you notify before and after knife commands. 
+  * It would be best and most flexible to be able to hook right in with knife inside opscode's codebase.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/santoku

@@ -0,0 +1,32 @@
+#!/usr/bin/env ruby
+#
+# ./santoku - A flexible wrapper for the 'knife' Chef CLI interface 
+#
+# Author:: Kevin Nuckolls(<kevin.nuckolls@gmail.com>)
+# Author:: Adam Jacob (<adam@opscode.com>)
+# Copyright:: Copyright (c) 2009 Opscode, Inc.
+# License:: Apache License, Version 2.0
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+# 
+#     http://www.apache.org/licenses/LICENSE-2.0
+# 
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+## Adapted from Opscode's knife initializer @ https://github.com/opscode/chef
+
+require 'rubygems'
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), "..", "lib")))
+require 'chef/application/knife'
+
+## Contains a monkeypatch for Chef::Application::Knife. Shims in Santoku.
+require 'knife-santoku'
+
+Chef::Application::Knife.new.run
+

data/examples/santoku-after.rb

@@ -0,0 +1,26 @@
+## Put this in config/santoku-after.rb
+
+match /spork/ do
+  notify :hipchat, "Someone used the spork plugin"
+end
+
+match /from file/ do
+  notify :hipchat
+end
+
+require 'etc'
+match /cookbook upload (.*)/ do |cookbook|
+  notify :hipchat, "#{Etc.getlogin} finished uploading #{cookbook}"
+end
+
+match /create/ do
+  notify :hipchat
+end
+
+match /delete/ do
+  notify :hipchat
+end
+
+match /bootstrap/ do 
+  notify :hipchat
+end

data/examples/santoku-before.rb

@@ -0,0 +1,7 @@
+## Put this in config/santoku-before.rb
+
+require 'etc'
+
+match /cookbook upload (.*)/ do |cookbook|
+  notify :hipchat, "#{Etc.getlogin} started uploading #{cookbook}"
+end

data/examples/santoku-config.yml

@@ -0,0 +1,8 @@
+## Put this in config/santoku-config.yml
+
+hipchat:
+    token: "your_hipchat_api_token"
+    room: "developers"
+    from: "Knife"
+    notify: false
+    color:  "yellow"

data/knife-santoku.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/knife_santoku/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Kevin Nuckolls"]
+  gem.email         = ["kevin.nuckolls@gmail.com"]
+  gem.description   = "A drop in replacement for knife that helps you build out processes around Chef"
+  gem.summary       = ""
+  gem.homepage      = "http://www.github.com/knuckolls/knife-santoku"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "knife-santoku"
+  gem.require_paths = ["lib"]
+  gem.version       = KnifeSantoku::VERSION
+  
+  gem.add_dependency "chef"
+  gem.add_dependency "httparty"
+  gem.add_dependency "app_conf"
+end

data/lib/knife-santoku.rb

@@ -0,0 +1,10 @@
+require "knife_santoku/version"
+require "knife_santoku/notifier"
+require 'knife_santoku/notification/hipchat_notifier'
+require "knife_santoku/callback"
+require "knife_santoku/monkey_patches/knife"
+require "knife_santoku/application"
+
+module KnifeSantoku
+  
+end

data/lib/knife_santoku/application.rb

@@ -0,0 +1,38 @@
+require 'app_conf'
+require 'chef/knife'
+
+module KnifeSantoku
+  class Application
+    def initialize(argv)
+      
+      chef_conf_dir = ::Chef::Knife.chef_config_dir
+      
+      config_file = "#{chef_conf_dir}/../config/santoku-config.yml"
+      before_file = "#{chef_conf_dir}/../config/santoku-before.rb"
+      after_file  = "#{chef_conf_dir}/../config/santoku-after.rb"
+      lib_folder  = Pathname.new("#{chef_conf_dir}/../lib/santoku/")
+      
+
+      config = AppConf.new
+      config.load(config_file)
+
+      
+      # load up notifiers & custom code out of lib
+      #notifier = Notifier.new(config,lib_folder)
+      notifier = ::KnifeSantoku::Notifier.new(config)
+      
+      
+      # load up callbacks
+      @before_callbacks = Callback.new(before_file, notifier, argv)
+      @after_callbacks  = Callback.new(after_file, notifier, argv)
+    end
+    
+    def run_before_callbacks
+      @before_callbacks.run
+    end
+    
+    def run_after_callbacks
+      @after_callbacks.run
+    end
+  end
+end

data/lib/knife_santoku/callback.rb

@@ -0,0 +1,38 @@
+require 'chef/mixin/from_file'
+require 'etc'
+
+module KnifeSantoku
+  class Callback
+    
+    include Chef::Mixin::FromFile
+    
+    def initialize(file, notifier, argv)
+      @file = file
+      @notifier = notifier
+      @argv = argv.join(" ")
+    end
+    
+    def run
+      from_file(@file)
+    end
+    
+    def match(regexp, &proc)
+      matches = regexp.match(@argv)
+
+      if (matches != nil and matches.length > 1)
+
+        # drop the 'full match' off the front and leave the captures
+        matches = matches.to_a.drop(1)
+
+        proc.call(*matches)
+      elsif @argv =~ regexp
+        proc.call
+      end
+    end
+    
+    def notify(type, msg="#{Etc.getlogin} ran: #{@argv}")
+      @notifier.notify(type, msg)
+    end
+
+  end
+end

data/lib/knife_santoku/monkey_patches/knife.rb

@@ -0,0 +1,24 @@
+## Monkeypatch knife to add in callback support
+
+
+class Chef::Application::Knife
+  
+  # Run knife
+  def run
+    require 'knife-santoku'
+    santoku = ::KnifeSantoku::Application.new(ARGV)
+
+    Mixlib::Log::Formatter.show_time = false
+    validate_and_parse_options
+    quiet_traps
+
+    santoku.run_before_callbacks
+
+    Chef::Knife.run(ARGV, options)
+
+    santoku.run_after_callbacks
+
+    exit 0
+  end
+
+end

data/lib/knife_santoku/notification/hipchat_notifier.rb

@@ -0,0 +1,25 @@
+require 'httparty'
+
+module KnifeSantoku
+  module Notification
+    class HipchatNotifier
+      
+      def initialize(config)
+        @url   = "https://api.hipchat.com/v1/rooms/message"
+        
+        @token = config["hipchat"]["token"]
+        @room  = config["hipchat"]["room"]
+        @from  = config["hipchat"]["from"]
+        @notify = 0 if config["hipchat"]["notify"] == false
+        @notify = 1 if config["hipchat"]["notify"] == true
+        @color = config["hipchat"]["color"]
+      end
+      
+      def notify(msg)
+        url = "#{@url}?format=json&auth_token=#{@token}&message=#{URI.escape(msg)}&room_id=#{@room}&from=#{@from}&notify=#{@notify}&color=#{@color}"
+        HTTParty.post(url)
+      end
+      
+    end
+  end
+end

data/lib/knife_santoku/notifier.rb

@@ -0,0 +1,19 @@
+module KnifeSantoku
+  class Notifier    
+    #def initialize(config, lib_folder)
+    def initialize(config)
+      @config = config
+      
+      @notifiers = { :hipchat => ::KnifeSantoku::Notification::HipchatNotifier }
+      
+      # iterate through our internal folder and our external folder for notification classes
+    end
+    
+    def notify(type, msg)
+      klass = @notifiers[type]
+      notifier = klass.new(@config)
+      
+      notifier.notify(msg)
+    end
+  end
+end

data/lib/knife_santoku/version.rb

@@ -0,0 +1,3 @@
+module KnifeSantoku
+  VERSION = "0.1.4"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: knife-santoku
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+  prerelease: 
+platform: ruby
+authors:
+- Kevin Nuckolls
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: app_conf
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A drop in replacement for knife that helps you build out processes around
+  Chef
+email:
+- kevin.nuckolls@gmail.com
+executables:
+- santoku
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/santoku
+- examples/santoku-after.rb
+- examples/santoku-before.rb
+- examples/santoku-config.yml
+- knife-santoku.gemspec
+- lib/knife-santoku.rb
+- lib/knife_santoku/application.rb
+- lib/knife_santoku/callback.rb
+- lib/knife_santoku/monkey_patches/knife.rb
+- lib/knife_santoku/notification/hipchat_notifier.rb
+- lib/knife_santoku/notifier.rb
+- lib/knife_santoku/version.rb
+homepage: http://www.github.com/knuckolls/knife-santoku
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ''
+test_files: []