clamby 1.6.6 → 1.6.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9bf0bfa99f769f41a964838dca46fcb5d6b4c2a2e1653ff43c3a40fde25480f
-  data.tar.gz: 95615a8f2c69aa42a593f909a426266253026c7bc3d24a74dfabb13dd931c526
+  metadata.gz: 171036eaf5b847c95d24d69acf689dad2c9eda942a746b5c98182058446e9af0
+  data.tar.gz: 862529ea5008ebd2568c40ea3dd8c2e38cc5467733edf13b97ac67b6ac817e03
 SHA512:
-  metadata.gz: d4af568ba3f78fb465a18625ff9e9fca343de65b95b155b57cd3b7156d19db876457837331896c3c9c6767326a93f6dcf01f73c5518180df9ff95b7af8868b5e
-  data.tar.gz: 3c2b5004c4b5dbb2fc627a2d20a79307361b5385b3b53dc0500fe1683430db9619d90a18e0aa414d28ce103bbbe9265409462c0d3845f0e6667a76ff788743a6
+  metadata.gz: 8c416805c97b12c6f2ed9dbb43843be08841ca0821ea2036f9ab903feceecf7fabde4fc6786fb7a0ef5e1e628123329e29478bfb843540cf416c6709e174cb56
+  data.tar.gz: a5667261a416a5eb2ade0ba75f1982949ae9845849a8f647bcd918091720b5b1e95c30477b838e94a7d297256c45263bc09268aef6b711d2ed2e704845554f51

data/.travis.yml

@@ -9,7 +9,9 @@ rvm:
   - 2.5.3
   - 2.6.3
   - 2.6.5
-install: 
+  - 2.6.6
+  - 2.7.2
+install:
  - sudo apt-get install clamav
  - sudo freshclam
 

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v1.6.8
+ - [codezomb](https://github.com/kobaltz/clamby/commits?author=codezomb)  - Allow paths to be escaped #37
+
 # v1.6.5
  - [bennacer860](https://github.com/kobaltz/clamby/commits?author=bennacer860) - Added config data dir option
 
@@ -25,7 +28,7 @@
 
 # v1.3.2
  - [emilong](https://github.com/kobaltz/clamby/commits/master?author=emilong) added `stream` option
- 
+
 # v1.3.1
  - [zealot128](https://github.com/kobaltz/clamby/commits/master?author=zealot128) added `silence_output` option
 
@@ -43,7 +46,7 @@
  - Refactor of logic
  - Cleanup
  - Thanks to @hderms for contributing!
- 
+
 # v1.1.0
  - Changed `scan()` to `safe?()`
  - Added `virus?()`
@@ -70,7 +73,7 @@ HTTP request sent, awaiting response... 200 OK
 Length: 68 [application/octet-stream]
 Saving to: 'eicar.com'
 
-100%[=================>] 68          --.-K/s   in 0s      
+100%[=================>] 68          --.-K/s   in 0s
 
 2014-03-10 21:35:50 (13.0 MB/s) - 'eicar.com' saved [68/68]
 

data/README.md

@@ -99,6 +99,7 @@ Configuration is rather limited right now. You can exclude the check if `clamsca
       :error_file_virus => false,
       :fdpass => false,
       :stream => false,
+      :reload => false,
       :output_level => 'medium', # one of 'off', 'low', 'medium', 'high'
       :executable_path_clamscan => 'clamscan',
       :executable_path_clamdscan => 'clamdscan',
@@ -128,6 +129,12 @@ Setting the `stream` configuration option will stream the file to the daemon. Th
 
 `--stream : Forces file streaming to clamd. This is generally not needed as clamdscan detects automatically if streaming is required. This option only exists for debugging and testing purposes, in all other cases --fdpass is preferred.`
 
+#### Force streaming files to clamd
+
+Setting the `reload` configuration option to `true` will pass the `--reload` option  to the daemon. Only works when also specifying `daemonize`. From the clamdscan man page:
+
+`--reload : Request clamd to reload virus database.`
+
 #### Output levels
 
 - *off*: suppress all output

data/clamby.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["dave@k-innovations.net"]
   spec.summary       = "Scan file uploads with ClamAV"
   spec.description   = "Clamby allows users to scan files uploaded with Paperclip or Carrierwave. If a file has a virus, then you can delete this file and discard it without causing harm to other users."
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/kobaltz/clamby"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files -z`.split("\x0")
@@ -21,5 +21,4 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "byebug"
 end

data/lib/clamby/command.rb

@@ -16,11 +16,12 @@ module Clamby
     def self.scan(path)
       return nil unless file_exists?(path)
 
-      args = [path, '--no-summary']
+      args = [Shellwords.escape(path), '--no-summary']
 
       if Clamby.config[:daemonize]
         args << '--fdpass' if Clamby.config[:fdpass]
         args << '--stream' if Clamby.config[:stream]
+        args << '--reload' if Clamby.config[:reload]
       end
 
       args << "-d #{Clamby.config[:datadir]}" if Clamby.config[:datadir]

data/lib/clamby/version.rb

@@ -1,3 +1,3 @@
 module Clamby
-  VERSION = "1.6.6"
+  VERSION = "1.6.9"
 end

data/lib/clamby.rb

@@ -14,6 +14,7 @@ module Clamby
     :error_file_virus => false,
     :fdpass => false,
     :stream => false,
+    :reload => false,
     :output_level => 'medium',
     :datadir => nil,
     :executable_path_clamscan => 'clamscan',

data/spec/clamby/command_spec.rb

@@ -84,6 +84,32 @@ describe Clamby::Command do
       end
     end
 
+    describe 'reloading virus database' do
+      it 'does not include reload in the command by default' do
+        Clamby.configure
+        expect(runner).to receive(:run).with('clamscan', good_path, '--no-summary')
+        allow(described_class).to receive(:new).and_return(runner)
+
+        described_class.scan(good_path)
+      end
+
+      it 'omits the reload option when invoking clamscan if it is set, but daemonize isn\'t' do
+        Clamby.configure(reload: true)
+        expect(runner).to receive(:run).with('clamscan', good_path, '--no-summary')
+        allow(described_class).to receive(:new).and_return(runner)
+
+        described_class.scan(good_path)
+      end
+
+      it 'passes the reload option when invoking clamscan if it is set with daemonize' do
+        Clamby.configure(reload: true, daemonize: true)
+        expect(runner).to receive(:run).with('clamdscan', good_path, '--no-summary', '--reload')
+        allow(described_class).to receive(:new).and_return(runner)
+
+        described_class.scan(good_path)
+      end
+    end
+
     describe 'specifying config-file' do
       it 'does not include the parameter in the clamscan command by default' do
         Clamby.configure
@@ -134,9 +160,7 @@ describe Clamby::Command do
 
         it 'executes the clamscan executable from the custom path' do
           expect(runner).to receive(:system).with(
-            "#{custom_path}/clamscan",
-            '--no-summary',
-            good_path,
+            "#{custom_path}/clamscan --no-summary #{good_path}",
             {}
           ) { system("exit 0", out: File::NULL) }
 
@@ -149,9 +173,7 @@ describe Clamby::Command do
 
         it 'executes the clamdscan executable from the custom path' do
           expect(runner).to receive(:system).with(
-            "#{custom_path}/clamdscan",
-            '--no-summary',
-            good_path,
+            "#{custom_path}/clamdscan --no-summary #{good_path}",
             {}
           ) { system("exit 0", out: File::NULL) }
 
@@ -159,5 +181,11 @@ describe Clamby::Command do
         end
       end
     end
+
+    describe 'special filenames' do
+      it 'does not fail' do
+        expect(described_class.scan(special_path)).to be(false)
+      end
+    end
   end
 end

data/spec/clamby_spec.rb

@@ -66,6 +66,18 @@ describe Clamby do
     end
   end
 
+  # From the clamscan man page:
+  # Request clamd to reload virus database.
+  context 'reload option' do
+    it 'is false by default' do
+      expect(Clamby.config[:reload]).to eq false
+    end
+    it 'accepts an reload option in the config' do
+      Clamby.configure(reload: true)
+      expect(Clamby.config[:reload]).to eq true
+    end
+  end
+
   context 'error_clamscan_client_error option' do
     it 'is false by default' do
       expect(Clamby.config[:error_clamscan_client_error]).to eq false

data/spec/fixtures/safe (special).txt

@@ -0,0 +1,2 @@
+This is a virus-free file.
+It is used by automated tests.

data/spec/support/shared_context.rb

@@ -1,4 +1,5 @@
 RSpec.shared_context 'paths' do
+  let(:special_path) { File.expand_path('../../fixtures/safe (special).txt', __FILE__) }
   let(:good_path) { File.expand_path('../../fixtures/safe.txt', __FILE__) }
   let(:bad_path) { File.expand_path("not-here/#{rand 10e6}.txt", __FILE__) }
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamby
 version: !ruby/object:Gem::Version
-  version: 1.6.6
+  version: 1.6.9
 platform: ruby
 authors:
 - kobaltz
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-05 00:00:00.000000000 Z
+date: 2023-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,20 +52,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: byebug
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 description: Clamby allows users to scan files uploaded with Paperclip or Carrierwave.
   If a file has a virus, then you can delete this file and discard it without causing
   harm to other users.
@@ -93,10 +79,11 @@ files:
 - spec/.DS_Store
 - spec/clamby/command_spec.rb
 - spec/clamby_spec.rb
+- spec/fixtures/safe (special).txt
 - spec/fixtures/safe.txt
 - spec/spec_helper.rb
 - spec/support/shared_context.rb
-homepage: ''
+homepage: https://github.com/kobaltz/clamby
 licenses:
 - MIT
 metadata: {}
@@ -115,7 +102,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.4.19
 signing_key:
 specification_version: 4
 summary: Scan file uploads with ClamAV
@@ -123,6 +110,7 @@ test_files:
 - spec/.DS_Store
 - spec/clamby/command_spec.rb
 - spec/clamby_spec.rb
+- spec/fixtures/safe (special).txt
 - spec/fixtures/safe.txt
 - spec/spec_helper.rb
 - spec/support/shared_context.rb