high_school 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7c630f397982e498679da0ae302f68513a48608f97d3d13c7b8a155507d72425
+  data.tar.gz: fc807676662df3157dd910f0e708a00bdc6e35f55d00a79d7785ce71775b65bd
+SHA512:
+  metadata.gz: d7ad06cf433014fccb6e4f865ecaa12dff55aa3cb47ab39d4e2dca1d7388e53d92dfc19f90bc4e5d8c1163bb36cae4d9b03b975cd48010c08a16683a49b500ef
+  data.tar.gz: 8a4fc9c17175576d02e8d106d8f1dae3aad9405ead958a6ceda8beee6df89a841e39244ad578900f45dd61b1bf6ee7ec59ff31612f6e21d91cbae62ed2ebf250

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-01-30
+
+- Initial release

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in high_school.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "redis"

data/Gemfile.lock

@@ -0,0 +1,23 @@
+PATH
+  remote: .
+  specs:
+    high_school (0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.17.0)
+    rake (13.0.6)
+    redis (4.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  high_school!
+  minitest (~> 5.0)
+  rake (~> 13.0)
+  redis
+
+BUNDLED WITH
+   2.3.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Sutro Labs Inc.
+
+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,48 @@
+# High School - a Redis mutex in Ruby and Lua
+
+I had my backpack stolen in high school while I was distracted playing chess. :(
+
+Lesson learned. Keep your stuff safe in your locker.
+
+My loss to high school bullies => your win! :)
+
+Here's a simple Redis based Locker for your stuff.
+
+(Implements the [locking strategy](https://redislabs.com/ebook/part-2-core-concepts/chapter-6-application-components-in-redis/6-2-distributed-locking/6-2-5-locks-with-timeouts/) from Redis Labs' book about... Redis)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add high_school
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install high_school
+
+## Usage
+
+```ruby
+@locker = HighSchool::Locker.new(my_redis_instance)
+
+@locker.lock(
+    "the_name_of_my_lock",
+    acquire_timeout: 10.seconds,
+    lock_timeout: 1.hour
+    ) do
+
+    # keep this code safe from other threads ~~stealing your backpack~~ trampling on.
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+Feedback
+--------
+[Source code available on Github](https://github.com/sutrolabs/high_school). Feedback and pull requests are greatly appreciated. Let us know if we can improve this.
+
+From
+-----------
+:wave: The folks at [Census](http://getcensus.com) originally put this together. Have data? We'll sync your data warehouse with your CRM and the customer success apps critical to your team. Interested in joining the team? **[Come work with us](https://www.getcensus.com/careers)**.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/high_school/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module HighSchool
+  VERSION = "0.1.3"
+end

data/lib/high_school.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "high_school/version"
+require 'securerandom'
+
+module HighSchool
+  # implements the locking strategy from Redis Labs' book about... Redis
+  # https://redislabs.com/ebook/part-2-core-concepts/chapter-6-application-components-in-redis/6-2-distributed-locking/6-2-5-locks-with-timeouts/
+  class Locker
+
+    # unlock is a lua script because this call will run atomically vs having to issue 2 calls independently to delete the lock.
+    # Script alo makes sure that the creator of the lock is the one deleting the lock.
+    UNLOCK_LUA_SCRIPT = "if redis.call('get',KEYS[1])==ARGV[1] then redis.call('del',KEYS[1]) end"
+
+    def initialize(redis)
+      @redis = redis
+    end
+
+    class LockNotAcquired < StandardError
+    end
+
+    # A default timeout of 10 seconds is set on the lock. You probably want to set that to something safe for yourself.
+    # But leaving it locked for infinity is probably not what you want.
+    def lock(lock_name, acquire_timeout: nil, lock_timeout: 10, &block)
+      identifier = SecureRandom.uuid
+
+      end_time = Time.now + acquire_timeout if acquire_timeout
+
+      # prefix it to make them easier to find in redis if we need to.
+      lock_name = "lock:" + lock_name
+
+      begin
+        while end_time.nil? || Time.now < end_time
+          # returns false if the lock with this name already exists
+          if @redis.set(lock_name, identifier, nx: true, ex: lock_timeout)
+            return yield
+          else
+            # just to vary up how many simulatenous threads are asking to set the lock
+            sleep(rand(0.10..0.5))
+          end
+        end
+
+        raise LockNotAcquired.new("Waited #{acquire_timeout} seconds to get lock for #{lock_name}")
+      ensure
+        @redis.eval(UNLOCK_LUA_SCRIPT, [lock_name], [identifier])
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: high_school
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- n8
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-02-01 00:00:00.000000000 Z
+dependencies: []
+description: Use Redis to establish a lock.
+email:
+- n8@getcensus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/high_school.rb
+- lib/high_school/version.rb
+homepage: https://github.com/sutrolabs/high_school
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sutrolabs/high_school
+  source_code_uri: https://github.com/sutrolabs/high_school
+  changelog_uri: https://github.com/sutrolabs/high_school/CHANGELOG.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key: 
+specification_version: 4
+summary: A Redis based Mutex
+test_files: []