aspera-cli 4.1.0 → 4.3.0

data/lib/aspera/command_line_builder.rb

@@ -4,21 +4,45 @@ module Aspera
   # process_param is called repeatedly with all known parameters
   # add_env_args is called to get resulting param list and env var (also checks that all params were used)
   class CommandLineBuilder
+    # transform yes/no to trye/false
+    def self.yes_to_true(value)
+      case value
+      when 'yes'; return true
+      when 'no'; return false
+      end
+      raise "unsupported value: #{value}"
+    end
 
-    private
-    # default value for command line based on option name
-    def switch_name(param_name,options)
-      return options[:option_switch] if options.has_key?(:option_switch)
-      return '--'+param_name.to_s.gsub('_','-')
+    # Called by provider of definition before constructor of this class so that params_definition has all mandatory fields
+    def self.normalize_description(d)
+      d.each do |param_name,options|
+        raise "Expecting Hash, but have #{options.class} in #{param_name}" unless options.is_a?(Hash)
+        #options[:accepted_types]=:bool if options[:cltype].eql?(:envvar) and !options.has_key?(:accepted_types)
+        # by default : not mandatory
+        options[:mandatory]||=false
+        options[:desc]||=''
+        # by default : string, unless it's without arg
+        if ! options.has_key?(:accepted_types)
+          options[:accepted_types]=options[:cltype].eql?(:opt_without_arg) ? :bool : :string
+        end
+        # single type is placed in array
+        options[:accepted_types]=[options[:accepted_types]] unless options[:accepted_types].is_a?(Array)
+        if !options.has_key?(:option_switch) and options.has_key?(:cltype) and [:opt_without_arg,:opt_with_arg].include?(options[:cltype])
+          options[:option_switch]='--'+param_name.to_s.gsub('_','-')
+        end
+      end
     end
 
+    private
+
+    # clvarname : command line variable name
     def env_name(param_name,options)
-      return options[:variable]
+      return options[:clvarname]
     end
 
     public
 
-    BOOLEAN_CLASSES=[TrueClass,FalseClass]
+    attr_reader :params_definition
 
     # @param param_hash
     def initialize(param_hash,params_definition)
@@ -44,15 +68,6 @@ module Aspera
       return nil
     end
 
-    # transform yes/no to trye/false
-    def self.yes_to_true(value)
-      case value
-      when 'yes'; return true
-      when 'no'; return false
-      end
-      raise "unsupported value: #{value}"
-    end
-
     # add options directly to ascp command line
     def add_command_line_options(options)
       return if options.nil?
@@ -71,24 +86,25 @@ module Aspera
     # @param options : options for type
     def process_param(param_name,action=nil)
       options=@params_definition[param_name]
-      action=options[:type] if action.nil?
+      action=options[:cltype] if action.nil?
       # should not happen
       raise "Internal error: ask processing of param #{param_name}" if options.nil?
-      # by default : not mandatory
-      options[:mandatory]||=false
-      if options.has_key?(:accepted_types)
-        # single type is placed in array
-        options[:accepted_types]=[options[:accepted_types]] unless options[:accepted_types].is_a?(Array)
-      else
-        # by default : string, unless it's without arg
-        options[:accepted_types]=action.eql?(:opt_without_arg) ? BOOLEAN_CLASSES : [String]
-      end
       # check mandatory parameter (nil is valid value)
       raise Fasp::Error.new("mandatory parameter: #{param_name}") if options[:mandatory] and !@param_hash.has_key?(param_name)
       parameter_value=@param_hash[param_name]
-      parameter_value=options[:default] if parameter_value.nil? and options.has_key?(:default)
+      #parameter_value=options[:default] if parameter_value.nil? and options.has_key?(:default)
+      expected_classes=options[:accepted_types].map do |s|
+        case s
+        when :string; String
+        when :array; Array
+        when :hash; Hash
+        when :int; Integer
+        when :bool; [TrueClass,FalseClass]
+        else raise "INTERNAL: unexpected value: #{s}"
+        end
+      end.flatten
       # check provided type
-      raise Fasp::Error.new("#{param_name} is : #{parameter_value.class} (#{parameter_value}), shall be #{options[:accepted_types]}, ") unless parameter_value.nil? or options[:accepted_types].inject(false){|m,v|m or parameter_value.is_a?(v)}
+      raise Fasp::Error.new("#{param_name} is : #{parameter_value.class} (#{parameter_value}), shall be #{options[:accepted_types]}, ") unless parameter_value.nil? or expected_classes.include?(parameter_value.class)
       @used_param_names.push(param_name) unless action.eql?(:defer)
 
       # process only non-nil values
@@ -102,7 +118,8 @@ module Aspera
       end
       raise "unsupported value: #{parameter_value}" unless options[:accepted_values].nil? or options[:accepted_values].include?(parameter_value)
       if options[:encode]
-        newvalue=options[:encode].call(parameter_value)
+        # :encode has name of class with encoding method
+        newvalue=Kernel.const_get(options[:encode]).send("encode_#{param_name}",parameter_value)
         raise Fasp::Error.new("unsupported #{param_name}: #{parameter_value}") if newvalue.nil?
         parameter_value=newvalue
       end
@@ -123,12 +140,12 @@ module Aspera
         else raise Fasp::Error.new("unsupported #{param_name}: #{parameter_value}")
         end
         add_param=!add_param if options[:add_on_false]
-        add_command_line_options([switch_name(param_name,options)]) if add_param
+        add_command_line_options([options[:option_switch]]) if add_param
       when :opt_with_arg # transform into command line option with value
         #parameter_value=parameter_value.to_s if parameter_value.is_a?(Integer)
         parameter_value=[parameter_value] unless parameter_value.is_a?(Array)
         # if transfer_spec value is an array, applies option many times
-        parameter_value.each{|v|add_command_line_options([switch_name(param_name,options),v])}
+        parameter_value.each{|v|add_command_line_options([options[:option_switch],v])}
       else
         raise "Error"
       end

data/lib/aspera/cos_node.rb

@@ -5,46 +5,52 @@ require 'xmlsimple'
 module Aspera
   class CosNode < Rest
     attr_reader :add_ts
