sdb_lock 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.rvmrc
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 KAWACHI Takashi
+
+MIT License
+
+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.md

@@ -0,0 +1,71 @@
+# SdbLock
+
+Poor man's distributed lock using SimpleDB. It is useful when you don't want to
+maintain distributed lock server by yourself.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sdb_lock'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sdb_lock
+
+## Usage
+
+````
+require 'sdb_lock'
+
+lock = SdbLock.new(
+  'my_app_lock_domain',  # SimpleDB domain name to use
+  create_domain: true,   # At the first time, you will need to create domain. Note it might take long time.
+
+  # Other hash members will be passed to AWS::SimpleDB#new as is.
+  # You can set credential by other ways including environmental variables.
+  # See https://github.com/amazonwebservices/aws-sdk-for-ruby
+
+  # see http://docs.amazonwebservices.com/general/latest/gr/rande.html#sdb_region
+  simple_db_endpoint: "sdb.ap-northeast-1.amazonaws.com",
+  access_key_id: YOUR_AWS_ACCESS_KEY,
+  secret_access_key: YOUR_AWS_SECRET
+)
+
+locked = lock.try_lock("a1") do
+  # do some work
+end
+
+# if you want to block until gain lock, then
+lock.lock("a1") do
+  # do some work
+end
+
+# List locked resource names
+lock.locked_resources
+
+# Some times lock might remain because of network failure. Then we'll need
+# a way to unlock these.
+#
+# Unlock older than 10 secs.
+lock.unlock_old(10)
+
+````
+
+## Limitation
+
+* Lock might remain by network failure or other reason. See `#unlock_old`.
+* Number of domains are limited by SimpleDB.
+* Each Lock is represented by an item in SimpleDB. Number of items are limited by SimpleDB.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/sdb_lock/version.rb

@@ -0,0 +1,3 @@
+class SdbLock
+  VERSION = "0.0.1"
+end

data/lib/sdb_lock.rb

@@ -0,0 +1,154 @@
+require "sdb_lock/version"
+
+require 'aws'
+
+# Lock using SimpleDB conditional put.
+#
+# Create instance.
+# lock = SdbLock.new('my_app_lock', access_key_id: YOUR_AWS_ACCESS_KEY, secret_access_key: YOUR_AWS_SECRET)
+#
+# Or if you set up AWS account in another way.
+# lock = SdbLock.new('my_app_lock')
+#
+# Try lock, unlock.
+# lock_gained = lock.try_lock("abc")
+# lock.unlock("abc") if lock_gained
+#
+# Try lock with block. It unlocks after block execution is finished.
+# executed = lock.try_lock("abc") do
+#   # some work
+# end
+#
+# Unlock old ones.
+# lock.unlock_old(60)  # Unlock all of older than 60 secs
+class SdbLock
+
+
+  # Attribute name to be used to save locked time
+  LOCK_TIME = 'lock_time'
+
+  # Constructor
+  #
+  # @param [String] domain_name SimpleDB domain name
+  # @param [Hash] options
+  def initialize(domain_name, options = {})
+    @sdb = AWS::SimpleDB.new(options)
+    options = options.dup
+    if options.has_key?(:create_domain)
+      @sdb.domains.create(domain_name) if options[:create_domain]
+      options.delete(:create_domain)
+    end
+    @domain = @sdb.domains[domain_name]
+  end
+
+  # Try to lock resource_name
+  #
+  # @param [String] resource_name name to lock
+  # @return [TrueClass] true when locked, unless false
+  def try_lock(resource_name)
+    attributes = {LOCK_TIME => format_time(Time.now), unless: LOCK_TIME}
+    item(resource_name).attributes.set(attributes)
+    if block_given?
+      begin
+        yield
+      ensure
+        unlock(resource_name)
+      end
+    end
+    true
+  rescue AWS::SimpleDB::Errors::ConditionalCheckFailed
+    false
+  end
+
+  # lock resource_name
+  # It blocks until lock is succeeded.
+  #
+  # @param [String] resource_name
+  def lock(resource_name)
+    wait_secs = 0.5
+    while true
+      lock = try_lock(resource_name)
+      break if lock
+      sleep(wait_secs)
+      wait_secs *= 2
+    end
+
+    if block_given?
+      begin
+        yield
+      ensure
+        unlock(resource_name)
+      end
+    else
+      true
+    end
+  end
+
+  # Unlock resource_name
+  # @param [String] resource_name name to unlock
+  def unlock(resource_name, expected_lock_time = nil)
+    if expected_lock_time
+      item(resource_name).attributes.delete(LOCK_TIME, if: {LOCK_TIME => expected_lock_time})
+    else
+      item(resource_name).attributes.delete(LOCK_TIME)
+    end
+    true
+  rescue AWS::SimpleDB::Errors::ConditionalCheckFailed
+    false
+  end
+
+  # Locked time for resource_name
+  # @return [Time] locked time, nil if it is not locked
+  def locked_time(resource_name)
+    attribute = item(resource_name).attributes[LOCK_TIME]
+    lock_time_string = attribute.values.first
+    Time.at(lock_time_string.to_i) if lock_time_string
+  end
+
+  # All locked resources
+  #
+  # @param [Fixnum] age_in_seconds select resources older than this seconds
+  def locked_resources(age_in_seconds = nil)
+    if age_in_seconds
+      cond = older_than(age_in_seconds)
+    else
+      cond = "`#{LOCK_TIME}` is not null"
+    end
+    @domain.items.where(cond).map(&:name)
+  end
+
+  # Unlock old resources.
+  # It is needed if any program failed to unlock by an unexpected exception
+  # or network failure etc.
+  #
+  # @param [Fixnum] age_in_seconds select resources older than this seconds
+  # @return [Array<String>] unlocked resource names
+  def unlock_old(age_in_seconds)
+    targets = locked_resources(age_in_seconds)
+    unlocked = []
+    targets.each do |resource_name|
+      values = item(resource_name).attributes[LOCK_TIME].values
+      next if !values || !values.first || values.first > format_time(Time.now - age_in_seconds)
+      succ = unlock(resource_name, values.first)
+      unlocked << resource_name if succ
+    end
+    unlocked
+  end
+
+  private
+
+  def item(resource_name)
+    @domain.items[resource_name]
+  end
+
+  # Format time to compare lexicographically
+  def format_time(time)
+    # 12 digits is enough until year 9999
+    "%012d" % time.to_i
+  end
+
+  def older_than(age_in_seconds)
+    condition_time = Time.now.utc - age_in_seconds
+    "`#{LOCK_TIME}` < '#{format_time(condition_time)}'"
+  end
+end

data/sdb_lock.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/sdb_lock/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["KAWACHI Takashi"]
+  gem.email         = ["kawachi@p-lucky.net"]
+  gem.description   = %q{Lock library using Amazon SimpleDB}
+  gem.summary       = %q{Lock library using Amazon SimpleDB}
+  gem.homepage      = ""
+
+  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          = "sdb_lock"
+  gem.require_paths = ["lib"]
+  gem.version       = SdbLock::VERSION
+
+  gem.add_dependency 'aws-sdk', '~> 1.5.7'
+
+  gem.add_development_dependency 'rake', '~> 0.9.2.2'
+end

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: sdb_lock
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- KAWACHI Takashi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.7
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.9.2.2
+description: Lock library using Amazon SimpleDB
+email:
+- kawachi@p-lucky.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/sdb_lock.rb
+- lib/sdb_lock/version.rb
+- sdb_lock.gemspec
+homepage: ''
+licenses: []
+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: -3369914292283911745
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3369914292283911745
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Lock library using Amazon SimpleDB
+test_files: []