officer 0.0.1 → 0.1.1

data/README.rdoc

@@ -3,16 +3,6 @@
 This project is a work in progress and shouldn't be considered production ready at this time.
 It is implemented using Ruby and Eventmachine. Inspiration comes from elock.
 
-== Note on Patches/Pull Requests
- 
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a
-  future version unintentionally.
-* Commit, do not mess with rakefile, version, or history.
-  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
-* Send me a pull request. Bonus points for topic branches.
-
 == Copyright
 
 Copyright (c) 2010 Chad Remesch. See LICENSE for details.

data/VERSION

@@ -1 +1 @@
-0.0.1
+0.1.1

data/lib/officer/client.rb

@@ -0,0 +1,73 @@
+require 'socket'
+require 'fcntl'
+
+require 'rubygems'
+require 'active_support'
+require 'json'
+
+module Officer
+
+  class GenericError < RuntimeError; end
+  class AlreadyConnectedError < GenericError; end
+  class NotConnectedError < GenericError; end
+  class LockError < GenericError; end
+  class UnlockError < GenericError; end
+
+  class Client
+    def initialize options={}
+      options.reverse_merge! :host => 'localhost', :port => 11500
+
+      @host = options[:host]
+      @port = options[:port]
+
+      connect
+    end
+
+    def reconnect
+      disconnect
+      connect
+    end
+
+    def lock name
+      execute({:command => 'lock', :name => name}.to_json)
+    end
+
+    def unlock name
+      execute({:command => 'unlock', :name => name}.to_json)
+    end
+
+    def with_lock name
+      response = lock name
+      raise LockError unless response['result'] == 'acquired'
+
+      begin
+        yield
+      ensure
+        response = unlock name
+        raise UnlockError unless response['result'] == 'released'
+      end
+    end
+
+  private
+    def connect
+      raise AlreadyConnectedError if @socket
+
+      @socket = TCPSocket.new @host, @port.to_i
+      @socket.fcntl Fcntl::F_SETFD, Fcntl::FD_CLOEXEC
+    end
+
+    def disconnect
+      raise NotConnectedError unless @socket
+
+      @socket.close
+      @socket = nil
+    end
+
+    def execute command
+      @socket.write command + "\n"
+      result = @socket.gets "\n"
+      JSON.parse result.chomp
+    end
+  end
+
+end

data/lib/officer/commands.rb

@@ -0,0 +1,85 @@
+module Officer
+  module Command
+
+    class Factory
+      @@commands = {} # command_name => klass
+
+      class << self
+        def create line, connection
+          request = JSON.parse line
+          @@commands[request['command']].new connection, request
+        end
+
+        def register command_name, klass
+          @@commands[command_name] = klass
+        end
+      end
+    end
+
+    class Base
+      class << self
+        def register
+          Factory.register to_s.split('::').last.underscore, self
+        end
+      end
+
+      def initialize connection, request
+        @connection = connection
+        @request  = request
+        
+        setup
+
+        raise('Invalid request') unless valid?
+      end
+
+      def execute
+        raise 'Must override.'
+      end
+
+    private
+      def valid?
+        raise 'Must override.'
+      end
+
+      def require_string arg
+        arg.class == String && arg.length > 0
+      end
+    end
+
+    class Lock < Base
+      register
+
+      def execute
+        L.debug 'executing lock command.'
+        Officer::LockStore.instance.acquire @name, @connection
+      end
+
+    private
+      def setup
+        @name = @request['name']
+      end
+
+      def valid?
+        require_string @request['name']
+      end
+    end
+
+    class Unlock < Base
+      register
+
+      def execute
+        L.debug 'executing unlock command.'
+        Officer::LockStore.instance.release @name, @connection
+      end
+
+    private
+      def setup
+        @name = @request['name']
+      end
+
+      def valid?
+        require_string @request['name']
+      end
+    end
+  end
+end

data/lib/officer/connection.rb

@@ -0,0 +1,60 @@
+module Officer
+  module Connection
+
+    module EmCallbacks
+      def post_init
+        L.debug "Client connected."
+        @connected = true
+      end
+
+      def receive_line line
+        line.chomp!
+
+        L.debug "Received line: #{line}"
+
+        command = Officer::Command::Factory.create line, self
+        command.execute
+
+      rescue Exception => e
+        L.debug_exception e
+        raise
+      end
+
+      def unbind
+        @connected = false
+
+        L.debug "client disconnected."
+        Officer::LockStore.instance.unbind self
+      end
+    end
+
+    module LockCallbacks
+      def acquired name
+        L.debug "acquired lock: #{name}"
+        send_line({:result => 'acquired', :name => name}.to_json)
+      end
+
+      def released name
+        L.debug "released lock: #{name}"
+        send_line({:result => 'released', :name => name}.to_json)
+      end
+
+      def release_failed name
+        L.debug "release lock failed: #{name}"
+        send_line({:result => 'release_failed', :name => name}.to_json)
+      end
+    end
+
+    class Connection < EventMachine::Protocols::LineAndTextProtocol
+      include EmCallbacks
+      include LockCallbacks
+
+      attr_reader :connected
+
+      def send_line line
+        send_data "#{line}\n" if @connected
+      end
+    end
+
+  end
+end

