marloss 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 629f069429a911325be9035a724ce9216268189a6b58239754db8b83faab9688
+  data.tar.gz: a9ce90e625c14b49a7595fb147cafabae54202097d4a4d2683cc52b27cef991a
+SHA512:
+  metadata.gz: 11f765e28d25d5e63f49e06b463f3203acc9fdbf726698cd76763a86b1bae6b288237bacf6cc1d557a1c66a1845d0bf05c97b05bba114ece203ab0073f6dfacc
+  data.tar.gz: fc3c12bf10577a5d19febd069f97bb5028d14d467ab6ce18062af4c633458f483fe116855e26a50396cb2932b7e8e5754bc56a2d582f4074c9864ccd0d98fa67

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+*.rbc
+.bundle
+Gemfile.lock
+.idea
+.*.swp

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - 2.3.3
+  - 2.3.1
+notifications:
+  email: false

data/CONTRIBUTING.md

@@ -0,0 +1,11 @@
+### Pull Requests
+
+Here are some reasons why a pull request may not be merged:
+
+1. It hasn’t been reviewed.
+2. It doesn’t include specs for new functionality.
+3. It doesn’t include documentation for new functionality.
+4. It changes behavior without changing the relevant documentation, comments, or specs.
+5. It changes behavior of an existing public API, breaking backward compatibility.
+6. It breaks the tests on a supported platform.
+7. It doesn’t merge cleanly (requiring Git rebasing and conflict resolution).

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Jacopo Scrinzi
+
+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,63 @@
+## Marloss
+
+[![Build Status](https://travis-ci.org/eredi93/marloss.svg?branch=master)](https://travis-ci.org/eredi93/marloss)
+[![Gem Version](https://badge.fury.io/rb/marloss.svg)](http://badge.fury.io/rb/marloss)
+
+Marloss is a general DynamoDB-based locking implementation.
+
+### Installation
+
+```sh
+gem install marloss
+```
+
+### Usage
+
+Firstly, we need to initialize a lock store:
+
+```ruby
+store = Marloss::Store.new("lock_table_name", "LockHashKeyName")
+```
+
+We can use this store to create a single lock
+
+```ruby
+locker = Marloss::Locker.new(store, "my_resource")
+
+# raise exception if we fail to get a lock
+locker.obtain_lock
+
+# or we can block until we get a lock
+locker.wait_until_lock_obtained
+
+# refresh the lock once
+locker.refresh
+
+# or execute block with lock being refreshed
+locker.with_refreshed_lock do
+  # execute long running code
+end
+
+# delete the lock
+locker.delete_lock
+```
+
+### Testing
+
+`rspec`
+
+### Logging
+
+By default Marloss logs to STDOUT, you can override it with the following command.
+
+```ruby
+Marloss.logger = Logger.new("my_app.log")
+```
+
+### What's in a name?
+
+"Marlòss" means lock, in Trentino's dialect. I'm from [Volano](https://en.wikipedia.org/wiki/Volano), and I liked the idea of using a word from my hometown.
+
+### Contributing
+
+This repository is [open to contributions](.github/CONTRIBUTING.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/marloss.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+#
+require "aws-sdk-dynamodb"
+
+require "marloss/version"
+require "marloss/error"
+require "marloss/store"
+require "marloss/locker"
+
+module Marloss
+
+  def self.logger
+    @logger ||= ::Logger.new(STDOUT)
+  end
+
+  def self.logger=(logger)
+    @logger = logger
+  end
+
+end

data/lib/marloss/error.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+#
+module Marloss
+  class LockNotObtainedError < StandardError
+  end
+
+  class LockNotRefreshedError < StandardError
+  end
+end

data/lib/marloss/locker.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+#
+module Marloss
+  class Locker
+
+    attr_reader :store, :name
+
+    def initialize(store, name)
+      @store = store
+      @name = name
+    end
+
+    def obtain_lock
+      store.create_lock(name)
+    end
+
+    def refresh_lock
+      store.refresh_lock(name)
+    end
+
+    def wait_until_lock_obtained(sleep_seconds: 3)
+      store.create_lock(name)
+    rescue LockNotObtainedError
+      sleep(sleep_seconds)
+      retry
+    end
+
+    def with_refreshed_lock
+      thr = Thread.new do
+        loop do
+          begin
+            store.refresh_lock(name)
+          rescue Exception => e
+            Thread.main.raise(e)
+          end
+
+          sleep(store.ttl / 3.0)
+        end
+      end
+
+      yield
+
+    ensure
+      thr.kill
+    end
+
+  end
+end

data/lib/marloss/store.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+#
+module Marloss
+  class Store
+
+    attr_reader :client, :table, :hash_key, :ttl
+
+    def initialize(table, hash_key, ttl: 30, client_options: {})
+      @client = Aws::DynamoDB::Client.new(client_options)
+      @table = table
+      @hash_key = hash_key
+      @ttl = ttl
+    end
+
+    def create_table
+      client.create_table(
+        attribute_definitions: [
+          {
+            attribute_name: hash_key,
+            attribute_type: "S",
+          }
+        ],
+        key_schema: [
+          {
+            attribute_name: hash_key,
+            key_type: "HASH",
+          }
+        ],
+        provisioned_throughput: {
+          read_capacity_units: 5,
+          write_capacity_units: 5,
+        },
+        table_name: table
+      )
+      Marloss.logger.info("DynamoDB table created successfully")
+      client.update_time_to_live(
+        table_name: table,
+        time_to_live_specification: {
+          enabled: true,
+          attribute_name: "Expires"
+        }
+      )
+      Marloss.logger.info("DynamoDB table TTL configured successfully")
+    end
+
+    def delete_table
+      client.delete_table(table_name: table)
+      Marloss.logger.info("DynamoDB table deleted successfully")
+    end
+
+    def create_lock(name)
+      client.put_item(
+        table_name: table,
+        item: {
+          hash_key => name,
+          "ProcessID" => process_id,
+          "Expires" => (Time.now + ttl).to_i
+        },
+        expression_attribute_names: {
+          "#E" => "Expires",
+          "#P" => "ProcessID"
+        },
+        expression_attribute_values: {
+          ":now" => Time.now.to_i,
+          ":process_id" => process_id,
+        },
+        condition_expression: "attribute_not_exists(#{hash_key}) OR #E < :now OR #P = :process_id"
+      )
+      Marloss.logger.info("Lock for #{name} created successfully, will expire in #{ttl} seconds")
+    rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
+      Marloss.logger.error("Failed to create lock for #{name}")
+      raise(LockNotObtainedError, e.message)
+    end
+
+    def refresh_lock(name)
+      client.update_item(
+        table_name: table,
+        key: { hash_key => name },
+        expression_attribute_names: {
+          "#E" => "Expires",
+          "#P" => "ProcessID"
+        },
+        expression_attribute_values: {
+          ":expires" => (Time.now + ttl).to_i,
+          ":now" => Time.now.to_i,
+          ":process_id" => process_id,
+        },
+        update_expression: "SET #E = :expires", 
+        condition_expression: "attribute_exists(#{hash_key}) AND (#E < :now OR #P = :process_id)"
+      )
+      Marloss.logger.info("Lock for #{name} refreshed successfully, will expire in #{ttl} seconds")
+    rescue Aws::DynamoDB::Errors::ConditionalCheckFailedException => e
+      Marloss.logger.error("Failed to refresh lock for #{name}")
+      raise(LockNotRefreshedError, e.message)
+    end
+
+    private def process_id
+      hostname = `hostname`.chomp
+      pid = Process.pid
+
+      "#{hostname}:#{pid}"
+    end
+
+  end
+end

data/lib/marloss/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+#
+module Marloss
+
+  VERSION = "0.1.1"
+
+end

data/marloss.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "marloss/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "marloss"
+  spec.version       = Marloss::VERSION
+  spec.authors       = ["Jacopo Scrinzi"]
+  spec.email         = "scrinzi.jcopo@gmail.com"
+
+  spec.summary       = %q{AWS DynamoDB based Locking}
+  spec.description   = %q{Distributed locking using AWS DynamoDB}
+  spec.homepage      = "https://github.com/eredi93/marloss"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.require_paths = %w(lib)
+
+  spec.add_dependency "aws-sdk-dynamodb", "~> 1.2"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: marloss
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Jacopo Scrinzi
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-26 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: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: rspec
+  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'
+description: Distributed locking using AWS DynamoDB
+email: scrinzi.jcopo@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CONTRIBUTING.md
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/marloss.rb
+- lib/marloss/error.rb
+- lib/marloss/locker.rb
+- lib/marloss/store.rb
+- lib/marloss/version.rb
+- marloss.gemspec
+homepage: https://github.com/eredi93/marloss
+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.7.2
+signing_key: 
+specification_version: 4
+summary: AWS DynamoDB based Locking
+test_files: []