aspera-cli 4.17.0 → 4.18.1

data/lib/aspera/transfer/parameters.rb

@@ -22,12 +22,10 @@ module Aspera
       # Agents shown in manual for parameters (sub list)
       SUPPORTED_AGENTS = %i[direct node connect trsdk httpgw].freeze
       # Short names of columns in manual
-      SUPPORTED_AGENTS_SHORT = SUPPORTED_AGENTS.map{|a|a.to_s[0].to_sym}
+      SUPPORTED_AGENTS_SHORT = SUPPORTED_AGENTS.map{|agent_sym|agent_sym.to_s[0].to_sym}
       FILE_LIST_OPTIONS = ['--file-list', '--file-pair-list'].freeze
-      # options that can be provided to the constructor, and then in @options
-      SUPPORTED_OPTIONS = %i[ascp_args wss check_ignore_cb quiet trusted_certs].freeze
 
-      private_constant :SUPPORTED_AGENTS, :FILE_LIST_OPTIONS, :SUPPORTED_OPTIONS
+      private_constant :SUPPORTED_AGENTS, :FILE_LIST_OPTIONS
 
       class << self
         # Temp folder for file lists, must contain only file lists
@@ -35,18 +33,18 @@ module Aspera
         # this could be refined, as , for instance, on macos, temp folder is already user specific
         @file_list_folder = TempFileManager.instance.new_file_path_global('asession_filelists') # cspell:disable-line
 
-        # @param to_text [bool] replace HTML entities with text equivalent
+        # @param formatter [Cli::Formatter] formatter to use
         # @return a table suitable to display in manual
-        def man_table
+        def man_table(formatter)
           result = []
           Spec::DESCRIPTION.each do |name, options|
             param = {name: name, type: [options[:accepted_types]].flatten.join(','), description: options[:desc]}
             # add flags for supported agents in doc
-            SUPPORTED_AGENTS.each do |a|
-              param[a.to_s[0].to_sym] = Cli::Formatter.tick(options[:agents].nil? || options[:agents].include?(a))
+            SUPPORTED_AGENTS.each do |agent_sym|
+              param[agent_sym.to_s[0].to_sym] = Cli::Formatter.tick(options[:agents].nil? || options[:agents].include?(agent_sym))
             end
             # only keep lines that are usable in supported agents
-            next if SUPPORTED_AGENTS_SHORT.inject(true){|m, j|m && param[j].empty?}
+            next if SUPPORTED_AGENTS_SHORT.inject(true){|memory, agent_short_sym|memory && param[agent_short_sym].empty?}
             param[:cli] =
               case options[:cli][:type]
               when :envvar then 'env:' + options[:cli][:variable]
@@ -63,8 +61,8 @@ module Aspera
                 end.map{|n|"{#{n}}"}.join('|')
                 conversion_tag = options[:cli].key?(:convert) ? '(conversion)' : ''
                 "#{options[:cli][:switch]} #{conversion_tag}#{values}"
-              when :special then Cli::Formatter.special('special')
-              when :ignore then Cli::Formatter.special('ignored')
+              when :special then formatter.special_format('special')
+              when :ignore then formatter.special_format('ignored')
               else
                 param[:d].eql?(tick_yes) ? '' : 'n/a'
               end
@@ -75,17 +73,17 @@ module Aspera
             param[:description] = param[:description].gsub('&sol;', '\\')
             result.push(param)
           end
-          return result.sort_by { |a| a[:name] }
+          return result.sort_by { |parameter_info| parameter_info[:name] }
         end
 
         # special encoding methods used in YAML (key: :convert)
-        def convert_remove_hyphen(v); v.tr('-', ''); end
+        def convert_remove_hyphen(value); value.tr('-', ''); end
 
         # special encoding methods used in YAML (key: :convert)
-        def convert_json64(v); Base64.strict_encode64(JSON.generate(v)); end
+        def convert_json64(value); Base64.strict_encode64(JSON.generate(value)); end
 
         # special encoding methods used in YAML (key: :convert)
-        def convert_base64(v); Base64.strict_encode64(v); end
+        def convert_base64(value); Base64.strict_encode64(value); end
 
         # file list is provided directly with ascp arguments
         # @param ascp_args [Array,NilClass] ascp arguments
@@ -94,8 +92,8 @@ module Aspera
         end
 
         # temp file list files are created here
-        def file_list_folder=(v)
-          @file_list_folder = v
+        def file_list_folder=(value)
+          @file_list_folder = value
           return if @file_list_folder.nil?
           FileUtils.mkdir_p(@file_list_folder)
           TempFileManager.instance.cleanup_expired(@file_list_folder)
@@ -103,28 +101,33 @@ module Aspera
 
         # static methods
         attr_reader :file_list_folder
-      end # self
+      end
 
       # @param options [Hash] key: :wss: bool, :ascp_args: array of strings
-      def initialize(job_spec, options)
-        Aspera.assert_type(job_spec, Hash)
-        Aspera.assert_type(options, Hash)
+      def initialize(
+        job_spec,
+        ascp_args:,
+        wss:,
+        quiet:,
+        trusted_certs:,
+        check_ignore_cb:
+      )
         @job_spec = job_spec
-        # check necessary options
-        missing_options = SUPPORTED_OPTIONS - options.keys
-        Aspera.assert(missing_options.empty?){"missing options: #{missing_options.join(', ')}"}
-        @options = SUPPORTED_OPTIONS.each_with_object({}){|o, h| h[o] = options[o]}
-        Log.log.debug{Log.dump(:parameters_options, @options)}
-        Log.log.debug{Log.dump(:dismiss_options, options.keys - SUPPORTED_OPTIONS)}
-        Aspera.assert_type(@options[:ascp_args], Array){'ascp_args'}
-        Aspera.assert(@options[:ascp_args].all?(String)){'ascp arguments must Strings'}
+        @ascp_args = ascp_args
+        @wss = wss
+        @quiet = quiet
+        @trusted_certs = trusted_certs
+        @check_ignore_cb = check_ignore_cb
+        Aspera.assert_type(job_spec, Hash)
+        Aspera.assert_type(@ascp_args, Array){'ascp_args'}
+        Aspera.assert(@ascp_args.all?(String)){'ascp arguments must be Strings'}
         @builder = CommandLineBuilder.new(@job_spec, Spec::DESCRIPTION)
       end
 
       # either place source files on command line, or add file list file
       def process_file_list
         # is the file list provided through ascp parameters?
-        ascp_file_list_provided = self.class.ascp_args_file_list?(@options[:ascp_args])
+        ascp_file_list_provided = self.class.ascp_args_file_list?(@ascp_args)
         # set if paths is mandatory in ts
         @builder.params_definition['paths'][:mandatory] = !@job_spec.key?('keepalive') && !ascp_file_list_provided # cspell:words keepalive
         # get paths in transfer spec (after setting if it is mandatory)
@@ -162,7 +165,7 @@ module Aspera
       def remote_certificates
         certificates_to_use = []
         # use web socket secure for session ?
-        if @builder.read_param('wss_enabled') && (@options[:wss] || !@job_spec.key?('fasp_port'))
+        if @builder.read_param('wss_enabled') && (@wss || !@job_spec.key?('fasp_port'))
           # by default use web socket session if available, unless removed by user
           @builder.add_command_line_options(['--ws-connect'])
           # TODO: option to give order ssh,ws (legacy http is implied by ssh)
@@ -171,9 +174,9 @@ module Aspera
           @job_spec.delete('fasp_port')
           @job_spec.delete('sshfp')
           # set location for CA bundle to be the one of Ruby, see env var SSL_CERT_FILE / SSL_CERT_DIR
-          certificates_to_use.concat(@options[:trusted_certs]) if @options[:trusted_certs].is_a?(Array)
+          certificates_to_use.concat(@trusted_certs) if @trusted_certs.is_a?(Array)
           # ignore cert for wss ?
-          if @options[:check_ignore_cb]&.call(@job_spec['remote_host'], @job_spec['wss_port'])
+          if @check_ignore_cb&.call(@job_spec['remote_host'], @job_spec['wss_port'])
             wss_cert_file = TempFileManager.instance.new_file_path_global('wss_cert')
             wss_url = "https://#{@job_spec['remote_host']}:#{@job_spec['wss_port']}"
             File.write(wss_cert_file, Rest.remote_certificate_chain(wss_url))
@@ -228,7 +231,7 @@ module Aspera
         # destination will be base64 encoded, put this before source path arguments
         @builder.add_command_line_options(['--dest64']) if base64_destination
         # optional arguments, at the end to override previous ones (to allow override)
-        @builder.add_command_line_options(@options[:ascp_args])
+        @builder.add_command_line_options(@ascp_args)
         # get list of source files to transfer and build arg for ascp
         process_file_list
         # process destination folder
@@ -238,7 +241,7 @@ module Aspera
         # destination MUST be last command line argument to ascp
         @builder.add_command_line_options([destination_folder])
         @builder.add_env_args(env_args)
