aspera-cli 4.17.0 → 4.18.0

data/lib/aspera/faspex_gw.rb

@@ -50,8 +50,9 @@ module Aspera
         operation:   'POST',
         subpath:     "packages/#{package['id']}/transfer_spec/upload",
         headers:     {'Accept' => 'application/json'},
-        url_params:  {transfer_type: Cli::Plugins::Faspex5::TRANSFER_CONNECT},
-        json_params: {paths: [{'destination'=>'/'}]}
+        query:       {transfer_type: Cli::Plugins::Faspex5::TRANSFER_CONNECT},
+        body:        {paths: [{'destination'=>'/'}]},
+        body_type:   :json
       )[:data]
       transfer_spec.delete('authentication')
       # but we place it in a Faspex package creation response
@@ -94,5 +95,5 @@ module Aspera
         response.body = {error: 'Unsupported endpoint'}.to_json
       end
     end
-  end # Faspex4GWServlet
-end # Aspera
+  end
+end

data/lib/aspera/faspex_postproc.rb

@@ -74,5 +74,5 @@ module Aspera
         response.body = {status: 'error', script: script_path, message: e.message}.to_json
       end
     end
-  end # Faspex4PostProcServlet
-end # Aspera
+  end
+end

data/lib/aspera/log.rb

@@ -2,13 +2,14 @@
 
 require 'aspera/colors'
 require 'aspera/secret_hider'
-require 'aspera/environment'
-require 'aspera/assert'
 require 'logger'
 require 'pp'
 require 'json'
 require 'singleton'
 
+old_verbose = $VERBOSE
+$VERBOSE = nil
+
 # extend Ruby logger with trace levels
 class Logger
   TRACE_MAX = 2
@@ -44,6 +45,8 @@ class Logger
   Logger::Severity.constants.each { |severity| make_methods(severity) }
 end
 
+$VERBOSE = old_verbose
+
 module Aspera
   # Singleton object for logging
   class Log
@@ -84,7 +87,7 @@ module Aspera
       ensure
         $stderr = real_stderr
       end
-    end # class
+    end
 
     attr_reader :logger_type, :logger
     attr_writer :program_name

data/lib/aspera/node_simulator.rb

@@ -209,5 +209,5 @@ module Aspera
           session_id:      'bafc72b8-366c-4501-8095-47208183d6b8'}]
       }
     end
-  end # NodeSimulatorServlet
-end # Aspera
+  end
+end

data/lib/aspera/oauth/base.rb

@@ -9,9 +9,7 @@ require 'date'
 module Aspera
   module OAuth
     # Implement OAuth 2 for the REST client and generate a bearer token
-    # call get_authorization() to get a token.
-    # bearer tokens are kept in memory and also in a file cache for later re-use
-    # if a token is expired (api returns 4xx), call again get_authorization(refresh: true)
+    # bearer tokens are cached in memory and in a file cache for later re-use
     # https://tools.ietf.org/html/rfc6749
     class Base
       # scope can be modified after creation
@@ -31,6 +29,7 @@ module Aspera
         client_id: nil,
         client_secret: nil,
         scope: nil,
+        use_query: false,
         path_token:  'token',       # default endpoint for /token to generate token
         token_field: 'access_token' # field with token in result of call to path_token
       )
@@ -42,6 +41,7 @@ module Aspera
         @client_id = client_id
         @client_secret = client_secret
         @scope = scope
+        @use_query = use_query
         @identifiers = []
         @identifiers.push(auth[:username]) if auth.is_a?(Hash) && auth.key?(:username)
         # this is the OAuth API
@@ -52,13 +52,22 @@ module Aspera
       end
 
       # helper method to create token as per RFC
-      def create_token_call(www_params)
+      def create_token_call(creation_params)
         Log.log.debug{'Generating a new token'.bg_green}
+        payload = {
+          body:      creation_params,
+          body_type: :www
+        }
+        if @use_query
+          payload[:query] = creation_params
+          payload[:body] = {}
+        end
         return @api.call(
-          operation:       'POST',
-          subpath:         @path_token,
-          headers:         {'Accept' => 'application/json'},
-          www_body_params: www_params)
+          operation: 'POST',
+          subpath:   @path_token,
+          headers:   {'Accept' => 'application/json'},
+          **payload
+        )
       end
 
       # @return Hash with optional general parameters
@@ -70,24 +79,27 @@ module Aspera
         return call_params
       end
 
-      # OAuth v2 token generation
-      # @param use_refresh_token set to true to force refresh or re-generation (if previous failed)
-      def get_authorization(use_refresh_token: false, use_cache: true)
+      # get an OAuth v2 token (generated, cached, refreshed)
+      # call token() to get a token.
+      # if a token is expired (api returns 4xx), call again token(refresh: true)
+      # @param cache set to false to disable cache
+      # @param refresh set to true to force refresh or re-generation (if previous failed)
+      def token(cache: true, refresh: false)
         # generate token unique identifier for persistency (memory/disk cache)
         token_id = IdGenerator.from_list(Factory.id(
           @base_url,
-          @grant_method,
+          Factory.class_to_id(self.class),
           @identifiers,
           @scope
         ))
 
         # get token_data from cache (or nil), token_data is what is returned by /token
-        token_data = Factory.instance.persist_mgr.get(token_id) if use_cache
+        token_data = Factory.instance.persist_mgr.get(token_id) if cache
         token_data = JSON.parse(token_data) unless token_data.nil?
         # Optional optimization: check if node token is expired based on decoded content then force refresh if close enough
         # might help in case the transfer agent cannot refresh himself
         # `direct` agent is equipped with refresh code
-        if !use_refresh_token && !token_data.nil?
+        if !refresh && !token_data.nil?
           decoded_token = OAuth::Factory.instance.decode_token(token_data[@token_field])
           Log.log.debug{Log.dump('decoded_token', decoded_token)} unless decoded_token.nil?
           if decoded_token.is_a?(Hash)
@@ -96,13 +108,13 @@ module Aspera
               elsif decoded_token['exp'].is_a?(Integer)       then Time.at(decoded_token['exp'])
               end
             # force refresh if we see a token too close from expiration
-            use_refresh_token = true if expires_at_sec.is_a?(Time) && (expires_at_sec - Time.now) < OAuth::Factory.instance.globals[:token_expiration_guard_sec]
-            Log.log.debug{"Expiration: #{expires_at_sec} / #{use_refresh_token}"}
+            refresh = true if expires_at_sec.is_a?(Time) && (expires_at_sec - Time.now) < OAuth::Factory.instance.parameters[:token_expiration_guard_sec]
+            Log.log.debug{"Expiration: #{expires_at_sec} / #{refresh}"}
           end
         end
 
         # an API was already called, but failed, we need to regenerate or refresh
-        if use_refresh_token
+        if refresh
           if token_data.is_a?(Hash) && token_data.key?('refresh_token') && !token_data['refresh_token'].eql?('not_supported')
             # save possible refresh token, before deleting the cache
             refresh_token = token_data['refresh_token']
@@ -133,11 +145,11 @@ module Aspera
           json_data = resp[:http].body
           token_data = JSON.parse(json_data)
           Factory.instance.persist_mgr.put(token_id, json_data)
-        end # if ! in_cache
+        end
         Aspera.assert(token_data.key?(@token_field)){"API error: No such field in answer: #{@token_field}"}
         # ok we shall have a token here
         return OAuth::Factory.bearer_build(token_data[@token_field])
       end
-    end # OAuth
+    end
   end
 end

data/lib/aspera/oauth/factory.rb

@@ -5,6 +5,7 @@ require 'aspera/assert'
 require 'base64'
 module Aspera
   module OAuth
+    # Factory to create tokens and manage their cache
     class Factory
       include Singleton
       # a prefix for persistency of tokens (simplify garbage collect)
@@ -16,7 +17,11 @@ module Aspera
 
       class << self
         def bearer_build(token)
-          return BEARER_PREFIX + token
+          return "#{BEARER_PREFIX}#{token}"
+        end
+
+        def bearer?(token)
+          return token.start_with?(BEARER_PREFIX)
         end
 
         def bearer_extract(token)
@@ -24,14 +29,11 @@ module Aspera
           return token[BEARER_PREFIX.length..-1]
         end
 
-        def bearer?(token)
-          return token.start_with?(BEARER_PREFIX)
-        end
-
         def id(*params)
           return [PERSIST_CATEGORY_TOKEN, *params].flatten
         end
 
+        # snake version of class name is the identifier
         def class_to_id(creator_class)
           return creator_class.name.split('::').last.capital_to_snake.to_sym
         end
@@ -45,11 +47,8 @@ module Aspera
         # token creation methods
         @token_type_classes = {}
         @decoders = []
