baza.rb 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 56c9306fec1c51c662d122a94bb3a04cb1bc1fca68e518fa43aa600dd93aac4e
-  data.tar.gz: c7ecb9b7213285cbea8302070bbbe0d43800e1c0f2a81cdf2747a50013b390a5
+  metadata.gz: a4fb6929da01d8ec60b802d9bd8c3300456ff66144723496bbe60a11b1f67fad
+  data.tar.gz: 29db7120d95c442fcb529e9f1f1d8f3c7145baca1cf829cd011bdf6b6d6918bd
 SHA512:
-  metadata.gz: 97b304210bef6e1c94db070044dbcc248b2f42d3982a5561eec155bd0c7f0040a7258c73cfb62b3ac6a2cf402ef6de9ef644cd41fe6311a0d10241ab2e68f8e9
-  data.tar.gz: 0a28fccff243c7539117f37633607451c7efa94f13b93e2f2848f8e3e662ffa337a7fab4569ebcad9a6d96ccb4eca2cf5f0aed72112148439e0673759d985b6d
+  metadata.gz: 0212eb14782da74ea7ecbfa855e3a075e4639577f512ea12f98549451a7000a820a0bbb918f909f0eacde8c62593bc62910b7829a759ee989a2844e5def8fb20
+  data.tar.gz: 883fb08a189555e8abdb1800c2ab2d08229833945b11809930412d5da82890b23856122c9e2fe6c44f369db007a0dee4ebb3b51991a7ba4eedca261ec135b934

data/.github/workflows/copyrights.yml

@@ -16,4 +16,4 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - uses: yegor256/copyrights-action@0.0.8
+      - uses: yegor256/copyrights-action@0.0.10

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

@@ -20,4 +20,4 @@ jobs:
     runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
-      - uses: articulate/actions-markdownlint@v1
+      - uses: DavidAnson/markdownlint-cli2-action@v20.0.0

data/.github/workflows/typos.yml

@@ -0,0 +1,19 @@
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
+---
+# yamllint disable rule:line-length
+name: typos
+'on':
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  typos:
+    timeout-minutes: 15
+    runs-on: ubuntu-24.04
+    steps:
+      - uses: actions/checkout@v4
+      - uses: crate-ci/typos@v1.32.0

data/.gitignore

@@ -1,10 +1,11 @@
-*.gem
-.DS_Store
 .bundle/
+.DS_Store
 .idea/
 .yardoc/
+*.gem
 coverage/
 doc/
 node_modules/
 rdoc/
 vendor/
+.claude

data/.rubocop.yml

@@ -52,3 +52,4 @@ Layout/MultilineAssignmentLayout:
   Enabled: true
 Naming/FileName:
   Enabled: false
+require: []

data/Gemfile

@@ -10,7 +10,6 @@ gem 'base64', '>0', require: false
 gem 'factbase', '>0', require: false
 gem 'minitest', '~>5.25', require: false
 gem 'minitest-reporters', '~>1.7', require: false
-gem 'net-ping', '~>2.0', require: false
 gem 'os', '>0', require: false
 gem 'qbash', '>0', require: false
 gem 'rake', '~>13.2', require: false

data/Gemfile.lock

@@ -35,7 +35,7 @@ GEM
       tago (> 0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
-    factbase (0.9.10)
+    factbase (0.10.2)
       backtrace (~> 0.4)
       decoor (~> 0.0)
       json (~> 2.7)
@@ -45,7 +45,7 @@ GEM
       others (~> 0.0)
       tago (~> 0.0)
       yaml (~> 0.3)
-    faraday (2.12.2)
+    faraday (2.13.1)
       faraday-net_http (>= 2.0, < 3.5)
       json
       logger
@@ -55,19 +55,20 @@ GEM
       multipart-post (~> 2.0)
     faraday-net_http (3.4.0)
       net-http (>= 0.5.0)
-    faraday-retry (2.3.0)
+    faraday-retry (2.3.1)
       faraday (~> 2.0)
-    ffi (1.17.1-arm64-darwin)
-    ffi (1.17.1-x64-mingw-ucrt)
-    ffi (1.17.1-x86_64-darwin)
-    ffi (1.17.1-x86_64-linux-gnu)
-    hashdiff (1.1.2)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x64-mingw-ucrt)
+    ffi (1.17.2-x86_64-darwin)
+    ffi (1.17.2-x86_64-linux-gnu)
+    hashdiff (1.2.0)
     iri (0.10.0)
-    json (2.10.2)
-    language_server-protocol (3.17.0.4)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
     logger (1.7.0)
-    loog (0.6.0)
+    loog (0.6.1)
+      logger (~> 1.0)
     minitest (5.25.5)
     minitest-reporters (1.7.1)
       ansi
@@ -77,24 +78,23 @@ GEM
     multipart-post (2.4.1)
     net-http (0.6.0)
       uri
-    net-ping (2.0.8)
-    nokogiri (1.18.7-arm64-darwin)
+    nokogiri (1.18.8-arm64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x64-mingw-ucrt)
+    nokogiri (1.18.8-x64-mingw-ucrt)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-darwin)
+    nokogiri (1.18.8-x86_64-darwin)
       racc (~> 1.4)
-    nokogiri (1.18.7-x86_64-linux-gnu)
+    nokogiri (1.18.8-x86_64-linux-gnu)
       racc (~> 1.4)
     os (1.1.4)
     others (0.0.3)
-    parallel (1.26.3)
-    parser (3.3.7.4)
+    parallel (1.27.0)
+    parser (3.3.8.0)
       ast (~> 2.4.1)
       racc
     prism (1.4.0)
-    public_suffix (6.0.1)
-    qbash (0.4.0)
+    public_suffix (6.0.2)
+    qbash (0.4.5)
       backtrace (> 0)
       elapsed (> 0)
       loog (> 0)
@@ -107,7 +107,7 @@ GEM
     regexp_parser (2.10.0)
     retries (0.0.5)
     rexml (3.4.1)
-    rubocop (1.75.2)
+    rubocop (1.75.7)
       json (~> 2.3)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.1.0)
@@ -118,7 +118,7 @@ GEM
       rubocop-ast (>= 1.44.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 4.0)
-    rubocop-ast (1.44.0)
+    rubocop-ast (1.44.1)
       parser (>= 3.3.7.2)
       prism (~> 1.4)
     rubocop-minitest (0.38.0)
@@ -173,7 +173,6 @@ DEPENDENCIES
   factbase (> 0)
   minitest (~> 5.25)
   minitest-reporters (~> 1.7)
-  net-ping (~> 2.0)
   os (> 0)
   qbash (> 0)
   rake (~> 13.2)

data/README.md

