ddr-antivirus 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e09e6bc593db830915157ce7ed38e9c05702ec8
-  data.tar.gz: 66f916b33a1e8e336d5b3172a145007eeba312dd
+  metadata.gz: 9424fb9fcce9fd87db0354060b80873112d923bb
+  data.tar.gz: 4e190d50edeba08eec311c2ed6e38189fec3eb29
 SHA512:
-  metadata.gz: dc8b5c988bb1e6f1b3b50e9439611a965b2291526586ea18670265f6ac4282a6556966b7ac4c1667f107007c8fee198a0fef745fe2fd5328f79413e2d71987d6
-  data.tar.gz: 91c7a1a590026094a67255a253939ec779a46689637adf813a28e0c728139b58fc1cfe85f881c73e4e8eb98cf3c05fb4c4e035b5f01f66b7313f5fca749003f7
+  metadata.gz: 6f2dc02d2c56c5f5e4d0d2669517578b6905b6e300ca6b9afef71243c44540f89cdd630549e386ed15d9b7911a53d05d9030a2801c11503e2b5dd549de02fc84
+  data.tar.gz: b32e01dc33aba340e8ac87f7030c431518d24d387992fc42addbe1131c5355c8eef8e35e2ac38b67ef2b223686647bceb09fca26d0a47fbb5c38e5b382d69b76

data/.travis.yml

@@ -1,8 +1,10 @@
 language: ruby
 before_install:
   - sudo apt-get update -qq
-  - sudo apt-get install -y libclamav-dev clamav clamav-freshclam
+  - sudo apt-get install -y libclamav-dev clamav clamav-daemon clamav-freshclam
+before_script:
   - sudo freshclam
+  - sudo /etc/init.d/clamav-daemon start
 rvm:
   - 2.1
 cache: 

data/README.md

@@ -19,16 +19,20 @@ Or install it yourself as:
 
     $ gem install ddr-antivirus
 
-## ClamAV Dependencies
+## ClamAV
 
-For system dependencies, see https://github.com/eagleas/clamav.
-
-Ddr::Antivirus intentionally does *not* include `clamav` as a runtime dependency.  Rather you should add to you application's Gemfile:
+Ddr::Antivirus does *not* include the `clamav` gem as a runtime dependency.  Add to your application's Gemfile:
 
     gem 'clamav'
 
+For system dependencies, see https://github.com/eagleas/clamav.
+
 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.
+
 ## Usage
 
 ### Scanning ###
@@ -47,10 +51,14 @@ Ddr::Antivirus::Scanner.new do |scanner|
 end
 ```
 
+The scanner raises an exception (Ddr::Antivirus::VirusFoundError) if a virus is found.
+
 ### Results
 
 Class: `Ddr::Antivirus::ScanResult`
 
+A scanner adapter may subclass the base class to parse the raw result properly.
+
 ```ruby
 >> require "ddr-antivirus"
 => true
@@ -74,14 +82,14 @@ Class: `Ddr::Antivirus::ScanResult`
 >> result.raw
 => 0 # ClamAV example
 
-# String representation
+# String representation (example)
 >> puts result.to_s
-Virus scan: OK - /path/to/blue-devil.png (ClamAV 0.98.3/19559/Thu Oct 30 06:39:46 2014)
+=> /path/to/blue-devil.png: OK (ClamAV 0.98.3/19559/Thu Oct 30 06:39:46 2014)
 ```
 
 ### 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 normal scan result (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 that logs a message and returns a scan result object (instance of Ddr::Antivirus::ScanResult).
 
 ```ruby
 >> Ddr::Antivirus.scanner_adapter = :null

data/lib/ddr/antivirus.rb

@@ -1,42 +1,52 @@
 require "ddr/antivirus/version"
+require "ddr/antivirus/scanner"
+require "ddr/antivirus/scan_result"
+require "ddr/antivirus/adapters"
+
 require "active_support/core_ext/module/attribute_accessors"
-require "active_support/dependencies/autoload"
-require "logger"
 
 module Ddr
   module Antivirus
-    extend ActiveSupport::Autoload
 
     class VirusFoundError < ::StandardError; end
 
-    def self.clamav_installed?
-      begin
-        require 'clamav'
-      rescue LoadError
-        false
-      else
-        true
-      end
-    end
-
     def self.configure
       yield self
     end
 
-    autoload :Scanner
-    autoload :ScanResult
-    autoload :Adapters
-
+    #
     # Custom logger
+    #
     # Defaults to Rails logger if Rails is loaded; otherwise logs to STDERR.
+    #
     mattr_accessor :logger do
-      defined?(Rails) && Rails.logger ? Rails.logger : Logger.new(STDERR)    
+      if defined?(Rails) && Rails.logger
+        Rails.logger
+      else 
+        require "logger"
+        Logger.new(STDERR)    
+      end
     end
 
+    #
     # Scanner adapter
-    # Defaults to :clamav adapter if ClamAV is installed; otherwise uses the :null adapter
+    #
+    # Defaults to:
+    # - :clamav adapter if the 'clamav' gem is installed; 
+    # - :clamd adapter if the 'clamdscan' executable is available;
+    # - otherwise, the :null adapter.
+    #
     mattr_accessor :scanner_adapter do
-      clamav_installed? ? :clamav : :null
+      begin
+        require "clamav"
+        :clamav
+      rescue LoadError
+        if system "which -s clamdscan"
+          :clamd
+        else
+          :null
+        end
+      end
     end
 
   end

data/lib/ddr/antivirus/adapters.rb

@@ -1,15 +1,11 @@
-require "active_support/dependencies/autoload"
+require_relative "./adapters/scanner_adapter"
 
 module Ddr
   module Antivirus
     module Adapters
-      extend ActiveSupport::Autoload
-
-      autoload :ScannerAdapter
-      autoload :NullScannerAdapter
-      autoload :ClamavScannerAdapter if Ddr::Antivirus.clamav_installed?
 
       def self.get_adapter
+        require_relative adapter_module
         klass = self.const_get(adapter_name.to_sym, false)
         klass.new
       end
@@ -18,6 +14,10 @@ module Ddr
         "#{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/clamd_scanner_adapter.rb

@@ -0,0 +1,53 @@
+module Ddr
+  module Antivirus
+    module Adapters
+      #
+      # ClamdScannerAdapter uses an external ClamAV daemon (clamd)
+      # 
+      # See https://github.com/soundarapandian/clamd for configuration method and options.
+      #
+      class ClamdScannerAdapter < ScannerAdapter
+
+        def scan(path)
+          raw = clamdscan(path)
+          ClamdScanResult.new(raw, path)
+        end
+
+        def clamdscan(path)
+          `clamdscan --no-summary #{path}`.strip
+        end
+
+        class ClamdScanResult < Ddr::Antivirus::ScanResult
+          
+          def virus_found
+            if m = /: ([^\s]+) FOUND$/.match(raw)
+              m[1]
+            end
+          end
+
+          def has_virus?
+            raw =~ / FOUND$/
+          end
+
+          def error?
+            raw =~ / ERROR$/
+          end
+
+          def ok?
+            raw =~ / OK$/
+          end
+
+          def to_s
+            "#{raw} (#{version})"
+          end
+
+          def default_version
+            `sigtool --version`.strip
+          end
+
+        end
+
+      end
+    end
+  end
+end

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

@@ -10,6 +10,10 @@ module Ddr
           raise NotImplementedError
         end
 
+        def config
+          Ddr::Antivirus.adapter_config
+        end
+
       end
     end
   end

data/lib/ddr/antivirus/version.rb

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

data/spec/shared_examples_for_scan_results.rb

@@ -9,7 +9,7 @@ shared_examples "a scan result" do
     expect(subject.scanned_at).to be_a(Time)
   end
   it "should have a string representation" do
