aspera-cli 4.25.5 → 4.26.0

data/lib/aspera/api/aoc.rb

@@ -12,12 +12,52 @@ require 'base64'
 
 module Aspera
   module Api
+    # information relative to Files or Packages App
+
     # Aspera on Cloud API client
     class AoC < Rest
       include RestList
 
+      module AppType
+        FILES = 'files'
+        PACKAGES = 'packages'
+      end
+
+      class AppInfo
+        # @return [Aspera::Api::AoC] Rest Api object
+        attr_reader  :api
+        # @return [Hash, nil] Package information, `"files"` or `"packages"`
+        attr_reader  :package
+        # @return [Hash] Result of GET /nodes/:id
+        attr_reader  :node_info
+        # @return [String] Workspace id
+        attr_reader  :workspace_id
+        # @return [String] Workspace name
+        attr_reader  :workspace_name
+        # @return [String, nil] "Share as" link name
+        attr_accessor :opt_link_name
+
+        # @param api [Api::Aoc] Rest Api object
+        # @param package [Hash,nil] package information or nil
+        # @param node_info [Hash] Result of GET /nodes/:id
+        # @param workspace_id [String]
+        # @param workspace_name [String]
+        def initialize(api, package, node_info, workspace_id, workspace_name)
+          @api = api
+          @package = package
+          @node_info = node_info
+          @workspace_id = workspace_id
+          @workspace_name = workspace_name
+          @opt_link_name = nil
+        end
+
+        # @return ["files", "packages"] Type of application
+        def app
+          package.nil? ? AppType::FILES : AppType::PACKAGES
+        end
+      end
       PRODUCT_NAME = 'Aspera on Cloud'
-      # use default workspace if it is set, else none
+      # `''` Use default workspace if it is set, else none
       DEFAULT_WORKSPACE = ''
       # Production domain of AoC
       SAAS_DOMAIN_PROD = 'ibmaspera.com' # cspell:disable-line
@@ -39,6 +79,7 @@ module Aspera
       PERMISSIONS_CREATED = ['permission.created'].freeze
       # Special user identifier when creating workspace shared folders
       ID_AK_ADMIN = 'ASPERA_ACCESS_KEY_ADMIN'
+      HEADER_X_TOTAL_COUNT = 'X-Total-Count'
 
       private_constant :MAX_AOC_URL_REDIRECT,
         :CLIENT_ID_PREFIX,
@@ -49,18 +90,19 @@ module Aspera
         :OAUTH_API_SUBPATH,
         :USER_INFO_FIELDS_MIN,
         :PERMISSIONS_CREATED,
-        :ID_AK_ADMIN
+        :ID_AK_ADMIN,
+        :HEADER_X_TOTAL_COUNT
 
       # Various API scopes supported
       module Scope
         SELF = 'self'
+        # Scope `user:all`
         USER = 'user:all'
+        # Scope `admin:all`
         ADMIN = 'admin:all'
         ADMIN_USER = 'admin-user:all'
         ADMIN_USER_USER = "#{ADMIN_USER}+#{USER}"
       end
-      FILES_APP = 'files'
-      PACKAGES_APP = 'packages'
       API_V1 = 'api/v1'
 
       # class static methods
@@ -92,8 +134,9 @@ module Aspera
           false
         end
 
+        # Get information from link
         # @param url [String] URL of AoC public link
-        # @return [Hash] information about public link, or nil if not a public link
+        # @return [Hash{Symbol => String, Hash}] Information about public link, or nil if not a public link
         def link_info(url)
           final_uri = Rest.new(base_url: url, redirect_max: MAX_AOC_URL_REDIRECT).call(operation: 'GET', ret: :resp).uri
           Log.dump(:final_uri, final_uri, level: :trace1)
@@ -169,7 +212,7 @@ module Aspera
             new_query['page'] = current_page
             result_data, result_http = yield(new_query)
             Aspera.assert(result_http)
-            total_count = result_http['X-Total-Count']&.to_i
+            total_count = result_http[HEADER_X_TOTAL_COUNT]&.to_i
             page_count += 1
             current_page += 1
             add_items = result_data
@@ -221,21 +264,23 @@ module Aspera
       end
 
       attr_reader :private_link
+      attr_accessor :ws_ids
 
+      # By default: no workspace
       def initialize(
+        scope: nil,
+        subpath: API_V1,
+        secret_finder: nil,
+        # below: OAuth::AUTH_OPTIONS
         url:,
         auth:,
-        subpath: API_V1,
         client_id: nil,
         client_secret: nil,
-        scope: nil,
         redirect_uri: nil,
         private_key: nil,
         passphrase: nil,
         username: nil,
-        password: nil,
-        workspace: nil,
-        secret_finder: nil
+        password: nil
       )
         # Test here because link may set url
         Aspera.assert(url, 'Missing mandatory option: url', type: ParameterError)
@@ -246,10 +291,12 @@ module Aspera
         # key: access key
         # value: associated secret
         @secret_finder = secret_finder
-        @workspace_name = workspace
         @cache_user_info = nil
         @cache_url_token_info = nil
+        # @type [Hash]
         @workspace_info = nil
+        # Used only for init: provided by user
+        @ws_ids = {id: nil, name: nil}
         @home_info = nil
         auth_params = {
           type:   :oauth2,
@@ -350,34 +397,38 @@ module Aspera
         return @cache_user_info
       end
 
-      # Cached workspace information
-      def workspace
+      def default_workspace?
+        @ws_ids[:name].eql?(DEFAULT_WORKSPACE)
+      end
+
+      # Cached workspace information.
+      # Always with `:name`.
+      # If no workspace, then no `:id`
+      # @return [Hash{Symbol=>String}] Workspace info.
+      def workspace_info
         return @workspace_info unless @workspace_info.nil?
-        ws_id =
-          if !public_link.nil?
-            Log.log.debug('Using workspace of public link')
-            public_link['data']['workspace_id']
-          elsif !private_link.nil?
-            Log.log.debug('Using workspace of private link')
-            private_link[:workspace_id]
-          elsif @workspace_name.eql?(DEFAULT_WORKSPACE)
-            if !current_user_info['default_workspace_id'].nil?
-              Log.log.debug('Using default workspace'.green)
-              current_user_info['default_workspace_id']
-            end
-          elsif @workspace_name.nil?
-            nil
+        if !public_link.nil?
+          Log.log.debug('Using workspace of public link')
+          @ws_ids[:id] = public_link['data']['workspace_id']
+        elsif !private_link.nil?
+          Log.log.debug('Using workspace of private link')
+          @ws_ids[:id] = private_link[:workspace_id]
+        elsif @ws_ids[:id]
+          Log.log.debug("Using workspace id: #{@ws_ids[:id]}")
+        elsif default_workspace?
+          if current_user_info['default_workspace_id'].nil?
+            @ws_ids[:name] = nil
+            Log.log.warn('No default workspace')
           else
-            lookup_by_name('workspaces', @workspace_name)['id']
-          end
-        @workspace_info =
-          if ws_id.nil?
-            {
-              name: 'Shared (no workspace)'
-            }
-          else
-            read("workspaces/#{ws_id}").slice('id', 'name', 'home_node_id', 'home_file_id').symbolize_keys
+            Log.log.debug('Using default workspace'.green)
+            @ws_ids[:id] = current_user_info['default_workspace_id']
           end
+        elsif !@ws_ids[:name].nil?
+          @workspace_info = lookup_with_q('workspaces', value: @ws_ids[:name])
+        end
+        @workspace_info = read("workspaces/#{@ws_ids[:id]}") unless @ws_ids[:id].nil?
+        @workspace_info ||= {name: 'Shared (no workspace)'}
+        @workspace_info = @workspace_info.slice('name', 'id', 'home_node_id', 'home_file_id').symbolize_keys
         Log.dump(:workspace_info, @workspace_info)
         @workspace_info
       end
@@ -397,10 +448,10 @@ module Aspera
               node_id: private_link[:node_id],
               file_id: private_link[:file_id]
             }
-          elsif workspace[:home_node_id] && workspace[:home_file_id]
+          elsif workspace_info[:home_node_id] && workspace_info[:home_file_id]
             {
-              node_id: workspace[:home_node_id],
-              file_id: workspace[:home_file_id]
+              node_id: workspace_info[:home_node_id],
+              file_id: workspace_info[:home_file_id]
             }
           else
             # not part of any workspace, but has some folder shared
@@ -426,18 +477,7 @@ module Aspera
         Aspera.assert_type(node_id, String)
         node_info = read("nodes/#{node_id}")
         workspace_name = read("workspaces/#{workspace_id}")['name'] if workspace_name.nil? && !workspace_id.nil?
-        app_info = {
-          api:            self, # for callback
-          app:            package_info.nil? ? FILES_APP : PACKAGES_APP,
-          node_info:      node_info,
-          workspace_id:   workspace_id,
-          workspace_name: workspace_name
-        }
-        if PACKAGES_APP.eql?(app_info[:app])
-          Aspera.assert(!package_info.nil?){'package info required'}
-          app_info[:package_id] = package_info['id']
-          app_info[:package_name] = package_info['name']
-        end
+        app_info = AppInfo.new(self, package_info, node_info, workspace_id, workspace_name)
         node_params = {base_url: node_info['url']}
         ak_secret = @secret_finder&.lookup_secret(url: node_info['url'], username: node_info['access_key'])
         # If secret is available, or no scope, use basic auth
@@ -514,7 +554,7 @@ module Aspera
             # email: user, else dropbox
             entity_type = short_recipient_info.include?('@') ? 'contacts' : 'dropboxes'
             begin
-              full_recipient_info = lookup_by_name(entity_type, short_recipient_info, query: {'workspace_id' => ws_id})
+              full_recipient_info = lookup_with_q(entity_type, value: short_recipient_info, query: {'workspace_id' => ws_id})
             rescue EntityNotFound
               # dropboxes cannot be created on the fly
               Aspera.assert_values(entity_type, 'contacts', type: Error){"No such shared inbox in workspace #{ws_id}"}
@@ -609,13 +649,13 @@ module Aspera
         transfer_spec.deep_merge!({
           'tags' => {
             Transfer::Spec::TAG_RESERVED => {
-              'app'      => app_info[:app],
-              'usage_id' => "aspera.files.workspace.#{app_info[:workspace_id]}", # activity tracking
+              'app'      => app_info.app,
+              'usage_id' => "aspera.files.workspace.#{app_info.workspace_id}", # activity tracking
               'files'    => {
-                'node_id'               => app_info[:node_info]['id'],
-                'files_transfer_action' => "#{transfer_type}_#{app_info[:app].gsub(/s$/, '')}",
-                'workspace_name'        => app_info[:workspace_name], # activity tracking
-                'workspace_id'          => app_info[:workspace_id]
+                'node_id'               => app_info.node_info['id'],
+                'files_transfer_action' => "#{transfer_type}_#{app_info.app.gsub(/s$/, '')}",
+                'workspace_name'        => app_info.workspace_name, # activity tracking
+                'workspace_id'          => app_info.workspace_id
               }
             }
           }
@@ -623,30 +663,30 @@ module Aspera
         # Console cookie
         ################
         # we are sure that fields are not nil
-        cookie_elements = [app_info[:app], current_user_info['name'] || 'public link', current_user_info['email'] || 'none'].map{ |e| Base64.strict_encode64(e)}
+        cookie_elements = [app_info.app, current_user_info['name'] || 'public link', current_user_info['email'] || 'none'].map{ |e| Base64.strict_encode64(e)}
         cookie_elements.unshift(COOKIE_PREFIX_CONSOLE_AOC)
         transfer_spec['cookie'] = cookie_elements.join(':')
         # Application tags
         ##################
-        case app_info[:app]
-        when FILES_APP
+        case app_info.app
+        when AppType::FILES
           file_id = transfer_spec['tags'][Transfer::Spec::TAG_RESERVED]['node']['file_id']
           transfer_spec.deep_merge!({
             'tags' => {
               Transfer::Spec::TAG_RESERVED => {
                 'files' => {
-                  'parentCwd' => "#{app_info[:node_info]['id']}:#{file_id}"
+                  'parentCwd' => "#{app_info.node_info['id']}:#{file_id}"
                 }
               }
             }
           }) unless transfer_spec.key?('remote_access_key')
-        when PACKAGES_APP
+        when AppType::PACKAGES
           transfer_spec.deep_merge!({
             'tags' => {
               Transfer::Spec::TAG_RESERVED => {
                 'files' => {
-                  'package_id'        => app_info[:package_id],
-                  'package_name'      => app_info[:package_name],
+                  'package_id'        => app_info.package['id'],
+                  'package_name'      => app_info.package['name'],
                   'package_operation' => transfer_type
                 }
               }
@@ -658,21 +698,21 @@ module Aspera
       # Callback from Plugins::Node
       # add application specific tags to permissions creation
       # @param perm_data [Hash] parameters for creating permissions
-      # @param app_info [Hash] application information
+      # @param app_info [AppInfo] application information
       def permissions_set_create_params(perm_data:, app_info:)
         defaults = {
           'tags' => {
             Transfer::Spec::TAG_RESERVED => {
               'files' => {
                 'workspace' => {
-                  'id'                => app_info[:workspace_id],
-                  'workspace_name'    => app_info[:workspace_name],
+                  'id'                => app_info.workspace_id,
+                  'workspace_name'    => app_info.workspace_name,
                   'user_name'         => current_user_info['name'],
                   'shared_by_user_id' => current_user_info['id'],
                   'shared_by_name'    => current_user_info['name'],
                   'shared_by_email'   => current_user_info['email'],
-                  'access_key'        => app_info[:node_info]['access_key'],
-                  'node'              => app_info[:node_info]['name']
+                  'access_key'        => app_info.node_info['access_key'],
+                  'node'              => app_info.node_info['name']
                 }
               }
             }
@@ -685,10 +725,10 @@ module Aspera
         when NilClass
         when ''
           # workspace shared folder
-          perm_data.merge!(self.class.workspace_access(app_info[:workspace_id]))
+          perm_data.merge!(self.class.workspace_access(app_info.workspace_id))
           tag_workspace['shared_with_name'] = perm_data['access_id']
         else
-          entity_info = lookup_by_name('contacts', shared_with, query: {'current_workspace_id' => app_info[:workspace_id]})
+          entity_info = lookup_with_q('contacts', value: shared_with, query: {'current_workspace_id' => app_info.workspace_id})
           perm_data['access_type'] = entity_info['source_type']
           perm_data['access_id'] = entity_info['source_id']
           tag_workspace['shared_with_name'] = entity_info['email'] # TODO: check that ???
@@ -698,26 +738,26 @@ module Aspera
           perm_data.delete('as')
         end
         # optional
-        app_info[:opt_link_name] = perm_data.delete('link_name')
+        app_info.opt_link_name = perm_data.delete('link_name')
       end
 
       # Callback from Plugins::Node
       # send shared folder event to AoC
       # @param event_data [Hash] response from permission creation
-      # @param app_info [Hash] hash with app info
+      # @param app_info [AppInfo] hash with app info
       # @param types [Array] event types
       def permissions_send_event(event_data:, app_info:, types: PERMISSIONS_CREATED)
         Aspera.assert_type(types, Array)
         Aspera.assert(!types.empty?)
         event_creation = {
           'types'        => types,
-          'node_id'      => app_info[:node_info]['id'],
-          'workspace_id' => app_info[:workspace_id],
+          'node_id'      => app_info.node_info['id'],
+          'workspace_id' => app_info.workspace_id,
           'data'         => event_data
         }
         # (optional). The name of the folder to be displayed to the destination user.
         # Use it if its value is different from the "share_as" field.
-        event_creation['link_name'] = app_info[:opt_link_name] unless app_info[:opt_link_name].nil?
+        event_creation['link_name'] = app_info.opt_link_name unless app_info.opt_link_name.nil?
         create('events', event_creation, query: {admin: true})
       end
     end