@@ -11,7 +11,7 @@
 [![License](https://img.shields.io/badge/license-MIT-green.svg)](https://github.com/zerocracy/baza.rb/blob/master/LICENSE.txt)
 [![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fzerocracy%2Fbaza.rb.svg?type=shield&issueType=license)](https://app.fossa.com/projects/git%2Bgithub.com%2Fzerocracy%2Fbaza.rb?ref=badge_shield&issueType=license)
 
-It's an client for [Zerocracy API](https://www.zerocracy.com), in Ruby.
+It's a client for [Zerocracy API](https://www.zerocracy.com), in Ruby.
 
 ## How to contribute
 

data/REUSE.toml

@@ -4,9 +4,16 @@
 version = 1
 [[annotations]]
 path = [
+    ".DS_Store",
+    ".gitattributes",
+    ".gitignore",
+    ".pdd",
     "**.json",
     "**.md",
     "**.txt",
+    "**/.DS_Store",
+    "**/.gitignore",
+    "**/.pdd",
     "**/*.csv",
     "**/*.jpg",
     "**/*.json",
@@ -16,15 +23,8 @@ path = [
     "**/*.svg",
     "**/*.txt",
     "**/*.vm",
-    "**/.DS_Store",
-    "**/.gitignore",
-    "**/.pdd",
     "**/CNAME",
     "**/Gemfile.lock",
-    ".DS_Store",
-    ".gitattributes",
-    ".gitignore",
-    ".pdd",
     "Gemfile.lock",
     "README.md",
     "renovate.json",

data/Rakefile

@@ -24,19 +24,23 @@ task default: %i[clean test picks rubocop yard]
 
 require 'rake/testtask'
 desc 'Run all unit tests'
-Rake::TestTask.new(:test) do |test|
+Rake::TestTask.new(:test) do |t|
   Rake::Cleaner.cleanup_files(['coverage'])
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/test_*.rb'
-  test.warning = true
-  test.verbose = false
+  t.libs << 'lib' << 'test'
+  t.pattern = 'test/**/test_*.rb'
+  t.warning = true
+  t.verbose = false
+  t.options = ARGV.join(' ').match(/(?:^| )(-- .*)$/)
 end
 
 desc 'Run them via Ruby, one by one'
 task :picks do
   next if OS.windows?
   (Dir['test/**/*.rb'] + Dir['lib/**/*.rb']).each do |f|
-    qbash("bundle exec ruby #{Shellwords.escape(f)}", log: $stdout, env: { 'RACK_ENV' => 'picks' })
+    qbash(
+      "bundle exec ruby #{Shellwords.escape(f)} -- --offline",
+      log: $stdout, env: { 'RACK_ENV' => 'picks' }
+    )
   end
 end
 

data/lib/baza-rb/fake.rb

@@ -7,10 +7,16 @@ require 'factbase'
 require_relative '../baza-rb'
 require_relative 'version'
 
-# Fake interface to the API of zerocracy.com for testing.
+# Fake implementation of the Zerocracy API client for testing.
 #
 # This class implements the same public interface as BazaRb but doesn't
-# make any network connections, instead returning predefined fake values.
+# make any network connections. Instead, it returns predefined fake values
+# and validates inputs to help catch errors during testing.
+#
+# @example Using in tests
+#   baza = BazaRb::Fake.new
+#   assert_equal 'torvalds', baza.whoami
+#   assert_equal 42, baza.push('test-job', 'data', [])
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
@@ -18,17 +24,17 @@ require_relative 'version'
 class BazaRb::Fake
   # Get GitHub login name of the logged in user.
   #
-  # @return [String] GitHub nickname
+  # @return [String] Always returns 'torvalds' for testing
   def whoami
     'torvalds'
   end
 
   # Push factbase to the server.
   #
-  # @param [String] name The name of the job on the server
-  # @param [Bytes] data The data to push to the server (binary)
-  # @param [Array<String>] meta List of metas, possibly empty
-  # @return [Integer] Job ID on the server
+  # @param [String] name The unique name of the job on the server
+  # @param [String] data The binary data to push to the server
+  # @param [Array<String>] meta List of metadata strings to attach to the job
+  # @return [Integer] Always returns 42 as the fake job ID
   def push(name, data, meta)
     assert_name(name)
     raise 'The data must be non-empty' if data.empty?
@@ -39,16 +45,16 @@ class BazaRb::Fake
   # Pull factbase from the server.
   #
   # @param [Integer] id The ID of the job on the server
-  # @return [Bytes] Binary data pulled
+  # @return [String] Returns an empty factbase export for testing
   def pull(id)
     assert_id(id)
     Factbase.new.export
   end
 
-  # The job with this ID is finished already?
+  # Check if the job with this ID is finished already.
   #
   # @param [Integer] id The ID of the job on the server
-  # @return [Boolean] TRUE if the job is already finished
+  # @return [Boolean] Always returns TRUE for testing
   def finished?(id)
     assert_id(id)
     true
@@ -117,13 +123,15 @@ class BazaRb::Fake
     true
   end
 
-  # Place a single durable.
+  # Place a single durable file on the server.
   #
   # @param [String] jname The name of the job on the server
-  # @param [String] file The file name
+  # @param [String] file The path to the file to upload
+  # @return [Integer] Always returns 42 as the fake durable ID
   def durable_place(jname, file)
     assert_name(jname)
     assert_file(file)
+    42
   end
 
   # Save a single durable from local file to server.
@@ -162,18 +170,19 @@ class BazaRb::Fake
     assert_owner(owner)
   end
 
-  # Get current balance, in Ƶ.
+  # Get current balance of the authenticated user.
   #
-  # @return [Float] The balance, as float
+  # @return [Float] Always returns 3.14 zents for testing
   def balance
     3.14
   end
 
-  # Transfer some funds to another user.
+  # Transfer 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
+  # @param [String] recipient GitHub username of the recipient
+  # @param [Float] amount The amount to transfer in ƶ (zents)
+  # @param [String] summary The description/reason for the payment
+  # @return [Integer] Always returns 42 as the fake receipt ID
   def transfer(recipient, amount, summary, *)
     raise "The recipient #{recipient.inspect} is not valid" unless recipient.match?(/^[a-zA-Z0-9-]+$/)
     raise "The amount #{amount} must be a Float" unless amount.is_a?(Float)
@@ -182,13 +191,13 @@ class BazaRb::Fake
     42
   end
 
-  # Pay fee, while working with a job.
+  # Pay a fee associated with a job.
   #
-  # @param [String] tab The tab of the fee (use "unknown" if not sure)
-  # @param [Float] amount The amount in Z/USDT (not zents!)
-  # @param [String] summary The description of the payment
-  # @param [Integer] job The ID of the job
-  # @return [Integer] Receipt ID
+  # @param [String] tab The category/type of the fee
+  # @param [Float] amount The fee amount in ƶ (zents)
+  # @param [String] summary The description/reason for the fee
+  # @param [Integer] job The ID of the job this fee is for
+  # @return [Integer] Always returns 42 as the fake receipt ID
   def fee(tab, amount, summary, job)
     raise 'The "tab" is nil' if tab.nil?
     raise "The amount #{amount} must be a Float" unless amount.is_a?(Float)
@@ -199,11 +208,11 @@ class BazaRb::Fake
     42
   end
 
-  # Pop job from the server.
+  # Pop the next available job from the server's queue.
   #
-  # @param [String] owner Who is acting (could be any text)
-  # @param [String] zip The path to ZIP archive to take
-  # @return [Boolean] TRUE if job taken, otherwise false
+  # @param [String] owner Identifier of who is taking the job
+  # @param [String] zip The local file path where the job's ZIP will be saved
+  # @return [Boolean] Always returns TRUE and creates an empty file
   def pop(owner, zip)
     assert_owner(owner)
     FileUtils.mkdir_p(File.dirname(zip))
@@ -211,22 +220,23 @@ class BazaRb::Fake
     true
   end
 
-  # Submit a ZIP archive to finish a job.
+  # Submit a ZIP archive to finish a previously popped 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
+  # @param [Integer] id The ID of the job to finish
+  # @param [String] zip The path to the ZIP file containing job results
   def finish(id, zip)
     assert_id(id)
     assert_file(zip)
   end
 
-  # Enter a valve.
+  # Enter a valve to cache or retrieve a computation result.
   #
   # @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
+  # @param [String] badge Unique identifier for this valve
+  # @param [String] why The reason/description for entering this valve
+  # @param [nil|Integer] job Optional job ID to associate with this valve
+  # @yield Block that computes the result
+  # @return [String] Always executes and returns the block's result
   def enter(name, badge, why, job)
     assert_name(name)
     raise "The badge '#{badge}' is not valid" unless badge.match?(/^[a-zA-Z0-9_-]+$/)
@@ -235,8 +245,9 @@ class BazaRb::Fake
     yield
   end
 
-  # Get CSRF token from the server.
-  # @return [String] The token for this user
+  # Get CSRF token from the server for authenticated requests.
+  #
+  # @return [String] Always returns 'fake-csrf-token' for testing
   def csrf
     'fake-csrf-token'
   end

data/lib/baza-rb/version.rb

@@ -10,8 +10,8 @@
 # other packages (thus failing the build).
 #
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
-# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
 # License:: MIT
 class BazaRb
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end