bunny_farm 0.1.2

data/images/message_structure.svg

@@ -0,0 +1,138 @@
+<svg width="800" height="650" xmlns="http://www.w3.org/2000/svg">
+  <!-- Background transparent -->
+  <rect width="800" height="650" fill="transparent"/>
+  
+  <!-- Title -->
+  <text x="400" y="30" text-anchor="middle" font-family="Arial, sans-serif" font-size="20" font-weight="bold" fill="#e0e0e0">
+    BunnyFarm Message Class Structure
+  </text>
+  
+  <!-- Class Definition -->
+  <g>
+    <rect x="50" y="60" width="700" height="120" rx="10" fill="#2d3748" stroke="#9f7aea" stroke-width="2"/>
+    <text x="400" y="85" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="#9f7aea">Message Class Definition</text>
+    
+    <rect x="70" y="100" width="660" height="70" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="80" y="115" font-family="monospace" font-size="11" fill="#9f7aea">class OrderMessage &lt; BunnyFarm::Message</text>
+    <text x="90" y="130" font-family="monospace" font-size="11" fill="#68d391">fields</text>
+    <text x="130" y="130" font-family="monospace" font-size="11" fill="#e0e0e0">:order_id, :total, { customer: [:name, :email] }, { items: [:id, :qty] }</text>
+    <text x="90" y="145" font-family="monospace" font-size="11" fill="#f6e05e">actions</text>
+    <text x="130" y="145" font-family="monospace" font-size="11" fill="#e0e0e0">:validate, :process_payment, :ship, :cancel</text>
+    <text x="80" y="160" font-family="monospace" font-size="11" fill="#9f7aea">end</text>
+  </g>
+  
+  <!-- DSL Components -->
+  <g>
+    <rect x="50" y="200" width="340" height="160" rx="10" fill="#2d3748" stroke="#68d391" stroke-width="2"/>
+    <text x="220" y="225" text-anchor="middle" font-family="Arial, sans-serif" font-size="14" font-weight="bold" fill="#68d391">Fields DSL</text>
+    <text x="220" y="245" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" fill="#e0e0e0">Define expected data structure</text>
+    
+    <rect x="70" y="255" width="300" height="95" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="80" y="270" font-family="monospace" font-size="10" fill="#68d391">Simple fields:</text>
+    <text x="80" y="285" font-family="monospace" font-size="10" fill="#e0e0e0">:name, :email, :amount</text>
+    
+    <text x="80" y="305" font-family="monospace" font-size="10" fill="#68d391">Nested objects:</text>
+    <text x="80" y="320" font-family="monospace" font-size="10" fill="#e0e0e0">{ customer: [:name, :email] }</text>
+    
+    <text x="80" y="340" font-family="monospace" font-size="10" fill="#68d391">Arrays of objects:</text>
+    <text x="80" y="355" font-family="monospace" font-size="10" fill="#e0e0e0">{ items: [:product_id, :quantity] }</text>
+    
+    <rect x="410" y="200" width="340" height="160" rx="10" fill="#2d3748" stroke="#f6e05e" stroke-width="2"/>
+    <text x="580" y="225" text-anchor="middle" font-family="Arial, sans-serif" font-size="14" font-weight="bold" fill="#f6e05e">Actions DSL</text>
+    <text x="580" y="245" text-anchor="middle" font-family="Arial, sans-serif" font-size="11" fill="#e0e0e0">Define available operations</text>
+    
+    <rect x="430" y="255" width="300" height="95" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="440" y="270" font-family="monospace" font-size="10" fill="#f6e05e">actions :create, :update, :delete</text>
+    <text x="440" y="290" font-family="monospace" font-size="10" fill="#9ca3af"># Each action becomes a method</text>
+    <text x="440" y="310" font-family="monospace" font-size="10" fill="#f6e05e">def create(*args)</text>
+    <text x="450" y="325" font-family="monospace" font-size="10" fill="#e0e0e0"># Process creation logic</text>
+    <text x="450" y="340" font-family="monospace" font-size="10" fill="#68d391">success!</text>
+    <text x="440" y="355" font-family="monospace" font-size="10" fill="#f6e05e">end</text>
+  </g>
+  
+  <!-- Message Instance Structure -->
+  <g>
+    <rect x="50" y="380" width="700" height="140" rx="10" fill="#2d3748" stroke="#4299e1" stroke-width="2"/>
+    <text x="400" y="405" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="#4299e1">Message Instance Structure</text>
+    
+    <!-- Instance Variables -->
+    <rect x="80" y="420" width="200" height="90" rx="5" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="180" y="440" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#4299e1">Instance Variables</text>
+    <text x="90" y="455" font-family="monospace" font-size="10" fill="#68d391">@items</text>
+    <text x="125" y="455" font-family="monospace" font-size="10" fill="#e0e0e0">- Validated data</text>
+    <text x="90" y="470" font-family="monospace" font-size="10" fill="#68d391">@elements</text>
+    <text x="140" y="470" font-family="monospace" font-size="10" fill="#e0e0e0">- Raw JSON data</text>
+    <text x="90" y="485" font-family="monospace" font-size="10" fill="#68d391">@payload</text>
+    <text x="135" y="485" font-family="monospace" font-size="10" fill="#e0e0e0">- JSON string</text>
+    <text x="90" y="500" font-family="monospace" font-size="10" fill="#68d391">@errors</text>
+    <text x="130" y="500" font-family="monospace" font-size="10" fill="#e0e0e0">- Error messages</text>
+    
+    <!-- Access Methods -->
+    <rect x="300" y="420" width="180" height="90" rx="5" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="390" y="440" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#4299e1">Access Methods</text>
+    <text x="310" y="455" font-family="monospace" font-size="10" fill="#68d391">msg[:field]</text>
+    <text x="370" y="455" font-family="monospace" font-size="10" fill="#e0e0e0">- Get value</text>
+    <text x="310" y="470" font-family="monospace" font-size="10" fill="#68d391">msg[:field] = val</text>
+    <text x="395" y="470" font-family="monospace" font-size="10" fill="#e0e0e0">- Set</text>
+    <text x="310" y="485" font-family="monospace" font-size="10" fill="#68d391">msg.to_json</text>
+    <text x="370" y="485" font-family="monospace" font-size="10" fill="#e0e0e0">- Serialize</text>
+    <text x="310" y="500" font-family="monospace" font-size="10" fill="#68d391">msg.keys</text>
+    <text x="350" y="500" font-family="monospace" font-size="10" fill="#e0e0e0">- Get fields</text>
+    
+    <!-- State Methods -->
+    <rect x="500" y="420" width="220" height="90" rx="5" fill="#1a202c" stroke="#4a5568" stroke-width="1"/>
+    <text x="610" y="440" text-anchor="middle" font-family="Arial, sans-serif" font-size="12" font-weight="bold" fill="#4299e1">State Management</text>
+    <text x="510" y="455" font-family="monospace" font-size="10" fill="#68d391">success!</text>
+    <text x="550" y="455" font-family="monospace" font-size="10" fill="#e0e0e0">- Mark successful</text>
+    <text x="510" y="470" font-family="monospace" font-size="10" fill="#e53e3e">failure(msg)</text>
+    <text x="570" y="470" font-family="monospace" font-size="10" fill="#e0e0e0">- Mark failed</text>
+    <text x="510" y="485" font-family="monospace" font-size="10" fill="#68d391">successful?</text>
+    <text x="570" y="485" font-family="monospace" font-size="10" fill="#e0e0e0">- Check status</text>
+    <text x="510" y="500" font-family="monospace" font-size="10" fill="#68d391">publish(action)</text>
+    <text x="585" y="500" font-family="monospace" font-size="10" fill="#e0e0e0">- Send msg</text>
+  </g>
+  
+  <!-- Data Flow Example -->
+  <g>
+    <rect x="50" y="540" width="700" height="100" rx="10" fill="#2d3748" stroke="#ed8936" stroke-width="2"/>
+    <text x="400" y="565" text-anchor="middle" font-family="Arial, sans-serif" font-size="16" font-weight="bold" fill="#ed8936">Data Flow Example</text>
+    
+    <!-- Step boxes -->
+    <rect x="70" y="580" width="120" height="50" rx="5" fill="#68d391"/>
+    <text x="130" y="595" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" font-weight="bold" fill="#1a202c">1. JSON Input</text>
+    <text x="130" y="610" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">Raw message data</text>
+    <text x="130" y="620" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">from RabbitMQ</text>
+    
+    <rect x="210" y="580" width="120" height="50" rx="5" fill="#4299e1"/>
+    <text x="270" y="595" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" font-weight="bold" fill="#1a202c">2. Parse &amp; Validate</text>
+    <text x="270" y="610" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">Extract fields</text>
+    <text x="270" y="620" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">using DSL definition</text>
+    
+    <rect x="350" y="580" width="120" height="50" rx="5" fill="#9f7aea"/>
+    <text x="410" y="595" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" font-weight="bold" fill="#1a202c">3. Route Action</text>
+    <text x="410" y="610" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">Call method based</text>
+    <text x="410" y="620" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">on routing key</text>
+    
+    <rect x="490" y="580" width="120" height="50" rx="5" fill="#f6e05e"/>
+    <text x="550" y="595" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" font-weight="bold" fill="#1a202c">4. Execute Logic</text>
+    <text x="550" y="610" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">Run business</text>
+    <text x="550" y="620" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">logic in action</text>
+    
+    <rect x="630" y="580" width="120" height="50" rx="5" fill="#e53e3e"/>
+    <text x="690" y="595" text-anchor="middle" font-family="Arial, sans-serif" font-size="10" font-weight="bold" fill="#1a202c">5. ACK/NACK</text>
+    <text x="690" y="610" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">Acknowledge</text>
+    <text x="690" y="620" text-anchor="middle" font-family="Arial, sans-serif" font-size="9" fill="#1a202c">to RabbitMQ</text>
+    
+    <!-- Arrows -->
+    <defs>
+      <marker id="arrow-flow" markerWidth="10" markerHeight="7" refX="9" refY="3.5" orient="auto">
+        <polygon points="0 0, 10 3.5, 0 7" fill="#ed8936"/>
+      </marker>
+    </defs>
+    
+    <line x1="190" y1="605" x2="210" y2="605" stroke="#ed8936" stroke-width="2" marker-end="url(#arrow-flow)"/>
+    <line x1="330" y1="605" x2="350" y2="605" stroke="#ed8936" stroke-width="2" marker-end="url(#arrow-flow)"/>
+    <line x1="470" y1="605" x2="490" y2="605" stroke="#ed8936" stroke-width="2" marker-end="url(#arrow-flow)"/>
+    <line x1="610" y1="605" x2="630" y2="605" stroke="#ed8936" stroke-width="2" marker-end="url(#arrow-flow)"/>
+  </g>
+</svg>

