redis-store-with-cas 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b078891090e8eb34a95b4ee0bc6a8a4f2f9fc179
+  data.tar.gz: c80c840495cff70bc4e3b46da42f04d9a5fae9bd
+SHA512:
+  metadata.gz: 0b1d51e1aca950890aa2bf18c97b284269c5fbc9352a174e27c277c5678af10bb7d9349a1775bc60b3135bae09e9de2132e8ecb393a405f318dd655cf6b8eb65
+  data.tar.gz: 033d735df907553eb5e537c3d8076cd2771079b28aff0ee89e676bb5223ad56305d20f32f7e5113b7c95ae0c1202fcf019ccda6eb04e644355d2ef66014b532f

data/.gitignore

@@ -0,0 +1,9 @@
+Gemfile.lock
+*.gem
+tmp/
+stdout
+.idea/
+.ruby-version
+.ruby-gemset
+.yardoc/
+doc

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2017 Rajko Albrecht
+
+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,30 @@
+# Enhance redis store with Compare-and-Swap methods
+
+__Redis Store With CAS__ enhance the existing [redis-store for Ruby Frameworks](https://github.com/redis-store/redis-store)
+with so called Compare-And-Swap. 
+
+This is required for thread-safe-usage of cache systems like [Identity cache](https://github.com/Shopify/identity_cache).
+
+The tests and workflow are build like in [Memcached store for ruby](https://github.com/Shopify/memcached_store)
+
+## Installation
+
+Add the following to your Gemfile
+
+`gem 'redis-store-with-cas`
+
+## Usage
+
+Add a 
+
+`require 'redis-store-with-cas'`
+
+line to your source before first call to `Redis::Store.new`. Now each instance of `Redis::Store` has 
+two new methods:
+
+ * `cas`
+ * `cas_multi`
+
+## Copyright
+
+2017 Rajko Albrecht - [http://alwins-world.de](http://alwins-world.de)

data/Rakefile

@@ -0,0 +1,4 @@
+require 'bundler/setup'
+require 'rake'
+require 'bundler/gem_tasks'
+require 'redis-store/testing/tasks'

data/irb.rb

@@ -0,0 +1,4 @@
+require "irb"
+require 'redis-store-with-cas'
+
+IRB.start(__FILE__)

data/lib/redis-store-with-cas.rb

@@ -0,0 +1,3 @@
+require 'redis'
+require 'redis/store'
+require 'redis/store-with-cas'

data/lib/redis/store-with-cas.rb

@@ -0,0 +1,15 @@
+require 'redis'
+require 'redis/store'
+require 'redis/store-with-cas/cas'
+require 'redis/store-with-cas/version'
+require 'redis/store/marshalling'
+require 'redis/store/namespace'
+require 'redis/store-with-cas/namespace'
+
+class Redis
+
+  class Store < self
+    include Cas
+  end
+
+end

data/lib/redis/store-with-cas/cas.rb

@@ -0,0 +1,107 @@
+class Redis
+
+  # simple enhancement of Redis::Store
+  class Store < self
+
+    # Implements Compare-And-Swap (or as Redis says Compare-And-Save)
+    # on top of Redis::Store using Redis::Store::watch. It is designated for simple values, not redis-lists/hashes etc
+    module Cas
+
+      # Single CAS
+      #
+      # Trys to save change the value of a redis-key when it may not done in a atomic matter. Eg, you have do some
+      # checks on old value before setting the new one and so on. If key content changes meanwhile it refuses to
+      # set and you will not overwrite changes from other Thread or Process.
+      #
+      # This method works only on existing keys in redis.
+      # It works only with keys holding a value, eg, read/writeable with get/set
+      #
+      # @yield [value] the current value of given key
+      # @yieldparam [String] key the key to get and set the value
+      # @yieldreturn [String] the new value to store in key
+      # @return [Boolean] true if new value was stored, otherwise false
+      # @param key [String] the key to set. Must not be nil and key must exists in Redis
+      # @param ttl [Integer] if not nil and integer > 0 set a TTL to the changed key
+      # @example
+      #
+      #  storewithcas.cas('examplekey') do |value|
+      #    # value is the CURRENT value!
+      #    new_value = do_some_important_stuff_here(value)
+      #    new_value # write back to redis unless key has changed meanwhile
+      #  end
+      def cas key, ttl=nil
+        return false unless exists(key)
+        watch(key) do
+          value = get(key)
+          value = yield value
+          ires = multi do |multi|
+            multi.set(key,value,ttl.nil? ? {} : {:expire_after => ttl})
+          end
+          ires.is_a?(Array) && ires[0] == 'OK'
+        end
+      end
+
+      # Multi CAS
+      #
+      # Safe changing multiple keys at once. It works only with keys holding a value, eg, read/writeable with get/set
+      #
+      # @example
+      #
+      #   storewithcas.cas_multi('key1','key1') do |currenthash|
+      #     newhashedvalues = make_something_with_current(currenthash)
+      #     newhashedvalues
+      #   end
+      #
+      # @example
+      #   storewithcas.cas_multi('k1','k2', :expire_in => 1200) do |currenthash| #=> ttl for all keys swapped
+      #     {'k1' => '1', 'k2' => 2}
+      #   end
+      #
+      # @yield [values] a key=>value hash with values of given keys. keys not existing are not yielded
+      # @yieldparam [Array] keys the keys to change
+      # @yieldreturn [Hash] key-value-pairs to change. Keys not given in parameter or not existing in redis are ignored.
+      # @return [Boolean] true if tried making changes, nil when keylist empty
+      # @param keys [Array] the keys to set. Must not be nil and keys must exists in Redis. After keys list you may append hash with options for redis.
+      def cas_multi *keys
+        return if keys.empty?
+        options = extract_options keys
+        watch(*keys) do
+          values = read_multi(*keys,options)
+          valuehash = yield values
+          valuehash.map do |name,value|
+            multi do |multi|
+              multi.set(name,value,options)
+            end if values.key?(name)
+          end
+          true
+        end
+      end
+
+      # Read list of keys and return values as Hash
+      #
+      # @param keys Array the keys to read
+      # @return [Hash] key-value-pairs of key found in redis, eg, exists.
+      #
+      # @example
+      #  values = read_multi("key1","key2","key3") #=> {"key1" => "1", "key2" => "2", "key3" => "3"}
+      def read_multi *keys
+        options = extract_options keys
+        keys = keys.select {|k| exists(k)}
+        return {} if keys.empty?
+        values = mget(*keys,options)
+        values.nil? ? {} : Hash[keys.zip(values)]
+      end
+
+      private
+
+      def extract_options array
+        if array.last.is_a?(Hash) && array.last.instance_of?(Hash)
+          array.pop
+        else
+          {}
+        end
+      end
+    end
+
+  end
+end

data/lib/redis/store-with-cas/namespace.rb

@@ -0,0 +1,17 @@
+class Redis
+  class Store < self
+    # Add namespaced methods missing in #Redis::Store
+    module Namespace
+      # redis.watch for a list of keys respecting the namespace for keys of the
+      # Redis::Store instance
+      # @param keys Array a list of keys to watch
+      # @see Redis::Store::watch in redis-store-gem
+      # @see Redis::watch in redis-gem
+      def watch *keys
+        if keys.any?
+          super(*keys.map {|key| interpolate(key) })
+        end
+      end
+    end
+  end
+end

data/lib/redis/store-with-cas/version.rb

@@ -0,0 +1,7 @@
+require 'redis/store'
+
+class Redis
+  class StoreWithCas < Store
+    VERSION = '0.0.1'
+  end
+end

data/redis-store-with-cas.gemspec

@@ -0,0 +1,34 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path('../lib', __FILE__)
+require 'redis/store-with-cas/version'
+
+Gem::Specification.new do |s|
+  s.name        = 'redis-store-with-cas'
+  s.version     = Redis::StoreWithCas::VERSION
+  s.authors     = ['Rajko Albrecht']
+  s.email       = ['ral@alwins-world.de']
+  s.homepage    = 'https://git.alwin-it.de/alwin/redis-store-with-cas'
+  s.summary     = %q{Extend redis store for Ruby frameworks with cas}
+  s.description = %q{Extend the redis store with CAS (compare-and-swap) functionality for better cache integrity support}
+
+  s.rubyforge_project = 'redis-store-with-cas'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.license       = 'MIT'
+
+  s.add_dependency 'redis', '>= 2.2', '< 4'
+  s.add_dependency 'redis-store', '>= 1.1.0', '< 2'
+
+  s.add_development_dependency 'rake',     '~> 10'
+  s.add_development_dependency 'bundler',  '~> 1.3'
+  s.add_development_dependency 'mocha',    '~> 0.14.0'
+  s.add_development_dependency 'minitest', '~> 5'
+  s.add_development_dependency 'git',      '~> 1.2'
+  s.add_development_dependency 'pry-nav',  '~> 0.2.4'
+  s.add_development_dependency 'pry',      '~> 0.10.4'
+  s.add_development_dependency 'redis-store-testing'
+
+end

data/test/store_test.rb

@@ -0,0 +1,127 @@
+require 'test_helper'
+
+describe Redis::StoreWithCas do
+  def setup
+    @store  = Redis::Store.new :namespace => 'storetest'
+  end
+
+  def teardown
+    @store.flushdb
+    @store.quit
+  end
+
+  def test_cas
+    @store.set('foo', 'baz')
+    assert(@store.cas('foo') do |value|
+      assert_equal 'baz', value
+      'bar'
+    end)
+    assert_equal 'bar', @store.get('foo')
+  end
+
+  def test_cas_with_cache_miss
+    refute @store.cas('not_exist') { |_value| flunk }
+  end
+
+  def test_cas_with_conflict
+    @store.set('foo', 'bar')
+    refute @store.cas('foo') { |_value|
+      @store.set('foo', 'baz')
+      'biz'
+    }
+    assert_equal 'baz', @store.get('foo')
+  end
+
+  # TODO write a Mockup redis with support for watch
+  def test_cas_with_ttl
+    @store.set('ttlfoo','bar')
+    assert(@store.cas('ttlfoo',3600) do |value|
+      assert_equal 'bar',value
+      'ttlbar'
+    end)
+    assert_equal @store.get('ttlfoo'),'ttlbar'
+    assert @store.ttl('ttlfoo') > 0
+    assert(@store.cas('ttlfoo') do |value|
+      'bar'
+    end)
+    assert_equal -1,@store.ttl('ttlfoo')
+  end
+
+  def test_cas_multi_with_empty_set
+    refute @store.cas_multi { |_hash| flunk }
+  end
+
+
+  def test_read_multi
+    @store.set('k1','m1')
+    @store.set('k2','m2')
+    assert_equal({"k1" => "m1","k2" => "m2"},@store.read_multi("k1","k2"))
+  end
+
+  def test_cas_multi
+    @store.set('foo', 'bar')
+    @store.set('fud', 'biz')
+    assert_equal true, (@store.cas_multi('foo', 'fud') do |hash|
+      assert_equal({ "foo" => "bar", "fud" => "biz" }, hash)
+      { "foo" => "baz", "fud" => "buz" }
+    end)
+    assert_equal({ "foo" => "baz", "fud" => "buz" }, @store.read_multi('foo', 'fud'))
+  end
+
+  def test_cas_multi_with_ttl
+    @store.set('foo', 'bar')
+    @store.set('fud', 'biz')
+    @store.cas_multi('foo','fud',{:expires_in => 3600}) do |hash|
+      { "foo" => "baz", "fud" => "buz" }
+    end
+    assert @store.ttl('foo') > 0
+    assert @store.ttl('fud') > 0
+  end
+
+  def test_cas_multi_with_cache_miss
+    assert(@store.cas_multi('not_exist') do |hash|
+      assert hash.empty?
+      {}
+    end)
+  end
+
+  def test_cas_multi_with_altered_key
+    @store.set('foo', 'baz')
+    assert @store.cas_multi('foo') { |_hash| { 'fu' => 'baz' } }
+    assert_nil @store.get('fu')
+    assert_equal 'baz', @store.get('foo')
+  end
+
+  def test_cas_multi_with_partial_miss
+    @store.set('foo', 'baz')
+    assert(@store.cas_multi('foo', 'bar') do |hash|
+      assert_equal({ "foo" => "baz" }, hash)
+      {}
+    end)
+    assert_equal 'baz', @store.get('foo')
+  end
+
+  def test_cas_multi_with_partial_update
+    @store.set('foo', 'bar')
+    @store.set('fud', 'biz')
+    assert(@store.cas_multi('foo', 'fud') do |hash|
+      assert_equal({ "foo" => "bar", "fud" => "biz" }, hash)
+
+      { "foo" => "baz" }
+    end)
+    assert_equal({ "foo" => "baz", "fud" => "biz" }, @store.read_multi('foo', 'fud'))
+  end
+
+  def test_cas_multi_with_partial_conflict
+    @store.set('foo', 'bar')
+    @store.set('fud', 'biz')
+    result = @store.cas_multi('foo', 'fud') do |hash|
+      assert_equal({ "foo" => "bar", "fud" => "biz" }, hash)
+      @store.set('foo', 'bad')
+      { "foo" => "baz", "fud" => "buz" }
+    end
+    assert result
+    assert_equal({ "foo" => "bad", "fud" => "buz" }, @store.read_multi('foo', 'fud'))
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require 'bundler/setup'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+require 'redis-store-with-cas'
+

data/test/version_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+describe Redis::Store::StoreWithCas::VERSION do
+  it 'returns current version' do
+    Redis::Store::StoreWithCas::VERSION.wont_equal nil
+  end
+end

metadata

@@ -0,0 +1,215 @@
+--- !ruby/object:Gem::Specification
+name: redis-store-with-cas
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Rajko Albrecht
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: redis-store
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.0
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: git
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.4
+- !ruby/object:Gem::Dependency
+  name: redis-store-testing
+  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'
+description: Extend the redis store with CAS (compare-and-swap) functionality for
+  better cache integrity support
+email:
+- ral@alwins-world.de
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- MIT-LICENSE
+- README.md
+- Rakefile
+- irb.rb
+- lib/redis-store-with-cas.rb
+- lib/redis/store-with-cas.rb
+- lib/redis/store-with-cas/cas.rb
+- lib/redis/store-with-cas/namespace.rb
+- lib/redis/store-with-cas/version.rb
+- redis-store-with-cas.gemspec
+- test/store_test.rb
+- test/test_helper.rb
+- test/version_test.rb
+homepage: https://git.alwin-it.de/alwin/redis-store-with-cas
+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: redis-store-with-cas
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Extend redis store for Ruby frameworks with cas
+test_files:
+- test/store_test.rb
+- test/test_helper.rb
+- test/version_test.rb