haveapi-client 0.20.0 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 21e90c8144a063cb9be879765fd3905219cb80fa200d4890d429d2cdcd9a895d
-  data.tar.gz: 2a6dbd41df5d8257d3f0e283aedf564f914b676c885b3590e372197ae8325057
+  metadata.gz: 5a10ca3718864bd73e33c306e4c9d0b01627f60bf43352adc88a48fd14164aef
+  data.tar.gz: 2344875dcded9d82436b0d7a10935ffba00eeb07cebcd6aebb1f45a35e0561fe
 SHA512:
-  metadata.gz: 3e8198d615ac29d3deadd9bac90e7be6ff58a365772692eda690e2464c4d4bad834171c3fead9414122359ee33641bb4b22fef9a016e8dc8be38a4298be09c2a
-  data.tar.gz: f7d748cbcc26f4f25cbe770f1b457931d3fcbbe8cb63353db7dcb786d5bc0f760e0455b7c2da9b04120afc66b21ffc9702e4fe252d8ce3682a09f0124b61d60c
+  metadata.gz: 389f8ae1e086215dab9d62cdf642b1cb47bb1608e40dab3be0a7415696a19a9bb235d87cbe37b02f69941740b6d4daa34ab2080ac8d6cc981964d0c655021bf6
+  data.tar.gz: f7be612fbc40e3cd2d47e4507cb4ae3c34706086fcae5a2a65740ae5d90a5e5922f584ae561f5c2a8c51f4eeedbec2b2814ff97485126a909b9f9564fa698e26

data/Gemfile

@@ -1,3 +1,8 @@
 source 'https://rubygems.org'
 
 gemspec
+
+group :development do
+  gem 'bundler'
+  gem 'rake'
+end

data/Rakefile

@@ -1,2 +1 @@
 require 'bundler/gem_tasks'
-

data/haveapi-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 'haveapi/client/version'
 
 Gem::Specification.new do |spec|
@@ -9,22 +8,20 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jakub Skokan']
   spec.email         = ['jakub.skokan@vpsfree.cz']
   spec.summary       =
-  spec.description   = 'Ruby API and CLI for HaveAPI'
+    spec.description = 'Ruby API and CLI for HaveAPI'
   spec.homepage      = ''
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = ">= #{File.read('../../.ruby-version').strip}"
+
   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 'activesupport', '>= 7.0'
+  spec.add_runtime_dependency 'highline', '~> 2.1.0'
+  spec.add_runtime_dependency 'json'
   spec.add_runtime_dependency 'require_all', '~> 2.0.0'
   spec.add_runtime_dependency 'rest-client', '~> 2.1.0'
-  spec.add_runtime_dependency 'json'
-  spec.add_runtime_dependency 'highline', '~> 2.1.0'
   spec.add_runtime_dependency 'ruby-progressbar', '~> 1.13.0'
 end

data/lib/haveapi/cli/action_state.rb

@@ -26,31 +26,30 @@ module HaveAPI::CLI
       id ||= @id
 
       if cancel
-        puts "Waiting for the action to cancel (hit Ctrl+C to skip)..."
+        puts 'Waiting for the action to cancel (hit Ctrl+C to skip)...'
       else
-        puts "Waiting for the action to complete (hit Ctrl+C to skip)..."
+        puts 'Waiting for the action to complete (hit Ctrl+C to skip)...'
       end
-      
+
       last_status = false
       can_cancel = false
-    
+
       begin
         ret = HaveAPI::Client::Action.wait_for_completion(
-            @client,
-            id,
-            timeout: timeout,
+          @client,
+          id,
+          timeout:
         ) do |state|
           last_status = state.status
           can_cancel = state.can_cancel?
-          
+
           update_progress(state, cancel)
         end
-
       rescue Interrupt
         @pb && @pb.stop
         puts
 
-        cancel_action(timeout: timeout) if can_cancel && !cancel && last_status
+        cancel_action(timeout:) if can_cancel && !cancel && last_status
 
         puts
         print_help(id)
@@ -70,67 +69,67 @@ module HaveAPI::CLI
     # and call self.wait_for_completion on the cancellation, if it is blocking
     # operation.
     def cancel_action(timeout: nil)
-      STDOUT.write("Do you wish to cancel the action? [y/N]: ")
-      STDOUT.flush
+      $stdout.write('Do you wish to cancel the action? [y/N]: ')
+      $stdout.flush
 
-      if STDIN.readline.strip.downcase == 'y'
-        begin
-          res = HaveAPI::Client::Action.cancel(@client, @id)
+      return unless $stdin.readline.strip.downcase == 'y'
 
-        rescue HaveAPI::Client::ActionFailed => e
-          res = e.response
-        end
-    
-        if res.is_a?(HaveAPI::Client::Response) && res.ok?
-          puts "Cancelled"
-          exit
-
-        elsif res
-          @pb.resume
-
-          wait_for_completion(
-              id: res,
-              timeout: timeout,
-              cancel: true,
-          )
-          exit
-        end
+      begin
+        res = HaveAPI::Client::Action.cancel(@client, @id)
+      rescue HaveAPI::Client::ActionFailed => e
+        res = e.response
+      end
 
-        warn "Cancel failed: #{res.message}"
-        exit(false)
+      if res.is_a?(HaveAPI::Client::Response) && res.ok?
+        puts 'Cancelled'
+        exit
+
+      elsif res
+        @pb.resume
+
+        wait_for_completion(
+          id: res,
+          timeout:,
+          cancel: true
+        )
+        exit
       end
+
+      warn "Cancel failed: #{res.message}"
+      exit(false)
     end
 
     def print_help(id = nil)
       id ||= @id
 
-      puts "Run"
+      puts 'Run'
       puts "  #{$0} action_state show #{id}"
-      puts "or"
+      puts 'or'
       puts "  #{$0} action_state wait #{id}"
       puts "to check the action's progress."
     end
 
     protected
+
     def update_progress(state, cancel)
       @pb ||= ProgressBar.create(
-          title: cancel ? 'Cancelling' : 'Executing',
-          total: state.progress.total,
-          format: if state.progress.total && state.progress.total > 0
-                    "%t: [%B] %c/%C #{state.progress.unit}"
-                  else
-                    '%t: [%B]'
-                  end,
-          starting_at: state.progress.current,
-          autofinish: false,
+        title: cancel ? 'Cancelling' : 'Executing',
+        total: state.progress.total,
+        format: if state.progress.total && state.progress.total > 0
+                  "%t: [%B] %c/%C #{state.progress.unit}"
+                else
+                  '%t: [%B]'
+                end,
+        starting_at: state.progress.current,
+        autofinish: false
       )
 
-      if state.status
-        @pb.title = cancel ? 'Cancelling' : 'Executing'
+      @pb.title = if state.status
+                    cancel ? 'Cancelling' : 'Executing'
 
-      else
-        @pb.title = 'Failing'
-      end
+                  else
+                    'Failing'
+                  end
 
       if state.progress.total && state.progress.total > 0
         @pb.progress = state.progress.current

data/lib/haveapi/cli/authentication/base.rb

@@ -27,28 +27,23 @@ module HaveAPI::CLI
       # This method is NOT called if the auth provider has been loaded
       # from the config and wasn't specified as a command line option
       # and therefore all necessary information must be stored in the config.
-      def options(opts)
-
-      end
+      def options(opts); end
 
       # Implement this method to check if all needed information
       # for successful authentication are provided.
       # Ask the user on stdin if something is missing.
-      def validate
-
-      end
+      def validate; end
 
       # This method should call HaveAPI::Client::Communicator#authenticate
       # with arguments specific for this authentication provider.
-      def authenticate
-
-      end
+      def authenticate; end
 
       def save
         @communicator.auth_save
       end
 
       protected
+
       attr_reader :communicator, :desc
     end
   end

data/lib/haveapi/cli/authentication/basic.rb

@@ -21,10 +21,12 @@ module HaveAPI::CLI::Authentication
         q.default = nil
         q.echo = false
       end.to_s
+
+      nil
     end
 
     def authenticate
-      @communicator.authenticate(:basic, {user: @user, password: @password})
+      @communicator.authenticate(:basic, { user: @user, password: @password })
     end
   end
 end

data/lib/haveapi/cli/authentication/token.rb

@@ -22,7 +22,7 @@ module HaveAPI::CLI::Authentication
       end
 
       opts.on('--token-lifetime LIFETIME',
-              %i(fixed renewable_manual renewable_auto permanent),
+              %i[fixed renewable_manual renewable_auto permanent],
               'Token lifetime, defaults to renewable_auto') do |l|
         @lifetime = l
       end
@@ -36,7 +36,7 @@ module HaveAPI::CLI::Authentication
         @token = nil
       end
 
-      via = %i(query_param header)
+      via = %i[query_param header]
 
       opts.on('--token-via VIA', via,
               'Send token as a query parameter or in HTTP header',
@@ -61,12 +61,12 @@ module HaveAPI::CLI::Authentication
         lifetime: @lifetime || :renewable_auto,
         interval: @interval,
         valid_to: @valid_to,
-        via: @via,
+        via: @via
       }
 
       opts.update(@credentials) if @credentials
 
-      @communicator.authenticate(:token, opts) do |action, params|
+      @communicator.authenticate(:token, opts) do |_action, params|
         ret = {}
 
         params.each do |name, desc|
@@ -78,14 +78,13 @@ module HaveAPI::CLI::Authentication
     end
 
     def save
-      super.update({via: @via, interval: @interval})
+      super.update({ via: @via, interval: @interval })
     end
 
     protected
+
     def request_credentials
-      desc[:resources][:token][:actions][:request][:input][:parameters].reject do |name, _|
-        %i(lifetime interval).include?(name)
-      end
+      desc[:resources][:token][:actions][:request][:input][:parameters].except(:lifetime, :interval)
     end
   end
 end