aspera-cli 4.25.6 → 4.26.0

data/lib/aspera/preview/utils.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-# cspell:ignore ffprobe optipng unoconv
+# cspell:ignore ffprobe optipng unoconv soffice
 require 'aspera/log'
 require 'aspera/assert'
 require 'English'
@@ -11,32 +11,30 @@ require 'open3'
 module Aspera
   module Preview
     class Utils
-      # from bash manual: meta-character need to be escaped
-      BASH_SPECIAL_CHARACTERS = "|&;()<> \t#\n"
-      # external binaries used
-      EXTERNAL_TOOLS = %i[ffmpeg ffprobe magick optipng unoconv].freeze
+      # External binaries used
+      EXTERNAL_TOOLS = %i[ffmpeg ffprobe magick optipng unoconv soffice].freeze
+      # File name format for temporary files, used by both ffmpeg and ruby(Kernel.format)
       TEMP_FORMAT = 'img%04d.jpg'
+      # default parameters for ffmpeg
       FFMPEG_DEFAULT_PARAMS = [
         '-y', # overwrite output without asking
         '-loglevel', 'error' # show only errors and up
       ].freeze
-      private_constant :BASH_SPECIAL_CHARACTERS, :EXTERNAL_TOOLS, :TEMP_FORMAT
+      private_constant :EXTERNAL_TOOLS, :TEMP_FORMAT, :FFMPEG_DEFAULT_PARAMS
 
       class << self
-        # returns string with single quotes suitable for bash if there is any bash meta-character
-        def shell_quote(argument)
-          return argument unless argument.chars.any?{ |c| BASH_SPECIAL_CHARACTERS.include?(c)}
-          # surround with single quotes, and escape single quotes
-          return %Q{'#{argument.gsub("'"){ |_s| %q{'"'"'}}}'}
-        end
-
-        # check that external tools can be executed
+        # Check that external tools can be executed
+        # @param skip_types [Array<Symbol>] list of tools to skip
+        # @return [nil]
         def check_tools(skip_types = [])
           tools_to_check = EXTERNAL_TOOLS.dup
-          tools_to_check.delete(:unoconv) if skip_types.include?(:office)
+          if skip_types.include?(:office)
+            tools_to_check.delete(:unoconv)
+            tools_to_check.delete(:soffice)
+          end
           # Check for binaries
           tools_to_check.each do |command_sym|
-            external_command(command_sym, ['-h'], out: File::NULL)
+            silent_execute(command_sym, '-h')
           rescue Errno::ENOENT => e
             raise "missing #{command_sym} binary: #{e}"
           rescue
@@ -44,42 +42,47 @@ module Aspera
           end
         end
 
-        # Execute external command
-        # @return [nil]
-        def external_command(command_sym, command_args)
-          Aspera.assert_values(command_sym, EXTERNAL_TOOLS){'command'}
-          Environment.secure_execute(command_sym.to_s, *command_args.map(&:to_s), out: File::NULL, err: File::NULL)
+        # Execute external command, verify it is in the supported list
+        def execute(*args, **kwargs)
+          Aspera.assert_values(args.first, EXTERNAL_TOOLS){'command'}
+          Environment.secure_execute(*args, **kwargs)
         end
 
-        # Execute external command and get stdout
-        # @return [String]
-        def external_capture(command_sym, command_args)
-          Aspera.assert_values(command_sym, EXTERNAL_TOOLS){'command'}
-          Environment.secure_execute(command_sym.to_s, *command_args.map(&:to_s), mode: :capture).first
+        # Execute external command silently
+        # @return [nil]
+        def silent_execute(*args)
+          execute(*args, out: File::NULL, err: File::NULL)
+          nil
         end
 
+        # Execute `ffmpeg`
+        # @return [nil]
         def ffmpeg(gl_p: FFMPEG_DEFAULT_PARAMS, in_p: [], in_f:, out_p: [], out_f:)
           Aspera.assert_type(gl_p, Array)
           Aspera.assert_type(in_p, Array)
           Aspera.assert_type(out_p, Array)
-          external_command(:ffmpeg, gl_p +  in_p + ['-i', in_f] + out_p + [out_f])
+          silent_execute(:ffmpeg, *gl_p, *in_p, '-i', in_f, *out_p, out_f)
         end
 
         # @return Float in seconds
         def video_get_duration(input_file)
-          return external_capture(:ffprobe, [
+          return execute(
+            :ffprobe,
             '-loglevel', 'error',
             '-show_entries', 'format=duration',
             '-print_format', 'default=noprint_wrappers=1:nokey=1', # cspell:disable-line
-            input_file
-          ]).to_f
+            input_file,
+            mode: :capture
+          ).first.to_f
         end
 
+        # File output format, including temp folder
         def ffmpeg_fmt(temp_folder)
           return File.join(temp_folder, TEMP_FORMAT)
         end
 
         def get_tmp_num_filepath(temp_folder, file_number)
+          # Format using {Kernel.format}
           return File.join(temp_folder, format(TEMP_FORMAT, file_number))
         end
 
