baza.rb 0.0.7 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cec6d23dff978b5dcf080a6940a875ee1f9a67eb07b61ee5ee4b8a98348113c4
-  data.tar.gz: 98eb41907e61acc9beeb0397da3b1ec0c9cbb8a1ebd7c8f57422f8be18947cf4
+  metadata.gz: a4854042d95be4cff78c5fa7d534c754025b0fea372586f6f782c755df332432
+  data.tar.gz: bffcee29566e8959085d7948365eebd8cfb399c248644f494b73e82de0c65734
 SHA512:
-  metadata.gz: 1df697ec1d35721c3d23e6ef0b05d0d1c7e99b47c959b8150e413b18f5fd131efb9d3ca28bbdff4343ab4f012ce86217f4b1ffc8508c92eec2842633b6bef354
-  data.tar.gz: 9f74b8782d6a5ad2bfa1f0d8450e1c033cf5c8ad22c2a083f20fb2d96f94a8abbdd572b612a9440edf74f1d40d3b09356c471e2befd85fdd8c020b69884f60f3
+  metadata.gz: d7e0c79a6f30febc5a408c7d63bab7606cdb9881c0bfc708fbd4ca7e5a60df14fe0d3677ec35c6fcf38210a23292fbe873bf51befd600040cfa42148170a8038
+  data.tar.gz: 027042ba55cd31a9ddea329efb085499deb342ba117a6a42782d1f328e74efb1164d12ae3329e7af0b4562705703f8af52b8057fa1012f0a8c2f9e488d3ad383

data/Gemfile.lock

@@ -3,6 +3,7 @@ PATH
   specs:
     baza.rb (0.0.0)
       backtrace (> 0)
+      elapsed (> 0)
       faraday (> 0)
       faraday-http-cache (> 0)
       faraday-multipart (> 0)
@@ -16,9 +17,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.2.0)
-      actionview (= 7.2.0)
-      activesupport (= 7.2.0)
+    actionpack (7.2.1)
+      actionview (= 7.2.1)
+      activesupport (= 7.2.1)
       nokogiri (>= 1.8.5)
       racc
       rack (>= 2.2.4, < 3.2)
@@ -27,13 +28,13 @@ GEM
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
       useragent (~> 0.16)
-    actionview (7.2.0)
-      activesupport (= 7.2.0)
+    actionview (7.2.1)
+      activesupport (= 7.2.1)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.2.0)
+    activesupport (7.2.1)
       base64
       bigdecimal
       concurrent-ruby (~> 1.0, >= 1.3.1)
@@ -62,6 +63,9 @@ GEM
     diff-lcs (1.5.1)
     docile (1.4.1)
     drb (2.2.1)
+    elapsed (0.0.1)
+      loog (> 0)
+      tago (> 0)
     erubi (1.13.0)
     ethon (0.16.0)
       ffi (>= 1.15.0)
@@ -74,14 +78,14 @@ GEM
       others (> 0)
       tago (> 0)
       yaml (~> 0.3)
-    faraday (2.10.1)
-      faraday-net_http (>= 2.0, < 3.2)
+    faraday (2.11.0)
+      faraday-net_http (>= 2.0, < 3.4)
       logger
     faraday-http-cache (2.5.1)
       faraday (>= 0.8)
     faraday-multipart (1.0.4)
       multipart-post (~> 2)
-    faraday-net_http (3.1.1)
+    faraday-net_http (3.3.0)
       net-http
     faraday-retry (2.2.1)
       faraday (~> 2.0)
@@ -123,7 +127,7 @@ GEM
     nokogiri (1.16.7-x86_64-linux)
       racc (~> 1.4)
     others (0.0.3)
-    parallel (1.26.2)
+    parallel (1.26.3)
     parser (3.3.4.2)
       ast (~> 2.4.1)
       racc
@@ -146,9 +150,9 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.2.0)
-      actionpack (= 7.2.0)
-      activesupport (= 7.2.0)
+    railties (7.2.1)
+      actionpack (= 7.2.1)
+      activesupport (= 7.2.1)
       irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
@@ -163,11 +167,11 @@ GEM
     reline (0.5.9)
       io-console (~> 0.5)
     retries (0.0.5)
-    rexml (3.3.5)
+    rexml (3.3.6)
       strscan
     rspec-core (3.13.0)
       rspec-support (~> 3.13.0)
-    rspec-expectations (3.13.1)
+    rspec-expectations (3.13.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.13.0)
     rspec-mocks (3.13.1)
@@ -193,7 +197,7 @@ GEM
       rubocop-ast (>= 1.31.1, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 2.4.0, < 3.0)
-    rubocop-ast (1.32.0)
+    rubocop-ast (1.32.1)
       parser (>= 3.3.1.0)
     rubocop-performance (1.21.1)
       rubocop (>= 1.48.1, < 2.0)
@@ -214,13 +218,13 @@ GEM
     stringio (3.1.1)
     strscan (3.1.0)
     tago (0.0.2)
-    thor (1.3.1)
+    thor (1.3.2)
     typhoeus (1.4.1)
       ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
-    uri (0.13.0)
+    uri (0.13.1)
     useragent (0.16.10)
     wait_for (0.1.1)
     webmock (3.23.1)

data/baza.rb.gemspec

@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
   s.rdoc_options = ['--charset=UTF-8']
   s.extra_rdoc_files = ['README.md', 'LICENSE.txt']
   s.add_dependency 'backtrace', '>0'
+  s.add_dependency 'elapsed', '>0'
   s.add_dependency 'faraday', '>0'
   s.add_dependency 'faraday-http-cache', '>0'
   s.add_dependency 'faraday-multipart', '>0'

data/lib/baza-rb/version.rb

@@ -22,9 +22,13 @@
 
 # Just a version.
 #
+# We keep this file separate from the "baza-rb.rb" in order to have an
+# ability to include it from the ".gemspec" script, without including all
+# other packages (thus failing the build).
+#
 # Author:: Yegor Bugayenko (yegor256@gmail.com)
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class BazaRb
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/lib/baza-rb.rb

@@ -21,6 +21,8 @@
 # SOFTWARE.
 
 require 'base64'
+require 'elapsed'
+require 'fileutils'
 require 'iri'
 require 'loog'
 require 'retries'
@@ -38,7 +40,17 @@ require_relative 'baza-rb/version'
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class BazaRb
-  def initialize(host, port, token, ssl: true, timeout: 30, retries: 3, loog: Loog::NULL, compression: true)
+  # Ctor.
+  #
+  # @param [String] host Host name
+  # @param [Integer] port TCP port
+  # @param [String] token Secret token of zerocracy.com
+  # @param [Boolean] ssl Should we use SSL?
+  # @param [Float] timeout Connect timeout and session timeout, in seconds
+  # @param [Integer] retries How many times to retry on connection failure?
+  # @param [Loog] loog The logging facility
+  # @param [Boolean] compress Set to TRUE if need to use GZIP while pulling and sending
+  def initialize(host, port, token, ssl: true, timeout: 30, retries: 3, loog: Loog::NULL, compress: true)
     @host = host
     @port = port
     @ssl = ssl
@@ -46,10 +58,11 @@ class BazaRb
     @timeout = timeout
     @loog = loog
     @retries = retries
-    @compression = compression
+    @compress = compress
   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
@@ -79,7 +92,7 @@ class BazaRb
           checked(
             Typhoeus::Request.put(
               home.append('push').append(name).to_s,
-              @compression ? zipped(params) : params
+              @compress ? zipped(params) : params
             )
           )
         end
@@ -90,6 +103,7 @@ class BazaRb
   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)
@@ -125,6 +139,7 @@ class BazaRb
   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)
@@ -148,6 +163,7 @@ class BazaRb
   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)
@@ -171,6 +187,7 @@ class BazaRb
   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)
