bigwig 0.2 → 0.3

data/CHANGELOG

@@ -1,3 +1,5 @@
+v0.3. added bigwig-push command to place arbitrary messages on the queue
+
 v0.2. added bigwig-ping command to place ping messages on the queue
 
 v0.1. first public release

data/Manifest

@@ -7,10 +7,12 @@ bigwig.yml
 bigwig.yml.example
 bin/bigwig
 bin/bigwig-ping
+bin/bigwig-push
 lib/bigwig.rb
 lib/bigwig/internal_plugins/ping_plugin.rb
 lib/bigwig/job.rb
 lib/bigwig/pinger.rb
 lib/bigwig/plugin.rb
 lib/bigwig/plugins.rb
+lib/bigwig/push.rb
 lib/bigwig/runner.rb

data/README.markdown

@@ -1,7 +1,7 @@
 Bigwig
 ======
 
-Bigwig is a daemon process that listens to a RabbitMQ queue and processes messages that it receives.  
+Bigwig is a daemon process that listens to a RabbitMQ queue and processes messages that it receives, along with some simple command-line tools to place messages on the queue.   
 
 Typical Usage
 -------------
@@ -10,7 +10,9 @@ Typical Usage
 * Start an AMQP server
 * Create a folder of plugins
 * Create a bigwig configuration file
-* Start bigwig - `bigwig start -c config -l logs`
+* Start bigwig - `bigwig start -c config-file -l log-folder`
+* Ping bigwig - `bigwig-ping -c config-file`
+* Push a message with data onto the queue - `bigwig-push -m my_message -d '{:key => "value"}' -c config-file`
 
 Configuration
 -------------
@@ -30,7 +32,7 @@ A typical configuration file looks like this:
         warren_logging: false
         plugins_folder: /full/path/to/a/folder
 
-The first six items tell bigwig how to connect to the AMQP server.  The next item specifies whether you want warren (the lower-level AMQP processor) to log its output.  Lastly, you tell bigwig where to find its plugins.  
+The first six items tell bigwig how to connect to the AMQP server.  The next item specifies whether you want warren (the lower-level AMQP processor) to log its output (normally you will want this to be false, as warren can be quite noisy).  Lastly, you tell bigwig where to find its plugins.  
 
 Logging
 -------
@@ -79,11 +81,30 @@ For example, a plugin, which we shall call LoggingPlugin, would look like this:
 
 When bigwig receives a message where the `:method` parameter == 'logging' it will then invoke `LoggingPlugin#call`, passing it the `:id` and `:data` from the original message as task_id and args respectively.  
 
+If your plugin needs to know where it is on the filesystem (for example, so that it can shell out to run a script) it can access `BigWig::Plugins.root` which returns the folder reference you specified within the configuration file.  
+
 Pings
 -----
 
 There is a plugin built-in to bigwig called PingPlugin, that registers itself under the name "ping".  If you place a message onto the queue with :method => 'ping', the PingPlugin responds by writing a message to the log file.  This is useful for monitoring bigwig - another system places ping messages onto the queue at regular intervals and we watch to ensure that the log file's update time is changing.  
 
+Command-line Interface
+----------------------
+
+There are two command-line scripts that push messages on to the queue.  
+
+The simplest is `bigwig-ping`.  
+
+This pushes a ping message onto the queue - ideal for calling from a cron job.  This takes two parameters: `-t` (or `--timeout`) which is the connection timeout in seconds (defaulting to 5 if not supplied) and `-c` (or `--config`) which is the path to a Bigwig configuration file (defaulting to bigwig.yml in the current directory if not supplied).  
+
+        bigwig-ping -c /path/to/config -t 10
+
+There is also `bigwig-push`.  
+
+This pushes an arbitrary message onto the queue - ideal for testing, or just manually poking Bigwig to make something happen.  It takes the same `--config` and `--timeout` parameters as bigwig-ping, plus a few more for specifying the message itself.  These are `-m` (or `--method`) which is the method name (for selecting which plugin responds), `-i` (or `--id`) which is the optional task id (useful when linking to an external system) and `-d` (or `--data`) for a hash of values that becomes the `:data` parameter.  
+
+        bigwig-push -m my_message -d '{:key => "value", :key2 => "something else"}' -i 123 -c /path/to/config -t 10
+
 License
 -------
 

