aspera-cli 4.22.0 → 4.24.0

data/lib/aspera/oauth/web.rb

@@ -31,8 +31,9 @@ module Aspera
         # generate secure state to check later
         random_state = SecureRandom.uuid
         login_page_url = Rest.build_uri(
-          "#{@api.base_url}/#{@path_authorize}",
-          optional_scope_client_id.merge(response_type: 'code', redirect_uri: @redirect_uri, state: random_state))
+          "#{api.base_url}/#{@path_authorize}",
+          optional_scope_client_id.merge(response_type: 'code', redirect_uri: @redirect_uri, state: random_state)
+        )
         # here, we need a human to authorize on a web page
         Log.log.info{"login_page_url=#{login_page_url}".bg_red.gray}
         # start a web server to receive request code
@@ -46,7 +47,8 @@ module Aspera
         return create_token_call(optional_scope_client_id(add_secret: true).merge(
           grant_type:   'authorization_code',
           code:         received_params['code'],
-          redirect_uri: @redirect_uri))
+          redirect_uri: @redirect_uri
+        ))
       end
     end
     Factory.instance.register_token_creator(Web)

data/lib/aspera/persistency_folder.rb

@@ -60,7 +60,7 @@ module Aspera
     end
 
     # Delete persisted items
-    def garbage_collect(persist_category, max_age_seconds=nil)
+    def garbage_collect(persist_category, max_age_seconds = nil)
       garbage_files = current_files(persist_category)
       if !max_age_seconds.nil?
         current_time = Time.now
@@ -75,7 +75,7 @@ module Aspera
     end
 
     def current_files(persist_category)
-      Dir[File.join(@folder, persist_category + '*' + FILE_SUFFIX)]
+      Dir[File.join(@folder, "#{persist_category}*#{FILE_SUFFIX}")]
     end
 
     def current_items(persist_category)

data/lib/aspera/preview/file_types.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'aspera/log'
+require 'aspera/assert'
 require 'singleton'
 require 'mime/types'
 
@@ -9,6 +10,7 @@ module Aspera
     # function conversion_type returns one of the types: CONVERSION_TYPES
     class FileTypes
       include Singleton
+
       # values for conversion_type : input format
       CONVERSION_TYPES = %i[image office pdf plaintext video].freeze
 
@@ -22,6 +24,8 @@ module Aspera
         'application/mxf'                    => :video,
         'application/mac-binhex40'           => :office,
         'application/msword'                 => :office,
+        'application/vnd.ms-excel'           => :office,
+        'application/vnd.ms-powerpoint'      => :office,
         'application/rtf'                    => :office,
         'application/x-abiword'              => :office,
         'application/x-mspublisher'          => :office,
@@ -44,7 +48,8 @@ module Aspera
         'application/x-xfig'                 => :image,
         'font/ttf'                           => :image,
         'text/troff'                         => :image,
-        'video/x-mng'                        => :image}.freeze
+        'video/x-mng'                        => :image
+      }.freeze
 
       private_constant :SUPPORTED_MIME_TYPES
 
@@ -56,17 +61,43 @@ module Aspera
       end
 
       # @param mimetype [String] mime type
-      # @return file type, one of enum CONVERSION_TYPES
+      # @return file type, one of enum CONVERSION_TYPES, or nil if not found
       def mime_to_type(mimetype)
+        Aspera.assert_type(mimetype, String)
         return SUPPORTED_MIME_TYPES[mimetype] if SUPPORTED_MIME_TYPES.key?(mimetype)
-        return :office if mimetype.start_with?('application/vnd.')
+        return :office if mimetype.start_with?('application/vnd.ms-')
+        return :office if mimetype.start_with?('application/vnd.openxmlformats-officedocument')
         return :video if mimetype.start_with?('video/')
         return :image if mimetype.start_with?('image/')
-        return nil
+        return
+      end
+
+      # @param filepath [String] full path to file
+      # @param mimetype [String] provided by node API
+      # @return file type, one of enum CONVERSION_TYPES
+      # @raise [RuntimeError] if no conversion type found
+      def conversion_type(filepath, mimetype)
+        Log.log.debug{"conversion_type(#{filepath},mime=#{mimetype},magic=#{@use_mimemagic})"}
+        mimetype = nil if mimetype.is_a?(String) && (mimetype == 'application/octet-stream' || mimetype.empty?)
+        # Use mimemagic if available
+        mimetype ||= mime_using_mimemagic(filepath)
+        mimetype ||= mime_using_file(filepath)
+        # from extensions, using local mapping
+        mimetype ||= MIME::Types.of(File.basename(filepath)).first
+        raise "no MIME type found for #{File.basename(filepath)}" if mimetype.nil?
+        conversion_type = mime_to_type(mimetype)
+        raise "no conversion type found for #{File.basename(filepath)}" if conversion_type.nil?
+        Log.log.trace1{"conversion_type(#{File.basename(filepath)}): #{conversion_type.class.name} [#{conversion_type}]"}
+        return conversion_type
       end
 
-      # use mime magic to find mime type based on file content (magic numbers)
-      def file_to_mime(filepath)
+      private
+
+      # Use mime magic to find mime type based on file content (magic numbers)
+      # @param filepath [String] full path to file
+      # @return [String] mime type, or nil if not found
+      def mime_using_mimemagic(filepath)
+        return unless @use_mimemagic
         # moved here, as `mimemagic` can cause installation issues
         require 'mimemagic'
         require 'mimemagic/version'
@@ -83,35 +114,12 @@ module Aspera
         return detected_mime
       end
 
-      # @param filepath [String] full path to file
-      # @param mimetype [String] provided by node API
-      # @return file type, one of enum CONVERSION_TYPES
-      # @raise [RuntimeError] if no conversion type found
-      def conversion_type(filepath, mimetype)
-        Log.log.debug{"conversion_type(#{filepath},m=#{mimetype},t=#{@use_mimemagic})"}
-        # 1- get type from provided mime type, using local mapping
-        conversion_type = mime_to_type(mimetype) if !mimetype.nil?
-        # 2- else, from computed mime type (if available)
-        if conversion_type.nil? && @use_mimemagic
-          detected_mime = file_to_mime(filepath)
-          if !detected_mime.nil?
-            conversion_type = mime_to_type(detected_mime)
-            if !mimetype.nil?
-              if mimetype.eql?(detected_mime)
-                Log.log.debug('matching mime type per magic number')
-              else
-                # NOTE: detected can be nil
-                Log.log.debug{"non matching mime types: node=[#{mimetype}], magic=[#{detected_mime}]"}
-              end
-            end
-          end
-        end
-        # 3- else, from extensions, using local mapping
-        mime_by_ext = MIME::Types.of(File.basename(filepath)).first
-        conversion_type = mime_to_type(mime_by_ext.to_s) if conversion_type.nil? && !mime_by_ext.nil?
-        raise "no conversion type found for #{File.basename(filepath)}" if conversion_type.nil?
-        Log.log.trace1{"conversion_type(#{File.basename(filepath)}): #{conversion_type.class.name} [#{conversion_type}]"}
-        return conversion_type
+      # Use 'file' command to find mime type based on file content (Unix)
+      def mime_using_file(filepath)
+        return Environment.secure_capture(exec: 'file', args: ['--mime-type', '--brief', filepath]).strip
+      rescue => e
+        Log.log.error{"error using 'file' command: #{e.message}"}
+        return
       end
     end
   end

data/lib/aspera/preview/generator.rb

@@ -116,7 +116,9 @@ module Aspera
             '-filter:v', "scale='trunc(iw/2)*2:trunc(ih/2)*2'",
             '-codec:v', 'libx264',
             '-r', 30,
-            '-pix_fmt', 'yuv420p'])
+            '-pix_fmt', 'yuv420p'
+          ]
+        )
       end
 
       # generate n clips starting at offset
@@ -135,7 +137,9 @@ module Aspera
                 '-ss', offset_seconds * 0.1,
                 '-t', @options.clips_length,
                 '-filter:v', "scale=#{@options.video_scale}",
-                '-codec:a', 'libmp3lame'])
+                '-codec:a', 'libmp3lame'
+              ]
+            )
             f.puts("file '#{tmp_file_name}'")
           end
         end
@@ -144,7 +148,8 @@ module Aspera
           in_f: file_list_file,
           in_p: ['-f', 'concat'],
           out_f: @destination_file_path,
-          out_p: ['-codec', 'copy'])
+          out_p: ['-codec', 'copy']
+        )
         File.delete(file_list_file)
       end
 
@@ -174,7 +179,9 @@ module Aspera
             '-codec:a', 'libmp3lame',
             '-ac', '2',
             '-b:a', '128k',
-            '-movflags', 'faststart'])
+            '-movflags', 'faststart'
+          ]
+        )
       end
 
       def convert_video_to_png_using_fixed
@@ -182,7 +189,8 @@ module Aspera
           @source_file_path,
           Utils.video_get_duration(@source_file_path) * @options.thumb_vid_fraction,
           @options.thumb_vid_scale,
-          @destination_file_path)
+          @destination_file_path
+        )
       end
 
       # https://trac.ffmpeg.org/wiki/SponsoringPrograms/GSoC/2015#AnimatedPortableNetworkGraphicsAPNG
@@ -201,19 +209,21 @@ module Aspera
             '-vf', 'fps=5,scale=120:-1:flags=lanczos,split[s0][s1];[s0]palettegen[p];[s1][p]paletteuse',
             '-loop', 0,
             '-f', 'gif'
-          ])
+          ]
+        )
       end
 
       def convert_office_to_png
-        tmp_pdf_file = File.join(this_tmpdir, File.basename(@source_file_path, File.extname(@source_file_path)) + '.pdf')
+        tmp_pdf_file = File.join(this_tmpdir, "#{File.basename(@source_file_path, File.extname(@source_file_path))}.pdf")
         Utils.external_command(:unoconv, [
           '-f', 'pdf',
           '-o', tmp_pdf_file,
-          @source_file_path])
+          @source_file_path
+        ])
         convert_pdf_to_png(tmp_pdf_file)
       end
 
-      def convert_pdf_to_png(source_file_path=nil)
+      def convert_pdf_to_png(source_file_path = nil)
         source_file_path ||= @source_file_path
         Utils.external_command(:magick, [
           'convert',
@@ -221,7 +231,8 @@ module Aspera
           '-background', 'white',
           '-flatten',
           "#{source_file_path}[0]",
-          @destination_file_path])
+          @destination_file_path
+        ])
       end
 
       def convert_image_to_png
@@ -233,14 +244,15 @@ module Aspera
           '+dither',
           '-posterize', 40,
           "#{@source_file_path}[0]",
-          @destination_file_path])
+          @destination_file_path
+        ])
         Utils.external_command(:optipng, [@destination_file_path])
       end
 
       # text to png
       def convert_plaintext_to_png
         # get 100 first lines of text file
-        first_lines = File.open(@source_file_path){ |f| Array.new(100){f.readline rescue ''}.join}
+        first_lines = File.foreach(@source_file_path).first(100).join
         Utils.external_command(:magick, [
           'convert',
           '-size', "#{@options.thumb_img_size}x#{@options.thumb_img_size}",
@@ -253,7 +265,8 @@ module Aspera
           '-bordercolor', 'white',
           '-border', 8,
           '+repage',
-          @destination_file_path])
+          @destination_file_path
+        ])
       end
     end
   end

data/lib/aspera/preview/terminal.rb

@@ -5,9 +5,11 @@
 require 'rainbow'
 require 'io/console'
 require 'aspera/log'
+require 'aspera/environment'
 module Aspera
   module Preview
