fog-aws-dynamodb-locker 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Michael Gorsuch
+
+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,65 @@
+# Fog::AWS:DynamoDB::Locker
+
+This is an attempt to use DynamoDB as a lock store.
+
+We don't have a 'Locks as a Service' thing yet, so this is an experiment to make the best of what we do have.
+
+Would love to hear of any use of this or if you think it is just a terrible idea to begin with.
+
+Inspired by the simplicity of [sequel-pg-locker](https://github.com/dylanegan/sequel-pg-locker) by [@dylanegan](https://github.com/dylanegan).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'fog-aws-dynamodb-locker'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install fog-aws-dynamodb-locker
+
+## Usage
+
+```bash
+export AWS_ACCESS_KEY_ID=...
+export AWS_SECRET_ACCESS_KEY=...
+export DYNAMODB_LOCK_TABLE='my-lock-table'
+```
+
+```ruby
+require 'fog/aws/dynamodb/locker'
+
+# first run only
+Fog::AWS::DynamoDB::Locker.init!
+
+# create a lock
+Fog::AWS::DynamoDB::Locker.lock!('my lock')
+# => true
+
+# try to claim it a second time
+Fog::AWS::DynamoDB::Locker.lock!('my lock')
+# => false
+
+# release it
+Fog::AWS::DynamoDB::Locker.release!('my lock')
+# => true
+```
+
+## TODO
+
+* real specs
+* set a timestamp on each lock
+* allow metadata on each lock
+* `Fog::AWS::DynamoDB::Locker.sweep!(n)` to remove all locks that are `n` old
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/fog-aws-dynamodb-locker.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'fog/aws/dynamodb/locker'
+
+Gem::Specification.new do |gem|
+  gem.name          = "fog-aws-dynamodb-locker"
+  gem.version       = Fog::AWS::DynamoDB::Locker::VERSION
+  gem.authors       = ["Michael Gorsuch"]
+  gem.email         = ["michael.gorsuch@gmail.com"]
+  gem.description   = %q{an attempt to leverage DynamoDB as an HA lock store}
+  gem.summary       = gem.description
+  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.require_paths = ["lib"]
+  gem.add_dependency('fog')
+  gem.add_development_dependency('rspec')
+end

data/lib/fog/aws/dynamodb/locker.rb

@@ -0,0 +1,47 @@
+require 'fog'
+require 'fog/aws/dynamodb/locker/version'
+
+module Fog::AWS::DynamoDB::Locker
+  extend self
+
+  def connect
+    Fog::AWS::DynamoDB.new(aws_access_key_id: env!('AWS_ACCESS_KEY_ID'), aws_secret_access_key: env!('AWS_SECRET_ACCESS_KEY'))
+  end
+
+  def db
+    @db ||= connect
+  end
+
+  def env!(key)
+    ENV[key] || raise("Could not find #{key} in ENV")
+  end
+
+  def init!(opts={})
+    db.create_table(table_name,
+                    {:HashKeyElement => {:AttributeName => "id", :AttributeType => "S"}},
+                    {:ReadCapacityUnits => 1, :WriteCapacityUnits => 1}.merge(opts))
+    true
+  end
+
+  def lock!(id, meta_data={})
+    begin   
+      db.put_item(table_name, {:id => {:S => id}}, {:Expected => {:id => {:Exists => false}}})
+    rescue Excon::Errors::BadRequest => e
+      if JSON.parse(e.response.body)['__type'] == 'com.amazonaws.dynamodb.v20111205#ConditionalCheckFailedException'
+        return false
+      else
+        raise 
+      end
+    end
+    true
+  end
+
+  def release!(id)
+    db.delete_item(table_name, {:HashKeyElement => {"S" => id}})
+    true
+  end
+
+  def table_name
+    env!('DYNAMODB_LOCK_TABLE')
+  end
+end

data/lib/fog/aws/dynamodb/locker/version.rb

@@ -0,0 +1,3 @@
+module Fog::AWS::DynamoDB::Locker
+  VERSION = "0.0.1"
+end

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# Require this file using `require "spec_helper"` to ensure that it is only
+# loaded once.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: fog-aws-dynamodb-locker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Michael Gorsuch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-08-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: fog
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: an attempt to leverage DynamoDB as an HA lock store
+email:
+- michael.gorsuch@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- fog-aws-dynamodb-locker.gemspec
+- lib/fog/aws/dynamodb/locker.rb
+- lib/fog/aws/dynamodb/locker/version.rb
+- spec/spec_helper.rb
+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'
+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: an attempt to leverage DynamoDB as an HA lock store
+test_files:
+- spec/spec_helper.rb