lock-smith 0.0.1

data/lib/locksmith/config.rb

@@ -0,0 +1,20 @@
+module Locksmith
+  module Config
+    extend self
+
+    def env(key)
+      ENV[key]
+    end
+
+    def env!(key)
+      env(key) || raise("missing #{key}")
+    end
+
+    def env?(key)
+      !env(key).nil?
+    end
+
+    def aws_id; env!("AWS_ID"); end
+    def aws_secret; env!("AWS_SECRET"); end
+  end
+end

data/lib/locksmith/dynamodb.rb

@@ -0,0 +1,81 @@
+require 'thread'
+require 'locksmith/log'
+
+module Locksmith
+  module Dynamodb
+    extend self
+    TTL = 60
+    MAX_LOCK_ATTEMPTS = 3
+    LOCK_TIMEOUT = 30
+    LOCK_TABLE = "Locks"
+
+    @dynamo_lock = Mutex.new
+    @table_lock = Mutex.new
+
+    def lock(name)
+      lock = fetch_lock(name)
+      last_rev = lock[:Locked] || 0
+      new_rev = Time.now.to_i
+      attempts = 0
+      while attempts < MAX_LOCK_ATTEMPTS
+        begin
+          Timeout::timeout(LOCK_TIMEOUT) do
+            release_lock(name, last_rev) if last_rev < (Time.now.to_i - TTL)
+            write_lock(name, 0, new_rev)
+            log(at: "lock-acquired", lock: name, rev: new_rev)
+            result = yield
+            release_lock(name, new_rev)
+            log(at: "lock-released", lock: name, rev: new_rev)
+            return result
+          end
+        rescue AWS::DynamoDB::Errors::ConditionalCheckFailedException
+          attempts += 1
+        rescue Timeout::Error
+          attempts += 1
+          release_lock(name, new_rev)
+          log(at: "timeout-lock-released", lock: name, rev: new_rev)
+        end
+      end
+    end
+
+    def write_lock(name, rev, new_rev)
+      locks.put({Name: name, Locked: new_rev},
+        :if => {:Locked => rev})
+    end
+
+    def release_lock(name, rev)
+      locks.put({Name: app_name, Locked: 0},
+        :if => {:Locked => rev})
+    end
+
+    def fetch_lock(name)
+      locks[name].attributes
+    end
+
+    def locks
+      table(LOCK_TABLE)
+    end
+
+    def table(name)
+      @table_lock.synchronize {tables[name].items}
+    end
+
+    def tables
+      @tables ||= dynamo.tables.
+        map {|t| t.load_schema}.
+        reduce({}) {|h, t| h[t.name] = t; h}
+    end
+
+    def dynamo
+      @dynamo_lock.synchronize do
+        @db ||= AWS::DynamoDB.new(access_key_id: Config.aws_id,
+                                   secret_access_key: Config.aws_secret)
+      end
+    end
+
+    def log(data, &blk)
+      Log.log({ns: "app-lock"}.merge(data), &blk)
+    end
+
+  end
+end

data/lib/locksmith/log.rb

@@ -0,0 +1,21 @@
+module Locksmith
+  module Log
+    extend self
+
+    def log(data)
+      result = nil
+      data = {lib: "locksmith"}.merge(data)
+      if block_given?
+        start = Time.now
+        result = yield
+        data.merge(elapsed: Time.now - start)
+      end
+      data.reduce(out=String.new) do |s, tup|
+        s << [tup.first, tup.last].join("=") << " "
+      end
+      puts(out) if ENV["DEBUG"]
+      return result
+    end
+
+  end
+end

data/lib/locksmith/postgresql.rb

@@ -0,0 +1,50 @@
+require 'zlib'
+module Locksmith
+  module Postresql
+  BACKOFF = 0.5
+
+    def lock(name)
+      i = Zlib.crc32(name)
+      result = nil
+      begin
+        sleep(BACKOFF) until write_lock(i)
+        if block_given?
+          result = yield
+        end
+        return result
+      ensure
+        unlock(i)
+      end
+    end
+
+    def write_lock(i)
+      r = conn.exec("select pg_try_advisory_lock($1)", [i])
+      r[0]["pg_try_advisory_lock"] == "t"
+    end
+
+    def release_lock(i)
+      conn.exec("select pg_advisory_unlock($1)", [i])
+    end
+
+    def conn
+      @con ||= PG::Connection.open(
+        dburl.host,
+        dburl.port || 5432,
+        nil, '', #opts, tty
+        dburl.path.gsub("/",""), # database name
+        dburl.user,
+        dburl.password
+      )
+    end
+
+    def dburl
+      URI.parse(ENV["DATABASE_URL"])
+    end
+
+    def log(data, &blk)
+      Log.log({ns: "postgresql-lock"}.merge(data), &blk)
+    end
+
+  end
+end
+

data/readme.md

@@ -0,0 +1,66 @@
+# Locksmith
+
+A library of locking algorithms for a variety of data stores. Supported Data Stores:
+
+* DynamoDB
+* PostgreSQL
+* TODO: Memcached
+* TODO: Redis
+* TODO: Doozerd
+* TODO: Zookeeper
+
+## Usage
+
+There is only 1 public method:
+
+```
+lock(name, &blk)
+```
+
+### DynamoDB
+
+Create a DynamoDB table named **Locks** with a hash key **Name**.
+
+```ruby
+ENV["AWS_ID"] = "id"
+ENV["AWS_SECRET"] = "secret"
+
+require 'aws/dynamo_db'
+require 'locksmith/dynamodb'
+Locksmith::Dynamodb.lock("my-resource") do
+  puts("locked my-resource with DynamoDB")
+end
+```
+
+### PostgreSQL
+
+Locksmith will use `pg_try_advisory_lock` to lock, no need for table creation.
+
+```ruby
+ENV["DATABASE_URL"] = "postgresql://user:pass@localhost/database_name"
+
+require 'pg'
+require 'locksmith/postgresql'
+Locksmith::Postgresql.lock("my-resource") do
+  puts("locked my-resource with PostgreSQL")
+end
+```
+
+## Why Locksmith
+
+Locking code is tricky. Ideally, I would write it once, verify in production for
+a year then never think about it again.
+
+## Hacking on Locksmith
+
+There are still some Data Stores to implement, follow the pattern for PostgreSQLand DynamoDB and submit a pull request.
+
+## License
+
+Copyright (C) 2012 Ryan Smith
+
+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.

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: lock-smith
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Smith (♠ ace hacker)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-12 00:00:00.000000000 Z
+dependencies: []
+description: Locking toolkit for a variety of data stores.
+email: ryan@heroku.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/locksmith/config.rb
+- lib/locksmith/dynamodb.rb
+- lib/locksmith/log.rb
+- lib/locksmith/postgresql.rb
+- readme.md
+homepage: http://github.com/ryandotsmith/lock-smith
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Locking is hard. Write it once.
+test_files: []
+has_rdoc: