marloss 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 629f069429a911325be9035a724ce9216268189a6b58239754db8b83faab9688
-  data.tar.gz: a9ce90e625c14b49a7595fb147cafabae54202097d4a4d2683cc52b27cef991a
+  metadata.gz: 11111f0e9d75f96a957474f886c63db4686e0329c4a4457beafb0a0aae83be2c
+  data.tar.gz: fea9eec8c522ca462ede12c94aa7228cf56ae6d9540d0e8b4925e3249e88c71c
 SHA512:
-  metadata.gz: 11f765e28d25d5e63f49e06b463f3203acc9fdbf726698cd76763a86b1bae6b288237bacf6cc1d557a1c66a1845d0bf05c97b05bba114ece203ab0073f6dfacc
-  data.tar.gz: fc3c12bf10577a5d19febd069f97bb5028d14d467ab6ce18062af4c633458f483fe116855e26a50396cb2932b7e8e5754bc56a2d582f4074c9864ccd0d98fa67
+  metadata.gz: 69787108adc8ef5f2c8da6cb553d3e4033492c076267af966c9ea80d8b2d25e3175a809561327dc2f13eb13bfd08e02e38827258e94a9dcb40e732ade97f3421
+  data.tar.gz: cab2f65c3b4191a63c6bd30b461a3b82412dbac16267ee8ca1e0272fc9859c6f97c2aad276df371c2952cc222dbf83fb632799b0bbc4ec2594cb788973c1a411

data/.gitignore

@@ -4,3 +4,4 @@
 Gemfile.lock
 .idea
 .*.swp
+console

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+## 0.2.0 29/11/2017
+
+IMPROVEMENTS:
+
+* Add the possibility to include `Marloss`. This adds some healpers that makes it really easy to use the lock in your class
+
+BUG FIXES:
+
+* Add the possibility of deleting the lock, it was documented but never implemented

data/README.md

@@ -3,16 +3,66 @@
 [![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.
+Marloss is a general DynamoDB-based lock implementation.
+
+![rusty-lock](https://user-images.githubusercontent.com/10990391/33243215-aa602a6c-d2d9-11e7-8fc6-d4a0c2a5b30d.jpg)
 
 ### Installation
 
+Add this line to your application's Gemfile:
+
+```ruby
+gem "marloss"
+```
+
+And then execute:
+
+```sh
+$ bundle
+```
+
+Or install it yourself as:
+
 ```sh
-gem install marloss
+$ gem install marloss
 ```
 
 ### Usage
 
+Marloss can be use as module, with some useful heplers, or plain for more specific use cases
+
+#### Module
+
+Include the module to your class and set the options
+
+```ruby
+class MyClass
+
+  include Marloss
+
+  marloss_options table: "my_table", hash_key: "ID"
+
+end
+```
+
+now you can simply wrap the code that needs to be locked
+
+```ruby
+with_marloss_locker("my_lock")
+  # execute code
+end
+```
+
+if you have a long running task and you need to make sure you don't lose the lock
+
+```ruby
+with_refreshed_marloss_locker("my_lock")
+  # execute code
+end
+```
+
+#### Plain
+
 Firstly, we need to initialize a lock store:
 
 ```ruby
@@ -39,7 +89,7 @@ locker.with_refreshed_lock do
 end
 
 # delete the lock
-locker.delete_lock
+locker.release_lock
 ```
 
 ### Testing

data/lib/marloss.rb

@@ -17,4 +17,60 @@ module Marloss
     @logger = logger
   end
 
+  def self.included(base)
+    base.define_singleton_method(:marloss_options) do |opts|
+      if opts[:table].nil?
+        raise(MissingParameterError, "DynamoDB Hash Key not set")
+      elsif opts[:hash_key].nil?
+        raise(MissingParameterError, "DynamoDB Table not set")
+      end
+
+      define_method(:marloss_options_hash) { opts }
+
+      nil
+    end
+
+    base.send(:include, InstanceMethods)
+  end
+
+  module InstanceMethods
+
+    def marloss_store
+      @marloss_store ||=begin
+        table = marloss_options_hash[:table]
+        hash_key = marloss_options_hash[:hash_key]
+        options = marloss_options_hash.reject do |k, v|
+          k == :table || k == :hash_key
+        end
+
+        Store.new(table, hash_key, options)
+      end
+    end
+
+    def marloss_locker(name)
+      Locker.new(marloss_store, name)
+    end
+
+    def with_marloss_locker(name, opts = {})
+      locker = marloss_locker(name)
+
+      locker.wait_until_lock_obtained(opts)
+
+      yield
+
+      locker.release_lock
+    end
+
+    def with_refreshed_marloss_locker(name, opts = {})
+      locker = marloss_locker(name)
+
+      locker.wait_until_lock_obtained(opts)
+
+      locker.with_refreshed_lock { yield }
+
+      locker.release_lock
+    end
+
+  end
+
 end

data/lib/marloss/error.rb

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

data/lib/marloss/locker.rb

@@ -18,6 +18,10 @@ module Marloss
       store.refresh_lock(name)
     end
 
+    def release_lock
+      store.delete_lock(name)
+    end
+
     def wait_until_lock_obtained(sleep_seconds: 3)
       store.create_lock(name)
     rescue LockNotObtainedError

data/lib/marloss/store.rb

@@ -32,7 +32,9 @@ module Marloss
         },
         table_name: table
       )
+
       Marloss.logger.info("DynamoDB table created successfully")
+
       client.update_time_to_live(
         table_name: table,
         time_to_live_specification: {
@@ -40,11 +42,13 @@ module Marloss
           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
 
@@ -66,9 +70,12 @@ module Marloss
         },
         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
 
@@ -88,12 +95,19 @@ module Marloss
         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
 
+    def delete_lock(name)
+      client.delete_item(key: { hash_key => name }, table_name: table)
+    end
+
     private def process_id
       hostname = `hostname`.chomp
       pid = Process.pid

data/lib/marloss/version.rb

@@ -2,6 +2,6 @@
 #
 module Marloss
 
-  VERSION = "0.1.1"
+  VERSION = "0.2.0"
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marloss
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Jacopo Scrinzi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-26 00:00:00.000000000 Z
+date: 2017-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -74,6 +74,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.md