data/lib/officer/lock_store.rb

@@ -0,0 +1,100 @@
+module Officer
+
+  class Lock
+    attr_reader :name
+    attr_reader :queue
+
+    def initialize name
+      @name = name
+      @queue = []
+    end
+  end
+
+  class LockStore
+    include Singleton
+
+    def initialize
+      @locks = {} # name => Lock
+      @connections = {} # Connection => [name, ...]
+    end
+
+    def log_state
+      L.debug '-----'
+
+      L.debug 'LOCK STORE:'
+      puts
+      
+      puts "locks:"
+      @locks.each do |name, lock|
+        puts "#{name}: connections=[#{lock.queue.map{|c| c.object_id}.join(', ')}]"
+      end
+      puts
+
+      puts "Connections:"
+      @connections.each do |connection, names|
+        puts "#{connection.object_id}: names=[#{names.join(', ')}]"
+      end
+      puts
+
+      L.debug '-----'
+    end
+
+    def acquire name, connection
+      lock = @locks[name] ||= Lock.new(name)
+
+      # Queue the lock request unless this connection already has the lock.
+      unless lock.queue.include? connection
+        lock.queue << connection
+        (@connections[connection] ||= []) << name
+      end
+      
+      # Tell the client to block unless it has acquired the lock.
+      if lock.queue.first == connection
+        connection.acquired name
+      end
+    end
+
+    def release name, connection
+      lock = @locks[name]
+      names = @connections[connection]
+
+      # Client should only be able to release a lock that
+      # exists and that it has previously queued.
+      if lock.nil? || !names.include?(name)
+        connection.release_failed(name) and return
+      end
+
+      # If connecton has the lock, release it and let the next
+      # connection know that it has acquired the lock.
+      if lock.queue.first == connection
+        lock.queue.shift
+        connection.released name
+
+        if next_connection = lock.queue.first
+          next_connection.acquired name
+        else
+          @locks.delete name
+        end
+
+      # If the connection is queued, but doesn't have the lock,
+      # release it and leave the other connections alone.
+      else
+        lock.queue.delete connection
+        connection.released name
+      end
+
+      @connections[connection].delete name
+    end
+
+    def unbind connection
+      names = @connections[connection] || []
+
+      names.each do |name|
+        release name, connection
+      end
+
+      @connections.delete connection
+    end
+  end
+
+end

data/lib/officer/log.rb

@@ -0,0 +1,21 @@
+module Officer
+
+  class Log
+    include Singleton
+
+    def debug message
+      puts message
+    end
+
+    def debug_exception e
+      debug '-----'
+      debug "EXCEPTION: "
+      debug e
+      debug e.backtrace.join "\n  "
+      debug '-----'
+    end
+  end
+  
+end
+
+L = Officer::Log.instance

data/lib/officer/server.rb

@@ -0,0 +1,26 @@
+module Officer
+
+  class Server
+    def initialize options={}
+      options.reverse_merge! :port => 11500, :host => '0.0.0.0'
+
+      @port = options[:port]
+      @host = options[:host]
+    end
+
+    def run
+      EM.error_handler do |e|
+        L.debug_exception e
+      end
+    
+      EM::run do
+        EM::PeriodicTimer.new(5) do
+          Officer::LockStore.instance.log_state
+        end
+
+        EM::start_server @host, @port, Connection::Connection
+      end
+    end
+  end
+
+end

data/lib/officer.rb

@@ -7,7 +7,6 @@ require 'rubygems'
 require 'active_support'
 require 'eventmachine'
 require 'json'
-require 'ruby-debug'
 
 # Application.
 require 'officer/log'
@@ -15,3 +14,4 @@ require 'officer/commands'
 require 'officer/connection'
 require 'officer/lock_store'
 require 'officer/server'
+require 'officer/client'

data/officer.gemspec

@@ -0,0 +1,69 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{officer}
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Chad Remesch"]
+  s.date = %q{2010-02-02}
+  s.default_executable = %q{officer}
+  s.description = %q{Distributed lock server and client written in Ruby and EventMachine}
+  s.email = %q{chad@remesch.com}
+  s.executables = ["officer"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "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/server.rb",
+     "officer.gemspec",
+     "test/helper.rb",
+     "test/test_officer.rb"
+  ]
+  s.homepage = %q{http://github.com/chadrem/officer}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Distributed lock server and client}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_officer.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<eventmachine>, [">= 0"])
+      s.add_development_dependency(%q<json>, [">= 0"])
+      s.add_development_dependency(%q<active_support>, [">= 0"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+      s.add_dependency(%q<json>, [">= 0"])
+      s.add_dependency(%q<active_support>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+    s.add_dependency(%q<json>, [">= 0"])
+    s.add_dependency(%q<active_support>, [">= 0"])
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: officer
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors: 
 - Chad Remesch
@@ -58,7 +58,15 @@ files:
 - README.rdoc
 - 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/server.rb
+- officer.gemspec
 - test/helper.rb
 - test/test_officer.rb
 has_rdoc: true