baza.rb 0.0.9 → 0.0.10

data/lib/baza-rb.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2024 Zerocracy
-#
-# 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.
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
 
 require 'base64'
 require 'elapsed'
@@ -26,8 +9,11 @@ require 'fileutils'
 require 'iri'
 require 'loog'
 require 'retries'
+require 'stringio'
 require 'tago'
+require 'tempfile'
 require 'typhoeus'
+require 'zlib'
 require_relative 'baza-rb/version'
 
 # Interface to the API of zerocracy.com.
@@ -37,7 +23,7 @@ require_relative 'baza-rb/version'
 # results returned.
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class BazaRb
   # When the server failed (503).
@@ -87,7 +73,7 @@ class BazaRb
       'Content-Length' => data.size
     )
     unless meta.empty?
-      hdrs = hdrs.merge('X-Zerocracy-Meta' => meta.map { |v| Base64.encode64(v).gsub("\n", '') }.join(' '))
+      hdrs = hdrs.merge('X-Zerocracy-Meta' => meta.map { |v| Base64.encode64(v).delete("\n") }.join(' '))
     end
     params = {
       connecttimeout: @timeout,
@@ -118,7 +104,7 @@ class BazaRb
   def pull(id)
     raise 'The ID of the job is nil' if id.nil?
     raise 'The ID of the job must be a positive integer' unless id.positive?
-    data = 0
+    data = ''
     elapsed(@loog) do
       Tempfile.open do |file|
         File.open(file, 'wb') do |f|
@@ -226,7 +212,7 @@ class BazaRb
   def verified(id)
     raise 'The ID of the job is nil' if id.nil?
     raise 'The ID of the job must be a positive integer' unless id.positive?
-    verdict = 0
+    verdict = ''
     elapsed(@loog) do
       ret =
         with_retries(max_tries: @retries, rescue: TimedOut) do
@@ -252,16 +238,18 @@ 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, rescue: TimedOut) do
-        checked(
-          Typhoeus::Request.get(
-            home.append('lock').append(name).add(owner:).to_s,
-            headers:
-          ),
-          302
-        )
-      end
-      throw :"Job name '#{name}' locked at #{@host}"
+      ret =
+        with_retries(max_tries: @retries, rescue: TimedOut) do
+          checked(
+            Typhoeus::Request.get(
+              home.append('lock').append(name).add(owner:).to_s,
+              headers:
+            ),
+            [302, 409]
+          )
+        end
+      throw :"Job name '#{name}' locked at #{@host}" if ret.code == 302
+      raise "Failed to lock '#{name}' job at #{@host}, it's most probably already locked"
     end
   end
 
@@ -294,7 +282,7 @@ class BazaRb
   def recent(name)
     raise 'The "name" of the job is nil' if name.nil?
     raise 'The "name" of the job may not be empty' if name.empty?
-    job = 0
+    job = nil
     elapsed(@loog) do
       ret =
         with_retries(max_tries: @retries, rescue: TimedOut) do
@@ -318,7 +306,7 @@ class BazaRb
   def name_exists?(name)
     raise 'The "name" of the job is nil' if name.nil?
     raise 'The "name" of the job may not be empty' if name.empty?
-    exists = 0
+    exists = false
     elapsed(@loog) do
       ret =
         with_retries(max_tries: @retries, rescue: TimedOut) do
