baza.rb 0.0.11 → 0.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6259199f7664798d339669ee679182f3876bbd71ff426f3f6810840b7aa2b43
-  data.tar.gz: 65e5b754e8381e01f486faad4eea1eccb80176743fca4bdd94c5a87ce35d4e54
+  metadata.gz: 2879a58b22740c55d8f4f433ad17d903c1d60fb4ffb7474f3e38eafd4de34c70
+  data.tar.gz: 2a37091f3541e6d44bf132532a0f77b3d813dbfad4e3a2b2d602419d5e48be43
 SHA512:
-  metadata.gz: 2b3a36f7079a85027d3a2cd5e2aad3230e70affcdaac34019a51af49f6aecfe6e5d3fad187bb48a9934aae8a670324c4845c97363c4e137deb23d69156e3b80d
-  data.tar.gz: 99d0ba75cc97f3e389836a85ea0afb65a05e453e8e430ec6320d6c07af971c229a969b9fd0f5412cc4e43b00de0845e7c9184dd95a41fee9529ba17485d91391
+  metadata.gz: d10abffe172d128c5cf4b0e15db6e24236378d4a13e8ce0ce4d303807c949196ac00b90daae47993250fc6f4c4ae4c58472160fdd51ff0665975a850bff18117
+  data.tar.gz: 634cf07d3c82b9685f46ced49044cf68c1f19c4a3e58a7e131a50e8f3d146cb33cc2011f641500b4c6ea2c930f0f896b624e347381845719b326390e33f238c8

data/lib/baza-rb/fake.rb

@@ -0,0 +1,183 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
+
+require 'factbase'
+require_relative '../baza-rb'
+require_relative 'version'
+
+# Fake interface to the API of zerocracy.com for testing.
+#
+# This class implements the same public interface as BazaRb but doesn't
+# make any network connections, instead returning predefined fake values.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024-2025 Yegor Bugayenko
+# License:: MIT
+class BazaRb::Fake
+  # 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
+  def push(_name, _data, _meta)
+    42
+  end
+
+  # Pull factbase from the server.
+  #
+  # @param [Integer] id The ID of the job on the server
+  # @return [Bytes] Binary data pulled
+  def pull(_id)
+    Factbase.new.export
+  end
+
+  # 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
+  def finished?(_id)
+    true
+  end
+
+  # Read and return the stdout of the job.
+  #
+  # @param [Integer] id The ID of the job on the server
+  # @return [String] The stdout, as a text
+  def stdout(_id)
+    'Fake stdout output'
+  end
+
+  # Read and return the exit code of the job.
+  #
+  # @param [Integer] id The ID of the job on the server
+  # @return [Integer] The exit code
+  def exit_code(_id)
+    0
+  end
+
+  # Read and return the verification verdict of the job.
+  #
+  # @param [Integer] id The ID of the job on the server
+  # @return [String] The verdict
+  def verified(_id)
+    'fake-verdict'
+  end
+
+  # Lock the name.
+  #
+  # @param [String] name The name of the job on the server
+  # @param [String] owner The owner of the lock (any string)
+  def lock(name, owner)
+    # nothing
+  end
+
+  # Unlock the name.
+  #
+  # @param [String] name The name of the job on the server
+  # @param [String] owner The owner of the lock (any string)
+  def unlock(name, owner)
+    # nothing
+  end
+
+  # Get the ID of the job by the name.
+  #
+  # @param [String] name The name of the job on the server
+  # @return [Integer] The ID of the job on the server
+  def recent(_name)
+    42
+  end
+
+  # Check whether the name of the job exists on the server.
+  #
+  # @param [String] name The name of the job on the server
+  # @return [Boolean] TRUE if such name exists
+  def name_exists?(_name)
+    true
+  end
+
+  # Place a single durable.
+  #
+  # @param [String] jname The name of the job on the server
+  # @param [String] file The file name
+  def durable_place(jname, file)
+    # nothing
+  end
+
+  # Save a single durable from local file to server.
+  #
+  # @param [Integer] id The ID of the durable
+  # @param [String] file The file to upload
+  def durable_save(id, file)
+    # nothing
+  end
+
+  # Load a single durable from server to local file.
+  #
+  # @param [Integer] id The ID of the durable
+  # @param [String] file The file to upload
+  def durable_load(id, file)
+    # nothing
+  end
+
+  # Lock a single durable.
+  #
+  # @param [Integer] id The ID of the durable
+  # @param [String] owner The owner of the lock
+  def durable_lock(id, owner)
+    # nothing
+  end
+
+  # Unlock a single durable.
+  #
+  # @param [Integer] id The ID of the durable
+  # @param [String] owner The owner of the lock
+  def durable_unlock(id, owner)
+    # nothing
+  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)
+    42
+  end
+
+  # Pop job from the server.
+  #
+  # @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
+  def pop(_owner, _zip)
+    true
+  end
+
+  # 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)
+    # nothing
+  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)
+    yield
+  end
+
+  # Get CSRF token from the server.
+  # @return [String] The token for this user
+  def csrf
+    'fake-csrf-token'
+  end
+end

data/lib/baza-rb/version.rb

@@ -13,5 +13,5 @@
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class BazaRb
-  VERSION = '0.0.11'
+  VERSION = '0.0.12'
 end

data/lib/baza-rb.rb

@@ -466,6 +466,7 @@ class BazaRb
   # @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
+  # @return [Integer] Receipt ID
   def transfer(recipient, amount, summary)
     raise 'The "recipient" is nil' if recipient.nil?
     raise 'The "amount" is nil' if amount.nil?

data/test/test_fake.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+# SPDX-FileCopyrightText: Copyright (c) 2024-2025 Zerocracy
+# SPDX-License-Identifier: MIT
+
+require_relative '../lib/baza-rb/fake'
+
+# Test fake object.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class TestFake < Minitest::Test
+  def test_pull
+    baza = BazaRb::Fake.new
+    bin = baza.pull(42)
+    refute_nil(bin)
+  end
+
+  def test_push
+    baza = BazaRb::Fake.new
+    id = baza.push('test-job', 'test-data', [])
+    assert_equal(42, id)
+  end
+
+  def test_finished
+    baza = BazaRb::Fake.new
+    assert(baza.finished?(42))
+  end
+
+  def test_stdout
+    baza = BazaRb::Fake.new
+    output = baza.stdout(42)
+    assert_equal('Fake stdout output', output)
+  end
+
+  def test_exit_code
+    baza = BazaRb::Fake.new
+    code = baza.exit_code(42)
+    assert_equal(0, code)
+  end
+
+  def test_verified
+    baza = BazaRb::Fake.new
+    verdict = baza.verified(42)
+    assert_equal('fake-verdict', verdict)
+  end
+
+  def test_lock_unlock
+    baza = BazaRb::Fake.new
+    baza.lock('test-job', 'test-owner')
+    baza.unlock('test-job', 'test-owner')
+  end
+
+  def test_recent
+    baza = BazaRb::Fake.new
+    id = baza.recent('test-job')
+    assert_equal(42, id)
+  end
+
+  def test_name_exists
+    baza = BazaRb::Fake.new
+    assert(baza.name_exists?('test-job'))
+  end
+
+  def test_durable_operations
+    baza = BazaRb::Fake.new
+    baza.durable_place('test-job', 'test-file')
+    baza.durable_save(42, 'test-file')
+    baza.durable_load(42, 'test-file')
+    baza.durable_lock(42, 'test-owner')
+    baza.durable_unlock(42, 'test-owner')
+  end
+
+  def test_transfer
+    baza = BazaRb::Fake.new
+    receipt_id = baza.transfer('recipient', 1.0, 'test-payment')
+    assert_equal(42, receipt_id)
+  end
+
+  def test_pop
+    baza = BazaRb::Fake.new
+    result = baza.pop('test-owner', 'test.zip')
+    assert(result)
+  end
+
+  def test_finish
+    baza = BazaRb::Fake.new
+    baza.finish(42, 'test.zip')
+  end
+
+  def test_enter
+    baza = BazaRb::Fake.new
+    result =
+      baza.enter('test-job', 'test-badge', 'test-reason', 42) do
+        'test-result'
+      end
+    assert_equal('test-result', result)
+  end
+
+  def test_csrf
+    baza = BazaRb::Fake.new
+    token = baza.csrf
+    assert_equal('fake-csrf-token', token)
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: baza.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.11
+  version: 0.0.12
 platform: ruby
 authors:
 - Yegor Bugayenko
@@ -199,10 +199,12 @@ files:
 - Rakefile
 - baza.rb.gemspec
 - lib/baza-rb.rb
+- lib/baza-rb/fake.rb
 - lib/baza-rb/version.rb
 - renovate.json
 - test/test__helper.rb
 - test/test_baza-rb.rb
+- test/test_fake.rb
 homepage: http://github.com/zerocracy/baza.rb
 licenses:
 - MIT