aspera-cli 4.18.0 → 4.18.1

data/lib/aspera/rest.rb

@@ -12,7 +12,7 @@ require 'json'
 require 'base64'
 require 'cgi'
 
-# add cancel method to http
+# Cancel method for HTTP
 class Net::HTTP::Cancel < Net::HTTPRequest # rubocop:disable Style/ClassAndModuleChildren
   METHOD = 'CANCEL'
   REQUEST_HAS_BODY  = false
@@ -24,12 +24,16 @@ module Aspera
   # rest call errors are raised as exception RestCallError
   # and error are analyzed in RestErrorAnalyzer
   class Rest
-    # global settings also valid for any subclass
+    # Global settings also valid for any subclass
+    # @param user_agent [String] HTTP request header: 'User-Agent'
+    # @param download_partial_suffix [String] suffix for partial download
+    # @param session_cb [lambda] lambda called on new HTTP session. Takes the Net::HTTP as arg. Used to change parameters on creation.
+    # @param progress_bar [Object] progress bar object
     @@global = { # rubocop:disable Style/ClassVars
-      user_agent:              'Ruby',          # goes to HTTP request header: 'User-Agent'
-      download_partial_suffix: '.http_partial', # suffix for partial download
-      session_cb:              nil,             # a lambda which takes the Net::HTTP as arg, use this to change parameters
-      progress_bar:            nil # progress bar object
+      user_agent:              'RubyAsperaRest',
+      download_partial_suffix: '.http_partial',
+      session_cb:              nil,
+      progress_bar:            nil
     }
 
     # flag for array parameters prefixed with []
@@ -44,9 +48,10 @@ module Aspera
     JSON_DECODE = ['application/json', 'application/vnd.api+json', 'application/x-javascript'].freeze
 
     class << self
+      # @return [String] Basic auth token
       def basic_token(user, pass); return "Basic #{Base64.strict_encode64("#{user}:#{pass}")}"; end
 
-      # used to build a parameter list prefixed with "[]"
+      # Build a parameter list prefixed with "[]"
       # @param values [Array] list of values
       def array_params(values)
         return [ARRAY_PARAMS].concat(values)
@@ -56,7 +61,7 @@ module Aspera
         return values.first.eql?(ARRAY_PARAMS)
       end
 
-      # build URI from URL and parameters and check it is http or https, encode array [] parameters
+      # Build URI from URL and parameters and check it is http or https, encode array [] parameters
       def build_uri(url, query_hash=nil)
         uri = URI.parse(url)
         Aspera.assert(%w[http https].include?(uri.scheme)){"REST endpoint shall be http/s not #{uri.scheme}"}
@@ -82,8 +87,16 @@ module Aspera
         return uri
       end
 
+      # decode query string as hash
+      # Does not support arrays in query string, no standard, e.g. PHP's way is p[]=1&p[]=2
+      # @param query [String] query string
+      # @return [Hash] decoded query
       def decode_query(query)
-        URI.decode_www_form(query).each_with_object({}){|v, h|h[v.first] = v.last }
+        URI.decode_www_form(query).each_with_object({}) do |pair, h|
+          key = pair.first
+          raise "Array not supported in query string: #{key}" if key.include?('[]') || h.key?(key)
+          h[key] = pair.last
+        end
       end
 
       # Start a HTTP/S session, also used for web sockets
@@ -141,6 +154,17 @@ module Aspera
       def user_agent
         return @@global[:user_agent]
       end
+
+      def parse_header(header)
+        type, *params = header.split(/;\s*/)
+        parameters = params.map do |param|
+          one = param.split(/=\s*/)
+          one[0] = one[0].to_sym
+          one[1] = one[1].gsub(/\A"|"\z/, '')
+          one
+        end.to_h
+        { type: type.downcase, parameters: parameters }
+      end
     end
 
     private
@@ -185,8 +209,12 @@ module Aspera
       headers: nil
     )
       Aspera.assert_type(base_url, String)
-      # base url with max one trailing slashes (note: string may be frozen)
-      @base_url = base_url.gsub(%r{//+$}, '/')
+      # base url with no trailing slashes (note: string may be frozen)
+      @base_url = base_url.gsub(%r{/+$}, '')
+      # remove trailing port if it is 443 and scheme is https
+      @base_url = @base_url.gsub(/:443$/, '') if @base_url.start_with?('https://')
+      @base_url = @base_url.gsub(/:80$/, '') if @base_url.start_with?('http://')
+      Log.log.debug{"Rest.new(#{@base_url})"}
       # default is no auth
       @auth_params = auth.nil? ? {type: :none} : auth
       Aspera.assert_type(@auth_params, Hash)
@@ -265,7 +293,7 @@ module Aspera
       begin
         # TODO: shall we percent encode subpath (spaces) test with access key delete with space in id
         # URI.escape()
-        separator = !['', '/'].include?(subpath) || @base_url.end_with?('/') ? '/' : ''
+        separator = ['', '/'].include?(subpath) ? '' : '/'
         uri = self.class.build_uri("#{@base_url}#{separator}#{subpath}", query)
         Log.log.debug{"URI=#{uri}"}
         begin
@@ -305,7 +333,7 @@ module Aspera
         # make http request (pipelined)
         http_session.request(req) do |response|
           result[:http] = response
-          result_mime = (result[:http]['Content-Type'] || 'text/plain').split(';').first.downcase
+          result_mime = self.class.parse_header(result[:http]['Content-Type'] || 'text/plain')[:type]
           # JSON data needs to be parsed, in case it contains an error code
           if !save_to_file.nil? &&
               result[:http].code.to_s.start_with?('2') &&
@@ -315,8 +343,11 @@ module Aspera
             Log.log.debug('before write file')
             target_file = save_to_file
             # override user's path to path in header
-            if !response['Content-Disposition'].nil? && (m = response['Content-Disposition'].match(/filename="([^"]+)"/))
-              target_file = File.join(File.dirname(target_file), m[1])
+            if !response['Content-Disposition'].nil?
+              disposition = self.class.parse_header(response['Content-Disposition'])
+              if disposition[:parameters].key?(:filename)
+                target_file = File.join(File.dirname(target_file), disposition[:parameters][:filename])
+              end
             end
             # download with temp filename
             target_file_tmp = "#{target_file}#{@@global[:download_partial_suffix]}"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.18.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-07-10 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
@@ -435,6 +436,7 @@ files:
 - 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
@@ -468,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/open_application.rb

@@ -1,69 +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
-    USER_INTERFACES = %i[text graphical].freeze
-    class << self
-      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?
-        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
-
-    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
-end