-        @globals = {
-          # remove 5 minutes to account for time offset between client and server (TODO: configurable?)
-          jwt_accepted_offset_sec:    300,
-          # one hour validity (TODO: configurable?)
-          jwt_expiry_offset_sec:      3600,
+        # default parameters, others can be added by handlers
+        @parameters = {
           # tokens older than 30 minutes will be discarded from cache
           token_cache_expiry_sec:     1800,
           # tokens valid for less than this duration will be regenerated
@@ -59,12 +58,12 @@ module Aspera
 
       public
 
-      attr_reader :globals
+      attr_reader :parameters
 
       def persist_mgr=(manager)
         @persist = manager
         # cleanup expired tokens
-        @persist.garbage_collect(PERSIST_CATEGORY_TOKEN, @globals[:token_cache_expiry_sec])
+        @persist.garbage_collect(PERSIST_CATEGORY_TOKEN, @parameters[:token_cache_expiry_sec])
       end
 
       def persist_mgr
@@ -104,7 +103,7 @@ module Aspera
       # @param id_create called to generate unique id for token, for cache
       def register_token_creator(creator_class)
         Aspera.assert_type(creator_class, Class)
-        id = self.class.class_to_id(creator_class)
+        id = Factory.class_to_id(creator_class)
         Log.log.debug{"registering token creator #{id}"}
         @token_type_classes[id] = creator_class
       end

data/lib/aspera/oauth/generic.rb

@@ -4,6 +4,7 @@ require 'aspera/oauth/base'
 
 module Aspera
   module OAuth
+    # Generic token creator
     class Generic < Base
       def initialize(
         grant_type:,

data/lib/aspera/oauth/jwt.rb

@@ -5,41 +5,44 @@ require 'aspera/assert'
 require 'securerandom'
 module Aspera
   module OAuth
+    # remove 5 minutes to account for time offset between client and server (TODO: configurable?)
+    Factory.instance.parameters[:jwt_accepted_offset_sec] = 300
+    # one hour validity (TODO: configurable?)
+    Factory.instance.parameters[:jwt_expiry_offset_sec] = 3600
     # Authentication using private key
+    # https://tools.ietf.org/html/rfc7523
+    # https://tools.ietf.org/html/rfc7519
     class Jwt < Base
-      # @param g_o:private_key_obj [M] for type :jwt
-      # @param g_o:payload         [M] for type :jwt
-      # @param g_o:headers         [0] for type :jwt
+      # @param private_key_obj private key object
+      # @param payload payload to be included in the JWT
+      # @param headers headers to be included in the JWT
       def initialize(
-        payload:,
         private_key_obj:,
+        payload:,
         headers: {},
         **base_params
       )
-        Aspera.assert_type(payload, Hash){'payload'}
         Aspera.assert_type(private_key_obj, OpenSSL::PKey::RSA){'private_key_obj'}
+        Aspera.assert_type(payload, Hash){'payload'}
         Aspera.assert_type(headers, Hash){'headers'}
         super(**base_params)
         @private_key_obj = private_key_obj
-        @payload = payload
+        @additional_payload = payload
         @headers = headers
-        @identifiers.push(@payload[:sub])
+        @identifiers.push(@additional_payload[:sub])
       end
 
       def create_token
-        # https://tools.ietf.org/html/rfc7523
-        # https://tools.ietf.org/html/rfc7519
         require 'jwt'
         seconds_since_epoch = Time.new.to_i
         Log.log.info{"seconds=#{seconds_since_epoch}"}
-        Aspera.assert(@payload.is_a?(Hash)){'missing JWT payload'}
         jwt_payload = {
-          exp: seconds_since_epoch + OAuth::Factory.instance.globals[:jwt_expiry_offset_sec], # expiration time
-          nbf: seconds_since_epoch - OAuth::Factory.instance.globals[:jwt_accepted_offset_sec], # not before
-          iat: seconds_since_epoch - OAuth::Factory.instance.globals[:jwt_accepted_offset_sec] + 1, # issued at
+          exp: seconds_since_epoch + OAuth::Factory.instance.parameters[:jwt_expiry_offset_sec], # expiration time
+          nbf: seconds_since_epoch - OAuth::Factory.instance.parameters[:jwt_accepted_offset_sec], # not before
+          iat: seconds_since_epoch - OAuth::Factory.instance.parameters[:jwt_accepted_offset_sec] + 1, # issued at
           jti: SecureRandom.uuid # JWT id
-        }.merge(@payload)
-        Log.log.debug{"JWT jwt_payload=[#{jwt_payload}]"}
+        }.merge(@additional_payload)
+        Log.log.debug{Log.dump(:jwt_payload, jwt_payload)}
         Log.log.debug{"private=[#{@private_key_obj}]"}
         assertion = JWT.encode(jwt_payload, @private_key_obj, 'RS256', @headers)
         Log.log.debug{"assertion=[#{assertion}]"}

data/lib/aspera/oauth/url_json.rb

@@ -4,16 +4,17 @@ require 'aspera/oauth/base'
 
 module Aspera
   module OAuth
+    # This class is used to create a token using a JSON body and a URL
     class UrlJson < Base
       def initialize(
-        json:,
         url:,
+        json:,
         **generic_params
       )
         super(**generic_params)
-        @json_params = json
-        @url_params = url
-        @identifiers.push(@json_params[:url_token])
+        @body = json
+        @query = url
+        @identifiers.push(@body[:url_token])
       end
 
       def create_token
@@ -21,8 +22,9 @@ module Aspera
           operation:   'POST',
           subpath:     @path_token,
           headers:     {'Accept' => 'application/json'},
-          json_params: @json_params,
-          url_params:  @url_params.merge(scope: @scope) # scope is here because it may change over time (node)
+          query:       @query.merge(scope: @scope), # scope is here because it may change over time (node)
+          body:        @body,
+          body_type:   :json
         )
       end
     end

data/lib/aspera/open_application.rb

@@ -11,12 +11,10 @@ module Aspera
   # if method is "graphical", then the URL will be opened with the default browser.
   class OpenApplication
     include Singleton
+    USER_INTERFACES = %i[text graphical].freeze
     class << self
-      USER_INTERFACES = %i[text graphical].freeze
-      # User Interfaces
-      def user_interfaces; USER_INTERFACES; end
-
       def default_gui_mode
+        # assume not remotely connected on macos and windows
         return :graphical if [Environment::OS_WINDOWS, Environment::OS_X].include?(Environment.os)
         # unix family
         return :graphical if ENV.key?('DISPLAY') && !ENV['DISPLAY'].empty?
@@ -43,7 +41,7 @@ module Aspera
           uri_graphical(file_path.to_s)
         end
       end
-    end # self
+    end
 
     attr_accessor :url_method
 
@@ -67,5 +65,5 @@ module Aspera
         raise StandardError, "unsupported url open method: #{@url_method}"
       end
     end
-  end # OpenApplication
-end # Aspera
+  end
+end

data/lib/aspera/persistency_folder.rb

@@ -74,5 +74,5 @@ module Aspera
       return File.join(@folder, "#{object_id}#{FILE_SUFFIX}")
       # .gsub(/[^a-z]+/,FILE_FIELD_SEPARATOR)
     end
-  end # PersistencyFolder
-end # Aspera
+  end
+end

data/lib/aspera/preview/generator.rb

@@ -252,6 +252,6 @@ module Aspera
           '+repage',
           @destination_file_path])
       end
-    end # Generator
-  end # Preview
-end # Aspera
+    end
+  end
+end

data/lib/aspera/preview/options.rb

@@ -36,6 +36,6 @@ module Aspera
       DESCRIPTIONS.each do |opt|
         attr_accessor opt[:name]
       end
-    end # Options
-  end # Preview
-end # Aspera
+    end
+  end
+end

data/lib/aspera/preview/terminal.rb

@@ -95,7 +95,7 @@ module Aspera
           end
           false
         end
-      end # class << self
-    end # class Terminal
-  end # module Preview
-end # module Aspera
+      end
+    end
+  end
+end

data/lib/aspera/preview/utils.rb

@@ -117,6 +117,6 @@ module Aspera
           return output_file
         end
       end
-    end # Options
-  end # Preview
-end # Aspera
+    end
+  end
+end

data/lib/aspera/proxy_auto_config.rb

@@ -36,7 +36,11 @@ module Aspera
     def pac_dns_functions(context_host)
       context_self = '127.0.0.1'
       context_ip = nil
-      Resolv::DNS.open{|dns|dns.each_address(context_host){|r_addr|context_ip = r_addr.to_s if r_addr.is_a?(Resolv::IPv4)}}
+      Resolv::DNS.open do |dns|
+        dns.each_address(context_host) do |r_addr|
+          context_ip = r_addr.to_s if r_addr.is_a?(Resolv::IPv4)
+        end
+      end
       raise "DNS name not found: #{context_host}" if context_ip.nil?
       # NOTE: Javascript code here with string inclusions
       javascript = <<END_OF_JAVASCRIPT