-    expect(subject.to_s).to match(/^Virus scan:/)
+    expect(subject.to_s).not_to be_nil
   end
 end
 
@@ -36,6 +36,13 @@ shared_examples "an error scan result" do
   it "should have an error" do
     expect(subject).to be_error
   end
+  it "shoud not have a virus" do
+    expect(subject.virus_found).to be_nil
+    expect(subject).not_to have_virus
+  end
+  it "should not be ok" do
+    expect(subject).not_to be_ok
+  end
 end
 
 shared_examples "a virus scan result" do
@@ -43,6 +50,13 @@ shared_examples "a virus scan result" 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
   end
+  it "should not have an error" do
+    expect(subject).not_to be_error
+  end
+  it "should not be ok" do
+    expect(subject).not_to be_ok
+  end
 end

data/spec/unit/clamav_scanner_adapter_spec.rb

@@ -1,11 +1,12 @@
-require 'shared_examples_for_scan_results'
+require "shared_examples_for_scan_results"
+require "ddr/antivirus/adapters/clamav_scanner_adapter"
 
 module Ddr
   module Antivirus
     module Adapters
       RSpec.describe ClamavScannerAdapter do
 
-        let(:path) { File.expand_path(File.join("..", "fixtures", "blue-devil.png"), __FILE__) }
+        let(:path) { File.expand_path(File.join("..", "..", "fixtures", "blue-devil.png"), __FILE__) }
 
         describe "#scan" do
           context "when the db is already loaded" do

data/spec/unit/clamd_scanner_adapter_spec.rb

@@ -0,0 +1,39 @@
+require "shared_examples_for_scan_results"
+require "ddr/antivirus/adapters/clamd_scanner_adapter"
+
+module Ddr
+  module Antivirus
+    module Adapters
+      RSpec.describe ClamdScannerAdapter 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 scan result" do
+            expect(subject).to be_a(Ddr::Antivirus::ScanResult)
+          end
+          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
+              expect(subject.virus_found).to eq "Bad-boy-35"
+            end
+            it_should_behave_like "a virus scan result"
+          end
+          context "when there is an error" do
+            before { allow(adapter).to receive(:clamdscan).with(path) { "#{path}: ERROR" } }
+            it "should not have a virus" do
+              expect(subject).not_to have_virus
+            end
+            it_should_behave_like "an error scan result"
+          end
+          context "success" do
+            before { allow(adapter).to receive(:clamdscan).with(path) { "#{path}: OK" } }
+            it_should_behave_like "a successful scan result"
+          end
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddr-antivirus
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-31 00:00:00.000000000 Z
+date: 2014-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -99,14 +99,17 @@ files:
 - lib/ddr/antivirus.rb
 - lib/ddr/antivirus/adapters.rb
 - 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/scanner_adapter.rb
 - lib/ddr/antivirus/scan_result.rb
 - lib/ddr/antivirus/scanner.rb
 - lib/ddr/antivirus/version.rb
+- spec/fixtures/blue-devil.png
 - spec/shared_examples_for_scan_results.rb
 - spec/spec_helper.rb
 - spec/unit/clamav_scanner_adapter_spec.rb
+- spec/unit/clamd_scanner_adapter_spec.rb
 - spec/unit/scan_result_spec.rb
 - spec/unit/scanner_spec.rb
 homepage: https://github.com/duke-libraries/ddr-antivirus
@@ -134,8 +137,10 @@ signing_key:
 specification_version: 4
 summary: Antivirus scanning service.
 test_files:
+- spec/fixtures/blue-devil.png
 - spec/shared_examples_for_scan_results.rb
 - spec/spec_helper.rb
 - spec/unit/clamav_scanner_adapter_spec.rb
+- spec/unit/clamd_scanner_adapter_spec.rb
 - spec/unit/scan_result_spec.rb
 - spec/unit/scanner_spec.rb