suo 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 200ad3e821080a0c0674af2abd4622de1c5088fb
-  data.tar.gz: 81a59e78a7396bd76b4a5d9c1e3cab46b0eac260
+  metadata.gz: a30ddf4504c61a3c6e3896fea1300c8100140902
+  data.tar.gz: ec8b97cf374d959037c8825e9f0a6131f487dcff
 SHA512:
-  metadata.gz: f5ee6c325526dbe4ea6f4a68cd60a310c33b563a3b05495de4197093061634086581702ab25973df67410ef28345484a0ddf224a6d580ab863fe7ce732f777eb
-  data.tar.gz: 6f308c0243d9af16a65b33e8c35be667c27ce070500264ed236deb128c3bdfb4f9563aa879ece10d22386f4a92c4d56a42f2242003674a9038a585950f3d5839
+  metadata.gz: e630516db130906d81fc7dafcb8c8532711710cfe6dbcd2932d2245a8294af716ac65b4d2551876acac7815a8d08593009489329c1f305f8f4927e64cb19b2e0
+  data.tar.gz: 135a570b6781da6ffb9232845a6ef7a9c096edb63025588b77173b6b93f69e63ceeb8de41a8818aa2d4cbf3c9d15b4d7ed2f04ff6bf2973c3cea47d74bcd77f7

data/.travis.yml

@@ -1,3 +1,6 @@
 language: ruby
 rvm:
   - 2.2.0
+services:
+  - memcached
+  - redis-server

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 0.1.1
+
+- Use [MessagePack](https://github.com/msgpack/msgpack-ruby) for semaphore serialization.
+
+
 ## 0.1.0
 
-- First release
+- First release.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Nick Elser
+
+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

@@ -1,4 +1,4 @@
-# Suo
+# Suo [![Build Status](https://travis-ci.org/nickelser/suo.png?branch=master)](https://travis-ci.org/nickelser/suo)
 
 :lock: Distributed semaphores using Memcached or Redis in Ruby.
 

data/Rakefile

@@ -1,7 +1,8 @@
 require "bundler/gem_tasks"
 require "rake/testtask"
 
+task default: :test
 Rake::TestTask.new do |t|
   t.libs << "test"
-  t.pattern = "test/*_test.rb"
+  t.pattern = "test/**/*_test.rb"
 end

data/lib/suo/client/base.rb

@@ -82,14 +82,15 @@ module Suo
         private
 
         def serialize_locks(locks)
-          locks.map { |time, token| [time.to_f, token].join(":") }.join(",")
+          MessagePack.pack(locks.map { |time, token| [time.to_f, token] })
         end
 
-        def deserialize_locks(str)
-          str.split(",").map do |s|
-            time, token = s.split(":", 2)
-            [Time.at(time.to_f), token]
+        def deserialize_locks(val)
+          MessagePack.unpack(val).map do |time, token|
+            [Time.at(time), token]
           end
+        rescue EOFError => _
+          []
         end
 
         def clear_expired_locks(locks, options)

data/lib/suo/client/memcached.rb

@@ -16,7 +16,12 @@ module Suo
           begin
             start = Time.now.to_f
 
-            options[:retry_count].times do |i|
+            options[:retry_count].times do
+              if options[:retry_timeout]
+                now = Time.now.to_f
+                break if now - start > options[:retry_timeout]
+              end
+
               val, cas = client.get_cas(key)
 
               # no key has been set yet; we could simply set it, but would lead to race conditions on the initial setting
@@ -38,11 +43,6 @@ module Suo
                 end
               end
 
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
               sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
             end
           rescue => _
@@ -60,6 +60,11 @@ module Suo
             start = Time.now.to_f
 
             options[:retry_count].times do
+              if options[:retry_timeout]
+                now = Time.now.to_f
+                break if now - start > options[:retry_timeout]
+              end
+
               val, cas = client.get_cas(key)
 
               # much like with initial set - ensure the key is here
@@ -76,11 +81,6 @@ module Suo
 
               break if client.set_cas(key, newval, cas)
 
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
               sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
             end
           rescue => _
@@ -98,6 +98,11 @@ module Suo
             start = Time.now.to_f
 
             options[:retry_count].times do
+              if options[:retry_timeout]
+                now = Time.now.to_f
+                break if now - start > options[:retry_timeout]
+              end
+
               val, cas = client.get_cas(key)
 
               break if val.nil? # lock has expired totally
@@ -114,11 +119,6 @@ module Suo
 
               # another client cleared a token in the interim - try again!
 
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
               sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
             end
           rescue => boom # rubocop:disable Lint/HandleExceptions

data/lib/suo/client/redis.rb

@@ -17,6 +17,11 @@ module Suo
             start = Time.now.to_f
 
             options[:retry_count].times do
+              if options[:retry_timeout]
+                now = Time.now.to_f
+                break if now - start > options[:retry_timeout]
+              end
+
               client.watch(key) do
                 begin
                   val = client.get(key)
@@ -41,15 +46,9 @@ module Suo
 
               break if acquisition_token
 
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
               sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
             end
-          rescue => boom
-            raise boom
+          rescue => _
             raise Suo::Client::FailedToAcquireLock
           end
 
@@ -65,6 +64,11 @@ module Suo
             start = Time.now.to_f
 
             options[:retry_count].times do
+              if options[:retry_timeout]
+                now = Time.now.to_f
+                break if now - start > options[:retry_timeout]
+              end
+
               client.watch(key) do
                 begin
                   val = client.get(key)
@@ -87,11 +91,6 @@ module Suo
 
               break if refreshed
 
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
               sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
             end
           rescue => _
@@ -111,6 +110,11 @@ module Suo
             options[:retry_count].times do
               cleared = false
 
+              if options[:retry_timeout]
+                now = Time.now.to_f
+                break if now - start > options[:retry_timeout]
+              end
+
               client.watch(key) do
                 begin
                   val = client.get(key)
@@ -144,11 +148,6 @@ module Suo
 
               break if cleared
 
-              if options[:retry_timeout]
-                now = Time.now.to_f
-                break if now - start > options[:retry_timeout]
-              end
-
               sleep(rand(options[:retry_delay] * 1000).to_f / 1000)
             end
           rescue => boom # rubocop:disable Lint/HandleExceptions

data/lib/suo/clients.rb

@@ -6,6 +6,8 @@ require "dalli/cas/client"
 
 require "redis"
 
+require "msgpack"
+
 require "suo/client/errors"
 require "suo/client/base"
 require "suo/client/memcached"

data/lib/suo/version.rb

@@ -1,3 +1,3 @@
 module Suo
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/suo.gemspec

@@ -1,7 +1,7 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'suo/version'
+require "suo/version"
 
 Gem::Specification.new do |spec|
   spec.name          = "suo"
@@ -10,12 +10,14 @@ Gem::Specification.new do |spec|
   spec.email         = ["nick.elser@gmail.com"]
 
   spec.summary       = %q(Distributed semaphores using Memcached or Redis.)
-  # spec.description   = %q{TODO: Long description}
+  spec.description   = %q(Distributed semaphores using Memcached or Redis.)
   spec.homepage      = "https://github.com/nickelser/suo"
+  spec.license       = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.files         = `git ls-files -z`.split("\x0")
   spec.bindir        = "bin"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  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_dependency "dalli"
@@ -25,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.5"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rubocop", "~> 0.30.0"
+  spec.add_development_dependency "minitest", "~> 5.5.0"
 end

data/test/client_test.rb

@@ -0,0 +1,154 @@
+require "test_helper"
+
+TEST_KEY = "suo_test_key".freeze
+
+module ClientTests
+  def test_requires_client
+    exception = assert_raises(RuntimeError) do
+      @klass.lock(TEST_KEY, 1)
+    end
+
+    assert_equal "Client required", exception.message
+  end
+
+  def test_class_single_resource_locking
+    lock1 = @klass.lock(TEST_KEY, 1, client: @klass_client)
+    refute_nil lock1
+
+    locked = @klass.locked?(TEST_KEY, 1, client: @klass_client)
+    assert_equal true, locked
+
+    lock2 = @klass.lock(TEST_KEY, 1, client: @klass_client)
+    assert_nil lock2
+
+    @klass.unlock(TEST_KEY, lock1, client: @klass_client)
+
+    locked = @klass.locked?(TEST_KEY, 1, client: @klass_client)
+    assert_equal false, locked
+  end
+
+  def test_class_multiple_resource_locking
+    lock1 = @klass.lock(TEST_KEY, 2, client: @klass_client)
+    refute_nil lock1
+
+    locked = @klass.locked?(TEST_KEY, 2, client: @klass_client)
+    assert_equal false, locked
+
+    lock2 = @klass.lock(TEST_KEY, 2, client: @klass_client)
+    refute_nil lock2
+
+    locked = @klass.locked?(TEST_KEY, 2, client: @klass_client)
+    assert_equal true, locked
+
+    @klass.unlock(TEST_KEY, lock1, client: @klass_client)
+
+    locked = @klass.locked?(TEST_KEY, 1, client: @klass_client)
+    assert_equal true, locked
+
+    @klass.unlock(TEST_KEY, lock2, client: @klass_client)
+
+    locked = @klass.locked?(TEST_KEY, 1, client: @klass_client)
+    assert_equal false, locked
+  end
+
+  def test_instance_single_resource_locking
+    locked = false
+
+    @client.lock(TEST_KEY, 1) { locked = true }
+
+    assert_equal true, locked
+  end
+
+  def test_instance_unlocks_on_exception
+    assert_raises(RuntimeError) do
+      @client.lock(TEST_KEY, 1) { fail "Test" }
+    end
+
+    locked = @klass.locked?(TEST_KEY, 1, client: @klass_client)
+    assert_equal false, locked
+  end
+
+  def test_instance_multiple_resource_locking
+    success_counter = Queue.new
+    failure_counter = Queue.new
+
+    100.times.map do |i|
+      Thread.new do
+        success = @client.lock(TEST_KEY, 50, retry_timeout: 0.9) do
+          sleep(1)
+          success_counter << i
+        end
+
+        failure_counter << i unless success
+      end
+    end.map(&:join)
+
+    assert_equal 50, success_counter.size
+    assert_equal 50, failure_counter.size
+  end
+
+  def test_instance_multiple_resource_locking_longer_timeout
+    success_counter = Queue.new
+    failure_counter = Queue.new
+
+    100.times.map do |i|
+      Thread.new do
+        success = @client.lock(TEST_KEY, 50, retry_timeout: 2) do
+          sleep(1)
+          success_counter << i
+        end
+
+        failure_counter << i unless success
+      end
+    end.map(&:join)
+
+    assert_equal 100, success_counter.size
+    assert_equal 0, failure_counter.size
+  end
+end
+
+class TestBaseClient < Minitest::Test
+  def setup
+    @klass = Suo::Client::Base
+  end
+
+  def test_not_implemented
+    assert_raises(NotImplementedError) do
+      @klass.lock(TEST_KEY, 1)
+    end
+  end
+end
+
+class TestMemcachedClient < Minitest::Test
+  include ClientTests
+
+  def setup
+    @klass = Suo::Client::Memcached
+    @client = @klass.new
+    @klass_client = Dalli::Client.new("127.0.0.1:11211")
+  end
+
+  def teardown
+    @klass_client.delete(TEST_KEY)
+  end
+end
+
+class TestRedisClient < Minitest::Test
+  include ClientTests
+
+  def setup
+    @klass = Suo::Client::Redis
+    @client = @klass.new
+    @klass_client = Redis.new
+  end
+
+  def teardown
+    @klass_client.del(TEST_KEY)
+  end
+end
+
+class TestLibrary < Minitest::Test
+  def test_that_it_has_a_version_number
+    refute_nil ::Suo::VERSION
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,9 @@
+$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+
+require "suo"
+require "thread"
+require "minitest/autorun"
+require "minitest/benchmark"
+
+ENV["SUO_TEST"] = "true"
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: suo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Nick Elser
@@ -94,10 +94,26 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.30.0
-description: 
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.5.0
+description: Distributed semaphores using Memcached or Redis.
 email:
 - nick.elser@gmail.com
-executables: []
+executables:
+- console
+- setup
 extensions: []
 extra_rdoc_files: []
 files:
@@ -106,6 +122,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
@@ -118,8 +135,11 @@ files:
 - lib/suo/clients.rb
 - lib/suo/version.rb
 - suo.gemspec
+- test/client_test.rb
+- test/test_helper.rb
 homepage: https://github.com/nickelser/suo
-licenses: []
+licenses:
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -141,4 +161,6 @@ rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Distributed semaphores using Memcached or Redis.
-test_files: []
+test_files:
+- test/client_test.rb
+- test/test_helper.rb