baza.rb 0.0.8 → 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,9 +23,18 @@ 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).
+  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
@@ -78,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,
@@ -88,7 +83,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,
@@ -109,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|
@@ -126,7 +121,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 +143,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 +167,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 +191,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,
@@ -217,10 +212,10 @@ 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) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           checked(
             Typhoeus::Request.get(
               home.append('jobs').append(id).append('verified.txt').to_s,
@@ -243,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) 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
 
@@ -265,7 +262,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,
@@ -285,10 +282,10 @@ 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) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           checked(
             Typhoeus::Request.get(
               home.append('recent').append("#{name}.txt").to_s,
@@ -309,10 +306,10 @@ 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) do
+        with_retries(max_tries: @retries, rescue: TimedOut) do
           checked(
             Typhoeus::Request.get(
               home.append('exists').append(name).to_s,
@@ -338,11 +335,12 @@ 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,
               body: {
+                '_csrf' => csrf,
                 'jname' => jname,
                 'file' => File.basename(file),
                 'zip' => File.open(file, 'rb')
@@ -370,7 +368,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 +406,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 +425,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 +448,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,
@@ -463,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)
@@ -470,7 +500,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 +516,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
@@ -503,17 +532,17 @@ 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
-      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 +560,65 @@ 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')
+        uri = uri.add(job:) unless job.nil?
+        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
@@ -556,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)
@@ -571,14 +659,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 +701,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__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