baza.rb 0.0.1

data/lib/baza.rb

@@ -0,0 +1,332 @@
+# 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.
+
+require 'typhoeus'
+require 'retries'
+require 'iri'
+require 'loog'
+require 'base64'
+require_relative 'baza/elapsed'
+
+# Interface to the API of zerocracy.com.
+#
+# You make an instance of this class and then call one of its methods.
+# The object will make HTTP request to api.zerocracy.com and interpret the
+# results returned.
+#
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class Baza
+  VERSION = '0.0.0'
+
+  def initialize(host, port, token, ssl: true, timeout: 30, retries: 3, loog: Loog::NULL, compression: true)
+    @host = host
+    @port = port
+    @ssl = ssl
+    @token = token
+    @timeout = timeout
+    @loog = loog
+    @retries = retries
+    @compression = compression
+  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
+  def push(name, data, meta)
+    id = 0
+    hdrs = headers.merge(
+      'Content-Type' => 'application/octet-stream',
+      'Content-Length' => data.size
+    )
+    unless meta.empty?
+      hdrs = hdrs.merge('X-Zerocracy-Meta' => meta.map { |v| Base64.encode64(v).gsub("\n", '') }.join(' '))
+    end
+    params = {
+      connecttimeout: @timeout,
+      timeout: @timeout,
+      body: data,
+      headers: hdrs
+    }
+    elapsed(@loog) do
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.put(
+              home.append('push').append(name).to_s,
+              @compression ? zipped(params) : params
+            )
+          )
+        end
+      id = ret.body.to_i
+      throw :"Pushed #{data.size} bytes to #{@host}, job ID is ##{id}"
+    end
+    id
+  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)
+    data = 0
+    elapsed(@loog) do
+      Tempfile.open do |file|
+        File.open(file, 'wb') do |f|
+          request = Typhoeus::Request.new(
+            home.append('pull').append("#{id}.fb").to_s,
+            headers: headers.merge(
+              'Accept' => 'application/octet-stream'
+            ),
+            connecttimeout: @timeout,
+            timeout: @timeout
+          )
+          request.on_body do |chunk|
+            f.write(chunk)
+          end
+          with_retries(max_tries: @retries) do
+            request.run
+          end
+          checked(request.response)
+        end
+        data = File.binread(file)
+        throw :"Pulled #{data.size} bytes of job ##{id} factbase at #{@host}"
+      end
+    end
+    data
+  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)
+    finished = false
+    elapsed(@loog) do
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.get(
+              home.append('finished').append(id).to_s,
+              headers:
+            )
+          )
+        end
+      finished = ret.body == 'yes'
+      throw :"The job ##{id} is #{finished ? '' : 'not yet '}finished at #{@host}"
+    end
+    finished
+  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)
+    stdout = ''
+    elapsed(@loog) do
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.get(
+              home.append('stdout').append("#{id}.txt").to_s,
+              headers:
+            )
+          )
+        end
+      stdout = ret.body
+      throw :"The stdout of the job ##{id} has #{stdout.split("\n")} lines"
+    end
+    stdout
+  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)
+    code = 0
+    elapsed(@loog) do
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.get(
+              home.append('exit').append("#{id}.txt").to_s,
+              headers:
+            )
+          )
+        end
+      code = ret.body.to_i
+      throw :"The exit code of the job ##{id} is #{code}"
+    end
+    code
+  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)
+    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
+    end
+  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)
+    elapsed(@loog) do
+      with_retries(max_tries: @retries) do
+        checked(
+          Typhoeus::Request.get(
+            home.append('unlock').append(name).add(owner:).to_s,
+            headers:
+          ),
+          302
+        )
+      end
+    end
+  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)
+    job = 0
+    elapsed(@loog) do
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.get(
+              home.append('recent').append("#{name}.txt").to_s,
+              headers:
+            )
+          )
+        end
+      job = ret.body.to_i
+      throw :"The recent \"#{name}\" job's ID is ##{job} at #{@host}"
+    end
+    job
+  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)
+    exists = 0
+    elapsed(@loog) do
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.get(
+              home.append('exists').append(name).to_s,
+              headers:
+            )
+          )
+        end
+      exists = ret.body == 'yes'
+      throw :"The name \"#{name}\" #{exists ? 'exists' : "doesn't exist"} at #{@host}"
+    end
+    exists
+  end
+
+  private
+
+  def headers
+    {
+      'User-Agent' => "baza.rb #{Baza::VERSION}",
+      'Connection' => 'close',
+      'X-Zerocracy-Token' => @token
+    }
+  end
+
+  def zipped(params)
+    body = gzip(params.fetch(:body))
+    headers = params
+      .fetch(:headers)
+      .merge(
+        {
+          'Content-Type' => 'application/zip',
+          'Content-Encoding' => 'gzip',
+          'Content-Length' => body.size
+        }
+      )
+    params.merge(body:, headers:)
+  end
+
+  def gzip(data)
+    ''.dup.tap do |result|
+      io = StringIO.new(result)
+      gz = Zlib::GzipWriter.new(io)
+      gz.write(data)
+      gz.close
+    end
+  end
+
+  def home
+    Iri.new('')
+      .host(@host)
+      .port(@port)
+      .scheme(@ssl ? 'https' : 'http')
+  end
+
+  def checked(ret, allowed = [200])
+    allowed = [allowed] unless allowed.is_a?(Array)
+    mtd = (ret.request.original_options[:method] || '???').upcase
+    url = ret.effective_url
+    log = "#{mtd} #{url} -> #{ret.code}"
+    if allowed.include?(ret.code)
+      @loog.debug(log)
+      return ret
+    end
+    @loog.debug("#{log}\n  #{(ret.headers || {}).map { |k, v| "#{k}: #{v}" }.join("\n  ")}")
+    msg = [
+      "Invalid response code ##{ret.code} ",
+      "at #{mtd} #{url}",
+      ret.headers['X-Zerocracy-Flash'] ? " (#{ret.headers['X-Zerocracy-Flash'].inspect})" : ''
+    ].join
+    case ret.code
+    when 500
+      msg +=
+        ', most probably it\'s an internal error on the server, ' \
+        'please report this to https://github.com/zerocracy/baza'
+    when 503
+      msg +=
+        ", most probably it's an internal error on the server (#{ret.headers['X-Zerocracy-Failure'].inspect}), " \
+        'please report this to https://github.com/zerocracy/baza.rb'
+    when 404
+      msg +=
+        ', most probably you are trying to reach a wrong server, which doesn\'t ' \
+        'have the URL that it is expected to have'
+    when 0
+      msg += ', most likely an internal error'
+    end
+    raise msg
+  end
+end

data/renovate.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+  "extends": [
+    "config:base"
+  ]
+}

data/test/test__helper.rb

@@ -0,0 +1,34 @@
+# 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.
+
+$stdout.sync = true
+
+require 'minitest/reporters'
+Minitest::Reporters.use! [Minitest::Reporters::SpecReporter.new]
+
+require 'simplecov'
+SimpleCov.start
+
+require 'simplecov-cobertura'
+SimpleCov.formatter = SimpleCov::Formatter::CoberturaFormatter
+
+require 'minitest/autorun'

data/test/test_baza.rb

@@ -0,0 +1,258 @@
+# 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.
+
+require 'minitest/autorun'
+require 'webmock/minitest'
+require 'webrick'
+require 'loog'
+require 'socket'
+require 'stringio'
+require 'random-port'
+require 'factbase'
+require 'securerandom'
+require 'net/ping'
+require_relative '../lib/baza'
+
+# Test.
+# Author:: Yegor Bugayenko (yegor256@gmail.com)
+# Copyright:: Copyright (c) 2024 Yegor Bugayenko
+# License:: MIT
+class TestBaza < Minitest::Test
+  TOKEN = '00000000-0000-0000-0000-000000000000'
+  HOST = 'api.zerocracy.com'
+  PORT = 443
+  LIVE = Baza.new(HOST, PORT, TOKEN)
+
+  def test_live_recent_check
+    WebMock.enable_net_connect!
+    skip unless we_are_online
+    assert(LIVE.recent('zerocracy').positive?)
+  end
+
+  def test_live_name_exists_check
+    WebMock.enable_net_connect!
+    skip unless we_are_online
+    assert(LIVE.name_exists?('zerocracy'))
+  end
+
+  def test_live_push
+    WebMock.enable_net_connect!
+    skip unless we_are_online
+    fb = Factbase.new
+    fb.insert.foo = 'test-' * 10_000
+    fb.insert
+    assert(LIVE.push(fake_name, fb.export, []).positive?)
+  end
+
+  def test_live_push_no_compression
+    WebMock.enable_net_connect!
+    skip unless we_are_online
+    fb = Factbase.new
+    fb.insert.foo = 'test-' * 10_000
+    fb.insert
+    baza = Baza.new(HOST, PORT, TOKEN, compression: false)
+    assert(baza.push(fake_name, fb.export, []).positive?)
+  end
+
+  def test_live_pull
+    WebMock.enable_net_connect!
+    skip unless we_are_online
+    id = LIVE.recent('zerocracy')
+    assert(!LIVE.pull(id).nil?)
+  end
+
+  def test_live_check_finished
+    WebMock.enable_net_connect!
+    skip unless we_are_online
+    id = LIVE.recent('zerocracy')
+    assert(!LIVE.finished?(id).nil?)
+  end
+
+  def test_live_read_stdout
+    WebMock.enable_net_connect!
+    skip unless we_are_online
+    id = LIVE.recent('zerocracy')
+    assert(!LIVE.stdout(id).nil?)
+  end
+
+  def test_live_read_exit_code
+    WebMock.enable_net_connect!
+    skip unless we_are_online
+    id = LIVE.recent('zerocracy')
+    assert(!LIVE.exit_code(id).nil?)
+  end
+
+  def test_live_lock_unlock
+    WebMock.enable_net_connect!
+    skip unless we_are_online
+    n = fake_name
+    owner = 'judges teesting'
+    assert(!LIVE.lock(n, owner).nil?)
+    assert(!LIVE.unlock(n, owner).nil?)
+  end
+
+  def test_simple_push
+    WebMock.disable_net_connect!
+    stub_request(:put, 'https://example.org/push/simple').to_return(
+      status: 200, body: '42'
+    )
+    assert_equal(
+      42,
+      Baza.new('example.org', 443, '000').push('simple', 'hello, world!', [])
+    )
+  end
+
+  def test_simple_recent_check
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/recent/simple.txt')
+      .with(body: '', headers: { 'User-Agent' => /^baza.rb .*$/ })
+      .to_return(status: 200, body: '42')
+    assert_equal(
+      42,
+      Baza.new('example.org', 443, '000').recent('simple')
+    )
+  end
+
+  def test_simple_exists_check
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/exists/simple').to_return(
+      status: 200, body: 'yes'
+    )
+    assert(
+      Baza.new('example.org', 443, '000').name_exists?('simple')
+    )
+  end
+
+  def test_exit_code_check
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/exit/42.txt').to_return(
+      status: 200, body: '0'
+    )
+    assert(
+      Baza.new('example.org', 443, '000').exit_code(42).zero?
+    )
+  end
+
+  def test_stdout_read
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/stdout/42.txt').to_return(
+      status: 200, body: 'hello!'
+    )
+    assert(
+      !Baza.new('example.org', 443, '000').stdout(42).empty?
+    )
+  end
+
+  def test_simple_pull
+    WebMock.disable_net_connect!
+    stub_request(:get, 'https://example.org/pull/333.fb').to_return(
+      status: 200, body: 'hello, world!'
+    )
+    assert(
+      Baza.new('example.org', 443, '000').pull(333).start_with?('hello')
+    )
+  end
+
+  def test_real_http
+    req =
+      with_http_server(200, 'yes') do |baza|
+        baza.name_exists?('simple')
+      end
+    assert_equal("baza.rb #{Baza::VERSION}", req['user-agent'])
+  end
+
+  def test_push_with_meta
+    req =
+      with_http_server(200, 'yes') do |baza|
+        baza.push('simple', 'hello, world!', ['boom!', 'хей!'])
+      end
+    assert_equal('Ym9vbSE= 0YXQtdC5IQ==', req['x-zerocracy-meta'])
+  end
+
+  def test_push_with_big_meta
+    req =
+      with_http_server(200, 'yes') do |baza|
+        baza.push(
+          'simple',
+          'hello, world!',
+          [
+            'pages_url:https://zerocracy.github.io/zerocracy.html',
+            'others:https://zerocracy.github.io/zerocracy.html',
+            'duration:59595'
+          ]
+        )
+      end
+    assert(req['x-zerocracy-meta'])
+  end
+
+  def test_push_compressed_content
+    skip # this test is not stable, see https://github.com/yegor256/judges/issues/105
+    req =
+      with_http_server(200, 'yes') do |baza|
+        baza.push('simple', 'hello, world!', %w[meta1 meta2 meta3])
+      end
+    assert_equal('application/zip', req.content_type)
+    assert_equal('gzip', req['content-encoding'])
+    body = Zlib::GzipReader.zcat(StringIO.new(req.body))
+    assert_equal('hello, world!', body)
+  end
+
+  def test_push_compression_disabled
+    req =
+      with_http_server(200, 'yes', compression: false) do |baza|
+        baza.push('simple', 'hello, world!', %w[meta1 meta2 meta3])
+      end
+    assert_equal('application/octet-stream', req.content_type)
+    assert_equal('hello, world!', req.body)
+  end
+
+  private
+
+  def with_http_server(code, response, opts = {})
+    opts = { ssl: false, timeout: 1 }.merge(opts)
+    WebMock.enable_net_connect!
+    req = WEBrick::HTTPRequest.new(WEBrick::Config::HTTP)
+    host = '127.0.0.1'
+    RandomPort::Pool::SINGLETON.acquire do |port|
+      server = TCPServer.new(host, port)
+      t =
+        Thread.new do
+          socket = server.accept
+          req.parse(socket)
+          req.body
+          socket.puts "HTTP/1.1 #{code} OK\r\nContent-Length: #{response.length}\r\n\r\n#{response}"
+          socket.close
+        end
+      yield Baza.new(host, port, '0000', **opts)
+      t.join
+    end
+    req
+  end
+
+  def fake_name
+    "fake-#{SecureRandom.hex(8)}"
+  end
+
+  def we_are_online
+    Net::Ping::External.new('8.8.8.8').ping?
+  end
+end