zlk 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: abfebeccf8a57c9cb6b9e6fb3c45b435968284baaed19ce3e1d1eb7128f65362
+  data.tar.gz: d1e16ba95a2f76b1b9bfd21f72efb25c52d3e0e03a2cb0b59315911ecf92b851
+SHA512:
+  metadata.gz: 8077e2850bf115df518abfbdaabbe1b3dd3b9a77b8726a5cd1cf071cc4136e9a5bf61bdc43974baabdf50dff4bc4d9c4918334b3aab0d1f87dd5e876467fe8c5
+  data.tar.gz: ef4a0039d783bf08f83a3c3aae759aed57830d146f4f867cda849def963f218b3e7c55400e9ff6b5d723423d35c151e2e2584a382c24f5dc15e1671fcb2c9fd6

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Nikolay Markov
+
+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,42 @@
+# Zlk
+
+Simple wrapper over `ZK` gem for Zookeeper locks.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'zlk'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install zlk
+
+## Usage
+
+```ruby
+Zlk.config_file = Rails.root.join('config', 'zlk.yml')
+Zlk.env = Rails.env
+
+Zlk.create_lock('lock/path').run_exclusively { <your code> }
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/mainameiz/zlk.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "zlk"
+
+# 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/lib/zlk.rb

@@ -0,0 +1,68 @@
+require "erb"
+require "yaml"
+require "zlk/version"
+
+module Zlk
+  class << self
+    attr_accessor :mutex
+    Zlk.mutex = Mutex.new
+
+    def create_lock(path)
+      if config.use_fake_locks?
+        NullLock.new
+      else
+        Lock.new(path)
+      end
+    end
+
+    # Lazy initialization
+    def connection_pool
+      return @connection_pool if @connection_pool
+
+      mutex.synchronize do
+        hosts = config.hosts.join(',')
+
+        @connection_pool = ZK::Pool::Simple.new(
+          hosts,
+          config.pool,
+          chroot: config.chroot,
+          timeout: config.connection_timeout,
+          ephemeral: true
+        )
+      end
+
+      @connection_pool
+    end
+
+    def env=(env)
+      @env = env
+      @config = nil
+    end
+
+    def env
+      @env
+    end
+
+    def config_file=(filepath)
+      @config_file = filepath
+      @config = nil
+    end
+
+    def config_file
+      @config_file
+    end
+
+    def config
+      @config ||= begin
+        yaml = ERB.new(File.read(config_file)).result
+        hash = YAML.load(yaml)
+        Zlk::Config.new(hash[env]) if hash
+      end
+    end
+  end
+end
+
+require "zlk/config"
+require "zlk/lock"
+require "zlk/null_lock"
+require "zlk/lockable"

data/lib/zlk/config.rb

@@ -0,0 +1,19 @@
+module Zlk
+  class Config
+    attr_reader :hash
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def use_fake_locks?
+      !!hash['use_fake_locks'.freeze]
+    end
+
+    %w(hosts pool chroot connection_timeout).each do |config_key|
+      define_method(config_key) do
+        hash[config_key]
+      end
+    end
+  end
+end

data/lib/zlk/lock.rb

@@ -0,0 +1,58 @@
+module Zlk
+  class Lock
+    LockWaitTimeoutError = Class.new(StandardError)
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = sanitize_path(path)
+    end
+
+    def run_exclusively
+      with_locker do |locker|
+        locker.with_lock(wait: true) { yield }
+      end
+    end
+
+    def with_timeout(timeout)
+      with_locker do |locker|
+        begin
+          locker.with_lock(wait: timeout) { yield(true) }
+        rescue ZK::Exceptions::LockWaitTimeoutError => e
+          yield(false)
+        end
+      end
+    end
+
+    def with_timeout!(timeout)
+      with_timeout(timeout) do |locked|
+        if locked
+          yield
+        else
+          fail Zlk::Lock::LockWaitTimeoutError
+        end
+      end
+    end
+
+    def acquirable?
+      with_locker do |locker|
+        locker.acquirable?
+      end
+    end
+
+    private
+
+    def with_locker
+      Zlk.connection_pool.with_connection do |connection|
+        locker = connection.locker(path)
+        yield(locker)
+      end
+    end
+
+    # NOTE: it can be reimplemented really precisely (https://github.com/apache/zookeeper/blob/release-3.5.2/src/java/main/org/apache/zookeeper/common/PathUtils.java#L43-L102)
+    # but simple is better. Leave only word characters and substitute the rest with an underscore
+    def sanitize_path(path)
+      I18n.transliterate(path).scan(/\w+/).join('_')
+    end
+  end
+end

data/lib/zlk/lockable.rb

@@ -0,0 +1,33 @@
+module Zlk
+  module Lockable
+    def lock_key
+      suffix = if respond_to?(:id)
+        id
+      else
+        respond_to?(:uuid) ? uuid : fail("Define #{self.class}#lock_key")
+      end
+
+      "#{self.class}-#{suffix}"
+    end
+
+    def run_exclusively
+      lock.run_exclusively { yield }
+    end
+
+    def run_with_timeout!
+      lock.with_timeout!(lock_timeout) { yield }
+    end
+
+    def lock_timeout
+      10
+    end
+
+    def locked?
+      !lock.acquirable?
+    end
+
+    def lock
+      Zlk.create_lock(lock_key)
+    end
+  end
+end

data/lib/zlk/null_lock.rb

@@ -0,0 +1,19 @@
+module Zlk
+  class NullLock
+    def run_exclusively
+      yield
+    end
+
+    def with_timeout(timeout)
+      yield(true)
+    end
+
+    def with_timeout!(timeout)
+      yield
+    end
+
+    def acquirable?
+      true
+    end
+  end
+end

data/lib/zlk/version.rb

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

data/zlk.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "zlk/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "zlk"
+  spec.version       = Zlk::VERSION
+  spec.authors       = ["Nikolay Markov"]
+  spec.email         = ["mainameiz@gmail.com"]
+
+  spec.summary       = %q{Simple Zookeeper locks for ruby}
+  spec.homepage      = "https://github.com/mainameiz/zlk"
+  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.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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_runtime_dependency "zk", "~> 1.9"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification
+name: zlk
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nikolay Markov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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'
+description: 
+email:
+- mainameiz@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/zlk.rb
+- lib/zlk/config.rb
+- lib/zlk/lock.rb
+- lib/zlk/lockable.rb
+- lib/zlk/null_lock.rb
+- lib/zlk/version.rb
+- zlk.gemspec
+homepage: https://github.com/mainameiz/zlk
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+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.6
+signing_key: 
+specification_version: 4
+summary: Simple Zookeeper locks for ruby
+test_files: []