clamby 1.3.2 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e11cf21ff5f74654f10a44017053c0b883f382ab423e38c6fe0a46af9ce314ac
-  data.tar.gz: 233cc4ea434c05f575885336aebbba53884b019317d507855b0688179546d116
+  metadata.gz: d8a7e48c2bd0285d60fe7ece07fd72bca337e33fefb86d5304b6278132047d44
+  data.tar.gz: d2489bc3655ecf95667fa41f9aa39e104404fb9d0eccbbf5447dd6cd9e78b307
 SHA512:
-  metadata.gz: eee15a0059ebd4bf338cfda8ae30428ed0160b8bf14a2d10296bccccf41bb17bab07aea2f4de3ebd8bbb85664131fb050a5a8b64786be107c1d25c689867dab1
-  data.tar.gz: '092f0f57aee3984ab4085cf84960686cce96033095d41bd1c0ff61cb5b5ab7bafcaeec6d1563e1167b6641917d4bf95a3a80cc456553b7c36b3dbcdc1de211e6'
+  metadata.gz: 1a505ca85b244f599a0270a9e94e46305b1230fb2502eebbffbc441e86e78d7e668ab534fb39a2f086eb14a330c68706bd15104a387aec2e518108e9e4f912e3
+  data.tar.gz: 2401278d0d3721113268156994ed39eed440619b90f1e25dd42b62db99681eeeaa3aa23c9d5d7c7c59477ccd1875f93192f052a350ea9d83d3836517ec5ff724

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v1.4.0
+ - [emilong](https://github.com/kobaltz/clamby/commits/master?author=emilong) added `:error_clamscan_client_error => false` option to prevent error from missing running daemon or clamscan.
+
 # v1.3.2
  - [emilong](https://github.com/kobaltz/clamby/commits/master?author=emilong) added `stream` option
  

data/lib/clamby.rb

@@ -1,3 +1,4 @@
+require "English"
 require "clamby/version"
 require "clamby/exception"
 module Clamby
@@ -5,6 +6,7 @@ module Clamby
     :check => true,
     :daemonize => false,
     :error_clamscan_missing => true,
+    :error_clamscan_client_error => false,
     :error_file_missing => true,
     :error_file_virus => false,
     :fdpass => false,
@@ -21,7 +23,7 @@ module Clamby
   end
 
   def self.safe?(path)
-    value =  virus?(path)
+    value = virus?(path)
     return nil if value.nil?
     ! value
   end
@@ -44,12 +46,24 @@ module Clamby
   def self.virus?(path)
     return nil unless scanner_exists?
     return nil unless file_exists?(path)
-    scanner = system(*system_command(path))
+    system(*system_command(path))
 
-    return false if scanner
-    return true unless @config[:error_file_virus]
+    case $CHILD_STATUS.exitstatus
+    when 0
+      return false
+    when 2
+      # clamdscan returns 2 whenever error other than a detection happens
+      if @config[:error_clamscan_client_error] && @config[:daemonize]
+        raise Exceptions::ClamscanClientError.new("Clamscan client error")
+      end
+
+      # returns true to maintain legacy behavior
+      return true
+    else
+      return true unless @config[:error_file_virus]
 
-    raise Exceptions::VirusDetected.new("VIRUS DETECTED on #{Time.now}: #{path}")
+      raise Exceptions::VirusDetected.new("VIRUS DETECTED on #{Time.now}: #{path}")
+    end
   end
 
   def self.scanner_exists?

data/lib/clamby/exception.rb

@@ -2,5 +2,6 @@ module Exceptions
   class Error < StandardError; end
   class VirusDetected < Error; end
   class ClamscanMissing < Error; end
+  class ClamscanClientError < Error; end
   class FileNotFound < Error; end
-end
+end

data/lib/clamby/version.rb

@@ -1,3 +1,3 @@
 module Clamby
-  VERSION = "1.3.2"
+  VERSION = "1.4.0"
 end

data/spec/clamby_spec.rb

@@ -97,4 +97,46 @@ describe Clamby do
       expect(Clamby.system_command(good_path)).to eq ["clamdscan", "--stream", good_path, "--no-summary"]
     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
+    end
+    it 'accepts an error_clamscan_client_error option in the config' do
+      Clamby.configure(error_clamscan_client_error: true)
+      expect(Clamby.config[:error_clamscan_client_error]).to eq true
+    end
+
+    before {
+      Clamby.configure(check: false)
+      allow_any_instance_of(Process::Status).to receive(:exitstatus).and_return(2)
+      allow(Clamby).to receive(:system)
+    }
+
+    context 'when false' do
+      before { Clamby.configure(error_clamscan_client_error: false) }
+
+      it 'virus? returns true when the daemonized client exits with status 2' do
+        Clamby.configure(daemonize: true)
+        expect(Clamby.virus?(good_path)).to eq true
+      end
+      it 'returns true when the client exits with status 2' do
+        Clamby.configure(daemonize: false)
+        expect(Clamby.virus?(good_path)).to eq true
+      end
+    end
+
+    context 'when true' do
+      before { Clamby.configure(error_clamscan_client_error: true) }
+
+      it 'virus? raises when the daemonized client exits with status 2' do
+        Clamby.configure(daemonize: true)
+        expect { Clamby.virus?(good_path) }.to raise_error(Exceptions::ClamscanClientError)
+      end
+      it 'returns true when the client exits with status 2' do
+        Clamby.configure(daemonize: false)
+        expect(Clamby.virus?(good_path)).to eq true
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamby
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
 platform: ruby
 authors:
 - kobaltz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-22 00:00:00.000000000 Z
+date: 2018-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler