ddr-antivirus 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbf8b0276005e8766ca6c985e7a4d4771c1ec2f1
-  data.tar.gz: 39638ef73883d0ba112cf8d093ed84e9e021d39d
+  metadata.gz: 86a232e5b90342f2dd51279b2e589e51d7345a23
+  data.tar.gz: e48ae1a5fe0a895d18784a6ba120a0e7dfa892ba
 SHA512:
-  metadata.gz: 96ea1c688237f4dfa5f9b6a8c7c5c5c87edd9eeb5a535ed55978680c9850f744bd2d7ba456d37811157d744bf8a2bdda1d2a9c0111d1a411c404ac2cd798f609
-  data.tar.gz: 5e1c5433a733abdc129bf37893299ec2133b817e7a316613805e973927e13206a673f42f67c7c9671abb2816a68186e3096fecfff925eaa1971f6e71f09a1232
+  metadata.gz: 173c325eb8d7369d7823341593334e229ae5a48047938a680fda9afc21a6151d6e34722864a9acda826fd1f11113526b086bc7dc45acdaf7a410c8a70b4e0ee8
+  data.tar.gz: 51d17a1ea969fab1d69f86b4bd1f3c870fdcef45d7362f96bebb9387ab95105f2e61e55c79eee1be628a254d5ef15acffd0d894a6a6414bbc7a88e96a52bd3af

data/README.md

@@ -24,7 +24,7 @@ Or install it yourself as:
 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:
 
 - 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`.
+- If the ClamAV Daemon client `clamdscan` is on the user's path, it will select the `ClamdScannerAdapter`.  Ddr::Antivirus *does not* manage clamd -- i.e., checking its status, starting or reloading the database.  These tasks must be managed externally.
 - Otherwise, it will select the [`NullScannerAdapter`](#the-nullscanneradapter).
 
 The auto-selection process may be overridden by configuration:
@@ -57,7 +57,7 @@ The scanner raises a `Ddr::Antivirus::VirusFoundError` exception if a virus is f
 
 ### Results
 
-Class: `Ddr::Antivirus::ScanResult`
+Class: `Ddr::Antivirus::Adapters::ScanResult`
 
 A scanner adapter may subclass the base class to parse the raw result properly.
 
@@ -66,7 +66,7 @@ A scanner adapter may subclass the base class to parse the raw result properly.
 => true
 
 >> result = Ddr::Antivirus::Scanner.scan("/path/to/blue-devil.png")
-=> #<Ddr::Antivirus::Adapters::ClamavScannerAdapter::ClamavScanResult:0x007f98fb169cc0 ...
+=> #<Ddr::Antivirus::Adapters::ClamavScanResult:0x007f98fb169cc0 ...
 
 # Was there a virus?
 >> result.has_virus?
@@ -85,20 +85,29 @@ A scanner adapter may subclass the base class to parse the raw result properly.
 => 0 # ClamAV example
 
 # String representation (example)
->> puts result.to_s
-=> /path/to/blue-devil.png: OK (ClamAV 0.98.3/19559/Thu Oct 30 06:39:46 2014)
+>> result.to_s
+=> "/path/to/blue-devil.png: OK (ClamAV 0.98.3/19595/Thu Nov  6 11:32:29 2014)"
+```
+
+### Logging
+
+In a Rails application, `Ddr::Antivirus` will log messages to the Rails logger by default. The fallback logger writes to STDERR.  You may also explicitly set `Ddr::Antivirus.logger` to any object that supports the Ruby logger API:
+
+```ruby
+require "logger"
+Ddr::Antivirus.logger = Logger.new("/path/to/custom.log")
 ```
 
 ### The NullScannerAdapter
 
-In order to avoid the overhead of ClamAV in test and/or development environments, the package provides a no-op adapter that logs a message and returns a scan result object (instance of Ddr::Antivirus::ScanResult).
+In order to avoid the overhead of ClamAV in test and/or development environments, the package provides a no-op adapter:
 
 ```ruby
 >> Ddr::Antivirus.scanner_adapter = :null
 => :null
 >> Ddr::Antivirus::Scanner.scan("/path/to/blue-devil.png")
-W, [2014-10-30T16:21:24.349542 #76244]  WARN -- : File not scanned -- using :null scanner adapter.
-I, [2014-10-30T16:21:24.350582 #76244]  INFO -- : #<Ddr::Antivirus::ScanResult:0x007ff6c98d0500 @raw="File not scanned -- using :null scanner adapter.", @file_path="/path/to/blue-devil.png", @scanned_at=2014-10-30 20:21:24 UTC, @version="ddr-antivirus 1.0.0.rc1">
+I, [2014-11-07T15:58:17.706866 #82651]  INFO -- : /path/to/blue-devil.png: NOT SCANNED - using :null scanner adapter. (ddr-antivirus 1.2.0)
+=> #<Ddr::Antivirus::Adapters::NullScanResult:0x007f9e2ba1af38 @raw="/path/to/blue-devil.png: NOT SCANNED - using :null scanner adapter.", @file_path="/path/to/blue-devil.png", @scanned_at=2014-11-07 20:58:17 UTC, @version="ddr-antivirus 1.2.0">
 ```
 
 ## Contributing

data/lib/ddr/antivirus.rb

@@ -1,7 +1,8 @@
-require "ddr/antivirus/version"
-require "ddr/antivirus/scanner"
-require "ddr/antivirus/scan_result"
-require "ddr/antivirus/adapters"
+require "logger"
+
+require_relative "antivirus/version"
+require_relative "antivirus/scanner"
+require_relative "antivirus/adapters"
 
 require "active_support/core_ext/module/attribute_accessors"
 
@@ -23,7 +24,6 @@ module Ddr
       if defined?(Rails) && Rails.logger
         Rails.logger
       else 
-        require "logger"
         Logger.new(STDERR)    
       end
     end

data/lib/ddr/antivirus/adapters.rb

@@ -1,23 +1,14 @@
-require_relative "./adapters/scanner_adapter"
-
 module Ddr
   module Antivirus
     module Adapters
 
-      def self.get_adapter
-        require_relative adapter_module
+      def self.get_adapter 
+        require_relative "adapters/#{Ddr::Antivirus.scanner_adapter}_scanner_adapter"
+        adapter_name = "#{Ddr::Antivirus.scanner_adapter.to_s.capitalize}ScannerAdapter"
         klass = self.const_get(adapter_name.to_sym, false)
         klass.new
       end
 
-      def self.adapter_name
-        "#{Ddr::Antivirus.scanner_adapter.to_s.capitalize}ScannerAdapter"
-      end
-
-      def self.adapter_module
-        "./adapters/#{Ddr::Antivirus.scanner_adapter}_scanner_adapter"
-      end
-
     end
   end
 end

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

@@ -1,8 +1,12 @@
-require 'clamav'
+require "clamav"
+
+require_relative "scanner_adapter"
+require_relative "scan_result"
 
 module Ddr
   module Antivirus
     module Adapters
+
       class ClamavScannerAdapter < ScannerAdapter
 
         def scan(path)
@@ -31,39 +35,43 @@ module Ddr
           ClamAV.instance
         end
 
-        class ClamavScanResult < Ddr::Antivirus::ScanResult
+      end
 
-          def virus_found
-            raw if has_virus?
-          end
+      #
+      # Result of a scan with the ClamavScannerAdapter.
+      #
+      class ClamavScanResult < ScanResult
 
-          def has_virus?
-            ![0, 1].include?(raw)
-          end
+        def virus_found
+          raw if has_virus?
+        end
 
-          def error?
-            raw == 1
-          end
+        def has_virus?
+          ![0, 1].include?(raw)
+        end
 
-          def status
-            return "FOUND #{virus_found}" if has_virus?
-            return "ERROR" if error?
-            "OK"
-          end
+        def error?
+          raw == 1
+        end
 
-          def to_s
-            "#{file_path}: #{status} (#{version})"
-          end
+        def status
+          return "FOUND #{virus_found}" if has_virus?
+          return "ERROR" if error?
+          "OK"
+        end
 