@@ -352,6 +340,7 @@ class BazaRb
             Typhoeus::Request.post(
               home.append('durables').append('place').to_s,
               body: {
+                '_csrf' => csrf,
                 'jname' => jname,
                 'file' => File.basename(file),
                 'zip' => File.open(file, 'rb')
@@ -472,6 +461,38 @@ class BazaRb
     end
   end
 
+  # Transfer some funds to another user.
+  #
+  # @param [String] recipient GitHub name (e.g. "yegor256") of the recipient
+  # @param [Float] amount The amount in Z/USDT (not zents!)
+  # @param [String] summary The description of the payment
+  def transfer(recipient, amount, summary)
+    raise 'The "recipient" is nil' if recipient.nil?
+    raise 'The "amount" is nil' if amount.nil?
+    raise 'The "amount" must be Float' unless amount.is_a?(Float)
+    raise 'The "summary" is nil' if summary.nil?
+    elapsed(@loog) do
+      with_retries(max_tries: @retries, rescue: TimedOut) do
+        checked(
+          Typhoeus::Request.post(
+            home.append('account').append('transfer').to_s,
+            body: {
+              '_csrf' => csrf,
+              'human' => recipient,
+              'amount' => amount.to_s,
+              'summary' => summary
+            },
+            headers:,
+            connecttimeout: @timeout,
+            timeout: @timeout
+          ),
+          302
+        )
+      end
+      throw :"Transferred ##{amount} to @#{recipient} at #{@host}"
+    end
+  end
+
   # Pop job from the server.
   #
   # @param [String] owner Who is acting (could be any text)
@@ -511,13 +532,13 @@ class BazaRb
     success
   end
 
-  # Submit a ZIP archvie to finish a job.
+  # Submit a ZIP archive to finish a job.
   #
   # @param [Integer] id The ID of the job on the server
   # @param [String] zip The path to the ZIP file with the content of the archive
   def finish(id, zip)
-    raise 'The "id" of the job is nil' if id.nil?
-    raise 'The "id" of the job must be an integer' unless id.is_a?(Integer)
+    raise 'The ID of the job is nil' if id.nil?
+    raise 'The ID of the job must be a positive integer' unless id.positive?
     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
@@ -559,17 +580,45 @@ class BazaRb
         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)
+        checked(
+          Typhoeus::Request.post(
+            uri.to_s,
+            body: {
+              '_csrf' => csrf,
+              'name' => name,
+              'badge' => badge,
+              'why' => why,
+              'result' => r.to_s
+            },
+            headers:
+          ),
+          302
+        )
         r
       end
     end
   end
 
+  # Get CSRF token from the server.
+  # @return [String] The token for this user
+  def csrf
+    token = nil
+    elapsed(@loog) do
+      with_retries(max_tries: @retries, rescue: TimedOut) do
+        token = checked(
+          Typhoeus::Request.get(
+            home.append('csrf').to_s,
+            headers:
+          ),
+          200
+        ).body
+      end
+      throw :"CSRF token retrieved (#{token.length} chars)"
+    end
+    token
+  end
+
   private
 
   def headers
@@ -595,7 +644,7 @@ class BazaRb
   end
 
   def gzip(data)
-    ''.dup.tap do |result|
+    (+'').tap do |result|
       io = StringIO.new(result)
       gz = Zlib::GzipWriter.new(io)
       gz.write(data)

data/test/test__helper.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2024 Zerocracy
-#
-# 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 NONINFINGEMENT. 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.
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
 
 $stdout.sync = true
 

data/test/test_baza-rb.rb

@@ -1,24 +1,7 @@
 # frozen_string_literal: true
 
-# Copyright (c) 2024 Zerocracy
-#
-# 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.
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
 
 require 'factbase'
 require 'loog'
@@ -38,45 +21,52 @@ require_relative '../lib/baza-rb'
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class TestBazaRb < Minitest::Test
+  # The token to use for testing:
   TOKEN = '00000000-0000-0000-0000-000000000000'
+
+  # The host of the production platform:
   HOST = 'api.zerocracy.com'
+
+  # The HTTPS port to use:
   PORT = 443
+
+  # Live agent:
   LIVE = BazaRb.new(HOST, PORT, TOKEN, loog: Loog::VERBOSE)
 
   def test_live_push
     WebMock.enable_net_connect!
-    skip unless we_are_online
+    skip('We are offline') unless we_are_online
     fb = Factbase.new
     fb.insert.foo = 'test-' * 10_000
     fb.insert
     n = fake_name
-    assert(LIVE.push(n, fb.export, []).positive?)
+    assert_predicate(LIVE.push(n, fb.export, []), :positive?)
     assert(LIVE.name_exists?(n))
-    assert(LIVE.recent(n).positive?)
+    assert_predicate(LIVE.recent(n), :positive?)
     id = LIVE.recent(n)
     wait_for(60) { LIVE.finished?(id) }
-    assert(!LIVE.pull(id).nil?)
-    assert(!LIVE.stdout(id).nil?)
-    assert(!LIVE.exit_code(id).nil?)
-    assert(!LIVE.verified(id).nil?)
+    refute_nil(LIVE.pull(id))
+    refute_nil(LIVE.stdout(id))
+    refute_nil(LIVE.exit_code(id))
+    refute_nil(LIVE.verified(id))
     owner = 'baza.rb testing'
-    assert(!LIVE.lock(n, owner).nil?)
-    assert(!LIVE.unlock(n, owner).nil?)
+    refute_nil(LIVE.lock(n, owner))
+    refute_nil(LIVE.unlock(n, owner))
   end
 
   def test_live_push_no_compression
     WebMock.enable_net_connect!
-    skip unless we_are_online
+    skip('We are offline') unless we_are_online
     fb = Factbase.new
     fb.insert.foo = 'test-' * 10_000
     fb.insert
     baza = BazaRb.new(HOST, PORT, TOKEN, compress: false)
-    assert(baza.push(fake_name, fb.export, []).positive?)
+    assert_predicate(baza.push(fake_name, fb.export, []), :positive?)
   end
 
   def test_live_durable_lock_unlock
     WebMock.enable_net_connect!
-    skip unless we_are_online
+    skip('We are offline') unless we_are_online
     Dir.mktmpdir do |dir|
       file = File.join(dir, "#{fake_name}.bin")
       File.binwrite(file, 'hello')
@@ -91,7 +81,7 @@ class TestBazaRb < Minitest::Test
 
   def test_live_enter_valve
     WebMock.enable_net_connect!
-    skip unless we_are_online
+    skip('We are offline') unless we_are_online
     r = 'something'
     n = fake_name
     badge = fake_name
@@ -99,8 +89,22 @@ class TestBazaRb < Minitest::Test
     assert_equal(r, LIVE.enter(n, badge, 'no reason', nil) { nil })
   end
 
+  def test_get_csrf_token
+    WebMock.enable_net_connect!
+    skip('We are offline') unless we_are_online
+    assert_operator(LIVE.csrf.length, :>, 10)
+  end
+
+  def test_transfer_payment
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/csrf').to_return(body: 'token')
+    stub_request(:post, 'https://example.org/account/transfer').to_return(status: 302)
+    BazaRb.new('example.org', 443, '000').transfer('jeff', 42.50, 'for fun')
+  end
+
   def test_durable_place
     WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/csrf').to_return(body: 'token')
     stub_request(:post, 'https://example.org/durables/place').to_return(
       status: 302, headers: { 'X-Zerocracy-DurableId' => '42' }
     )
@@ -126,8 +130,8 @@ class TestBazaRb < Minitest::Test
     WebMock.disable_net_connect!
     stub_request(:get, 'https://example.org/pop?owner=me').to_return(status: 204)
     Tempfile.open do |zip|
-      assert(!BazaRb.new('example.org', 443, '000').pop('me', zip.path))
-      assert(!File.exist?(zip.path))
+      refute(BazaRb.new('example.org', 443, '000').pop('me', zip.path))
+      refute_path_exists(zip.path)
     end
   end
 
@@ -165,8 +169,8 @@ class TestBazaRb < Minitest::Test
     stub_request(:get, 'https://example.org/exit/42.txt').to_return(
       status: 200, body: '0'
     )
-    assert(
-      BazaRb.new('example.org', 443, '000').exit_code(42).zero?
+    assert_predicate(
+      BazaRb.new('example.org', 443, '000').exit_code(42), :zero?
     )
   end
 
@@ -175,8 +179,8 @@ class TestBazaRb < Minitest::Test
     stub_request(:get, 'https://example.org/stdout/42.txt').to_return(
       status: 200, body: 'hello!'
     )
-    assert(
-      !BazaRb.new('example.org', 443, '000').stdout(42).empty?
+    refute_empty(
+      BazaRb.new('example.org', 443, '000').stdout(42)
     )
   end
 
@@ -190,20 +194,35 @@ class TestBazaRb < Minitest::Test
     )
   end
 
+  def test_simple_lock_success
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/lock/name?owner=owner').to_return(status: 302)
+    BazaRb.new('example.org', 443, '000').lock('name', 'owner')
+  end
+
+  def test_simple_lock_failure
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/lock/name?owner=owner').to_return(status: 409)
+    assert_raises(StandardError) do
+      BazaRb.new('example.org', 443, '000').lock('name', 'owner')
+    end
+  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', []) }
+    e = assert_raises(StandardError) { 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}") }
+    ].each { |t| assert_includes(e.message, t, "Can't find '#{t}' in #{e.message.inspect}") }
   end
 
   def test_real_http
     WebMock.enable_net_connect!
+    skip('We are offline') unless we_are_online
     req =
       with_http_server(200, 'yes') do |baza|
         baza.name_exists?('simple')
@@ -213,6 +232,7 @@ class TestBazaRb < Minitest::Test
 
   def test_push_with_meta
     WebMock.enable_net_connect!
+    skip('We are offline') unless we_are_online
     req =
       with_http_server(200, 'yes') do |baza|
         baza.push('simple', 'hello, world!', ['boom!', 'хей!'])
@@ -222,6 +242,7 @@ class TestBazaRb < Minitest::Test
 
   def test_push_with_big_meta
     WebMock.enable_net_connect!
+    skip('We are offline') unless we_are_online
     req =
       with_http_server(200, 'yes') do |baza|
         baza.push(
@@ -239,6 +260,7 @@ class TestBazaRb < Minitest::Test
 
   def test_push_compressed_content
     WebMock.enable_net_connect!
+    skip('We are offline') unless we_are_online
     req =
       with_http_server(200, 'yes') do |baza|
         baza.push('simple', 'hello, world!', %w[meta1 meta2 meta3])
@@ -251,6 +273,7 @@ class TestBazaRb < Minitest::Test
 
   def test_push_compression_disabled
     WebMock.enable_net_connect!
+    skip('We are offline') unless we_are_online
     req =
       with_http_server(200, 'yes', compress: false) do |baza|
         baza.push('simple', 'hello, world!', %w[meta1 meta2 meta3])
@@ -261,6 +284,7 @@ class TestBazaRb < Minitest::Test
 
   def test_with_very_short_timeout
     WebMock.enable_net_connect!
+    skip('We are offline') unless we_are_online
     host = '127.0.0.1'
     RandomPort::Pool::SINGLETON.acquire do |port|
       server = TCPServer.new(host, port)
@@ -274,10 +298,10 @@ class TestBazaRb < Minitest::Test
           socket.puts "HTTP/1.1 200 OK\r\nContent-Length: 3\r\n\r\nabc"
           socket.close
         end
-      assert(
-        assert_raises do
+      assert_includes(
+        assert_raises(StandardError) do
           BazaRb.new(host, port, '0000', ssl: false, timeout: 0.01).push('x', 'y', [])
-        end.message.include?('timed out in')
+        end.message, 'timed out in'
       )
       t.join
     end
@@ -288,6 +312,7 @@ class TestBazaRb < Minitest::Test
   def with_http_server(code, response, opts = {})
     opts = { ssl: false, timeout: 1 }.merge(opts)
     WebMock.enable_net_connect!
+    skip('We are offline') unless we_are_online
     req = WEBrick::HTTPRequest.new(WEBrick::Config::HTTP)
     host = '127.0.0.1'
     RandomPort::Pool::SINGLETON.acquire do |port|
@@ -311,6 +336,6 @@ class TestBazaRb < Minitest::Test
   end
 
   def we_are_online
-    Net::Ping::External.new('8.8.8.8').ping?
+    @we_are_online ||= Net::Ping::External.new('8.8.8.8').ping?
   end
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: baza.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.0.10
 platform: ruby
 authors:
 - Yegor Bugayenko
-autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-10-14 00:00:00.000000000 Z
+date: 2025-03-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -182,6 +181,7 @@ files:
 - ".github/workflows/markdown-lint.yml"
 - ".github/workflows/pdd.yml"
 - ".github/workflows/rake.yml"
+- ".github/workflows/reuse.yml"
 - ".github/workflows/xcop.yml"
 - ".github/workflows/yamllint.yml"
 - ".gitignore"
@@ -193,7 +193,9 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
+- LICENSES/MIT.txt
 - README.md
+- REUSE.toml
 - Rakefile
 - baza.rb.gemspec
 - lib/baza-rb.rb
@@ -206,7 +208,6 @@ licenses:
 - MIT
 metadata:
   rubygems_mfa_required: 'true'
-post_install_message: 
 rdoc_options:
 - "--charset=UTF-8"
 require_paths:
@@ -222,8 +223,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key: 
+rubygems_version: 3.6.2
 specification_version: 4
 summary: Zerocracy API Ruby Client
 test_files: []