ddr-antivirus 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9424fb9fcce9fd87db0354060b80873112d923bb
-  data.tar.gz: 4e190d50edeba08eec311c2ed6e38189fec3eb29
+  metadata.gz: 0cbe6bb3732e0dd194bee771110acbd331359f91
+  data.tar.gz: a5cd603f3e9a56244179ece7d93890c26f873910
 SHA512:
-  metadata.gz: 6f2dc02d2c56c5f5e4d0d2669517578b6905b6e300ca6b9afef71243c44540f89cdd630549e386ed15d9b7911a53d05d9030a2801c11503e2b5dd549de02fc84
-  data.tar.gz: b32e01dc33aba340e8ac87f7030c431518d24d387992fc42addbe1131c5355c8eef8e35e2ac38b67ef2b223686647bceb09fca26d0a47fbb5c38e5b382d69b76
+  metadata.gz: 6ba1025ded7e40dea5ace207906ee6e0b5dbff5076d2c6d39880a2bb323eb27c147391ea3b17e09a9b61a70e7d9c6fb4088d9103b21fa08c960d26a2a642a518
+  data.tar.gz: dbc106f548fc2c4369cf1fc3d74292f62ed77d11780858f6660bb7f740fda02430bed699f2060b7f67403cadc2895a128b9794264543f9383df6d1a33dc02632

data/README.md

@@ -19,19 +19,21 @@ Or install it yourself as:
 
     $ gem install ddr-antivirus
 
-## ClamAV
+## How It Works
 
-Ddr::Antivirus does *not* include the `clamav` gem as a runtime dependency.  Add to your application's Gemfile:
+Ddr::Antivirus does *not* provide a virus scanning engine as a runtime dependency. Instead, it will select a scanner adapter class for the software it finds in your environment following this procedure:
 
-    gem 'clamav'
+- If the [clamav](https://github.com/eagleas/clamav) gem is available, it will select the `ClamavScannerAdapter`.
+- If the ClamAV Daemon client `clamdscan` is on the user's path, it will select the `ClamdScannerAdapter`.
+- Otherwise, it will select the [`NullScannerAdapter`](#the-nullscanneradapter).
 
-For system dependencies, see https://github.com/eagleas/clamav.
+The auto-selection process may be overridden by configuration:
 
-Ddr::Antivirus will automatically use an adapter class for ClamAV if the Ruby gem is installed.
-
-## ClamAV Daemon Client (clamdscan)
-
-Ddr::Antivirus will automatically use an adapter class for `clamdscan` if the executable is on the user's path.
+```ruby
+Ddr::Antivirus.configure do |config|
+  config.scanner_adapter = :clamd # or :clamav, or :null
+end
+```
 
 ## Usage
 
@@ -51,7 +53,7 @@ Ddr::Antivirus::Scanner.new do |scanner|
 end
 ```
 
-The scanner raises an exception (Ddr::Antivirus::VirusFoundError) if a virus is found.
+The scanner raises a `Ddr::Antivirus::VirusFoundError` exception if a virus is found.
 
 ### Results
 

data/lib/ddr/antivirus/adapters/clamav_scanner_adapter.rb

@@ -34,13 +34,27 @@ module Ddr
         class ClamavScanResult < Ddr::Antivirus::ScanResult
 
           def virus_found
-            raw if raw.is_a?(String)
+            raw if has_virus?
+          end
+
+          def has_virus?
+            ![0, 1].include?(raw)
           end
 
           def error?
             raw == 1
           end
 
+          def status
+            return "FOUND #{virus_found}" if has_virus?
+            return "ERROR" if error?
+            "OK"
+          end
+
+          def to_s
+            "#{file_path}: #{status} (#{version})"
+          end
+
           def default_version
             # Engine and database versions
             # E.g., ClamAV 0.98.3/19010/Tue May 20 21:46:01 2014

data/lib/ddr/antivirus/adapters/null_scanner_adapter.rb

@@ -6,11 +6,8 @@ module Ddr
       #
       class NullScannerAdapter < ScannerAdapter
 
-        RESULT = "File not scanned -- using :null scanner adapter."
-
         def scan(path)
-          Ddr::Antivirus.logger.warn(RESULT)
-          Ddr::Antivirus::ScanResult.new(RESULT, path)
+          Ddr::Antivirus::ScanResult.new("#{path}: NOT SCANNED - using :null scanner adapter.", path)
         end
 
       end

data/lib/ddr/antivirus/scan_result.rb

@@ -23,42 +23,25 @@ module Ddr
       end
 
       # Subclasses may override to provide description of virus found.
-      # Should return nil if no virus found.
       def virus_found; end
 
+      # Subclasses should override
       def has_virus?
         !virus_found.nil?
       end
 
-      def status
-        return status_found if has_virus?
-        return status_error if error?
-        status_ok
-      end
-
-      def ok?
-        !(has_virus? || error?)
-      end
-
-      # Subclasses may implement to indicate an error condition (not necessarily an exception).
+      # Subclasses may override to indicate an error condition (not necessarily an exception).
       def error?
         false
       end
 
-      def status_error
-        "ERROR"
-      end
-
-      def status_ok
-        "OK"
-      end
-
-      def status_found
-        "FOUND #{virus_found}"
+      def ok?
+        !(has_virus? || error?)
       end
 
+      # Subclasses may override
       def to_s
-        "Virus scan: #{status} - #{file_path} (#{version})"
+        "#{raw} (#{version})"
       end
 
     end

data/lib/ddr/antivirus/scanner.rb

@@ -20,7 +20,7 @@ module Ddr
         result = adapter.scan(path)
         raise Ddr::Antivirus::VirusFoundError, result if result.has_virus?
         logger.error("Antivirus scanner error (#{result.version})") if result.error?
-        logger.info(result)
+        logger.info(result.to_s)
         result
       end
 

data/lib/ddr/antivirus/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Antivirus
-    VERSION = "1.1.0"
+    VERSION = "1.2.0"
   end
 end

data/spec/shared_examples_for_scan_results.rb

@@ -24,15 +24,9 @@ shared_examples "a successful scan result" do
   it "should be ok" do
     expect(subject).to be_ok
   end
-  it "should have OK status" do
-    expect(subject.status).to eq "OK"
-  end
 end
 
 shared_examples "an error scan result" do
-  it "should have ERROR status" do
-    expect(subject.status).to eq("ERROR")
-  end
   it "should have an error" do
     expect(subject).to be_error
   end
@@ -46,9 +40,6 @@ shared_examples "an error scan result" do
 end
 
 shared_examples "a virus scan result" do
-  it "should have FOUND status" do
-    expect(subject.status).to match(/^FOUND/)
-  end
   it "shoud have a virus" do
     expect(subject.virus_found).not_to be_nil
     expect(subject).to have_virus

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddr-antivirus
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-03 00:00:00.000000000 Z
+date: 2014-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport