redis_lock 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ee826bd92ec9c79acb13dd5abd4c25cae2b58740
+  data.tar.gz: 8111863df02cc6c004e9ae65cbdfa5106fc7eb89
+SHA512:
+  metadata.gz: 658f04d297764af0e0fe29739972eacd3aebeeb43334c59d51fe070ca86e7455afa75e6c4b3ff6fe1a6b44d7327cf00ee39443295ef793a7080756dfa97d0697
+  data.tar.gz: e7b3e9954828b0fc0d53c15b35476561ecfbf52d201e7977baeeadb4c66861bf677f495bc5334964d34a089eb148470020b42b0571953886b4280447ec35478f

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/README.md

@@ -0,0 +1,67 @@
+# RedisLock
+
+Do not allow anyone to perfor de same operation while this is running.
+Do not perform this operation unless the previous was executed in more than 5 minutes ago.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'redis_lock'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install redis_lock
+
+## Setup
+
+```ruby
+RedisLock.setup do |config|
+  config.redis = { host: '127.0.0.1'
+                   port: 6379
+                   db: 2 }
+  config.logger = Rails.logger
+end
+```
+
+## Usage
+
+```ruby
+lock = RedisLock.new('my_key')
+
+lock.locked? #=> false
+# Add 20 secs time to live (TTL)
+lock.set(20) #=> true
+lock.locked? #=> true
+lock.remove #=> true
+lock.locked? #=> false
+```
+
+```ruby
+lock = RedisLock.new('my_key')
+out = subject.perform do
+        #no one can perform the same operation while this is running
+        {}.tap do |t|
+          t[:locked?] = subject.locked?
+        end
+      end
+out[:locked?] #=> true
+# once the block has finished releases the lock
+lock.locked? #=> false
+```
+
+## 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`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/arturictus/redis_lock.

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 "redis_lock"
+
+# 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/redis_lock/config.rb

@@ -0,0 +1,20 @@
+class RedisLock
+  class Config
+    def redis=(hash = {})
+      @redis = hash
+    end
+
+    def redis
+      fail "[RedisLock::Config] redis connection setup is not set" unless @redis
+      @redis
+    end
+
+    def logger=(logger)
+      @logger = logger
+    end
+
+    def logger
+      @logger ? @logger : Logger.new(STDOUT)
+    end
+  end
+end

data/lib/redis_lock/version.rb

@@ -0,0 +1,3 @@
+class RedisLock
+  VERSION = "0.1.0"
+end

data/lib/redis_lock.rb

@@ -0,0 +1,66 @@
+require 'redis'
+require "redis_lock/version"
+require "redis_lock/config"
+
+class RedisLock
+  attr_reader :key
+
+  def self.config
+    @config ||= Config.new
+  end
+
+  def self.setup
+    yield config
+  end
+
+  def config; self.class.config; end
+
+  def initialize(key, opts = {})
+    @key = key
+    @redis = opts[:redis]
+  end
+
+  def redis
+    @redis ||= Redis.new(config.redis)
+  end
+
+  def set(expiration_time = 600)
+    redis.set(
+      key,
+      Time.now.strftime('%FT%T'),
+      ex: expiration_time, # expires in X seconds
+      nx: true # only if it does not exists
+    )
+  end
+
+  def perform(args = {}, &block)
+    return if locked?
+    expiration = args[:expiration] || args[:ex] || 600
+    set(expiration)
+    # If error occurs, we remove the lock
+    out = _perform(&block)
+    remove
+    out
+  end
+
+
+
+  def locked?
+    redis.ttl(key) == -2 ? false : true
+  end
+  alias_method :exists?, :locked?
+
+  def remove
+    redis.del(key) == 1 ? true : false
+  end
+
+  private
+
+  def _perform(&block)
+    yield self
+  rescue => e
+    config.logger.error "[RedisLock] key: `#{key}` error:"
+    config.logger.error e
+    false
+  end
+end

data/redis_lock.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "redis_lock/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "redis_lock"
+  spec.version       = RedisLock::VERSION
+  spec.authors       = ["Artur Pañach"]
+  spec.email         = ["arturictus@gmail.com"]
+
+  spec.summary       = %q{Lock with redis}
+  spec.description   = %q{Lock with redis}
+  spec.homepage      = "https://github.com/arturictus/redis_lock.git"
+
+  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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.6"
+  spec.add_dependency "redis", "~> 3"
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: redis_lock
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Artur Pañach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-29 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3'
+description: Lock with redis
+email:
+- arturictus@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/redis_lock.rb
+- lib/redis_lock/config.rb
+- lib/redis_lock/version.rb
+- redis_lock.gemspec
+homepage: https://github.com/arturictus/redis_lock.git
+licenses: []
+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.4.5
+signing_key: 
+specification_version: 4
+summary: Lock with redis
+test_files: []