data/lib/bunny_farm/.irbrc

@@ -0,0 +1,7 @@
+require 'init_bunny.rb'
+$debug = false
+
+BunnyFarm.config do
+  xyz 123
+end
+

data/lib/bunny_farm/generic_consumer.rb

@@ -0,0 +1,12 @@
+module BunnyFarm
+  class GenericConsumer < Bunny::Consumer
+
+    def cancelled?
+      @cancelled
+    end
+
+    def handle_cancellation(_)
+      @cancelled = true
+    end
+  end # class GenericConsumer < Bunny::Consumer
+end # module BunnyFarm

data/lib/bunny_farm/hash_ext.rb

@@ -0,0 +1,37 @@
+require 'active_support/core_ext/hash/keys'
+
+class Hash
+
+  # Extract a limited set of keys from a hash
+  # SMELL: this will mess up on hash entires that are arrays of hashes.
+  def tdv_extract(an_array)
+    temp_hash = {}
+    an_array.each do |s|
+      if s.is_a? Symbol
+        temp_hash[s] = self[s]
+      elsif s.is_a? Hash
+        # FIXME: Why don't we allow all the keys?
+        the_entry_name = s.keys.first
+        the_component_names = s[the_entry_name]
+        if self[the_entry_name].is_a? Hash
+          temp_hash[the_entry_name] = self[the_entry_name].tdv_extract(the_component_names)
+        elsif self[the_entry_name].is_a? Array
+          temp_hash[the_entry_name] = []
+          self[the_entry_name].each do |a|
+            temp_hash[the_entry_name] << a.tdv_extract(the_component_names)
+          end
+        elsif self[the_entry_name].is_a? NilClass
+          next
+        else
+          raise "Another Invalid entry #{the_entry_name} of #{self[the_entry_name].class}"
+        end
+      else
+        raise "Invalid entry name #{s} of class #{s.class}"
+      end
+    end
+    return temp_hash
+  end
+
+end # class Hash
+
+

data/lib/bunny_farm/init_bunny.rb

@@ -0,0 +1,137 @@
+require 'bunny'
+require 'erb'
+require 'hashie'
+require 'yaml'
+
+require_relative 'generic_consumer'
+
+module BunnyFarm
+
+  CONFIG     = Hashie::Mash.new
+
+  class << self
+
+    def config(config_file=nil, &block)
+
+      unless config_file.nil?
+        config_dir  File.dirname(config_file)
+        bunny_file  File.basename(config_file)
+      end
+
+      if block_given?
+        class_eval(&block)
+      end
+
+      default :env, 'development'
+
+      default :config_dir, File.dirname(__FILE__) + "/../../config/"
+
+      default :bunny_file, 'bunny.yml.erb'
+
+      default :bunny, Hashie::Mash.new(
+                        YAML.load(
+                          ERB.new(
+                            File.read(
+                              File.join(  CONFIG.config_dir,
+                                          CONFIG.bunny_file))).result, aliases: true))[CONFIG.env]
+
+      default :app_id, CONFIG.bunny.app_name
+
+      default :connection, Bunny.new(CONFIG.bunny).tap(&:start)
+
+      default :channel, CONFIG.connection.create_channel
+
+      default :exchange, CONFIG.channel.topic(
+                                  CONFIG.bunny.exchange_name,
+                                  :durable => true,
+                                  :auto_delete => false)
+
+      default :queue, CONFIG.channel.queue(
+                                      CONFIG.bunny.queue_name,
+                                      durable: true,
+                                      auto_delete: false,
+                                      arguments: {"x-max-length" => 1000}
+                                  ).bind(CONFIG.exchange,
+                                      :routing_key => CONFIG.bunny.routing_key)
+
+      default :control_c, false # used to signal that user hit the panic button
+
+      default :consumer_tag, 'generic_consumer'
+
+      default :no_ack,    false # false means that an acknowledgement is required
+      default :exclusive, false
+
+      # Usage: see BunnyFarm#manage
+      default :run, GenericConsumer.new(
+        CONFIG.channel,
+        CONFIG.queue,
+        CONFIG.consumer_tag,
+        CONFIG.no_ack,
+        CONFIG.exclusive
+      )
+
+      default :block, true  # set to false for background processing
+
+    end # def self.config
+
+    def default(key, value)
+      set(key, value) if CONFIG[key].nil?
+    end
+
+    def set(key, value)
+      STDERR.puts "Setting #{key} ..." if defined?($debug) && $debug
+      CONFIG[key] = value
+    end
+
+    def method_missing(method_sym, *args, &block)
+      STDERR.puts "METHOD-MISSING: #{method_sym}(#{args.join(', ')})" if defined?($debug) && $debug
+      set(method_sym, args.first)
+    end
+
+    # Usage:
+    #   BunnyFarm.manage(true)  -- manages queue in background
+    #   BunnyFarm.manage(false) -- manages queue in foreground (eg. blocks; will not return)
+    #   BunnyFarm.manage -- behavior controlled by BunnyFarm::CONFIG.block
+    def manage(background=nil)
+
+      if background.nil?
+        background = CONFIG.block
+      else
+        background = !background # Counter-intutive based on POV of block
+      end
+
+      CONFIG.run.on_delivery do |info, metadata, payload|
+        Thread.new do
+          klass   = Kernel.const_get info.routing_key.split('.').first
+          klass.new(payload, info, metadata)
+        end
+      end # BunnyFarm.run.on_delivery do
+
+      CONFIG.queue.subscribe_with( CONFIG.run, block: background )
+
+    end # def self.manage
+  end # class << self
+end # module BunnyFarm
+
+
+trap("INT") do
+  BunnyFarm::CONFIG.control_c = true
+  exit
+end
+
+# Need to clean up the smart pills -- rabbit joke
+at_exit do
+
+  if BunnyFarm::CONFIG.control_c
+    STDERR.puts 'Shutting down the BunnyFarm due to control-C request'
+  end
+
+  unless BunnyFarm::CONFIG.channel.nil?
+    BunnyFarm::CONFIG.channel.work_pool.shutdown
+    BunnyFarm::CONFIG.channel.work_pool.kill if BunnyFarm::CONFIG.channel.work_pool.running?
+    BunnyFarm::CONFIG.channel.close
+    BunnyFarm::CONFIG.connection.close
+  end
+end # at_exit do
+
+

