baton 0.4.10 → 0.5.2

data/README.md

@@ -62,6 +62,7 @@ Any baton extension should have an executable script that will start the extensi
 ### Service
 
 The Service is the starting point of any baton extension. The idea of the service is to setup consumers for the input messages arriving from the API. By implementing `setup_consumers` one will allow the consumers to receive messages. [Here](https://github.com/digital-science/baton-ping/blob/master/lib/baton/baton-ping.rb) is an example.
+The service also handles daemonizing for an extension. It will properly detach the process and take care of managing pid files and optionally log files. The configuration for pid and log files is commented out in the sample config.
 
 ### Consumer Manager
 

data/baton.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |gem|
   gem.version       = Baton::VERSION
 
   gem.add_runtime_dependency "amqp", "~> 0.9.7"
+  gem.add_runtime_dependency "amq-client", "~> 0.9.9"
   gem.add_runtime_dependency "eventmachine", "~> 1.0.0"
   gem.add_runtime_dependency "em-http-request", "1.0.3"
   gem.add_runtime_dependency "bunny", "~> 0.8.0"

data/lib/baton/configuration.rb

@@ -5,7 +5,7 @@ module Baton
   class Configuration
     include Baton::Logging
 
-    attr_accessor :config, :host, :vhost, :user, :password, :amqp_host_list
+    attr_accessor :config, :host, :vhost, :user, :password, :amqp_host_list, :heartbeat
 
     def initialize
       @config = {}
@@ -76,9 +76,10 @@ module Baton
       self.host      = rabbit_hosts[Kernel.rand(rabbit_hosts.size)]
       self.amqp_host_list = rabbit_hosts
 
-      self.vhost    = config["RABBIT_VHOST"]
-      self.user     = config["RABBIT_USER"]
-      self.password = config["RABBIT_PASS"]
+      self.vhost     = config["RABBIT_VHOST"]
+      self.user      = config["RABBIT_USER"]
+      self.password  = config["RABBIT_PASS"]
+      self.heartbeat = config.fetch("RABBIT_HEARTBEAT", 60).to_i
     end
 
     # Public: Defines the connection options for RabbitMQ as a Hash.
@@ -90,7 +91,14 @@ module Baton
     #
     # Returns a hash of RabbitMQ connection options.
     def connection_opts
-      {:host => host, :vhost => vhost, :user => user, :password => password, :pass => password}.delete_if{|k,v| v.nil?}
+      {
+        :host => host, 
+        :vhost => vhost, 
+        :user => user, 
+        :password => password, 
+        :pass => password,
+        :heartbeat => heartbeat
+      }.delete_if{|k,v| v.nil?}
     end
   end
 end

data/lib/baton/service.rb

@@ -11,24 +11,80 @@ module Baton
   class Service
     include Baton::Logging
 
-    attr_accessor :server, :channel
+    attr_accessor :server, :channel, :daemonize
 
     # Public: Initialize a Service. Sets up a new server for this service.
-    def initialize
+    def initialize(daemonize=false)
       @server = Baton::Server.new
+      @daemonize = daemonize
+      @pid_file = Baton.configuration.pid_file || "/var/run/baton.pid"
+      Baton::Logging.logger = Baton.configuration.log_file || STDOUT
     end
 
     # Public: Method that starts the service.
     #
     # Returns nothing.
-    def run
+    def go
       logger.info "Starting Baton v#{Baton::VERSION}"
       EM.run do
+        Signal.trap('INT') { stop }
+        Signal.trap('TERM'){ stop }
         @channel = Baton::Channel.new
         setup_consumers
       end
     end
 
+    def run
+      if @daemonize
+        pid = get_pid
+
+        if pid != 0 
+          logger.error "Baton is already running! (PID: #{pid})"
+          exit -1
+        end
+
+        pid = fork { go }
+
+        begin
+          File.open(@pid_file, "w") { |f| f.write pid }
+          Process.detach(pid)
+        rescue => exc
+          Process.kill('TERM', pid)
+          logger.error "Couldn't daemonize: #{exc.message}"
+        end
+      else
+        go
+      end
+    end
+
+    def stop
+      if @daemonize
+        pid = get_pid
+        begin
+          EM.stop
+        rescue
+        end
+
+        if pid != 0
+          Process.kill('HUP', pid.to_i)
+          File.delete(@pid_file)
+          logger.info "Stopped"
+        else
+          logger.warn "Daemon not running"
+          exit -1
+        end
+      else
+        EM.stop
+      end
+    end
+
+    # Get the PID of the running daemon
+    #
+    # Returns the PID of the daemon
+    def get_pid
+      File.exists?(@pid_file) ? File.read(@pid_file).strip : 0
+    end
+
     # Public: Method that allows implementations to setup new consumers
     # depending on their needs. An example would be add a deploy consumer
     # which will listen to deploy messages. For each consumer, add_consumer

data/lib/baton/templates/gem/bin/gem-monitor.tt

@@ -1,9 +1,26 @@
 #!/usr/bin/env ruby
 
 require "baton/<%= config[:name] %>/<%= config[:name] %>-monitor"
+require 'optparse'
+
+cfg = File.expand_path("../../config/<%= config[:name] %>.cfg", __FILE__)
+
+OptionParser.new do |opt|
+  opt.banner = "Usage: <%= config[:name] %> [OPTIONS]"
+  opt.separator ""
+  opt.separator "Specific options:"
+  opt.on("-c","--config-file [PATH]", "Path to a baton config file") do |o|
+    cfg = o
+  end
+  opt.on_tail("-h", "--help", "Show this message") do
+    puts opt
+    exit
+  end
+end.parse!
 
 Baton.configure do |c|
-  c.config_path  = "<%= File.join(Dir.pwd, config[:name], 'config', config[:name]) %>.cfg"
+  c.config_path  = cfg
+  c.exchange     = "<%= config[:name] %>_in"
   c.exchange_out = "<%= config[:name] %>_out"
 end
 

data/lib/baton/templates/gem/bin/gem.tt

@@ -1,11 +1,31 @@
 #!/usr/bin/env ruby
 
 require 'baton/<%= config[:name] %>'
+require 'optparse'
+
+cfg = File.expand_path("../../config/<%= config[:name] %>.cfg", __FILE__)
+daemonize = false
+
+OptionParser.new do |opt|
+  opt.banner = "Usage: <%= config[:name] %> [OPTIONS]"
+  opt.separator ""
+  opt.separator "Specific options:"
+  opt.on("-c","--config-file [PATH]", "Path to a baton config file") do |o|
+    cfg = o
+  end
+  opt.on("-d","--daemonize", "Should baton daemonize") do |o|
+    daemonize = o
+  end
+  opt.on_tail("-h", "--help", "Show this message") do
+    puts opt
+    exit
+  end
+end.parse!
 
 Baton.configure do |c|
-  c.config_path  = "<%= File.join(Dir.pwd, config[:name], 'config', config[:name]) %>.cfg"
+  c.config_path  = cfg
   c.exchange     = "<%= config[:name] %>_in"
   c.exchange_out = "<%= config[:name] %>_out"
 end
 
-Baton::<%= config[:constant_array].last %>Service.new.run
+Baton::<%= config[:constant_array].last %>Service.new(daemonize).run

data/lib/baton/templates/gem/config/gem.cfg.tt

@@ -2,3 +2,6 @@ RABBIT_HOST: localhost
 RABBIT_VHOST: 
 RABBIT_USER: guest
 RABBIT_PASS: guest
+#for daemonising applications
+#PID_FILE: /var/run/<%=config[:name]%>.pid
+#LOG_FILE: /var/log/<%=config[:name]%>.log

data/lib/baton/version.rb

@@ -1,3 +1,3 @@
 module Baton
-  VERSION = "0.4.10"
+  VERSION = "0.5.2"
 end

data/spec/baton/configuration_spec.rb

@@ -23,6 +23,10 @@ describe Baton::Configuration do
       it "will set the password" do
         subject.password.should eq("fromconfigpass")
       end
+
+      it "will set the heartbeat" do
+        subject.heartbeat.should eq(666)
+      end
     end
 
     context "given a non existing file" do
@@ -40,14 +44,27 @@ describe Baton::Configuration do
 
     context "give a config file" do
       it "will return a config hash" do
-        subject.connection_opts.should eq({:host=>"fromconfig.com", :vhost=>"fromconfig", :user=>"fromconfiguser", :password=>"fromconfigpass", :pass=>"fromconfigpass"})
+        subject.connection_opts.should eq({
+          :host=>"fromconfig.com", 
+          :vhost=>"fromconfig", 
+          :user=>"fromconfiguser", 
+          :password=>"fromconfigpass", 
+          :pass=>"fromconfigpass",
+          :heartbeat=>666
+        })
       end
     end
 
     context "given one of the configuration options is nil" do
       it "will not be returned in the config hash" do
         subject.vhost = nil
-        subject.connection_opts.should eq({:host=>"fromconfig.com", :user=>"fromconfiguser", :password=>"fromconfigpass", :pass=>"fromconfigpass"})
+        subject.connection_opts.should eq({
+          :host=>"fromconfig.com", 
+          :user=>"fromconfiguser", 
+          :password=>"fromconfigpass", 
+          :pass=>"fromconfigpass",
+          :heartbeat=>666
+        })
       end
     end
   end
@@ -67,5 +84,9 @@ describe Baton::Configuration do
       subject.amqp_host_list.should eq(["fromconfig.com", "moreconfig.com", "thirdconfig.com"])
     end
 
+    it "will default the heartbeat to 60" do
+      subject.heartbeat.should eq(60)
+    end
+
   end
 end

data/spec/fixtures/config.cfg

@@ -1,4 +1,5 @@
 RABBIT_HOST: fromconfig.com
 RABBIT_VHOST: fromconfig
 RABBIT_USER: fromconfiguser
-RABBIT_PASS: fromconfigpass
+RABBIT_PASS: fromconfigpass
+RABBIT_HEARTBEAT: 666

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: baton
 version: !ruby/object:Gem::Version
-  version: 0.4.10
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,11 +10,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-10-01 00:00:00.000000000 Z
+date: 2013-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: amqp
-  requirement: &70300266385460 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,31 @@ dependencies:
         version: 0.9.7
   type: :runtime
   prerelease: false
-  version_requirements: *70300266385460
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.7
+- !ruby/object:Gem::Dependency
+  name: amq-client
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.9
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70300266384960 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,21 +54,31 @@ dependencies:
         version: 1.0.0
   type: :runtime
   prerelease: false
-  version_requirements: *70300266384960
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: em-http-request
-  requirement: &70300266384500 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 1.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *70300266384500
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
 - !ruby/object:Gem::Dependency
   name: bunny
-  requirement: &70300266384040 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,10 +86,15 @@ dependencies:
         version: 0.8.0
   type: :runtime
   prerelease: false
-  version_requirements: *70300266384040
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: ohai
-  requirement: &70300266383580 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -66,10 +102,15 @@ dependencies:
         version: 0.6.12
   type: :runtime
   prerelease: false
-  version_requirements: *70300266383580
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.12
 - !ruby/object:Gem::Dependency
   name: thor
-  requirement: &70300266383200 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -77,10 +118,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70300266383200
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70300266382660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +134,15 @@ dependencies:
         version: '2.7'
   type: :development
   prerelease: false
-  version_requirements: *70300266382660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.7'
 - !ruby/object:Gem::Dependency
   name: moqueue
-  requirement: &70300266382160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -99,10 +150,15 @@ dependencies:
         version: 0.1.4
   type: :development
   prerelease: false
-  version_requirements: *70300266382160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.4
 - !ruby/object:Gem::Dependency
   name: fakefs
-  requirement: &70300266381700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -110,10 +166,15 @@ dependencies:
         version: 0.4.0
   type: :development
   prerelease: false
-  version_requirements: *70300266381700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.4.0
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70300266381240 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -121,10 +182,15 @@ dependencies:
         version: 0.9.2
   type: :development
   prerelease: false
-  version_requirements: *70300266381240
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70300266380780 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -132,29 +198,44 @@ dependencies:
         version: 1.8.7
   type: :development
   prerelease: false
-  version_requirements: *70300266380780
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.7
 - !ruby/object:Gem::Dependency
   name: minitar
-  requirement: &70300266380320 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.5.3
   type: :development
   prerelease: false
-  version_requirements: *70300266380320
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.5.3
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70300266379860 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - =
+    - - '='
       - !ruby/object:Gem::Version
         version: 0.6.4
   type: :development
   prerelease: false
-  version_requirements: *70300266379860
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.6.4
 description: Baton
 email:
 - johnog@gmail.com
@@ -227,7 +308,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -208704398013789747
+      hash: 1528221756626291784
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -236,10 +317,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -208704398013789747
+      hash: 1528221756626291784
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.11
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: Baton