watcher_on_the_wall 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 228f9b5f3cefcd9b84360b78974d73a4cac91994
+  data.tar.gz: 964b5fde1e7e238858f74b4d8f40751bc73501a2
+SHA512:
+  metadata.gz: ca3eda96ee70d441fa47b1fda34c312c38342830299a8ec1a9fe1997c01e2449eb594433f44d135067e4cd551b1c2ff122bc0226a79cfe03d2ee1998d1cadaca
+  data.tar.gz: c404464a56c714adbbf3afc9d764a50c7bf9f1d1b0dd5730a6a8f917592893d3fe67e86870b40fbfa9964f8e045cb813229978dd99f10661351cc44fbb06d571

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in watcher_on_the_wall.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Elad Meidar
+
+MIT License
+
+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,46 @@
+# WatcherOnTheWall
+
+WatcherOnTheWall aims to provide a single instance mutual exclusion lock for running ruby scripts
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'watcher_on_the_wall'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install watcher_on_the_wall
+
+## Usage
+
+`WatcherOnTheWall` will automatically hook onto your existing Redis instance, so in order to use that you'll just need to use the following method
+
+```ruby
+    redis = Redis.new # Or whatever
+
+    redis.watcher_on_the_wall(unique_key: "my_script_is_running_now", auto_expire_in_seconds: 300) do
+      # I am a script that does things but i can't be started again until i'm done.
+    end
+```
+### Options
+
+* `unique_key` - this will be used as a Redis key to and will be checked and locked accordingly by the running scripts. defaults to a random 60 chars long string.
+* `auto_expire_in_seconds` - specifiy the number of seconds to auto-expire the mutex key to ensure it is not helf forever if something happens, if you specify `false` no expiry interval will be set (not recommended). defaults to 300 seconds (5 minutes).
+
+The lock and key will be released and deleted once the run is over.
+
+## Exceptions
+
+If you will try to run a script that uses the same `unique_key` while one is still running, `WatcherOnTheWall` will raise an `WatcherOnTheWall::Exceptions::AlreadyRunning` exception.
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/watcher_on_the_wall/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/watcher_on_the_wall/version.rb

@@ -0,0 +1,3 @@
+module WatcherOnTheWall
+  VERSION = "0.0.1"
+end

data/lib/watcher_on_the_wall.rb

@@ -0,0 +1,54 @@
+require 'redis'
+require "watcher_on_the_wall/version"
+
+module WatcherOnTheWall
+
+  def self.included(base)
+    base.class_eval do
+      include InstanceMethods
+    end
+
+  end
+
+  module Exceptions
+
+    class AlreadyRunning < RuntimeError; end
+  end
+
+  module InstanceMethods
+
+    def watcher_on_the_wall(options = {}, &block)
+      configuration = {
+        unique_key: (0..60).map { ('a'..'z').to_a[rand(26)] }.join,
+        auto_expire_in_seconds: 300
+      }.merge(options)
+
+      key = configuration[:unique_key]
+      if configuration[:auto_expire_in_seconds] == false
+        expire_in = false
+      end
+        expire_in = configuration[:auto_expire_in_seconds].to_i
+      end
+
+      self.watch(key)
+      if self.exists(key) == true
+
+        raise Exceptions::AlreadyRunning
+      end
+      self.multi do
+        if expire_in != false
+          self.setex(key, expire_in, true)
+        end
+      end
+
+      begin
+        yield if block_given?
+      ensure
+        self.del(key)
+      end
+    end
+  end
+
+end
+
+Redis.send(:include, WatcherOnTheWall)

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'watcher_on_the_wall'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = :should
+  end
+end

data/watcher_on_the_wall.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'watcher_on_the_wall/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "watcher_on_the_wall"
+  spec.version       = WatcherOnTheWall::VERSION
+  spec.authors       = ["Elad Meidar"]
+  spec.email         = ["elad@eizesus.com"]
+  spec.summary       = "WatcherOnTheWall aims to provide a single instance mutual exclusion lock for running ruby scripts"
+  spec.description   = "This gem uses Redis to provide a mutex lock and to ensure certain processes do not overlap each other."
+  spec.homepage      = "https://github.com/ShinobiDevs/watcher_on_the_wall"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency 'rspec'
+  spec.add_dependency 'redis'
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: watcher_on_the_wall
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Elad Meidar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-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.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem uses Redis to provide a mutex lock and to ensure certain processes
+  do not overlap each other.
+email:
+- elad@eizesus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/watcher_on_the_wall.rb
+- lib/watcher_on_the_wall/version.rb
+- spec/spec_helper.rb
+- watcher_on_the_wall.gemspec
+homepage: https://github.com/ShinobiDevs/watcher_on_the_wall
+licenses:
+- MIT
+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.2.2
+signing_key: 
+specification_version: 4
+summary: WatcherOnTheWall aims to provide a single instance mutual exclusion lock
+  for running ruby scripts
+test_files:
+- spec/spec_helper.rb