data/Rakefile

@@ -3,6 +3,6 @@ Echoe.new 'bigwig' do | gem |
   gem.author = 'David Smalley, Caius Durling, Rahoul Baruah'
   gem.summary = 'A daemon that listens to an AMQP queue and responds to messages by invoking commands from a set of plugins'
   gem.url = 'http://www.brightbox.co.uk/'
-  gem.runtime_dependencies = ["brightbox-warren >=0.9.0", "daemons >=1.0.10"]
+  gem.runtime_dependencies = ["warren >=0.9.0", "daemons >=1.0.10"]
   gem.install_message = 'Welcome to bigwig.  Please set up a configuration file and a plugins folder before starting bigwig...'
 end

data/bigwig.gemspec

@@ -2,16 +2,16 @@
 
 Gem::Specification.new do |s|
   s.name = %q{bigwig}
-  s.version = "0.2"
+  s.version = "0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["David Smalley, Caius Durling, Rahoul Baruah"]
-  s.date = %q{2009-10-06}
+  s.date = %q{2009-11-05}
   s.description = %q{A daemon that listens to an AMQP queue and responds to messages by invoking commands from a set of plugins}
   s.email = %q{}
-  s.executables = ["bigwig", "bigwig-ping"]
-  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.markdown", "bin/bigwig", "bin/bigwig-ping", "lib/bigwig.rb", "lib/bigwig/internal_plugins/ping_plugin.rb", "lib/bigwig/job.rb", "lib/bigwig/pinger.rb", "lib/bigwig/plugin.rb", "lib/bigwig/plugins.rb", "lib/bigwig/runner.rb"]
-  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.markdown", "Rakefile", "bigwig.yml", "bigwig.yml.example", "bin/bigwig", "bin/bigwig-ping", "lib/bigwig.rb", "lib/bigwig/internal_plugins/ping_plugin.rb", "lib/bigwig/job.rb", "lib/bigwig/pinger.rb", "lib/bigwig/plugin.rb", "lib/bigwig/plugins.rb", "lib/bigwig/runner.rb", "bigwig.gemspec"]
+  s.executables = ["bigwig", "bigwig-ping", "bigwig-push"]
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.markdown", "bin/bigwig", "bin/bigwig-ping", "bin/bigwig-push", "lib/bigwig.rb", "lib/bigwig/internal_plugins/ping_plugin.rb", "lib/bigwig/job.rb", "lib/bigwig/pinger.rb", "lib/bigwig/plugin.rb", "lib/bigwig/plugins.rb", "lib/bigwig/push.rb", "lib/bigwig/runner.rb"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.markdown", "Rakefile", "bigwig.yml", "bigwig.yml.example", "bin/bigwig", "bin/bigwig-ping", "bin/bigwig-push", "lib/bigwig.rb", "lib/bigwig/internal_plugins/ping_plugin.rb", "lib/bigwig/job.rb", "lib/bigwig/pinger.rb", "lib/bigwig/plugin.rb", "lib/bigwig/plugins.rb", "lib/bigwig/push.rb", "lib/bigwig/runner.rb", "bigwig.gemspec"]
   s.homepage = %q{http://www.brightbox.co.uk/}
   s.post_install_message = %q{Welcome to bigwig.  Please set up a configuration file and a plugins folder before starting bigwig...}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Bigwig", "--main", "README.markdown"]
@@ -25,14 +25,14 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<brightbox-warren>, [">= 0.9.0"])
+      s.add_runtime_dependency(%q<warren>, [">= 0.9.0"])
       s.add_runtime_dependency(%q<daemons>, [">= 1.0.10"])
     else
-      s.add_dependency(%q<brightbox-warren>, [">= 0.9.0"])
+      s.add_dependency(%q<warren>, [">= 0.9.0"])
       s.add_dependency(%q<daemons>, [">= 1.0.10"])
     end
   else
-    s.add_dependency(%q<brightbox-warren>, [">= 0.9.0"])
+    s.add_dependency(%q<warren>, [">= 0.9.0"])
     s.add_dependency(%q<daemons>, [">= 1.0.10"])
   end
 end

