kanrisuru 0.8.16 → 0.8.17

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c2110c3bfef603ff4d09ade3a4fabf81b34e2f5ca51ff9f120d382963542f7f
-  data.tar.gz: 6ef4e848168e93b37a06e0d0cbfffd9138d979e125d7a151e77c594539aba85d
+  metadata.gz: 3fddbe577acc9083ead480c1c69dad8e74c3b00c6a66cd770655b626bf022cb7
+  data.tar.gz: dac3e1bfc3ddcb59eff30b620e080210f23e0a2586ab0b38031db01920504c90
 SHA512:
-  metadata.gz: 3444e7a640af911e1f0eb67181503e0b87677847adacd6c0bf3a45c13ce8c8287b2b17ad56ba36d4fe301fe3a19aaf5b17856d3f9bceb1175002ed199d1eb774
-  data.tar.gz: d5a76df5b4ffd4f7483c6953d5c36479755f30efb3e19c822f1df41e459e6213c555c64324f6412df2a9b1ac5a4f003d5e525110c9e6f8e92389d655666fd5d7
+  metadata.gz: 43537168eee374dbe372259ea263a139dd9999ad242666e1f036adecee96df6d1040e1a03cc083ca9e1ba6704c61d29c6146e97356951564927278f61e14762a
+  data.tar.gz: 45184c4eeafd9447b4e46f323a65d545f666eaeac33bd3e1e19f1d308fc1555ff6042850eecad47368ce5927fa8065b55e6cb141ca09731b3dd190f79fe0134a

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## Kanrisuru 0.8.16 (October 14, 20201)
+## Kanrisuru 0.8.17 (October 16 2021)
+* Add functional test cases for `transfer` module
+* Update wget command to accept hash for `headers` opt.
+
+## Kanrisuru 0.8.16 (October 14, 2021)
 * Add functional test cases for `stream` and `path` modules
 * Create `expect_command`  helper for quick testing on raw command result
 

data/lib/kanrisuru/core/disk.rb

@@ -23,7 +23,7 @@ module Kanrisuru
         :name, :label, :uuid, :type, :uuid_sub, :label_fatboot, :version, :usage,
         :part_uuid, :part_entry_scheme, :part_entry_uuid, :part_entry_type,
         :part_entry_number, :part_entry_offset, :part_entry_size, :part_entry_disk,
-        :minimum_io_size, :physical_sector_size, :logical_sector_size, 
+        :minimum_io_size, :physical_sector_size, :logical_sector_size
       )
 
       def du(opts = {})

data/lib/kanrisuru/core/transfer.rb

@@ -124,7 +124,6 @@ module Kanrisuru
         command.append_flag('--no-cookies', opts[:no_cookies])
         command.append_flag('--keep-session-cookies', opts[:keep_session_cookies])
         command.append_flag('--ignore-length', opts[:ignore_length])
-        command.append_arg('--header', opts[:header])
         command.append_arg('--max-redirect', opts[:max_redirect])
         command.append_arg('--proxy-user', opts[:proxy_user])
         command.append_arg('--proxy-password', opts[:proxy_password])
@@ -132,6 +131,18 @@ module Kanrisuru
         command.append_flag('--save-headers', opts[:save_headers])
         command.append_arg('--user-agent', opts[:user_agent])
 
+        headers = opts[:headers]
+        if Kanrisuru::Util.present?(headers)
+          if headers.instance_of?(Hash)
+            headers.each do |key, value|
+              header = "'#{key}: #{value}'"
+              command.append_arg('--header', header)
+            end
+          elsif headers.instance_of?(String)
+            command.append_arg('--header', headers)
+          end
+        end
+
         post_data = opts[:post_data]
 
         if Kanrisuru::Util.present?(post_data)

data/lib/kanrisuru/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Kanrisuru
-  VERSION = '0.8.16'
+  VERSION = '0.8.17'
 end

data/spec/functional/core/path_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe Kanrisuru::Core::Path do
   let(:host) do
     Kanrisuru::Remote::Host.new(
       host: 'localhost',
-      username: 'ubuntu', 
+      username: 'ubuntu',
       keys: ['id_rsa']
     )
   end
@@ -42,5 +42,4 @@ RSpec.describe Kanrisuru::Core::Path do
     expect_command(host.readlink('/etc/os-release', canonicalize_existing: true), 'readlink -e /etc/os-release')
     expect_command(host.readlink('/etc/os-release', canonicalize_missing: true), 'readlink -m /etc/os-release')
   end
-
 end

data/spec/functional/core/stat_spec.rb

@@ -8,19 +8,16 @@ RSpec.describe Kanrisuru::Core::Stat do
   let(:host) do
     Kanrisuru::Remote::Host.new(
       host: 'localhost',
-      username: 'ubuntu', 
+      username: 'ubuntu',
       keys: ['id_rsa']
     )
   end
 
   it 'prepares stat command' do
-    expect_command(host.stat('~/file1.txt'), 
-      'stat -c %A,%b,%D,%F,%g,%G,%h,%i,%n,%s,%u,%U,%x,%y,%z ~/file1.txt'
-    )
+    expect_command(host.stat('~/file1.txt'),
+                   'stat -c %A,%b,%D,%F,%g,%G,%h,%i,%n,%s,%u,%U,%x,%y,%z ~/file1.txt')
 
     expect_command(host.stat('~/file2.txt', follow: true),
-      'stat -L -c %A,%b,%D,%F,%g,%G,%h,%i,%n,%s,%u,%U,%x,%y,%z ~/file2.txt'
-    )
+                   'stat -L -c %A,%b,%D,%F,%g,%G,%h,%i,%n,%s,%u,%U,%x,%y,%z ~/file2.txt')
   end
-
 end

data/spec/functional/core/stream_spec.rb

@@ -8,7 +8,7 @@ RSpec.describe Kanrisuru::Core::Stream do
   let(:host) do
     Kanrisuru::Remote::Host.new(
       host: 'localhost',
-      username: 'ubuntu', 
+      username: 'ubuntu',
       keys: ['id_rsa']
     )
   end
@@ -26,13 +26,13 @@ RSpec.describe Kanrisuru::Core::Stream do
 
   it 'prepares tail command' do
     result = host.tail('/var/log/syslog')
-    expect_command(result, 'tail /var/log/syslog' )
+    expect_command(result, 'tail /var/log/syslog')
 
     result = host.tail('/var/log/syslog', bytes: 1024)
     expect_command(result, 'tail -c 1024 /var/log/syslog')
 
     result = host.tail('/var/log/syslog', lines: 50)
-    expect_command(result, 'tail -n 50 /var/log/syslog' )
+    expect_command(result, 'tail -n 50 /var/log/syslog')
   end
 
   it 'prepares read_file_chunk command' do
@@ -42,59 +42,59 @@ RSpec.describe Kanrisuru::Core::Stream do
     result = host.read_file_chunk('/var/log/apache2/access.log', 0, 0)
     expect_command(result, 'tail -n +0 /var/log/apache2/access.log | head -n 1')
 
-    expect {
+    expect do
       host.read_file_chunk('file.log', 10, '20')
-    }.to raise_error(ArgumentError)
+    end.to raise_error(ArgumentError)
 
-    expect {
+    expect do
       host.read_file_chunk('file.log', '10', 20)
-    }.to raise_error(ArgumentError)
+    end.to raise_error(ArgumentError)
 
-    expect {
+    expect do
       host.read_file_chunk('file.log', 10, 9)
-    }.to raise_error(ArgumentError)
+    end.to raise_error(ArgumentError)
 
-    expect {
+    expect do
       host.read_file_chunk('file.log', -1, 1)
-    }.to raise_error(ArgumentError)
+    end.to raise_error(ArgumentError)
 
-    expect {
+    expect do
       host.read_file_chunk('file.log', 10, -2)
-    }.to raise_error(ArgumentError)
+    end.to raise_error(ArgumentError)
   end
 
   it 'prepares sed command' do
-    result = host.sed("~/file.txt", 'Cat', 'Dog')
+    result = host.sed('~/file.txt', 'Cat', 'Dog')
     expect_command(result, "sed 's/Cat/Dog/g' '~/file.txt'")
 
-    result = host.sed("~/file.txt", 'Cat', 'Doggz', in_place: true, new_file: '~/file2.txt', mode: 'write') 
+    result = host.sed('~/file.txt', 'Cat', 'Doggz', in_place: true, new_file: '~/file2.txt', mode: 'write')
     expect_command(result, "sed -i 's/Cat/Doggz/g' '~/file.txt' > ~/file2.txt")
 
-    result = host.sed("~/file.txt", 'Cat', 'Dogo', regexp_extended: true, new_file: '~/file2.txt', mode: 'append')
+    result = host.sed('~/file.txt', 'Cat', 'Dogo', regexp_extended: true, new_file: '~/file2.txt', mode: 'append')
     expect_command(result, "sed -r 's/Cat/Dogo/g' '~/file.txt' >> ~/file2.txt")
   end
 
   it 'prepares echo command' do
-    expect_command(host.echo('Hello world') , "echo 'Hello world'")
-    expect_command(host.echo("Hello\\n world", backslash: true), "echo -e 'Hello\\n world'")
+    expect_command(host.echo('Hello world'), "echo 'Hello world'")
+    expect_command(host.echo('Hello\\n world', backslash: true), "echo -e 'Hello\\n world'")
 
     expect_command(host.echo('Hello world', new_file: '~/file1.txt', mode: 'write'),
       "echo 'Hello world' > ~/file1.txt")
-    expect_command(host.echo("Goodbye", new_file: '~/file1.txt', mode: 'append'), 
+    
+    expect_command(host.echo('Goodbye', new_file: '~/file1.txt', mode: 'append'),
       "echo 'Goodbye' >> ~/file1.txt")
   end
 
   it 'prepares cat command' do
     expect_command(host.cat('/etc/group'), 'cat /etc/group')
     expect_command(host.cat('/etc/group', show_all: true), 'cat -A /etc/group')
-    expect_command(host.cat('/etc/group', 
-      show_tabs: true, 
-      number: true, 
-      squeeze_blank: true, 
+    expect_command(host.cat('/etc/group',
+      show_tabs: true,
+      number: true,
+      squeeze_blank: true,
       show_nonprinting: true,
       show_ends: true,
-      number_nonblank: true
-    ), 'cat -T -n -s -v -E -b /etc/group')
+      number_nonblank: true), 'cat -T -n -s -v -E -b /etc/group')
 
     expect_command(host.cat(['~/file1.txt', '~/file2.txt', '~/file3.txt']),
       'cat ~/file1.txt ~/file2.txt ~/file3.txt')
@@ -105,5 +105,4 @@ RSpec.describe Kanrisuru::Core::Stream do
     expect_command(host.cat(['~/file1.txt', '~/file2.txt', '~/file3.txt'], mode: 'append', new_file: 'combined.txt'),
       'cat ~/file1.txt ~/file2.txt ~/file3.txt >> combined.txt')
   end
-
 end

data/spec/functional/core/transfer_spec.rb

@@ -0,0 +1,181 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+StubNetwork.stub!
+
+RSpec.describe Kanrisuru::Core::Stat do
+  let(:host) do
+    Kanrisuru::Remote::Host.new(
+      host: 'localhost',
+      username: 'ubuntu', 
+      keys: ['id_rsa']
+    )
+  end
+
+  it 'prepares wget command' do
+    url = 'https://rubygems.org'
+
+    expect_command(host.wget(url),
+      "wget #{url}"
+    )
+
+    ## Output options
+    expect_command(host.wget(url, 
+      quiet: true, verbose: false, log_file: '/var/log/wget.log'),
+      "wget --quiet --no-verbose --output-file /var/log/wget.log #{url}"
+    )
+
+    expect_command(host.wget(url, 
+      verbose: true, append_log_file: '/var/log/wget.log'),
+      "wget --verbose --append-output /var/log/wget.log #{url}"
+    )
+
+    ## Download options
+    expect_command(host.wget(url,
+        bind_address: '0.0.0.0', 
+        retries: 3, 
+        output_document: '/home/ubuntu/index.html',
+        no_clobber: true,
+        timeout: 30,
+        dns_timeout: 60,
+        connect_timeout: 60,
+        read_timeout: 15,
+        limit_rate: '120k',
+        wait: 5, 
+        waitretry: 15,
+        random_wait: true, 
+        no_proxy: true,
+        no_dns_cache: true
+      ),
+      "wget --bind-address 0.0.0.0 --tries 3 --output-document /home/ubuntu/index.html --no-clobber --timeout 30 --dns-timeout 60 --connect-timeout 60 --read-timeout 15 --limit-rate 120k --wait 5 --waitretry 15 --random-wait --no-proxy --no-dns-cache https://rubygems.org"
+    )
+
+    ## Other Options
+    expect_command(host.wget(url,
+        quota: 'inf',
+        family: 'inet',
+        restrict_file_names: ['unix', 'ascii', 'lowercase', 'uppercase'],
+        retry_connrefused: true,
+        user: 'admin',
+        password: 'admin',
+        no_iri: true,
+      ),
+      "wget --quota inf --restrict-file-names unix,ascii,lowercase,uppercase --inet4-only --retry-connrefused --user admin --password admin --no-iri #{url}"
+    )
+
+    ## Directories
+    expect_command(host.wget(url,
+        no_directories: true,
+        no_host_directories: true,
+        cut_dirs: 3,
+        directory_prefix: '~/downloads/'
+      ),
+    "wget --no-directories --no-host-directories --cut-dirs 3 --directory-prefix ~/downloads/ #{url}"
+    )
+
+    ## HTTP
+    expect_command(host.wget(url,
+        default_page: 'index.html',
+        adjust_extension: true,
+        http_user: 'admin',
+        http_password: 'admin',
+        load_cookies: '~/cookies.txt',
+        save_cookies: '~/cookies.txt',
+        no_cache: true,
+        keep_session_cookies: true,
+        ignore_length: true,
+        headers: {
+          'Accept-Language' => 'hr',
+          'Authorization' => 'Bearer 1234' 
+        },
+        max_redirect: 5,
+        proxy_user: 'admin',
+        proxy_password: '12345678'
+      ),
+      "wget --default-page index.html --adjust-extension --http-user admin --http-password admin --load-cookies ~/cookies.txt --save-cookies ~/cookies.txt --no-cache --keep-session-cookies --ignore-length --max-redirect 5 --proxy-user admin --proxy-password 12345678 --header 'Accept-Language: hr' --header 'Authorization: Bearer 1234' #{url}"
+    )
+
+    expect_command(host.wget(url,
+        post_data: {
+          url: "https://example.com?param=123"
+        },
+        content_disposition: true,
+        secure_protocol: 'SSLv3',
+        no_check_certificate: true,
+      ),
+      "wget --post-data url=https%3A%2F%2Fexample.com%3Fparam%3D123 --content-disposition --secure-protocol SSLv3 --no-check-certificate #{url}"
+    )
+
+    expect {
+      host.wget(url, secure_protocol: 'SSL')
+    }.to raise_error(ArgumentError)
+
+    expect_command(host.wget(url,
+        certificate: '~/cert.pem',
+        certificate_type: 'PEM',
+        private_key: '~/key.pem',
+        private_key_type: 'PEM',
+        ca_certificate: '~/ca.pem',
+        random_file: '~/random'
+      ),
+      "wget --certificate ~/cert.pem --certificate-type PEM --private-key ~/key.pem --private-key-type PEM --ca-certificate ~/ca.pem --random-file ~/random #{url}"
+    )
+
+    expect_command(host.wget(url,
+        certificate: '~/cert.pem',
+        certificate_type: 'PEM',
+        private_key: '~/key.pem',
+        private_key_type: 'PEM',
+        ca_certificate: '~/ca.pem',
+        random_file: '~/random'
+      ),
+      "wget --certificate ~/cert.pem --certificate-type PEM --private-key ~/key.pem --private-key-type PEM --ca-certificate ~/ca.pem --random-file ~/random #{url}"
+    )
+
+    ## FTP
+    expect_command(host.wget(url, 
+        ftp_user: 'admin',
+        ftp_password: '12345678',
+        no_remove_listing: true,
+        no_glob: true,
+        no_passive_ftp: true,
+        retr_symlinks: true
+      ),
+      "wget --ftp-user admin --ftp-password 12345678 --no-remove-listing --no-glob --no-passive-ftp --retr-symlinks #{url}"
+    )
+
+    ## Recursive Retrieval
+    expect_command(host.wget(url,
+        recursive: true,
+        depth: 10,
+        delete_after: true,
+        convert_links: true,
+        backup_converted: true,
+        mirror: true,
+        page_requisites: true,
+        strict_comments: true
+      ),
+      "wget --recursive --level 10 --delete-after --convert-links --backup-converted --mirror --page-requisites --strict-comments #{url}"
+    )
+
+    ## Recursive Accept/Reject
+    expect_command(host.wget(url,
+        accept_list: ['.txt', '.html'],
+        reject_list: ['.csv'],
+        domain_list: ['example.com'],
+        exclude_domain_list: ['hackernews.com'],
+        follow_tags: ['a', 'div', 'span'],
+        ignore_tags: ['area', 'link'],
+        include_directories: ['/gems'],
+        exclude_directories: ['/releases'],
+        follow_ftp: true,
+        ignore_case: true,
+        span_hosts: true,
+        relative: true,
+        no_parent: true
+      ),
+      "wget --accept .txt,.html --reject .csv --domains example.com --exclude-domains hackernews.com --follow-tags a,div,span --ignore-tags area,link --include-directories /gems --exclude-directories /releases --follow-ftp --ignore-case --span-hosts --relative --no-parent #{url}"
+    )
+  end
+end

data/spec/helper/expect_helpers.rb

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 def expect_command(result, string)
+  puts result.command.raw_command
   expect(result.command.raw_command).to eq(
     string
   )
-end
+end

data/spec/helper/stub_network.rb

@@ -2,15 +2,14 @@
 
 class StubNetwork
   class << self
-
     def stub!
-      ## Stub out the execute_with_retries method to 
-      ## test functionality of host commands 
+      ## Stub out the execute_with_retries method to
+      ## test functionality of host commands
       Kanrisuru::Remote::Host.class_eval do
         private
 
         def execute_with_retries(command)
-          command.handle_status(0) 
+          command.handle_status(0)
           command.handle_data(nil)
 
           command
@@ -24,22 +23,21 @@ class StubNetwork
           @kernel_name       = 'Linux'
           @kernel_version    = '#91-Ubuntu SMP Thu Jul 15 19:09:17 UTC 2021'
           @operating_system  = 'GNU/Linux'
-          @hardware_platform = "x86_64"
-          @processor         = "x86_64"
-          @release           = "ubuntu"
+          @hardware_platform = 'x86_64'
+          @processor         = 'x86_64'
+          @release           = 'ubuntu'
           @version           = 20.0
         end
       end
 
       Kanrisuru::Result.class_eval do
-        def initialize(command, &block)
+        def initialize(command)
           @command = command
           @data = nil
 
           @error = @command.to_a if @command.failure?
         end
       end
-    end 
-
+    end
   end
 end

data/spec/integration/core/disk_spec.rb

@@ -41,7 +41,7 @@ RSpec.describe Kanrisuru::Core::Disk do
           :name, :label, :uuid, :type, :uuid_sub, :label_fatboot, :version, :usage,
           :part_uuid, :part_entry_scheme, :part_entry_uuid, :part_entry_type,
           :part_entry_number, :part_entry_offset, :part_entry_size, :part_entry_disk,
-          :minimum_io_size, :physical_sector_size, :logical_sector_size,
+          :minimum_io_size, :physical_sector_size, :logical_sector_size
         )
       end
 

data/spec/integration/core/file_spec.rb

@@ -41,7 +41,10 @@ RSpec.describe Kanrisuru::Core::File do
         )
 
         host.rm("#{host_json['home']}/.kanrisuru_spec_files", force: true, recursive: true)
-        host.rm("#{host_json['home']}/extract-tar-files", force: true, recursive: true) if host.dir?("#{host_json['home']}/extract-tar-files")
+        if host.dir?("#{host_json['home']}/extract-tar-files")
+          host.rm("#{host_json['home']}/extract-tar-files", force: true,
+                                                            recursive: true)
+        end
         host.disconnect
       end
 
@@ -68,9 +71,9 @@ RSpec.describe Kanrisuru::Core::File do
         expect(mode.symbolic).to eq('-rwxr--r--')
         expect(mode.to_i).to eq(0o744)
 
-        expect {
+        expect do
           host.chmod(path, 600)
-        }.to raise_error(ArgumentError)
+        end.to raise_error(ArgumentError)
       end
 
       it 'changes file owner and group' do
@@ -338,7 +341,7 @@ RSpec.describe Kanrisuru::Core::File do
         ## Can't delete non empty dir
         result = host.rmdir("#{spec_dir}/directory")
         expect(result).to be_failure
-       
+
         result = host.rmdir("#{spec_dir}/directory/3")
         expect(result).to be_success
       end
@@ -355,7 +358,7 @@ RSpec.describe Kanrisuru::Core::File do
 
         lines = doc.length
         words = doc.map(&:split).flatten
-        chars = doc.map(&:length).flatten 
+        chars = doc.map(&:length).flatten
 
         expect(result.lines).to eq(doc.length)
         expect(result.words).to eq(words.length)

data/spec/spec_helper.rb

@@ -21,4 +21,4 @@ RSpec.configure do |config|
   config.expect_with :rspec do |c|
     c.syntax = :expect
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: kanrisuru
 version: !ruby/object:Gem::Version
-  version: 0.8.16
+  version: 0.8.17
 platform: ruby
 authors:
 - Ryan Mammina
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-10-14 00:00:00.000000000 Z
+date: 2021-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -176,6 +176,7 @@ files:
 - spec/functional/core/path_spec.rb
 - spec/functional/core/stat_spec.rb
 - spec/functional/core/stream_spec.rb
+- spec/functional/core/transfer_spec.rb
 - spec/functional/os_package_spec.rb
 - spec/helper/expect_helpers.rb
 - spec/helper/stub_network.rb