vpsadmin-client 3.0.0.master.202211181.pre.0.ac358990 → 4.0.0

data/lib/vpsadmin/cli/commands/vps_remote_console.rb

@@ -1,8 +1,8 @@
-require 'thread'
 require 'time'
 require 'json'
 require 'base64'
-require 'terminal-size'
+require 'io/wait'
+require 'terminal_size'
 
 module VpsAdmin::CLI::Commands
   class VpsRemoteControl < HaveAPI::CLI::Command
@@ -14,7 +14,7 @@ module VpsAdmin::CLI::Commands
       def initialize(http_client)
         @http_client = http_client
         @private_buffer = ''
-        @end_seq = ["\r", "\e", "."]
+        @end_seq = ["\r", "\e", '.']
         @end_i = 0
         @stop = false
       end
@@ -37,6 +37,7 @@ module VpsAdmin::CLI::Commands
       end
 
       protected
+
       attr_reader :http_client
 
       # Data is checked on the presence of the end sequence. The first character
@@ -52,10 +53,10 @@ module VpsAdmin::CLI::Commands
         buffer = ''
 
         data.each_char do |char|
-          if char == @end_seq[ @end_i ]
+          if char == @end_seq[@end_i]
             if @end_i == @end_seq.size - 1
               @stop = true
-              return
+              return # rubocop:disable Lint/NonLocalExitFromIterator
             end
 
             @end_i += 1
@@ -111,9 +112,7 @@ module VpsAdmin::CLI::Commands
         @error != false
       end
 
-      def error
-        @error
-      end
+      attr_reader :error
 
       def join
         stop
@@ -132,13 +131,14 @@ module VpsAdmin::CLI::Commands
       end
 
       protected
+
       attr_reader :vps, :token, :rate, :width, :height, :write_buffer,
-        :mutex, :thread
+                  :mutex, :thread
 
       def run
         uri = URI("#{vps.node.location.remote_console_server}/console/feed/#{vps.id}")
         start_args = [uri.host, uri.port, nil, nil, nil, nil, {
-          use_ssl: uri.scheme == 'https',
+          use_ssl: uri.scheme == 'https'
         }]
 
         Net::HTTP.start(*start_args) do |http|
@@ -164,14 +164,14 @@ module VpsAdmin::CLI::Commands
           'session' => token,
           'keys' => keys,
           'width' => width,
-          'height' => height,
+          'height' => height
         )
 
         res = http.request(req)
 
         unless res.is_a?(Net::HTTPSuccess)
           set_error(
-            "Console server returned error: "+
+            'Console server returned error: ' \
             "HTTP #{res.code} - #{res.message}\n\n#{res.body}"
           )
           stop
@@ -182,7 +182,7 @@ module VpsAdmin::CLI::Commands
 
         unless ret[:session]
           $stdout.write(ret[:data])
-          set_error("Session closed.")
+          set_error('Session closed.')
           stop
           return
         end
@@ -216,38 +216,36 @@ module VpsAdmin::CLI::Commands
 
     def exec(args)
       if args.empty?
-        puts "provide VPS ID as an argument"
+        puts 'provide VPS ID as an argument'
         exit(false)
       end
 
       vps_id = args.first.to_i
 
-      write "Locating VPS.."
+      write 'Locating VPS..'
       begin
         vps = @api.vps.show(vps_id, meta: { includes: 'node__location' })
-
       rescue HaveAPI::Client::ActionFailed => e
-        puts "  error"
+        puts '  error'
         puts e.message
         exit(false)
       end
 
       puts "  VPS is on #{vps.node.domain_name}, located in #{vps.node.location.label}."
       puts "Console server URL is #{vps.node.location.remote_console_server}"
-      write "Obtaining authentication token..."
+      write 'Obtaining authentication token...'
 
       begin
         t = vps.console_token.create
-
       rescue HaveAPI::Client::ActionFailed => e
-        puts "  error"
+        puts '  error'
         puts e.message
         exit(false)
       end
 
       puts
-      puts "Connecting to the remote console..."
-      puts "Press ENTER ESC . to exit"
+      puts 'Connecting to the remote console...'
+      puts 'Press ENTER ESC . to exit'
       puts
 
       raw_mode do
@@ -256,6 +254,7 @@ module VpsAdmin::CLI::Commands
     end
 
     protected
+
     attr_reader :client
 
     def raw_mode
@@ -289,19 +288,19 @@ module VpsAdmin::CLI::Commands
       client.start
 
       loop do
-        res = IO.select([$stdin], [], [], 1)
+        res = $stdin.wait_readable(1)
         input.read_from($stdin) if res
 
-        if input.stop? || client.stop?
-          client.join
+        next unless input.stop? || client.stop?
 
-          if client.error?
-            write("\n")
-            write(client.error)
-          end
+        client.join
 
-          return
+        if client.error?
+          write("\n")
+          write(client.error)
         end
+
+        return
       end
     end
 

data/lib/vpsadmin/cli/stream_downloader.rb

@@ -4,15 +4,15 @@ require 'ruby-progressbar'
 require 'digest'
 
 module VpsAdmin::CLI
-  class DownloadError < StandardError ; end
+  class DownloadError < StandardError; end
 
   class StreamDownloader
     def self.download(*args, **kwargs)
       new(*args, **kwargs)
     end
 
-    def initialize(api, dl, io, progress: STDOUT, position: 0, max_rate: nil,
-                  checksum: true)
+    def initialize(api, dl, io, progress: $stdout, position: 0, max_rate: nil,
+                   checksum: true)
       downloaded = position
       uri = URI(dl.url)
       digest = Digest::SHA256.new
@@ -26,12 +26,12 @@ module VpsAdmin::CLI
             format: '%E %t: [%B] %p%% %r MB/s',
             rate_scale: ->(rate) { (rate / 1024.0 / 1024.0).round(2) },
             throttle_rate: 0.2,
-            output: progress,
+            output: progress
           )
         end
 
         read = 0
-        step = 1*1024*1024
+        step = 1 * 1024 * 1024
         io.seek(0)
 
         while read < position
@@ -56,20 +56,20 @@ module VpsAdmin::CLI
           throttle_rate: 0.2,
           starting_at: downloaded,
           autofinish: false,
-          output: progress,
+          output: progress
         )
       end
 
-      args = [uri.host] + Array.new(5, nil) + [{use_ssl: uri.scheme == 'https'}]
+      args = [uri.host] + Array.new(5, nil) + [{ use_ssl: uri.scheme == 'https' }]
 
       Net::HTTP.start(*args) do |http|
         loop do
           begin
             dl_check = api.snapshot_download.show(dl.id)
 
-            if @pb && (dl_check.ready || (dl_check.size && dl_check.size > 0))
+            if @pb && (dl_check.ready || (dl_check.size && dl_check.size > 0)) # rubocop:disable all
               total = dl_check.size * 1024 * 1024
-              @pb.total = @pb.progress > total ? @pb.progress : total
+              @pb.total = [@pb.progress, total].max
 
               @download_size = (dl_check.size / 1024.0).round(2)
 
@@ -81,7 +81,6 @@ module VpsAdmin::CLI
                 self.format = "%E %t ~#{@download_size} GB: [%B] %p%% %r kB/s"
               end
             end
-
           rescue HaveAPI::Client::ActionFailed => e
             # The SnapshotDownload object no longer exists, the transaction
             # responsible for its creation must have failed.
@@ -94,36 +93,32 @@ module VpsAdmin::CLI
 
           http.request_get(uri.path, headers) do |res|
             case res.code
-            when '404'  # Not Found
-              if downloaded > 0
-                # This means that the transaction used for preparing the download
-                # has failed, the file to download does not exist anymore, so fail.
-                raise DownloadError, 'The download has failed, most likely transaction failure'
+            when '404' # Not Found
+              raise DownloadError, 'The download has failed, most likely transaction failure' if downloaded > 0
 
-              else
-                # The file is not available yet, this is normal, the transaction
-                # may be queued and it can take some time before it is processed.
-                pause(10)
-                next
-              end
+              # This means that the transaction used for preparing the download
+              # has failed, the file to download does not exist anymore, so fail.
 
-            when '416'  # Range Not Satisfiable
-              if downloaded > position
-                # We have already managed to download something (at this run, if the trasfer
-                # was resumed) and the server cannot provide more data yet. This can be
-                # because the server is busy. Wait and retry.
-                pause(20)
-                next
+              # The file is not available yet, this is normal, the transaction
+              # may be queued and it can take some time before it is processed.
+              pause(10)
+              next
 
-              else
-                # The file is not ready yet - we ask for range that cannot be provided
-                # This happens when we're resuming a download and the file on the
-                # server was deleted meanwhile. The file might not be exactly the same
-                # as the one before, sha256sum would most likely fail.
-                raise DownloadError, 'Range not satisfiable'
-              end
+            when '416' # Range Not Satisfiable
+              raise DownloadError, 'Range not satisfiable' unless downloaded > position
+
+              # We have already managed to download something (at this run, if the trasfer
+              # was resumed) and the server cannot provide more data yet. This can be
+              # because the server is busy. Wait and retry.
+              pause(20)
+              next
 
-            when '200', '206'  # OK and Partial Content
+            # The file is not ready yet - we ask for range that cannot be provided
+            # This happens when we're resuming a download and the file on the
+            # server was deleted meanwhile. The file might not be exactly the same
+            # as the one before, sha256sum would most likely fail.
+
+            when '200', '206' # OK and Partial Content
               resume
 
             else
@@ -140,10 +135,7 @@ module VpsAdmin::CLI
               downloaded += size
 
               begin
-                if @pb && (@pb.total.nil? || @pb.progress < @pb.total)
-                  @pb.progress += size
-                end
-
+                @pb.progress += size if @pb && (@pb.total.nil? || @pb.progress < @pb.total)
               rescue ProgressBar::InvalidProgressError
                 # The total value is in MB, it is not precise, so the actual
                 # size may be a little bit bigger.
@@ -186,12 +178,13 @@ module VpsAdmin::CLI
       @pb.finish if @pb
 
       # Verify the checksum
-      if checksum && digest.hexdigest != dl_check.sha256sum
-        raise DownloadError, 'The sha256sum does not match, retry the download'
-      end
+      return unless checksum && digest.hexdigest != dl_check.sha256sum
+
+      raise DownloadError, 'The sha256sum does not match, retry the download'
     end
 
     protected
+
     def pause(secs)
       @paused = true
 

data/lib/vpsadmin/cli.rb

@@ -3,11 +3,11 @@ require 'vpsadmin/client/version'
 
 module VpsAdmin
   module CLI
-    module Commands ; end
+    module Commands; end
 
     class Cli < HaveAPI::CLI::Cli
       def show_version
-        puts "#{VpsAdmin::Client::VERSION} based on haveapi-client "+
+        puts "#{VpsAdmin::Client::VERSION} based on haveapi-client " +
              HaveAPI::Client::VERSION
       end
     end

data/lib/vpsadmin/client/version.rb

@@ -1,5 +1,5 @@
 module VpsAdmin
   module Client
-    VERSION = '3.0.0.master.202211181-0.ac358990'
+    VERSION = '4.0.0'.freeze
   end
 end

data/lib/vpsadmin/client.rb

@@ -3,7 +3,6 @@ require 'haveapi/client'
 module VpsAdmin
   module Client
     class Client < HaveAPI::Client::Client
-
     end
 
     # Shortcut to {VpsAdmin::Client::Client.new}

data/shell.nix

@@ -5,12 +5,12 @@ let
 in stdenv.mkDerivation rec {
   name = "vpsadmin-client";
 
-  buildInputs = [
-    pkgs.ruby
-    pkgs.git
-    pkgs.zlib
-    pkgs.openssl
-    pkgs.ncurses
+  buildInputs = with pkgs; [
+    ruby
+    git
+    zlib
+    openssl
+    ncurses
   ];
 
   shellHook = ''

data/vpsadmin-client.gemspec

@@ -1,6 +1,5 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+lib = File.expand_path('lib', __dir__)
+$:.unshift(lib) unless $:.include?(lib)
 require 'vpsadmin/client/version'
 
 Gem::Specification.new do |spec|
@@ -9,19 +8,17 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jakub Skokan']
   spec.email         = ['jakub.skokan@vpsfree.cz']
   spec.summary       =
-  spec.description   = 'Ruby API and CLI for vpsAdmin API'
+    spec.description = 'Ruby API and CLI for vpsAdmin API'
   spec.homepage      = ''
   spec.license       = 'GPL'
 
+  spec.required_ruby_version = '>= 3.0'
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-
-  spec.add_runtime_dependency 'haveapi-client', '~> 0.16.1'
-  spec.add_runtime_dependency 'json'
-  spec.add_runtime_dependency 'curses'
+  spec.add_dependency 'curses'
+  spec.add_dependency 'haveapi-client', '~> 0.23.6'
+  spec.add_dependency 'json'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vpsadmin-client
 version: !ruby/object:Gem::Version
-  version: 3.0.0.master.202211181.pre.0.ac358990
+  version: 4.0.0
 platform: ruby
 authors:
 - Jakub Skokan
@@ -11,27 +11,13 @@ cert_chain: []
 date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: curses
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -44,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.23.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.1
+        version: 0.23.6
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: curses
-  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'
 description: Ruby API and CLI for vpsAdmin API
 email:
 - jakub.skokan@vpsfree.cz
@@ -89,13 +61,14 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE
 - README.md
 - Rakefile
 - bin/vpsadminctl
-- lib/terminal-size.rb
+- lib/terminal_size.rb
 - lib/vpsadmin/cli.rb
 - lib/vpsadmin/cli/commands/backup_dataset.rb
 - lib/vpsadmin/cli/commands/backup_vps.rb
@@ -122,14 +95,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.26
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Ruby API and CLI for vpsAdmin API