-          def default_version
-            # Engine and database versions
-            # E.g., ClamAV 0.98.3/19010/Tue May 20 21:46:01 2014
-            `sigtool --version`.strip
-          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
+          `sigtool --version`.strip
         end
 
       end
+
     end
   end
 end

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

@@ -1,3 +1,6 @@
+require_relative "scanner_adapter"
+require_relative "scan_result"
+
 module Ddr
   module Antivirus
     module Adapters
@@ -17,37 +20,41 @@ module Ddr
           `clamdscan --no-summary #{path}`.strip
         end
 
-        class ClamdScanResult < Ddr::Antivirus::ScanResult
-          
-          def virus_found
-            if m = /: ([^\s]+) FOUND$/.match(raw)
-              m[1]
-            end
-          end
+      end
 
-          def has_virus?
-            raw =~ / FOUND$/
+      #
+      # Result of a scan with the ClamdScannerAdapter
+      #
+      class ClamdScanResult < ScanResult
+        
+        def virus_found
+          if m = /: ([^\s]+) FOUND$/.match(raw)
+            m[1]
           end
+        end
 
-          def error?
-            raw =~ / ERROR$/
-          end
+        def has_virus?
+          raw =~ / FOUND$/
+        end
 
-          def ok?
-            raw =~ / OK$/
-          end
+        def error?
+          raw =~ / ERROR$/
+        end
 
-          def to_s
-            "#{raw} (#{version})"
-          end
+        def ok?
+          raw =~ / OK$/
+        end
 
-          def default_version
-            `sigtool --version`.strip
-          end
+        def to_s
+          "#{raw} (#{version})"
+        end
 
+        def default_version
+          `sigtool --version`.strip
         end
 
       end
+
     end
   end
 end

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

@@ -1,3 +1,6 @@
+require_relative "scanner_adapter"
+require_relative "scan_result"
+
 module Ddr
   module Antivirus
     module Adapters
@@ -7,10 +10,16 @@ module Ddr
       class NullScannerAdapter < ScannerAdapter
 
         def scan(path)
-          Ddr::Antivirus::ScanResult.new("#{path}: NOT SCANNED - using :null scanner adapter.", path)
+          NullScanResult.new("#{path}: NOT SCANNED - using :null scanner adapter.", path)
         end
 
       end
+
+      #
+      # The result of the scan with the NullScannerAdapter.
+      #
+      class NullScanResult < ScanResult; end
+
     end
   end
 end

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

@@ -0,0 +1,52 @@
+module Ddr
+  module Antivirus
+    module Adapters
+      #
+      # Default scan result implementation
+      # 
+      class ScanResult
+        
+        attr_reader :raw, :file_path, :scanned_at, :version
+        
+        def initialize(raw, file_path, opts={})
+          @raw = raw
+          @file_path = file_path
+          @scanned_at = opts.fetch(:scanned_at, default_time)
+          @version = opts.fetch(:version, default_version)
+        end
+
+        def default_time
+          Time.now.utc
+        end
+
+        def default_version
+          "ddr-antivirus #{Ddr::Antivirus::VERSION}"
+        end
+
+        # Subclasses may override to provide description of virus found.
+        def virus_found; end
+
+        # Subclasses should override
+        def has_virus?
+          !virus_found.nil?
+        end
+
+        # Subclasses may override to indicate an error condition (not necessarily an exception).
+        def error?
+          false
+        end
+
+        def ok?
+          !(has_virus? || error?)
+        end
+
+        # Subclasses may override
+        def to_s
+          "#{raw} (#{version})"
+        end
+
+      end
+    end
+  end
+end
+

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

@@ -6,10 +6,15 @@ module Ddr
       # 
       class ScannerAdapter
 
+        # Scan a file path for viruses - subclasses must implement.
+        #
+        # @param [String] file path to scan
+        # @return [Ddr::Antivirus::ScanResult] the result
         def scan(path)
           raise NotImplementedError
         end
 
+        # Return the adapter configuration options
         def config
           Ddr::Antivirus.adapter_config
         end

data/lib/ddr/antivirus/version.rb

@@ -1,5 +1,5 @@
 module Ddr
   module Antivirus
-    VERSION = "1.2.1"
+    VERSION = "1.3.0"
   end
 end

data/spec/unit/clamav_scanner_adapter_spec.rb

@@ -35,9 +35,10 @@ module Ddr
           describe "result" do
             subject { adapter.scan(path) }
             let(:adapter) { described_class.new }
-            it "should be a scan result" do
-              expect(subject).to be_a(Ddr::Antivirus::ScanResult)
+            it "should be a ClamavScanResult" do
+              expect(subject).to be_a(ClamavScanResult)
             end
+            it_should_behave_like "a scan result"
             context "when a virus is found" do
               before { allow(adapter.engine).to receive(:scanfile).with(path) { "Bad boy 35" } }
               it "the raw result should be the virus description" do

data/spec/unit/clamd_scanner_adapter_spec.rb

@@ -12,8 +12,9 @@ module Ddr
           subject { adapter.scan(path) }
           let(:adapter) { described_class.new }
           it "should be a scan result" do
-            expect(subject).to be_a(Ddr::Antivirus::ScanResult)
+            expect(subject).to be_a(ClamdScanResult)
           end
+          it_should_behave_like "a scan result"
           context "when a virus is found" do
             before { allow(adapter).to receive(:clamdscan).with(path) { "#{path}: Bad-boy-35 FOUND" } }
             it "should have a virus_found" do

data/spec/unit/null_scanner_adapter_spec.rb

@@ -0,0 +1,24 @@
+require "shared_examples_for_scan_results"
+require "ddr/antivirus/adapters/null_scanner_adapter"
+
+module Ddr
+  module Antivirus
+    module Adapters
+      RSpec.describe NullScannerAdapter do
+
+        let(:path) { File.expand_path(File.join("..", "..", "fixtures", "blue-devil.png"), __FILE__) }
+
+        describe "result" do
+          subject { adapter.scan(path) }
+          let(:adapter) { described_class.new }
+          it "should be a NullScanResult" do
+            expect(subject).to be_a(NullScanResult)
+          end
+          it_should_behave_like "a scan result"
+          it_should_behave_like "a successful scan result"
+        end
+
+      end
+    end
+  end
+end

data/spec/unit/scan_result_spec.rb

@@ -2,23 +2,25 @@ require 'shared_examples_for_scan_results'
 
 module Ddr
   module Antivirus
-    RSpec.describe ScanResult do
-      subject { described_class.new("Raw result", "/tmp/foo") }
+    module Adapters
+      RSpec.describe ScanResult do
+        subject { described_class.new("Raw result", "/tmp/foo") }
 
-      it_should_behave_like "a scan result"
+        it_should_behave_like "a scan result"
 
-      describe "success" do
-        it_should_behave_like "a successful scan result"        
-      end
+        describe "success" do
+          it_should_behave_like "a successful scan result"        
+        end
 
-      describe "error" do
-        before { allow(subject).to receive(:error?) { true } }
-        it_should_behave_like "an error scan result"
-      end
+        describe "error" do
+          before { allow(subject).to receive(:error?) { true } }
+          it_should_behave_like "an error scan result"
+        end
 
-      describe "virus found" do
-        before { allow(subject).to receive(:virus_found) { "Bad boy 35" } }
-        it_should_behave_like "a virus scan result"
+        describe "virus found" do
+          before { allow(subject).to receive(:virus_found) { "Bad boy 35" } }
+          it_should_behave_like "a virus scan result"
+        end
       end
     end
   end

data/spec/unit/scanner_spec.rb

@@ -1,31 +1,34 @@
+require "ddr/antivirus/adapters/scan_result"
+
 module Ddr
   module Antivirus
     RSpec.describe Scanner do
 
       shared_examples "a scanner" do
-        describe "when a virus is found" do
-          before do
-            allow_any_instance_of(ScanResult).to receive(:has_virus?) { true }
+        let(:path) { "/tmp/foo" }
+        describe "logging" do
+          it "should log the result" do
+            expect(Ddr::Antivirus.logger).to receive(:info)
+            subject.scan(path)
           end
+        end
+        describe "when a virus is found" do
+          before { allow_any_instance_of(Ddr::Antivirus::Adapters::ScanResult).to receive(:has_virus?) { true } }
           it "should raise an execption" do
-            expect { subject.scan("/tmp/foo") }.to raise_error
+            expect { subject.scan(path) }.to raise_error
           end
         end
         describe "when a virus is not found" do
-          before do
-            allow_any_instance_of(ScanResult).to receive(:has_virus?) { false }
-          end
+          before { allow_any_instance_of(Ddr::Antivirus::Adapters::ScanResult).to receive(:has_virus?) { false } }
           it "should return the scan result" do
-            expect(subject.scan("/tmp/foo")).to be_a(ScanResult)
+            expect(subject.scan(path)).to be_a(Ddr::Antivirus::Adapters::ScanResult)
           end
         end
         describe "when an error occurs in the scanner" do
-          before do
-            allow_any_instance_of(ScanResult).to receive(:error?) { true }
-          end
+          before { allow_any_instance_of(Ddr::Antivirus::Adapters::ScanResult).to receive(:error?) { true } }
           it "should log an error" do
             expect(Ddr::Antivirus.logger).to receive(:error)
-            subject.scan("/tmp/foo")
+            subject.scan(path)
           end
         end
       end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ddr-antivirus
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - David Chandek-Stark
@@ -101,8 +101,8 @@ files:
 - lib/ddr/antivirus/adapters/clamav_scanner_adapter.rb
 - lib/ddr/antivirus/adapters/clamd_scanner_adapter.rb
 - lib/ddr/antivirus/adapters/null_scanner_adapter.rb
+- lib/ddr/antivirus/adapters/scan_result.rb
 - lib/ddr/antivirus/adapters/scanner_adapter.rb
-- lib/ddr/antivirus/scan_result.rb
 - lib/ddr/antivirus/scanner.rb
 - lib/ddr/antivirus/version.rb
 - spec/fixtures/blue-devil.png
@@ -110,6 +110,7 @@ files:
 - spec/spec_helper.rb
 - spec/unit/clamav_scanner_adapter_spec.rb
 - spec/unit/clamd_scanner_adapter_spec.rb
+- spec/unit/null_scanner_adapter_spec.rb
 - spec/unit/scan_result_spec.rb
 - spec/unit/scanner_spec.rb
 homepage: https://github.com/duke-libraries/ddr-antivirus
@@ -142,5 +143,6 @@ test_files:
 - spec/spec_helper.rb
 - spec/unit/clamav_scanner_adapter_spec.rb
 - spec/unit/clamd_scanner_adapter_spec.rb
+- spec/unit/null_scanner_adapter_spec.rb
 - spec/unit/scan_result_spec.rb
 - spec/unit/scanner_spec.rb

data/lib/ddr/antivirus/scan_result.rb

@@ -1,50 +0,0 @@
-module Ddr
-  module Antivirus
-    #
-    # Default scan result implementation
-    # 
-    class ScanResult
-      
-      attr_reader :raw, :file_path, :scanned_at, :version
-      
-      def initialize(raw, file_path, opts={})
-        @raw = raw
-        @file_path = file_path
-        @scanned_at = opts.fetch(:scanned_at, default_time)
-        @version = opts.fetch(:version, default_version)
-      end
-
-      def default_time
-        Time.now.utc
-      end
-
-      def default_version
-        "ddr-antivirus #{Ddr::Antivirus::VERSION}"
-      end
-
-      # Subclasses may override to provide description of virus found.
-      def virus_found; end
-
-      # Subclasses should override
-      def has_virus?
-        !virus_found.nil?
-      end
-
-      # Subclasses may override to indicate an error condition (not necessarily an exception).
-      def error?
-        false
-      end
-
-      def ok?
-        !(has_virus? || error?)
-      end
-
-      # Subclasses may override
-      def to_s
-        "#{raw} (#{version})"
-      end
-
-    end
-  end
-end
-