-    # Display a picture in the terminal, either using coloured characters or iTerm2
+    # Display a picture in the terminal.
+    # Either use coloured characters or iTerm2 protocol.
     class Terminal
       # Rainbow only supports 8-bit colors
       # env vars to detect terminal type
@@ -19,13 +21,14 @@ module Aspera
       DEFAULT_FONT_RATIO = 32.0 / 14.0
       private_constant :TERM_ENV_VARS, :ITERM_NAMES, :DEFAULT_FONT_RATIO
       class << self
-        # @return [String] the image as text, or the iTerm2 escape sequence
-        # @param blob [String] the image as a binary string
-        # @param reserve [Integer] number of lines to reserve for other text than the image
-        # @param text [Boolean] true to display the image as text, false to use iTerm2
-        # @param double [Boolean] true to use colors on half lines, false to use colors on full lines
-        # @param font_ratio [Float] ratio = font height / font width
+        # @param blob       [String]  The image as a binary string
+        # @param reserve    [Integer] Number of lines to reserve for other text than the image
+        # @param text       [Boolean] `true` to display the image as text, `false` to use iTerm2 if supported
+        # @param double     [Boolean] `true` to use colors on half lines, `false` to use colors on full lines
+        # @param font_ratio [Float]   ratio = font height / font width
+        # @return [String] The image as text, or the iTerm2 escape sequence
         def build(blob, reserve: 3, text: false, double: true, font_ratio: DEFAULT_FONT_RATIO)
+          return '[Image display requires a terminal]' unless Environment.terminal?
           return iterm_display_image(blob) if iterm_supported? && !text
           begin
             # do not require statically, as the package is optional

data/lib/aspera/preview/utils.rb

@@ -31,7 +31,7 @@ module Aspera
         end
 
         # check that external tools can be executed
-        def check_tools(skip_types=[])
+        def check_tools(skip_types = [])
           tools_to_check = EXTERNAL_TOOLS.dup
           tools_to_check.delete(:unoconv) if skip_types.include?(:office)
           # Check for binaries
@@ -70,7 +70,8 @@ module Aspera
             '-loglevel', 'error',
             '-show_entries', 'format=duration',
             '-print_format', 'default=noprint_wrappers=1:nokey=1', # cspell:disable-line
-            input_file]).to_f
+            input_file
+          ]).to_f
         end
 
         def ffmpeg_fmt(temp_folder)
@@ -88,24 +89,25 @@ module Aspera
           end
         end
 
-        def video_blend_frames(temp_folder, index1, index2)
-          img1 = get_tmp_num_filepath(temp_folder, index1)
-          img2 = get_tmp_num_filepath(temp_folder, index2)
-          count = index2 - index1 - 1
+        def video_blend_frames(temp_folder, index_begin, index_end)
+          img1 = get_tmp_num_filepath(temp_folder, index_begin)
+          img2 = get_tmp_num_filepath(temp_folder, index_end)
+          count = index_end - index_begin - 1
           1.upto(count) do |i|
             percent = i * 100 / (count + 1)
-            filename = get_tmp_num_filepath(temp_folder, index1 + i)
+            filename = get_tmp_num_filepath(temp_folder, index_begin + i)
             external_command(:magick, ['composite', '-blend', percent, img2, img1, filename])
           end
         end
 
-        def video_dump_frame(input_file, offset_seconds, scale, output_file, index=nil)
+        def video_dump_frame(input_file, offset_seconds, scale, output_file, index = nil)
           output_file = get_tmp_num_filepath(output_file, index) unless index.nil?
           ffmpeg(
             in_f: input_file,
             in_p: ['-ss', offset_seconds],
             out_f: output_file,
-            out_p: ['-frames:v', 1, '-filter:v', "scale=#{scale}"])
+            out_p: ['-frames:v', 1, '-filter:v', "scale=#{scale}"]
+          )
           return output_file
         end
       end

data/lib/aspera/products/connect.rb

@@ -7,12 +7,13 @@ module Aspera
   module Products
     class Connect
       include Singleton
+
       APP_NAME = 'IBM Aspera Connect'
 
       class << self
         # standard folder locations
         def locations
