chicanery 0.1.0 → 0.1.1

data/Gemfile.lock

@@ -1,32 +1,32 @@
 PATH
   remote: .
   specs:
-    chicanery (0.1.0)
+    chicanery (0.1.1)
       nokogiri (~> 1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.1)
     fakeweb (1.3.0)
-    multi_json (1.3.7)
+    multi_json (1.6.1)
     nokogiri (1.5.6)
-    rake (0.9.2.2)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.3)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.3)
+    rake (0.9.6)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.0)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.0)
     simplecov (0.7.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.7.1)
     simplecov-gem-adapter (1.0.1)
       simplecov
     simplecov-html (0.7.1)
-    vcr (2.3.0)
+    vcr (2.4.0)
 
 PLATFORMS
   ruby

data/README.md

@@ -16,18 +16,18 @@ State is persisted between executions so that it be scheduled to run regularly w
 
 Create a configuration file.  This file is just a ruby file that can make use of a few configuration and callback methods:
 
-    require 'chicanery/cctray'
     require 'chicanery/git'
-
     include Chicanery::Git
-
-    git_repo 'chicanery', '/tmp/chicanery', remotes: {
+    git 'chicanery', '.', branches: [:master], remotes: {
       github: { url: 'git://github.com/markryall/chicanery.git' }
     }
-    server Chicanery::Cctray.new 'tddium', 'https://cihost.com/cctray.xml'
+
+    require 'chicanery/cctray'
+    include Chicanery::Cctray
+    cctray 'tddium', 'https://cihost.com/cctray.xml'
 
     when_run do |state|
-      puts 'checked state'
+      puts state.has_failure? ? "something is wrong" : "all builds are fine"
     end
 
     when_commit do |repo, commit, previous|
@@ -66,6 +66,39 @@ If you want to specify an alternate location for this state file, add the follow
 
     persist_state_to '/tmp/build_state'
 
+# Callbacks
+
+## General
+
+The 'when_run' callback is executed on every poll.
+
+## Servers
+
+The following callbacks may be received after checking a CI server:
+
+* when_started - when a new job has started
+* when_succeeded - when a job finishes successfully
+* when_failed - when a job finishes unsuccessfully
+* when_broken - when a previously passing job fails
+* when_fixed - when a previously failing job passes
+
+## Repos
+
+The following callbacks may be received after checking a source repository:
+
+* when_commit - when a new commit is detected in the repository
+
+Currently only git repositories are supported.
+
+## Site
+
+The following callbacks may be received after checking a web site:
+
+* when_up - the website responded with a 2xx HTTP status
+* when_down - the website did not responded with a 2xx HTTP status
+* when_crashed - the website was previously up and is now down
+* when_recovered - the website was previously down and is now up
+
 ## 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.
@@ -88,7 +121,6 @@ Basic authentication is supported by passing :user => 'user', :password => 'pass
 * 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
@@ -97,4 +129,4 @@ Basic authentication is supported by passing :user => 'user', :password => 'pass
 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
+5. Create new Pull Request

data/examples/chicanery.rb

@@ -10,6 +10,8 @@ git 'chicanery', '.', branches: [:master], remotes: {
 
 cctray 'travis', 'https://api.travis-ci.org/repositories/markryall/chicanery/cc.xml'
 
+site 'travis', 'https://api.travis-ci.org/repositories/markryall/chicanery.json'
+
 poll_period 10
 
 def growlnotify message
@@ -18,6 +20,7 @@ end
 
 when_run do |state|
   puts state.has_failure? ? "something is wrong" : "all builds are fine"
+  puts state.site_down? ? "something is wrong" : "all sites are fine"
 end
 
 when_commit do |repo, commit, previous|
@@ -45,4 +48,16 @@ end
 when_fixed do |job_name, job|
   growlnotify "job #{job_name} is fixed"
   `afplay ~/build_sounds/applause.mp3`
+end
+
+when_up do |name, site|
+  puts "#{name} returned #{site.code} in #{site.duration} seconds"
+end
+
+when_crashed do |name, site|
+  puts "#{name} has crashed with status of #{site.code}"
+end
+
+when_recovered do |name, site|
+  puts "#{name} has recovered with status of #{site.code}"
 end

data/lib/chicanery/cctray.rb

@@ -1,4 +1,4 @@
-require 'net/http'
+require 'chicanery/site'
 require 'nokogiri'
 require 'date'
 
@@ -12,31 +12,14 @@ module Chicanery
       server Cctray::Server.new *args
     end
 
-    class Server
-      attr_reader :name, :uri, :options
-
-      def initialize name, url, options={}
-        @name, @uri, @options = name, URI(url), options
-      end
-
-      def get
-        req = Net::HTTP::Get.new(uri.path)
-        req.basic_auth options[:user], options[:password] if options[:user] and options[:password]
-        res = Net::HTTP.start(uri.host, uri.port, use_ssl: uri.scheme == 'https', verify_mode: OpenSSL::SSL::VERIFY_NONE) do |https|
-          https.request(req)
-        end
-        res.value #check for success via a spectactulalry poorly named method
-        res.body
-      end
-
+    class Server < Chicanery::Site
       def jobs
         jobs = {}
-        response_body = get
-        Nokogiri::XML(response_body).css("Project").each do |project|
+        Nokogiri::XML(response_body = get).css("Project").each do |project|
           job = {
             activity: project[:activity] == 'Sleeping' ? :sleeping : :building,
             last_build_status: parse_build_status(project[:lastBuildStatus]),
-            last_build_time: project[:lastBuildTime].empty? ? nil : DateTime.parse(project[:lastBuildTime]).to_time.to_i,
+            last_build_time: parse_build_time(project[:lastBuildTime]),
             url: project[:webUrl],
             last_label: project[:lastBuildLabel]
           }
@@ -46,6 +29,11 @@ module Chicanery
         jobs
       end
 
+      def parse_build_time time
+        return nil if time.nil? || time.empty?
+        DateTime.parse(time).to_time.to_i
+      end
+
       def parse_build_status status
         case status
         when /^Success/ then :success

data/lib/chicanery/handlers.rb

@@ -1,6 +1,6 @@
 module Chicanery
   module Handlers
-    %w{run started succeeded failed broken fixed commit}.each do |status|
+    %w{run started succeeded failed broken fixed commit up down crashed recovered}.each do |status|
       class_eval <<-EOF
         def when_#{status} &block
           #{status}_handlers << block

data/lib/chicanery/repos.rb

@@ -0,0 +1,26 @@
+require 'chicanery/collections'
+require 'chicanery/handlers'
+
+module Chicanery
+  module Repos
+    include Collections
+    include Handlers
+
+    def check_repos current_state, previous_state
+      current_state[:repos] = {}
+      repos.each do |repo|
+        repo_state = repo.state
+        compare_repo_state repo.name, repo_state, previous_state[:repos][repo.name] if previous_state[:repos]
+        current_state[:repos][repo.name] = repo_state
+      end
+    end
+
+    def compare_repo_state name, current, previous
+      return unless previous
+      current.each do |branch, state|
+        next unless previous[branch]
+        notify_commit_handlers "#{name}/#{branch}", state, previous[branch] if state != previous[branch]
+      end
+    end
+  end
+end

data/lib/chicanery/{state_comparison.rb → servers.rb}

@@ -1,5 +1,20 @@
+require 'chicanery/collections'
+require 'chicanery/handlers'
+
 module Chicanery
-  module StateComparison
+  module Servers
+    include Collections
+    include Handlers
+
+    def check_servers current_state, previous_state
+      current_state[:servers] = {}
+      servers.each do |server|
+        current_jobs = server.jobs
+        compare_jobs current_jobs, previous_state[:servers][server.name] if previous_state[:servers]
+        current_state[:servers][server.name] = current_jobs
+      end
+    end
+
     def compare_jobs current_jobs, previous_jobs
       return unless previous_jobs
       current_jobs.each do |job_name, job|
@@ -17,13 +32,5 @@ module Chicanery
       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
-
-    def compare_repo_state name, current, previous
-      return unless previous
-      current.each do |branch, state|
-        next unless previous[branch]
-        notify_commit_handlers "#{name}/#{branch}", state, previous[branch] if state != previous[branch]
-      end
-    end
   end
 end

data/lib/chicanery/site.rb

@@ -0,0 +1,26 @@
+require 'net/http'
+require 'benchmark'
+
+module Chicanery
+  class Site
+    attr_reader :name, :uri, :options, :body, :code, :duration
+
+    def initialize name, url, options={}
+      @name, @uri, @options = name, URI(url), options
+    end
+
+    def get
+      req = Net::HTTP::Get.new uri.path
+      req.basic_auth options[:user], options[:password] if options[:user] and options[:password]
+      http_opts = { use_ssl: uri.scheme == 'https' }
+      http_opts[:verify_mode] = OpenSSL::SSL::VERIFY_NONE unless options[:verify_ssl]
+      start = Time.now
+      res = Net::HTTP.start uri.host, uri.port, http_opts do |https|
+        https.request req
+      end
+      @duration, @code, @body = (Time.now - start), res.code, res.body
+      res.value #check for success via a spectactularly poorly named method
+      res.body
+    end
+  end
+end

data/lib/chicanery/sites.rb

@@ -0,0 +1,32 @@
+require 'chicanery/handlers'
+require 'chicanery/site'
+
+module Chicanery
+  module Sites
+    include Handlers
+
+    def sites
+      @sites ||= []
+    end
+
+    def site *args
+      sites << Chicanery::Site.new(*args)
+    end
+
+    def check_sites current_state, previous_state
+      current_state[:sites] = {}
+      sites.each do |site|
+        begin
+          content = site.get
+          current_state[:sites][site.name] = :up
+          notify_up_handlers site.name, site
+          notify_recovered_handlers site.name, site if previous_state && previous_state[:sites] && previous_state[:sites][site.name] == :down
+        rescue Exception
+          current_state[:sites][site.name] = :down
+          notify_down_handlers site.name, site
+          notify_crashed_handlers site.name, site if previous_state && previous_state[:sites] && previous_state[:sites][site.name] == :up
+        end
+      end
+    end
+  end
+end

data/lib/chicanery/summary.rb

@@ -7,5 +7,11 @@ module Chicanery
         end
       end.flatten.inject(false) {|v,a| v || a}
     end
+
+    def site_down?
+      self[:sites].map do |name, status|
+        status == :down
+      end.inject(false) {|v,a| v || a}
+    end
   end
 end

data/lib/chicanery.rb

@@ -5,18 +5,18 @@ if ENV['COVERAGE']
 end
 
 require 'chicanery/persistence'
-require 'chicanery/collections'
-require 'chicanery/handlers'
-require 'chicanery/state_comparison'
+require 'chicanery/servers'
+require 'chicanery/repos'
+require 'chicanery/sites'
 require 'chicanery/summary'
 
 module Chicanery
   include Persistence
-  include Collections
-  include Handlers
-  include StateComparison
+  include Servers
+  include Repos
+  include Sites
 
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 
   def poll_period seconds=nil
     @poll_period = seconds if seconds
@@ -24,40 +24,29 @@ module Chicanery
   end
 
   def execute args
-    load args.shift
-    run_every poll_period
+    begin
+      load args.shift
+      run_every poll_period
+    rescue Interrupt
+    end
   end
 
   def run_every poll_period
-    begin
-      loop do
-        run
-        break unless poll_period
-        sleep poll_period
-      end
-    rescue Interrupt
+    loop do
+      run
+      break unless poll_period
+      sleep poll_period
     end
   end
 
   def run
     previous_state = restore
-    current_state = {
-      servers: {},
-      repos: {}
-    }
-    repos.each do |repo|
-      repo_state = repo.state
-      compare_repo_state repo.name, repo_state, previous_state[:repos][repo.name] if previous_state[:repos]
-      current_state[:repos][repo.name] = repo_state
-    end
-    servers.each do |server|
-      current_jobs = server.jobs
-      compare_jobs current_jobs, previous_state[:servers][server.name] if previous_state[:servers]
-      current_state[:servers][server.name] = current_jobs
-    end
+    current_state = {}
+    check_servers current_state, previous_state
+    check_repos current_state, previous_state
+    check_sites current_state, previous_state
     current_state.extend Chicanery::Summary
     run_handlers.each {|handler| handler.call current_state, previous_state }
     persist current_state
   end
-
 end

data/spec/chicanery/cctray_spec.rb

@@ -52,17 +52,16 @@ describe Chicanery::Cctray do
       }
     end
   end
-  
+
   it 'should complain if there are no jobs in response' do
      VCR.use_cassette('no_projects') do
        expect{server.jobs}.to raise_error "could not find any jobs in response: [Nothing here but us chickens]"
      end
   end
-  
+
   it 'should complain if it gets a non 2xx response' do
      VCR.use_cassette('redirect') do
        expect{server.jobs}.to raise_error Net::HTTPRetriableError
      end
-  end  
-  
+  end
 end

data/spec/chicanery/{state_comparison_spec.rb → servers_spec.rb}

@@ -1,5 +1,5 @@
-describe Chicanery::StateComparison do
-  include Chicanery::StateComparison
+describe Chicanery::Servers do
+  include Chicanery::Servers
 
   describe '#compare_jobs' do
     let(:current_jobs) { {} }

data/spec/chicanery_spec.rb

@@ -15,10 +15,7 @@ describe Chicanery do
     end
 
     it 'should persist new state' do
-      should_receive(:persist).with({
-        servers: {},
-        repos: {}
-      })
+      should_receive(:persist).with servers: {}, repos: {}, sites: {}
     end
 
     it 'should sleep for specified time when poll period is provided' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: chicanery
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-19 00:00:00.000000000 Z
+date: 2013-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -154,12 +154,15 @@ files:
 - lib/chicanery/git.rb
 - lib/chicanery/handlers.rb
 - lib/chicanery/persistence.rb
-- lib/chicanery/state_comparison.rb
+- lib/chicanery/repos.rb
+- lib/chicanery/servers.rb
+- lib/chicanery/site.rb
+- lib/chicanery/sites.rb
 - lib/chicanery/summary.rb
 - spec/chicanery/cctray_spec.rb
 - spec/chicanery/collections_spec.rb
 - spec/chicanery/persistence_spec.rb
-- spec/chicanery/state_comparison_spec.rb
+- spec/chicanery/servers_spec.rb
 - spec/chicanery/summary_spec.rb
 - spec/chicanery_spec.rb
 - spec/embedded_chicanery_spec.rb
@@ -177,7 +180,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1168261720268673254
+      hash: -3139042759217892738
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -186,7 +189,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1168261720268673254
+      hash: -3139042759217892738
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -197,7 +200,7 @@ test_files:
 - spec/chicanery/cctray_spec.rb
 - spec/chicanery/collections_spec.rb
 - spec/chicanery/persistence_spec.rb
-- spec/chicanery/state_comparison_spec.rb
+- spec/chicanery/servers_spec.rb
 - spec/chicanery/summary_spec.rb
 - spec/chicanery_spec.rb
 - spec/embedded_chicanery_spec.rb