homeq 1.1.4

data/config/boot.rb

@@ -0,0 +1,224 @@
+#############################################################################
+#
+# Author:: Colin Steele (colin@colinsteele.org)
+# Homepage::  
+# 
+#----------------------------------------------------------------------------
+#
+#      Copyright (C) 2008 by Colin Steele. All Rights Reserved.
+#                        colin@colinsteele.org
+# 
+# This program is free software; you can redistribute it and/or modify
+# it under the terms of either: 1) the GNU General Public License
+# as published by the Free Software Foundation; either version 2 of the
+# License, or (at your option) any later version; or 2) Ruby's License.
+# 
+# See the file COPYING for complete licensing information.
+#
+#---------------------------------------------------------------------------
+#
+# 
+#############################################################################
+
+unless defined?(HOMEQ_APP_ROOT)
+  HOMEQ_APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+end
+
+module HomeQ
+  class << self
+    def boot!
+      unless booted?
+        pick_boot.init
+      end
+    end
+
+    def booted?
+      defined? HOMEQ_ROOT
+    end
+
+    def pick_boot
+      (vendor_homeq? ? VendorBoot : GemBoot).new
+    end
+
+    def vendor_homeq?
+      File.exist?("#{HOMEQ_APP_ROOT}/vendor/homeq")
+    end
+
+  end
+
+  class Boot
+
+    @config = nil
+    
+    class << self
+      attr :config, true
+    end
+    
+    attr :config, true
+
+    def set_gem_path
+      path = File.expand_path("#{File.dirname(__FILE__)}/../vendor/gems")
+      Gem.clear_paths
+      gem_paths = [path, Gem.default_dir]
+      gem_paths << APPLE_GEM_HOME if defined?(APPLE_GEM_HOME)
+      Gem.send :set_paths, gem_paths.join(":")
+    end
+    
+    def set_load_paths
+      paths = %w(
+	app
+        app/services
+        app/models
+        app/messages
+        app/messages/wire
+        lib
+        vendor
+      ).map { |d| File.join(HOMEQ_APP_ROOT, d) }
+      paths += @config['load_paths']
+      paths.reverse_each { |dir|
+        $LOAD_PATH.unshift(dir) if File.directory?(dir)
+      }
+      $LOAD_PATH.uniq!
+      ActiveSupport::Dependencies.load_paths = paths
+    end
+    def self.database_configuration
+      require 'erb'
+      YAML::load(ERB.new(IO.read(database_configuration_file)).result)
+    end
+    def self.database_configuration_file
+      File.join(HOMEQ_APP_ROOT, 'config', 'database.yml')
+    end
+    def self.database_configuration_parameters(environment = nil)
+      env = (environment || HOMEQ_ENV).to_s
+      params = @config['database_configuration'][env]
+      params = HashWithIndifferentAccess.new(params)
+      params[:user] ||= params[:username]
+      params
+    end
+    def self.establish_database_connection(environment = nil)
+      params =
+        database_configuration_parameters(environment || HOMEQ_ENV)
+      @config['sequel_database_connection'] = Sequel.connect(params)
+      silence_warnings do
+        HomeQ.const_set(:DB, self.config['sequel_database_connection'])
+      end
+      if defined?(EventedMysql)
+        params[:connections] ||= 4
+        # uncomment to see sequel logging
+        # params[:logging] = true
+        params.each { |k,v|
+          if k.is_a?(Symbol)
+            EventedMysql.settings[k] = v
+          else
+            EventedMysql.settings[k.intern] = v
+          end
+        }
+      end
+      HomeQ::DB
+    end
+    def init
+      Boot.load_rubygems
+      set_gem_path
+      load_homeq
+    end
+    def self.run
+      b = self.new
+      b.config = default_config
+      yield b.config if block_given?
+      b.load_gems
+      b.require_dependencies
+      b.set_load_paths
+      HomeQ::Boot.establish_database_connection
+    end
+    def require_dependencies
+      require 'eventmachine'
+      require 'statemachine'
+      require 'activesupport'
+      require 'sequel'
+      require_homeq_dependencies
+    end
+    def require_homeq_dependencies
+      require 'homeq/base/base'
+      require 'homeq/cp/cp'
+      require 'homeq/sobs/sobs'
+    end
+    def load_gems
+      self.config.gems.each { |name, opts|
+        if opts[:version]
+          gem(name, opts[:version])
+        else
+          gem(name)
+        end
+        require(opts[:lib] || name)
+      }
+    end
+    def self.default_config
+      require 'homeq/base/base'
+      self.config ||= HomeQ::Base::Configuration::Configuration.instance
+      self.config['database_configuration'] = database_configuration
+      self.config
+    end
+    def self.rubygems_version
+      Gem::RubyGemsVersion if defined? Gem::RubyGemsVersion
+    end
+    def self.gem_version
+      if defined? HOMEQ_GEM_VERSION
+        HOMEQ_GEM_VERSION
+      elsif ENV.include?('HOMEQ_GEM_VERSION')
+        ENV['HOMEQ_GEM_VERSION']
+      else
+        parse_gem_version(read_environment_rb)
+      end
+    end
+    def self.parse_gem_version(text)
+      $1 if text =~ /^[^#]*HOMEQ_GEM_VERSION\s*=\s*'([!~<>=]*\s*[\d.]+)'/
+    end
+    private
+    def self.read_environment_rb
+      File.read(File.expand_path("#{File.dirname(__FILE__)}/../config/environment.rb"))
+    end
+    def self.load_rubygems
+      require 'rubygems'
+      
+      unless rubygems_version >= '0.9.4'
+        $stderr.puts %(Homeq requires RubyGems >= 0.9.4 (you have #{rubygems_version}). Please `gem update --system` and try again.)
+        exit 1
+      end
+      
+    rescue LoadError
+      $stderr.puts %(Homeq requires RubyGems >= 0.9.4. Please install RubyGems and try again: http://rubygems.rubyforge.org)
+      exit 1
+    end
+  end
+
+  class VendorBoot < Boot
+    def load_homeq
+      path = File.expand_path("#{File.dirname(__FILE__)}/../vendor/homeq/lib/homeq")
+      require path
+    end
+  end
+
+  class GemBoot < Boot
+    def load_homeq
+      load_homeq_gem
+    end
+
+    def load_homeq_gem
+      if version = self.class.gem_version
+        gem 'homeq', version
+      else
+        gem 'homeq'
+      end
+      require 'homeq'
+    rescue Gem::LoadError => load_error
+      $stderr.puts %(#{load_error})
+      $stderr.puts %(Missing the HomeQ #{version} gem or a prerequisite?)
+      $stderr.puts %(program requires version #{version} of homeq)
+      exit 1
+    end
+
+  end
+end
+
+# All that for this:
+HomeQ.boot!

data/config/databases/frontbase.yml

@@ -0,0 +1,28 @@
+# FrontBase versions 4.x
+#
+# Get the bindings:
+#   gem install ruby-frontbase
+
+development:
+  adapter: frontbase
+  host: localhost
+  database: <%= app_name %>_development
+  username: <%= app_name %>
+  password: ''
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: frontbase
+  host: localhost
+  database: <%= app_name %>_test
+  username: <%= app_name %>
+  password: ''
+
+production:
+  adapter: frontbase
+  host: localhost
+  database: <%= app_name %>_production
+  username: <%= app_name %>
+  password: ''

data/config/databases/mysql.yml

@@ -0,0 +1,54 @@
+# MySQL.  Versions 4.1 and 5.0 are recommended.
+#
+# Install the MySQL driver:
+#   gem install mysql
+# On Mac OS X:
+#   sudo gem install mysql -- --with-mysql-dir=/usr/local/mysql
+# On Mac OS X Leopard:
+#   sudo env ARCHFLAGS="-arch i386" gem install mysql -- --with-mysql-config=/usr/local/mysql/bin/mysql_config
+#       This sets the ARCHFLAGS environment variable to your native architecture
+# On Windows:
+#   gem install mysql
+#       Choose the win32 build.
+#       Install MySQL and put its /bin directory on your path.
+#
+# And be sure to use new-style password hashing:
+#   http://dev.mysql.com/doc/refman/5.0/en/old-client.html
+development:
+  adapter: mysql
+  encoding: utf8
+  database: <%= app_name %>_development
+  username: root
+  password:
+<% if socket -%>
+  socket: <%= socket %>
+<% else -%>
+  host: localhost
+<% end -%>
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: mysql
+  encoding: utf8
+  database: <%= app_name %>_test
+  username: root
+  password:
+<% if socket -%>
+  socket: <%= socket %>
+<% else -%>
+  host: localhost
+<% end -%>
+
+production:
+  adapter: mysql
+  encoding: utf8
+  database: <%= app_name %>_production
+  username: root
+  password: 
+<% if socket -%>
+  socket: <%= socket %>
+<% else -%>
+  host: localhost
+<% end -%>

data/config/databases/oracle.yml

@@ -0,0 +1,39 @@
+# Oracle/OCI 8i, 9, 10g
+#
+# Requires Ruby/OCI8:
+#  http://rubyforge.org/projects/ruby-oci8/
+#
+# Specify your database using any valid connection syntax, such as a
+# tnsnames.ora service name, or a SQL connect url string of the form:
+#
+#   //host:[port][/service name]
+#
+# By default prefetch_rows (OCI_ATTR_PREFETCH_ROWS) is set to 100. And
+# until true bind variables are supported, cursor_sharing is set by default
+# to 'similar'. Both can be changed in the configation below; the defaults
+# are equivalent to specifying:
+#
+#  prefetch_rows: 100
+#  cursor_sharing: similar
+#
+
+development:
+  adapter: oracle
+  database: <%= app_name %>_development
+  username: <%= app_name %>
+  password:
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: oracle
+  database: <%= app_name %>_test
+  username: <%= app_name %>
+  password:
+
+production:
+  adapter: oracle
+  database: <%= app_name %>_production
+  username: <%= app_name %>
+  password: 

data/config/databases/postgresql.yml

@@ -0,0 +1,48 @@
+# PostgreSQL. Versions 7.4 and 8.x are supported.
+#
+# Install the ruby-postgres driver:
+#   gem install ruby-postgres
+# On Mac OS X:
+#   gem install ruby-postgres -- --include=/usr/local/pgsql
+# On Windows:
+#   gem install ruby-postgres
+#       Choose the win32 build.
+#       Install PostgreSQL and put its /bin directory on your path.
+development:
+  adapter: postgresql
+  encoding: unicode
+  database: <%= app_name %>_development
+  username: <%= app_name %>
+  password:
+
+  # Connect on a TCP socket. Omitted by default since the client uses a
+  # domain socket that doesn't need configuration. Windows does not have
+  # domain sockets, so uncomment these lines.
+  #host: localhost
+  #port: 5432
+
+  # Schema search path. The server defaults to $user,public
+  #schema_search_path: myapp,sharedapp,public
+
+  # Minimum log levels, in increasing order:
+  #   debug5, debug4, debug3, debug2, debug1,
+  #   log, notice, warning, error, fatal, and panic
+  # The server defaults to notice.
+  #min_messages: warning
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: postgresql
+  encoding: unicode
+  database: <%= app_name %>_test
+  username: <%= app_name %>
+  password:
+
+production:
+  adapter: postgresql
+  encoding: unicode
+  database: <%= app_name %>_production
+  username: <%= app_name %>
+  password:

data/config/databases/sqlite2.yml

@@ -0,0 +1,16 @@
+# SQLite version 2.x
+#   gem install sqlite-ruby
+development:
+  adapter: sqlite
+  database: db/development.sqlite2
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite
+  database: db/test.sqlite2
+
+production:
+  adapter: sqlite
+  database: db/production.sqlite2

data/config/databases/sqlite3.yml

@@ -0,0 +1,19 @@
+# SQLite version 3.x
+#   gem install sqlite3-ruby (not necessary on OS X Leopard)
+development:
+  adapter: sqlite3
+  database: db/development.sqlite3
+  timeout: 5000
+
+# Warning: The database defined as "test" will be erased and
+# re-generated from your development database when you run "rake".
+# Do not set this db to the same as development or production.
+test:
+  adapter: sqlite3
+  database: db/test.sqlite3
+  timeout: 5000
+
+production:
+  adapter: sqlite3
+  database: db/production.sqlite3
+  timeout: 5000

data/config/environment.rb

@@ -0,0 +1,20 @@
+# Uncomment below to force HomeQ into production mode
+# ENV['HOMEQ_ENV'] ||= 'production'
+
+# Uncomment below to force a gem load path
+# ENV['GEM_PATH'] = '/some/place:/some/other/place'
+
+# Specifies gem version of HomeQ to use when vendor/homeq is not present
+HOMEQ_GEM_VERSION = '1.1.3' unless defined? HOMEQ_GEM_VERSION
+
+# Bootstrap the Homeq framework
+require File.join(File.dirname(__FILE__), 'boot')
+
+HomeQ::Boot.run { |config|
+
+  # Put your intialization configuration here
+
+  # Configure gem versions here
+  # config.gem "foo", :version => '=1.1.1'
+  
+}

data/config/environments/development.cfg

@@ -0,0 +1,35 @@
+###### CONTROL PORTS ######
+
+# In dev, all of this runs on localhost, so we need different control
+# ports
+
+raise "No queue name set; -q on command line, or in config file" if !queue_name
+ports = {}
+QUEUES.each_with_index { |name, i|
+  ports[name] = CP_BASE_PORT + i
+}
+cp_port ports[queue_name]
+
+###### QUEUE CONNECTION GRAPH ######
+
+topology {
+
+  # Homes - this tells us where a given queue's process runs (a la
+  # hostname), and which host/port it listens on for connections.
+
+  hostname = `hostname`.chomp
+  QUEUES.each_with_index { |name, i|
+    queue(name) { |q|
+      q.located_at('localhost', QUEUE_BASE_PORT + i, hostname)
+    }
+  }
+
+  # Connections
+
+  queue('producer') {
+    writes_to('holder')
+  }
+  queue('consumer') {
+    reads_from('holder')
+  }
+}

data/config/environments/production.cfg

@@ -0,0 +1,35 @@
+###### CONTROL PORTS ######
+
+# In dev, all of this runs on localhost, so we need different control
+# ports
+
+raise "No queue name set; -q on command line, or in config file" if !queue_name
+ports = {}
+QUEUES.each_with_index { |name, i|
+  ports[name] = CP_BASE_PORT + i
+}
+cp_port ports[queue_name]
+
+###### QUEUE CONNECTION GRAPH ######
+
+topology {
+
+  # Homes - this tells us where a given queue's process runs (a la
+  # hostname), and which host/port it listens on for connections.
+
+  hostname = `hostname`.chomp
+  QUEUES.each_with_index { |name, i|
+    queue(name) { |q|
+      q.located_at('localhost', QUEUE_BASE_PORT + i, hostname)
+    }
+  }
+
+  # Connections
+
+  queue('producer') {
+    writes_to('holder')
+  }
+  queue('consumer') {
+    reads_from('holder')
+  }
+}

data/config/environments/test.cfg

@@ -0,0 +1,35 @@
+###### CONTROL PORTS ######
+
+# In dev, all of this runs on localhost, so we need different control
+# ports
+
+raise "No queue name set; -q on command line, or in config file" if !queue_name
+ports = {}
+QUEUES.each_with_index { |name, i|
+  ports[name] = CP_BASE_PORT + i
+}
+cp_port ports[queue_name]
+
+###### QUEUE CONNECTION GRAPH ######
+
+topology {
+
+  # Homes - this tells us where a given queue's process runs (a la
+  # hostname), and which host/port it listens on for connections.
+
+  hostname = `hostname`.chomp
+  QUEUES.each_with_index { |name, i|
+    queue(name) { |q|
+      q.located_at('localhost', QUEUE_BASE_PORT + i, hostname)
+    }
+  }
+
+  # Connections
+
+  queue('producer') {
+    writes_to('holder')
+  }
+  queue('consumer') {
+    reads_from('holder')
+  }
+}

data/config/generators/job/templates/job.rb.erb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+module <%= service_name.camelize %>Service
+  class Job < HomeQ::SOBS::Job
+    include HomeQ
+    @jobs = 0
+    class << self
+      attr :jobs, true
+    end
+    def initialize(message, queue)
+      super(message, queue)
+      Job.jobs += 1
+    end
+    def run
+      super
+    end
+  end
+end
+
+

data/config/generators/message/templates/messages/MESSAGE.proto.erb

@@ -0,0 +1,12 @@
+package wire;
+
+message <%= message_name.camelize %> {
+ <%- if task.args -%>
+  <%- task.args[1..-1].each_with_index do |tuple,i| %>
+   <%- tuple = tuple.split(':') %>
+   <%- required = ((tuple[2] || '') =~ /yes|true|required|on/i) %>
+   <%= required ? 'required' : 'optional' %> <%= tuple[1] %> <%= tuple[0] %> = <%= i + 1 %>;
+  <% end %> 
+ <%- end -%>
+}
+

data/config/generators/model/templates/models/MODEL.rb.erb

@@ -0,0 +1,3 @@
+class <%= model_name.camelize %> < ActiveRecord::Base
+  
+end

data/config/generators/service/templates/services/SERVICE.rb.erb

@@ -0,0 +1,43 @@
+#!/usr/bin/env ruby
+
+##############################################################################
+#
+# <%= service_name %>
+#
+##############################################################################
+
+require File.join(File.dirname(__FILE__), '../../config/environment')
+
+# Gives us easy access to log, system and config.
+include HomeQ
+
+#############################################################################
+# Command line options
+#############################################################################
+
+parser = HomeQ::Base::Options::Options.instance.parser
+options = HomeQ::Base::Options::Options.instance.options
+
+# Service specific options setup goes here
+## 
+## parser.separator ""
+## parser.separator "<%= service_name %> specific options:"
+##
+## options.<%= service_name %>_frob = 'localhost'
+## parser.on("--<%= service_name %>-frob FOO",
+##           "frobnitz; defaults to #{options.<%= service_name %>_frob}") { |o|
+##  options.<%= service_name %>_frob = o
+## }
+
+#############################################################################
+# Prep for and run HQ
+#############################################################################
+
+sys.start {
+  # Install our handler for jobs we get on our home queue
+  sys.handlers[config.queue_name] = <%= service_name.camelize %>Service::Job
+  logger.info {
+    "Queue #{config.queue_name} handled by #{<%= service_name.camelize %>Service::Job}"
+  }
+}
+

data/config/homeq.cfg

@@ -0,0 +1,35 @@
+###### BASIC CONFIGURATION ######
+
+QUEUES = %w(holder producer consumer)
+queue_retry 10 # client queue connections retried after this long
+
+###### LOGGING ######
+
+# I think this makes things more readable.
+
+log_id queue_name
+
+# Uncomment the next line to send logging to syslog
+#
+# syslog
+
+# Uncomment the next line to change the log level, which is also
+# overidden using command line -vvv
+#
+# Levels are: DEBUG4 DEBUG3 DEBUG2 DEBUG1 DEBUG INFO WARN ERROR FATAL
+#
+# log_level "DEBUG"
+
+# Now go and read HOMEQ_ENV-specific configuration.  Usually an
+# env-specific config file will have a queue topology suited to the
+# host(s) it runs on.  Eg., a development topology will have queues
+# all running on the same machine.
+
+CP_BASE_PORT = 26000
+QUEUE_BASE_PORT = 25000
+
+conf_dir = File.join(HOMEQ_APP_ROOT, 'config')
+config.read_config_file(File.join(conf_dir,
+                                  'environments',
+                                  "#{HOMEQ_ENV}.cfg"))
+