@@ -194,6 +211,7 @@ class BazaRb
   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)
@@ -217,6 +235,7 @@ class BazaRb
   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)
@@ -238,6 +257,7 @@ class BazaRb
   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)
@@ -259,6 +279,7 @@ class BazaRb
   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)
@@ -282,6 +303,7 @@ class BazaRb
   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)
@@ -305,6 +327,7 @@ class BazaRb
   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)
@@ -338,6 +361,7 @@ class BazaRb
   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)
@@ -362,6 +386,7 @@ class BazaRb
   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)
@@ -393,6 +418,7 @@ class BazaRb
   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)
@@ -415,6 +441,7 @@ class BazaRb
   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)
@@ -436,6 +463,74 @@ class BazaRb
     end
   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)
+    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
+      File.open(zip, 'wb') do |f|
+        request = Typhoeus::Request.new(
+          home.append('pop').add(owner:).to_s,
+          method: :get,
+          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
+        ret = request.response
+        checked(ret, [200, 204])
+        success = ret.code == 200
+      end
+      unless success
+        FileUtils.rm_f(zip)
+        throw :"Nothing to pop at #{@host}"
+      end
+      throw :"Popped #{File.size(zip)} bytes in ZIP archive at #{@host}"
+    end
+    success
+  end
+
+  # Submit a ZIP archvie 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 "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
+        checked(
+          Typhoeus::Request.put(
+            home.append('finish').add(id:).to_s,
+            connecttimeout: @timeout,
+            timeout: @timeout,
+            body: File.binread(zip),
+            headers: headers.merge(
+              'Content-Type' => 'application/octet-stream',
+              'Content-Length' => File.size(zip)
+            )
+          )
+        )
+      end
+      throw :"Pushed #{File.size(zip)} bytes to #{@host}, finished job ##{id}"
+    end
+  end
+
   private
 
   def headers
@@ -460,17 +555,6 @@ class BazaRb
     params.merge(body:, headers:)
   end
 
-  def elapsed(loog)
-    start = Time.now
-    begin
-      yield
-    rescue UncaughtThrowError => e
-      tag = e.tag
-      throw e unless tag.is_a?(Symbol)
-      loog.info("#{tag} in #{start.ago}")
-    end
-  end
-
   def gzip(data)
     ''.dup.tap do |result|
       io = StringIO.new(result)

data/test/test_baza-rb.rb

@@ -70,7 +70,7 @@ class TestBazaRb < Minitest::Test
     fb = Factbase.new
     fb.insert.foo = 'test-' * 10_000
     fb.insert
-    baza = BazaRb.new(HOST, PORT, TOKEN, compression: false)
+    baza = BazaRb.new(HOST, PORT, TOKEN, compress: false)
     assert(baza.push(fake_name, fb.export, []).positive?)
   end
 
@@ -112,6 +112,23 @@ class TestBazaRb < Minitest::Test
     )
   end
 
+  def test_simple_pop
+    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))
+    end
+  end
+
+  def test_simple_finish
+    WebMock.disable_net_connect!
+    stub_request(:put, 'https://example.org/finish?id=42').to_return(status: 200)
+    Tempfile.open do |zip|
+      BazaRb.new('example.org', 443, '000').finish(42, zip.path)
+    end
+  end
+
   def test_simple_recent_check
     WebMock.disable_net_connect!
     stub_request(:get, 'https://example.org/recent/simple.txt')
@@ -208,7 +225,7 @@ class TestBazaRb < Minitest::Test
 
   def test_push_compression_disabled
     req =
-      with_http_server(200, 'yes', compression: false) do |baza|
+      with_http_server(200, 'yes', compress: false) do |baza|
         baza.push('simple', 'hello, world!', %w[meta1 meta2 meta3])
       end
     assert_equal('application/octet-stream', req.content_type)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baza.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-18 00:00:00.000000000 Z
+date: 2024-08-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -24,6 +24,20 @@ dependencies:
     - - ">"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: elapsed
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement