officer 0.3.3 → 0.4.0

data/README.markdown

@@ -9,11 +9,24 @@ It is implemented using Ruby and Eventmachine. Inspiration comes from [elock](ht
 
 ## Usage
 
+Officer uses the 'daemons' gem to simplify creating long lived background processes.
+Here are some simple examples in case you aren't familiar with it.
+
+'daemons' help information:
     sudo officer --help
-    sudo officer start
 
-- The server listens on 0.0.0.0:11500 by default.  In the future this should be configurable.
-- All debugging output goes to stdout for now.  Use 'sudo officer run' to see it.
+Officer's help information:
+    sudo officer run -- --help
+
+Run Officer in the foreground with verbose mode enabled (useful for debugging):
+    sudo officer run -- -v
+
+Run Officer in the background (production mode) and listen on a specific IP and port:
+    sudo officer start -- -h 127.0.0.1 -p 9999
+
+- The server listens on 0.0.0.0:11500 by default.
+- All debugging and error output goes to stdout for now.  The daemons gem is configured to log stdout.
+- The daemons gem will create a PID file in /var/run and log files in /var/log when using the 'start' option for background mode.
 
 ## Ruby Client
 

data/Rakefile

@@ -14,6 +14,7 @@ begin
     gem.add_development_dependency "json", ">= 0"
     gem.add_development_dependency "activesupport", ">= 0"
     gem.add_development_dependency "daemons", ">= 0"
+    gem.add_development_dependency "choice", ">= 0"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
   Jeweler::GemcutterTasks.new

data/VERSION

@@ -1 +1 @@
-0.3.3
+0.4.0

data/bin/officer

@@ -3,13 +3,45 @@
 require 'rubygems'
 require 'officer'
 
-options = {
+daemon_options = {
   :dir_mode   => :system,
   :multiple   => false,
-  :monitor    => true
+  :monitor    => true,
+  :log_output => true
 }
 
+def parse_command_line
+  if ARGV.include? '--'
+    ARGV.slice! 0..ARGV.index('--')
+  end
 
-Daemons.run_proc('officer', options) do
-  Officer::Server.new.run
+  Choice.options do
+    option :host do
+      short '-h'
+      long '--host=HOST'
+      desc 'The hostname or IP to bind to (default: 0.0.0.0)'
+    end
+
+    option :port do
+      short '-p'
+      long '--port=PORT'
+      desc 'The port to listen on (default: 11500)'
+      cast Integer
+    end
+
+    option :verbose do
+      short '-v'
+      long '--verbose'
+      desc 'Print lock information to stdout every five seconds (default: off)'
+    end
+
+    option :help do
+      long '--help'
+    end
+  end
+end
+
+Daemons.run_proc('officer', daemon_options) do
+  parse_command_line
+  Officer::Server.new(Choice.choices).run
 end

data/lib/officer/log.rb

@@ -21,6 +21,7 @@ module Officer
       debug e
       debug e.backtrace.join "\n  "
       debug '-----'
+      debug "ARGV: #{ARGV.inspect}"
     end
 
   private

data/lib/officer/server.rb

@@ -2,10 +2,11 @@ module Officer
 
   class Server
     def initialize options={}
-      options.reverse_merge! :port => 11500, :host => '0.0.0.0'
+      options.reverse_merge! :port => 11500, :host => '0.0.0.0', :verbose => false
 
       @port = options[:port]
       @host = options[:host]
+      @verbose = options[:verbose]
     end
 
     def run
@@ -14,8 +15,10 @@ module Officer
       end
     
       EM::run do
-        EM::PeriodicTimer.new(5) do
-          Officer::LockStore.instance.log_state
+        if @verbose
+          EM::PeriodicTimer.new(5) do
+            Officer::LockStore.instance.log_state
+          end
         end
         
         EM::start_server @host, @port, Connection::Connection

data/lib/officer.rb

@@ -8,6 +8,7 @@ require 'active_support'
 require 'eventmachine'
 require 'json'
 require 'daemons'
+require 'choice'
 
 # Application.
 require 'officer/log'

data/officer.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{officer}
-  s.version = "0.3.3"
+  s.version = "0.4.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chad Remesch"]
-  s.date = %q{2010-02-10}
+  s.date = %q{2010-02-11}
   s.default_executable = %q{officer}
   s.description = %q{Distributed lock server and client written in Ruby and EventMachine}
   s.email = %q{chad@remesch.com}
@@ -56,17 +56,20 @@ Gem::Specification.new do |s|
       s.add_development_dependency(%q<json>, [">= 0"])
       s.add_development_dependency(%q<activesupport>, [">= 0"])
       s.add_development_dependency(%q<daemons>, [">= 0"])
+      s.add_development_dependency(%q<choice>, [">= 0"])
     else
       s.add_dependency(%q<eventmachine>, [">= 0"])
       s.add_dependency(%q<json>, [">= 0"])
       s.add_dependency(%q<activesupport>, [">= 0"])
       s.add_dependency(%q<daemons>, [">= 0"])
+      s.add_dependency(%q<choice>, [">= 0"])
     end
   else
     s.add_dependency(%q<eventmachine>, [">= 0"])
     s.add_dependency(%q<json>, [">= 0"])
     s.add_dependency(%q<activesupport>, [">= 0"])
     s.add_dependency(%q<daemons>, [">= 0"])
+    s.add_dependency(%q<choice>, [">= 0"])
   end
 end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: officer
 version: !ruby/object:Gem::Version 
-  version: 0.3.3
+  version: 0.4.0
 platform: ruby
 authors: 
 - Chad Remesch
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-10 00:00:00 -05:00
+date: 2010-02-11 00:00:00 -05:00
 default_executable: officer
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,6 +52,16 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: "0"
     version: 
+- !ruby/object:Gem::Dependency 
+  name: choice
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
 description: Distributed lock server and client written in Ruby and EventMachine
 email: chad@remesch.com
 executables: