baldrick 0.0.1

data/History.txt

@@ -0,0 +1,5 @@
+== 0.0.1 2009-02-24
+
+* 1 major enhancement:
+  * Initial release
+  * mmmm...has that new gem smell

data/Manifest.txt

@@ -0,0 +1,18 @@
+History.txt
+Manifest.txt
+README.rdoc
+Rakefile
+lib/baldrick.rb
+lib/baldrick_serve.rb
+lib/baldrick/command.rb
+lib/baldrick/run_servant.rb
+lib/baldrick/servant.rb
+lib/baldrick/task.rb
+lib/baldrick/listeners/feed_listener.rb
+lib/baldrick/listeners/feed_orders.rb
+lib/baldrick/listeners/injour_listener.rb
+lib/baldrick/listeners/xpath_locator.rb
+script/console
+script/destroy
+script/generate
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,98 @@
+= Baldrick
+
+* http://github.com/brentsnook/baldrick
+
+A dogsbody. Does what you tell it.
+
+Baldrick recognises orders and then performs appropriate tasks.
+Baldrick acts as the glue between the source of the order (for example a twitter Atom feed) and the task you would like performed (put the kettle on).
+
+== Installation
+
+<em>Note: the rubyforge project application is currently being considered. First gem should be up within a few days. Please build yourself in the meantime - 2009-02-23</em>
+
+Make Baldrick cower 'neath *your* boot:
+
+  sudo gem install baldrick
+
+If you want to use the injour listener you will also need to install injour[http://github.com/arunthampi/injour]
+
+=== Building the Gem yourself
+
+Grab the code from github:
+
+  git clone git://github.com/brentsnook/baldrick.git
+  cd baldrick
+  rake install_gem
+
+== How does it work?
+
+You tell Baldrick:
+
+* how to perform tasks
+* which tasks will be performed when a particular order is received
+* where to listen for new orders
+
+Baldrick keeps an ear out at the places you tell it to listen and then does its thing.
+
+To tell Baldrick to print out a list of people in the twitterverse who desire a tasty beverage:
+
+  #cuppa.rb
+  require 'rubygems'
+  require 'baldrick_serve'
+
+  listen_to :feed, :at => 'http://search.twitter.com/search.atom?q=cup+of'
+
+  on_hearing /cup of (.*?)[\.,]/ do |beverage, order|
+    puts "#{order[:who]} would like a cup of #{beverage}"  
+  end
+
+Just run the script and the magic ruby fairies will take care of the rest:
+
+  ruby cuppa.rb
+
+Dismiss Baldrick with <tt>CTRL C</tt>.
+
+== How does it all work?
+
+The regex describes the phrase that triggers the task, the contents of any capturing groups are passed to the body of your task along with the order.
+The order contains *who*, *what*, *where* and *when*.
+
+Check out http://wiki.github.com/brentsnook/baldrick for details.
+
+== What is it good for?
+
+Don't look at me, I just made it. How about these for suggestions?
+
+* do cool stuff based on injour[http://github.com/arunthampi/injour] statuses
+* do cool stuff based on web (RSS/Atom) feeds
+* do cool stuff with an {Arduino board}[http://www.arduino.cc/]
+* control a continuous integration build light
+* control a nuclear power plant
+
+I'd love to hear what you use it for.
+
+== License
+
+(The MIT License)
+
+Copyright (c) 2009 Brent Snook http://fuglylogic.com
+
+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/Rakefile

@@ -0,0 +1,30 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/baldrick'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('baldrick', Baldrick::VERSION) do |p|
+  p.developer 'Brent Snook', 'brent@fuglylogic.com'
+  p.summary = %q{Does what you tell it - glues orders to tasks.}
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.rubyforge_name = p.name
+  p.extra_deps = [
+    ['nokogiri','>= 1.1.1'],
+  ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"],
+    ['rspec', '>= 1.1.12'],
+    ['cucumber', '>= 0.1.16'],
+    ['injour', '>= 0.2.3'],
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+task :default => [:spec, :features]

data/lib/baldrick.rb

@@ -0,0 +1,17 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+module Baldrick
+  VERSION = '0.0.1'
+end
+
+require 'baldrick/listeners/xpath_locator'
+require 'baldrick/listeners/injour_listener'
+require 'baldrick/listeners/feed_listener'
+require 'baldrick/listeners/feed_orders'
+
+require 'baldrick/servant'
+require 'baldrick/task'
+
+require 'baldrick/command'
+require 'baldrick/run_servant'

data/lib/baldrick/command.rb

@@ -0,0 +1,53 @@
+require 'singleton'
+
+module Baldrick
+  class Command 
+    include Singleton
+    
+    def initialize
+      @listener_classes = {:injour => Listeners::InjourListener, :feed => Listeners::FeedListener}
+      @servant = Servant.new
+      @wait_period = 2
+      @should_serve = true  
+    end
+      
+    def execute(stdout)
+      stdout << "Servant started...\n"; stdout.flush   
+      while should_serve? do
+        @servant.serve
+        sleep @wait_period
+      end
+    end
+
+    def should_serve?
+      @should_serve
+    end
+    
+    def stop!
+      @should_serve = false  
+    end   
+    
+    def listen_every period
+      @wait_period = period
+    end  
+    
+    def listen_to listener_type, options={}
+      listener_class = listener_class_for(listener_type) || raise("No order listener implementation found for #{listener_type}")
+      @servant.add_listener(listener_class.new(options))
+    end
+    
+    def on_hearing(matcher, &procedure)
+      @servant.add_task Task.new(matcher, procedure)
+    end
+    alias :to :on_hearing
+    
+    def register_listener_type type, listener_class
+      @listener_classes[type] = listener_class
+    end
+      
+    def listener_class_for type
+      @listener_classes[type]
+    end    
+
+  end
+end

data/lib/baldrick/listeners/feed_listener.rb

@@ -0,0 +1,25 @@
+require 'open-uri'
+
+module Baldrick::Listeners
+  class FeedListener
+
+    def initialize options
+      @url = options[:at]
+      # just don't go trying to consume feeds before 1970
+      @time_of_last_order = Time.at 0
+    end
+
+    def orders
+      content = open(@url){|f| f.read}
+      select_new_orders_from FeedOrders.within(content)
+    end 
+    
+    private
+    
+    def select_new_orders_from orders
+      new_orders = orders.select {|order| order[:when] and order[:when] > @time_of_last_order}
+      @time_of_last_order = new_orders.collect {|order| order[:when]}.sort.last || @time_of_last_order
+      new_orders
+    end   
+  end 
+end

data/lib/baldrick/listeners/feed_orders.rb

@@ -0,0 +1,23 @@
+module Baldrick::Listeners
+
+  class FeedOrders
+    
+    def self.within xml
+      XPathLocator.from_xml(xml).find_nodes_matching('//item', '//entry').collect {|item| order_from item} 
+    end
+    
+    private
+    
+    def self.order_from item
+      locator = XPathLocator.from_node item
+      publish_time = locator.find_text_matching 'published/text()', 'pubDate/text()', 'date/text()', 'updated/text()'
+      {
+        :what => item.to_s,
+        :who => locator.find_text_matching('author/name/text()', 'author/text()'), 
+        :when => publish_time ? Time.parse(publish_time) : nil,
+        :where => locator.find_text_matching('link/text()', "link[@rel='alternate']/@href")
+      }
+    end 
+  
+  end
+end

data/lib/baldrick/listeners/injour_listener.rb

@@ -0,0 +1,34 @@
+module Baldrick::Listeners
+  class InjourListener
+
+    def initialize options = {}
+      @last_orders = {}
+    end
+
+    def orders
+      order_pattern = /=== (.*?) on (.*?) ===\n\* \[(.*?)\] (.*?)\n/m
+      all_orders = `injour ls`.scan(order_pattern).collect do |match|
+        {
+          :who => match[0],
+          :where => match[1],
+          :when => Time.parse(match[2]),
+          :what => match[3]
+        }
+      end
+
+      select_new_orders_from all_orders
+    end
+    
+    private
+    
+    def select_new_orders_from all_orders
+      new_orders = all_orders.reject do |order|
+        who = order[:who]
+        previous_order = @last_orders[who]
+        @last_orders[who] = order
+        !previous_order.nil? and previous_order == order 
+      end
+      new_orders
+    end
+  end
+end

data/lib/baldrick/listeners/xpath_locator.rb

@@ -0,0 +1,37 @@
+require 'nokogiri'
+
+module Baldrick::Listeners
+  
+  class XPathLocator
+    
+    def self.from_xml xml
+      from_node Nokogiri::XML(strip_default_namespaces_from xml)
+    end  
+    
+    def self.from_node node
+      self.new node
+    end
+    
+    def initialize node
+      @doc = node     
+    end  
+    
+    def find_text_matching *paths
+      matches = find_nodes_matching *paths
+      matches.first.text unless matches.empty?
+    end  
+    
+    def find_nodes_matching *paths  
+      @doc.search *paths || []
+    end
+    
+    private
+    
+    # need to do this so that default namespaced elements can be located
+    # http://nokogiri.lighthouseapp.com/projects/19607/tickets/8-nokogirixml-str-not-allow-an-xpath-result
+    # has to be a better way though
+    def self.strip_default_namespaces_from xml
+      xml.gsub /xmlns="[^"]*"/, ''    
+    end  
+  end
+end

data/lib/baldrick/run_servant.rb

@@ -0,0 +1,22 @@
+module Baldrick
+  module RunServant
+
+    def self.included clazz
+      # register shutdown hook ONLY when the module is included
+      at_exit do
+        raise $! if $!
+        Baldrick::Command.instance.execute STDOUT
+      end 
+      
+      trap(:INT) do
+        Baldrick::Command.instance.stop!
+      end     
+    end  
+    
+    # send configuration messages to the command
+    def method_missing name, *args, &block
+      Baldrick::Command.instance.respond_to?(name) ? Baldrick::Command.instance.send(name, *args, &block) : super(name, args)        
+    end
+  
+  end
+end    

data/lib/baldrick/servant.rb

@@ -0,0 +1,40 @@
+module Baldrick
+
+  class Servant
+    
+    def initialize
+      @tasks, @listeners = [], []
+    end
+     
+    def add_task task
+      @tasks << task
+    end
+
+    def add_listener listener
+      @listeners << listener
+    end
+
+    def serve
+      orders.each {|order| follow order}
+    end
+
+    def follow order
+      @tasks.each{|task| task.run order}
+    end
+
+    private
+
+    def orders
+      @listeners.inject([]) do |all_orders, listener|
+        begin
+          all_orders + listener.orders
+        rescue Exception => exception
+          puts exception 
+          all_orders  
+        end
+      end
+    end
+
+  end
+
+end

data/lib/baldrick/task.rb

@@ -0,0 +1,16 @@
+module Baldrick
+  class Task
+    def initialize(matcher, procedure)
+      @matcher, @procedure = matcher, procedure
+    end
+
+    def run order
+      if matches = @matcher.match(order[:what])
+        all_arguments = matches[1..-1] << order
+        accepted_arguments = all_arguments[0..(@procedure.arity - 1)]
+        @procedure.call(*accepted_arguments)
+      end
+    end
+
+  end
+end

data/lib/baldrick_serve.rb

@@ -0,0 +1,3 @@
+require File.dirname(__FILE__) + '/baldrick'
+
+include Baldrick::RunServant

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/baldrick.rb'}"
+puts "Loading baldrick gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification 
+name: baldrick
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Brent Snook
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-24 00:00:00 +11:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: nokogiri
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.1
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.1.12
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: cucumber
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.16
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: injour
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+description: ""
+email: 
+- brent@fuglylogic.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+files: 
+- History.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- lib/baldrick.rb
+- lib/baldrick_serve.rb
+- lib/baldrick/command.rb
+- lib/baldrick/run_servant.rb
+- lib/baldrick/servant.rb
+- lib/baldrick/task.rb
+- lib/baldrick/listeners/feed_listener.rb
+- lib/baldrick/listeners/feed_orders.rb
+- lib/baldrick/listeners/injour_listener.rb
+- lib/baldrick/listeners/xpath_locator.rb
+- script/console
+- script/destroy
+- script/generate
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/brentsnook/baldrick
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: baldrick
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Does what you tell it - glues orders to tasks.
+test_files: []
+