vpsadmin-client 3.0.0.master.20211209.pre.0.34bce62b → 3.0.0.master.20220809.pre.0.4bb004b0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7904eb80c6480049ca0bd7610d1271ca8190021cedee59e8035427513dcd90f0
-  data.tar.gz: 88999438bbc0016133b931a8678ef2ab1aa9657e4cfa98d17b42ba98c63c12ac
+  metadata.gz: b441c7f4575b1c83f0b44e030e487f5a21314f28044379aa020bb65437315764
+  data.tar.gz: 83a6e16dfb20baf6188f09ec4d92e3887c957e0bbd884b4143d95a49f958f86a
 SHA512:
-  metadata.gz: b6c410b2f35e56c6f438e2941a0a915439ab8e749869ad88c526fea5f7aedaaa339a23591e09eea1b81c2d3acb52fb89781eb9d45035d3a85a65203cda84b462
-  data.tar.gz: 5e896b3ae63c5ab7c28a51713dafaf32936ce4e7ed3559b5380c9802fc093f6b8c244b1efb95966a3e162e9e931977d5812cf2db15761b35e173a785d518ba86
+  metadata.gz: a421f897c7a466b86914ecc77db3f077175b25118ae198e059f8a3c2213002d46e652734588da5f21401ec19b6d34ddd1f577d6244cc3de8631aae79267e0442
+  data.tar.gz: 16fd9d780cf499e8af47cb9dd21592ea01e6ac76717883a3d88cfe0f108d1c579396bd4b08450e5e2a1c5ea6d5aeca5cf6f23bba47a27e27a9c566f2fcd102e0

data/README.md

@@ -1,6 +1,15 @@
 # vpsAdmin client
 
