chicanery 0.0.3 → 0.0.4

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"

data/Gemfile.lock

@@ -1,30 +1,13 @@
 PATH
   remote: .
   specs:
-    chicanery (0.0.3)
+    chicanery (0.0.4)
       nokogiri (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    aruba (0.5.0)
-      childprocess (= 0.2.3)
-      cucumber (>= 1.1.1)
-      ffi (>= 1.0.11)
-      rspec-expectations (>= 2.7.0)
-    builder (3.1.4)
-    childprocess (0.2.3)
-      ffi (~> 1.0.6)
-    cucumber (1.2.1)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.3)
-      gherkin (~> 2.11.0)
-      json (>= 1.4.6)
     diff-lcs (1.1.3)
-    ffi (1.0.11)
-    gherkin (2.11.5)
-      json (>= 1.4.6)
-    json (1.7.5)
     nokogiri (1.5.5)
     rake (0.9.2.2)
     rspec (2.11.0)
@@ -40,7 +23,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  aruba (~> 0)
   chicanery!
   rake (~> 0)
   rspec (~> 2)

data/README.md

@@ -1,24 +1,78 @@
-# Chicanery
+# Chicanery [![Build Status](https://secure.travis-ci.org/markryall/chicanery.png)](http://travis-ci.org/markryall/chicanery)
 
