dynamodb-mutex 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2c51332da52855eb26f2f6dcf190ca6c46da6f75
+  data.tar.gz: 795579cb3f014ac3974cc30d90658f917ff5cef8
+SHA512:
+  metadata.gz: ca601a979c69633c6d21ff8e40c614b482936134fe5aab758cb1107aa24ccb934a106bb015715533fb255e4de13836743ff7f0fd62b7aef42036e94ed6219b8b
+  data.tar.gz: b7ba8b59b985ff8b067e88b621f81859bb963475c0c92ca0031cc246f5abc9839083704298d9154d24054ce980c9993eb20fbe47b709afdbe3fc53533a103bc0

data/README.rst

@@ -0,0 +1,28 @@
+DynamoDB Mutex
+==============
+
+Using DynamoDB, it implements a simple semaphore that can be used to coordinate
+access to shared data from multiple concurrent hosts or processes.
+
+Usage
+-----
+
+.. code-block:: ruby
+
+    require 'dynamodb-mutex'
+
+    DynamoDBMutex.with_lock :your_lock do
+       # Access to shared resource.
+    end
+
+You can pass following options to ``with_lock``
+
+.. code-block:: ruby
+
+    :block  => 1    # Specify in seconds how long you want to wait for the lock to be released. (default: 1)
+                    # It will raise DynamoDBMutex::LockError after block timeout
+    :sleep  => 0.1  # Specify in seconds how long the polling interval should be when :block is given.
+                    # It is NOT recommended to go below 0.01. (default: 0.1)
+    :ttl => 10      # Specify in seconds when the lock should be considered stale when something went wrong
+                    # with the one who held the lock and failed to unlock. (default: 10)
+

data/Rakefile

@@ -0,0 +1,7 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+# RSpec
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new('spec')
+task :default => :spec

data/lib/dynamodb-mutex.rb

@@ -0,0 +1,2 @@
+
+require_relative 'dynamodb_mutex'

data/lib/dynamodb_mutex/lock.rb

@@ -0,0 +1,83 @@
+require 'aws-sdk'
+require_relative 'logging'
+
+module DynamoDBMutex
+
+  LockError = Class.new(StandardError)
+  
+  module Lock
+    include Logging
+    extend self
+
+    TABLE_NAME = 'dynamodb-mutex'
+
+    def with_lock name, opts = {}
+      opts[:ttl]      ||= 10     
+      opts[:block]    ||= 1
+      opts[:sleep]    ||= 0.1        
+
+      if create(name, opts)
+        begin Timeout::timeout(opts[:ttl]) { return(yield) }
+        ensure delete(name)
+        end
+      else
+        raise LockError, "Unable to hold #{name} after #{opts[:block]} ms"
+      end
+    end
+
+    private
+
+      def create name, opts
+        acquire_timeout = Time.now.to_i + opts[:block]
+
+        while Time.now.to_i < acquire_timeout
+          delete(name) if expired?(name, opts[:ttl])
+          begin
+            table.items.put({:id => name, :created => Time.now.to_i},
+              :unless_exists => :id)
+            logger.info "ACQUIRED LOCK #{name} by #{pid}"
+            return true
+          rescue AWS::DynamoDB::Errors::ConditionalCheckFailedException
+            logger.info "Waiting for the #{name} (pid=#{pid})..."
+            sleep opts[:sleep]
+          end
+        end
+
+        false
+      end
+
+      def delete(name)
+        table.items.at(name).delete
+        logger.info "RELEASED LOCK #{name} by #{pid}"
+      end
+
+      def pid
+        Process.pid
+      end
+
+      def expired?(name, ttl)
+        if l = table.items.at(name).attributes.to_h(:consistent_read => true)
+          if t = l["created"]
+            t < (Time.now.to_i - ttl)
+          end
+        end
+      end
+
+      def table
+        return @table if @table
+        dynamo_db = AWS::DynamoDB.new
+
+        begin
+          @table = dynamo_db.tables[TABLE_NAME].load_schema
+        rescue AWS::DynamoDB::Errors::ResourceInUseException
+          logger.info "table named: #{TABLE_NAME} already exists"
+          retry
+        rescue AWS::DynamoDB::Errors::ResourceNotFoundException
+          @table = dynamo_db.tables.create(TABLE_NAME, 5, 5, {})
+          sleep 1 unless @table.status == :active
+        end
+
+        @table
+      end
+    end
+end

data/lib/dynamodb_mutex/logging.rb

@@ -0,0 +1,14 @@
+require 'logger'
+
+module Logging
+  attr_writer :logger
+
+  def logger
+    @logger ||= lambda {
+      logger = Logger.new(STDOUT, 1024*1024, 10)
+      logger.level = Logger::DEBUG
+      logger
+    }.call
+  end
+
+end

data/lib/dynamodb_mutex/version.rb

@@ -0,0 +1,4 @@
+
+module DynamoDBMutex
+  VERSION = '0.0.1'
+end

data/lib/dynamodb_mutex.rb

@@ -0,0 +1,10 @@
+
+require 'dynamodb_mutex/lock'
+
+module DynamoDBMutex
+  
+  def self.with_lock *args, &block
+    Lock.with_lock(*args, &block)
+  end
+
+end

data/spec/dynamodb_mutex_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe DynamoDBMutex::Lock do
+  
+  let(:locker) { DynamoDBMutex::Lock }
+
+  describe '#with_lock' do
+
+    def run(id, ms)
+      print "invoked worker #{id}...\n"
+      locker.with_lock 'test.lock' do
+        sleep(ms)
+      end
+    end
+
+    it 'should execute block by default' do
+      locked = false
+      locker.with_lock 'test.lock' do
+        locked = true
+      end
+      expect(locked).to eq(true)
+    end
+
+    it 'should raise error after block timeout' do
+      if pid1 = fork
+        sleep(1)
+        expect {
+          locker.with_lock('test.lock'){ sleep 1 }
+        }.to raise_error(DynamoDBMutex::LockError)
+        Process.waitall
+      else
+        run(1, 5)
+      end
+    end
+
+    it 'should expire lock if stale' do
+      if pid1 = fork
+        sleep(2)
+        locker.with_lock 'test.lock', block: 10 do
+          expect(locker).to receive(:delete).with('test.lock')
+        end 
+        Process.waitall
+      else
+        run(1, 5)
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'rspec'
+require 'fake_dynamo'
+require 'aws-sdk'
+
+AWS.config(:use_ssl => false,
+           :dynamo_db_endpoint => 'localhost',
+           :dynamo_db_port => 4567)
+
+require 'dynamodb-mutex'
+
+RSpec.configure do |config|
+
+  dynamo_thread = nil
+
+  config.before(:suite) do
+    FakeDynamo::Storage.db_path = 'test.fdb'
+    FakeDynamo::Storage.instance.load_aof
+
+    dynamo_thread = Thread.new do
+      FakeDynamo::Server.run!(port: 4567, bind: 'localhost') do |server|
+        if server.respond_to?('config') && server.config.respond_to?('[]=')
+          server.config[:AccessLog] = []
+        end
+      end
+    end
+    sleep(1)
+  end
+
+  config.after(:suite) do
+    FakeDynamo::Storage.instance.shutdown
+    dynamo_thread.exit if dynamo_thread
+    FileUtils.rm('test.fdb', force: true)
+  end
+
+end

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification
+name: dynamodb-mutex
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Dinesh Yadav
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: rspec-mocks
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: fake_dynamo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+description: dynamodb-mutex implements a simple mutex that can be used to coordinate
+email: dy@clearhaus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.rst
+- Rakefile
+- lib/dynamodb-mutex.rb
+- lib/dynamodb_mutex.rb
+- lib/dynamodb_mutex/lock.rb
+- lib/dynamodb_mutex/logging.rb
+- lib/dynamodb_mutex/version.rb
+- spec/dynamodb_mutex_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/clearhaus/dynamodb-mutex
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.4
+signing_key: 
+specification_version: 4
+summary: Distributed mutex based on AWS DynamoDB
+test_files: []