aspera-cli 4.0.0.pre3 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 22041be5b72d2a1907350832239b7e3b96890e6b50cc36ab199ecdddf6fe3e89
-  data.tar.gz: b30116b52e35ffd5020a400fa07a519da847de1c078c2e09b91349488c95947a
+  metadata.gz: 7172a58b5d9de3455d25667a9eb6d3475d66b2a334be6e2cdee987a041d1d89f
+  data.tar.gz: 7408405f727f10b137a15c453cd3d89770256fc8392ab311b1318b873bffd18d
 SHA512:
-  metadata.gz: d7992b721a8dc47334ad5706aa645534822ef7b9608055c1ef0c5908085c20e45dd2dc4b7a4210481b40af9f554f389fe408c8807cc7d2eb40c3e7b212f0c4f9
-  data.tar.gz: 16ee1fdb8ddfecac75a0674f2f4be902decc76543b3577e81a12284d899d74b4cd1c38b68f6bda126aebd1f9cddf045af0c7ef98fe0aa0aee0a2634b9a249a84
+  metadata.gz: 80fff0696b7a65c05b823483e8f07f34d37a3b0c95c6658ed23e4837b4b223143b46146aae53604a5f80e1695e12f598d53bbb900d3d34a5c31094e441904e82
+  data.tar.gz: 76c299e2daed96ff33af518f1d1df97eba35bab38c9c8eec86f2bf5b623455dec6bc6bbddba3fbd390b3ebb7d34a68ed7054a74999e215cbbfa88840af8d311a

data/README.md

@@ -1,7 +1,7 @@
 [comment1]: # (Do not edit this README.md, edit docs/README.erb.md, for details, read docs/README.md)
 # `ascli` : a Command Line for IBM Aspera products
 
-Version : 4.0.0.pre3
+Version : 4.0.0
 
 _Laurent/2016-2021_
 
@@ -14,17 +14,11 @@ Disclaimers:
 
 * This has not yet been officially released so things may change
 
-That being said, `ascli` is very powerful and gets things done, it's also a great tool to learn Aspera APIs.
-
-This manual addresses three parts:
-
-* `ascli` : The command line tool
-* `asession` : starting a FASP Session with JSON parameters
-* `Aspera` : includes a Ruby "FASPManager"
+`ascli` is also a great tool to learn Aspera APIs.
 
 In examples, command line operations (starting with `$`) are shown using a standard shell: `bash` or `zsh`.
 
-Command line parameters in example beginning with `my_`, like `my_param_value` are user-provided value and not fixed value commands.
+Command line parameters in examples beginning with `my_`, like `my_param_value` are user-provided value and not fixed value commands.
 
 # Quick Start
 
@@ -36,7 +30,7 @@ Once the gem is installed, `ascli` shall be accessible:
 
 ```
 $ ascli --version
-4.0.0.pre3
+4.0.0
 ```
 
 ## First use
@@ -112,19 +106,21 @@ The following sections provide information on the installation.
 ## <a name="ruby"></a>Ruby
 
 A ruby interpreter is required to run the tool or to use the gem and tool.
-The Ruby version shall be at least > 2.4.
-Any type of Ruby installation can be used.
-Ruby 3 is not yet tested.
+
+Ruby minimum version: > 2.4
+
+Ruby 3 is also supported.
+
+Any type of Ruby installation can be used (installer, rpm, rvm, ...).
 
 Refer to the following sections for a proposed method for specific operating systems.
 
 ### macOS
 
-
 MacOS 10.13+ (High Sierra) comes with a recent Ruby, so you can use it directly, you will need to install aspera-cli using `sudo` :
 
 ```
-$ sudo gem install aspera-cli --pre
+$ sudo gem install aspera-cli
 ```
 
 Alternatively, if you use [Homebrew](https://brew.sh/) already you can install Ruby with it:
@@ -133,6 +129,8 @@ Alternatively, if you use [Homebrew](https://brew.sh/) already you can install R
 $ brew install ruby
 ```
 
+It is also possib le to use `rvm`
+
 ### Windows
 
 Install Latest stable Ruby using [https://rubyinstaller.org/](https://rubyinstaller.org/).
@@ -167,13 +165,7 @@ Alternatively, only if you know what you do, on RPM based systems (CentOs, Redha
 # yum install -y ruby rubygems ruby-json
 ```
 
-If necessary, pre-install jwt for older Ruby < 2.1.
-
-```
-# gem install jwt -v 1.5.6
-```
-
-You can cleanup your whole yum-installed ruby environment like this to uninstall:
+One can cleanup your whole yum-installed ruby environment like this to uninstall:
 
 ```
 gem uninstall $(ls $(gem env gemdir)/gems/|sed -e 's/-[^-]*$//'|sort -u)
@@ -182,7 +174,7 @@ yum remove -y ruby ruby-libs
 
 ### Other Unixes: Aix, etc...
 
-If your unix do not provide a pre-built ruby, you can get using one of those
+If your unix do not provide a pre-built ruby, you can get it using one of those
 [methods](https://www.ruby-lang.org/en/documentation/installation/)
 
 For instance to build from source, and install in `/opt/ruby` :
@@ -203,7 +195,7 @@ For instance to build from source, and install in `/opt/ruby` :
 Once you have Ruby and rights to install gems: Install the gem and its dependencies:
 
 ```
-# gem install aspera-cli --pre
+# gem install aspera-cli
 ```
 
 To upgrade to the latest version:
@@ -1252,6 +1244,24 @@ ascli aoc admin ats cluster clouds
 ascli aoc admin ats cluster list
 ascli aoc admin ats cluster show --cloud=aws --region=eu-west-1
 ascli aoc admin ats cluster show --id=1f412ae7-869a-445c-9c05-02ad16813be2
+ascli aoc admin res apps_new list
+ascli aoc admin res client list
+ascli aoc admin res client_access_key list
+ascli aoc admin res client_registration_token list
+ascli aoc admin res contact list
+ascli aoc admin res dropbox list
+ascli aoc admin res dropbox_membership list
+ascli aoc admin res group list
+ascli aoc admin res kms_profile list
+ascli aoc admin res node list
+ascli aoc admin res operation list
+ascli aoc admin res organization show
+ascli aoc admin res package list
+ascli aoc admin res saml_configuration list
+ascli aoc admin res self show
+ascli aoc admin res short_link list
+ascli aoc admin res user list
+ascli aoc admin res workspace_membership list
 ascli aoc admin resource node --name=AOC_NODE1_NAME --secret=AOC_NODE1_SECRET v3 access_key create --value=@json:'{"id":"testsub1","storage":{"path":"/folder1"}}'
 ascli aoc admin resource node --name=AOC_NODE1_NAME --secret=AOC_NODE1_SECRET v3 access_key delete --id=testsub1
 ascli aoc admin resource node --name=AOC_NODE1_NAME --secret=AOC_NODE1_SECRET v3 events
@@ -1441,7 +1451,7 @@ ascli sync start --parameters=@json:'{"sessions":[{"name":"test","reset":true,"r
 ```
 $ ascli -h
 NAME
-	ascli -- a command line tool for Aspera Applications (v4.0.0.pre3)
+	ascli -- a command line tool for Aspera Applications (v4.0.0)
 
 SYNOPSIS
 	ascli COMMANDS [OPTIONS] [ARGS]
@@ -2272,8 +2282,9 @@ Notes:
 Examples:
 
 ```
-$ ascli aoc packages send --value=@json:'{"name":"my title","note":"my note","recipients":["laurent.martin.aspera@fr.ibm.com","other@example.com"]}' --sources=@args my_file.dat
-$ ascli aoc packages send --value=@json:'{"name":"my file in shared inbox","recipients":["The Shared Inbox"]}' my_file.dat --ts=@json:'{"target_rate_kbps":100000}'
+$ ascli aoc package send --value=@json:'{"name":"my title","note":"my note","recipients":["laurent.martin.aspera@fr.ibm.com","other@example.com"]}' --sources=@args my_file.dat
+$ ascli aoc package send --value=@json:'{"name":"my file in shared inbox","recipients":["The Shared Inbox"]}' my_file.dat --ts=@json:'{"target_rate_kbps":100000}'
+$ ascli aoc package send --workspace=eudemo --value=@json:'{"name":"my pack title","recipients":["Shared Inbox Name"],"metadata":[{"input_type":"single-text","name":"Project Id","values":["123"]},{"input_type":"single-dropdown","name":"Type","values":["Opt2"]},{"input_type":"multiple-checkbox","name":"CheckThose","values":["Check1","Check2"]},{"input_type":"date","name":"Optional Date","values":["2021-01-13T15:02:00.000Z"]}]}' ~/Documents/Samples/200KB.1
 ```
 
 ## <a name="aoccargo"></a>Receive new packages only

data/docs/README.erb.md

@@ -30,17 +30,11 @@ Disclaimers:
 
 * This has not yet been officially released so things may change
 
-That being said, <%=tool%> is very powerful and gets things done, it&apos;s also a great tool to learn Aspera APIs.
-
-This manual addresses three parts:
-
-* <%=tool%> : The command line tool
-* `asession` : starting a FASP Session with JSON parameters
-* `Aspera` : includes a Ruby "FASPManager"
+<%=tool%> is also a great tool to learn Aspera APIs.
 
 In examples, command line operations (starting with `$`) are shown using a standard shell: `bash` or `zsh`.
 
-Command line parameters in example beginning with `my_`, like `my_param_value` are user-provided value and not fixed value commands.
+Command line parameters in examples beginning with `my_`, like `my_param_value` are user-provided value and not fixed value commands.
 
 # Quick Start
 
@@ -128,15 +122,17 @@ The following sections provide information on the installation.
 ## <a name="ruby"></a>Ruby
 
 A ruby interpreter is required to run the tool or to use the gem and tool.
-The Ruby version shall be at least <%= gemspec.required_ruby_version %>.
-Any type of Ruby installation can be used.
-Ruby 3 is not yet tested.
+
+Ruby minimum version: <%= gemspec.required_ruby_version %>
+
+Ruby 3 is also supported.
+
+Any type of Ruby installation can be used (installer, rpm, rvm, ...).
 
 Refer to the following sections for a proposed method for specific operating systems.
 
 ### macOS
 
-
 MacOS 10.13+ (High Sierra) comes with a recent Ruby, so you can use it directly, you will need to install <%= gemspec.name %> using `sudo` :
 
 ```
@@ -149,6 +145,8 @@ Alternatively, if you use [Homebrew](https://brew.sh/) already you can install R
 $ brew install ruby
 ```
 
+It is also possib le to use `rvm`
+
 ### Windows
 
 Install Latest stable Ruby using [https://rubyinstaller.org/](https://rubyinstaller.org/).
@@ -183,13 +181,7 @@ Alternatively, only if you know what you do, on RPM based systems (CentOs, Redha
 # yum install -y ruby rubygems ruby-json
 ```
 
-If necessary, pre-install jwt for older Ruby < 2.1.
-
-```
-# gem install jwt -v 1.5.6
-```
-
-You can cleanup your whole yum-installed ruby environment like this to uninstall:
+One can cleanup your whole yum-installed ruby environment like this to uninstall:
 
 ```
 gem uninstall $(ls $(gem env gemdir)/gems/|sed -e 's/-[^-]*$//'|sort -u)
@@ -198,7 +190,7 @@ yum remove -y ruby ruby-libs
 
 ### Other Unixes: Aix, etc...
 
-If your unix do not provide a pre-built ruby, you can get using one of those
+If your unix do not provide a pre-built ruby, you can get it using one of those
 [methods](https://www.ruby-lang.org/en/documentation/installation/)
 
 For instance to build from source, and install in `/opt/ruby` :
@@ -1735,8 +1727,9 @@ Notes:
 Examples:
 
 ```
-$ <%=cmd%> aoc packages send --value=@json:'{"name":"my title","note":"my note","recipients":["laurent.martin.aspera@fr.ibm.com","other@example.com"]}' --sources=@args my_file.dat
-$ <%=cmd%> aoc packages send --value=@json:'{"name":"my file in shared inbox","recipients":["The Shared Inbox"]}' my_file.dat --ts=@json:'{"target_rate_kbps":100000}'
+$ <%=cmd%> aoc package send --value=@json:'{"name":"my title","note":"my note","recipients":["laurent.martin.aspera@fr.ibm.com","other@example.com"]}' --sources=@args my_file.dat
+$ <%=cmd%> aoc package send --value=@json:'{"name":"my file in shared inbox","recipients":["The Shared Inbox"]}' my_file.dat --ts=@json:'{"target_rate_kbps":100000}'
+$ <%=cmd%> aoc package send --workspace=eudemo --value=@json:'{"name":"my pack title","recipients":["Shared Inbox Name"],"metadata":[{"input_type":"single-text","name":"Project Id","values":["123"]},{"input_type":"single-dropdown","name":"Type","values":["Opt2"]},{"input_type":"multiple-checkbox","name":"CheckThose","values":["Check1","Check2"]},{"input_type":"date","name":"Optional Date","values":["2021-01-13T15:02:00.000Z"]}]}' ~/Documents/Samples/200KB.1
 ```
 
 ## <a name="aoccargo"></a>Receive new packages only

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

@@ -139,12 +139,12 @@ module Aspera
             return Main.result_status("renamed #{thepath} to #{newname}")
           when :delete
             thepath=self.options.get_next_argument('path')
-            return do_bulk_operation(thepath,'deleted','path') do |thepath|
-              raise "expecting String (path), got #{thepath.class.name} (#{thepath})" unless thepath.is_a?(String)
-              node_file = @api_aoc.resolve_node_file(top_node_file,thepath)
+            return do_bulk_operation(thepath,'deleted','path') do |l_path|
+              raise "expecting String (path), got #{l_path.class.name} (#{l_path})" unless l_path.is_a?(String)
+              node_file = @api_aoc.resolve_node_file(top_node_file,l_path)
               node_api=@api_aoc.get_node_api(node_file[:node_info],AoC::SCOPE_NODE_USER)
               result=node_api.delete("files/#{node_file[:file_id]}")[:data]
-              {'path'=>thepath}
+              {'path'=>l_path}
             end
           when :transfer
             # client side is agent
@@ -558,8 +558,23 @@ module Aspera
               return {:type=>:object_list,:data=>events}
             end
           when :resource
-            resource_type=self.options.get_next_argument('resource',[:self,:organization,:user,:group,:client,:contact,:dropbox,:node,:operation,:package,:saml_configuration, :workspace, :dropbox_membership,:short_link,:workspace_membership,'admin/apps_new'.to_sym,'admin/client_registration_token'.to_sym,'integrations/kms_profile'.to_sym])
-            resource_class_path=resource_type.to_s+case resource_type;when :dropbox;'es';when :self,:organization,'admin/apps_new'.to_sym;'';else; 's';end
+            resource_type=self.options.get_next_argument('resource',[:self,:organization,:user,:group,:client,:contact,:dropbox,:node,:operation,:package,:saml_configuration, :workspace, :dropbox_membership,:short_link,:workspace_membership,:apps_new,:client_registration_token,:client_access_key,:kms_profile])
+            # get path on API
+            resource_class_path=case resource_type
+            when :self,:organization
+              "#{resource_type}"
+            when :apps_new
+              "admin/#{resource_type}"
+            when :dropbox
+              resource_type.to_s+'es'
+            when :client_registration_token,:client_access_key
+              "admin/#{resource_type}s"
+            when :kms_profile
+              "integrations/#{resource_type}s"
+            else
+              resource_type.to_s+'s'
+            end
+            # build list of supported operations
             singleton_object=[:self,:organization].include?(resource_type)
             global_operations=[:create,:list]
             supported_operations=[:show,:modify]
@@ -568,7 +583,6 @@ module Aspera
             supported_operations.push(:set_pub_key) if resource_type.eql?(:client)
             supported_operations.push(:shared_folders) if [:node,:workspace].include?(resource_type)
             command=self.options.get_next_command(supported_operations)
-
             # require identifier for non global commands
             if !singleton_object and !global_operations.include?(command)
               res_id=self.options.get_option(:id)
@@ -607,8 +621,8 @@ module Aspera
               when :node; default_fields.push('host','access_key')
               when :operation; default_fields=nil
               when :contact; default_fields=["email","name","source_id","source_type"]
-              when 'admin/apps_new'.to_sym; list_query={:organization_apps=>true};default_fields=['app_type','available']
-              when 'admin/client_registration_token'.to_sym; default_fields=['id','value','data.client_subject_scopes','created_at']
+              when :apps_new; list_query={:organization_apps=>true};default_fields=['app_type','available']
+              when :client_registration_token; default_fields=['id','value','data.client_subject_scopes','created_at']
               end
               result=@api_aoc.read(resource_class_path,url_query(list_query))
               self.format.display_status("Items: #{result[:data].length}/#{result[:http]['X-Total-Count']}")
@@ -639,18 +653,6 @@ module Aspera
               return Node.new(@agents.merge(skip_basic_auth_options: true, node_api: api_node)).execute_action if command.eql?(:v3)
               ak_data=api_node.call({:operation=>'GET',:subpath=>"access_keys/#{res_data['access_key']}",:headers=>{'Accept'=>'application/json'}})[:data]
               return node_gen4_execute_action({node_info: res_data, file_id: ak_data['root_file_id']})
-              #            when :info
-              #              object=@api_aoc.read(resource_instance_path)[:data]
-              #              access_key=object['access_key']
-              #              match_list=@api_aoc.read('admin/search_nodes',{:q=>"access_key:\"#{access_key}\""})[:data]
-              #              result=match_list.select{|i|i["_source"]["access_key_recursive_counts"].first["access_key"].eql?(access_key)}
-              #              return Main.result_status('Private node') if result.empty?
-              #              raise CliError,"more than one match" unless result.length.eql?(1)
-              #              result=result.first["_source"]
-              #              result.merge!(result['access_key_recursive_counts'].first)
-              #              result.delete('access_key_recursive_counts')
-              #              result.delete('token')
-              #              return { :type=>:single_object, :data =>result}
             when :shared_folders
               read_params = case resource_type
               when :workspace;{'access_id'=>"ASPERA_ACCESS_KEY_ADMIN_WS_#{res_id}",'access_type'=>'user'}

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

@@ -44,7 +44,7 @@ module Aspera
           result={
             :base_url => "#{publink_uri.scheme}://#{publink_uri.host}#{port_add}#{base}",
             :subpath  => subpath,
-            :query    => URI::decode_www_form(publink_uri.query).inject({}){|m,v|m[v.first]=v.last;m}
+            :query    => URI::decode_www_form(publink_uri.query).inject({}){|h,v|h[v.first]=v.last;h}
           }
           Log.dump('publink',result)
           return result

data/lib/aspera/cli/version.rb

@@ -1,5 +1,5 @@
 module Aspera
   module Cli
-    VERSION = "4.0.0.pre3"
+    VERSION = "4.0.0"
   end
 end

data/lib/aspera/fasp/installation.rb

@@ -54,7 +54,7 @@ module Aspera
           # add sdk as first search path
           @found_products.unshift({# SDK
             :expected =>'SDK',
-            :app_root =>self.folder_path,
+            :app_root =>folder_path,
             :sub_bin =>''
           })
           @found_products.select! do |pl|
@@ -89,19 +89,19 @@ module Aspera
           # note that there might be a .exe at the end
           file=file.gsub('ascp','ascp4') if k.eql?(:ascp4)
         when :ssh_bypass_key_dsa
-          file=File.join(self.folder_path,'aspera_bypass_dsa.pem')
+          file=File.join(folder_path,'aspera_bypass_dsa.pem')
           File.write(file,get_key('dsa',1)) unless File.exist?(file)
           File.chmod(0400,file)
         when :ssh_bypass_key_rsa
-          file=File.join(self.folder_path,'aspera_bypass_rsa.pem')
+          file=File.join(folder_path,'aspera_bypass_rsa.pem')
           File.write(file,get_key('rsa',2)) unless File.exist?(file)
           File.chmod(0400,file)
         when :aspera_license
-          file=File.join(self.folder_path,'aspera-license')
+          file=File.join(folder_path,'aspera-license')
           File.write(file,Base64.strict_encode64("#{Zlib::Inflate.inflate(DataRepository.instance.get_bin(6))}==SIGNATURE==\n#{Base64.strict_encode64(DataRepository.instance.get_bin(7))}")) unless File.exist?(file)
           File.chmod(0400,file)
         when :aspera_conf
-          file=File.join(self.folder_path,'aspera.conf')
+          file=File.join(folder_path,'aspera.conf')
           File.write(file,%Q{<?xml version='1.0' encoding='UTF-8'?>
 <CONF version="2">
 <default>
@@ -120,8 +120,8 @@ module Aspera
 }) unless File.exist?(file)
           File.chmod(0400,file)
         when :fallback_cert,:fallback_key
-          file_key=File.join(self.folder_path,'aspera_fallback_key.pem')
-          file_cert=File.join(self.folder_path,'aspera_fallback_cert.pem')
+          file_key=File.join(folder_path,'aspera_fallback_key.pem')
+          file_cert=File.join(folder_path,'aspera_fallback_cert.pem')
           if !File.exist?(file_key) or !File.exist?(file_cert)
             require 'openssl'
             # create new self signed certificate for http fallback
@@ -188,7 +188,7 @@ module Aspera
         Zip::File.open(sdk_zip_path) do |zip_file|
           zip_file.each do |entry|
             if entry.name.include?(filter) and !entry.name.end_with?('/')
-              archive_file=File.join(self.folder_path,File.basename(entry.name))
+              archive_file=File.join(folder_path,File.basename(entry.name))
               File.open(archive_file, 'wb') do |output_stream|
                 IO.copy_stream(entry.get_input_stream, output_stream)
               end
@@ -201,12 +201,13 @@ module Aspera
         end
         File.unlink(sdk_zip_path) rescue nil # Windows may give error
         ascp_version='n/a'
-        if !ascp_path.nil?
-          # get version from ascp, only after full extract, as windows requires SSL/TLS DLLs
-          m=%x{#{ascp_path} -A}.match(/ascp version (.*)/)
-          ascp_version=m[1] unless m.nil?
-          File.write(File.join(self.folder_path,PRODUCT_INFO),"<product><name>IBM Aspera SDK</name><version>#{ascp_version}</version></product>")
-        end
+        raise "error in sdk: no ascp included" if ascp_path.nil?
+        cmd_out=%x{#{ascp_path} -A}
+        raise "An error occured when testing ascp: #{cmd_out}" unless $? == 0
+        # get version from ascp, only after full extract, as windows requires DLLs (SSL/TLS/etc...)
+        m=cmd_out.match(/ascp version (.*)/)
+        ascp_version=m[1] unless m.nil?
+        File.write(File.join(folder_path,PRODUCT_INFO),"<product><name>IBM Aspera SDK</name><version>#{ascp_version}</version></product>")
         return ascp_version
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspera-cli
 version: !ruby/object:Gem::Version
-  version: 4.0.0.pre3
+  version: 4.0.0
 platform: ruby
 authors:
 - Laurent Martin
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-18 00:00:00.000000000 Z
+date: 2021-02-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: xml-simple
@@ -301,9 +301,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '2.4'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements:
 - IBM Aspera ascp installed for the user
 rubygems_version: 3.0.3