-        env_args[:args].unshift('-q') if @options[:quiet]
+        env_args[:args].unshift('-q') if @quiet
         # add fallback cert and key as arguments if needed
         if ['1', 1, true, 'force'].include?(@job_spec['http_fallback'])
           env_args[:args].unshift('-Y', Ascp::Installation.instance.path(:fallback_private_key))
@@ -247,6 +250,6 @@ module Aspera
         Log.log.debug{"ascp args: #{env_args}"}
         return env_args
       end
-    end # Parameters
+    end
   end
 end

data/lib/aspera/transfer/spec.rb

@@ -17,6 +17,8 @@ module Aspera
         'ssh_port'    => SSH_PORT,
         'fasp_port'   => UDP_PORT
       }.freeze
+      # fields for transport
+      TRANSPORT_FIELDS = %w[remote_host remote_user ssh_port fasp_port wss_enabled wss_port].freeze
       # reserved tag for Aspera
       TAG_RESERVED = 'aspera'
       class << self

data/lib/aspera/transfer/sync.rb

@@ -48,7 +48,8 @@ module Aspera
           'cooloff'                    => { cli: { type: :opt_with_arg}, accepted_types: :int},
           'pending_max'                => { cli: { type: :opt_with_arg}, accepted_types: :int},
           'scan_intensity'             => { cli: { type: :opt_with_arg}, accepted_types: :string},
-          'cipher'                     => { cli: { type: :opt_with_arg, convert: 'Aspera::Transfer::Parameters.convert_remove_hyphen'}, accepted_types: :string, ts: true},
+          'cipher'                     => { cli: { type: :opt_with_arg, convert: 'Aspera::Transfer::Parameters.convert_remove_hyphen'},
+                                            accepted_types: :string, ts: true},
           'transfer_threads'           => { cli: { type: :opt_with_arg}, accepted_types: :int},
           'preserve_time'              => { cli: { type: :opt_without_arg}, ts: :preserve_times},
           'preserve_access_time'       => { cli: { type: :opt_without_arg}, ts: nil},

data/lib/aspera/transfer/uri.rb

@@ -24,7 +24,7 @@ module Aspera
         result_ts['ssh_port'] = @fasp_uri.port
         result_ts['paths'] = [{'source' => URI.decode_www_form_component(@fasp_uri.path)}]
         # faspex 4 does not encode trailing base64 padding, fix that to be able to decode properly
-        fixed_query = @fasp_uri.query.gsub(/(=+)$/){|x|'%3D' * x.length}
+        fixed_query = @fasp_uri.query.gsub(/(=+)$/){|trail_equals|'%3D' * trail_equals.length}
 
         Rest.decode_query(fixed_query).each do |name, value|
           case name

data/lib/aspera/uri_reader.rb

@@ -4,21 +4,22 @@ require 'uri'
 require 'aspera/rest'
 
 module Aspera
+  # read some content from some URI, support file: , http: and https: schemes
   module UriReader
     class << self
       # read some content from some URI, support file: , http: and https: schemes
       def read(uri_to_read)
-        proxy_uri = URI.parse(uri_to_read)
-        case proxy_uri.scheme
+        uri = URI.parse(uri_to_read)
+        case uri.scheme
         when 'http', 'https'
           return Rest.new(base_url: uri_to_read, redirect_max: 5).call(operation: 'GET', subpath: '', headers: {'Accept' => 'text/plain'})[:data]
         when 'file', NilClass
-          local_file_path = proxy_uri.path
+          local_file_path = uri.path
           raise 'URL shall have a path, check syntax' if local_file_path.nil?
           local_file_path = File.expand_path(local_file_path.gsub(%r{^/}, '')) if %r{^/(~|.|..)/}.match?(local_file_path)
           return File.read(local_file_path)
         else
-          raise "unknown scheme: [#{proxy_uri.scheme}] for [#{uri_to_read}]"
+          raise "unknown scheme: [#{uri.scheme}] for [#{uri_to_read}]"
         end
       end
     end

data/lib/aspera/web_auth.rb

@@ -28,7 +28,7 @@ module Aspera
       response.body = '<html><head><title>Ok</title></head><body><h1>Thank you !</h1><p>You can close this window.</p></body></html>'
       return nil
     end
-  end # WebAuthServlet
+  end
 
   # start a local web server, then start a browser that will callback the local server upon authentication
   class WebAuth < WebServerSimple

data/lib/aspera/web_server_simple.rb

@@ -7,6 +7,7 @@ require 'aspera/assert'
 require 'openssl'
 
 module Aspera
+  # Simple WEBrick server with HTTPS support
   class WebServerSimple < WEBrick::HTTPServer
     CERT_PARAMETERS = %i[key cert chain].freeze
     GENERIC_ISSUER = '/C=FR/O=Test/OU=Test/CN=Test'
@@ -18,8 +19,8 @@ module Aspera
       # generates and adds self signed cert to provided webrick options
       def fill_self_signed_cert(cert, key, digest = 'SHA256')
         cert.subject = cert.issuer = OpenSSL::X509::Name.parse(GENERIC_ISSUER)
-        cert.not_before = Time.now
-        cert.not_after = Time.now + ONE_YEAR_SECONDS
+        cert.not_before = cert.not_after = Time.now
+        cert.not_after += ONE_YEAR_SECONDS
         cert.public_key = key.public_key
         cert.serial = 0x0
         cert.version = 2
@@ -56,7 +57,7 @@ module Aspera
         else
           Aspera.assert_type(certificate, Hash)
           certificate = certificate.symbolize_keys
-          raise "unexpected key in certificate config: only: #{CERT_PARAMETERS.join(', ')}" if certificate.keys.any?{|k|!CERT_PARAMETERS.include?(k)}
+          raise "unexpected key in certificate config: only: #{CERT_PARAMETERS.join(', ')}" if certificate.keys.any?{|key|!CERT_PARAMETERS.include?(key)}
           webrick_options[:SSLPrivateKey] = if certificate.key?(:key)
             OpenSSL::PKey::RSA.new(File.read(certificate[:key]))
           else

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.17.0
+  version: 4.18.1
 platform: ruby
 authors:
 - Laurent Martin
@@ -37,7 +37,7 @@ cert_chain:
   eTf9kxhVM40wGQOECVNA8UsEEZHD48eF+csUYZtAJOF5oxTI8UyV9T/o6CgO0c9/
   Gzz+Qm5ULOUcPiJLjSpaiTrkiIVYiDGnqNSr6R1Hb1c=
   -----END CERTIFICATE-----
-date: 2024-05-13 00:00:00.000000000 Z
+date: 2024-08-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: blankslate
@@ -390,6 +390,7 @@ files:
 - README.md
 - bin/ascli
 - bin/asession
+- examples/build_package.sh
 - examples/dascli
 - examples/proxy.pac
 - examples/rubyc
@@ -403,6 +404,7 @@ files:
 - lib/aspera/api/aoc.rb
 - lib/aspera/api/ats.rb
 - lib/aspera/api/cos_node.rb
+- lib/aspera/api/httpgw.rb
 - lib/aspera/api/node.rb
 - lib/aspera/ascmd.rb
 - lib/aspera/ascp/installation.rb
@@ -422,17 +424,19 @@ files:
 - lib/aspera/cli/plugins/alee.rb
 - lib/aspera/cli/plugins/aoc.rb
 - lib/aspera/cli/plugins/ats.rb
-- lib/aspera/cli/plugins/bss.rb
 - lib/aspera/cli/plugins/config.rb
 - lib/aspera/cli/plugins/console.rb
 - lib/aspera/cli/plugins/cos.rb
 - lib/aspera/cli/plugins/faspex.rb
 - lib/aspera/cli/plugins/faspex5.rb
+- lib/aspera/cli/plugins/faspio.rb
+- lib/aspera/cli/plugins/httpgw.rb
 - lib/aspera/cli/plugins/node.rb
 - lib/aspera/cli/plugins/orchestrator.rb
 - lib/aspera/cli/plugins/preview.rb
 - lib/aspera/cli/plugins/server.rb
 - lib/aspera/cli/plugins/shares.rb
+- lib/aspera/cli/special_values.rb
 - lib/aspera/cli/sync_actions.rb
 - lib/aspera/cli/transfer_agent.rb
 - lib/aspera/cli/transfer_progress.rb
@@ -466,7 +470,6 @@ files:
 - lib/aspera/oauth/jwt.rb
 - lib/aspera/oauth/url_json.rb
 - lib/aspera/oauth/web.rb
-- lib/aspera/open_application.rb
 - lib/aspera/persistency_action_once.rb
 - lib/aspera/persistency_folder.rb
 - lib/aspera/preview/file_types.rb