-TODO: Write a gem description
+This is a command line tool to trigger any kind of action in response to any interesting event in a software development project (such as build server events, commit events, deployment events, etc.).
+
+This is intended to run unattended on a server and is not really intended for local notifications on a developer's machine.  If this is what you're looking for, take a look at [build reactor](https://github.com/AdamNowotny/BuildReactor) instead.
+
+Any kind of action can be taken in response to these events - playing a sound, announcement in an irc session, firing a projectile at a developer, emitting an odour etc.
+
+State is persisted between executions so that it be scheduled to run regularly with crontab or it can simply be run as a long polling process.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+    $ gem install chicanery
 
-    gem 'chicanery'
+## Usage
 
-And then execute:
+Create a configuration file.  This file is just a ruby file that can make use of a few configuration and callback methods:
 
-    $ bundle
+    require 'chicanery/cctray'
 
-Or install it yourself as:
+    server Chicanery::Cctray.new 'tddium', 'https://cihost.com/cctray.xml'
 
-    $ gem install chicanery
+    when_succeeded do |job_name, job|
+      puts "#{job_name} has succeeded"
+    end
 
-## Usage
+    when_failed do |job_name, job|
+      puts "#{job_name} has failed"
+    end
+
+    when_broken do |job_name, job|
+      `afplay ~/build_sounds/ambulance.mp3`
+      puts "#{job_name} is broken"
+    end
+
+    when_fixed do |job_name, job|
+      `afplay ~/build_sounds/applause.mp3`
+      puts "#{job_name} is fixed"
+    end
+
+Now you can schedule the following command with cron:
+
+    chicanery myconfiguration
+
+Or continuously poll every 10 seconds:
+
+    chicanery myconfiguration 10
+
+You'll notice a file called 'state' is created which represents the state at the last execution.  This is then restored during the next execution to detect events such as a new build succeeding/failing.
+
+## Supported CI servers
+
+Currently only ci servers that can provide [cctray reporting format](http://confluence.public.thoughtworks.org/display/CI/Multiple+Project+Summary+Reporting+Standard) are supported.
+
+This includes thoughtworks go, tddium, travisci, jenkins, cc.net and several others:
+
+For a jenkins or hudson server, monitor http://jenkins-server:8080/cc.xml
+
+For a go server, monitor https://go-server:8154/go/cctray.xml
+
+For a travis ci project, monitor https://api.travis-ci.org/repositories/owner/project/cc.xml
+
+For a tddium project, monitor the link 'Configure with CCMenu' which will look something like https://api.tddium.com/cc/long_uuid_string/cctray.xml
+
+Basic authentication is supported by passing :user => 'user', :password => 'password' to the Chicanery::Cctray constructor.  https is supported without performing certificate verification (some ci servers such as thoughtworks go generates a self signed cert that would otherwise be rejected without significant messing around).
+
+## Plans for world domination
 
-TODO: Write usage instructions here
+* monitoring a git repository for push notifications
+* monitoring a mercurial repository for push notifications
+* monitoring a subversion repository for commit notifications
+* monitoring heroku for deployment event notification
+* monitoring more ci servers (atlassian bamboo, jetbrains team city, etc.)
+* integration with the blinky gem to control a delcom build light
+* other interesting notifier plugins or examples
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+
+task :default do
+  sh 'bundle exec rspec spec'
+end

data/chicanery.gemspec

@@ -21,5 +21,4 @@ Gem::Specification.new do |gem|
 
   gem.add_development_dependency 'rake', '~>0'
   gem.add_development_dependency 'rspec', '~>2'
-  gem.add_development_dependency 'aruba', '~>0'
 end

data/examples/travis.rb

@@ -0,0 +1,26 @@
+require 'chicanery/cctray'
+
+server Chicanery::Cctray.new 'travis', 'https://api.travis-ci.org/repositories/markryall/chicanery/cc.xml'
+
+when_started do |job_name, job|
+  `afplay ~/build_sounds/startup.mp3`
+  puts "job #{job_name} has started"
+end
+
+when_succeeded do |job_name, job|
+  puts "job #{job_name} #{job[:last_label]} has succeeded"
+end
+
+when_failed do |job_name, job|
+  puts "job #{job_name} #{job[:last_label]} has failed"
+end
+
+when_broken do |job_name, job|
+  `afplay ~/build_sounds/ambulance.mp3`
+  puts "job #{job_name} is broken"
+end
+
+when_fixed do |job_name, job|
+  `afplay ~/build_sounds/applause.mp3`
+  puts "job #{job_name} is fixed"
+end

data/lib/chicanery.rb

@@ -9,7 +9,7 @@ module Chicanery
   include Handlers
   include StateComparison
 
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 
   def execute *args
     load args.shift
@@ -26,7 +26,7 @@ module Chicanery
       end
       run_handlers.each {|handler| handler.call current_state }
       persist current_state
-      exit unless poll_period
+      break unless poll_period
       sleep poll_period.to_i
     end
   end

data/lib/chicanery/cctray.rb

@@ -23,9 +23,9 @@ module Chicanery
       jobs = {}
       Nokogiri::XML(get).css("Project").each do |project|
         job = {
-          activity: project[:activity],
+          activity: project[:activity] == 'Sleeping' ? :sleeping : :building,
           last_build_status: project[:lastBuildStatus] == 'Success' ? :success : :failure,
-          last_build_time: DateTime.parse(project[:lastBuildTime]),
+          last_build_time: project[:lastBuildTime].empty? ? nil : DateTime.parse(project[:lastBuildTime]),
           url: project[:webUrl],
           last_label: project[:lastBuildLabel]
         }
@@ -35,7 +35,7 @@ module Chicanery
     end
 
     def filtered name
-      return true unless options[:include]
+      return false unless options[:include]
       !options[:include].match(name)
     end
   end

data/lib/chicanery/handlers.rb

@@ -1,6 +1,6 @@
 module Chicanery
   module Handlers
-    %w{run succeeded failed broken fixed}.each do |status|
+    %w{run started succeeded failed broken fixed}.each do |status|
       class_eval <<-EOF
         def when_#{status} &block
           #{status}_handlers << block
@@ -9,6 +9,10 @@ module Chicanery
         def #{status}_handlers
           @#{status}_handlers ||= []
         end
+
+        def notify_#{status}_handlers *args
+          #{status}_handlers.each {|handler| handler.call *args }
+        end
       EOF
     end
   end

data/lib/chicanery/state_comparison.rb

@@ -3,17 +3,20 @@ module Chicanery
     def compare_jobs current_jobs, previous_jobs
       return unless previous_jobs
       current_jobs.each do |job_name, job|
-        compare_job job_name, job, previous_jobs[job_name]
+        compare_job job_name, job, previous_jobs[job_name] if previous_jobs[job_name]
       end
     end
 
     def compare_job name, current, previous
-      return unless current and previous
-      return unless current[:last_build_time] > previous[:last_build_time]
-      succeeded_handlers.each {|handler| handler.call name, current } if current[:last_build_status] == :success
-      failed_handlers.each {|handler| handler.call name, current } if current[:last_build_status] == :failure
-      broken_handlers.each {|handler| handler.call name, current } if current[:last_build_status] == :failure and previous[:last_build_status] == :success
-      fixed_handlers.each {|handler| handler.call name, current } if current[:last_build_status] == :success and previous[:last_build_status] == :failure
+      return unless current[:last_build_time] != previous[:last_build_time]
+      if current[:activity] == :building and previous[:activity] == :sleeping
+        notify_started_handlers name, current
+        return
+      end
+      notify_succeeded_handlers name, current if current[:last_build_status] == :success
+      notify_failed_handlers name, current if current[:last_build_status] == :failure
+      notify_broken_handlers name, current if current[:last_build_status] == :failure and previous[:last_build_status] == :success
+      notify_fixed_handlers name, current if current[:last_build_status] == :success and previous[:last_build_status] == :failure
     end
   end
 end

data/spec/chicanery/state_comparison_spec.rb

@@ -0,0 +1,20 @@
+require 'chicanery/state_comparison'
+
+describe Chicanery::StateComparison do
+  include Chicanery::StateComparison
+
+  let(:current_jobs) { {} }
+  let(:previous_jobs) { {} }
+
+  it 'should do nothing when there are no jobs in current state' do
+    should_not_receive :compare_job
+    previous_jobs[:job] = {}
+    compare_jobs current_jobs, previous_jobs
+  end
+
+  it 'should do nothing when there is no previous state' do
+    should_not_receive :compare_job
+    current_jobs[:job] = {}
+    compare_jobs current_jobs, previous_jobs
+  end
+end

data/spec/chicanery_spec.rb

@@ -0,0 +1,12 @@
+require 'chicanery'
+
+describe Chicanery do
+  include Chicanery
+
+  describe '#execute' do
+    it 'should load configuration and exit immediately when nothing is configured no poll period is provided' do
+      should_receive(:load).with 'configuration'
+      execute 'configuration'
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chicanery
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-17 00:00:00.000000000 Z
+date: 2012-11-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -59,22 +59,6 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2'
-- !ruby/object:Gem::Dependency
-  name: aruba
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0'
 description: trigger various events related to a continuous integration environment
 email:
 - mark@ryall.name
@@ -84,6 +68,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -91,11 +76,7 @@ files:
 - Rakefile
 - bin/chicanery
 - chicanery.gemspec
-- cucumber.yml
-- examples/go_server.rb
-- features/ci.feature
-- features/step_definitions/ci_steps.rb
-- features/support/env.rb
+- examples/travis.rb
 - lib/chicanery.rb
 - lib/chicanery/cctray.rb
 - lib/chicanery/handlers.rb
@@ -104,6 +85,8 @@ files:
 - lib/chicanery/state_comparison.rb
 - spec/broken.xml
 - spec/building.xml
+- spec/chicanery/state_comparison_spec.rb
+- spec/chicanery_spec.rb
 homepage: http://github.com/markryall/chicanery
 licenses: []
 post_install_message: 
@@ -118,7 +101,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2729598607174781804
+      hash: -3725593527818179587
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -127,7 +110,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -2729598607174781804
+      hash: -3725593527818179587
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -135,8 +118,7 @@ signing_key:
 specification_version: 3
 summary: polls various resources related to a ci environment and performs custom notifications
 test_files:
-- features/ci.feature
-- features/step_definitions/ci_steps.rb
-- features/support/env.rb
 - spec/broken.xml
 - spec/building.xml
+- spec/chicanery/state_comparison_spec.rb
+- spec/chicanery_spec.rb

data/cucumber.yml

@@ -1,2 +0,0 @@
-default: -r features -t ~@wip
-wip: -r features -t @wip --wip

data/examples/go_server.rb

@@ -1 +0,0 @@
-puts "loading configuration from #{__FILE__}"

data/features/ci.feature

@@ -1,21 +0,0 @@
-Feature: ci
-
-  In order to know I have working software
-  As a software delivery team member
-  I want to receive notifications from my ci build
-
-  @wip
-  Scenario: no previous state and passing build
-    Given I have ci jobs:
-    | name | status  | activity |
-    | job1 | success | sleeping |
-    | job2 | success | sleeping |
-    And a stdout ci handler
-    When I engage in chicanery
-    Then the exit status should be 0
-    And the stdout should contain:
-    """
-    job1 is ok
-    job2 is ok
-    all jobs are ok
-    """

data/features/step_definitions/ci_steps.rb

@@ -1,28 +0,0 @@
-require 'erb'
-
-Given /^I have ci jobs:$/ do |table|
-  @jobs = table.hashes
-end
-
-Given /^a stdout ci handler$/ do
-  @handlers = <<EOF
-when_anything do |state|
-  state.jobs each do |job|
-    puts "#{job.name} is #{job.status}"
-  end
-end
-EOF
-end
-
-When /^I engage in chicanery$/ do
-  jobs, handlers = @jobs, @handlers
-  template = ERB.new <<EOF
-<% @jobs.each do |job| %>
-  job "<%= job['name'] %>
-<% end %>
-
-<% @handlers %>
-EOF
-  write_file 'configuration', template.result(binding)
-  run_simple 'chicanery configuration'
-end

data/features/support/env.rb

@@ -1,3 +0,0 @@
-require 'aruba/cucumber'
-
-ENV['PATH'] = "#{File.expand_path(File.dirname(__FILE__) + '/../../bin')}#{File::PATH_SEPARATOR}#{ENV['PATH']}"