data/lib/bunny_farm/init_hipchat.rb

@@ -0,0 +1,49 @@
+require 'erb'
+require 'hashie'
+require 'json'
+require 'net/http'
+require 'yaml'
+
+# TODO: need to make the location of the config directory
+#       a parameter
+
+HIPCHAT_CONFIG = Hashie::Mash.new(
+                    YAML.load(
+                      ERB.new(
+                        File.read(
+                          File.join(JOB_CONFIG.root, 'config/hipchat.yml.erb'))).result))[JOB_CONFIG.env]
+
+# TODO: Consider a generic Notifier base class and let
+#       HipchatNotifier inherent from it
+class HipchatNotifier
+
+  def initialize(config)
+
+    @uri = URI.parse("https://api.hipchat.com/v2/room/#{config.room}/notification?auth_token=#{config.token}")
+
+    @http = Net::HTTP.new(@uri.host, @uri.port)
+
+    @http.use_ssl = true
+
+    @request = Net::HTTP::Post.new(@uri.request_uri, {'Content-Type' => 'application/json'})
+
+  end # def initialize(config)
+
+
+  def notify(a_message)
+
+    @request.body = {
+      "notify"          => true,
+      "message_format"  => "text",
+      "message"         => "#{JOB_CONFIG.my_name} #{a_message}"
+    }.to_json
+
+    @http.request(@request)
+
+  end # def notify(a_message)
+end # class HipchatNotifier
+
+JOB_CONFIG.notifier = HipchatNotifier.new(HIPCHAT_CONFIG)
+JOB_CONFIG.log.info('Hipchat notifier has been initialized')
+
+

