aspera-cli 4.15.0 → 4.16.0

data/lib/aspera/cli/plugins/aoc.rb

@@ -10,6 +10,7 @@ require 'aspera/aoc'
 require 'aspera/node'
 require 'aspera/persistency_action_once'
 require 'aspera/id_generator'
+require 'aspera/assert'
 require 'securerandom'
 require 'date'
 
@@ -118,7 +119,7 @@ module Aspera
             end
             myself = object.aoc_api.read('self')[:data]
             if auto_set_pub_key
-              raise Cli::Error, 'Public key is already set in profile (use --override=yes)' unless myself['public_key'].empty? || option_override
+              assert(myself['public_key'].empty?, exception_class: Cli::Error){'Public key is already set in profile (use --override=yes)'} unless option_override
               formatter.display_status('Updating profile with the public key.')
               aoc_api.update("users/#{myself['id']}", {'public_key' => pub_key_pem})
             end
@@ -165,7 +166,11 @@ module Aspera
           client_registration_token
           client_access_key
           kms_profile].freeze
-        PACKAGE_QUERY_DEFAULT = {'archived' => false, 'exclude_dropbox_packages' => true, 'has_content' => true, 'received' => true}.freeze
+        PACKAGE_RECEIVED_BASE_QUERY = {
+          'archived'    => false,
+          'has_content' => true,
+          'received'    => true,
+          'completed'   => true}.freeze
 
         def initialize(env)
           super(env)
@@ -209,7 +214,7 @@ module Aspera
         # @return identifier
         def get_resource_id_from_args(resource_class_path)
           return instance_identifier do |field, value|
-            raise Cli::BadArgument, 'only selection by name is supported' unless field.eql?('name')
+            assert(field.eql?('name'), exception_class: Cli::BadArgument){'only selection by name is supported'}
             aoc_api.lookup_by_name(resource_class_path, value)['id']
           end
         end
@@ -218,11 +223,11 @@ module Aspera
           return "#{resource_class_path}/#{get_resource_id_from_args(resource_class_path)}"
         end
 
-        # Call aoc_api.read with same parameters.
-        # Use paging if necessary to get all results
-        # @return [Hash] {list: , total: }
-        def read_with_paging(resource_class_path, base_query)
-          raise 'Query must be Hash' unless base_query.is_a?(Hash)
+        # Call block with same query using paging and response information
+        # @return [Hash] {data: , total: }
+        def api_call_paging(base_query={})
+          assert_type(base_query, Hash){'query'}
+          assert(block_given?)
           # set default large page if user does not specify own parameters. AoC Caps to 1000 anyway
           base_query['per_page'] = 1000 unless base_query.key?('per_page')
           max_items = base_query.delete(MAX_ITEMS)
@@ -235,7 +240,7 @@ module Aspera
           loop do
             query = base_query.clone
             query['page'] = current_page
-            result = aoc_api.read(resource_class_path, query)
+            result = yield(query)
             total_count = result[:http]['X-Total-Count']
             page_count += 1
             current_page += 1
@@ -247,7 +252,36 @@ module Aspera
             break if !max_pages.nil? && page_count >= max_pages
           end
           item_list = item_list[0..max_items - 1] if !max_items.nil? && item_list.count > max_items
-          return {list: item_list, total: total_count}
+          return {data: item_list, total: total_count}
+        end
+
+        # read using the query and paging
+        # @return [Hash] {data: , total: }
+        def api_read_all(resource_class_path, base_query={})
+          return api_call_paging(base_query) do |query|
+            aoc_api.read(resource_class_path, query)
+          end
+        end
+
+        # list all entities, given additional, default and user's queries
+        def result_list(resource_class_path, fields: nil, base_query: {}, default_query: {})
+          assert_type(base_query, Hash)
+          assert_type(default_query, Hash)
+          user_query = query_read_delete(default: default_query)
+          # caller may add specific modifications or checks
+          yield(user_query) if block_given?
+          return {type: :object_list, fields: fields}.merge(api_read_all(resource_class_path, base_query.merge(user_query)))
+        end
+
+        def resolve_dropbox_name_default_ws_id(query)
+          if query.key?('dropbox_name')
+            # convenience: specify name instead of id
+            raise 'not both dropbox_name and dropbox_id' if query.key?('dropbox_id')
+            query['dropbox_id'] = aoc_api.lookup_by_name('dropboxes', query['dropbox_name'])['id']
+            query.delete('dropbox_name')
+          end
+          query['workspace_id'] ||= aoc_api.context[:workspace_id] unless aoc_api.context[:workspace_id].eql?(:undefined)
+          query['exclude_dropbox_packages'] = true unless query.key?('dropbox_id')
         end
 
         NODE4_EXT_COMMANDS = %i[transfer].concat(Node::COMMANDS_GEN4).freeze
@@ -282,7 +316,7 @@ module Aspera
               client_direction = Fasp::TransferSpec::DIRECTION_RECEIVE
               client_folder = transfer.destination_folder(client_direction)
               server_folder = source_folder
-            else raise 'internal error'
+            else error_unreachable_line
             end
             client_apfid = top_node_api.resolve_api_fid(file_id, client_folder)
             server_apfid = top_node_api.resolve_api_fid(file_id, server_folder)
@@ -303,9 +337,9 @@ module Aspera
               server_apfid[:file_id],
               client_direction,
               add_ts)))
-          else raise "INTERNAL ERROR: Missing case: #{command_repo}"
+          else error_unreachable_line
           end # command_repo
-          # raise 'internal error:shall not reach here'
+          error_unreachable_line
         end # execute_nodegen4_command
 
         def execute_admin_action
@@ -317,8 +351,7 @@ module Aspera
             command_auth_prov = options.get_next_command(%i[list update])
             case command_auth_prov
             when :list
-              providers = aoc_api.read('admin/auth_providers')[:data]
-              return {type: :object_list, data: providers}
+              return result_list('admin/auth_providers')
             when :update
               raise 'not implemented'
             end
@@ -402,7 +435,7 @@ module Aspera
                 when :organizations then aoc_api.current_user_info['organization_id']
                 when :users then aoc_api.current_user_info['id']
                 when :nodes then aoc_api.current_user_info['id'] # TODO: consistent ? # rubocop:disable Lint/DuplicateBranch
-                else raise 'Internal error'
+                else error_unreachable_line
                 end
               filter = options.get_option(:query) || {}
               filter['limit'] ||= 100
@@ -411,9 +444,13 @@ module Aspera
                 start_date_persistency = PersistencyActionOnce.new(
                   manager: @agents[:persistency],
                   data: saved_date,
-                  ids: IdGenerator.from_list(['aoc_ana_date', options.get_option(:url, mandatory: true), aoc_api.context[:workspace_name]].push(
+                  id: IdGenerator.from_list([
+                    'aoc_ana_date',
+                    options.get_option(:url, mandatory: true),
+                    aoc_api.context(:files)[:workspace_name],
                     filter_resource.to_s,
-                    filter_id)))
+                    filter_id
+                  ]))
                 start_date_time = saved_date.first
                 stop_date_time = Time.now.utc.strftime('%FT%T.%LZ')
                 # Log.log().error("start: #{start_date_time}")
@@ -484,9 +521,7 @@ module Aspera
               when :group_membership then default_fields.push(*%w[group_id member_type member_id])
               when :workspace_membership then default_fields.push(*%w[workspace_id member_type member_id])
               end
-              items = read_with_paging(resource_class_path, query_read_delete(default: default_query))
-              formatter.display_item_count(items[:list].length, items[:total])
-              return {type: :object_list, data: items[:list], fields: default_fields}
+              return result_list(resource_class_path, fields: default_fields, default_query: default_query)
             when :show
               object = aoc_api.read(resource_instance_path)[:data]
               # default: show all, but certificate
@@ -511,12 +546,13 @@ module Aspera
               return Main.result_success
             when :do
               command_repo = options.get_next_command(NODE4_EXT_COMMANDS)
-              aoc_api.context(:none)
+              # init context
+              aoc_api.context(:files)
               return execute_nodegen4_command(command_repo, res_id)
-            else raise 'unknown command'
+            else error_unexpected_value(command)
             end
           when :usage_reports
-            return {type: :object_list, data: aoc_api.read('usage_reports', {workspace_id: aoc_api.context(:none)[:workspace_id]})[:data]}
+            return result_list('usage_reports', base_query: {workspace_id: aoc_api.context(:files)[:workspace_id]})
           end
         end
 
@@ -549,15 +585,15 @@ module Aspera
           when :tier_restrictions
             return { type: :single_object, data: aoc_api.read('tier_restrictions')[:data] }
           when :user
-            case options.get_next_command(%i[workspaces profile])
+            case options.get_next_command(%i[workspaces profile preferences])
             # when :settings
             # return {type: :object_list,data: aoc_api.read('client_settings/')[:data]}
             when :workspaces
               case options.get_next_command(%i[list current])
               when :list
-                return {type: :object_list, data: aoc_api.read('workspaces')[:data], fields: %w[id name]}
+                return result_list('workspaces', fields: %w[id name])
               when :current
-                return { type: :single_object, data: aoc_api.read("workspaces/#{aoc_api.context(:none)[:workspace_id]}")[:data] }
+                return { type: :single_object, data: aoc_api.read("workspaces/#{aoc_api.context(:files)[:workspace_id]}")[:data] }
               end
             when :profile
               case options.get_next_command(%i[show modify])
@@ -567,19 +603,25 @@ module Aspera
                 aoc_api.update("users/#{aoc_api.current_user_info(exception: true)['id']}", options.get_next_argument('properties', type: Hash))
                 return Main.result_status('modified')
               end
+            when :preferences
+              user_preferences_res = "users/#{aoc_api.current_user_info(exception: true)['id']}/user_interaction_preferences"
+              case options.get_next_command(%i[show modify])
+              when :show
+                return { type: :single_object, data: aoc_api.read(user_preferences_res)[:data] }
+              when :modify
+                aoc_api.update(user_preferences_res, options.get_next_argument('properties', type: Hash))
+                return Main.result_status('modified')
+              end
             end
           when :packages
-            package_command = options.get_next_command(%i[shared_inboxes send recv list show delete].concat(Node::NODE4_READ_ACTIONS))
+            package_command = options.get_next_command(%i[shared_inboxes send receive list show delete].concat(Node::NODE4_READ_ACTIONS), aliases: {recv: :receive})
             case package_command
             when :shared_inboxes
               case options.get_next_command(%i[list show])
               when :list
-                query = query_read_delete
-                if query.nil?
-                  query = {'embed[]' => 'dropbox', 'aggregate_permissions_by_dropbox' => true, 'sort' => 'dropbox_name'}
-                  query['workspace_id'] = aoc_api.context[:workspace_id] unless aoc_api.context[:workspace_id].eql?(:undefined)
-                end
-                return {type: :object_list, data: aoc_api.read('dropbox_memberships', query)[:data], fields: ['dropbox_id', 'dropbox.name']}
+                default_query = {'embed[]' => 'dropbox', 'aggregate_permissions_by_dropbox' => true, 'sort' => 'dropbox_name'}
+                default_query['workspace_id'] = aoc_api.context[:workspace_id] unless aoc_api.context[:workspace_id].eql?(:undefined)
+                return result_list('dropbox_memberships', fields: %w[dropbox_id dropbox.name], default_query: default_query)
               when :show
                 return {type: :single_object, data: aoc_api.read(get_resource_path_from_args('dropboxes'), query)[:data]}
               end
@@ -603,7 +645,7 @@ module Aspera
               Main.result_transfer(transfer.start(created_package[:spec], rest_token: created_package[:node]))
               # return all info on package (especially package id)
               return { type: :single_object, data: created_package[:info]}
-            when :recv
+            when :receive
               ids_to_download = nil
               if !aoc_api.public_link.nil?
                 aoc_api.assert_public_link_types(['view_received_package'])
@@ -615,6 +657,7 @@ module Aspera
               skip_ids_data = []
               skip_ids_persistency = nil
               if options.get_option(:once_only, mandatory: true)
+                # TODO: add query info to id
                 skip_ids_persistency = PersistencyActionOnce.new(
                   manager: @agents[:persistency],
                   data: skip_ids_data,
@@ -624,25 +667,25 @@ module Aspera
                      aoc_api.context[:workspace_id]
                     ].concat(aoc_api.additional_persistence_ids)))
               end
-              if ExtendedValue::ALL.eql?(ids_to_download)
-                query = query_read_delete(default: PACKAGE_QUERY_DEFAULT)
-                raise 'option query must be Hash' unless query.is_a?(Hash)
-                if query.key?('dropbox_name')
-                  # convenience: specify name instead of id
-                  raise 'not both dropbox_name and dropbox_id' if query.key?('dropbox_id')
-                  query['dropbox_id'] = aoc_api.lookup_by_name('dropboxes', query['dropbox_name'])['id']
-                  query.delete('dropbox_name')
-                end
-                query['workspace_id'] ||= aoc_api.context[:workspace_id] unless aoc_api.context[:workspace_id].eql?(:undefined)
-                # get list of packages in inbox
-                package_info = aoc_api.read('packages', query)[:data]
+              case ids_to_download
+              when ExtendedValue::ALL, ExtendedValue::INIT
+                query = query_read_delete(default: PACKAGE_RECEIVED_BASE_QUERY)
+                assert_type(query, Hash){'query'}
+                resolve_dropbox_name_default_ws_id(query)
                 # remove from list the ones already downloaded
-                ids_to_download = package_info.map{|e|e['id']}
+                all_ids = api_read_all('packages', query)[:data].map{|e|e['id']}
+                if ids_to_download.eql?(ExtendedValue::INIT)
+                  assert(skip_ids_persistency){'Only with option once_only'}
+                  skip_ids_persistency.data.clear.concat(all_ids)
+                  skip_ids_persistency.save
+                  return Main.result_status("Initialized skip for #{skip_ids_persistency.data.count} package(s)")
+                end
                 # array here
-                ids_to_download.reject!{|id|skip_ids_data.include?(id)}
+                ids_to_download = all_ids.reject{|id|skip_ids_data.include?(id)}
+              else
+                ids_to_download = [ids_to_download] unless ids_to_download.is_a?(Array)
               end # ExtendedValue::ALL
               # list here
-              ids_to_download = [ids_to_download] unless ids_to_download.is_a?(Array)
               result_transfer = []
               formatter.display_status("found #{ids_to_download.length} package(s).")
               ids_to_download.each do |package_id|
@@ -673,24 +716,13 @@ module Aspera
               return { type: :single_object, data: package_info }
             when :list
               display_fields = %w[id name bytes_transferred]
-              query = query_read_delete(default: PACKAGE_QUERY_DEFAULT)
-              raise 'option query must be Hash' unless query.is_a?(Hash)
-              if query.key?('dropbox_name')
-                # convenience: specify name instead of id
-                raise 'not both dropbox_name and dropbox_id' if query.key?('dropbox_id')
-                query['dropbox_id'] = aoc_api.lookup_by_name('dropboxes', query['dropbox_name'])['id']
-                query.delete('dropbox_name')
-              end
-              if aoc_api.context[:workspace_id].eql?(:undefined)
-                display_fields.push('workspace_id')
-              else
-                query['workspace_id'] ||= aoc_api.context[:workspace_id]
-              end
-              packages = aoc_api.read('packages', query)[:data]
-              return {type: :object_list, data: packages, fields: display_fields}
+              display_fields.push('workspace_id') if aoc_api.context[:workspace_id].eql?(:undefined)
+              return result_list('packages', fields: display_fields, base_query: PACKAGE_RECEIVED_BASE_QUERY) do |query|
+                       resolve_dropbox_name_default_ws_id(query)
+                     end
             when :delete
               return do_bulk_operation(command: package_command, descr: 'identifier', values: identifier) do |id|
-                raise 'expecting String identifier' unless id.is_a?(String) || id.is_a?(Integer)
+                assert_values(id.class, [String, Integer]){'identifier'}
                 aoc_api.delete("packages/#{id}")[:data]
               end
             when *Node::NODE4_READ_ACTIONS
@@ -720,7 +752,7 @@ module Aspera
               purpose = case link_type
               when :public  then 'token_auth_redirection'
               when :private then 'shared_folder_auth_link'
-              else raise 'internal error'
+              else error_unreachable_line
               end
               case short_link_command
               when :delete
@@ -754,8 +786,7 @@ module Aspera
                   # embed: 'updated_by_user',
                   sort:        '-created_at'
                 }
-                result = aoc_api.read('short_links', list_params)[:data]
-                return {type: :object_list, data: result, fields: Formatter.all_but('data')}
+                return result_list('short_links', fields: Formatter.all_but('data'), base_query: list_params)
               when :create
                 creation_params = {
                   purpose:            purpose,
@@ -846,17 +877,16 @@ module Aspera
             url = value_create_modify(command: command, type: String)
             uri = URI.parse(url)
             server = WebServerSimple.new(uri)
-            server.mount(uri.path, Faspex4GWServlet, aoc_api, aoc_api.context(:none)[:workspace_id])
+            server.mount(uri.path, Faspex4GWServlet, aoc_api, aoc_api.context(:files)[:workspace_id])
             trap('INT') { server.shutdown }
             formatter.display_status("Faspex 4 gateway listening on #{url}")
             Log.log.info("Listening on #{url}")
             # this is blocking until server exits
             server.start
             return Main.result_status('Gateway terminated')
-          else
-            raise "internal error: #{command}"
+          else error_unreachable_line
           end # action
-          raise 'internal error: command shall return'
+          error_unreachable_line
         end
 
         private :execute_admin_action

data/lib/aspera/cli/plugins/ats.rb

@@ -4,6 +4,7 @@
 
 require 'aspera/cli/plugins/node'
 require 'aspera/ats_api'
+require 'aspera/assert'
 
 module Aspera
   module Cli
@@ -128,7 +129,7 @@ module Aspera
               }}
             api_ak_auth = Rest.new(rest_params)
             return {type: :single_object, data: api_ak_auth.read('servers')[:data]}
-          else raise 'INTERNAL ERROR'
+          else error_unreachable_line
           end
         end
 
@@ -200,7 +201,7 @@ module Aspera
           when :delete
             ats_ibm_api.delete("api_keys/#{concerned_id}")
             return Main.result_status("deleted #{concerned_id}")
-          else raise 'INTERNAL ERROR'
+          else error_unreachable_line
           end
         end
 
@@ -224,7 +225,7 @@ module Aspera
           when :aws_trust_policy
             res = ats_api_pub_v1.read('aws/trustpolicy', {region: options.get_option(:region, mandatory: true)})[:data]
             return {type: :single_object, data: res}
-          else raise 'ERROR'
+          else error_unexpected_value(command)
           end
         end