officer 0.9.2 → 0.10.0

data/.gitignore

@@ -0,0 +1,16 @@
+coverage
+rdoc
+doc
+.yardoc
+.bundle
+pkg
+.DS_Store
+*.tmproj
+tmtags
+*~
+\#*
+.\#*
+*.swp
+*.rbc
+.rvmrc
+.project

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in officer.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    officer (0.10.0)
+      choice
+      daemons
+      eventmachine
+      json
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    choice (0.1.6)
+    daemons (1.1.8)
+    diff-lcs (1.1.3)
+    eventmachine (0.12.10)
+    json (1.7.3)
+    rake (0.9.2.2)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  officer!
+  rake
+  rspec

data/LICENSE

@@ -1,4 +1,6 @@
-Copyright (c) 2010 Chad Remesch
+Copyright (c) 2012 Chad Remesch
+
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -1,46 +1,34 @@
-require 'rubygems'
-require 'rake'
-
-require 'jeweler'
-Jeweler::Tasks.new do |gem|
-  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
-  gem.name = "officer"
-  gem.homepage = "http://github.com/chadrem/officer"
-  gem.license = "MIT"
-  gem.summary = %Q{Ruby lock server and client built on EventMachine.}
-  gem.description = %Q{Officer is designed to help you coordinate distributed processes and avoid race conditions.}
-  gem.email = "chad@remesch.com"
-  gem.authors = ["Chad Remesch"]
-  # Include your dependencies below. Runtime dependencies are required when using your gem,
-  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
-  # gem.add_development_dependency 'rspec', '2.4.0'
-  gem.add_dependency "eventmachine", ">= 0"
-  gem.add_dependency "json", ">= 0"
-  gem.add_dependency "daemons", ">= 0"
-  gem.add_dependency "choice", ">= 0"
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
 
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
 end
-Jeweler::RubygemsDotOrgTasks.new
 
-require 'rspec/core'
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |spec|
-  spec.pattern = FileList['spec/**/*_spec.rb']
-end
+task :default => :spec
 
-RSpec::Core::RakeTask.new(:rcov) do |spec|
-  spec.pattern = 'spec/**/*_spec.rb'
-  spec.rcov = true
-end
+desc 'Start an IRB console with offier loaded'
+task :console do
+  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
 
-task :default => :spec
+  require 'officer'
+  require 'irb'
+
+  ARGV.clear
 
-require 'rake/rdoctask'
-Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  IRB.start
+end
 
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "officer #{version}"
-  rdoc.rdoc_files.include('README*')
-  rdoc.rdoc_files.include('lib/**/*.rb')
+desc 'Run all specs'
+task :spec do
+  puts 'Running rspec:'
+  system 'rspec spec'
 end
+
+task :default => :spec

data/lib/officer/client.rb

@@ -1,9 +1,3 @@
-require 'socket'
-require 'fcntl'
-
-require 'rubygems'
-require 'json'
-
 module Officer
 
   class GenericError < RuntimeError; end
@@ -12,6 +6,7 @@ module Officer
   class LockTimeoutError < LockError; end
   class LockQueuedMaxError < LockError; end
   class UnlockError < GenericError; end
+  class SocketResponseError < GenericError; end
 
   class Client
     def initialize options={}
@@ -20,6 +15,10 @@ module Officer
       @host = options[:host] || 'localhost'
       @port = options[:port] || 11500
       @namespace = options[:namespace]
+      @keep_alive_freq = options[:keep_alive_freq] || 6 # Hz.
+      @keep_alive_enabled = options.include?(:keep_alive_enabled) ? options[:keep_alive_enabled] : true
+      @thread = nil
+      @lock = Mutex.new
 
       connect
     end
@@ -27,22 +26,43 @@ module Officer
     def reconnect
       disconnect
       connect
+
+      self
     end
 
     def disconnect
-      @socket.close if @socket
-      @socket = nil
+      @lock.synchronize do
+        @thread.terminate if @thread
+        @thread = nil
+
+        @socket.close if @socket
+        @socket = nil
+      end
+
+      self
     end
 
     def lock name, options={}
       result = execute :command => 'lock', :name => name_with_ns(name),
         :timeout => options[:timeout], :queue_max => options[:queue_max]
       strip_ns_from_hash result, 'name'
+
+      if result['name'] != name || !%w(acquired already_acquired timed_out queue_maxed).include?(result['result'])
+        force_shutdown
+      end
+
+      result
     end
 
     def unlock name
       result = execute :command => 'unlock', :name => name_with_ns(name)
       strip_ns_from_hash result, 'name'
+
+      if result['name'] != name || !%w(released release_failed).include?(result['result'])
+        force_shutdown
+      end
+
+      result
     end
 
     def with_lock name, options={}
@@ -66,44 +86,85 @@ module Officer
     end
 
     def reset
-      execute :command => 'reset'
+      result = execute :command => 'reset'
+
+      if result['result'] != 'reset_succeeded'
+        force_shutdown
+      end
+
+      result
     end
 
     def locks
-      execute :command => 'locks'
+      result = execute :command => 'locks'
+
+      if result['result'] != 'locks'
+        force_shutdown
+      end
+
+      result
     end
 
     def connections
-      execute :command => 'connections'
+      result = execute :command => 'connections'
+
+      if result['result'] != 'connections'
+        force_shutdown
+      end
+
+      result
     end
 
     def my_locks
       result = execute :command => 'my_locks'
       result['value'] = result['value'].map {|name| strip_ns(name)}
+
+      if result['result'] != 'my_locks'
+        force_shutdown
+      end
+
       result
     end
 
   private
     def connect
-      raise AlreadyConnectedError if @socket
-
-      case @socket_type
-      when 'TCP'
-        @socket = TCPSocket.new @host, @port.to_i
-      when 'UNIX'
-        @socket = UNIXSocket.new @socket_file
-      else
-        raise "Invalid socket type: #{@socket_type}"
-      end
+      @lock.synchronize do
+        raise AlreadyConnectedError if @socket
+
+        case @socket_type
+        when 'TCP'
+          @socket = TCPSocket.new @host, @port.to_i
+        when 'UNIX'
+          @socket = UNIXSocket.new @socket_file
+        else
+          raise "Invalid socket type: #{@socket_type}"
+        end
+
+        @socket.fcntl Fcntl::F_SETFD, Fcntl::FD_CLOEXEC
+        @socket.setsockopt Socket::IPPROTO_TCP, Socket::TCP_NODELAY, 1
 
-      @socket.fcntl Fcntl::F_SETFD, Fcntl::FD_CLOEXEC
+        @thread = Thread.new { thread_main } unless @thread && @thread.alive?
+      end
     end
 
     def execute command
-      command = command.to_json
-      @socket.write command + "\n"
-      result = @socket.gets "\n"
-      JSON.parse result.chomp
+      @lock.synchronize do
+        command = command.to_json
+        @socket.write command + "\n"
+
+        result = nil
+
+        while true
+          rs = IO.select([@socket], nil, nil, sleep_sec)
+
+          if rs.nil?
+            keep_alive
+          else
+            result = @socket.gets "\n"
+            return JSON.parse result.chomp
+          end
+        end
+      end
     rescue
       reconnect
       raise
@@ -121,6 +182,44 @@ module Officer
       hash[key] = strip_ns(hash[key])
       hash
     end
+
+    def sleep_sec
+      60.0 / @keep_alive_freq
+    end
+
+    # This method assumes the calling thread already holds @lock.
+    def keep_alive
+      return unless @keep_alive_enabled
+      return unless @socket
+
+      command = { :command => 'keep_alive' }
+      @socket.write command.to_json + "\n"
+      nil
+    end
+
+    def thread_main
+      while true
+        sleep(sleep_sec)
+
+        if @lock.try_lock
+          begin
+            keep_alive
+          rescue Exception => e
+          ensure
+            @lock.unlock
+          end
+        end
+      end
+    end
+
+    def force_shutdown
+      begin
+        disconnect
+      rescue Exception => e
+      ensure
+        raise SocketResponseError
+      end
+    end
   end
 
 end

data/lib/officer/commands.rb

@@ -26,7 +26,7 @@ module Officer
       def initialize connection, request
         @connection = connection
         @request  = request
-        
+
         setup
 
         raise('Invalid request') unless valid?
@@ -135,5 +135,11 @@ module Officer
       end
     end
 
+    class KeepAlive < Base
+      register
+
+      def execute
+      end
+    end
   end
-end
+end

data/lib/officer/connection.rb

@@ -5,6 +5,7 @@ module Officer
       def post_init
         @connected = true
         @timers = {} # name => Timer
+        @last_cmd_at = Time.now.utc
 
         Officer::Log.info "Connected: #{to_host_s}"
       end
@@ -16,6 +17,7 @@ module Officer
 
         command = Officer::Command::Factory.create line, self
         command.execute
+        @last_cmd_at = Time.now.utc
 
       rescue Exception => e
         Officer::Log.error e
@@ -91,6 +93,8 @@ module Officer
       include EmCallbacks
       include LockStoreCallbacks
 
+      attr_reader :last_cmd_at
+
       def to_host_s
         begin
           @to_host_s ||= non_cached_to_host_s
@@ -100,6 +104,10 @@ module Officer
         end
       end
 
+      def received_keep_alive
+
+      end
+
     private
       attr_reader :connected
 

data/lib/officer/lock_store.rb

@@ -142,7 +142,7 @@ module Officer
       @locks.each do |name, lock|
         locks[name] = lock.queue.to_host_a
       end
-      
+
       connection.locks locks
     end
 
@@ -160,6 +160,12 @@ module Officer
       my_locks = @connections[connection] ? @connections[connection].to_a : []
       connection.my_locks my_locks
     end
+
+    def watchdog
+      @connections.each do |conn, names|
+
+      end
+    end
   end
 
 end

data/lib/officer/server.rb

@@ -31,7 +31,10 @@ module Officer
 
       EM::run do
         if @params[:stats]
-          EM::PeriodicTimer.new(5) {Officer::LockStore.instance.log_state}
+          EM::PeriodicTimer.new(5) do
+            Officer::LockStore.instance.log_state
+            Officer::LockStore.instance.watchdog
+          end
         end
 
         if @enable_shutdown_port

data/lib/officer/version.rb

@@ -0,0 +1,3 @@
+module Officer
+  VERSION = "0.10.0"
+end

data/lib/officer.rb

@@ -4,6 +4,8 @@ require 'set'
 require 'logger'
 require 'delegate'
 require 'thread'
+require 'socket'
+require 'fcntl'
 
 # Gems.
 require 'rubygems'
@@ -11,9 +13,9 @@ require 'eventmachine'
 require 'json'
 require 'daemons'
 require 'choice'
-# require 'ruby-debug'
 
 # Application.
+require 'officer/version'
 require 'officer/log'
 require 'officer/commands'
 require 'officer/connection'

data/officer.gemspec

@@ -1,69 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
 # -*- encoding: utf-8 -*-
+require File.expand_path('../lib/officer/version', __FILE__)
 
-Gem::Specification.new do |s|
-  s.name = "officer"
-  s.version = "0.9.2"
+Gem::Specification.new do |gem|
+  gem.authors       = ['Chad Remesch']
+  gem.email         = ['chad@remesch.com']
+  gem.description   = 'Officer is designed to help you coordinate distributed processes and avoid race conditions.'
+  gem.summary       = 'Ruby lock server and client built on EventMachine.'
+  gem.homepage      = 'http://github.com/chadrem/officer'
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Chad Remesch"]
-  s.date = "2012-03-16"
-  s.description = "Officer is designed to help you coordinate distributed processes and avoid race conditions."
-  s.email = "chad@remesch.com"
-  s.executables = ["officer"]
-  s.extra_rdoc_files = [
-    "LICENSE",
-    "README.markdown"
-  ]
-  s.files = [
-    ".autotest",
-    ".document",
-    ".rspec",
-    "CONTRIBUTORS",
-    "LICENSE",
-    "README.markdown",
-    "Rakefile",
-    "VERSION",
-    "bin/officer",
-    "lib/officer.rb",
-    "lib/officer/client.rb",
-    "lib/officer/commands.rb",
-    "lib/officer/connection.rb",
-    "lib/officer/lock_store.rb",
-    "lib/officer/log.rb",
-    "lib/officer/runner.rb",
-    "lib/officer/server.rb",
-    "officer.gemspec",
-    "spec/integration/officer_spec.rb",
-    "spec/spec_helper.rb"
-  ]
-  s.homepage = "http://github.com/chadrem/officer"
-  s.licenses = ["MIT"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.17"
-  s.summary = "Ruby lock server and client built on EventMachine."
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = 'officer'
+  gem.require_paths = ['lib']
+  gem.version       = Officer::VERSION
 
-  if s.respond_to? :specification_version then
-    s.specification_version = 3
+  gem.add_dependency('eventmachine', ['>= 0'])
+  gem.add_dependency('json', ['>= 0'])
+  gem.add_dependency('daemons', ['>= 0'])
+  gem.add_dependency('choice', ['>= 0'])
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
-      s.add_runtime_dependency(%q<json>, [">= 0"])
-      s.add_runtime_dependency(%q<daemons>, [">= 0"])
-      s.add_runtime_dependency(%q<choice>, [">= 0"])
-    else
-      s.add_dependency(%q<eventmachine>, [">= 0"])
-      s.add_dependency(%q<json>, [">= 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<daemons>, [">= 0"])
-    s.add_dependency(%q<choice>, [">= 0"])
-  end
+  gem.add_development_dependency('rake', ['>= 0'])
+  gem.add_development_dependency('rspec', ['>= 0'])
 end
-

data/spec/spec_helper.rb

@@ -1,8 +1,18 @@
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'rspec'
-require "benchmark"
-require "json"
+
+require 'rubygems'
+require 'bundler'
+
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts 'Run `bundle install` to install missing gems'
+  exit e.status_code
+end
+
+require 'benchmark'
 require 'officer'
 
 # Requires supporting files with custom matchers and macros, etc,

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: officer
 version: !ruby/object:Gem::Version
-  version: 0.9.2
+  version: 0.10.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-16 00:00:00.000000000 Z
+date: 2012-06-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: eventmachine
-  requirement: &70325432692700 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70325432692700
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &70325432692140 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70325432692140
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: daemons
-  requirement: &70325432691660 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +53,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70325432691660
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: choice
-  requirement: &70325432691180 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,25 +69,61 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70325432691180
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Officer is designed to help you coordinate distributed processes and
   avoid race conditions.
-email: chad@remesch.com
+email:
+- chad@remesch.com
 executables:
 - officer
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.markdown
+extra_rdoc_files: []
 files:
-- .autotest
-- .document
+- .gitignore
 - .rspec
 - CONTRIBUTORS
+- Gemfile
+- Gemfile.lock
 - LICENSE
 - README.markdown
 - Rakefile
-- VERSION
 - bin/officer
 - lib/officer.rb
 - lib/officer/client.rb
@@ -82,12 +133,12 @@ files:
 - lib/officer/log.rb
 - lib/officer/runner.rb
 - lib/officer/server.rb
+- lib/officer/version.rb
 - officer.gemspec
 - spec/integration/officer_spec.rb
 - spec/spec_helper.rb
 homepage: http://github.com/chadrem/officer
-licenses:
-- MIT
+licenses: []
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -98,16 +149,24 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2483715139742074305
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: -2483715139742074305
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: Ruby lock server and client built on EventMachine.
-test_files: []
+test_files:
+- spec/integration/officer_spec.rb
+- spec/spec_helper.rb

data/.autotest

@@ -1,10 +0,0 @@
-# Override autotest default magic to rerun all tests every time a
-# change is detected on the file system.
-class Autotest
-  def get_to_green
-    begin
-      rerun_all_tests
-      wait_for_changes unless all_good
-    end until all_good
-  end
-end

data/.document

@@ -1,5 +0,0 @@
-lib/**/*.rb
-bin/*
-- 
-features/**/*.feature
-LICENSE.txt

data/VERSION

@@ -1 +0,0 @@
-0.9.2