simplified Faspex5 specific api call

Signed-off-by: Laurent Martin <laurent.martin.l@gmail.com>

Author: laurent-martin

lib/aspera/api/faspex.rb

@@ -64,9 +64,6 @@ class Faspex < Aspera::Rest
       PATH_AUTH = 'auth'
       PATH_API_V5 = 'api/v5'
       PATH_HEALTH = 'configuration/ping'
-      private_constant :PATH_AUTH,
-        :PATH_API_V5,
-        :PATH_HEALTH
       RECIPIENT_TYPES = %w[user workgroup external_user distribution_list shared_inbox].freeze
       PACKAGE_TERMINATED = %w[completed failed].freeze
       # list of supported mailbox types (to list packages)
@@ -152,6 +149,7 @@ def box_type(box)
       def initialize(
         url:,
         auth:,
+        root: PATH_API_V5,
         password: nil,
         client_id: nil,
         client_secret: nil,
@@ -165,23 +163,23 @@ def initialize(
         super(**
           case auth
           when :public_link
-            # Get URL of final redirect of public link
-            redir_url = Rest.new(base_url: url, redirect_max: 3).call(operation: 'GET', ret: :resp).uri.to_s
-            Log.dump(:redir_url, redir_url, level: :trace1)
-            # get context from query
-            encoded_context = Rest.query_to_h(URI.parse(redir_url).query)['context']
+            # Get URL of final redirect of provided public link
+            final_url = Rest.new(base_url: url, redirect_max: 3).call(operation: 'GET', ret: :resp).uri.to_s
+            Log.dump(:final_url, final_url, level: :trace1)
+            # Get context from query
+            encoded_context = Rest.query_to_h(URI.parse(final_url).query)['context']
             raise ParameterError, 'Bad faspex5 public link, missing context in query' if encoded_context.nil?
             # public link information (contains passcode and allowed usage)
             @pub_link_context = JSON.parse(Base64.decode64(encoded_context))
             Log.dump(:pub_link_context, @pub_link_context, level: :trace1)
             # Get the base url, i.e. .../aspera/faspex
-            base_url = redir_url.gsub(%r{/public/.*}, '').gsub(/\?.*/, '')
+            base_url = final_url.gsub(%r{/public/.*}, '').gsub(/\?.*/, '')
             # Get web UI client_id and redirect_uri
             # TODO: change this for something more reliable
             config = JSON.parse(Rest.new(base_url: "#{base_url}/config.js", redirect_max: 3).call(operation: 'GET').sub(/^[^=]+=/, '').gsub(/([a-z_]+):/, '"\1":').delete("\n ").tr("'", '"')).symbolize_keys
-            Log.dump(:configjs, config)
+            Log.dump(:config_js, config)
             {
-              base_url: "#{base_url}/#{PATH_API_V5}",
+              base_url: "#{base_url}/#{root}",
               auth:     {
                 type:         :oauth2,
                 base_url:     "#{base_url}/#{PATH_AUTH}",
@@ -198,15 +196,15 @@ def initialize(
             Aspera.assert(password, type: ParameterError){'Missing password'}
             # the password here is the token copied directly from browser in developer mode
             {
-              base_url: "#{url}/#{PATH_API_V5}",
+              base_url: "#{url}/#{root}",
               headers:  {'Authorization' => password}
             }
           when :web
             Aspera.assert(client_id, type: ParameterError){'Missing client_id'}
             Aspera.assert(redirect_uri, type: ParameterError){'Missing redirect_uri'}
             # opens a browser and ask user to auth using web
             {
-              base_url: "#{url}/#{PATH_API_V5}",
+              base_url: "#{url}/#{root}",
               auth:     {
                 type:         :oauth2,
                 base_url:     "#{url}/#{PATH_AUTH}",
@@ -221,7 +219,7 @@ def initialize(
             Aspera.assert(client_id, type: ParameterError){'Missing client_id'}
             Aspera.assert(private_key, type: ParameterError){'Missing private_key'}
             {
-              base_url: "#{url}/#{PATH_API_V5}",
+              base_url: "#{url}/#{root}",
               auth:     {
                 type:            :oauth2,
                 base_url:        "#{url}/#{PATH_AUTH}",
@@ -242,10 +240,6 @@ def initialize(
           end
         )
       end
-
-      def auth_api
-        Rest.new(**params, base_url: base_url.sub(PATH_API_V5, PATH_AUTH))
-      end
     end
   end
 end

lib/aspera/cli/plugins/base.rb

@@ -134,7 +134,6 @@ def do_bulk_operation(command:, descr: nil, values: Hash, id_result: 'id', field
         # @param delete_style   [String]  If set, the delete operation by array in payload
         # @param id_as_arg      [String]  If set, the id is provided as url argument ?<id_as_arg>=<id>
         # @param is_singleton   [Boolean] If `true`, entity is the full path to the resource
-        # @param tclo           [Boolean] If `true`, :list use paging with total_count, limit, offset
         # @param block          [Proc]    Block to search for identifier based on attribute value
         # @return [Hash] Result suitable for CLI result
         def entity_execute(
@@ -147,7 +146,6 @@ def entity_execute(
           id_as_arg: false,
           is_singleton: false,
           list_query: nil,
-          tclo: false,
           &block
         )
           command = options.get_next_command(ALL_OPS) if command.nil?
@@ -185,10 +183,6 @@ def entity_execute(
           when :show
             return Main.result_single_object(api.read(one_res_path), fields: display_fields)
           when :list
-            if tclo
-              data, total = api.list_entities_limit_offset_total_count(entity: entity, items_key: items_key, query: query_read_delete(default: list_query))
-              return Main.result_object_list(data, total: total, fields: display_fields)
-            end
             data, http = api.read(entity, query_read_delete, ret: :both)
             return Main.result_empty if http.code == '204'
             # TODO: not generic : which application is this for ?

lib/aspera/cli/plugins/faspex5.rb

@@ -100,13 +100,6 @@ def initialize(**_)
           options.parse_options!
         end
 
-        def set_api
-          # create an API object with the same options, but with a different subpath
-          @api_v5 = Api::Faspex.new(**Oauth.args_from_options(options))
-          # in case user wants to use HTTPGW tell transfer agent how to get address
-          transfer.httpgw_url_cb = lambda{@api_v5.read('account')['gateway_url']}
-        end
-
         # if recipient is just an email, then convert to expected API hash : name and type
         def normalize_recipients(parameters, type)
           type = type.to_s
@@ -423,8 +416,7 @@ def package_action
         def execute_resource(res_sym)
           exec_args = {
             api:    @api_v5,
-            entity: res_sym.to_s,
-            tclo:   true
+            entity: res_sym.to_s
           }
           res_id_query = :default
           available_commands = ALL_OPS
@@ -445,7 +437,7 @@ def execute_resource(res_sym)
             available_commands += [:reset_password]
           when :oauth_clients
             exec_args[:display_fields] = Formatter.all_but('public_key')
-            exec_args[:api] = @api_v5.auth_api
+            exec_args[:api] = Api::Faspex.new(root: Api::Faspex::PATH_AUTH, **Oauth.args_from_options(options))
             exec_args[:list_query] = {'expand': true, 'no_api_path': true, 'client_types[]': 'public'}
           when :shared_inboxes, :workgroups
             available_commands += %i[members saml_groups invite_external_collaborator]
@@ -458,10 +450,13 @@ def execute_resource(res_sym)
           res_command = options.get_next_command(available_commands)
           return Main.result_value_list(Api::Faspex::EMAIL_NOTIF_LIST, name: 'email_id') if res_command.eql?(:list) && res_sym.eql?(:email_notifications)
           case res_command
-          when *ALL_OPS
+          when :create, :modify, :delete, :show
             return entity_execute(command: res_command, **exec_args) do |field, value|
                      @api_v5.lookup_entity_by_field(entity: exec_args[:entity], value: value, field: field, items_key: exec_args[:items_key], query: res_id_query)['id']
                    end
+          when :list
+            data, total = exec_args[:api].list_entities_limit_offset_total_count(entity: exec_args[:entity], items_key: exec_args[:items_key], query: query_read_delete(default: exec_args[:list_query]))
+            return Main.result_object_list(data, total: total, fields: exec_args[:display_fields])
           when :shared_folders
             # nodes
             node_id = instance_identifier do |field, value|
@@ -620,7 +615,12 @@ def execute_admin
 
         def execute_action
           command = options.get_next_command(ACTIONS)
-          set_api unless %i{postprocessing health}.include?(command)
+          unless %i{postprocessing health}.include?(command)
+            # create an API object with the same options, but with a different subpath
+            @api_v5 = Api::Faspex.new(**Oauth.args_from_options(options))
+            # in case user wants to use HTTPGW tell transfer agent how to get address
+            transfer.httpgw_url_cb = lambda{@api_v5.read('account')['gateway_url']}
+          end
           case command
           when :version
             return Main.result_single_object(@api_v5.read('version'))