dynalock 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 854bd030d7806c8763eff00fc43d53ccc281c700
+  data.tar.gz: 9d4e150b94b91c2e32b0d909ed329c309a652fe7
+SHA512:
+  metadata.gz: 37978f44c8b4510bf06a2ed61c5531c0254e07e0061a19aa61cbf0945cce4e36f5035fea85c692d015863308f3eef987fcc016a9ecb7c77f2f370ccc925c230f
+  data.tar.gz: f5e526cbf19e456995c6e521f35d8ff8d43f9cd60dc543c26820a7d224fe404a22374c5fbf09e5034cd6c2907733ef7ec88ae3666ad50eaaa4ba24b35dab3132

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.16.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at guillermo@cientifico.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in dynalock.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,33 @@
+PATH
+  remote: .
+  specs:
+    dynalock (0.2.0)
+      aws-sdk-dynamodb
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    aws-partitions (1.44.0)
+    aws-sdk-core (3.11.0)
+      aws-partitions (~> 1.0)
+      aws-sigv4 (~> 1.0)
+      jmespath (~> 1.0)
+    aws-sdk-dynamodb (1.3.0)
+      aws-sdk-core (~> 3)
+      aws-sigv4 (~> 1.0)
+    aws-sigv4 (1.0.2)
+    jmespath (1.3.1)
+    minitest (5.10.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  dynalock!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Guillermo Álvarez
+
+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,106 @@
+# Dynalock
+
+Dynalock is a distributed lock that uses dynamod db.
+
+
+## Background
+
+At tourlane we were running cronjobs through AWS ECS. Once the cluster become
+too big, Cloudwatch was scheduling tasks, even if the same task was already
+present. Dynalock solves this issue, ensuring that any new task exit and fails
+before starting the real work.
+
+The first assumption is that something like this should exists, but normally
+not as a command line program (if you found any, please let us know). So we
+created our own.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dynalock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dynalock
+
+You need to create a table in dynamo db with "id" as a primary key, and "expires" as expires.
+The default table name is "locks"
+
+
+## Usage
+
+
+Set the environment variables to its proper values.
+
+
+    AWS_ACCESS_KEY_ID
+    AWS_REGION
+    AWS_SECRET_ACCESS_KEY
+
+
+### Usage inside ruby
+
+```ruby
+require 'dynalock'
+
+include Dynalock::Lock
+
+adquire_lock(context: "my_lock", table: TABLE, owner: @owner, expire_time: 10)
+refresh_lock(context: "my_lock", table: TABLE, owner: @owner, expire_time: 10)
+with_lock(context: "my_lock", table: TABLE, owner: @owner) { "Only run this" }
+```
+
+Most of the paramenters are optional
+
+```ruby
+adquire_lock(context: "my_lock")
+refresh_lock(context: "my_lock")
+with_lock(context: "my_lock") { "Only run this" }
+```
+
+
+### Usage through the command line
+
+```sh
+$ dynalock my_program
+```
+
+This will try to adquire to a lock in dynamodb for 10 seconds, and refresh it every 5 seconds and run your program. The command will be context.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run
+`rake test` to run the tests. You can also run `bin/console` for an interactive
+prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To
+release a new version, update the version number in `version.rb`, and then run
+`bundle exec rake release`, which will create a git tag for the version, push
+git commits and tags, and push the `.gem` file to
+[rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at
+https://github.com/guillermo/dynalock. This project is intended to be a safe,
+welcoming space for collaboration, and contributors are expected to adhere to
+the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT
+License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Dynalock project’s codebases, issue trackers, chat
+rooms and mailing lists is expected to follow the [code of
+conduct](https://github.com/guillermo/dynalock/blob/master/CODE_OF_CONDUCT.md).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/TODO.md

@@ -0,0 +1,8 @@
+# TODO
+
+[ ] Add an option to release a lock.
+[ ] When the lock exists and its own by someone else, show by whom.
+[ ] Allow to specify the aws credentials without relying in the env variables.
+[ ] Allow to pass parameters to the command line.
+[ ] Automate the creation of the DynamoDB table.
+[ ] Add an option to remove the table.

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "dynalock"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/dynalock.gemspec

@@ -0,0 +1,30 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "dynalock/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "dynalock"
+  spec.version       = Dynalock::VERSION
+  spec.authors       = ["Guillermo Alarez"]
+  spec.email         = ["guillermo@cientifico.net"]
+
+  spec.summary       = %q{Distributed lock using dynamodb}
+  spec.description   = %q{dynalock is a distributed lock that uses Amazon Web Service Dynamod DB (Ruby api and command line... command)}
+  spec.homepage      = "https://github.com/tourlane/dynalock"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "aws-sdk-dynamodb"
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/exe/dynalock

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+
+if ARGV[0].nil?
+  $stderr.puts "Usage: #{$0} COMMAND"
+  exit(-1)
+end
+
+require 'dynalock'
+
+include Dynalock::Lock
+
+begin
+  with_lock(context: ARGV[0]) do
+    system(*ARGV)
+  end
+rescue Locked
+  $stderr.puts "This program is already running"
+  exit(-3)
+end

data/lib/dynalock.rb

@@ -0,0 +1,7 @@
+require "dynalock/version"
+require "dynalock/lock"
+
+module Dynalock
+end
+
+

data/lib/dynalock/lock.rb

@@ -0,0 +1,71 @@
+require 'aws-sdk-dynamodb'
+
+module Dynalock
+  module Lock
+    class Locked < Exception ; end
+    def adquire_lock(context:, owner: lock_default_owner, table: "locks", expire_time: 10)
+      dynamodb_client.put_item(
+	table_name: table,
+	item: {
+	  id: context,
+	  lock_owner: owner, 
+	  expires: Time.now.utc.to_i + expire_time
+	},
+	condition_expression: "attribute_not_exists(expires) OR expires < :expires",
+	expression_attribute_values: {
+	  ":expires": Time.now.utc.to_i
+	}
+      )
+      true
+    rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException
+      return false
+    end
+
+    def refresh_lock(context:, owner: lock_default_owner, table: "locks", expire_time: 10)
+      dynamodb_client.update_item({
+	table_name: table,
+	key: { id: context },
+	update_expression: "SET expires = :expires",
+	condition_expression: "attribute_exists(expires) AND expires > :now AND lock_owner = :owner",
+	expression_attribute_values: { 
+	  ":expires": Time.now.utc.to_i + expire_time,
+	  ":owner": owner,
+	  ":now": Time.now.utc.to_i
+	},
+      })
+      true
+    rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException
+      return false
+    end
+
+    def with_lock(context:, owner: lock_default_owner, table: "locks")
+      expire_time = 5
+
+      result = adquire_lock(context: context, owner: owner, table: table, expire_time: expire_time)
+      raise Locked.new if result == false
+
+      thread = Thread.new {
+	loop do
+	  refresh_lock(context: context, owner: owner, table: table, expire_time: expire_time)
+	  sleep(expire_time / 2.0)
+	end
+      }
+      if block_given?
+	return yield
+      end
+    ensure
+      thread.kill unless thread.nil?
+    end
+
+   private
+
+   def lock_default_owner
+     @lock_default_owner ||= "#{ENV["USER"]}@#{`hostname`.strip}"
+   end
+
+    def dynamodb_client
+      Aws::DynamoDB::Client.new
+    end
+
+  end
+end

data/lib/dynalock/version.rb

@@ -0,0 +1,3 @@
+module Dynalock
+  VERSION = "0.2.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: dynalock
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Guillermo Alarez
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk-dynamodb
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: dynalock is a distributed lock that uses Amazon Web Service Dynamod DB
+  (Ruby api and command line... command)
+email:
+- guillermo@cientifico.net
+executables:
+- dynalock
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- TODO.md
+- bin/console
+- bin/setup
+- dynalock.gemspec
+- exe/dynalock
+- lib/dynalock.rb
+- lib/dynalock/lock.rb
+- lib/dynalock/version.rb
+homepage: https://github.com/tourlane/dynalock
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Distributed lock using dynamodb
+test_files: []