-    def initialize(bucket_name,storage_endpoint,instance_id,api_key,auth_url='https://iam.cloud.ibm.com/identity')
+    IBM_CLOUD_TOKEN_URL='https://iam.cloud.ibm.com/identity'
+    TOKEN_FIELD='delegated_refresh_token'
+    def initialize(bucket_name,storage_endpoint,instance_id,api_key,auth_url=IBM_CLOUD_TOKEN_URL)
+      @auth_url=auth_url
+      @api_key=api_key
       s3_api=Aspera::Rest.new({
-        :base_url => storage_endpoint,
-        :not_auth_codes => ['401','403'],
-        :headers  => {'ibm-service-instance-id' => instance_id},
-        :auth     => {
-        :type       => :oauth2,
-        :base_url   => auth_url,
-        :grant      => :ibm_apikey,
-        :api_key    => api_key
+        :base_url       => storage_endpoint,
+        :not_auth_codes => ['401','403'], # error codes when not authorized
+        :headers        => {'ibm-service-instance-id' => instance_id},
+        :auth           => {
+        :type      => :oauth2,
+        :base_url  => @auth_url,
+        :grant     => :ibm_apikey,
+        :api_key   => @api_key
         }})
       # read FASP connection information for bucket
       xml_result_text=s3_api.call({:operation=>'GET',:subpath=>bucket_name,:headers=>{'Accept'=>'application/xml'},:url_params=>{'faspConnectionInfo'=>nil}})[:http].body
       ats_info=XmlSimple.xml_in(xml_result_text, {'ForceArray' => false})
       Aspera::Log.dump('ats_info',ats_info)
-      # get delegated token
-      delegated_oauth=Oauth.new({
-        :type       => :oauth2,
-        :base_url   => auth_url,
-        :grant      => :delegated_refresh,
-        :api_key    => api_key,
-        :token_field=> 'delegated_refresh_token'
-      })
-      # to be placed in rest call header and in transfer tags
-      aspera_storage_credentials={
-        'type'  => 'token',
-        'token' => {'delegated_refresh_token'=>delegated_oauth.get_authorization().gsub(/^Bearer /,'')}
-      }
-      # transfer spec addition
-      @add_ts={'tags'=>{'aspera'=>{'node'=>{'storage_credentials'=>aspera_storage_credentials}}}}
-      # set a general addon to transfer spec
-      # here we choose to use the add_request_param
-      #self.transfer.option_transfer_spec_deep_merge(@add_ts)
       super({
         :base_url => ats_info['ATSEndpoint'],
-        :headers  => {'X-Aspera-Storage-Credentials'=>JSON.generate(aspera_storage_credentials)},
         :auth     => {
         :type     => :basic,
         :username => ats_info['AccessKey']['Id'],
         :password => ats_info['AccessKey']['Secret']}})
+      # prepare transfer spec addition
+      @add_ts={'tags'=>{'aspera'=>{'node'=>{'storage_credentials'=>{
+        'type'  => 'token',
+        'token' => {TOKEN_FIELD=>nil}
+        }}}}}
+      generate_token
+    end
+
+    # potentially call this if delegated token is expired
+    def generate_token
+      # OAuth API to get delegated token
+      delegated_oauth=Oauth.new({
+        :type       => :oauth2,
+        :base_url   => @auth_url,
+        :grant      => :delegated_refresh,
+        :api_key    => @api_key,
+        :token_field=> TOKEN_FIELD
+      })
+      # get delagated token to be placed in rest call header and in transfer tags
+      @add_ts['tags']['aspera']['node']['storage_credentials']['token'][TOKEN_FIELD]=delegated_oauth.get_authorization().gsub(/^Bearer /,'')
+      @params[:headers]={'X-Aspera-Storage-Credentials'=>JSON.generate(@add_ts['tags']['aspera']['node']['storage_credentials'])}
     end
   end
 end

data/lib/aspera/environment.rb

@@ -2,7 +2,7 @@ require 'aspera/log'
 require 'rbconfig'
 
 module Aspera
-  # a simple binary data repository
+  # detect OS, architecture, and OS specific stuff
   class Environment
     OS_WINDOWS = :windows
     OS_X = :osx
@@ -53,7 +53,7 @@ module Aspera
       return ''
     end
 
-    # on Windows, the env var %USERPROFILE% provides the path to user's home more reliably then %HOMEDRIVE%%HOMEPATH%
+    # on Windows, the env var %USERPROFILE% provides the path to user's home more reliably than %HOMEDRIVE%%HOMEPATH%
     def self.fix_home
       if os.eql?(OS_WINDOWS)
         if ENV.has_key?('USERPROFILE') and Dir.exist?(ENV['USERPROFILE'])

data/lib/aspera/fasp/aoc.rb

@@ -11,7 +11,7 @@ module Aspera
         Log.log.warn("Under Development")
         server_node_file = @api_aoc.resolve_node_file(server_home_node_file,server_folder)
         # force node as transfer agent
-        node_api=Fasp::Node.new(@api_aoc.get_node_api(client_node_file[:node_info],AoC::SCOPE_NODE_USER))
+        node_api=Fasp::Node.new(@api_aoc.get_node_api(client_node_file[:node_info],scope: AoC::SCOPE_NODE_USER))
         super(node_api)
         # additional node to node TS info
         @add_ts={

data/lib/aspera/fasp/installation.rb

@@ -22,11 +22,18 @@ module Aspera
       PRODUCT_CLI_V1='Aspera CLI'
       PRODUCT_DRIVE='Aspera Drive'
       PRODUCT_ENTSRV='Enterprise Server'
-      # currently used ascp executable
+      MAX_REDIRECT_SDK=2
+      private_constant :MAX_REDIRECT_SDK
+      # set ascp executable path
       def ascp_path=(v)
         @path_to_ascp=v
       end
 
+      # filename for ascp with optional extension (Windows)
+      def ascp_filename
+        return 'ascp'+Environment.exe_extension
+      end
+
       # location of SDK files
       def folder=(v)
         @sdk_folder=v
@@ -50,26 +57,30 @@ module Aspera
       # @return the list of installed products in format of product_locations
       def installed_products
         if @found_products.nil?
-          @found_products=product_locations
-          # add sdk as first search path
-          @found_products.unshift({# SDK
+          scan_locations=product_locations.clone
+          # add SDK as first search path
+          scan_locations.unshift({
             :expected =>'SDK',
             :app_root =>folder_path,
             :sub_bin =>''
           })
-          @found_products.select! do |pl|
-            next false unless Dir.exist?(pl[:app_root])
-            Log.log.debug("found #{pl[:app_root]}")
-            sub_bin = pl[:sub_bin] || BIN_SUBFOLDER
-            pl[:ascp_path]=File.join(pl[:app_root],sub_bin,'ascp'+Environment.exe_extension)
-            next false unless File.exist?(pl[:ascp_path])
-            product_info_file="#{pl[:app_root]}/#{PRODUCT_INFO}"
+          # search installed products: with ascp
+          @found_products=scan_locations.select! do |item|
+            # skip if not main folder
+            next false unless Dir.exist?(item[:app_root])
+            Log.log.debug("Found #{item[:app_root]}")
+            sub_bin = item[:sub_bin] || BIN_SUBFOLDER
+            item[:ascp_path]=File.join(item[:app_root],sub_bin,ascp_filename)
+            # skip if no ascp
+            next false unless File.exist?(item[:ascp_path])
+            # read info from product info file if present
+            product_info_file="#{item[:app_root]}/#{PRODUCT_INFO}"
             if File.exist?(product_info_file)
-              res_s=XmlSimple.xml_in(File.read(product_info_file),{"ForceArray"=>false})
-              pl[:name]=res_s['name']
-              pl[:version]=res_s['version']
+              res_s=XmlSimple.xml_in(File.read(product_info_file),{'ForceArray'=>false})
+              item[:name]=res_s['name']
+              item[:version]=res_s['version']
             else
-              pl[:name]=pl[:expected]
+              item[:name]=item[:expected]
             end
             true # select this version
           end
@@ -77,6 +88,7 @@ module Aspera
         return @found_products
       end
 
+      # all ascp files (in SDK)
       FILES=[:ascp,:ascp4,:ssh_bypass_key_dsa,:ssh_bypass_key_rsa,:aspera_license,:aspera_conf,:fallback_cert,:fallback_key]
 
       # get path of one resource file of currently activated product
@@ -106,14 +118,8 @@ module Aspera
 <CONF version="2">
 <default>
     <file_system>
-        <storage_rc>
-            <adaptive>
-                true
-            </adaptive>
-        </storage_rc>
         <resume_suffix>.aspera-ckpt</resume_suffix>
         <partial_file_suffix>.partial</partial_file_suffix>
-        <replace_illegal_chars>_</replace_illegal_chars>
     </file_system>
 </default>
 </CONF>
@@ -147,7 +153,7 @@ module Aspera
         return file
       end
 
-      # @returns the file path of local connect where API's URI can be read
+      # @return the file path of local connect where API's URI can be read
       def connect_uri
         connect=get_product_folders(PRODUCT_CONNECT)
         folder=File.join(connect[:run_root],VARRUN_SUBFOLDER)
@@ -176,8 +182,21 @@ module Aspera
         return [:ssh_bypass_key_dsa,:ssh_bypass_key_rsa].map{|i|Installation.instance.path(i)}
       end
 
+      # Check that specified path is ascp and get version
+      def get_ascp_version(ascp_path)
+        raise "File basename of #{ascp_path} must be #{ascp_filename}" unless File.basename(ascp_path).eql?(ascp_filename)
+        ascp_version='n/a'
+        raise "error in sdk: no ascp included" if ascp_path.nil?
+        cmd_out=%x{"#{ascp_path}" -A}
+        raise "An error occured when testing #{ascp_filename}: #{cmd_out}" unless $? == 0
+        # get version from ascp, only after full extract, as windows requires DLLs (SSL/TLS/etc...)
+        m=cmd_out.match(/ascp version (.*)/)
+        ascp_version=m[1] unless m.nil?
+      end
+
       # download aspera SDK or use local file
-      # extract only ascp binary for current system architecture
+      # extracts ascp binary for current system architecture
+      # @return ascp version (from execution)
       def install_sdk(sdk_url)
         require 'zip'
         sdk_zip_path=File.join(Dir.tmpdir,'sdk.zip')
@@ -186,7 +205,7 @@ module Aspera
           raise 'use format: file:///<path>' unless sdk_url.start_with?('file:///')
           sdk_zip_path=sdk_url.gsub(%r{^file:///},'')
         else
-          redirect_remain=2
+          redirect_remain=MAX_REDIRECT_SDK
           begin
             Aspera::Rest.new(base_url: sdk_url).call(operation: 'GET',save_to_file: sdk_zip_path)
           rescue Aspera::RestCallError => e
@@ -196,7 +215,7 @@ module Aspera
                 sdk_url=e.response['location']
                 retry
               else
-                raise "too meny redirect"
+                raise "Too many redirect"
               end
             else
               raise e
@@ -206,6 +225,12 @@ module Aspera
         # SDK is organized by architecture
         filter="/#{Environment.architecture}/"
         ascp_path=nil
+        sdk_path=folder_path
+        # rename old install
+        if File.exist?(File.join(sdk_path,ascp_filename))
+          Log.log.warn("Previous install exists, renaming.")
+          File.rename(sdk_path,"#{sdk_path}.#{Time.now.strftime("%Y%m%d%H%M%S")}")
+        end
         # first ensure license file is here so that ascp invokation for version works
         self.path(:aspera_license)
         self.path(:aspera_conf)
@@ -213,11 +238,11 @@ module Aspera
           zip_file.each do |entry|
             # get only specified arch, but not folder, only files
             if entry.name.include?(filter) and !entry.name.end_with?('/')
-              archive_file=File.join(folder_path,File.basename(entry.name))
+              archive_file=File.join(sdk_path,File.basename(entry.name))
               File.open(archive_file, 'wb') do |output_stream|
                 IO.copy_stream(entry.get_input_stream, output_stream)
               end
-              if entry.name.include?('ascp')
+              if File.basename(entry.name).eql?(ascp_filename)
                 FileUtils.chmod(0755,archive_file)
                 ascp_path=archive_file
               end
@@ -225,13 +250,7 @@ module Aspera
           end
         end
         File.unlink(sdk_zip_path) rescue nil # Windows may give error
-        ascp_version='n/a'
-        raise "error in sdk: no ascp included" if ascp_path.nil?
-        cmd_out=%x{#{ascp_path} -A}
-        raise "An error occured when testing ascp: #{cmd_out}" unless $? == 0
-        # get version from ascp, only after full extract, as windows requires DLLs (SSL/TLS/etc...)
-        m=cmd_out.match(/ascp version (.*)/)
-        ascp_version=m[1] unless m.nil?
+        ascp_version=get_ascp_version(ascp_path)
         File.write(File.join(folder_path,PRODUCT_INFO),"<product><name>IBM Aspera SDK</name><version>#{ascp_version}</version></product>")
         return ascp_version
       end
@@ -248,27 +267,28 @@ module Aspera
 
       private_constant :BIN_SUBFOLDER,:ETC_SUBFOLDER,:VARRUN_SUBFOLDER,:PRODUCT_INFO
 
-      # get some specific folder from specific applications: Connect or CLI
-      def get_product_folders(name)
-        found=installed_products.select{|i|i[:expected].eql?(name) or i[:name].eql?(name)}
-        raise "Product: #{name} not found, please install." if found.empty?
-        return found.first
-      end
-
       def initialize
         @path_to_ascp=nil
         @sdk_folder=nil
         @found_products=nil
       end
 
+      # @return folder paths for specified applications
+      # @param name Connect or CLI
+      def get_product_folders(name)
+        found=installed_products.select{|i|i[:expected].eql?(name) or i[:name].eql?(name)}
+        raise "Product: #{name} not found, please install." if found.empty?
+        return found.first
+      end
+
+      # @return the path to folder where SDK is installed
       def folder_path
-        raise "undefined path to SDK" if @sdk_folder.nil?
+        raise "Undefined path to SDK" if @sdk_folder.nil?
         FileUtils.mkdir_p(@sdk_folder) unless Dir.exist?(@sdk_folder)
         @sdk_folder
       end
 
-      # returns product folders depending on OS
-      # fields
+      # @return product folders depending on OS fields
       # :expected  M app name is taken from the manifest if present, else defaults to this value
       # :app_root  M main folder for the application
       # :log_root  O location of log files (Linux uses syslog)
@@ -310,7 +330,7 @@ module Aspera
             :log_root =>File.join(Dir.home,'Library','Logs','Aspera_Drive'),
             :sub_bin  =>File.join('Contents','Resources'),
             }]
-        else; return [{  # other: Linux and unix family
+        else; return [{  # other: Linux and Unix family
             :expected =>PRODUCT_CONNECT,
             :app_root =>File.join(Dir.home,'.aspera','connect'),
             :run_root =>File.join(Dir.home,'.aspera','connect')
@@ -324,6 +344,9 @@ module Aspera
         end
       end
 
+      # @return a standard bypass key
+      # @param type rsa or dsa
+      # @param id in repository 1 for dsa, 2 for rsa
       def get_key(type,id)
         hf=['begin','end'].map{|t|"-----#{t} #{type} private key-----".upcase}
         bin=Base64.strict_encode64(DataRepository.instance.get_bin(id))