lusnoc 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 16c854beb66cb33dbc4cb2ee0026f4981de6f95a1ce3c86e3fec22a5c7e7f382
+  data.tar.gz: 6f07727a72751aab2640714fe40c1b252d75fdc79388c1b20aecde9ba84e6396
+SHA512:
+  metadata.gz: 6d0bbb37004b463725e8f0261ca239c7f9ae146655a2e28cf8510989c70a35e6c8c03c8a1370645098183f263f5dcecaf8e1b8d1e570876814a25842f0077f49
+  data.tar.gz: 9ccba26ba0be610089dc8e0a24b4ba58846a3d8d41f11a88f4272592063602e35f4fb554b97e2fff42b80e842ee1ebf6fea417bbdbf1fb6e283c4002e647f64b

data/lib/lusnoc/configuration.rb

@@ -0,0 +1,20 @@
+require 'logger'
+
+module Lusnoc
+  # Methods for configuring Lusnoc
+  class Configuration
+
+    attr_accessor :url, :acl_token, :logger
+
+    # Override defaults for configuration
+    # @param url [String] consul's connection URL
+    # @param acl_token [String] a connection token used when making requests to consul
+    def initialize(url = 'http://localhost:8500', acl_token = nil)
+      @url = url
+      @acl_token = acl_token
+      @logger = Logger.new(STDOUT, level: Logger::INFO, progname: 'Lusnoc')
+    end
+
+  end
+end
+

data/lib/lusnoc/exceptions.rb

@@ -0,0 +1,12 @@
+require 'timeout'
+
+module Lusnoc
+
+  class Error < RuntimeError; end
+
+  class TimeoutError < Error; end
+
+  class ExpiredError < Error; end
+
+end
+

data/lib/lusnoc/helper.rb

@@ -0,0 +1,14 @@
+module Lusnoc
+  module Helper
+
+    def logger
+      Lusnoc.configuration.logger
+    end
+
+    def build_url(path)
+      Lusnoc.configuration.url + path
+    end
+
+  end
+end
+

data/lib/lusnoc/mutex.rb

@@ -0,0 +1,97 @@
+require 'socket'
+require 'forwardable'
+require 'lusnoc/session'
+
+module Lusnoc
+  class Mutex
+
+    include Helper
+    attr_reader :key, :value, :owner
+
+    def initialize(key, value = Socket.gethostname, ttl: 20)
+      @key = key
+      @value = value
+      @ttl = ttl
+    end
+
+    def locked?
+      !!owner
+    end
+
+    def owned?
+      owner == Thread.current
+    end
+
+    def session_id
+      @session&.id
+    end
+
+    [:time_to_expiration, :need_renew?, :ttl, :expired?, :live?, :live!, :renew].each do |m|
+      define_method(m) {@session&.public_send(m)}
+    end
+
+    def synchronize(timeout: 0, &block)
+      timeouter = Timeouter.new(timeout,
+                                exception_class:   TimeoutError,
+                                exception_message: 'mutex acquisition expired')
+
+      Session.new("mutex_session/#{key}", ttl: @ttl) do |session|
+        @session = session
+        session.on_session_die do
+          @owner = nil
+        end
+
+        return acquisition_loop! key, session, value, timeouter, &block
+      ensure
+        release(key, session.id, timeout: 2) rescue nil
+        logger.info("Lock #{key} released for session #{session.name}[#{session.id}]")
+        @owner = nil
+        @session = nil
+      end
+    end
+
+    private
+
+      def acquire(key, session, value)
+        resp = Lusnoc.http_put(build_url("/v1/kv/#{key}?acquire=#{session.id}"), value, timeout: 1)
+        return false if resp.body.chomp != 'true'
+
+        @owner = Thread.current
+        logger.info("Lock #{key} acquired for session #{session.name}[#{session.id}]")
+        renew
+        true
+      end
+
+      def release(key, session)
+        Lusnoc.http_put(build_url("/v1/kv/#{key}?release=#{session.id}"), timeout: 1)
+      end
+
+      def acquisition_loop!(key, session, value, timeouter)
+        return yield(self) if acquire(key, session, value)
+
+        logger.debug("Start #{key} acquisition loop for session #{session.name}[#{session.id}]")
+        timeouter.loop! do
+          session.live!(TimeoutError)
+          wait_for_key_released(key, timeouter.left)
+
+          return yield(self) if acquire(key, session, value)
+
+          logger.debug("Lock #{key} acquisition failed for session #{session.name}[#{session.id}]")
+          sleep 1
+        end
+      end
+
+      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|
+          result = JSON.parse(body.empty? ? '[{}]' : body)
+          return true if result.first['Session'].nil?
+        end
+      end
+
+  end
+end
+

data/lib/lusnoc/session.rb

