aspera-cli 4.15.0 → 4.17.0

data/lib/aspera/aoc.rb

@@ -1,606 +0,0 @@
-# frozen_string_literal: true
-
-require 'aspera/log'
-require 'aspera/rest'
-require 'aspera/hash_ext'
-require 'aspera/data_repository'
-require 'aspera/fasp/transfer_spec'
-require 'aspera/node'
-require 'base64'
-require 'cgi'
-
-Aspera::Oauth.register_token_creator(
-  :aoc_pub_link,
-  lambda{|o|
-    o.api.call({
-      operation:   'POST',
-      subpath:     o.generic_parameters[:path_token],
-      headers:     {'Accept' => 'application/json'},
-      json_params: o.specific_parameters[:json],
-      url_params:  o.specific_parameters[:url].merge(scope: o.generic_parameters[:scope]) # scope is here because it changes over time (node)
-    })
-  },
-  lambda { |oauth|
-    return [oauth.specific_parameters.dig(:json, :url_token)]
-  })
-
-module Aspera
-  class AoC < Aspera::Rest
-    PRODUCT_NAME = 'Aspera on Cloud'
-    # Production domain of AoC
-    PROD_DOMAIN = 'ibmaspera.com' # cspell:disable-line
-    # to avoid infinite loop in pub link redirection
-    MAX_AOC_URL_REDIRECT = 10
-    # Well-known AoC globals client apps
-    GLOBAL_CLIENT_APPS = %w[aspera.global-cli-client aspera.drive].freeze
-    # index offset in data repository of client app
-    DATA_REPO_INDEX_START = 4
-    # cookie prefix so that console can decode identity
-    COOKIE_PREFIX_CONSOLE_AOC = 'aspera.aoc'
-    # path in URL of public links
-    PUBLIC_LINK_PATHS = %w[/packages/public/receive /packages/public/send /files/public /public/files /public/send].freeze
-    JWT_AUDIENCE = 'https://api.asperafiles.com/api/v1/oauth2/token'
-    OAUTH_API_SUBPATH = 'api/v1/oauth2'
-    # minimum fields for user info if retrieval fails
-    USER_INFO_FIELDS_MIN = %w[name email id default_workspace_id organization_id].freeze
-    # types of events for shared folder creation
-    # Node events: permission.created permission.modified permission.deleted
-    PERMISSIONS_CREATED = ['permission.created'].freeze
-    DEFAULT_WORKSPACE = ''
-
-    private_constant :MAX_AOC_URL_REDIRECT,
-      :GLOBAL_CLIENT_APPS,
-      :DATA_REPO_INDEX_START,
-      :COOKIE_PREFIX_CONSOLE_AOC,
-      :PUBLIC_LINK_PATHS,
-      :JWT_AUDIENCE,
-      :OAUTH_API_SUBPATH,
-      :USER_INFO_FIELDS_MIN,
-      :PERMISSIONS_CREATED
-
-    # various API scopes supported
-    SCOPE_FILES_SELF = 'self'
-    SCOPE_FILES_USER = 'user:all'
-    SCOPE_FILES_ADMIN = 'admin:all'
-    SCOPE_FILES_ADMIN_USER = 'admin-user:all'
-    SCOPE_FILES_ADMIN_USER_USER = "#{SCOPE_FILES_ADMIN_USER}+#{SCOPE_FILES_USER}"
-    FILES_APP = 'files'
-    PACKAGES_APP = 'packages'
-    API_V1 = 'api/v1'
-
-    # class static methods
-    class << self
-      # strings /Applications/Aspera\ Drive.app/Contents/MacOS/AsperaDrive|grep -E '.{100}==$'|base64 --decode
-      def get_client_info(client_name=GLOBAL_CLIENT_APPS.first)
-        client_index = GLOBAL_CLIENT_APPS.index(client_name)
-        raise "no such pre-defined client: #{client_name}" if client_index.nil?
-        return client_name, Base64.urlsafe_encode64(DataRepository.instance.data(DATA_REPO_INDEX_START + client_index))
-      end
-
-      # base API url depends on domain, which could be "qa.xxx"
-      def api_base_url(organization: 'api', api_domain: PROD_DOMAIN)
-        return "https://#{organization}.#{api_domain}"
-      end
-
-      def metering_api(entitlement_id, customer_id, api_domain=PROD_DOMAIN)
-        return Rest.new({
-          base_url: "#{api_base_url(api_domain: api_domain)}/metering/v1",
-          headers:  {'X-Aspera-Entitlement-Authorization' => Rest.basic_token(entitlement_id, customer_id)}
-        })
-      end
-
-      # split host of http://myorg.asperafiles.com in org and domain
-      def url_parts(uri)
-        raise "No host found in URL.Please check URL format: https://myorg.#{PROD_DOMAIN}" if uri.host.nil?
-        parts = uri.host.split('.', 2)
-        raise "expecting a public FQDN for #{PRODUCT_NAME}" unless parts.length == 2
-        return parts
-      end
-
-      # @param url [String] URL of AoC public link
-      # @return [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}).read('')[:http].uri
-        raise 'AoC shall redirect to login page' if final_uri.query.nil?
-        decoded_query = Rest.decode_query(final_uri.query)
-        # is that a public link ?
-        if decoded_query.key?('token')
-          Log.log.warn{"Unknown pub link path: #{final_uri.path}"} unless PUBLIC_LINK_PATHS.include?(final_uri.path)
-          # ok we get it !
-          return {
-            instance_domain: url_parts(final_uri)[1],
-            url:             'https://' + final_uri.host,
-            token:           decoded_query['token']
-          }
-        end
-        Log.log.debug{"path=#{final_uri.path} does not end with /login"} unless final_uri.path.end_with?('/login')
-        if decoded_query['state']
-          # can be a private link
-          state_uri = URI.parse(decoded_query['state'])
-          if state_uri.query && decoded_query['redirect_uri']
-            decoded_state = Rest.decode_query(state_uri.query)
-            if decoded_state.key?('short_link_url')
-              if (m = state_uri.path.match(%r{/files/workspaces/([0-9]+)/all/([0-9]+):([0-9]+)}))
-                redirect_uri = URI.parse(decoded_query['redirect_uri'])
-                parts = url_parts(redirect_uri)
-                return {
-                  instance_domain: parts[1],
-                  organization:    parts[0],
-                  url:             'https://' + redirect_uri.host,
-                  private_link:    {
-                    workspace_id: m[1],
-                    node_id:      m[2],
-                    file_id:      m[3]
-                  }
-                }
-              end
-            end
-          end
-        end
-        parts = url_parts(URI.parse(url))
-        return {
-          instance_domain: parts[1],
-          organization:    parts[0]
-        }
-      end
-    end # static methods
-
-    attr_reader :private_link
-
-    def initialize(subpath: API_V1, url:, auth:, 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)
-      # test here because link may set url
-      raise ArgumentError, 'Missing mandatory option: url' if url.nil?
-      raise ArgumentError, 'Missing mandatory option: scope' if scope.nil?
-      # default values for client id
-      client_id, client_secret = self.class.get_client_info if client_id.nil?
-      # access key secrets are provided out of band to get node api access
-      # key: access key
-      # value: associated secret
-      @secret_finder = secret_finder
-      @workspace_name = workspace
-      @cache_user_info = nil
-      @cache_url_token_info = nil
-      # init rest params
-      aoc_rest_p = {auth: {type: :oauth2}}
-      # shortcut to auth section
-      aoc_auth_p = aoc_rest_p[:auth]
-      # analyze type of url
-      url_info = AoC.link_info(url)
-      Log.log.debug{Log.dump(:url_info, url_info)}
-      @private_link = url_info[:private_link]
-      aoc_auth_p[:grant_method] = if url_info.key?(:token)
-        :aoc_pub_link
-      else
-        raise ArgumentError, 'Missing mandatory option: auth' if auth.nil?
-        auth
-      end
-      # this is the base API url
-      api_url_base = self.class.api_base_url(api_domain: url_info[:instance_domain])
-      # API URL, including subpath (version ...)
-      aoc_rest_p[:base_url] = "#{api_url_base}/#{subpath}"
-      # auth URL
-      aoc_auth_p[:base_url] = "#{api_url_base}/#{OAUTH_API_SUBPATH}/#{url_info[:organization]}"
-      aoc_auth_p[:client_id] = client_id
-      aoc_auth_p[:client_secret] = client_secret
-      aoc_auth_p[:scope] = scope
-
-      # fill other auth parameters based on Oauth method
-      case aoc_auth_p[:grant_method]
-      when :web
-        raise ArgumentError, 'Missing mandatory option: redirect_uri' if redirect_uri.nil?
-        aoc_auth_p[:web] = {redirect_uri: redirect_uri}
-      when :jwt
-        raise ArgumentError, 'Missing mandatory option: private_key' if private_key.nil?
-        raise ArgumentError, 'Missing mandatory option: username' if username.nil?
-        aoc_auth_p[:jwt] = {
-          private_key_obj: OpenSSL::PKey::RSA.new(private_key, passphrase),
-          payload:         {
-            iss: aoc_auth_p[:client_id], # issuer
-            sub: username, # subject
-            aud: JWT_AUDIENCE
-          }
-        }
-        # add jwt payload for global ids
-        aoc_auth_p[:jwt][:payload][:org] = url_info[:organization] if GLOBAL_CLIENT_APPS.include?(aoc_auth_p[:client_id])
-      when :aoc_pub_link
-        aoc_auth_p[:aoc_pub_link] = {
-          url:  {grant_type: 'url_token'}, # URL arguments
-          json: {url_token: url_info[:token]} # JSON body
-        }
-        # password protection of link
-        aoc_auth_p[:aoc_pub_link][:json][:password] = password unless password.nil?
-        # basic auth required for /token
-        aoc_auth_p[:auth] = {type: :basic, username: aoc_auth_p[:client_id], password: aoc_auth_p[:client_secret]}
-      else raise "ERROR: unsupported auth method: #{aoc_auth_p[:grant_method]}"
-      end
-      super(aoc_rest_p)
-    end
-
-    def public_link
-      return nil unless params[:auth][:grant_method].eql?(:aoc_pub_link)
-      return @cache_url_token_info unless @cache_url_token_info.nil?
-      # TODO: can there be several in list ?
-      @cache_url_token_info = read('url_tokens')[:data].first
-      return @cache_url_token_info
-    end
-
-    def assert_public_link_types(expected)
-      raise "public link type is #{public_link['purpose']} but action requires one of #{expected.join(',')}" unless expected.include?(public_link['purpose'])
-    end
-
-    def additional_persistence_ids
-      return [current_user_info['id']] if public_link.nil?
-      return [] # TODO : public_link['id'] ?
-    end
-
-    # def secret_finder=(secret_finder)
-    #  raise 'secret finder already set' unless @secret_finder.nil?
-    #  raise 'secret finder must have lookup_secret' unless secret_finder.respond_to?(:lookup_secret)
-    #  @secret_finder = secret_finder
-    # end
-
-    # cached user information
-    def current_user_info(exception: false)
-      return @cache_user_info unless @cache_user_info.nil?
-      # get our user's default information
-      @cache_user_info =
-        begin
-          read('self')[:data]
-        rescue StandardError => e
-          raise e if exception
-          Log.log.debug{"ignoring error: #{e}"}
-          {}
-        end
-      USER_INFO_FIELDS_MIN.each{|f|@cache_user_info[f] = 'unknown' if @cache_user_info[f].nil?}
-      return @cache_user_info
-    end
-
-    # @param application [Symbol] :files or :packages
-    # @return [Hash] current context information: workspace, and home node/file if app is "Files"
-    def context(application = nil)
-      return @context_cache unless @context_cache.nil?
-      raise 'context must be initialized with application' if application.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)
-          Log.log.debug('Using default workspace'.green)
-          raise 'User does not have default workspace, please specify workspace' if current_user_info['default_workspace_id'].nil?
-          current_user_info['default_workspace_id']
-        elsif @workspace_name.nil?
-          nil
-        else
-          lookup_by_name('workspaces', @workspace_name)['id']
-        end
-      ws_info =
-        if ws_id.nil?
-          nil
-        else
-          read("workspaces/#{ws_id}")[:data]
-        end
-      @context_cache = if ws_info.nil?
-        {
-          workspace_id:   nil,
-          workspace_name: 'Shared folders'
-        }
-      else
-        {
-          workspace_id:   ws_info['id'],
-          workspace_name: ws_info['name']
-        }
-      end
-      return @context_cache unless application.eql?(:files)
-      if !public_link.nil?
-        assert_public_link_types(['view_shared_file'])
-        @context_cache[:home_node_id] = public_link['data']['node_id']
-        @context_cache[:home_file_id] = public_link['data']['file_id']
-      elsif !private_link.nil?
-        @context_cache[:home_node_id] = private_link[:node_id]
-        @context_cache[:home_file_id] = private_link[:file_id]
-      elsif ws_info
-        @context_cache[:home_node_id] = ws_info['home_node_id']
-        @context_cache[:home_file_id] = ws_info['home_file_id']
-      else
-        # not part of any workspace, but has some folder shared
-        user_info = current_user_info(exception: true) rescue {'read_only_home_node_id' => nil, 'read_only_home_file_id' => nil}
-        @context_cache[:home_node_id] = user_info['read_only_home_node_id']
-        @context_cache[:home_file_id] = user_info['read_only_home_file_id']
-      end
-      raise "Cannot get user's home node id, check your default workspace or specify one" if @context_cache[:home_node_id].to_s.empty?
-      Log.log.debug{Log.dump(:context, @context_cache)}
-      return @context_cache
-    end
-
-    # @param node_id [String] identifier of node in AoC
-    # @param workspace_id [String] workspace identifier
-    # @param workspace_name [String] workspace name
-    # @param scope e.g. Aspera::Node::SCOPE_USER, or nil (requires secret)
-    # @param package_info [Hash] created package information
-    # @returns [Aspera::Node] a node API for access key
-    def node_api_from(node_id:, workspace_id: nil, workspace_name: nil, scope: Aspera::Node::SCOPE_USER, package_info: nil)
-      raise 'invalid type for node_id' unless node_id.is_a?(String)
-      node_info = read("nodes/#{node_id}")[:data]
-      if workspace_name.nil? && !workspace_id.nil?
-        workspace_name = read("workspaces/#{workspace_id}")[:data]['name']
-      end
-      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])
-        raise 'package info required' if package_info.nil?
-        app_info[:package_id] = package_info['id']
-        app_info[:package_name] = package_info['name']
-      end
-      node_rest_params = {base_url: node_info['url']}
-      # if secret is available
-      if scope.nil?
-        node_rest_params[:auth] = {
-          type:     :basic,
-          username: node_info['access_key'],
-          password: @secret_finder&.lookup_secret(url: node_info['url'], username: node_info['access_key'], mandatory: true)
-        }
-      else
-        # OAuth bearer token
-        node_rest_params[:auth] = params[:auth].clone
-        node_rest_params[:auth][:scope] = Aspera::Node.token_scope(node_info['access_key'], scope)
-        # special header required for bearer token only
-        node_rest_params[:headers] = {Aspera::Node::HEADER_X_ASPERA_ACCESS_KEY => node_info['access_key']}
-      end
-      return Node.new(params: node_rest_params, app_info: app_info)
-    end
-
-    # Check metadata: remove when validation is done server side
-    def validate_metadata(pkg_data)
-      # validate only for shared inboxes
-      return unless pkg_data['recipients'].is_a?(Array) &&
-        pkg_data['recipients'].first.is_a?(Hash) &&
-        pkg_data['recipients'].first.key?('type') &&
-        pkg_data['recipients'].first['type'].eql?('dropbox')
-      meta_schema = read("dropboxes/#{pkg_data['recipients'].first['id']}")[:data]['metadata_schema']
-      if meta_schema.nil? || meta_schema.empty?
-        Log.log.debug('no metadata in shared inbox')
-        return
-      end
-      pkg_meta = pkg_data['metadata']
-      raise "package requires metadata: #{meta_schema}" unless pkg_data.key?('metadata')
-      raise 'metadata must be an Array' unless pkg_meta.is_a?(Array)
-      Log.log.debug{Log.dump(:metadata, pkg_meta)}
-      pkg_meta.each do |field|
-        raise 'metadata field must be Hash' unless field.is_a?(Hash)
-        raise 'metadata field must have name' unless field.key?('name')
-        raise 'metadata field must have values' unless field.key?('values')
-        raise 'metadata values must be an Array' unless field['values'].is_a?(Array)
-        raise "unknown metadata field: #{field['name']}" if meta_schema.select{|i|i['name'].eql?(field['name'])}.empty?
-      end
-      meta_schema.each do |field|
-        provided = pkg_meta.select{|i|i['name'].eql?(field['name'])}
-        raise "only one field with name #{field['name']} allowed" if provided.count > 1
-        raise "missing mandatory field: #{field['name']}" if field['required'] && provided.empty?
-      end
-    end
-
-    # Normalize package creation recipient lists as expected by AoC API
-    # AoC expects {type: , id: }, but ascli allows providing either the native values or just a name
-    # in that case, the name is resolved and replaced with {type: , id: }
-    # @param package_data The whole package creation payload
-    # @param recipient_list_field The field in structure, i.e. recipients or bcc_recipients
-    # @return nil package_data is modified
-    def resolve_package_recipients(package_data, ws_id, recipient_list_field, new_user_option)
-      return unless package_data.key?(recipient_list_field)
-      raise "#{recipient_list_field} must be an Array" unless package_data[recipient_list_field].is_a?(Array)
-      new_user_option = {'package_contact' => true} if new_user_option.nil?
-      raise 'new_user_option must be a Hash' unless new_user_option.is_a?(Hash)
-      # list with resolved elements
-      resolved_list = []
-      package_data[recipient_list_field].each do |short_recipient_info|
-        case short_recipient_info
-        when Hash # native API information, check keys
-          raise "#{recipient_list_field} element shall have fields: id and type" unless short_recipient_info.keys.sort.eql?(%w[id type])
-        when String # CLI helper: need to resolve provided name to type/id
-          # email: user, else dropbox
-          entity_type = short_recipient_info.include?('@') ? 'contacts' : 'dropboxes'
-          begin
-            full_recipient_info = lookup_by_name(entity_type, short_recipient_info, {'current_workspace_id' => ws_id})
-          rescue RuntimeError => e
-            raise e unless e.message.start_with?(ENTITY_NOT_FOUND)
-            # dropboxes cannot be created on the fly
-            raise "No such shared inbox in workspace #{ws_id}" if entity_type.eql?('dropboxes')
-            # unknown user: create it as external user
-            full_recipient_info = create('contacts', {
-              'current_workspace_id' => ws_id,
-              'email'                => short_recipient_info
-            }.merge(new_user_option))[:data]
-          end
-          short_recipient_info = if entity_type.eql?('dropboxes')
-            {'id' => full_recipient_info['id'], 'type' => 'dropbox'}
-          else
-            {'id' => full_recipient_info['source_id'], 'type' => full_recipient_info['source_type']}
-          end
-        else # unexpected extended value, must be String or Hash
-          raise "#{recipient_list_field} item must be a String (email, shared inbox) or Hash (id,type)"
-        end # type of recipient info
-        # add original or resolved recipient info
-        resolved_list.push(short_recipient_info)
-      end
-      # replace with resolved elements
-      package_data[recipient_list_field] = resolved_list
-      return nil
-    end
-
-    # CLI allows simplified format for metadata: transform if necessary for API
-    def update_package_metadata_for_api(pkg_data)
-      case pkg_data['metadata']
-      when Array, NilClass # no action
-      when Hash
-        api_meta = []
-        pkg_data['metadata'].each do |k, v|
-          api_meta.push({
-            # 'input_type' => 'single-dropdown',
-            'name'   => k,
-            'values' => v.is_a?(Array) ? v : [v]
-          })
-        end
-        pkg_data['metadata'] = api_meta
-      else raise "metadata field if not of expected type: #{pkg_meta.class}"
-      end
-      return nil
-    end
-
-    # create a package
-    # @param package_data [Hash] package creation (with extensions...)
-    # @param validate_meta [TrueClass,FalseClass] true to validate parameters locally
-    # @param new_user_option [Hash] options if an unknown user is specified
-    # @return transfer spec, node api and package information
-    def create_package_simple(package_data, validate_meta, new_user_option)
-      update_package_metadata_for_api(package_data)
-      # list of files to include in package, optional
-      # package_data['file_names']||=[..list of filenames to transfer...]
-
-      # lookup users
-      resolve_package_recipients(package_data, package_data['workspace_id'], 'recipients', new_user_option)
-      resolve_package_recipients(package_data, package_data['workspace_id'], 'bcc_recipients', new_user_option)
-
-      validate_metadata(package_data) if validate_meta
-
-      #  create a new package container
-      created_package = create('packages', package_data)[:data]
-
-      package_node_api = node_api_from(
-        node_id: created_package['node_id'],
-        workspace_id: created_package['workspace_id'],
-        package_info: created_package)
-
-      # tell AoC what to expect in package: 1 transfer (can also be done after transfer)
-      # TODO: if multi session was used we should probably tell
-      # also, currently no "multi-source" , i.e. only from client-side files, unless "node" agent is used
-      update("packages/#{created_package['id']}", {'sent' => true, 'transfers_expected' => 1})[:data]
-
-      return {
-        spec: package_node_api.transfer_spec_gen4(created_package['contents_file_id'], Fasp::TransferSpec::DIRECTION_SEND),
-        node: package_node_api,
-        info: created_package
-      }
-    end
-
-    # Add transfer spec
-    # callback in Aspera::Node (transfer_spec_gen4)
-    def add_ts_tags(transfer_spec:, app_info:)
-      # translate transfer direction to upload/download
-      transfer_type = Fasp::TransferSpec.action(transfer_spec)
-      # Analytics tags
-      ################
-      transfer_spec.deep_merge!({
-        'tags' => {
-          Fasp::TransferSpec::TAG_RESERVED => {
-            'usage_id' => "aspera.files.workspace.#{app_info[:workspace_id]}", # activity tracking
-            'files'    => {
-              'files_transfer_action' => "#{transfer_type}_#{app_info[:app].gsub(/s$/, '')}",
-              'workspace_name'        => app_info[:workspace_name], # activity tracking
-              'workspace_id'          => app_info[:workspace_id]
-            }
-          }
-        }
-      })
-      # Console cookie
-      ################
-      # we are sure that fields are not nil
-      cookie_elements = [app_info[:app], current_user_info['name'], current_user_info['email']].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
-        file_id = transfer_spec['tags'][Fasp::TransferSpec::TAG_RESERVED]['node']['file_id']
-        transfer_spec.deep_merge!({'tags' => {Fasp::TransferSpec::TAG_RESERVED => {'files' => {'parentCwd' => "#{app_info[:node_info]['id']}:#{file_id}"}}}}) \
-          unless transfer_spec.key?('remote_access_key')
-      when PACKAGES_APP
-        transfer_spec.deep_merge!({
-          'tags' => {
-            Fasp::TransferSpec::TAG_RESERVED => {
-              'files' => {
-                'package_id'        => app_info[:package_id],
-                'package_name'      => app_info[:package_name],
-                'package_operation' => transfer_type
-              }
-            }
-          }
-        })
-      end
-      transfer_spec['tags'][Fasp::TransferSpec::TAG_RESERVED]['files']['node_id'] = app_info[:node_info]['id']
-      transfer_spec['tags'][Fasp::TransferSpec::TAG_RESERVED]['app'] = app_info[:app]
-    end
-
-    ID_AK_ADMIN = 'ASPERA_ACCESS_KEY_ADMIN'
-    # Callback from Plugins::Node
-    # add application specific tags to permissions creation
-    # @param create_param [Hash] parameters for creating permissions
-    # @param app_info [Hash] application information
-    def permissions_set_create_params(create_param:, app_info:)
-      # workspace shared folder:
-      # access_id = "#{ID_AK_ADMIN}_WS_#{app_info[:workspace_id]}"
-      default_params = {
-        # 'access_type'   => 'user', # mandatory: user or group
-        # 'access_id'     => access_id, # id of user or group
-        'tags' => {
-          Fasp::TransferSpec::TAG_RESERVED => {
-            'files' => {
-              'workspace' => {
-                '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'],
-                # 'shared_with_name'  => access_id,
-                'access_key'        => app_info[:node_info]['access_key'],
-                'node'              => app_info[:node_info]['name']
-              }
-            }
-          }
-        }
-      }
-      create_param.deep_merge!(default_params)
-      if create_param.key?('with')
-        contact_info = lookup_by_name(
-          'contacts',
-          create_param['with'],
-          {'current_workspace_id' => app_info[:workspace_id], 'context' => 'share_folder'})
-        create_param.delete('with')
-        create_param['access_type'] = contact_info['source_type']
-        create_param['access_id'] = contact_info['source_id']
-        create_param['tags'][Fasp::TransferSpec::TAG_RESERVED]['files']['workspace']['shared_with_name'] = contact_info['email']
-      end
-      # optional
-      app_info[:opt_link_name] = create_param.delete('link_name')
-    end
-
-    # Callback from Plugins::Node
-    # send shared folder event to AoC
-    # @param created_data [Hash] response from permission creation
-    # @param app_info [Hash] hash with app info
-    # @param types [Array] event types
-    def permissions_send_event(created_data:, app_info:, types: PERMISSIONS_CREATED)
-      raise "INTERNAL: (assert) Invalid event types: #{types}" unless types.is_a?(Array) && !types.empty?
-      event_creation = {
-        'types'        => types,
-        'node_id'      => app_info[:node_info]['id'],
-        'workspace_id' => app_info[:workspace_id],
-        'data'         => created_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?
-      create('events', event_creation)
-    end
-  end # AoC
-end # Aspera

data/lib/aspera/ats_api.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-require 'aspera/log'
-require 'aspera/rest'
-
-module Aspera
-  class AtsApi < Aspera::Rest
-    # currently supported clouds
-    # Note to Aspera: shall be an API call
-    CLOUD_NAME = {
-      aws:       'Amazon Web Services',
-      azure:     'Microsoft Azure',
-      google:    'Google Cloud',
-      limelight: 'Limelight',
-      rackspace: 'Rackspace',
-      softlayer: 'IBM Cloud'
-    }.freeze
-
-    private_constant :CLOUD_NAME
-
-    class << self
-      def base_url; 'https://ats.aspera.io'; end
-    end
-
-    def initialize
-      super({base_url: AtsApi.base_url + '/pub/v1'})
-      # cache of server data
-      @all_servers_cache = nil
-    end
-
-    def cloud_names; CLOUD_NAME; end
-
-    # all available ATS servers
-    # NOTE to Aspera: an API shall be created to retrieve all servers at once
-    def all_servers
-      if @all_servers_cache.nil?
-        @all_servers_cache = []
-        CLOUD_NAME.each_key do |name|
-          read("servers/#{name.to_s.upcase}")[:data].each do |i|
-            @all_servers_cache.push(i)
-          end
-        end
-      end
-      return @all_servers_cache
-    end
-  end # AtsApi
-end # Aspera