data/lib/bunny_farm/message.rb

@@ -0,0 +1,218 @@
+require 'json'
+
+require_relative 'message_elements'
+
+module BunnyFarm
+
+  # SNELL: why isn't this:
+  #        module Message
+  #          class Base
+  #        in keeping with the Rails pattern?
+
+  class Message
+
+    # contains the valid fields
+    attr_accessor :items
+
+    # contains all the junk sent in the JSON payload
+    attr_accessor :elements
+
+    # The JSON payload that was delivered
+    attr_accessor :payload
+
+    # The AMQP delivery information
+    attr_accessor :delivery_info
+
+    # SMELL: ClassName.new is being used as a dispatcher
+    def initialize(a_json_payload='', delivery_info=nil, metadata=nil)
+      success! # ass_u_me its gonna work
+
+      @payload        = a_json_payload
+      @delivery_info  = delivery_info
+      @metadata       = metadata
+
+      if @payload.empty?
+        return(failure 'payload was empty')
+      end
+
+      if String == @payload.class
+        begin
+          @elements = MessageElements.new( JSON.parse(@payload) )
+        rescue Exception => e
+          return(failure e)
+        end
+      elsif Hash == @payload.class
+        begin
+          @elements = MessageElements.new( @payload )
+        rescue Exception => e
+          return(failure e)
+        end
+      else
+        return(failure "payload is unknown class: #{@payload.class}")
+      end
+
+      begin
+        @items    = @elements.tdv_extract(@@item_names)
+      rescue Exception => e
+        return(failure e)
+      end
+
+
+      # SMELL: is this necessary if a hash was passed in?
+      @payload = to_json unless String == @payload.class
+
+
+      # NOTE: This is the message dispatcher
+      unless @delivery_info.nil?
+        params          = @delivery_info.routing_key.split('.')
+        job_name        = params.shift
+        action_request  = params.shift.to_sym
+
+        unless job_name == self.class.to_s
+          return(failure "Routing error; wrong job name: #{job_name} Expected: #{self.class}")
+        end
+
+        unless @@allowed_actions.include?(action_request)
+          return(failure "invalid action request: #{action_request}  Expected: #{@@allowed_actions.join(',')}")
+        end
+
+        if successful?
+          self.send(action_request, params)
+          if CONFIG.run && CONFIG.run.channel
+            CONFIG.run.channel.acknowledge( delivery_info.delivery_tag, false ) if success?
+            CONFIG.run.channel.reject( delivery_info.delivery_tag )             if failure? 
+          end
+        end
+      end # unless delivery_info.nil?
+
+    end # def initialize(a_json_payload, delivery_info=nil)
+
+
+    def publish(action='')
+      return(failure "Really? Action: '#{action.inspect}'") unless action.respond_to?(:to_s)
+      return(failure 'unspecified action') if action.empty?
+
+      action = action.to_s unless action.is_a?(String)
+
+      # NOTE: that is about all the error checking we can do in a generic
+      #       sort of way.  Had thought about checking against #allowed_actions
+      #       but realized that there may be a different job manager coordinating
+      #       different actions against the same class name.
+
+      @payload = to_json
+
+      begin
+        if CONFIG.exchange
+          CONFIG.exchange.publish(
+            @payload,
+            routing_key: "#{self.class}.#{action}",
+            app_id: CONFIG.app_id
+          )
+        else
+          failure("undefined method 'publish' for nil")
+        end
+      rescue Exception => e
+        failure(e)
+      end
+
+      success?
+    end # def publish(action=''
+
+    # some utilities
+
+    def error(a_string)
+      @errors = [] unless @errors.is_a? Array
+      @errors << "#{self.class} #{a_string}"
+      STDERR.puts "ERROR: " + @errors.last
+    end
+
+    def errors
+      @errors
+    end
+
+    def to_json
+      @items.to_json
+    end
+
+    def to_hash
+      @items
+    end
+
+    def keys
+      @items.keys
+    end
+
+
+    def [](a_key)
+      @items[a_key]
+    end
+
+    def []=(a_key,a_value)
+      @items[a_key.to_sym] = a_value
+    end
+
+    def <<(a_hash)
+      @items.merge!(a_hash.symbolize_keys)
+    end
+
+    def each(&block)
+      @items.each(&block)
+    end
+
+    # some success/failure utilities
+
+    def successful?()
+      @processing_successful
+    end
+
+    def success(result=true)
+      @processing_successful &&= result
+    end
+
+    def failure(a_string='Unknown failure')
+      error a_string
+      success(false)
+    end
+
+    def success?()
+      @processing_successful
+    end
+
+    def failure?()
+      !@processing_successful
+    end
+
+    def success!()
+      @processing_successful = true
+    end
+
+    def failure!(a_string='Unknown really bad failure')
+      error a_string
+      @processing_successful = false
+    end
+
+    # A little DSL candy
+    class << self
+
+      # SMELL: These class variables... are they of ::Message or of
+      #        its subclass?  If ::Message then that is a problem.
+      def fields(*args)
+        @@item_names = args.flatten
+      end
+
+      def actions(*args)
+        @@allowed_actions = args.flatten.map do |s|
+          s.is_a?(Symbol) ? s : s.to_sym
+        end
+      end
+
+      def item_names
+        @@item_names
+      end
+
+      def allowed_actions
+        @@allowed_actions
+      end
+    end # class << self
+  end # class Message
+end # module BunnyFarm

data/lib/bunny_farm/message_elements.rb

@@ -0,0 +1,25 @@
+require_relative 'hash_ext'
+
+class MessageElements < Hash
+
+  def initialize(*args)
+
+    super()
+
+    # SMELL: flatten _assumes_ that there is no structure
+    #        to the JSON message being handled.  Why did I
+    #        do it this way?  Might have been to ensure that
+    #        all the hash keys were symbolized.  I need a
+    #        deep symbolize_keys.
+
+    if args.size > 0
+      args.flatten.each do |a|
+        if a.is_a? Hash
+          self.merge!(a.deep_symbolize_keys)
+        else
+          self[a.to_sym]=nil
+        end
+      end # args.flatten.each do |a|
+    end # if args.size > 0
+  end # def initialize(*args)
+end # class MessageElements < Hash

data/lib/bunny_farm/version.rb

@@ -0,0 +1,3 @@
+module BunnyFarm
+  VERSION = '0.1.2'
+end

data/lib/bunny_farm.rb

@@ -0,0 +1,9 @@
+# bunny_farm.rb
+
+require "bunny_farm/version"
+require "bunny_farm/message"
+require "bunny_farm/init_bunny"
+
+module BunnyFarm
+  # BunnyFarm: where rabbits are planted ears up
+end