marloss 0.2.0 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 11111f0e9d75f96a957474f886c63db4686e0329c4a4457beafb0a0aae83be2c
-  data.tar.gz: fea9eec8c522ca462ede12c94aa7228cf56ae6d9540d0e8b4925e3249e88c71c
+  metadata.gz: 0e4551d19620ac54dab98243f0c7cff6b0fd60e6dbc93d69a85d86c9b22ac2bc
+  data.tar.gz: 5c3c13ca93eb5ec41946be009a3bb1cbc4cec93aafd53573753841f15cdbd199
 SHA512:
-  metadata.gz: 69787108adc8ef5f2c8da6cb553d3e4033492c076267af966c9ea80d8b2d25e3175a809561327dc2f13eb13bfd08e02e38827258e94a9dcb40e732ade97f3421
-  data.tar.gz: cab2f65c3b4191a63c6bd30b461a3b82412dbac16267ee8ca1e0272fc9859c6f97c2aad276df371c2952cc222dbf83fb632799b0bbc4ec2594cb788973c1a411
+  metadata.gz: a1b6c0bbdc40d80566ce5fedff3d96180e88eac10cd946c2d6e0fd94fc8cd63d17c6982e02d7e57aa83162846d718ce25dd8d971d959892110c5d02a2cee82fa
+  data.tar.gz: 9ca7d34daa20a435ddc28a36509ed3390116b58ab3c46c0f07639a352f0f256a9803804cc7f63f774c9f949858c2c0bc7564832df4c2be3e582c0b282bbc6600

data/.rubocop.yml

@@ -0,0 +1,130 @@
+Metrics/LineLength:
+  Max: 100
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Layout/MultilineMethodCallIndentation:
+  EnforcedStyle: indented
+
+Style/AccessModifierDeclarations:
+  EnforcedStyle: inline
+
+Style/Documentation:
+  Enabled: false # disable for now
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "marloss.gemspec"
+
+Layout/EmptyLinesAroundAttributeAccessor:
+  Enabled: true
+
+Layout/SpaceAroundMethodCallOperator:
+  Enabled: true
+
+Lint/BinaryOperatorWithIdenticalOperands:
+  Enabled: true
+
+Lint/DeprecatedOpenSSLConstant:
+  Enabled: true
+
+Lint/DuplicateElsifCondition:
+  Enabled: true
+
+Lint/DuplicateRescueException:
+  Enabled: true
+
+Lint/EmptyConditionalBody:
+  Enabled: true
+
+Lint/FloatComparison:
+  Enabled: true
+
+Lint/MissingSuper:
+  Enabled: true
+
+Lint/MixedRegexpCaptureTypes:
+  Enabled: true
+
+Lint/OutOfRangeRegexpRef:
+  Enabled: true
+
+Lint/RaiseException:
+  Enabled: true
+
+Lint/SelfAssignment:
+  Enabled: true
+
+Lint/StructNewOverride:
+  Enabled: true
+
+Lint/TopLevelReturnWithArgument:
+  Enabled: true
+
+Lint/UnreachableLoop:
+  Enabled: true
+
+Style/AccessorGrouping:
+  Enabled: true
+
+Style/ArrayCoercion:
+  Enabled: true
+
+Style/BisectedAttrAccessor:
+  Enabled: true
+
+Style/CaseLikeIf:
+  Enabled: true
+
+Style/ExplicitBlockArgument:
+  Enabled: true
+
+Style/ExponentialNotation:
+  Enabled: true
+
+Style/GlobalStdStream:
+  Enabled: true
+
+Style/HashAsLastArrayItem:
+  Enabled: true
+
+Style/HashEachMethods:
+  Enabled: true
+
+Style/HashLikeCase:
+  Enabled: true
+
+Style/HashTransformKeys:
+  Enabled: true
+
+Style/HashTransformValues:
+  Enabled: true
+
+Style/OptionalBooleanParameter:
+  Enabled: true
+
+Style/RedundantAssignment:
+  Enabled: true
+
+Style/RedundantFetchBlock:
+  Enabled: true
+
+Style/RedundantFileExtensionInRequire:
+  Enabled: true
+
+Style/RedundantRegexpCharacterClass:
+  Enabled: true
+
+Style/RedundantRegexpEscape:
+  Enabled: true
+
+Style/SingleArgumentDig:
+  Enabled: true
+
+Style/SlicingWithRange:
+  Enabled: true
+
+Style/StringConcatenation:
+  Enabled: true

