aspera-cli 4.5.0 → 4.8.0

data/docs/README.md

@@ -1,13 +0,0 @@
-docs/README.erb.md uses markdown format with embeded ruby macros (erb)
-
-/README.md is generated after compilation of README.erb.md
-
-docs/README.erb.md contains the following macros:
-
-* `<%=cmd%>` just the command line tool name
-* `<%=tool%>` the tool name in courrier to be included in text paragraphs
-* `<%=evp%>` env var prefix
-* `<%=opprst%>` option preset
-* `<%=prst%>` link to preset section, name and link to preset
-* `<%=prstt%>` preset in title
-

data/docs/diagrams.txt

@@ -1,49 +0,0 @@
-
-The following section contains the diagrams posted on support KB.
-mde with:  https://www.websequencediagrams.com/
-
-
--=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
-title general Aspera Files APIs use
-Client->+Files API: GET authorization(parameters)
-Files API-->-Client: Result=Bearer token
-Client-->Files API: use APIs with Authorization=Bearer
-
-
--=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
-title basic OAuth with grant_type=password (username/password, only local users, not google, SAML)
-Client->+Files API: GET authorization(username/password)
-Files API-->-Client: Result=Bearer token
-Client-->Files API: use APIs with Authorization=Bearer
-
-
--=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-=-
-title OAuth with grant_type=code (any user: local users, google, SAML)
-note right of Client
-    * Client is registered in "Files", with redirect_uri
-    * Files generates client_id and secret
-    * Listen on "redirect_uri" end point (TCP port)
-    * build "login address" for user:
-    api.asperafiles.com/oauth2/<org>/authorize
-    * open a browser for user with this URL
-end note
-Client->*Local Port: listen
-Client->Browser: open login url in browser (give redirect_uri and scope)
-Browser->Files: load login page
-note right of Browser: user clicks on "google auth"
-Browser->+Google: display google login page
-note right of Browser: user authenticates
-Google-->-Browser: browser is redirected to the "redirect URI" providing a "code"
-Browser->Local Port: browser provides code to client
-Local Port-->Client: read code
-Client->Local Port: close
-destroy Local Port
-note right of Client: close listening port after use
-Client->+Files: GET oauth/token(grant_type=code)
-Files-->-Client: Bearer token
-Client-->Files API: use APIs with Authorization=Bearer
-
-
-
-
-

data/docs/doc_tools.rb

@@ -1,58 +0,0 @@
-# get transfer spec parameter description
-$LOAD_PATH.unshift(ENV["INCL_DIR_GEM"])
-require 'aspera/fasp/parameters'
-
-# check that required env vars exist, and files
-%w{EXENAME GEMSPEC INCL_USAGE INCL_COMMANDS INCL_ASESSION INCL_DIR_GEM}.each do |e|
-  raise "missing env var #{e}" unless ENV.has_key?(e)
-  raise "missing file #{ENV[e]}" unless File.exist?(ENV[e]) or !e.start_with?('INCL_')
-end
-
-# set values used in ERB
-# just command name
-def cmd;ENV['EXENAME'];end
-
-# used in text with formatting of command
-def tool;'`'+cmd+'`';end
-
-# prefix for env vars
-def evp;cmd.upcase+'_';end
-
-# just the name for "option preset"
-def opprst;'option preset';end
-
-# name with link
-def prst;'['+opprst+'](#lprt)';end
-
-# name with link (plural)
-def prsts;'['+opprst+'s](#lprt)';end
-
-# in title
-def prstt;opprst.capitalize;end
-
-def gemspec;Gem::Specification::load(ENV['GEMSPEC']) or raise "error loading #{ENV["GEMSPEC"]}";end
-
-def geminstadd;gemspec.version.to_s.match(/\.[^0-9]/)?' --pre':'';end
-
-# transfer spec description generation
-def spec_table
-  r='<table><tr><th>Field</th><th>Type</th>'
-  Aspera::Fasp::Parameters::SUPPORTED_AGENTS_SHORT.each do |c|
-    r << '<th>'<<c.to_s.upcase<<'</th>'
-  end
-  r << '<th>Description</th></tr>'
-  Aspera::Fasp::Parameters.man_table.each do |p|
-    p[:description] << (p[:description].empty? ? '' : "\n") << "(" << p[:cli] << ")" unless p[:cli].to_s.empty?
-    p.delete(:cli)
-    p.keys.each{|c|p[c]='&nbsp;' if p[c].to_s.empty?}
-    p[:description].gsub!("\n",'<br/>')
-    p[:type].gsub!(',','<br/>')
-    r << '<tr><td>'<<p[:name]<<'</td><td>'<<p[:type]<<'</td>'
-    Aspera::Fasp::Parameters::SUPPORTED_AGENTS_SHORT.each do |c|
-      r << '<td>'<<p[c]<<'</td>'
-    end
-    r << '<td>'<<p[:description]<<'</td></tr>'
-  end
-  r << '</table>'
-  return r
-end

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

