kahuna 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c355732e13b809973f1ddc8d2bdb7403ca75fc1e
+  data.tar.gz: 24d1fdab1d19802706d18f0514b3950d2b8725d9
+SHA512:
+  metadata.gz: 67a22090953f3de8ab57c011e4758e9fc88c547c8e94d732192fb64f947eb6d8572f2134b2a98d05811ce966d645fc08083a5be3ed833add6c40727bf974ad10
+  data.tar.gz: 6087d68f1a831c4bf6391d34ef6a113231693b432d64bfc2dfd68a7c1b24cb2f229566d6a6f206cf68a8abc599ce60cb997fc3af5448f6a5a1759e8754fa93e1

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - jruby-19mode
+  - rbx-19mode
+script: bundle exec rspec spec
+branches:
+  only:
+    - master
+

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard :rspec do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+  watch(%r{^spec/factories/(.+)\.rb$})	{ "spec" }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+end
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Brandon Dennis
+
+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,73 @@
+# Kahuna
+
+A gem for handling [Serf](serfdom.io) events.
+
+_(ka-hoo-na) Hawaiian tern for a man that surfs usually with a degree of skill.
+[from rippinh2o.com](http://rippinh2o.com/dropzone/surflingo.shtml#k)_
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'kahuna'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install kahuna
+
+## Example Usage
+
+Create a file named ```handler``` like the file below.
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'kahuna'
+
+data = ''
+while line = Readline.readline('', true)
+  data += line
+end
+
+Kahuna::Handler.new(data) do |event, members|
+  # Code to execute in response to event
+end.execute
+
+exit 0
+```
+
+Make the file executable
+
+```bash
+$ chmod +x handler
+```
+
+Then pass the file to serf as a handler.
+
+```bash
+serf agent -event-handler ./handler
+```
+
+## Event and Members
+
+[Kahuna::Handler](lib/kahuna/handler.rb) yields [Kahuna::Event](lib/kahuna/event.rb) and [Kahuna::MemberCollection](lib/kahuna/member_collection.rb) objects to the block passed to new. The Event object contains all the information about the event parsed from the data sent from Serf and the ENV vars set by Serf.
+
+Serf _membership_ events contain information about the members that participated in the Serf event. This information is the payload for the Serf event, but for Serf _user_ events, the payload is arbitrary. In the case of user events, the current implementation yields ```nil``` for the members variable.
+
+You can always get to the raw data sent from Serf through the event object, regardless of whether it is a user event or a membership event.
+
+```ruby
+event.raw_data        #=> "deploy all the things!"
+```
+
+## Contributing
+
+1. Fork it
+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 new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/kahuna.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kahuna/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "kahuna"
+  spec.version       = Kahuna::VERSION
+  spec.authors       = ["Brandon Dennis"]
+  spec.email         = ["toady00@gmail.com"]
+  spec.description   = %q{Handlers for Serf "http://serfdom.io"}
+  spec.summary       = %q{Kahuna provides some nice classes for handling events fired from Serf}
+  spec.homepage      = ""
+  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_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.14"
+  spec.add_development_dependency "cucumber"
+  spec.add_development_dependency "aruba"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "factory_girl", "~> 4.3.0"
+end

data/lib/kahuna.rb

@@ -0,0 +1,4 @@
+require 'kahuna/handler'
+
+module Kahuna
+end

data/lib/kahuna/event.rb

@@ -0,0 +1,14 @@
+module Kahuna
+  class Event
+    attr_reader :raw_data, :type, :name, :role, :user_event, :user_ltime
+
+    def initialize(data)
+      @raw_data = data
+      @type = ENV['SERF_EVENT']
+      @name = ENV['SERF_SELF_NAME']
+      @role = ENV['SERF_SELF_ROLE']
+      @user_event = ENV['SERF_USER_EVENT']
+      @user_ltime = ENV['SERF_USER_LTIME']
+    end
+  end
+end

data/lib/kahuna/handler.rb

@@ -0,0 +1,21 @@
+require 'kahuna/event'
+require 'kahuna/member_collection'
+
+module Kahuna
+  class Handler
+    attr_reader :event, :members
+
+    def initialize(data, &block)
+      @event = Event.new data
+      unless event.type == 'user'
+        @members = MemberCollection.new data
+      end
+      @action = block_given? ? block : ->(event, members) {}
+    end
+
+    def execute &block
+      block_to_call = block_given? ? block : @action
+      block_to_call.call(event, members)
+    end
+  end
+end

data/lib/kahuna/member.rb

@@ -0,0 +1,18 @@
+require 'logger'
+
+module Kahuna
+  class Member
+    attr_reader :name, :address, :role, :raw_data
+    REGEX = /^([\w\.\-]+)\s+([\w\.\-]+)(?:\s+([\w\.\-]+))?$/
+
+    def initialize(data)
+      @raw_data = data
+      @name, @address, @role = process_data
+    end
+
+  private
+    def process_data
+      @raw_data.match(REGEX).captures
+    end
+  end
+end

data/lib/kahuna/member_collection.rb

@@ -0,0 +1,48 @@
+require 'kahuna/member'
+
+module Kahuna
+  class MemberCollection
+    include Enumerable
+
+    EVENTS = %w(member-join member-leave member-failed)
+
+    attr_reader :raw_data
+
+    def initialize(data)
+      @raw_data = data
+      members_from_data raw_data
+    end
+
+    def each(&block)
+      members.each do |member|
+        block.call member
+      end
+    end
+
+    def empty?
+      length == 0
+    end
+
+    def length
+      members.length
+    end
+
+    define_method("<<") do |member|
+      raise "Not a kind of Kahuna::Member" unless member.kind_of? Member
+      members << member
+    end
+
+  private
+    def members
+      @members ||= []
+    end
+
+    def members_from_data(raw_data)
+      member_data = raw_data.split("\n").map { |data| data.strip }
+      member_data.each do |data|
+        member = Member.new data
+        self << member
+      end
+    end
+  end
+end

data/lib/kahuna/version.rb

@@ -0,0 +1,3 @@
+module Kahuna
+  VERSION = "0.0.1"
+end

data/spec/event_spec.rb

@@ -0,0 +1,80 @@
+require 'kahuna/event'
+
+describe Kahuna::Event do
+  env_map = {
+    type: 'SERF_EVENT',
+    name: 'SERF_SELF_NAME',
+    role: 'SERF_SELF_ROLE',
+    user_event: 'SERF_USER_EVENT',
+    user_ltime: 'SERF_USER_LTIME'
+  }
+
+  let(:data)    { "Some Data" }
+  let(:event)   { Kahuna::Event.new data }
+
+  subject { event }
+
+  it { should respond_to :raw_data }
+  it { should respond_to :type }
+  it { should respond_to :name }
+  it { should respond_to :role }
+  it { should respond_to :user_event }
+  it { should respond_to :user_ltime }
+
+  describe "membership events" do
+    let(:name)    { "brandon.local" }
+    let(:address) { "127.0.0.1" }
+    let(:role)    { "web" }
+    let(:data)    { "#{name}    #{address}    #{role}" }
+
+    before(:each) do
+      ENV['SERF_EVENT']     = "member-join"
+      ENV['SERF_SELF_NAME'] = name
+      ENV['SERF_SELF_ROLE'] = role
+      ENV.delete 'SERF_USER_EVENT'
+      ENV.delete 'SERF_USER_LTIME'
+      @event = Kahuna::Event.new data
+    end
+
+    # TODO: Pull out into shared context
+    env_map.each do |attribute, env_var_name|
+      it "should set #{attribute} from ENV[#{env_var_name}" do
+        expect(@event.send attribute).to eq(ENV[env_var_name])
+      end
+    end
+
+    it 'does not set user_event' do
+      @event.user_event.should be_nil
+    end
+
+    it 'does not set the user_ltime' do
+      @event.user_ltime.should be_nil
+    end
+  end
+
+  describe 'user event' do
+    let(:data) { "Kahuna Test Payload" }
+
+    before(:each) do
+      ENV['SERF_EVENT'] = "user"
+      ENV['SERF_USER_EVENT'] = "kahuna_test"
+      ENV['SERF_USER_LTIME'] = Time.now.utc.to_s
+      @event = Kahuna::Event.new data
+    end
+
+    # TODO: Pull out into shared context
+    env_map.each do |attribute, env_var_name|
+      it "should set #{attribute} from ENV[#{env_var_name}" do
+        expect(@event.send attribute).to eq(ENV[env_var_name])
+      end
+    end
+
+    it 'does set the user_event' do
+      @event.user_event.should eq(ENV['SERF_USER_EVENT'])
+    end
+
+    it 'does set the user_ltime' do
+      @event.user_ltime.should eq(ENV['SERF_USER_LTIME'])
+    end
+  end
+end

data/spec/factories/member_factory.rb

@@ -0,0 +1,8 @@
+FactoryGirl.define do
+  factory :member, :class => Kahuna::Member do
+    role { %w(web lb ns db es proxy).sample }
+    sequence(:name) { |n| "#{role}#{n}.example.com" }
+    sequence(:address) { |n| "10.10.10.#{n}" }
+    initialize_with { new("#{name} #{address} #{role}")}
+  end
+end

data/spec/handler_spec.rb

@@ -0,0 +1,33 @@
+require 'kahuna/handler'
+
+describe Kahuna::Handler do
+
+  describe 'instance' do
+    let(:name)    { "brandon.local" }
+    let(:address) { "127.0.0.1" }
+    let(:role)    { "web" }
+    let(:data)    { "#{name}    #{address}    #{role}" }
+    let(:handler) { Kahuna::Handler.new data }
+
+    subject { handler }
+
+    it { should respond_to :event }
+    it { should respond_to :members }
+    it { should respond_to :execute }
+
+    describe '#execute' do
+      let(:block) { ->(event, members) { true } }
+
+      it 'calls the action' do
+        Proc.any_instance.should_receive(:call).with(handler.event, handler.members)
+        handler.execute
+      end
+
+      it 'allows arbitary blocks to be passed in' do
+        handler = Kahuna::Handler.new data, &block
+        Proc.any_instance.should_receive(:call).with(handler.event, handler.members)
+        handler.execute
+      end
+    end
+  end
+end

data/spec/member_collection_spec.rb

@@ -0,0 +1,88 @@
+require 'kahuna/member_collection'
+require 'kahuna/member'
+require 'spec_helper'
+
+describe Kahuna::MemberCollection do
+  subject { Kahuna::MemberCollection }
+  it { should include(Enumerable) }
+
+  describe 'instance' do
+    let(:member_data) { "brandon.local    127.0.0.1    web" }
+    let(:member)      { build :member }
+    let(:member2)     { build :member }
+    let(:member3)     { build :member }
+    let(:data)        { '' }
+    let(:mcollection) { Kahuna::MemberCollection.new data }
+
+    subject { mcollection }
+
+    it { should respond_to :raw_data }
+    it { should respond_to :empty? }
+
+    describe '#new' do
+      let(:data) {
+        <<-EOL
+          #{member.raw_data}
+          #{member2.raw_data}
+          #{member3.raw_data}
+        EOL
+      }
+
+      it 'creates members from data' do
+        mcollection.length.should eq 3
+      end
+    end
+
+    describe '#each' do
+
+      it 'yields each member if members are present' do
+        [member, member2, member3].each { |m| mcollection << m }
+        expect { |b| mcollection.each(&b) } .to yield_successive_args(member, member2, member3)
+      end
+
+      it 'does not yield if no members are present' do
+        expect { |b| mcollection.each(&b) } .not_to yield_control
+      end
+    end
+
+    describe '#length' do
+      it 'should return 0 if there are no members' do
+        mcollection.length.should eq 0
+      end
+
+      it 'should return the correct number of members in the collection' do
+        1.upto(10) do |n|
+          mcollection << member
+          mcollection.length.should eq n
+        end
+      end
+    end
+
+    describe '#empty?' do
+      it 'returns true if there are no members' do
+        mcollection.should be_empty
+      end
+
+      it 'returns false if these are members in the collection' do
+        mcollection << member
+        mcollection.should_not be_empty
+      end
+    end
+
+    describe "#<<" do
+
+      before :each do
+        mcollection << member
+      end
+
+      it "adds a new member to the collection" do
+        mcollection.to_a.should eq [member]
+      end
+
+      # this is a member collection after all
+      it "throws an exception if arguement is not a kind of Member" do
+        expect {mcollection << ''} .to raise_error RuntimeError
+      end
+    end
+  end
+end

data/spec/member_spec.rb

@@ -0,0 +1,35 @@
+require 'kahuna/member'
+
+describe Kahuna::Member do
+  let(:name)    { "brandon.local" }
+  let(:address) { "127.0.0.1" }
+  let(:role)    { "web" }
+  let(:data)    { "#{name}    #{address}    #{role}" }
+  let(:member)  { Kahuna::Member.new data }
+
+  subject { member }
+
+  it { should respond_to :name }
+  it { should respond_to :address }
+  it { should respond_to :role }
+  it { should respond_to :raw_data }
+
+  it 'should assign the correct values' do
+    member.name.should eq(name)
+    member.address.should eq(address)
+    member.role.should eq(role)
+  end
+
+  describe 'data without role information' do
+    let(:data) { "#{name} #{address}"}
+
+    it 'does not assign a role' do
+      member.role.should be_nil
+    end
+
+    it 'still assigns the name and address' do
+      member.name.should eq(name)
+      member.address.should eq(address)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+GEM_ROOT = File.expand_path("../../", __FILE__)
+$:.unshift File.join(GEM_ROOT, "lib")
+
+require 'rspec'
+require 'factory_girl'
+require 'kahuna'
+
+Dir[File.join(GEM_ROOT, "spec", "support", "**/*.rb")].each { |f| require f }
+Dir[File.join(GEM_ROOT, "spec/factories/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  config.order = "random"
+  config.include FactoryGirl::Syntax::Methods
+end

metadata

@@ -0,0 +1,198 @@
+--- !ruby/object:Gem::Specification
+name: kahuna
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Brandon Dennis
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !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: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  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: aruba
+  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: guard
+  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: guard-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: factory_girl
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.3.0
+description: Handlers for Serf "http://serfdom.io"
+email:
+- toady00@gmail.com
+executables:
+- .gitkeep
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/.gitkeep
+- kahuna.gemspec
+- lib/kahuna.rb
+- lib/kahuna/event.rb
+- lib/kahuna/handler.rb
+- lib/kahuna/member.rb
+- lib/kahuna/member_collection.rb
+- lib/kahuna/version.rb
+- spec/event_spec.rb
+- spec/factories/member_factory.rb
+- spec/handler_spec.rb
+- spec/member_collection_spec.rb
+- spec/member_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+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.1.11
+signing_key: 
+specification_version: 4
+summary: Kahuna provides some nice classes for handling events fired from Serf
+test_files:
+- spec/event_spec.rb
+- spec/factories/member_factory.rb
+- spec/handler_spec.rb
+- spec/member_collection_spec.rb
+- spec/member_spec.rb
+- spec/spec_helper.rb