data/.travis.yml

@@ -1,6 +1,11 @@
 language: ruby
 rvm:
-  - 2.3.3
-  - 2.3.1
+  - 2.7.1
+  - 2.6.6
+  - 2.5.8
+  - 2.4.10
 notifications:
   email: false
+script:
+  - bundle exec rubocop
+  - bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+## 0.5.0 11/02/2019
+
+IMPROVEMENTS:
+
+* Add the option to specify a `custom_process_id` [#15](https://github.com/eredi93/marloss/pull/15)
+
+## 0.4.0 01/09/2018
+
+IMPROVEMENTS:
+
+* Custom ttl attribute name instead of hardcoding `Expires` [#12](https://github.com/eredi93/marloss/pull/12)
+* Add possiblity to pass retries to `wait_until_lock_obtained` preventing spin lock [#11](https://github.com/eredi93/marloss/pull/11)
+
+## 0.3.1 01/09/2018
+
+IMPROVEMENTS:
+
+* Make `create_table` wait for table [#8](https://github.com/eredi93/marloss/pull/8)
+
+## 0.3.0 29/11/2017
+
+IMPROVEMENTS:
+
+* remove `with_refreshed_lock` as is not safe [#4](https://github.com/eredi93/marloss/pull/4)
+
+## 0.2.1 29/11/2017
+
+IMPROVEMENTS:
+
+* Log when deleting the lock
+
 ## 0.2.0 29/11/2017
 
 IMPROVEMENTS:

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 gemspec

data/README.md

@@ -7,6 +7,8 @@ Marloss is a general DynamoDB-based lock implementation.
 
 ![rusty-lock](https://user-images.githubusercontent.com/10990391/33243215-aa602a6c-d2d9-11e7-8fc6-d4a0c2a5b30d.jpg)
 
+This Gem is tested using Ruby 2.6, 2.5, 2.4, 2.3
+
 ### Installation
 
 Add this line to your application's Gemfile:
@@ -48,16 +50,11 @@ 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")
+with_marloss_locker("my_lock") do |locker|
   # execute code
+  # ...
+  # refresh lock if needed
+  locker.refresh
 end
 ```
 
@@ -69,6 +66,11 @@ Firstly, we need to initialize a lock store:
 store = Marloss::Store.new("lock_table_name", "LockHashKeyName")
 ```
 
+Create table if it does not exist:
+```ruby
+store.create_table
+```
+
 We can use this store to create a single lock
 
 ```ruby
@@ -81,12 +83,7 @@ locker.obtain_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
+locker.refresh_lock
 
 # delete the lock
 locker.release_lock
@@ -110,4 +107,4 @@ Marloss.logger = Logger.new("my_app.log")
 
 ### Contributing
 
-This repository is [open to contributions](.github/CONTRIBUTING.md).
+This repository is [open to contributions](CONTRIBUTING.md).

data/Rakefile

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

data/lib/marloss.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-#
+
 require "aws-sdk-dynamodb"
 
 require "marloss/version"
@@ -8,9 +8,8 @@ require "marloss/store"
 require "marloss/locker"
 
 module Marloss
-
   def self.logger
-    @logger ||= ::Logger.new(STDOUT)
+    @logger ||= ::Logger.new($stdout)
   end
 
   def self.logger=(logger)
@@ -19,10 +18,10 @@ module Marloss
 
   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")
+      %i[table hash_key].each do |key|
+        next unless opts[key].nil?
+
+        raise(MissingParameterError, "DynamoDB #{key.to_s.capitalize.tr('_', ' ')} not set")
       end
 
       define_method(:marloss_options_hash) { opts }
@@ -34,13 +33,12 @@ module Marloss
   end
 
   module InstanceMethods
-
     def marloss_store
-      @marloss_store ||=begin
+      @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
+        options = marloss_options_hash.reject do |k, _|
+          %i[table hash_key].include?(k)
         end
 
         Store.new(table, hash_key, options)
@@ -52,25 +50,15 @@ module Marloss
     end
 
     def with_marloss_locker(name, opts = {})
+      has_lock = false
       locker = marloss_locker(name)
 
       locker.wait_until_lock_obtained(opts)
+      has_lock = true
 
-      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
+      yield(locker)
+    ensure
+      locker.release_lock if has_lock
     end
-
   end
-
 end

data/lib/marloss/error.rb

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

data/lib/marloss/locker.rb

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
-#
+
 module Marloss
   class Locker
-
     attr_reader :store, :name
 
     def initialize(store, name)
@@ -22,31 +21,17 @@ module Marloss
       store.delete_lock(name)
     end
 
-    def wait_until_lock_obtained(sleep_seconds: 3)
+    def wait_until_lock_obtained(sleep_seconds: 3, retries: nil)
       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
+      unless retries.nil?
+        retries -= 1
+        raise if retries.zero?
       end
 
-      yield
-
-    ensure
-      thr.kill
+      retry
     end
-
   end
 end

data/lib/marloss/store.rb

@@ -1,49 +1,83 @@
 # frozen_string_literal: true
-#
-module Marloss
-  class Store
 
-    attr_reader :client, :table, :hash_key, :ttl
+module Marloss
+  class Store # rubocop:disable Metrics/ClassLength
+    attr_reader :client, :table, :hash_key, :expires_key, :ttl, :process_id
 
-    def initialize(table, hash_key, ttl: 30, client_options: {})
+    def initialize(table, hash_key, **options)
+      client_options = options.fetch(:client_options, {})
       @client = Aws::DynamoDB::Client.new(client_options)
       @table = table
       @hash_key = hash_key
-      @ttl = ttl
+      @expires_key = options.fetch(:expires_key, "Expires")
+      @ttl = options.fetch(:ttl, 30)
+      @process_id = options[:custom_process_id] || host_process_id
     end
 
     def create_table
+      create_ddb_table
+      wait_until_ddb_table_exists
+      set_ddb_table_ttl
+    end
+
+    private def create_ddb_table # rubocop:disable Metrics/MethodLength
       client.create_table(
         attribute_definitions: [
           {
             attribute_name: hash_key,
-            attribute_type: "S",
+            attribute_type: "S"
           }
         ],
         key_schema: [
           {
             attribute_name: hash_key,
-            key_type: "HASH",
+            key_type: "HASH"
           }
         ],
         provisioned_throughput: {
           read_capacity_units: 5,
-          write_capacity_units: 5,
+          write_capacity_units: 5
         },
         table_name: table
       )
 
       Marloss.logger.info("DynamoDB table created successfully")
+    rescue Aws::DynamoDB::Errors::ResourceInUseException => e
+      case e.message
+      when "Table already exists: #{table}"
+        Marloss.logger.warn("DynamoDB table #{table} already exists")
+      else
+        raise(CreateTableError, e.message)
+      end
+    end
 
+    private def wait_until_ddb_table_exists
+      client.wait_until(:table_exists, table_name: table) do |w|
+        w.max_attempts = 10
+        w.delay = 1
+      end
+    rescue Aws::Waiters::Errors::WaiterFailed => e
+      Marloss.logger.error("Failed waiting for initialization of table #{table}")
+      raise(CreateTableError, e.message)
+    end
+
+    private def set_ddb_table_ttl # rubocop:disable Metrics/MethodLength
       client.update_time_to_live(
         table_name: table,
         time_to_live_specification: {
           enabled: true,
-          attribute_name: "Expires"
+          attribute_name: expires_key
         }
       )
 
       Marloss.logger.info("DynamoDB table TTL configured successfully")
+    rescue Aws::DynamoDB::Errors::ValidationException => e
+      case e.message
+      when "TimeToLive is already enabled"
+        Marloss.logger.warn("TTL attribute is already configured for table #{table}")
+      else
+        raise(SetTableTtlError, e.message)
+      end
     end
 
     def delete_table
@@ -52,53 +86,51 @@ module Marloss
       Marloss.logger.info("DynamoDB table deleted successfully")
     end
 
-    def create_lock(name)
+    def create_lock(name) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       client.put_item(
         table_name: table,
         item: {
           hash_key => name,
           "ProcessID" => process_id,
-          "Expires" => (Time.now + ttl).to_i
+          expires_key => (Time.now + ttl).to_i
         },
         expression_attribute_names: {
-          "#E" => "Expires",
+          "#E" => expires_key,
           "#P" => "ProcessID"
         },
         expression_attribute_values: {
           ":now" => Time.now.to_i,
-          ":process_id" => process_id,
+          ":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)
+    def refresh_lock(name) # rubocop:disable Metrics/MethodLength, Metrics/AbcSize
       client.update_item(
         table_name: table,
         key: { hash_key => name },
         expression_attribute_names: {
-          "#E" => "Expires",
+          "#E" => expires_key,
           "#P" => "ProcessID"
         },
         expression_attribute_values: {
           ":expires" => (Time.now + ttl).to_i,
           ":now" => Time.now.to_i,
-          ":process_id" => process_id,
+          ":process_id" => process_id
         },
-        update_expression: "SET #E = :expires", 
+        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)
@@ -106,14 +138,15 @@ module Marloss
 
     def delete_lock(name)
       client.delete_item(key: { hash_key => name }, table_name: table)
+
+      Marloss.logger.info("Lock for #{name} deleted successfully")
     end
 
-    private def process_id
+    private def host_process_id
       hostname = `hostname`.chomp
       pid = Process.pid
 
       "#{hostname}:#{pid}"
     end
-
   end
 end

data/lib/marloss/version.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
-#
-module Marloss
-
-  VERSION = "0.2.0"
 
+module Marloss
+  VERSION = "0.5.2"
 end

data/marloss.gemspec

@@ -1,25 +1,33 @@
-# coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "marloss/version"
 
+files = `git ls-files -z`.split("\x0")
+  .reject { |f| f.match(%r{^(script|spec)/}) }
+
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = ">= 2.4.0"
+
   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.summary       = "AWS DynamoDB based Locking"
+  spec.description   = "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.files         = files
+  spec.require_paths = %w[lib]
 
-  spec.add_dependency "aws-sdk-dynamodb", "~> 1.2"
+  spec.add_dependency "aws-sdk-dynamodb", "~> 1"
 
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bundler", ">= 1"
+  spec.add_development_dependency "gem-release", "~> 2.1"
+  spec.add_development_dependency "rake", "~> 12.3"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "rubocop", "= 0.89.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: marloss
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.5.2
 platform: ruby
 authors:
 - Jacopo Scrinzi
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2017-11-29 00:00:00.000000000 Z
+date: 2020-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-dynamodb
@@ -16,56 +16,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.2'
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: gem-release
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.9'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.89.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.89.1
 description: Distributed locking using AWS DynamoDB
 email: scrinzi.jcopo@gmail.com
 executables: []
@@ -73,6 +101,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -90,7 +119,7 @@ homepage: https://github.com/eredi93/marloss
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -98,16 +127,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.4.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: 
+rubygems_version: 3.0.3
+signing_key:
 specification_version: 4
 summary: AWS DynamoDB based Locking
 test_files: []