@@ -97,19 +100,58 @@ module Aspera
           1.upto(count) do |i|
             percent = i * 100 / (count + 1)
             filename = get_tmp_num_filepath(temp_folder, index_begin + i)
-            external_command(:magick, ['composite', '-blend', percent, img2, img1, filename])
+            silent_execute(:magick, 'composite', '-blend', percent, img2, img1, filename)
           end
         end
 
-        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?
+        # Dump a frame from a video file
+        # @param input_file [String] the input file path
+        # @param offset_seconds [Integer] the offset in seconds
+        # @param scale [String] the scale of the output frame
+        # @param output_file [String] the output file path
+        # @return [nil]
+        def video_dump_frame(input_file, offset_seconds, scale, output_file)
           ffmpeg(
             in_f: input_file,
             in_p: ['-ss', offset_seconds],
             out_f: output_file,
             out_p: ['-frames:v', 1, '-filter:v', "scale=#{scale}"]
           )
-          return output_file
+        end
+
+        # Parse the output of `magick identify -list font` command
+        # @param output [String] the output from `magick -list font`
+        # @return [Hash] with keys :path and :fonts
+        #   :path [String] the path to the type.xml file
+        #   :fonts [Array<Hash>] array of font hashes with keys:
+        #     :name, :family, :style, :stretch, :weight, :metrics, :glyphs, :index
+        def parse_magick_fonts(output)
+          result = {path: nil, fonts: []}
+          current_font = nil
+          output.each_line do |line|
+            line = line.strip
+            # Parse the Path line
+            if line.start_with?('Path:')
+              result[:path] = line.sub(/^Path:\s*/, '')
+            # Parse Font name
+            elsif line.start_with?('Font:')
+              # Save previous font if exists
+              result[:fonts] << current_font if current_font
+              # Start new font
+              current_font = {name: line.sub(/^Font:\s*/, '')}
+            # Parse font properties
+            elsif current_font && line.include?(':')
+              key, value = line.split(':', 2)
+              key = key.strip.gsub(/\s+/, '_').to_sym
+              value = value.strip
+              # Convert numeric values
+              value = value.to_i if key == :weight || key == :index
+              current_font[key] = value
+            end
+          end
+          # Don't forget the last font
+          result[:fonts] << current_font if current_font
+          result
         end
       end
     end

data/lib/aspera/products/transferd.rb

@@ -27,7 +27,7 @@ module Aspera
           sdk_directory
         end
 
-        # @return the path to folder where SDK is installed
+        # @return the path to folder where SDK is or should be installed
         def sdk_directory
           Aspera.assert(!@sdk_dir.nil?){'SDK path was not initialized'}
           @sdk_dir

data/lib/aspera/rest.rb

@@ -78,6 +78,7 @@ module Aspera
 
       # Indicate that the given Hash query uses php style for array parameters
       # @param query [Hash] A key can have Array value and result will use PHP format: a[]=1&a[]=2
+      # @return [Hash] The query parameters.
       def php_style(query)
         Aspera.assert_type(query, Hash){'query'}
         query[:x_array_php_style] = true

data/lib/aspera/rest_list.rb

@@ -11,33 +11,39 @@ module Aspera
 
     # Query entity by general search (read with parameter `q`)
     #
-    # @param subpath     [String] Path of entity in API
-    # @param search_name [String] Name of searched entity
-    # @param query       [Hash]   Optional additional search query parameters
+    # @param entity [String] Path of entity in API
+    # @param value [String] Value of field of searched entity
+    # @param field [String] Field of searched entity
+    # @param query [Hash] Optional additional search query parameters
     # @returns [Hash] A single entity matching the search, or an exception if not found or multiple found
-    def lookup_by_name(subpath, search_name, query: nil)
-      query = {} if query.nil?
+    def lookup_with_q(entity, value:, field: 'name', query: {})
+      Aspera.assert_type(query, Hash){'query'}
+      Aspera.assert_type(field, String){'field'}
       # returns entities matching the query (it matches against several fields in case insensitive way)
-      matching_items = read(subpath, query.merge({'q' => search_name}))
-      # API style: {totalcount:, ...} cspell: disable-line
-      matching_items = matching_items[subpath] if matching_items.is_a?(Hash)
+      # We don't do paging, as anyway, we look for only one match
+      matching_items = read(entity, query.merge({'q' => value}))
+      # API style: {totalcount:, ...} cspell: disable-line: TODO: is that total_count ?
+      # @type [Array<Hash{String => String}>]
+      matching_items = matching_items[entity] if matching_items.is_a?(Hash)
       Aspera.assert_type(matching_items, Array)
       case matching_items.length
       when 1 then return matching_items.first
-      when 0 then raise EntityNotFound, %Q{No such #{subpath}: "#{search_name}"}
+      when 0 then raise EntityNotFound, %Q{No such #{entity}: "#{value}"}
       else
         # multiple case insensitive partial matches, try case insensitive full match
-        # (anyway AoC does not allow creation of 2 entities with same case insensitive name)
-        name_matches = matching_items.select{ |i| i['name'].casecmp?(search_name)}
-        case name_matches.length
-        when 1 then return name_matches.first
-        when 0 then raise %Q(#{subpath}: Multiple case insensitive partial match for: "#{search_name}": #{matching_items.map{ |i| i['name']}} but no case insensitive full match. Please be more specific or give exact name.)
-        else raise "Two entities cannot have the same case insensitive name: #{name_matches.map{ |i| i['name']}}"
+        # (anyway AoC does not allow creation of 2 entities with same case insensitive field value)
+        value_matches = matching_items.select{ |i| i[field].casecmp?(value)}
+        case value_matches.length
+        when 1 then return value_matches.first
+        when 0 then raise %Q(#{entity}: Multiple case insensitive partial match for: "#{value}" in #{matching_items.map{ |i| i[field]}.join(', ')} but no case insensitive full match. Please be more specific or give exact #{field}.)
+        else raise "Two entities cannot have the same case insensitive #{field}: #{value_matches.map{ |i| i[field]}}"
         end
       end
     end
 
-    # Get a (full or partial) list of all entities of a given type with query: offset/limit
+    # Get a (full or partial) list of all entities of a given type.
+    # Using query: `offset` + `limit`
+    # And response `total_count`
     # @param entity    [String,Symbol] API endpoint of entity to list
     # @param items_key [String]        Key in the result to get the list of items (Default: same as `entity`)
     # @param query     [Hash,nil]      Additional query parameters
@@ -114,6 +120,7 @@ module Aspera
       return found.first if found.length.eql?(1)
       raise Cli::BadIdentifier.new(entity, value, field: field, count: found.length)
     end
+
     PER_PAGE_DEFAULT = 1000
     private_constant :PER_PAGE_DEFAULT
     module_function :lookup_entity_generic

data/lib/aspera/secret_hider.rb

@@ -21,6 +21,8 @@ module Aspera
     ALL_SECRETS = (ASCP_ENV_SECRETS + KEY_SECRETS + HTTP_SECRETS).freeze
     ALL_SECRETS2 = (KEY_SECRETS + HTTP_SECRETS).freeze
     KEY_FALSE_POSITIVES = [/^access_key$/, /^fallback_private_key$/].freeze
+    # min length of hidden secrets, use `+` or `{n,}`
+    SECRET_LENGTH = '{5,}'
     # regex that define named captures :begin and :end
     REGEX_LOG_REPLACES = [
       # private key values (place first)
@@ -32,7 +34,7 @@ module Aspera
       # rendered JSON or Ruby
       /(?<begin>(?:(?<quote>["'])|:)[^"':=]*(?:#{ALL_SECRETS.join('|')})[^"':=]*\k<quote>?(?:=>|:) *")[^"]+(?<end>")/,
       # logged data
-      /(?<begin>(?:#{ALL_SECRETS2.join('|')})[ =:]+).*(?<end>$)/,
+      /(?<begin>(?:#{ALL_SECRETS2.join('|')})[ =:]+)[^ "]#{SECRET_LENGTH}(?<end>$)/,
       # cred in http dump
       /(?<begin>(?:#{HTTP_SECRETS.join('|')}): )[^\\]+(?<end>\\)/i
     ].freeze

data/lib/aspera/uri_reader.rb

@@ -14,6 +14,22 @@ module Aspera
     SCHEME_FILE_PFX2 = "#{SCHEME_FILE_PFX1}///"
     private_constant :SCHEME_FILE, :SCHEME_FILE_PFX1, :SCHEME_FILE_PFX2
     class << self
+      # @return [Boolean] true if the URL is a file:// URL
+      def file?(url)
+        url.start_with?(SCHEME_FILE_PFX2)
+      end
+
+      # @return [String] a file:// URL for the given path
+      def file_url(path)
+        return "#{SCHEME_FILE_PFX2}#{path}"
+      end
+
+      # @return [String] the path of a file:// URL
+      def file_path(url)
+        Aspera.assert(file?(url)){"use format: #{file_url('<path>')}"}
+        File.expand_path(url[SCHEME_FILE_PFX2.length..-1])
+      end
+
       # Read some content from some URI, support file: , http: and https: schemes
       def read(uri_to_read)
         uri = URI.parse(uri_to_read)
@@ -41,8 +57,7 @@ module Aspera
         if url.start_with?(SCHEME_FILE_PFX1)
           # for file scheme, return directly the path
           # require specific file scheme: the path part is "relative", or absolute if there are 4 slash
-          raise "use format: #{SCHEME_FILE_PFX2}<path>" unless url.start_with?(SCHEME_FILE_PFX2)
-          return File.expand_path(url[SCHEME_FILE_PFX2.length..-1])
+          return file_path(url)
         elsif url.start_with?('data:')
           # download to temp file
           # auto-delete on exit

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.25.6
+  version: 4.26.0
 platform: ruby
 authors:
 - Laurent Martin
@@ -98,16 +98,16 @@ dependencies:
   name: jwt
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: marcel
   requirement: !ruby/object:Gem::Requirement