-          case Aspera::Environment.os
+          case Aspera::Environment.instance.os
           when Aspera::Environment::OS_WINDOWS then [{
             app_root: File.join(ENV.fetch('LOCALAPPDATA', nil), 'Programs', 'Aspera', 'Aspera Connect'),
             log_root: File.join(ENV.fetch('LOCALAPPDATA', nil), 'Aspera', 'Aspera Connect', 'var', 'log'),

data/lib/aspera/products/desktop.rb

@@ -11,7 +11,7 @@ module Aspera
       class << self
         # standard folder locations
         def locations
-          case Aspera::Environment.os
+          case Aspera::Environment.instance.os
           when Aspera::Environment::OS_MACOS then [{
             app_root: File.join('', 'Applications', 'IBM Aspera.app'),
             log_root: File.join(Dir.home, 'Library', 'Logs', APP_IDENTIFIER),

data/lib/aspera/products/other.rb

@@ -21,7 +21,7 @@ module Aspera
       # :log_root  O location of log files (Linux uses syslog)
       # :run_root  O only for Connect Client, location of http port file
       # :sub_bin   O subfolder with executables, default : bin
-      LOCATION_ON_THIS_OS = case Aspera::Environment.os
+      LOCATION_ON_THIS_OS = case Aspera::Environment.instance.os
       when Aspera::Environment::OS_WINDOWS then [{
         expected: CLI_V3,
         app_root: File.join('C:', 'Program Files', 'Aspera', 'cli'),
@@ -61,7 +61,7 @@ module Aspera
             next false unless Dir.exist?(item[:app_root])
             Log.log.debug{"Found #{item[:expected]}"}
             sub_bin = item[:sub_bin] || 'bin'
-            item[:ascp_path] = File.join(item[:app_root], sub_bin, Environment.exe_file('ascp'))
+            item[:ascp_path] = File.join(item[:app_root], sub_bin, Environment.instance.exe_file('ascp'))
             # skip if no ascp
             next false unless File.exist?(item[:ascp_path])
             # read info from product info file if present

data/lib/aspera/products/transferd.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'aspera/log'
+require 'aspera/assert'
 module Aspera
   module Products
     class Transferd
@@ -19,9 +21,9 @@ module Aspera
         end
 
         # location of SDK files
-        def sdk_directory=(v)
-          Log.log.debug{"sdk_directory=#{v}"}
-          @sdk_dir = v
+        def sdk_directory=(folder)
+          Log.log.debug{"sdk_directory=#{folder}"}
+          @sdk_dir = folder
           sdk_directory
         end
 
@@ -33,9 +35,9 @@ module Aspera
         end
 
         def transferd_path
-          v1_path = File.join(sdk_directory, Environment.exe_file(V1_DAEMON_NAME))
+          v1_path = File.join(sdk_directory, Environment.instance.exe_file(V1_DAEMON_NAME))
           return v1_path if File.exist?(v1_path)
-          return File.join(sdk_directory, Environment.exe_file(V2_DAEMON_NAME))
+          return File.join(sdk_directory, Environment.instance.exe_file(V2_DAEMON_NAME))
         end
 
         # Well, the port number is only in log file
@@ -51,7 +53,7 @@ module Aspera
               end
             end
           end
-          raise 'Port not found in daemon logs' if result.nil?
+          Aspera.assert(!result.nil?){'Port not found in daemon logs'}
           Log.log.debug{"Got port #{result} from log"}
           return result
         end

data/lib/aspera/proxy_auto_config.rb

@@ -13,7 +13,7 @@ module URI
       def register_proxy_finder
         Aspera.assert(block_given?)
         # overload the method in URI : call user's provided block and fallback to original method
-        define_method(:find_proxy){ |env_vars=ENV| yield(to_s) || find_proxy_orig(env_vars)}
+        define_method(:find_proxy){ |env_vars = ENV| yield(to_s) || find_proxy_orig(env_vars)}
       end
     end
   end