@@ -0,0 +1,105 @@
+require 'lusnoc/watcher'
+
+module Lusnoc
+  class Session
+
+    include Helper
+
+    attr_reader :id, :name, :ttl, :live, :expired_at
+
+    def initialize(name, ttl: 20)
+      @name = name
+      @ttl = ttl
+
+      @id = create_session(name, ttl)
+      yield(self)
+    ensure
+      destroy_session(@id)
+    end
+
+    def expired?
+      !live?
+    end
+
+    def time_to_expiration
+      @expired_at && @expired_at - Time.now
+    end
+
+    def need_renew?
+      time_to_expiration && time_to_expiration < (@ttl / 2.0)
+    end
+
+    def live?
+      @live
+    end
+
+    def live!(exception_class = ExpiredError)
+      live? || (raise exception_class.new("Session #{id} expired"))
+    end
+
+    def renew
+      live!
+      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}"
+    end
+
+    def on_session_die(&block)
+      @session_die_cb = block
+    end
+
+    private
+
+      def create_session(name, ttl)
+        resp = Lusnoc.http_put(build_url('/v1/session/create'),
+                               { Name: name, TTL: "#{ttl}s", LockDelay: '5s' },
+                               { 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}"
+        @live = 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}]"
+        @live = false
+        @expired_at = nil
+      end
+
+      def start_watch_thread(session_id)
+        Thread.new do
+          logger.debug "Guard thread for Session #{name}[#{session_id}] started"
+
+          if wait_forever_for_session_gone(session_id)
+            logger.error "Session #{name}[#{session_id}] is gone"
+            @live = false
+            @expired_at = nil
+            @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
+      end
+
+
+  end
+end
+

data/lib/lusnoc/timeouter.rb

@@ -0,0 +1,51 @@
+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
+

data/lib/lusnoc/version.rb

@@ -0,0 +1,6 @@
+module Lusnoc
+
+  VERSION = '0.0.1'.freeze
+
+end
+

data/lib/lusnoc/watcher.rb

@@ -0,0 +1,44 @@
+require 'lusnoc/timeouter'
+require 'lusnoc/helper'
+
+module Lusnoc
+  class Watcher
+
+    include Helper
+
+    def initialize(base_url,
+                   timeout: 0,
+                   exception_class: TimeoutError,
+                   exception_message: 'watch timeout')
+      @base_url = base_url
+      @timeout = timeout
+      @exception_class = exception_class
+      @exception_message = exception_message
+    end
+
+    # run Consul blocking request in a loop with timeout support.
+    # break condition yielded by block call with response body
+    def run
+      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" : ''
+        url = "#{@base_url}?index=#{last_x_consul_index}#{wait_condition}"
+
+        resp = Lusnoc.http_get(url, timeout: timeouter.left)
+        return true if yield(resp.body)
+
+        logger.debug "Watch #{@base_url} response: #{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.rb

@@ -0,0 +1,71 @@
+require 'net/http'
+require 'json'
+
+require 'lusnoc/configuration'
+require 'lusnoc/session'
+require 'lusnoc/mutex'
+
+
+module Lusnoc
+
+  class << self
+
+    attr_accessor :configuration
+
+  end
+
+  self.configuration ||= Lusnoc::Configuration.new
+
+  class << self
+
+    def configure
+      self.configuration ||= Lusnoc::Configuration.new
+      yield(configuration)
+    end
+
+    def http_get(url, timeout: 1)
+      uri = URI(url)
+
+      with_http(uri, timeout: timeout) do |http|
+        req = Net::HTTP::Get.new(uri)
+
+        # configure http and request before send
+        yield(http, req) if block_given?
+        http.request(req)
+      end
+    end
+
+    def http_put(url, value = nil, timeout: 1)
+      uri = URI(url)
+      data = value.is_a?(String) ? value : JSON.generate(value) unless value.nil?
+
+      with_http(uri, timeout: timeout) do |http|
+        req = Net::HTTP::Put.new(uri).tap do |r|
+          r.body = data
+          r['Content-Type'] = 'application/json'
+        end
+
+        # configure http and request before send
+        yield(http, req) if block_given?
+        http.request(req)
+      end
+    end
+
+    private
+
+      def with_http(uri, timeout:)
+        Net::HTTP.start(uri.host, uri.port,
+                        use_ssl:          uri.scheme == 'https',
+                        read_timeout:     timeout,
+                        open_timeout:     1,
+                        continue_timeout: 1,
+                        write_timeout:    1,
+                        max_retries:      0) do |http|
+          yield(http)
+        end
+      end
+
+  end
+
+end
+

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: lusnoc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Samoilenko Yuri
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.0.1
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: rubocop
+  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: webmock
+  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: json
+  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: asd
+email:
+- kinnalru@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/lusnoc.rb
+- lib/lusnoc/configuration.rb
+- lib/lusnoc/exceptions.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
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: asd
+test_files: []