lusnoc 0.1.0 → 0.1.2.16548

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9d7357a1c2a8113aeb8609ee1dae3cae2ee40a75d5b7f89c33dd8dbb6025590
-  data.tar.gz: 186e2664d1f8659482abad06570f25445e17946f81e57ce62ef5a4a831ee4165
+  metadata.gz: 7bbe9d1f94b450c09aaeb7fe5283bef89ee796a4b57712af40603ba8eb5a3f0c
+  data.tar.gz: 2ceec91d3f94a92631698ad391b5c7848e57d4033dbd1766ab37d0cd75a1f322
 SHA512:
-  metadata.gz: d75571ec0a10776b116463c144a414dfa348848fe7671c4a57719179433d41cb0b833c905ca4d73eb84a28a5c17a80921f14b007613438ec88af9e37d862c4f0
-  data.tar.gz: 550e11d35d35a614d50c7714752d750e24db7f990f401362df781ee5751be34a8f036bedcef39ce55905cb9e2324c2d16b6aa85f8accddb26385307dea50072f
+  metadata.gz: 11b1834bca1940eea5d5099cff6100587bc5fbcf75ea012866629d23daa6f43a4c2cceeb76c26b58689adad5cffaad33f62d104fe3d75a33645cb4e39607b8e8
+  data.tar.gz: 5b356bfa4e314d7da5e4cba97e24abbe5b5ccfaa2e98c977d3c8f6d583c3f5ad3d12a616cf96f6ad120a3382d48dac2b53d197667fbcc9fbcee3886ad11362de

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2014-2019 Рнд Софт
+
+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,6 +1,15 @@
 # Lusnoc
 
-Lusnoc is reliable gem to deal with [Consul](https://www.consul.io). It is designed to be simple and without any background magic.
+[![Gem Version](https://badge.fury.io/rb/lusnoc.svg)](https://rubygems.org/gems/lusnoc)
+[![Gem](https://img.shields.io/gem/dt/lusnoc.svg)](https://rubygems.org/gems/lusnoc/versions)
+
+[![Test Coverage](https://api.codeclimate.com/v1/badges/ed48b89a9793a074cd23/test_coverage)](https://codeclimate.com/github/RnD-Soft/lusnoc/test_coverage)
+[![Maintainability](https://api.codeclimate.com/v1/badges/ed48b89a9793a074cd23/maintainability)](https://codeclimate.com/github/RnD-Soft/lusnoc/maintainability)
+[![Quality](https://lysander.x.rnds.pro/api/v1/badges/lusnoc_quality.svg)](https://lysander.x.rnds.pro/api/v1/badges/lusnoc_quality.html)
+[![Outdated](https://lysander.x.rnds.pro/api/v1/badges/lusnoc_outdated.svg)](https://lysander.x.rnds.pro/api/v1/badges/lusnoc_outdated.html)
+[![Vulnerabilities](https://lysander.x.rnds.pro/api/v1/badges/lusnoc_vulnerable.svg)](https://lysander.x.rnds.pro/api/v1/badges/lusnoc_vulnerable.html)
+
+Lusnoc is reliable gem to deal with [Consul](https://www.consul.io). It is designed to be simple and work without dark background magic.
 It is inspired by [consul-mutex](https://github.com/discourse/consul-mutex)(which has hard background magic). 
 
 ## FAQ
@@ -13,20 +22,20 @@ Lusnoc allows you to interact with Consul to provide distributed locks(mutex) to
 * consul-mutex starts background thread and  ***the block of code that you pass to #synchronize runs on a separate thread, and can be killed without warning if the mutex determines that it no longer holds the lock.***
 * diplomat provides the basic session/locks functionality but no automated control over it
 
-#### How luscon deal with sessions/mutexes?
-* Luscon ensures session creation/destruction upon block execution
-* Luscon uses only sessions with TTL to protect you system from stale sessions/locks
-* Luscon enforces you to manualy renew session(through callback or explicit check) but provide background session checker
-* Luscon tries to carefuly handle timeouts and expiration using Consul [blocking queries](https://www.consul.io/api/features/blocking.html)
+#### How Lusnoc deal with sessions/mutexes?
+* Lusnoc ensures session creation/destruction upon block execution
+* Lusnoc uses only sessions with TTL to protect you system from stale sessions/locks
+* Lusnoc enforces you to manualy renew session(through callback or explicit check) but provide background session checker
+* Lusnoc tries to carefuly handle timeouts and expiration using Consul [blocking queries](https://www.consul.io/api/features/blocking.html)
 
 # Usage
 
-Simply instantiate a new `Luscon::Mutex`, giving it the key you want to use
+Simply instantiate a new `Lusnoc::Mutex`, giving it the key you want to use
 as the "lock":
 
 ```ruby
-  require 'luscon/mutex'
-  mutex = Luscon::Mutex.new('/locks/mx1', ttl: 20)
+  require 'lusnoc/mutex'
+  mutex = Lusnoc::Mutex.new('/locks/mx1', ttl: 20)
 ```
 TTL will be used in session creation on `#synchronize`:
 ```ruby
@@ -39,13 +48,13 @@ By default, the "value" of the lock resource will be the hostname of the
 machine that it's running on (so you know who has the lock).  If, for some
 reason, you'd like to set the value to something else, you can do that, too:
 ```ruby
-  Luscon::Mutex.new('/some/key', value: {time: Time.now}).synchronize do |mx|
+  Lusnoc::Mutex.new('/some/key', value: {time: Time.now}).synchronize do |mx|
     #...
   end
 ```
-Session invalidation/renewval handled through mutex instance:
+Session invalidation/renewal handled through mutex instance:
 ```ruby
-  Luscon::Mutex.new('/some/key').synchronize do |mx|
+  Lusnoc::Mutex.new('/some/key').synchronize do |mx|
     mx.time_to_expiration # seconds to session expiration in consul. 
     mx.ttl                # session ttl. 
     mx.need_renew?        # true when time_to_expiration less than half of ttl
@@ -84,7 +93,7 @@ You can use only Session:
 Typical usage scenario:
 
 ```ruby
-  Luscon::Mutex.new('/some/key').synchronize do |mx|
+  Lusnoc::Mutex.new('/some/key').synchronize do |mx|
     # do some work
     mx.renew if mx.need_renew?
     # do other work
@@ -95,3 +104,15 @@ Typical usage scenario:
   end
 ```
 
+# Installation
+
+It's a gem:
+```bash
+  gem install lusnoc
+```
+There's also the wonders of [the Gemfile](http://bundler.io):
+```ruby
+  gem 'lusnoc'
+```
+
+

data/lib/lusnoc.rb

@@ -4,6 +4,7 @@ require 'json'
 require 'lusnoc/configuration'
 require 'lusnoc/session'
 require 'lusnoc/mutex'
+require 'lusnoc/guard'
 
 
 module Lusnoc

data/lib/lusnoc/guard.rb

@@ -0,0 +1,67 @@
+require 'timeouter'
+require 'lusnoc/helper'
+
+module Lusnoc
+  class Guard
+
+    include Helper
+
+    def initialize(base_url)
+      @base_url = base_url
+      yield(self) if block_given?
+    end
+
+    def condition(&block)
+      @condition = block
+      self
+    end
+
+    def then(&block)
+      @callback = block
+      self
+    end
+
+    def run
+      th = Thread.new do
+        logger.info "Guard[#{@base_url.inspect}] thread started"
+        watch_forever(@base_url)
+        fire!
+      rescue StandardError => e
+        logger.error "Guard[#{@base_url.inspect}] error: #{e.inspect}"
+        fire!
+      ensure
+        logger.info "Guard[#{@base_url.inspect}] finihsed"
+      end
+
+      yield
+    ensure
+      th.kill rescue nil
+    end
+
+    private
+
+      def fire!
+        @callback&.tap do |cb|
+          @callback = nil
+          logger.info "Guard[#{@base_url.inspect}] fired"
+          cb.call
+        end
+      end
+
+      def watch_forever(base_url)
+        last_x_consul_index = 1
+
+        Kernel.loop do
+          resp = Lusnoc.http_get("#{base_url}?index=#{last_x_consul_index}&wait=10s", timeout: 15)
+          logger.debug "Guard[#{@base_url.inspect}] response: #{resp.body}"
+          return unless @condition.call(resp.body)
+
+          index = [Integer(resp['x-consul-index']), 1].max
+          last_x_consul_index = (index < last_x_consul_index ? 1 : index)
+          sleep 1
+        end
+      end
+
+  end
+end
+

data/lib/lusnoc/mutex.rb

@@ -34,9 +34,7 @@ module Lusnoc
     end
 
     def synchronize(timeout: 0, &block)
-      timeouter = Timeouter.new(timeout,
-                                exception_class:   TimeoutError,
-                                exception_message: 'mutex acquisition expired')
+      t = Timeouter::Timer.new(timeout, eclass: TimeoutError, message: 'mutex acquisition expired')
 
       Session.new("mutex_session/#{key}", ttl: @ttl) do |session|
         @session = session
@@ -45,7 +43,7 @@ module Lusnoc
           @on_mutex_lost&.call(self)
         end
 
-        return acquisition_loop! key, session, value, timeouter, &block
+        return acquisition_loop! key, session, value, t, &block
       ensure
         release(key, session.id, timeout: 2) rescue nil
         logger.info("Lock #{key} released for session #{session.name}[#{session.id}]")
@@ -70,13 +68,13 @@ module Lusnoc
         Lusnoc.http_put(build_url("/v1/kv/#{key}?release=#{session.id}"), timeout: 1)
       end
 
-      def acquisition_loop!(key, session, value, timeouter)
+      def acquisition_loop!(key, session, value, t)
         return yield(self) if acquire(key, session, value)
 
         logger.debug("Start #{key} acquisition loop for session #{session.name}[#{session.id}]")
-        timeouter.loop! do
+        t.loop! do
           session.alive!(TimeoutError)
-          wait_for_key_released(key, timeouter.left)
+          wait_for_key_released(key, t.left)
 
           return yield(self) if acquire(key, session, value)
 
@@ -88,9 +86,9 @@ module Lusnoc
       def wait_for_key_released(key, timeout = nil)
         logger.debug "Waiting for key #{key} to be fre of any session"
         Lusnoc::Watcher.new(build_url("/v1/kv/#{key}"),
-                            timeout:           timeout,
-                            exception_class:   TimeoutError,
-                            exception_message: 'mutex acquisition expired').run do |body|
+                            timeout:  timeout,
+                            eclass:   TimeoutError,
+                            emessage: 'mutex acquisition expired').run do |body|
           result = JSON.parse(body.empty? ? '[{}]' : body)
           return true if result.first['Session'].nil?
         end

data/lib/lusnoc/session.rb

@@ -1,4 +1,5 @@
 require 'lusnoc/watcher'
+require 'lusnoc/guard'
 
 module Lusnoc
   class Session
@@ -12,9 +13,12 @@ module Lusnoc
       @ttl = ttl
 
       @id = create_session(name, ttl)
-      yield(self)
+
+      prepare_guard(@id).run do
+        yield(self)
+      end
     ensure
-      destroy_session(@id)
+      destroy_session(@id) if @id
     end
 
     def expired?
@@ -34,14 +38,14 @@ module Lusnoc
     end
 
     def alive!(exception_class = ExpiredError)
-      alive? || (raise exception_class.new("Session #{id} expired"))
+      alive? || (raise exception_class.new("Session[#{@name}:#{@id}] expired"))
     end
 
     def renew
       alive!
       Lusnoc.http_put(build_url("/v1/session/renew/#{@id}"), nil, timeout: 1)
       @expired_at = Time.now + ttl
-      logger.info "Session renewed: #{name}[#{@id}]. Next expiration: #{@expired_at}"
+      logger.info "Session[#{@name}:#{@id}] renewed. Next expiration: #{@expired_at}"
     end
 
     def on_session_die(&block)
@@ -56,50 +60,33 @@ module Lusnoc
                                { timeout: 1 })
         session_id = JSON.parse(resp.body)['ID']
         @expired_at = Time.now + ttl
-        logger.info "Session created: #{name}[#{session_id}]. TTL:#{ttl}s. Next expiration: #{@expired_at}"
+        logger.info "Session[#{name}:#{session_id}] created. TTL:#{ttl}s. Next expiration: #{@expired_at}"
         @alive = true
-        @th = start_watch_thread(session_id)
         session_id
       end
 
-      def destroy_session(session_id)
-        @th.kill rescue nil
-        Lusnoc.http_put(build_url("/v1/session/destroy/#{session_id}"),
-                        nil,
-                        timeout: 1) rescue nil
-        logger.info "Session destroyed: #{name}[#{session_id}]"
-        @alive = false
-        @expired_at = nil
-      end
-
-      def start_watch_thread(session_id)
-        Thread.new do
-          logger.debug "Guard thread for Session #{name}[#{session_id}] started"
+      def prepare_guard(session_id)
+        Lusnoc::Guard.new(build_url("/v1/session/info/#{session_id}")) do |guard|
+          guard.condition do |body|
+            !JSON.parse(body).empty? rescue false
+          end
 
-          if wait_forever_for_session_gone(session_id)
-            logger.error "Session #{name}[#{session_id}] is gone"
+          guard.then do
             @alive = false
             @expired_at = nil
+            logger.info "Session[#{@name}:#{session_id}] is gone"
             @session_die_cb&.call(self)
-          else
-            logger.unknown 'Something is wrong with thread logic'
           end
-        ensure
-          logger.debug "Guard thread for Session #{name}[#{session_id}] finihsed"
         end
       end
 
-      def wait_forever_for_session_gone(session_id)
-        Lusnoc::Watcher.new(build_url("/v1/session/info/#{session_id}"), timeout: 0).run do |body|
-          true if JSON.parse(body).empty?
-        end
-      rescue StandardError => e
-        logger.error "Session #{name}[#{session_id}] watch exception: #{e.inspect}"
-        logger.error e.backtrace.join("\n")
-        true
+      def destroy_session(session_id)
+        @alive = false
+        @expired_at = nil
+        Lusnoc.http_put(build_url("/v1/session/destroy/#{session_id}"), nil, timeout: 1) rescue nil
+        logger.info "Session[#{@name}:#{session_id}] destroyed"
       end
 
-
   end
 end
 

data/lib/lusnoc/version.rb

@@ -1,6 +1,6 @@
 module Lusnoc
 
-  VERSION = '0.1.0'.freeze
+  VERSION = '0.1.2'.freeze
 
 end
 

data/lib/lusnoc/watcher.rb

@@ -1,4 +1,5 @@
-require 'lusnoc/timeouter'
+require 'timeouter'
+require 'lusnoc/exceptions'
 require 'lusnoc/helper'
 
 module Lusnoc
@@ -8,12 +9,12 @@ module Lusnoc
 
     def initialize(base_url,
                    timeout: 0,
-                   exception_class: TimeoutError,
-                   exception_message: 'watch timeout')
+                   eclass: Lusnoc::TimeoutError,
+                   emessage: 'watch timeout')
       @base_url = base_url
       @timeout = timeout
-      @exception_class = exception_class
-      @exception_message = exception_message
+      @eclass = eclass
+      @emessage = emessage
     end
 
     # run Consul blocking request in a loop with timeout support.
@@ -22,13 +23,11 @@ module Lusnoc
       logger.debug "Watch #{@base_url} with #{@timeout.inspect} timeout"
       last_x_consul_index = 1
 
-      Timeouter.new(@timeout,
-                    exception_class:   @exception_class,
-                    exception_message: @exception_message).loop! do |timeouter|
-        wait_condition = timeouter.left ? "&wait=#{timeouter.left.to_i}s" : ''
+      Timeouter.loop!(@timeout, eclass: @eclass, message: @emessage) do |t|
+        wait_condition = t.left ? "&wait=#{t.left.to_i}s" : ''
         url = "#{@base_url}?index=#{last_x_consul_index}#{wait_condition}"
 
-        resp = Lusnoc.http_get(url, timeout: timeouter.left)
+        resp = Lusnoc.http_get(url, timeout: t.left)
         return true if yield(resp.body)
 
         logger.debug "Watch #{@base_url} response: #{resp.body}"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lusnoc
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.2.16548
 platform: ruby
 authors:
 - Samoilenko Yuri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-22 00:00:00.000000000 Z
+date: 2019-09-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,7 +59,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rspec_junit_formatter
+  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: simplecov
+  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: simplecov-console
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -100,6 +128,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: timeouter
+  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: Lusnoc is reliable gem to deal with consul
 email:
 - kinnalru@gmail.com
@@ -107,14 +149,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- LICENSE
 - README.md
 - lib/lusnoc.rb
 - lib/lusnoc/configuration.rb
 - lib/lusnoc/exceptions.rb
+- lib/lusnoc/guard.rb
 - lib/lusnoc/helper.rb
 - lib/lusnoc/mutex.rb
 - lib/lusnoc/session.rb
-- lib/lusnoc/timeouter.rb
 - lib/lusnoc/version.rb
 - lib/lusnoc/watcher.rb
 homepage: https://github.com/RnD-Soft/lusnoc
@@ -136,7 +179,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.4
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Lusnoc is reliable gem to deal with consul

data/lib/lusnoc/timeouter.rb

@@ -1,51 +0,0 @@
-require 'lusnoc/exceptions'
-
-module Lusnoc
-  class Timeouter
-
-    attr_reader :exhausted_at, :started_at
-
-    def initialize(timeout = 0,
-                   exception_class: TimeoutError,
-                   exception_message: 'execution expired')
-      timeout ||= 0
-      timeout = [timeout, 0].max
-
-      @default_exception_class = exception_class
-      @default_exception_message = exception_message
-
-      @started_at = Time.now.to_f
-      @exhausted_at = timeout > 0 ? @started_at + timeout : nil
-    end
-
-    def self.timeout(timeout = 0)
-      self.new(timeout)
-    end
-
-    def elapsed
-      Time.now.to_f - @started_at
-    end
-
-    def left
-      @exhausted_at && [@exhausted_at - Time.now.to_f, 0].max
-    end
-
-    def check
-      !@exhausted_at || (@exhausted_at > Time.now.to_f)
-    end
-
-    def check!(exception_class = @default_exception_class)
-      check || (raise exception_class.new(@default_exception_message))
-    end
-
-    def loop
-      yield(self) while self.check
-    end
-
-    def loop!(exception_class = @default_exception_class)
-      yield(self) while self.check!(exception_class)
-    end
-
-  end
-end
-