@@ -1,114 +0,0 @@
-require 'aspera/cli/plugins/node'
-require 'uri'
-
-module Aspera
-  module Cli
-    module Plugins
-      class Shares2 < BasicAuthPlugin
-        def initialize(env)
-          super(env)
-          self.options.add_opt_simple(:organization,"organization")
-          self.options.add_opt_simple(:project,"project")
-          self.options.add_opt_simple(:share,"share")
-          self.options.parse_options!
-          return if env[:man_only]
-          unless env[:man_only]
-            # get parameters
-            shares2_api_base_url=self.options.get_option(:url,:mandatory)
-            shares2_username=self.options.get_option(:username,:mandatory)
-            shares2_password=self.options.get_option(:password,:mandatory)
-
-            # create object for REST calls to Shares2
-            @api_shares2_oauth=Rest.new({
-              :base_url => shares2_api_base_url,
-              :auth     => {
-              :type      => :oauth2,
-              :base_url  => shares2_api_base_url+'/oauth2',
-              :grant     => :header_userpass,
-              :user_name => shares2_username,
-              :user_pass => shares2_password
-              }})
-
-            @api_node=Rest.new({
-              :base_url => shares2_api_base_url+'/node_api',
-              :auth     => {
-              :type     => :basic,
-              :username => shares2_username,
-              :password => shares2_password}})
-          end
-        end
-
-        # path_prefix is either "" or "res/id/"
-        # adds : prefix+"res/id/"
-        # modify parameter string
-        def set_resource_path_by_id_or_name(resource_path,resource_sym)
-          res_id=self.options.get_option(resource_sym,:mandatory)
-          # lets get the class path
-          resource_path<<resource_sym.to_s+'s'
-          # is this an integer ? or a name
-          if res_id.to_i.to_s != res_id
-            all=@api_shares2_oauth.read(resource_path)[:data]
-            one=all.select{|i|i['name'].start_with?(res_id)}
-            Log.log.debug(one)
-            raise CliBadArgument,"No matching name for #{res_id} in #{all}" if one.empty?
-            raise CliBadArgument,"More than one match: #{one}" if one.length > 1
-            res_id=one.first['id'].to_s
-          end
-          Log.log.debug("res_id=#{res_id}")
-          resource_path<<'/'+res_id+'/'
-          return resource_path
-        end
-
-        # path_prefix is empty or ends with slash
-        def process_entity_action(resource_sym,path_prefix)
-          resource_path=path_prefix+resource_sym.to_s+'s'
-          operations=[:list,:create,:delete]
-          command=self.options.get_next_command(operations)
-          case command
-          when :create
-            params=self.options.get_next_argument("creation data (json structure)")
-            resp=@api_shares2_oauth.create(resource_path,params)
-            return {:data=>resp[:data],:type => :other_struct}
-          when :list
-            default_fields=['id','name']
-            query=self.options.get_option(:query,:optional)
-            args=query.nil? ? nil : {'json_query'=>query}
-            Log.log.debug("#{args}".bg_red)
-            return {:data=>@api_shares2_oauth.read(resource_path,args)[:data],:fields=>default_fields,:type=>:object_list}
-          when :delete
-            @api_shares2_oauth.delete(set_resource_path_by_id_or_name(path_prefix,resource_sym))
-            return Main.result_status('deleted')
-          when :info
-            return {:type=>:other_struct,:data=>@api_shares2_oauth.read(set_resource_path_by_id_or_name(path_prefix,resource_sym),args)[:data]}
-          else raise :ERROR
-          end
-        end
-
-        ACTIONS=[ :repository,:organization,:project,:team,:share,:appinfo,:userinfo,:admin]
-
-        def execute_action
-          command=self.options.get_next_command(ACTIONS)
-          case command
-          when :repository
-            command=self.options.get_next_command(Node::COMMON_ACTIONS)
-            return Node.new(@agents.merge(skip_basic_auth_options: true, node_api: @api_node)).execute_action(command)
-          when :appinfo
-            node_info=@api_node.call({:operation=>'GET',:subpath=>'app',:headers=>{'Accept'=>'application/json','Content-Type'=>'application/json'}})[:data]
-            return { :type=>:single_object ,:data => node_info }
-          when :userinfo
-            node_info=@api_node.call({:operation=>'GET',:subpath=>'current_user',:headers=>{'Accept'=>'application/json','Content-Type'=>'application/json'}})[:data]
-            return { :type=>:single_object ,:data => node_info }
-          when :organization,:project,:share,:team
-            prefix=''
-            set_resource_path_by_id_or_name(prefix,:organization) if [:project,:team,:share].include?(command)
-            set_resource_path_by_id_or_name(prefix,:project) if [:share].include?(command)
-            process_entity_action(command,prefix)
-          when :admin
-            command=self.options.get_next_command([:users,:groups,:nodes])
-            return self.entity_action(@api_shares2_oauth,"system/#{command}",nil,:id)
-          end # command
-        end # execute_action
-      end # Files
-    end # Plugins
-  end # Cli
-end # Aspera

data/lib/aspera/fasp/default.rb

@@ -1,17 +0,0 @@
-module Aspera
-  module Fasp
-    # default parameters
-    class Default
-      # (public) default transfer username for access key based transfers
-      ACCESS_KEY_TRANSFER_USER='xfer'
-      SSH_PORT=33001
-      UDP_PORT=33001
-      AK_TSPEC_BASE={
-        'remote_user' => ACCESS_KEY_TRANSFER_USER,
-        'ssh_port'    => SSH_PORT,
-        'fasp_port'   => UDP_PORT
-      }
-    end
-  end
-end
-