data/bigwig.yml

@@ -5,4 +5,4 @@ server: localhost
 port: 5672
 queue: myqueue
 warren_logging: false
-plugins_folder: /Volumes/bb/bigwig-plugins
+plugins_folder: /Volumes/bb/builder/plugins

data/bin/bigwig-ping

@@ -1,3 +1,6 @@
 #!/usr/bin/env ruby
 require File.join(File.dirname(__FILE__), "..", "lib", "bigwig")
-BigWig::Pinger.new(ARGV).run
+
+options = BigWig::Push.load_options_from ARGV
+
+BigWig::Push.new(options).message 'ping'

data/bin/bigwig-push

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), "..", "lib", "bigwig")
+require 'optparse'
+
+options = BigWig::Push.load_options_from ARGV do | parser, options | 
+  
+  parser.on '-m', '--method METHOD', 'Specify the method name' do | value | 
+    options[:method] = value
+  end
+  
+  parser.on '-i', '--id TASK_ID', 'Specify the task id' do | value | 
+    options[:id] = value
+  end
+  
+  parser.on '-d', '--data HASH', 'Specify the message data as a Hash "{:key => \'value\', :key2 => \'other_value\'}"' do | value | 
+    options[:data] = eval(value)
+  end
+  
+  parser.on '-q', '--queue QUEUE_NAME', 'Specify which queue to put the message onto' do | value | 
+    options[:queue] = value
+  end
+end
+
+BigWig::Push.new(options).message options[:method], options[:data] || {}, options[:id], options[:queue] || :default

data/lib/bigwig/pinger.rb

@@ -1,60 +1,11 @@
-require 'warren'
-require 'warren/adapters/bunny_adapter'
-require 'daemons'
-require 'optparse'
-require 'ostruct'
-require 'benchmark'
-require 'timeout'
-
 module BigWig
   class Pinger
-    attr_reader :config
-    attr_reader :options
-    
-    def initialize(command_line)
-      load_options_from command_line
+    def initialize command_line
+      @push = Push.new command_line
     end
     
     def run
-      BigWig::logger.info("Starting bigwig pinger...")
-      @config = YAML.load(File.open(@options.config))
-      BigWig::connect_using @config
-
-      begin
-        Timeout::timeout(@options.timeout) do
-          begin
-            Warren::Queue.publish :default, :method => 'ping'
-          rescue Exception => ex
-            BigWig::logger.error("...ping failed with #{ex}")
-            exit 2
-          end
-        end
-      rescue Timeout::Error => te
-        BigWig::logger.error("...ping timed out: #{te}")
-        exit 1
-      end
-
-      BigWig::logger.info("...bigwig pinger finished")
-      exit 0
-    end
-    
-  protected
-    def load_options_from command_line
-      @options = OpenStruct.new(:config => File.expand_path('./bigwig.yml'), :timeout => 5) 
-      opts = OptionParser.new do |opts|
-        opts.banner = "Usage: #{File.basename($0)} [options]"
-        opts.on('-h', '--help', 'Show this message') do
-          puts opts
-          exit 1
-        end
-        opts.on('-c', '--config=file', 'Path to the config file; if not supplied then bigwig looks for bigwig.yml in the current folder') do |conf|
-          @options.config = conf
-        end
-        opts.on('-t', '--timeout=value', 'Timeout value in seconds') do | conf | 
-          @options.timeout = conf.to_i
-        end 
-      end
-      @args = opts.parse!(command_line)
+      @push.message 'ping'
     end
   end
 end

data/lib/bigwig/push.rb

@@ -0,0 +1,97 @@
+require 'warren'
+require 'warren/adapters/bunny_adapter'
+require 'daemons'
+require 'optparse'
+require 'benchmark'
+require 'timeout'
+
+module BigWig
+  # pushes a message onto the queue
+  # USAGE:
+  #     push = BigWig::Push.new :config => '/path/to/config/file', :timeout => 5
+  # By default, it uses bigwig.yml in the current directory and a timeout of 5 seconds
+  # The configuration file is expected to have the same structure as the BigWig daemon's file (without the plugins folder)
+  class Push
+    attr_reader :config
+    attr_reader :options
+
+    # Create a new BigWig::Push
+    # Options: 
+    #     :config => '/path/to/config/file'
+    #     :timeout => 5    
+    #
+    def initialize(overrides = {})
+      @options = {
+        :config => File.expand_path('./bigwig.yml'), 
+        :timeout => 5
+      }.merge(overrides)
+    end
+    
+    # Push a message on to the queue, passing in a message name, plus an optional data hash, an optional task id and an optional queue name
+    # 
+    def message method, data = {}, task_id = nil, queue = :default
+      BigWig::logger.info("Pushing #{method} on to #{queue}")
+      @config = YAML.load(File.open(@options[:config]))
+      BigWig::connect_using @config
+
+      begin
+        Timeout::timeout(@options[:timeout]) do
+          begin
+            Warren::Queue.publish queue, :method => method, :id => task_id, :data => data
+          rescue Exception => ex
+            BigWig::logger.error("...push failed with #{ex}")
+            exit 1
+          end
+        end
+      rescue Timeout::Error => te
+        BigWig::logger.error("...push timed out: #{te}")
+        exit 1
+      end
+
+      BigWig::logger.info("...bigwig push finished")
+      exit 0
+    end
+    
+    # Helper method so that calling scripts don't need to parse the Push parameters themselves
+    #
+    # USAGE: 
+    #     options = BigWig::Push.load_options_from ARGV
+    #     BigWig::Push.new(options).message 'whatever'
+    #
+    # If this is being called from a wrapper script (such as bin/bigwig-push) that needs its own parameters you can pass a block to append your own details
+    #
+    #     options = BigWig::Push.load_options_from(ARGV) do | parser, options | 
+    #       parser.on('--xxx', 'Push it good') do 
+    #         options[:push_it_good] = :push_it_real_good
+    #       end 
+    #     end
+    #
+    def self.load_options_from command_line
+      options = {}
+            
+      parser = OptionParser.new do | parser |
+        parser.banner = "Usage: #{File.basename($0)} [options]"
+
+        parser.on('-h', '--help', 'Show this message') do
+          puts parser
+          exit 2
+        end
+        
+        parser.on('-c', '--config=file', 'Path to the config file; if not supplied then bigwig looks for bigwig.yml in the current folder') do |conf|
+          options[:config] = conf
+        end
+        
+        parser.on('-t', '--timeout=value', 'Timeout value in seconds') do | conf | 
+          options[:timeout] = conf.to_i
+        end 
+        
+        yield(parser, options) if block_given?
+
+      end
+      parser.parse!(command_line)
+      
+      return options
+    end
+  
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: bigwig
 version: !ruby/object:Gem::Version 
-  version: "0.2"
+  version: "0.3"
 platform: ruby
 authors: 
 - David Smalley, Caius Durling, Rahoul Baruah
@@ -9,11 +9,11 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-10-06 00:00:00 +01:00
+date: 2009-11-05 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: brightbox-warren
+  name: warren
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -37,6 +37,7 @@ email: ""
 executables: 
 - bigwig
 - bigwig-ping
+- bigwig-push
 extensions: []
 
 extra_rdoc_files: 
@@ -45,12 +46,14 @@ extra_rdoc_files:
 - README.markdown
 - bin/bigwig
 - bin/bigwig-ping
+- bin/bigwig-push
 - lib/bigwig.rb
 - lib/bigwig/internal_plugins/ping_plugin.rb
 - lib/bigwig/job.rb
 - lib/bigwig/pinger.rb
 - lib/bigwig/plugin.rb
 - lib/bigwig/plugins.rb
+- lib/bigwig/push.rb
 - lib/bigwig/runner.rb
 files: 
 - CHANGELOG
@@ -62,12 +65,14 @@ files:
 - bigwig.yml.example
 - bin/bigwig
 - bin/bigwig-ping
+- bin/bigwig-push
 - lib/bigwig.rb
 - lib/bigwig/internal_plugins/ping_plugin.rb
 - lib/bigwig/job.rb
 - lib/bigwig/pinger.rb
 - lib/bigwig/plugin.rb
 - lib/bigwig/plugins.rb
+- lib/bigwig/push.rb
 - lib/bigwig/runner.rb
 - bigwig.gemspec
 has_rdoc: true