aspera-cli 4.0.0.pre1

data/lib/aspera/ssh.rb

@@ -0,0 +1,53 @@
+require 'net/ssh'
+
+# Hack: deactivate ed25519 and ecdsa private keys from ssh identities, as it usually hurts
+begin
+module Net; module SSH; module Authentication; class Session; private def default_keys; %w(~/.ssh/id_dsa ~/.ssh/id_rsa ~/.ssh2/id_dsa ~/.ssh2/id_rsa);end;end;end;end;end
+rescue
+end
+
+module Aspera
+  # A simple wrapper around Net::SSH
+  # executes one command and get its result from stdout
+  class Ssh
+    # ssh_options: same as Net::SSH.start
+    # see: https://net-ssh.github.io/net-ssh/classes/Net/SSH.html#method-c-start
+    def initialize(host,username,ssh_options)
+      Log.log.debug("ssh:#{username}@#{host}")
+      @host=host
+      @username=username
+      @ssh_options=ssh_options
+      @ssh_options[:logger]=Log.log
+    end
+
+    def execute(cmd,input=nil)
+      if cmd.is_a?(Array)
+        # concatenate arguments, enclose in double quotes
+        cmd=cmd.map{|v|'"'+v+'"'}.join(" ")
+      end
+      Log.log.debug("cmd=#{cmd}")
+      response = ''
+      Net::SSH.start(@host, @username, @ssh_options) do |session|
+        ssh_channel=session.open_channel do |channel|
+          # prepare stdout processing
+          channel.on_data{|chan,data|response << data}
+          # prepare stderr processing, stderr if type = 1
+          channel.on_extended_data do |chan, type, data|
+            errormsg="#{cmd}: [#{data.chomp}]"
+            # Happens when windows user hasn't logged in and created home account.
+            if data.include?("Could not chdir to home directory")
+              errormsg=errormsg+"\nHint: home not created in Windows?"
+            end
+            raise errormsg
+          end
+          channel.exec(cmd){|ch,success|channel.send_data(input) unless input.nil?}
+        end
+        # wait for channel to finish (command exit)
+        ssh_channel.wait
+        # main ssh session loop
+        session.loop
+      end # session
+      return response
+    end
+  end
+end

data/lib/aspera/sync.rb

@@ -0,0 +1,82 @@
+module Aspera
+  # builds command line arg for async
+  class Sync
+    private
+    INSTANCE_PARAMS=
+    {
+      'alt_logdir'           => { :type => :opt_with_arg, :accepted_types=>String},
+      'watchd'               => { :type => :opt_with_arg, :accepted_types=>String},
+      'apply_local_docroot'  => { :type => :opt_without_arg},
+      'quiet'                => { :type => :opt_without_arg},
+    }
+    SESSION_PARAMS=
+    {
+      'name'                 => { :type => :opt_with_arg, :accepted_types=>String},
+      'local_dir'            => { :type => :opt_with_arg, :accepted_types=>String},
+      'remote_dir'           => { :type => :opt_with_arg, :accepted_types=>String},
+      'local_db_dir'         => { :type => :opt_with_arg, :accepted_types=>String},
+      'remote_db_dir'        => { :type => :opt_with_arg, :accepted_types=>String},
+      'host'                 => { :type => :opt_with_arg, :accepted_types=>String},
+      'user'                 => { :type => :opt_with_arg, :accepted_types=>String},
+      'private_key_path'     => { :type => :opt_with_arg, :accepted_types=>String},
+      'direction'            => { :type => :opt_with_arg, :accepted_types=>String},
+      'checksum'             => { :type => :opt_with_arg, :accepted_types=>String},
+      'tcp_port'             => { :type => :opt_with_arg, :accepted_types=>Integer},
+      'rate_policy'          => { :type => :opt_with_arg, :accepted_types=>String},
+      'target_rate'          => { :type => :opt_with_arg, :accepted_types=>String},
+      'cooloff'              => { :type => :opt_with_arg, :accepted_types=>Integer},
+      'pending_max'          => { :type => :opt_with_arg, :accepted_types=>Integer},
+      'scan_intensity'       => { :type => :opt_with_arg, :accepted_types=>String},
+      'cipher'               => { :type => :opt_with_arg, :accepted_types=>String},
+      'transfer_threads'     => { :type => :opt_with_arg, :accepted_types=>Integer},
+      'preserve_time'        => { :type => :opt_without_arg},
+      'preserve_access_time' => { :type => :opt_without_arg},
+      'preserve_modification_time' => { :type => :opt_without_arg},
+      'preserve_uid'         => { :type => :opt_without_arg},
+      'preserve_gid'         => { :type => :opt_without_arg},
+      'create_dir'           => { :type => :opt_without_arg},
+      'reset'                => { :type => :opt_without_arg},
+      # note: only one env var, but multiple sessions... may be a problem
+      'remote_password'      => { :type => :envvar, :variable=>'ASPERA_SCP_PASS'},
+      'cookie'               => { :type => :envvar, :variable=>'ASPERA_SCP_COOKIE'},
+      'token'                => { :type => :envvar, :variable=>'ASPERA_SCP_TOKEN'},
+      'license'              => { :type => :envvar, :variable=>'ASPERA_SCP_LICENSE'},
+    }
+    public
+
+    def initialize(sync_params)
+      @sync_params=sync_params
+    end
+
+    MANDATORY_KEYS=['instance','sessions']
+
+    def compute_args
+      raise StandardError,"parameter must be Hash" unless @sync_params.is_a?(Hash)
+      raise StandardError,"parameter hash must have at least 'sessions', and optionally 'instance' keys." unless @sync_params.keys.push('instance').uniq.sort.eql?(MANDATORY_KEYS)
+      raise StandardError,"sessions key must be Array" unless @sync_params['sessions'].is_a?(Array)
+      raise StandardError,"sessions key must has at least one element (hash)" unless @sync_params['sessions'].first.is_a?(Hash)
+
+      env_args={
+        :args=>[],
+        :env=>{}
+      }
+
+      if @sync_params.has_key?('instance')
+        raise StandardError,"instance key must be hash" unless @sync_params['instance'].is_a?(Hash)
+        instance_builder=CommandLineBuilder.new(@sync_params['instance'],INSTANCE_PARAMS)
+        instance_builder.process_params
+        instance_builder.add_env_args(env_args[:env],env_args[:args])
+      end
+
+      @sync_params['sessions'].each do |session_params|
+        raise StandardError,"sessions must contain hashes" unless session_params.is_a?(Hash)
+        raise StandardError,"session must contain at leat name" unless session_params.has_key?('name')
+        session_builder=CommandLineBuilder.new(session_params,SESSION_PARAMS)
+        session_builder.process_params
+        session_builder.add_env_args(env_args[:env],env_args[:args])
+      end
+
+      return env_args
+    end
+  end
+end

data/lib/aspera/temp_file_manager.rb

@@ -0,0 +1,37 @@
+require 'singleton'
+require 'fileutils'
+require 'etc'
+
+module Aspera
+  # create a temp file name for a given folder
+  # files can be deleted on process exit by calling cleanup
+  class TempFileManager
+    include Singleton
+    def initialize
+      @created_files=[]
+    end
+
+    # call this on process exit
+    def cleanup
+      @created_files.each do |filepath|
+        File.delete(filepath) if File.file?(filepath)
+      end
+      @created_files=[]
+    end
+
+    # ensure that provided folder exists, or create it, generate a unique filename
+    # @return path to that unique file
+    def new_file_path_in_folder(temp_folder,add_base='')
+      FileUtils::mkdir_p(temp_folder) unless Dir.exist?(temp_folder)
+      new_file=File.join(temp_folder,add_base+SecureRandom.uuid)
+      @created_files.push(new_file)
+      return new_file
+    end
+
+    # same as above but in global temp folder
+    def new_file_path_global(base_name)
+      username = Etc.getlogin || Etc.getpwuid(Process.uid).name || 'unknown_user' rescue 'unknown_user'
+      return new_file_path_in_folder(Etc.systmpdir,base_name+'_'+username+'_')
+    end
+  end
+end

data/lib/aspera/uri_reader.rb

@@ -0,0 +1,25 @@
+require 'uri'
+require 'net/http'
+require 'net/https'
+
+module Aspera
+  module UriReader
+    # read some content from some URI, support file: , http: and https: schemes
+    def self.read(proxy_pac_uri)
+      proxy_uri=URI.parse(proxy_pac_uri)
+      if proxy_uri.scheme.eql?('http')
+        return Net::HTTP.start(proxy_uri.host, proxy_uri.port){|http|http.get(proxy_uri.path)}.body
+      elsif proxy_uri.scheme.eql?('https')
+        return Net::HTTPS.start(proxy_uri.host, proxy_uri.port){|http|http.get(proxy_uri.path)}.body
+      elsif proxy_uri.scheme.eql?('file')
+        local_file_path=proxy_uri.path
+        raise "URL shall have a path, check syntax" if local_file_path.nil?
+        local_file_path=File.expand_path(local_file_path.gsub(/^\//,'')) if local_file_path.match(/^\/(~|.|..)\//)
+        return File.read(local_file_path)
+      elsif proxy_uri.scheme.eql?('')
+        return File.read(proxy_uri)
+      end
+      raise "no scheme: [#{proxy_uri.scheme}] for [#{proxy_pac_uri}]"
+    end
+  end
+end

metadata

@@ -0,0 +1,288 @@
+--- !ruby/object:Gem::Specification
+name: aspera-cli
+version: !ruby/object:Gem::Version
+  version: 4.0.0.pre1
+platform: ruby
+authors:
+- Laurent Martin
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+- !ruby/object:Gem::Dependency
+  name: ruby-progressbar
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+- !ruby/object:Gem::Dependency
+  name: execjs
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: terminal-table
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: tty-spinner
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A powerful CLI for IBM Aspera products
+email:
+- laurent.martin.aspera@fr.ibm.com
+executables:
+- ascli
+- asession
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- bin/ascli
+- bin/asession
+- docs/Makefile
+- docs/README.erb.md
+- docs/README.md
+- docs/diagrams.txt
+- docs/secrets.make
+- docs/test_env.conf
+- docs/transfer_spec.html
+- examples/aoc.rb
+- examples/proxy.pac
+- examples/transfer.rb
+- lib/aspera/api_detector.rb
+- lib/aspera/ascmd.rb
+- lib/aspera/ats_api.rb
+- lib/aspera/cli/basic_auth_plugin.rb
+- lib/aspera/cli/extended_value.rb
+- lib/aspera/cli/formater.rb
+- lib/aspera/cli/listener/line_dump.rb
+- lib/aspera/cli/listener/logger.rb
+- lib/aspera/cli/listener/progress.rb
+- lib/aspera/cli/listener/progress_multi.rb
+- lib/aspera/cli/main.rb
+- lib/aspera/cli/manager.rb
+- lib/aspera/cli/plugin.rb
+- lib/aspera/cli/plugins/alee.rb
+- lib/aspera/cli/plugins/ats.rb
+- lib/aspera/cli/plugins/bss.rb
+- lib/aspera/cli/plugins/config.rb
+- lib/aspera/cli/plugins/console.rb
+- lib/aspera/cli/plugins/cos.rb
+- lib/aspera/cli/plugins/faspex.rb
+- lib/aspera/cli/plugins/faspex5.rb
+- lib/aspera/cli/plugins/node.rb
+- lib/aspera/cli/plugins/oncloud.rb
+- lib/aspera/cli/plugins/orchestrator.rb
+- lib/aspera/cli/plugins/preview.rb
+- lib/aspera/cli/plugins/server.rb
+- lib/aspera/cli/plugins/shares.rb
+- lib/aspera/cli/plugins/shares2.rb
+- lib/aspera/cli/plugins/sync.rb
+- lib/aspera/cli/plugins/xnode.rb
+- lib/aspera/cli/transfer_agent.rb
+- lib/aspera/cli/version.rb
+- lib/aspera/colors.rb
+- lib/aspera/command_line_builder.rb
+- lib/aspera/fasp/aoc.rb
+- lib/aspera/fasp/connect.rb
+- lib/aspera/fasp/error.rb
+- lib/aspera/fasp/error_info.rb
+- lib/aspera/fasp/http_gw.rb
+- lib/aspera/fasp/installation.rb
+- lib/aspera/fasp/listener.rb
+- lib/aspera/fasp/local.rb
+- lib/aspera/fasp/manager.rb
+- lib/aspera/fasp/node.rb
+- lib/aspera/fasp/parameters.rb
+- lib/aspera/fasp/resume_policy.rb
+- lib/aspera/fasp/uri.rb
+- lib/aspera/faspex_gw.rb
+- lib/aspera/hash_ext.rb
+- lib/aspera/log.rb
+- lib/aspera/nagios.rb
+- lib/aspera/node.rb
+- lib/aspera/oauth.rb
+- lib/aspera/on_cloud.rb
+- lib/aspera/open_application.rb
+- lib/aspera/persistency_action_once.rb
+- lib/aspera/persistency_folder.rb
+- lib/aspera/preview/file_types.rb
+- lib/aspera/preview/generator.rb
+- lib/aspera/preview/image_error.png
+- lib/aspera/preview/options.rb
+- lib/aspera/preview/utils.rb
+- lib/aspera/preview/video_error.png
+- lib/aspera/proxy_auto_config.erb.js
+- lib/aspera/proxy_auto_config.rb
+- lib/aspera/rest.rb
+- lib/aspera/rest_call_error.rb
+- lib/aspera/rest_error_analyzer.rb
+- lib/aspera/rest_errors_aspera.rb
+- lib/aspera/ssh.rb
+- lib/aspera/sync.rb
+- lib/aspera/temp_file_manager.rb
+- lib/aspera/uri_reader.rb
+homepage: https://github.com/IBM/aspera-cli
+licenses:
+- Apache-2.0
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements:
+- IBM Aspera ascp installed for the user
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: 'Command line tool for Aspera Server products: Aspera on Cloud, Faspex, Shares,
+  Node, Console, Orchestrator, Transfer Server'
+test_files: []