-TODO: Write a gem description
+vpsAdmin client is a Ruby CLI and client library for vpsAdmin API. It is based
+on [haveapi-client](https://github.com/vpsfreecz/haveapi/tree/master/clients/ruby).
+
+vpsAdmin client extends `haveapi-client` with several command-line operations
+specific to vpsAdmin, including:
+
+- VPS remote console
+- Snapshot downloads, either ZFS streams or tar archives
+- Automated utility for local backups using ZFS
+- Live IP traffic monitor
 
 ## Installation
 
@@ -17,13 +26,6 @@ Or install it yourself as:
     $ gem install vpsadmin-client
 
 ## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/vpsadminctl/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+See
+[haveapi-client](https://github.com/vpsfreecz/haveapi/tree/master/clients/ruby)
+for usage information.

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

@@ -1,5 +1,4 @@
-require 'eventmachine'
-require 'em-http'
+require 'thread'
 require 'time'
 require 'json'
 require 'base64'
@@ -11,16 +10,35 @@ module VpsAdmin::CLI::Commands
     args 'VPS_ID'
     desc 'Open VPS remote console'
 
-    class InputHandler < EventMachine::Connection
-      attr_accessor :buffer
-
-      def initialize
+    class InputHandler
+      def initialize(http_client)
+        @http_client = http_client
         @private_buffer = ''
-        @buffer = ''
         @end_seq = ["\r", "\e", "."]
         @end_i = 0
+        @stop = false
+      end
+
+      def read_from(io)
+        begin
+          data = io.read_nonblock(4096)
+        rescue IO::WaitReadable
+          return
+        rescue Errno::EIO
+          stop
+          return
+        end
+
+        write(data)
       end
 
+      def stop?
+        @stop
+      end
+
+      protected
+      attr_reader :http_client
+
       # Data is checked on the presence of the end sequence. The first character
       # in the sequence (ENTER) can be read multiple times in a row and it is
       # to be forwarded.
@@ -29,38 +47,160 @@ module VpsAdmin::CLI::Commands
       # but stored in a private buffer. If the sequence is later broken, the private
       # buffer is forwarded and reset.
       #
-      # If the whole end sequence is read, EM event loop is stopped.
-      def receive_data(data)
+      # If the whole end sequence is read, we exit.
+      def write(data)
+        buffer = ''
+
         data.each_char do |char|
           if char == @end_seq[ @end_i ]
-            if @end_i == @end_seq.size-1
-              EM.stop
+            if @end_i == @end_seq.size - 1
+              @stop = true
               return
             end
 
             @end_i += 1
 
             if @end_i == 1
-              @buffer += char
-
+              buffer += char
             else
               @private_buffer += char
             end
 
           elsif char == @end_seq.first
-            @buffer += char
-
+            buffer += char
           else
             @end_i = 0
 
             unless @private_buffer.empty?
-              @buffer += @private_buffer
+              buffer += @private_buffer
               @private_buffer.clear
             end
 
-            @buffer += char
+            buffer += char
           end
         end
+
+        http_client.write(buffer) unless buffer.empty?
+      end
+    end
+
+    class HttpClient
+      def initialize(vps, token, rate)
+        @vps = vps
+        @token = token
+        @rate = rate
+        @mutex = Mutex.new
+        @write_buffer = ''
+        @stop = false
+        @error = false
+      end
+
+      def start
+        @thread = Thread.new { run }
+      end
+
+      def stop
+        @stop = true
+      end
+
+      def stop?
+        @stop
+      end
+
+      def error?
+        @error != false
+      end
+
+      def error
+        @error
+      end
+
+      def join
+        stop
+        thread.join
+      end
+
+      def write(data)
+        mutex.synchronize do
+          write_buffer << data
+        end
+      end
+
+      def resize(width, height)
+        @width = width
+        @height = height
+      end
+
+      protected
+      attr_reader :vps, :token, :rate, :width, :height, :write_buffer,
+        :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',
+        }]
+
+        Net::HTTP.start(*start_args) do |http|
+          loop do
+            break if stop? || error?
+
+            rate_limit { send_request(http, uri) }
+          end
+        end
+      end
+
+      def send_request(http, uri)
+        req = Net::HTTP::Post.new(uri)
+
+        keys =
+          mutex.synchronize do
+            s = write_buffer.dup
+            write_buffer.clear
+            s
+          end
+
+        req.set_form_data(
+          'session' => token,
+          'keys' => keys,
+          'width' => width,
+          'height' => height,
+        )
+
+        res = http.request(req)
+
+        unless res.is_a?(Net::HTTPSuccess)
+          set_error(
+            "Console server returned error: "+
+            "HTTP #{res.code} - #{res.message}\n\n#{res.body}"
+          )
+          stop
+          return
+        end
+
+        ret = JSON.parse(res.body, symbolize_names: true)
+
+        unless ret[:session]
+          $stdout.write(ret[:data])
+          set_error("Session closed.")
+          stop
+          return
+        end
+
+        $stdout.write(Base64.decode64(ret[:data]))
+      end
+
+      def rate_limit
+        t1 = Time.now
+        yield
+        t2 = Time.now
+
+        cooldown = rate - (t2 - t1)
+        sleep(cooldown) if cooldown > 0
+      end
+
+      def set_error(str)
+        @error = str
       end
     end
 
@@ -93,7 +233,7 @@ module VpsAdmin::CLI::Commands
       end
 
       puts "  VPS is on #{vps.node.domain_name}, located in #{vps.node.location.label}."
-      puts "Console router URL is #{vps.node.location.remote_console_server}"
+      puts "Console server URL is #{vps.node.location.remote_console_server}"
       write "Obtaining authentication token..."
 
       begin
@@ -105,31 +245,18 @@ module VpsAdmin::CLI::Commands
         exit(false)
       end
 
-      @token = t.token
-
       puts
-      puts "Connecting to remote console..."
+      puts "Connecting to the remote console..."
       puts "Press ENTER ESC . to exit"
       puts
 
       raw_mode do
-        EventMachine.run do
-          @input = EventMachine.open_keyboard(InputHandler)
-
-          @http = EventMachine::HttpRequest.new(
-              "#{vps.node.location.remote_console_server}/console/feed/#{vps_id}",
-              ssl: {verify_peer: true},
-          )
-          communicate
-        end
+        run_console(vps, t.token)
       end
     end
 
     protected
-    def write(s)
-      $stdout.write(s)
-      $stdout.flush
-    end
+    attr_reader :client
 
     def raw_mode
       state = `stty -g`
@@ -140,6 +267,7 @@ module VpsAdmin::CLI::Commands
 
         Signal.trap('WINCH') do
           @size = Terminal.size!
+          client.resize(@size[:width], @size[:height]) if client
         end
 
         yield
@@ -151,38 +279,35 @@ module VpsAdmin::CLI::Commands
       puts
     end
 
-    def communicate
-      post = @http.post(
-        body: {
-          session: @token,
-          keys: @input.buffer,
-          width: @size[:width],
-          height: @size[:height],
-        },
-        keepalive: true
-      )
+    def run_console(vps, token)
+      Thread.abort_on_exception = true
 
-      @input.buffer = ''
+      @client = HttpClient.new(vps, token, @opts[:rate])
+      client.resize(@size[:width], @size[:height])
 
-      post.errback do
-        puts "Error: connection to console router failed"
-        EventMachine.stop
-      end
+      input = InputHandler.new(client)
+      client.start
 
-      post.callback do
-        ret = JSON.parse(post.response, symbolize_names: true)
+      loop do
+        res = IO.select([$stdin], [], [], 1)
+        input.read_from($stdin) if res
 
-        unless ret[:session]
-          $stdout.write(ret[:data])
-          puts "\nSession closed."
-          EM.stop
-          next
-        end
+        if input.stop? || client.stop?
+          client.join
 
-        $stdout.write(Base64.decode64(ret[:data]))
+          if client.error?
+            write("\n")
+            write(client.error)
+          end
 
-        EM.add_timer(@opts[:rate]) { communicate }
+          return
+        end
       end
     end
+
+    def write(s)
+      $stdout.write(s)
+      $stdout.flush
+    end
   end
 end

data/lib/vpsadmin/cli/stream_downloader.rb

@@ -7,8 +7,8 @@ module VpsAdmin::CLI
   class DownloadError < StandardError ; end
 
   class StreamDownloader
-    def self.download(*args)
-      new(*args)
+    def self.download(*args, **kwargs)
+      new(*args, **kwargs)
     end
 
     def initialize(api, dl, io, progress: STDOUT, position: 0, max_rate: nil,

data/lib/vpsadmin/client/version.rb

@@ -1,5 +1,5 @@
 module VpsAdmin
   module Client
-    VERSION = '3.0.0.master.20211209-0.34bce62b'
+    VERSION = '3.0.0.master.20220809-0.4bb004b0'
   end
 end

data/shell.nix

@@ -17,7 +17,6 @@ in stdenv.mkDerivation rec {
     mkdir -p /tmp/dev-ruby-gems
     export GEM_HOME="/tmp/dev-ruby-gems"
     export GEM_PATH="$GEM_HOME:$PWD/lib"
-    export PATH="$GEM_HOME/bin:$PATH"
 
     BUNDLE="$GEM_HOME/bin/bundle"
 
@@ -29,5 +28,6 @@ in stdenv.mkDerivation rec {
     $BUNDLE install
 
     export RUBYOPT=-rbundler/setup
+    export PATH="$(ruby -e 'puts Gem.bindir'):$PATH"
   '';
 }

data/vpsadmin-client.gemspec

@@ -21,9 +21,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'
 
-  spec.add_runtime_dependency 'haveapi-client', '~> 0.14.0'
-  spec.add_runtime_dependency 'eventmachine', '~> 1.2.7'
-  spec.add_runtime_dependency 'em-http-request', '~> 1.1.6'
+  spec.add_runtime_dependency 'haveapi-client', '~> 0.15.1'
   spec.add_runtime_dependency 'json'
   spec.add_runtime_dependency 'curses'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vpsadmin-client
 version: !ruby/object:Gem::Version
-  version: 3.0.0.master.20211209.pre.0.34bce62b
+  version: 3.0.0.master.20220809.pre.0.4bb004b0
 platform: ruby
 authors:
 - Jakub Skokan
@@ -44,42 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
+        version: 0.15.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.14.0
-- !ruby/object:Gem::Dependency
-  name: eventmachine
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.7
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.2.7
-- !ruby/object:Gem::Dependency
-  name: em-http-request
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.6
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 1.1.6
+        version: 0.15.1
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement