net-scp 4.2.0 → 4.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b8d6b4ea9428a9cc3df98e388eb80ce0a6dd45021bad757992537f24dc954d38
-  data.tar.gz: 72ada8e9dc44cf7d7ffad414ccf8dfa90f1f3f875e83400acc6293e9523d8b03
+  metadata.gz: ee8ac18a34abb6482265e9cef492d7a2988d821feeda9bd25b13158ae9676987
+  data.tar.gz: b35016e03ea18a6a707e6c9f0236930db49fe6ba33e2e675b910b6913f525419
 SHA512:
-  metadata.gz: 76879f624878414b25e51abe5cfc88d078a99db6750b3b7c816454cae23c4d1d988201dd56af3ac3df21ac7b9c575a160c9eca44ccb731bfa332a6c3fe43651a
-  data.tar.gz: 41880eab49fcce9ae5e1f251f2360843941598b96496d26b33770449d53bf1b2ea15ef706af37d5af83370c57e0c878815d523eca2b974274dce43288953e318
+  metadata.gz: d3a721c9a2310e338dc12f6f06bc712a3b0961f3236de4f69584541c04b2b4b83caf26954b104b8b4a834a93e8e5a4e50167057d7d9d238455d2012f6754ada6
+  data.tar.gz: aa7d1a69eeb9d67f622ca4af00576c91938bc39c68ce23e57a70b7ff2f156ec3337ecbc0c6fa4edf52780ce1a0ea95e8090e1fd53a23be42e46e86b675dcf8b2

data/CHANGES.txt

@@ -1,3 +1,7 @@
+=== 4.2.1
+
+* Add a `:limit` option to `upload`/`download` to cap bandwidth in Kbit/s, like `scp -l`. Based on #53 by @marcelrouw [#119, #53]
+
 === 4.2.0
 
 * BREAKING: Require Ruby 2.6 or later. Bundler on Ruby 2.3-2.5 resolves to 4.1.3. [#114]

data/README.md

@@ -47,6 +47,11 @@ Net::SCP.download!("remote.host.com", "username",
   "/remote/path", "/local/path",
   :ssh => { :password => "password" })
 
+# download with the bandwidth limited to 400 Kbit/s, like `scp -l 400`
+Net::SCP.download!("remote.host.com", "username",
+  "/remote/path", "/local/path",
+  :ssh => { :password => "password" }, :limit => 400)
+
 # download a file to an in-memory buffer
 data = Net::SCP::download!("remote.host.com", "username", "/remote/path")
 

data/lib/net/scp/version.rb

@@ -52,7 +52,7 @@ module Net
       MINOR = 2
 
       # The tiny component of this version of the Net::SSH library
-      TINY  = 0
+      TINY  = 1
 
       # The prerelease component of this version of the Net::SSH library
       # nil allowed

data/lib/net/scp.rb

@@ -94,6 +94,7 @@ module Net
   #   be sent to indicate the modification and access times of each file.
   # * "-r" -- recursive transfers should be allowed. Without this, it is an
   #   error to upload or download a directory.
+  # * "-l" -- limit the bandwidth used by the transfer, in Kbit/s.
   #
   # After those flags, the name of the remote file/directory should be passed
   # as the sole non-switch argument to scp.
@@ -267,6 +268,8 @@ module Net
     # * :chunk_size - the size of each "chunk" that should be sent. Defaults
     #   to 2048. Changing this value may improve throughput at the expense
     #   of decreasing interactivity.
+    # * :limit - the bandwidth limit in Kbit/s, a positive Integer, like
+    #   <tt>scp -l</tt>. The remote scp enforces it.
     # * :quote - how +remote+ is quoted in the scp command run by the remote
     #   shell. :posix (the default) escapes it for a POSIX shell, leaving a
     #   leading "~" or "~/" unescaped so it expands to the remote home
@@ -309,6 +312,7 @@ module Net
     # * :preserve - the atime and mtime of the file should be preserved.
     # * :verbose - the process should result in verbose output on the server
     #   end (useful for debugging).
+    # * :limit - the bandwidth limit in Kbit/s (see #upload).
     # * :quote - how +remote+ is quoted for the remote shell (see #upload).
     #
     # This method will return immediately, returning the Net::SSH::Connection::Channel
@@ -343,7 +347,7 @@ module Net
 
       # Constructs the scp command line needed to initiate and SCP session
       # for the given +mode+ (:upload or :download) and with the given options
-      # (:verbose, :recursive, :preserve). Returns the command-line as a
+      # (:verbose, :recursive, :preserve, :limit). Returns the command-line as a
       # string, ready to execute.
       def scp_command(mode, options)
         command = +"scp "
@@ -351,6 +355,11 @@ module Net
         command << " -v" if options[:verbose]
         command << " -r" if options[:recursive]
         command << " -p" if options[:preserve]
+        limit = options[:limit]
+        unless limit.nil?
+          raise ArgumentError, ":limit must be a positive Integer" unless limit.is_a?(Integer) && limit > 0
+          command << " -l #{limit}"
+        end
         command
       end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-scp
 version: !ruby/object:Gem::Version
-  version: 4.2.0
+  version: 4.2.1
 platform: ruby
 authors:
 - Jamis Buck
@@ -32,7 +32,7 @@ cert_chain:
   vNiMFH5yLu/tlav4xh+HlYscWVdFQIvd7f/Uxa+Vip1Pi16wmhnrE15z/vDX921v
   hukBRIoCEAuUgNVBh+L/C8aETzbf/77WU3Si/w==
   -----END CERTIFICATE-----
-date: 2026-10-29 00:00:00.000000000 Z
+date: 2026-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh