baza.rb 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a4854042d95be4cff78c5fa7d534c754025b0fea372586f6f782c755df332432
-  data.tar.gz: bffcee29566e8959085d7948365eebd8cfb399c248644f494b73e82de0c65734
+  metadata.gz: f06c63d179589bfc28c89fb3d60d4df8232fca069fdf1b225c830091765cef74
+  data.tar.gz: de1e9b335a7b34f702f3367980400d0667b08e78817ecef533eef0f81a38e1a5
 SHA512:
-  metadata.gz: d7e0c79a6f30febc5a408c7d63bab7606cdb9881c0bfc708fbd4ca7e5a60df14fe0d3677ec35c6fcf38210a23292fbe873bf51befd600040cfa42148170a8038
-  data.tar.gz: 027042ba55cd31a9ddea329efb085499deb342ba117a6a42782d1f328e74efb1164d12ae3329e7af0b4562705703f8af52b8057fa1012f0a8c2f9e488d3ad383
+  metadata.gz: 80c39feaf4cd305ba697f38225203f7a6917899cdc89a0ecf0735196b9f54691ebcac0b3742659e546e083d7d7e472f54c1d7648c9722ab478968e5b8a3bfcb4
+  data.tar.gz: 2f37dce17730366ae52e4a4cdd1e69651038402b2a2ab9e806829c275a9140fa0164bbdc31b550a4d809235615d976bd7705ab00e5e7a9186f29898ebece114b

data/.github/workflows/actionlint.yml

@@ -28,7 +28,7 @@ name: actionlint
       - master
 jobs:
   actionlint:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - name: Download actionlint

data/.github/workflows/codecov.yml

@@ -25,7 +25,7 @@ name: codecov
       - master
 jobs:
   codecov:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: ruby/setup-ruby@v1

data/.github/workflows/copyrights.yml

@@ -24,7 +24,7 @@ name: copyrights
   pull_request:
 jobs:
   copyrights:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: yegor256/copyrights-action@0.0.5

data/.github/workflows/markdown-lint.yml

@@ -32,7 +32,7 @@ concurrency:
   cancel-in-progress: true
 jobs:
   markdown-lint:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: articulate/actions-markdownlint@v1

data/.github/workflows/pdd.yml

@@ -28,7 +28,7 @@ name: pdd
       - master
 jobs:
   pdd:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: volodya-lombrozo/pdd-action@master

data/.github/workflows/xcop.yml

@@ -24,7 +24,7 @@ name: xcop
   pull_request:
 jobs:
   xcop:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: g4s8/xcop-action@master

data/.github/workflows/yamllint.yml

@@ -28,7 +28,7 @@ name: yamllint
       - master
 jobs:
   yamllint:
-    runs-on: ubuntu-22.04
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: ibiqlik/action-yamllint@v3

data/Gemfile

@@ -29,12 +29,12 @@ gem 'minitest-reporters', '1.7.1', require: false
 gem 'net-ping', '2.0.8', require: false
 gem 'rake', '13.2.1', require: false
 gem 'random-port', '>0', require: false
-gem 'rspec-rails', '6.1.4', require: false
-gem 'rubocop', '1.65.1', require: false
-gem 'rubocop-performance', '1.21.1', require: false
-gem 'rubocop-rspec', '3.0.4', require: false
+gem 'rspec-rails', '7.0.1', require: false
+gem 'rubocop', '1.66.1', require: false
+gem 'rubocop-performance', '1.22.1', require: false
+gem 'rubocop-rspec', '3.1.0', require: false
 gem 'simplecov', '0.22.0', require: false
 gem 'simplecov-cobertura', '2.1.0', require: false
 gem 'wait_for', '~>0', require: false
-gem 'webmock', '3.23.1', require: false
-gem 'yard', '0.9.36', require: false
+gem 'webmock', '3.24.0', require: false
+gem 'yard', '0.9.37', require: false

data/Gemfile.lock

@@ -78,8 +78,9 @@ GEM
       others (> 0)
       tago (> 0)
       yaml (~> 0.3)
-    faraday (2.11.0)
+    faraday (2.12.0)
       faraday-net_http (>= 2.0, < 3.4)
+      json
       logger
     faraday-http-cache (2.5.1)
       faraday (>= 0.8)
