petruchio 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9b127618289e59ee4d795a3f625390c510a8e6a46214cee477593990fbcba220
+  data.tar.gz: edfa3d726ec9fe1ac779a2f7a28d3709712554784a831080e2f3b1bf2b601877
+SHA512:
+  metadata.gz: 63dd6c39379eb507aa6c0e03446f1ceadc5c3186761286997ebf967142a11004e77bbeae6bf9cd17e2ab70c46758d5b09ba033d082947d846718e3c8400904f9
+  data.tar.gz: 6d17493b75706d368ff00ab00353cabd72a163aebbe499ad01c9c548b26552e99f967f136368a83caa814e9936d74d856749b72a42acaa8cc6fa1531f0522aa6

data/CHANGELOG.md

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

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,21 @@
+PATH
+  remote: .
+  specs:
+    petruchio (0.1.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.17.0)
+    rake (13.0.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  minitest (~> 5.0)
+  petruchio!
+  rake (~> 13.0)
+
+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,55 @@
+# Petruchio - a Redis ring buffer in Ruby and Lua
+
+> We will have rings, and things, and fine array.
+
+**-Petruchio** (The Taming of the Shrew)
+
+## What?
+
+Need a Redis ring buffer? Here's a simple one in Ruby and Lua.
+
+Supports resizing too if you later need to grow or shrink the buffer.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add petruchio
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install petruchio
+
+## Usage
+
+There's a bunch of reasons you might want to use a ring buffer. For example, you might need one to back a rate limiter. Give it your Redis instance, a name for the buffer, buffer size, and a default value each entry in the buffer is initialized with:
+
+```ruby
+@ring = Petruchio::Ring.new(redis_instance, 'request_limiter', 10, 0.0)
+```
+
+Once you have a ring, pop will remove the oldest things from the buffer:
+
+```ruby
+previous_request_time = @ring.pop.to_f
+```
+
+push will add the newest things:
+
+```ruby
+@ring.push(future_request_time.to_f)
+```
+
+(If you need a lock around pushing and popping stay tuned and [watch our org](https://github.com/sutrolabs).)
+
+## 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/petruchio). 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/petruchio/version.rb

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

data/lib/petruchio.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative "petruchio/version"
+
+module Petruchio
+  class Ring
+
+    INIT_LUA_SCRIPT = <<~LUA
+      local key = KEYS[1]
+      local size = tonumber(ARGV[1])
+      local value = ARGV[2]
+
+      if redis.call('EXISTS', key) == 0 then
+        for i=1,size do
+          redis.call('RPUSH', key, value)
+        end
+      end
+    LUA
+
+    RESIZE_LUA_SCRIPT = <<~LUA
+      local key = KEYS[1]
+      local size = redis.call("llen", key)
+      local new_size = tonumber(ARGV[1])
+      local value = ARGV[2]
+
+      if size > new_size then
+        redis.call('LTRIM', key, (size - new_size), (size - 1))
+      elseif size < new_size then
+        for i = 1, (new_size - size) do
+          redis.call('RPUSH', key, value)
+        end
+      end
+
+      return redis.call('LLEN', key)
+    LUA
+
+    def initialize(redis, ring_name, size, initial_item)
+      @redis = redis
+      @ring_name = ring_name
+      @initial_item = initial_item
+
+      @redis.eval(INIT_LUA_SCRIPT, [@ring_name], [size, @initial_item])
+    end
+
+    def resize(new_size)
+      # returns the new size
+      @redis.eval RESIZE_LUA_SCRIPT, [@ring_name], [new_size, @initial_item]
+    end
+
+    def pop
+      @redis.lpop @ring_name
+    end
+
+    def push(item)
+      @redis.rpush @ring_name, item
+    end
+
+    def push_pop(item)
+      popped, *rest =
+        T.let(
+          @redis.multi do |transaction|
+            transaction.lpop @ring_name
+            transaction.rpush @ring_name, item
+          end,
+          [String, T.untyped]
+        )
+
+      popped
+    end
+
+    def read
+      @redis.lrange(@ring_name, 0, -1)
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: petruchio
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- n8
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2023-01-31 00:00:00.000000000 Z
+dependencies: []
+description: Redis makes a great shared ring buffer
+email:
+- nate@getcensus.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/petruchio.rb
+- lib/petruchio/version.rb
+homepage: https://github.com/sutrolabs/petruchio
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/sutrolabs/petruchio
+  source_code_uri: https://github.com/sutrolabs/petruchio
+  changelog_uri: https://github.com/sutrolabs/petruchio/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 ring buffer written in ruby and lua
+test_files: []