ddr-antivirus 1.3.0 → 1.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 86a232e5b90342f2dd51279b2e589e51d7345a23
-  data.tar.gz: e48ae1a5fe0a895d18784a6ba120a0e7dfa892ba
+  metadata.gz: b3ef82b06ad7b12f5c73b2bf8d223baf3b2e3b3d
+  data.tar.gz: c764fe1c7b36acf7cb592da9105b0f32b923fa2d
 SHA512:
-  metadata.gz: 173c325eb8d7369d7823341593334e229ae5a48047938a680fda9afc21a6151d6e34722864a9acda826fd1f11113526b086bc7dc45acdaf7a410c8a70b4e0ee8
-  data.tar.gz: 51d17a1ea969fab1d69f86b4bd1f3c870fdcef45d7362f96bebb9387ab95105f2e61e55c79eee1be628a254d5ef15acffd0d894a6a6414bbc7a88e96a52bd3af
+  metadata.gz: 77b13b6df4c1f71d28817fbd1a851a3387bd5083b5ba811745aabf9ba67c8f0437bfa6ba34b3b6fcafad44cdb2fcb7e958f34c8d34a71dfeca43c6736e6044b6
+  data.tar.gz: 6610ac368e938e6b968bd95aa9bc93b2b6eb9dec5c2fb04b2fc0b01ea278638b7b599275211728849632cdfdaf086691eefed7c88ab90a2c443db8b4eb21078c

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in ddr-antivirus.gemspec
 gemspec
+
+gem "coveralls", require: false

data/README.md

@@ -1,9 +1,11 @@
 # Ddr::Antivirus
 
-[![Gem Version](https://badge.fury.io/rb/ddr-antivirus.svg)](http://badge.fury.io/rb/ddr-antivirus)
-[![Build Status](https://travis-ci.org/duke-libraries/ddr-antivirus.svg?branch=master)](https://travis-ci.org/duke-libraries/ddr-antivirus)
+Pluggable antivirus service for Ruby applications.
 
-Antivirus scanner for Ruby applications.
+[![Gem Version](https://badge.fury.io/rb/ddr-antivirus.svg)](http://badge.fury.io/rb/ddr-antivirus)
+[![Build Status](https://travis-ci.org/duke-libraries/ddr-antivirus.svg?branch=develop)](https://travis-ci.org/duke-libraries/ddr-antivirus)
+[![Coverage Status](https://coveralls.io/repos/duke-libraries/ddr-antivirus/badge.png?branch=develop)](https://coveralls.io/r/duke-libraries/ddr-antivirus?branch=develop)
+[![Code Climate](https://codeclimate.com/github/duke-libraries/ddr-antivirus/badges/gpa.svg)](https://codeclimate.com/github/duke-libraries/ddr-antivirus)
 
 ## Installation
 

data/ddr-antivirus.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Ddr::Antivirus::VERSION
   spec.authors       = ["David Chandek-Stark"]
   spec.email         = ["dchandekstark@gmail.com"]
-  spec.summary       = %q{Antivirus scanning service.}
-  spec.description   = %q{Antivirus scanning service.}
+  spec.summary       = "Pluggable antivirus scanning service."
+  spec.description   = "Pluggable antivirus scanning service."
   spec.homepage      = "https://github.com/duke-libraries/ddr-antivirus"
   spec.license       = "BSD-3-Clause"
 

data/lib/ddr/antivirus.rb

@@ -41,11 +41,9 @@ module Ddr
         require "clamav"
         :clamav
       rescue LoadError
-        if system "which -a clamdscan"
-          :clamd
-        else
-          :null
-        end
+        require "open3"
+        out, status = Open3.capture2e("which -a clamdscan")
+        status.success? ? :clamd : :null
       end
     end
 

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

@@ -6,15 +6,18 @@ require_relative "scan_result"
 module Ddr
   module Antivirus
     module Adapters
-
+      #
+      # Scanner adapter for the 'clamav' gem (Ruby libclamav bindings).
+      #
       class ClamavScannerAdapter < ScannerAdapter
-
+        
         def scan(path)
           reload!
           raw = engine.scanfile(path)
           ClamavScanResult.new(raw, path)
         end
 
+        # Load or reload the database of virus signatures.
         def reload!
           #
           # ClamAV.instance.reload is supposed to reload the database if changed and return:
@@ -54,6 +57,8 @@ module Ddr
           raw == 1
         end
 
+        # A formatted status message (for consistency with clamdscan output).
+        # @return [String] the result status.
         def status
           return "FOUND #{virus_found}" if has_virus?
           return "ERROR" if error?

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

@@ -5,9 +5,7 @@ module Ddr
   module Antivirus
     module Adapters
       #
-      # ClamdScannerAdapter uses an external ClamAV daemon (clamd)
-      # 
-      # See https://github.com/soundarapandian/clamd for configuration method and options.
+      # Adapter for clamd client (clamdscan)
       #
       class ClamdScannerAdapter < ScannerAdapter
 

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

@@ -5,7 +5,7 @@ module Ddr
   module Antivirus
     module Adapters
       #
-      # The NullScannerAdapter provides a no-op adapter, primarily for testing and development.
+      # A no-op adapter, primarily for testing and development.
       #
       class NullScannerAdapter < ScannerAdapter
 

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

@@ -2,7 +2,7 @@ module Ddr
   module Antivirus
     module Adapters
       #
-      # Default scan result implementation
+      # The result of a virus scan.
       # 
       class ScanResult
         
@@ -15,32 +15,42 @@ module Ddr
           @version = opts.fetch(:version, default_version)
         end
 
+        # Default time of virus scan - i.e., now.
+        # @return [Time] the time.
         def default_time
           Time.now.utc
         end
 
+        # Default anti-virus software version information.
+        # @return [String] the version.
         def default_version
           "ddr-antivirus #{Ddr::Antivirus::VERSION}"
         end
 
-        # Subclasses may override to provide description of virus found.
+        # the name of virus found.
+        # @return [String] the virus name.
         def virus_found; end
 
-        # Subclasses should override
+        # Was a virus found? 
+        # @return [true, false] whether a virus was found.
         def has_virus?
           !virus_found.nil?
         end
 
-        # Subclasses may override to indicate an error condition (not necessarily an exception).
+        # Was there an error (reported by the scanner, not necessarily an exception)?
+        # @return [true, false] whether there was an error.
         def error?
           false
         end
 
+        # Was the result OK - i.e., not an error and virus not found.
+        # @return [true, false] whether the result was OK.
         def ok?
           !(has_virus? || error?)
         end
 
-        # Subclasses may override
+        # String representation of the result
+        # @return [String] the representation.
         def to_s
           "#{raw} (#{version})"
         end
@@ -49,4 +59,3 @@ module Ddr
     end
   end
 end
-

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

@@ -2,16 +2,16 @@ module Ddr
   module Antivirus
     module Adapters
       #
-      # Abstract class for scanner adapters.
-      # 
+      # @abstract Subclass and override {#scan} to implement a scanner adapter.
+      #
       class ScannerAdapter
 
-        # Scan a file path for viruses - subclasses must implement.
+        # Scan a file path for viruses.
         #
-        # @param [String] file path to scan
-        # @return [Ddr::Antivirus::ScanResult] the result
+        # @param path [String] file path to scan.
+        # @return [Ddr::Antivirus::Adapters::ScanResult] the result of the scan.
         def scan(path)
-          raise NotImplementedError
+          raise NotImplementedError, "Adapters must implement the `scan' method."
         end
 
         # Return the adapter configuration options

data/lib/ddr/antivirus/version.rb

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

data/spec/spec_helper.rb

@@ -1,3 +1,6 @@
+require "coveralls"
+Coveralls.wear!
+
 # This file was generated by the `rspec --init` command. Conventionally, all
 # specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
 # The generated `.rspec` file contains `--require spec_helper` which will cause this

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ddr-antivirus
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.3.1
 platform: ruby
 authors:
 - David Chandek-Stark
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-14 00:00:00.000000000 Z
+date: 2015-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -80,7 +80,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Antivirus scanning service.
+description: Pluggable antivirus scanning service.
 email:
 - dchandekstark@gmail.com
 executables: []
@@ -136,7 +136,7 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Antivirus scanning service.
+summary: Pluggable antivirus scanning service.
 test_files:
 - spec/fixtures/blue-devil.png
 - spec/shared_examples_for_scan_results.rb