https://github.com/mainameiz/zlk
Simple locks through Zookeeper for Ruby
https://github.com/mainameiz/zlk
lock locking locks ruby ruby-gem ruby-library ruby-on-rails rubygem rubygems rubyonrails zookeeper
Last synced: 4 months ago
JSON representation
Simple locks through Zookeeper for Ruby
- Host: GitHub
- URL: https://github.com/mainameiz/zlk
- Owner: mainameiz
- License: mit
- Created: 2017-09-08T10:03:06.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2018-04-27T10:47:17.000Z (about 8 years ago)
- Last Synced: 2024-03-15T07:50:32.739Z (about 2 years ago)
- Topics: lock, locking, locks, ruby, ruby-gem, ruby-library, ruby-on-rails, rubygem, rubygems, rubyonrails, zookeeper
- Language: Ruby
- Homepage:
- Size: 13.7 KB
- Stars: 0
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# 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 { }
```
## 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).