data/lib/aspera/cli/plugins/bss.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'aspera/rest'
-
-module Aspera
-  module Cli
-    module Plugins
-      class Bss < Cli::BasicAuthPlugin
-        ACTIONS = %i[subscription].freeze
-
-        FIELDS = {
-          'bssSubscriptions' => %w[id name termVolumeGb termMonths trial startDate endDate plan renewalType chargeAgreementNumber customerName]
-        }.freeze
-
-        def initialize(**env)
-          super
-        end
-
-        def all_fields(name)
-          return FIELDS[name].join(' ')
-        end
-
-        def execute_action
-          if @api_bss.nil?
-            key = options.get_option(:password, mandatory: true)
-            @api_bss = Rest.new(
-              base_url: 'https://dashboard.bss.asperasoft.com/platform',
-              headers: {cookie: "_dashboard_key=#{key}"})
-          end
-          command = options.get_next_command(ACTIONS)
-          case command
-          when :subscription
-            command = options.get_next_command(%i[find show instances])
-            object = 'bssSubscriptions'
-            case command
-            when :find
-              query = options.get_option(:query, mandatory: true) # AOC_ORGANIZATION_QUERY AOC_USER_EMAIL
-              value = value_create_modify(command: command)
-              request = {
-                'variables' => {'filter' => {'key' => query, 'value' => value}},
-                'query'     => "query($filter: BssSubscriptionFilter!) {#{object}(filter: $filter) { #{all_fields('bssSubscriptions')} } }"
-              }
-              result = @api_bss.create('graphql', request)[:data]
-              # give fields to keep order
-              return {type: :object_list, data: result['data'][object], fields: FIELDS['bssSubscriptions']}
-            when :show
-              id = instance_identifier
-              request = {
-                'variables' => {'id' => id},
-                'query'     => "query($id: ID!) {#{object}(id: $id) { #{all_fields('bssSubscriptions')} roleAssignments(uniqueSubjectId: true) { id subjectId } " \
-                  'instances { id state planId serviceId ssmSubscriptionId entitlement { id } aocOrganization { id subdomainName name status tier urlId trialExpiresAt ' \
-                  'users(organizationAdmin: true) { id name email atsAdmin subscriptionAdmin } } } } }'
-              }
-              result = @api_bss.create('graphql', request)[:data]['data'][object].first
-              result.delete('instances')
-              return {type: :single_object, data: result}
-            when :instances
-              id = instance_identifier
-              request = {
-                'variables' => {'id' => id},
-                'query'     => "query($id: ID!) {#{object}(id: $id) { aocOrganization { id subdomainName name status tier urlId trialExpiresAt } } } }"
-              }
-              result = @api_bss.create('graphql', request)[:data]['data'][object].first
-              return {type: :object_list, data: result['instances']}
-            end
-          end
-        end
-      end # Bss
-    end # Plugins
-  end # Cli
-end # Aspera

data/lib/aspera/open_application.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-require 'aspera/log'
-require 'aspera/environment'
-require 'rbconfig'
-require 'singleton'
-
-module Aspera
-  # Allows a user to open a Url
-  # if method is "text", then URL is displayed on terminal
-  # if method is "graphical", then the URL will be opened with the default browser.
-  class OpenApplication
-    include Singleton
-    class << self
-      USER_INTERFACES = %i[text graphical].freeze
-      # User Interfaces
-      def user_interfaces; USER_INTERFACES; end
-
-      def default_gui_mode
-        return :graphical if [Environment::OS_WINDOWS, Environment::OS_X].include?(Environment.os)
-        # unix family
-        return :graphical if ENV.key?('DISPLAY') && !ENV['DISPLAY'].empty?
-        return :text
-      end
-
-      # command must be non blocking
-      def uri_graphical(uri)
-        case Environment.os
-        when Environment::OS_X       then return system('open', uri.to_s)
-        when Environment::OS_WINDOWS then return system('start', 'explorer', %Q{"#{uri}"})
-        when Environment::OS_LINUX   then return system('xdg-open', uri.to_s)
-        else
-          raise "no graphical open method for #{Environment.os}"
-        end
-      end
-
-      def editor(file_path)
-        if ENV.key?('EDITOR')
-          system(ENV['EDITOR'], file_path.to_s)
-        elsif Environment.os.eql?(Environment::OS_WINDOWS)
-          system('notepad.exe', %Q{"#{file_path}"})
-        else
-          uri_graphical(file_path.to_s)
-        end
-      end
-    end # self
-
-    attr_accessor :url_method
-
-    def initialize
-      @url_method = self.class.default_gui_mode
-    end
-
-    # this is non blocking
-    def uri(the_url)
-      case @url_method
-      when :graphical
-        self.class.uri_graphical(the_url)
-      when :text
-        case the_url.to_s
-        when /^http/
-          puts "USER ACTION: please enter this url in a browser:\n#{the_url.to_s.red}\n"
-        else
-          puts "USER ACTION: open this:\n#{the_url.to_s.red}\n"
-        end
-      else
-        raise StandardError, "unsupported url open method: #{@url_method}"
-      end
-    end
-  end # OpenApplication
-end # Aspera