lock-server 0.1.6

data/.document

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

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "eventmachine", ">=0"
+
+
+# Add dependencies to develop your gem here.
+# Include everything needed to run rake, tests, features, etc.
+group :development do
+  gem "shoulda", ">= 0"
+  gem "rdoc", "~> 3.12"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.8.3"
+  gem "simplecov", ">= 0"
+end

data/Gemfile.lock

@@ -0,0 +1,35 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    eventmachine (0.12.10)
+    git (1.2.5)
+    jeweler (1.8.3)
+      bundler (~> 1.0)
+      git (>= 1.2.5)
+      rake
+      rdoc
+    json (1.6.6)
+    multi_json (1.3.5)
+    rake (0.9.2.2)
+    rdoc (3.12)
+      json (~> 1.4)
+    shoulda (3.0.1)
+      shoulda-context (~> 1.0.0)
+      shoulda-matchers (~> 1.0.0)
+    shoulda-context (1.0.0)
+    shoulda-matchers (1.0.0)
+    simplecov (0.6.1)
+      multi_json (~> 1.0)
+      simplecov-html (~> 0.5.3)
+    simplecov-html (0.5.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  eventmachine
+  jeweler (~> 1.8.3)
+  rdoc (~> 3.12)
+  shoulda
+  simplecov

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 V_M
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+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.

data/README.rdoc

@@ -0,0 +1,19 @@
+= lock-server
+
+Description goes here.
+
+== Contributing to lock-server
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2012 V_M. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,59 @@
+# encoding: utf-8
+
+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 '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 = "lock-server"
+  gem.homepage = "http://github.com/blimp666/lock-server"
+  gem.license = "MIT"
+  gem.summary = %Q{Lock-server}
+  gem.description = %Q{General purpose lock-server}
+  gem.email = "nobody@nowhere.com"
+  gem.authors = ["V_M"]
+  # dependencies defined in Gemfile
+  gem.files.include 'lib/lock-server.rb'
+  gem.files.include 'lib/with_lock.rb'
+  gem.files.include 'lock-server-example.conf'
+  gem.executables << 'lock_server'
+end
+
+# Это чтобы на rubygems засылал
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+# require 'rcov/rcovtask'
+# Rcov::RcovTask.new do |test|
+#   test.libs << 'test'
+#   test.pattern = 'test/**/test_*.rb'
+#   test.verbose = true
+#   test.rcov_opts << '--exclude "gems/*"'
+# end
+
+task :default => :test
+
+require 'rdoc/task'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "lock-server #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.6

data/bin/lock_server

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+require 'rubygems'
+require 'daemons'
+require 'lock-server'
+
+file_name = ARGV[1] || './lock-server.conf'
+config = eval(File.open("#{file_name}").read)
+
+Daemons.run_proc(config[:name], config[:daemons_options]) do
+  LockServer.start_server(config[:server_socket])
+end

data/lib/lock-server.rb

@@ -0,0 +1,160 @@
+require 'rubygems'
+require 'eventmachine'
+require 'socket'
+
+module LockServer
+
+  CONNECTION_TIMEOUT = 600 # 10 minutes in seconds
+
+  # Simple resource locking protocol implementation, suitable for EventMachine.
+  module ResourceLockServer
+
+    # Returns a queue for specified resource
+    #
+    # ==== Parameters
+    # resource<String>::
+    #   A name of resource which query should be returned
+    def queue_for(resource)
+      p @@resource_queues
+      @@resource_queues[resource] ||= []
+    end
+
+    # Returns a mutex for specified resource
+    #
+    # ==== Parameters
+    # resource<String>::
+    #   A name of resource which mutex should be returned
+    def mutex_for(resource)
+      @@mutexes[resource] ||= Mutex.new
+    end
+
+    # Hash of resource queues. Keys are resource names, values are arrays of connections, trying to acquire resource.
+    @@resource_queues = { }
+    # Hash of mutexes used for syncronization of queue access. Keys are resource names, values are Mutex instances.
+    @@mutexes = { }
+
+    attr_reader :peer_ip
+    attr_reader :created_at, :updated_at
+
+    def post_init
+      @resource = nil
+      @peer_ip = Socket.unpack_sockaddr_in(self.get_peername)[1]
+      set_comm_inactivity_timeout(LockServer::CONNECTION_TIMEOUT)
+    end
+
+    def send_line(string)
+      send_data(string+"\n")
+    end
+
+    # A collback of EventMachine, being called when data is received. Used for processing of lock requests.
+    # To aquire lock for needed resource name application should send message 'lock resource_name', where resource_name is a
+    # name of needed resource.
+    # An answer will be either 'ok resource_name' (meaning lock have been obtained and application could proceed) or 'wait resource_name'
+    # (there's already lock on this resource, and application should wait).
+    # To unlock data, 'unlock' should be sent. This will remove current connection from a queue and a connection will be closed.
+    # Sending any other message will result in 'err: unknown message' and connection issued incorrect command will be closed.
+    #
+    # ==== Parameters
+    # data<String>::
+    #   Data fetched from EventMachine
+    def receive_data(data)
+      @updated_at = Time.now
+      data.each_line do |line|
+        command, resource = line.strip.split(' ')
+        case command
+
+        when 'lock'
+          obtain_lock(resource)
+
+        when 'unlock'
+          send_line("released #{@resource}")
+          close_connection_after_writing
+
+        when "status"
+          write_server_status
+          close_connection_after_writing
+
+        else
+          send_line("err: unknown message")
+          close_connection_after_writing
+        end
+      end
+    end
+
+    def write_server_status
+      @@resource_queues.keys.each{ |k|
+        next if queue_for(k).empty?
+        send_line("Resource: #{k} (#{queue_for(k).size} connections waiting)")
+        send_line(queue_for(k).collect(&:peer_ip).join(", "))
+      }
+    end
+
+    # Creates a lock for requested resource, acquires mutex to protect resource queue manipulations and
+    # either notifies remote side about successful resource aquisition or tells it to wait.
+    # First connection in a queue is owning a resource, otherwise a connection will be put on hold for resource aquisition.
+    #
+    # ==== Parameters
+    # resource<String>::
+    #   A name of resource to lock.
+    def obtain_lock(resource)
+      @resource = resource
+      queue = queue_for(@resource)
+      return if queue.include?(self)
+      mutex_for(@resource).synchronize do
+        queue << self
+        if queue.size == 1
+          allow_action
+        else
+          wait_for_lock_release
+        end
+      end
+    end
+
+    def interrupt_timed_out_connection
+      return unless Time.now-@updated_at
+    end
+
+    # Releases lock of previously specified resource.
+    # Calling this method will remove current connection from @resource aquisitors queue. Also, if current connection is owning a resource (is first in aquisitors queue),
+    # it will notify next connection that resource is free now.
+    #
+    # ==== Parameters
+    # none
+    def release_lock
+      queue = queue_for(@resource)
+      mutex_for(@resource).synchronize do
+        if queue.first == self
+          queue.shift
+          queue.first.allow_action unless queue.empty?
+        else
+          queue.delete self
+        end
+      end
+    end
+
+    # Sends a notification that requested resource is free now.
+    def allow_action
+      send_line("ok #{@resource}")
+    end
+
+    # Sends a notification that requested resource is locked and an application should wait for lock.
+    def wait_for_lock_release
+      send_line("wait #{@resource}")
+    end
+
+    def unbind
+      release_lock
+    end
+
+
+  end
+
+  def self.start_server(opts = { })
+    opts[:port] ||= 12312
+    opts[:host] ||= 'localhost'
+    EventMachine::run {
+      EventMachine::start_server opts[:host], opts[:port], ResourceLockServer
+    }
+  end
+end
+

data/lib/with_lock.rb

@@ -0,0 +1,35 @@
+require 'socket'
+
+module WithLock
+
+  class LockTimeOut < Exception
+  end
+
+  # Request a lock at remote server, waits for aquisition, and yields a given block.
+  # Opens a connection to lock server and performs a communication with it, obtaining lock.
+  #
+  # ==== Parameters
+  # resource<Object>::
+  #   A resource to aquire. Will be converted to string with to_str method and sent as a resource name to lock server.
+  def with_lock(resource, timeout_period = 20, &block)
+    # yield; return
+
+    resource = resource.to_s
+    if resource.empty?
+      yield; return;
+    end
+    sock = TCPSocket.new($lock_server_config[:host], $lock_server_config[:port])
+    sock.puts "lock #{resource}\n"
+    while 1 do
+      msg = sock.gets.to_s
+      break if msg.strip == "ok #{resource}"
+      sleep(0.1)
+    end
+    Timeout::timeout(timeout_period) { yield }
+  ensure
+    if sock
+      sock.puts("unlock #{resource}\n")
+      sock.close
+    end
+  end
+end

data/lock-server-example.conf

@@ -0,0 +1,12 @@
+{
+ name: "lock_server_blimp",
+ daemons_options: {
+                   dir_mode:  :normal,
+                   dir:       File.dirname(__FILE__)+'/log',
+                   multiple:  false,
+                   backtrace: true,
+                   monitor:   true},
+ server_socket: {
+                 host: '127.0.0.1',
+                 port: 12370}
+}

data/lock-server.gemspec

@@ -0,0 +1,71 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "lock-server"
+  s.version = "0.1.6"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["V_M"]
+  s.date = "2012-06-18"
+  s.description = "General purpose lock-server"
+  s.email = "nobody@nowhere.com"
+  s.executables = ["lock_server", "lock_server"]
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "Gemfile",
+    "Gemfile.lock",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "bin/lock_server",
+    "lib/lock-server.rb",
+    "lib/with_lock.rb",
+    "lock-server-example.conf",
+    "lock-server.gemspec",
+    "log/lock_server_blimp.pid",
+    "log/lock_server_blimp_monitor.pid",
+    "test/helper.rb",
+    "test/test_lock-server.rb"
+  ]
+  s.homepage = "http://github.com/blimp666/lock-server"
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = "1.8.16"
+  s.summary = "Lock-server"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_development_dependency(%q<simplecov>, [">= 0"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<rdoc>, ["~> 3.12"])
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+      s.add_dependency(%q<simplecov>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<rdoc>, ["~> 3.12"])
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
+    s.add_dependency(%q<simplecov>, [">= 0"])
+  end
+end
+

data/log/lock_server_blimp.pid

@@ -0,0 +1 @@
+8482

data/log/lock_server_blimp_monitor.pid

@@ -0,0 +1 @@
+8486

data/test/helper.rb

@@ -0,0 +1,18 @@
+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 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'lock-server'
+
+class Test::Unit::TestCase
+end

data/test/test_lock-server.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestLockServer < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,133 @@
+--- !ruby/object:Gem::Specification
+name: lock-server
+version: !ruby/object:Gem::Version
+  version: 0.1.6
+  prerelease: 
+platform: ruby
+authors:
+- V_M
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &85014590 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *85014590
+- !ruby/object:Gem::Dependency
+  name: shoulda
+  requirement: &85014320 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *85014320
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: &85014040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.12'
+  type: :development
+  prerelease: false
+  version_requirements: *85014040
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &85030030 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *85030030
+- !ruby/object:Gem::Dependency
+  name: jeweler
+  requirement: &85029420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: *85029420
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &85028860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *85028860
+description: General purpose lock-server
+email: nobody@nowhere.com
+executables:
+- lock_server
+extensions: []
+extra_rdoc_files:
+- LICENSE.txt
+- README.rdoc
+files:
+- .document
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/lock_server
+- lib/lock-server.rb
+- lib/with_lock.rb
+- lock-server-example.conf
+- lock-server.gemspec
+- log/lock_server_blimp.pid
+- log/lock_server_blimp_monitor.pid
+- test/helper.rb
+- test/test_lock-server.rb
+homepage: http://github.com/blimp666/lock-server
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 206688659
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: Lock-server
+test_files: []