baza.rb 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4be56cc9f4d1ff997e1cfd2d933a61d12e6967218efd73020929ee5a799f94f
-  data.tar.gz: 5e63ac9c9a4f1dcd418aca195edaa7f41567d9ce038bc94527e6937e02e01ba7
+  metadata.gz: 014c248d64a458634ae5e0230dbffb3efe583b3290ba939b8dce3ed1f91f502b
+  data.tar.gz: 735858245c3ab0bf9d362d325a47e5304813a3b281e4cc78cafaf6ee066086cb
 SHA512:
-  metadata.gz: 67c9cfaedc2d58204e98a5a743a12427688fc18942833d60ddc7b740a283540f34daf73afbc3a31735e46a6c03dd4aee6bf95d07481750f3ddb3c3f93fb3d3c2
-  data.tar.gz: 6141cbec72e2f26f93848bd3316f3cee5c3b41172817a40b43b1acc636fcd3f28b1fa43bfea90bb2ec6671cea41fd552732f1d74fe13d8b31cfa69d97d601c29
+  metadata.gz: da30b50601a6354138e593fffc3680cd2648b6c7b9eeb62d949301ef72e89c9446643f9b15dbca0b252d4e062af8a4b63f5ab3b71cf1ab2abad632427c7f7254
+  data.tar.gz: 3b394b41273005c73431ca4e191e6f3a653db0498504d59422ef5dacb4d8b8bc59d5cc4ee8c890a79cd2d05100109e8e6151e9f82686ede138bb0f00109bb0bd

data/.github/workflows/rake.yml

@@ -31,7 +31,7 @@ jobs:
     name: test
     strategy:
       matrix:
-        os: [ubuntu-24.04, macos-12, windows-2022]
+        os: [ubuntu-24.04, macos-12]
         ruby: [3.3]
     runs-on: ${{ matrix.os }}
     steps:

data/Gemfile.lock

@@ -10,37 +10,40 @@ PATH
       iri (> 0)
       loog (> 0)
       retries (~> 0)
+      tago (~> 0)
       typhoeus (~> 1.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.1.3.4)
-      actionview (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
+    actionpack (7.2.0)
+      actionview (= 7.2.0)
+      activesupport (= 7.2.0)
       nokogiri (>= 1.8.5)
       racc
-      rack (>= 2.2.4)
+      rack (>= 2.2.4, < 3.2)
       rack-session (>= 1.0.1)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    actionview (7.1.3.4)
-      activesupport (= 7.1.3.4)
+      useragent (~> 0.16)
+    actionview (7.2.0)
+      activesupport (= 7.2.0)
       builder (~> 3.1)
       erubi (~> 1.11)
       rails-dom-testing (~> 2.2)
       rails-html-sanitizer (~> 1.6)
-    activesupport (7.1.3.4)
+    activesupport (7.2.0)
       base64
       bigdecimal
-      concurrent-ruby (~> 1.0, >= 1.0.2)
+      concurrent-ruby (~> 1.0, >= 1.3.1)
       connection_pool (>= 2.2.5)
       drb
       i18n (>= 1.6, < 2)
+      logger (>= 1.4.2)
       minitest (>= 5.1)
-      mutex_m
-      tzinfo (~> 2.0)
+      securerandom (>= 0.3)
+      tzinfo (~> 2.0, >= 2.0.5)
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
     ansi (1.5.0)
@@ -49,7 +52,7 @@ GEM
     base64 (0.2.0)
     bigdecimal (3.1.8)
     builder (3.3.0)
-    concurrent-ruby (1.3.3)
+    concurrent-ruby (1.3.4)
     connection_pool (2.4.1)
     crack (1.0.0)
       bigdecimal
@@ -108,7 +111,6 @@ GEM
       minitest (>= 5.0)
       ruby-progressbar
     multipart-post (2.4.1)
-    mutex_m (0.2.0)
     net-http (0.4.1)
       uri
     net-ping (2.0.8)
@@ -144,10 +146,10 @@ GEM
     rails-html-sanitizer (1.6.0)
       loofah (~> 2.21)
       nokogiri (~> 1.14)
-    railties (7.1.3.4)
-      actionpack (= 7.1.3.4)
-      activesupport (= 7.1.3.4)
-      irb
+    railties (7.2.0)
+      actionpack (= 7.2.0)
+      activesupport (= 7.2.0)
+      irb (~> 1.13)
       rackup (>= 1.0.0)
       rake (>= 12.2)
       thor (~> 1.0, >= 1.2.2)
@@ -199,6 +201,7 @@ GEM
     rubocop-rspec (3.0.4)
       rubocop (~> 1.61)
     ruby-progressbar (1.13.0)
+    securerandom (0.3.1)
     simplecov (0.22.0)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -218,6 +221,7 @@ GEM
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.5.0)
     uri (0.13.0)
+    useragent (0.16.10)
     webmock (3.23.1)
       addressable (>= 2.8.0)
       crack (>= 0.3.2)

data/baza.rb.gemspec

@@ -31,7 +31,9 @@ Gem::Specification.new do |s|
   s.license = 'MIT'
   s.summary = 'Zerocracy API Ruby Client'
   s.description =
-    'It is a Ruby client for Zerocracy API'
+    'It is a Ruby client for Zerocracy API, allowing you to check your jobs ' \
+    'statuses, upload and download binaries, lock/unlock them, manage durables, ' \
+    'and do everything else that is possible to do via the HTTP API.'
   s.authors = ['Yegor Bugayenko']
   s.email = 'yegor256@gmail.com'
   s.homepage = 'http://github.com/zerocracy/baza.rb'
@@ -46,6 +48,7 @@ Gem::Specification.new do |s|
   s.add_dependency 'iri', '>0'
   s.add_dependency 'loog', '>0'
   s.add_dependency 'retries', '~>0'
+  s.add_dependency 'tago', '~>0'
   s.add_dependency 'typhoeus', '~>1.3'
   s.metadata['rubygems_mfa_required'] = 'true'
 end

data/lib/baza/version.rb

@@ -26,5 +26,5 @@
 # Copyright:: Copyright (c) 2024 Yegor Bugayenko
 # License:: MIT
 class Baza
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/baza.rb

@@ -25,7 +25,8 @@ require 'retries'
 require 'iri'
 require 'loog'
 require 'base64'
-require_relative 'baza/elapsed'
+require 'tago'
+require_relative 'baza/version'
 
 # Interface to the API of zerocracy.com.
 #
@@ -37,8 +38,6 @@ require_relative 'baza/elapsed'
 # 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
@@ -96,6 +95,7 @@ class Baza
         File.open(file, 'wb') do |f|
           request = Typhoeus::Request.new(
             home.append('pull').append("#{id}.fb").to_s,
+            method: :get,
             headers: headers.merge(
               'Accept' => 'application/octet-stream'
             ),
@@ -154,7 +154,7 @@ class Baza
           )
         end
       stdout = ret.body
-      throw :"The stdout of the job ##{id} has #{stdout.split("\n")} lines"
+      throw :"The stdout of the job ##{id} has #{stdout.split("\n").count} lines"
     end
     stdout
   end
@@ -194,6 +194,7 @@ class Baza
           302
         )
       end
+      throw :"Job name '#{name}' locked at #{@host}"
     end
   end
 
@@ -211,6 +212,7 @@ class Baza
           302
         )
       end
+      throw :"Job name '#{name}' unlocked at #{@host}"
     end
   end
 
@@ -256,6 +258,118 @@ class Baza
     exists
   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)
+    id = nil
+    elapsed(@loog) do
+      ret =
+        with_retries(max_tries: @retries) do
+          checked(
+            Typhoeus::Request.post(
+              home.append('durables').append('place').to_s,
+              body: {
+                'jname' => jname,
+                'file' => File.basename(file),
+                'zip' => File.open(file, 'r')
+              },
+              headers:,
+              connecttimeout: @timeout,
+              timeout: @timeout
+            ),
+            302
+          )
+        end
+      id = ret.headers['X-Zerocracy-DurableId'].to_i
+      throw :"Durable ##{id} placed for job \"#{jname}\" at #{@host}"
+    end
+    id
+  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)
+    elapsed(@loog) do
+      with_retries(max_tries: @retries) do
+        checked(
+          Typhoeus::Request.put(
+            home.append('durables').append(id).to_s,
+            body: File.binread(file),
+            headers:,
+            connecttimeout: @timeout,
+            timeout: @timeout
+          )
+        )
+      end
+      throw :"Durable ##{id} saved #{File.size(file)} bytes to #{@host}"
+    end
+  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)
+    elapsed(@loog) do
+      File.open(file, 'wb') do |f|
+        request = Typhoeus::Request.new(
+          home.append('durables').append(id).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
+        checked(request.response)
+      end
+      throw :"Durable ##{id} loaded #{File.size(file)} bytes from #{@host}"
+    end
+  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)
+    elapsed(@loog) do
+      with_retries(max_tries: @retries) do
+        checked(
+          Typhoeus::Request.get(
+            home.append('durables').append(id).append('lock').add(owner:).to_s,
+            headers:
+          ),
+          302
+        )
+      end
+      throw :"Durable ##{id} locked at #{@host}"
+    end
+  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)
+    elapsed(@loog) do
+      with_retries(max_tries: @retries) do
+        checked(
+          Typhoeus::Request.get(
+            home.append('durables').append(id).append('unlock').add(owner:).to_s,
+            headers:
+          ),
+          302
+        )
+      end
+      throw :"Durable ##{id} unlocked at #{@host}"
+    end
+  end
+
   private
 
   def headers
@@ -280,6 +394,17 @@ class Baza
     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

@@ -40,7 +40,7 @@ class TestBaza < Minitest::Test
   TOKEN = '00000000-0000-0000-0000-000000000000'
   HOST = 'api.zerocracy.com'
   PORT = 443
-  LIVE = Baza.new(HOST, PORT, TOKEN)
+  LIVE = Baza.new(HOST, PORT, TOKEN, loog: Loog::VERBOSE)
 
   def test_live_recent_check
     WebMock.enable_net_connect!
@@ -110,6 +110,33 @@ class TestBaza < Minitest::Test
     assert(!LIVE.unlock(n, owner).nil?)
   end
 
+  def test_live_durable_lock_unlock
+    WebMock.enable_net_connect!
+    skip unless we_are_online
+    Dir.mktmpdir do |dir|
+      file = File.join(dir, 'test.bin')
+      File.binwrite(file, 'hello')
+      id = LIVE.durable_place(fake_name, file)
+      owner = 'judges teesting'
+      LIVE.durable_lock(id, owner)
+      LIVE.durable_load(id, file)
+      LIVE.durable_save(id, file)
+      LIVE.durable_unlock(id, owner)
+    end
+  end
+
+  def test_durable_place
+    WebMock.disable_net_connect!
+    stub_request(:post, 'https://example.org/durables/place').to_return(
+      status: 302, headers: { 'X-Zerocracy-DurableId' => '42' }
+    )
+    Dir.mktmpdir do |dir|
+      file = File.join(dir, 'test.bin')
+      File.binwrite(file, 'hello')
+      assert_equal(42, Baza.new('example.org', 443, '000').durable_place('simple', file))
+    end
+  end
+
   def test_simple_push
     WebMock.disable_net_connect!
     stub_request(:put, 'https://example.org/push/simple').to_return(

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: baza.rb
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Yegor Bugayenko
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-08-09 00:00:00.000000000 Z
+date: 2024-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: backtrace
@@ -122,6 +122,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: tago
+  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: typhoeus
   requirement: !ruby/object:Gem::Requirement
@@ -136,7 +150,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
-description: It is a Ruby client for Zerocracy API
+description: It is a Ruby client for Zerocracy API, allowing you to check your jobs
+  statuses, upload and download binaries, lock/unlock them, manage durables, and do
+  everything else that is possible to do via the HTTP API.
 email: yegor256@gmail.com
 executables: []
 extensions: []
@@ -167,7 +183,6 @@ files:
 - Rakefile
 - baza.rb.gemspec
 - lib/baza.rb
-- lib/baza/elapsed.rb
 - lib/baza/version.rb
 - renovate.json
 - test/test__helper.rb

data/lib/baza/elapsed.rb

@@ -1,34 +0,0 @@
-# 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 'tago'
-
-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