@@ -94,16 +95,16 @@ GEM
     ffi (1.17.0-x86_64-darwin)
     ffi (1.17.0-x86_64-linux-gnu)
     hashdiff (1.1.1)
-    i18n (1.14.5)
+    i18n (1.14.6)
       concurrent-ruby (~> 1.0)
     io-console (0.7.2)
-    irb (1.14.0)
+    irb (1.14.1)
       rdoc (>= 4.0.0)
       reline (>= 0.4.2)
     iri (0.8.0)
     json (2.7.2)
     language_server-protocol (3.17.0.3)
-    logger (1.6.0)
+    logger (1.6.1)
     loofah (2.22.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.12.0)
@@ -128,14 +129,14 @@ GEM
       racc (~> 1.4)
     others (0.0.3)
     parallel (1.26.3)
-    parser (3.3.4.2)
+    parser (3.3.5.0)
       ast (~> 2.4.1)
       racc
     psych (5.1.2)
       stringio
     public_suffix (6.0.1)
     racc (1.8.1)
-    rack (3.1.7)
+    rack (3.1.8)
     rack-session (2.0.0)
       rack (>= 3.0.0)
     rack-test (2.1.0)
@@ -164,45 +165,43 @@ GEM
     rdoc (6.7.0)
       psych (>= 4.0.0)
     regexp_parser (2.9.2)
-    reline (0.5.9)
+    reline (0.5.10)
       io-console (~> 0.5)
     retries (0.0.5)
-    rexml (3.3.6)
-      strscan
-    rspec-core (3.13.0)
+    rexml (3.3.8)
+    rspec-core (3.13.1)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.2)
+    rspec-expectations (3.13.3)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-mocks (3.13.1)
+    rspec-mocks (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
-    rspec-rails (6.1.4)
-      actionpack (>= 6.1)
-      activesupport (>= 6.1)
-      railties (>= 6.1)
+    rspec-rails (7.0.1)
+      actionpack (>= 7.0)
+      activesupport (>= 7.0)
+      railties (>= 7.0)
       rspec-core (~> 3.13)
       rspec-expectations (~> 3.13)
       rspec-mocks (~> 3.13)
       rspec-support (~> 3.13)
     rspec-support (3.13.1)
-    rubocop (1.65.1)
+    rubocop (1.66.1)
       json (~> 2.3)
       language_server-protocol (>= 3.17.0)
       parallel (~> 1.10)
       parser (>= 3.3.0.2)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 2.4, < 3.0)
-      rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.31.1, < 2.0)
+      rubocop-ast (>= 1.32.2, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.1)
+    rubocop-ast (1.32.3)
       parser (>= 3.3.1.0)
-    rubocop-performance (1.21.1)
+    rubocop-performance (1.22.1)
       rubocop (>= 1.48.1, < 2.0)
       rubocop-ast (>= 1.31.1, < 2.0)
-    rubocop-rspec (3.0.4)
+    rubocop-rspec (3.1.0)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
     securerandom (0.3.1)
@@ -213,28 +212,27 @@ GEM
     simplecov-cobertura (2.1.0)
       rexml
       simplecov (~> 0.19)
-    simplecov-html (0.12.3)
+    simplecov-html (0.13.1)
     simplecov_json_formatter (0.1.4)
     stringio (3.1.1)
-    strscan (3.1.0)
     tago (0.0.2)
     thor (1.3.2)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.5.0)
+    unicode-display_width (2.6.0)
     uri (0.13.1)
     useragent (0.16.10)
     wait_for (0.1.1)
-    webmock (3.23.1)
+    webmock (3.24.0)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
-    webrick (1.8.1)
+    webrick (1.8.2)
     yaml (0.3.0)
-    yard (0.9.36)
-    zeitwerk (2.6.17)
+    yard (0.9.37)
+    zeitwerk (2.7.0)
 
 PLATFORMS
   arm64-darwin-22
@@ -251,15 +249,15 @@ DEPENDENCIES
   net-ping (= 2.0.8)
   rake (= 13.2.1)
   random-port (> 0)
-  rspec-rails (= 6.1.4)
-  rubocop (= 1.65.1)
-  rubocop-performance (= 1.21.1)
-  rubocop-rspec (= 3.0.4)
+  rspec-rails (= 7.0.1)
+  rubocop (= 1.66.1)
+  rubocop-performance (= 1.22.1)
+  rubocop-rspec (= 3.1.0)
   simplecov (= 0.22.0)
   simplecov-cobertura (= 2.1.0)
   wait_for (~> 0)
-  webmock (= 3.23.1)
-  yard (= 0.9.36)
+  webmock (= 3.24.0)
+  yard (= 0.9.37)
 
 BUNDLED WITH
    2.4.22

data/README.md

@@ -10,7 +10,7 @@
 [![Hits-of-Code](https://hitsofcode.com/github/zerocracy/baza.rb)](https://hitsofcode.com/view/github/zerocracy/baza.rb)
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/zerocracy/baza.rb/blob/master/LICENSE.txt)
 
-It's an clinet for [Zerocracy API](https://www.zerocracy.com), in Ruby.
+It's an client for [Zerocracy API](https://www.zerocracy.com), in Ruby.
 
 ## How to contribute
 

data/lib/baza-rb/version.rb

@@ -30,5 +30,5 @@
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class BazaRb
-  VERSION = '0.0.8'
+  VERSION = '0.0.9'
 end

data/lib/baza-rb.rb

@@ -40,6 +40,15 @@ require_relative 'baza-rb/version'
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class BazaRb
+  # When the server failed (503).
+  class ServerFailure < StandardError; end
+
+  # When request timeout.
+  class TimedOut < StandardError; end
+
+  # Unexpected response arrived from the server.
+  class BadResponse < StandardError; end
+
   # Ctor.
   #
   # @param [String] host Host name
@@ -88,7 +97,7 @@ class BazaRb
     }
     elapsed(@loog) do
       ret =
-        with_retries(max_tries: @retries) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           checked(
             Typhoeus::Request.put(
               home.append('push').append(name).to_s,
@@ -126,7 +135,7 @@ class BazaRb
           request.on_body do |chunk|
             f.write(chunk)
           end
-          with_retries(max_tries: @retries) do
+          with_retries(max_tries: @retries, rescue: TimedOut) do
             request.run
           end
           checked(request.response)
@@ -148,7 +157,7 @@ class BazaRb
     finished = false
     elapsed(@loog) do
       ret =
-        with_retries(max_tries: @retries) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           checked(
             Typhoeus::Request.get(
               home.append('finished').append(id).to_s,
@@ -172,7 +181,7 @@ class BazaRb
     stdout = ''
     elapsed(@loog) do
       ret =
-        with_retries(max_tries: @retries) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           checked(
             Typhoeus::Request.get(
               home.append('stdout').append("#{id}.txt").to_s,
@@ -196,7 +205,7 @@ class BazaRb
     code = 0
     elapsed(@loog) do
       ret =
-        with_retries(max_tries: @retries) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           checked(
             Typhoeus::Request.get(
               home.append('exit').append("#{id}.txt").to_s,
@@ -220,7 +229,7 @@ class BazaRb
     verdict = 0
     elapsed(@loog) do
       ret =
-        with_retries(max_tries: @retries) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           checked(
             Typhoeus::Request.get(
               home.append('jobs').append(id).append('verified.txt').to_s,
@@ -243,7 +252,7 @@ class BazaRb
     raise 'The "name" of the job may not be empty' if name.empty?
     raise 'The "owner" of the lock is nil' if owner.nil?
     elapsed(@loog) do
-      with_retries(max_tries: @retries) do
+      with_retries(max_tries: @retries, rescue: TimedOut) do
         checked(
           Typhoeus::Request.get(
             home.append('lock').append(name).add(owner:).to_s,
@@ -265,7 +274,7 @@ class BazaRb
     raise 'The "name" of the job may not be empty' if name.empty?
     raise 'The "owner" of the lock is nil' if owner.nil?
     elapsed(@loog) do
-      with_retries(max_tries: @retries) do
+      with_retries(max_tries: @retries, rescue: TimedOut) do
         checked(
           Typhoeus::Request.get(
             home.append('unlock').append(name).add(owner:).to_s,
@@ -288,7 +297,7 @@ class BazaRb
     job = 0
     elapsed(@loog) do
       ret =
-        with_retries(max_tries: @retries) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           checked(
             Typhoeus::Request.get(
               home.append('recent').append("#{name}.txt").to_s,
@@ -312,7 +321,7 @@ class BazaRb
     exists = 0
     elapsed(@loog) do
       ret =
-        with_retries(max_tries: @retries) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           checked(
             Typhoeus::Request.get(
               home.append('exists').append(name).to_s,
@@ -338,7 +347,7 @@ class BazaRb
     id = nil
     elapsed(@loog) do
       ret =
-        with_retries(max_tries: @retries) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           checked(
             Typhoeus::Request.post(
               home.append('durables').append('place').to_s,
@@ -370,7 +379,7 @@ class BazaRb
     raise 'The "file" of the durable is nil' if file.nil?
     raise "The file '#{file}' is absent" unless File.exist?(file)
     elapsed(@loog) do
-      with_retries(max_tries: @retries) do
+      with_retries(max_tries: @retries, rescue: TimedOut) do
         checked(
           Typhoeus::Request.put(
             home.append('durables').append(id).to_s,
@@ -408,7 +417,7 @@ class BazaRb
         request.on_body do |chunk|
           f.write(chunk)
         end
-        with_retries(max_tries: @retries) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           request.run
         end
         checked(request.response)
@@ -427,7 +436,7 @@ class BazaRb
     raise 'The "owner" of the lock is nil' if owner.nil?
     raise 'The "owner" of the lock may not be empty' if owner.empty?
     elapsed(@loog) do
-      with_retries(max_tries: @retries) do
+      with_retries(max_tries: @retries, rescue: TimedOut) do
         checked(
           Typhoeus::Request.get(
             home.append('durables').append(id).append('lock').add(owner:).to_s,
@@ -450,7 +459,7 @@ class BazaRb
     raise 'The "owner" of the lock is nil' if owner.nil?
     raise 'The "owner" of the lock may not be empty' if owner.empty?
     elapsed(@loog) do
-      with_retries(max_tries: @retries) do
+      with_retries(max_tries: @retries, rescue: TimedOut) do
         checked(
           Typhoeus::Request.get(
             home.append('durables').append(id).append('unlock').add(owner:).to_s,
@@ -470,7 +479,6 @@ class BazaRb
   # @return [Boolean] TRUE if job taken, otherwise false
   def pop(owner, zip)
     raise 'The "zip" of the job is nil' if zip.nil?
-    raise "The 'zip' file is absent: #{zip}" unless File.exist?(zip)
     success = false
     FileUtils.rm_f(zip)
     elapsed(@loog) do
@@ -487,7 +495,7 @@ class BazaRb
         request.on_body do |chunk|
           f.write(chunk)
         end
-        with_retries(max_tries: @retries) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           request.run
         end
         ret = request.response
@@ -513,7 +521,7 @@ class BazaRb
     raise 'The "zip" of the job is nil' if zip.nil?
     raise "The 'zip' file is absent: #{zip}" unless File.exist?(zip)
     elapsed(@loog) do
-      with_retries(max_tries: @retries) do
+      with_retries(max_tries: @retries, rescue: TimedOut) do
         checked(
           Typhoeus::Request.put(
             home.append('finish').add(id:).to_s,
@@ -531,6 +539,37 @@ class BazaRb
     end
   end
 
+  # Enter a valve.
+  #
+  # @param [String] name Name of the job
+  # @param [String] badge Unique badge of the valve
+  # @param [String] why The reason
+  # @param [nil|Integer] job The ID of the job
+  # @return [String] The result just calculated or retrieved
+  def enter(name, badge, why, job)
+    elapsed(@loog, intro: "Entered valve #{badge} to #{name}") do
+      with_retries(max_tries: @retries, rescue: TimedOut) do
+        ret = checked(
+          Typhoeus::Request.get(
+            home.append('valves').append('result').add(badge:).to_s,
+            headers:
+          ),
+          [200, 204]
+        )
+        return ret.body if ret.code == 200
+        r = yield
+        uri = home.append('valves').append('add')
+          .add(name:)
+          .add(badge:)
+          .add(why:)
+          .add(result: r.to_s)
+        uri = uri.add(job:) unless job.nil?
+        checked(Typhoeus::Request.post(uri.to_s, headers:), 302)
+        r
+      end
+    end
+  end
+
   private
 
   def headers
@@ -571,14 +610,19 @@ class BazaRb
       .scheme(@ssl ? 'https' : 'http')
   end
 
+  # Check the HTTP response and return it.
+  #
+  # @param [Typhoeus::Response] ret The response
+  # @param [Array<Integer>] allowed List of acceptable HTTP codes
+  # @return [Typhoeus::Response] The same response
   def checked(ret, allowed = [200])
     allowed = [allowed] unless allowed.is_a?(Array)
     mtd = (ret.request.original_options[:method] || '???').upcase
     url = ret.effective_url
     if ret.return_code == :operation_timedout
       msg = "#{mtd} #{url} timed out in #{ret.total_time}s"
-      @loog.debug(msg)
-      raise msg
+      @loog.error(msg)
+      raise TimedOut, msg
     end
     log = "#{mtd} #{url} -> #{ret.code} (#{format('%0.2f', ret.total_time)}s)"
     if allowed.include?(ret.code)
@@ -608,6 +652,7 @@ class BazaRb
     when 0
       msg += ', most likely an internal error'
     end
-    raise msg
+    @loog.error(msg)
+    raise ServerFailure, msg
   end
 end

data/test/test_baza-rb.rb

@@ -89,6 +89,16 @@ class TestBazaRb < Minitest::Test
     end
   end
 
+  def test_live_enter_valve
+    WebMock.enable_net_connect!
+    skip unless we_are_online
+    r = 'something'
+    n = fake_name
+    badge = fake_name
+    assert_equal(r, LIVE.enter(n, badge, 'no reason', nil) { r })
+    assert_equal(r, LIVE.enter(n, badge, 'no reason', nil) { nil })
+  end
+
   def test_durable_place
     WebMock.disable_net_connect!
     stub_request(:post, 'https://example.org/durables/place').to_return(
@@ -180,7 +190,20 @@ class TestBazaRb < Minitest::Test
     )
   end
 
+  def test_push_with_server_failure
+    WebMock.disable_net_connect!
+    stub_request(:put, 'https://example.org/push/foo')
+      .to_return(status: 503, body: 'oops', headers: { 'X-Zerocracy-Failure': 'the failure' })
+      .to_raise('why second time?')
+    e = assert_raises { BazaRb.new('example.org', 443, '000').push('foo', 'data', []) }
+    [
+      'Invalid response code #503',
+      '"the failure"'
+    ].each { |t| assert(e.message.include?(t), "Can't find '#{t}' in #{e.message.inspect}") }
+  end
+
   def test_real_http
+    WebMock.enable_net_connect!
     req =
       with_http_server(200, 'yes') do |baza|
         baza.name_exists?('simple')
@@ -189,6 +212,7 @@ class TestBazaRb < Minitest::Test
   end
 
   def test_push_with_meta
+    WebMock.enable_net_connect!
     req =
       with_http_server(200, 'yes') do |baza|
         baza.push('simple', 'hello, world!', ['boom!', 'хей!'])
@@ -197,6 +221,7 @@ class TestBazaRb < Minitest::Test
   end
 
   def test_push_with_big_meta
+    WebMock.enable_net_connect!
     req =
       with_http_server(200, 'yes') do |baza|
         baza.push(
@@ -213,6 +238,7 @@ class TestBazaRb < Minitest::Test
   end
 
   def test_push_compressed_content
+    WebMock.enable_net_connect!
     req =
       with_http_server(200, 'yes') do |baza|
         baza.push('simple', 'hello, world!', %w[meta1 meta2 meta3])
@@ -224,6 +250,7 @@ class TestBazaRb < Minitest::Test
   end
 
   def test_push_compression_disabled
+    WebMock.enable_net_connect!
     req =
       with_http_server(200, 'yes', compress: false) do |baza|
         baza.push('simple', 'hello, world!', %w[meta1 meta2 meta3])
@@ -280,7 +307,7 @@ class TestBazaRb < Minitest::Test
   end
 
   def fake_name
-    "fake-#{SecureRandom.hex(8)}"
+    "fake#{SecureRandom.hex(8)}"
   end
 
   def we_are_online

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baza.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-30 00:00:00.000000000 Z
+date: 2024-10-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace