clamby 1.5.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 14e5489bd2c961059e2642dfcd7e472a838c449d114ba7ce7849eb4a7d8a2ae9
-  data.tar.gz: a0e7743a75f54442325af1773d923eb3ead7342efb6fd147733020c2ad85551b
+  metadata.gz: 8580f01b4d5f65af4ee327b290e6e17f074fafb351a95a07d079c4eebad54ae1
+  data.tar.gz: 8b0bc003922e5490d24464954cb01a40084aaf3b7344243c9110a3d1811e57db
 SHA512:
-  metadata.gz: ec80ea427e309f396664d599e28e742ddbf1913f1f4c5a58e3be43557bd9ad0f85276827e58511d2132ce4c89e6ab577082d0e7dcc471dfea92cf3c08b448e44
-  data.tar.gz: '079f33a665afff1f99e6df4e8c6c7be877b5bade43d8d2fc4270976b77de7b84fc2cdeec8f1791c19b8c79b8ac921cd90e6974a448af0db6c96a2bac28601654'
+  metadata.gz: 6f7b78e3b031158253bd4cc7809d87a0570710ed7239f3fd837bcab4235baf5bcc182a29fa22669523d037658f2387601973eb36bc6981bc760aeeb03fd392d1
+  data.tar.gz: 56c12c45b4ecc6c9c6162243a8483226213f908d5df10655f409cb106b78881c3f0abfd781f7175757dbc2f50c9abb714952c5085ef420d021f77fe285a29ab3

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+# v1.5.1
+ - [ahukkanen](https://github.com/kobaltz/clamby/commits?author=ahukkanen) - Configurable execution paths
+
 # v1.5.0
  - Exceptions are now raised under Clamby module - could be breaking change
  - [szajbus](https://github.com/kobaltz/clamby/commits?author=szajbus) fixed specs! and updated README

data/README.md

@@ -1,6 +1,7 @@
 ![Clamby Logo](https://raw.github.com/kobaltz/clamby/master/clamby_logo.png)
 
 [![GemVersion](https://badge.fury.io/rb/clamby.png)](https://badge.fury.io/rb/clamby.png)
+[![Build Status](https://travis-ci.org/kobaltz/clamby.svg?branch=master)](https://travis-ci.org/kobaltz/clamby)
 
 This gem depends on the [clamscan](http://www.clamav.net/) and `freshclam` daemons to be installed already.
 
@@ -79,7 +80,10 @@ Configuration is rather limited right now. You can exclude the check if `clamsca
       :error_file_virus => false,
       :fdpass => false,
       :stream => false,
-      :output => 'medium' # one of 'off', 'low', 'medium', 'high'
+      :output => 'medium', # one of 'off', 'low', 'medium', 'high'
+      :executable_path_clamscan => 'clamscan',
+      :executable_path_clamdscan => 'clamdscan',
+      :executable_path_freshclam => 'freshclam',
     })
 ```
 
@@ -112,6 +116,22 @@ Setting the `stream` configuration option will stream the file to the daemon. Th
 - *medium*: show errors and briefly what happened _(default)_
 - *high*: as verbose as possible
 
+#### Executable paths
+
+Setting any of the executable paths makes Clamby to use those paths instead of
+the defaults for the system calls. The default configuration for these should be
+perfectly fine for most use cases but it may be required to configure custom
+paths in case ClamAV is manually installed to a custom location.
+
+In order to configure the paths, use the following configuration options:
+
+- *executable_path_clamscan*: defines the executable path for the `clamscan`
+  executable, defaults to `clamscan`
+- *executable_path_clamdscan*: defines the executable path for the `clamdscan`
+  executable, defaults to `clamdscan`
+- *executable_path_freshclam*: defines the executable path for the `freshclam`
+  executable, defaults to `freshclam`
+
 # Dependencies
 
 ***Ubuntu***

data/lib/clamby.rb

@@ -14,7 +14,10 @@ module Clamby
     :error_file_virus => false,
     :fdpass => false,
     :stream => false,
-    :output_level => 'medium'
+    :output_level => 'medium',
+    :executable_path_clamscan => 'clamscan',
+    :executable_path_clamdscan => 'clamdscan',
+    :executable_path_freshclam => 'freshclam',
   }.freeze
 
   @config = DEFAULT_CONFIG.dup

data/lib/clamby/command.rb

@@ -21,7 +21,7 @@ module Clamby
       if Clamby.config[:daemonize]
         args << '--fdpass' if Clamby.config[:fdpass]
         args << '--stream' if Clamby.config[:stream]
-        args << "--config-file=#{Clamby.config[:config_file]}" if Clamby.config[:config_file] && Clamby.config[:daemonize]
+        args << "--config-file=#{Clamby.config[:config_file]}" if Clamby.config[:config_file]
       end
 
       new.run scan_executable, *args
@@ -63,9 +63,9 @@ module Clamby
     #   run('clamscan', file, '--verbose')
     #   run('clamscan', '-V')
     def run(executable, *args)
-      raise "`#{executable}` is not permitted" unless EXECUTABLES.include?(executable)
+      executable_full = executable_path(executable)
       self.command = args | default_args
-      self.command = command.sort.unshift(executable)
+      self.command = command.sort.unshift(executable_full)
 
       system(*self.command, system_options)
     end
@@ -88,6 +88,11 @@ module Clamby
       end
     end
 
+    def executable_path(executable)
+      raise "`#{executable}` is not permitted" unless EXECUTABLES.include?(executable)
+      Clamby.config[:"executable_path_#{executable}"]
+    end
+
     def self.file_exists?(path)
       return true if File.file?(path)
 

data/lib/clamby/version.rb

@@ -1,3 +1,3 @@
 module Clamby
-  VERSION = "1.5.0"
+  VERSION = "1.5.1"
 end

data/spec/clamby/command_spec.rb

@@ -114,5 +114,58 @@ describe Clamby::Command do
         described_class.scan(good_path)
       end
     end
+
+    describe 'specifying custom executable paths' do
+      let(:runner) { described_class.new }
+      let(:custom_path) { '/custom/path' }
+
+      before do
+        Clamby.configure(
+          executable_path_clamscan: "#{custom_path}/clamscan",
+          executable_path_clamdscan: "#{custom_path}/clamdscan",
+          executable_path_freshclam: "#{custom_path}/freshclam",
+        )
+        allow(described_class).to receive(:new).and_return(runner)
+      end
+
+      it 'executes the freshclam executable from the custom path' do
+        expect(runner).to receive(:system).with(
+          "#{custom_path}/freshclam",
+          {}
+        ) { system("exit 0", out: File::NULL) }
+
+        described_class.freshclam
+      end
+
+      context 'when not set with daemonize' do
+        before { Clamby.configure(daemonize: false) }
+
+        it 'executes the clamscan executable from the custom path' do
+          expect(runner).to receive(:system).with(
+            "#{custom_path}/clamscan",
+            '--no-summary',
+            good_path,
+            {}
+          ) { system("exit 0", out: File::NULL) }
+
+          described_class.scan(good_path)
+        end
+      end
+
+      context 'when set with daemonize' do
+        before { Clamby.configure(daemonize: true) }
+
+        it 'executes the clamdscan executable from the custom path' do
+          expect(runner).to receive(:system).with(
+            "#{custom_path}/clamdscan",
+            '--no-summary',
+            good_path,
+            {}
+          ) { system("exit 0", out: File::NULL) }
+
+          described_class.scan(good_path)
+        end
+      end
+    end
   end
 end

data/spec/clamby_spec.rb

@@ -107,4 +107,39 @@ describe Clamby do
       end
     end
   end
+
+  context 'executable paths' do
+    context 'executable_path_clamscan option' do
+      it 'is clamscan by default' do
+        expect(Clamby.config[:executable_path_clamscan]).to eq 'clamscan'
+      end
+      it 'accepts an executable_path_clamscan option in the config' do
+        path = '/custom/path/clamscan'
+        Clamby.configure(executable_path_clamscan: path)
+        expect(Clamby.config[:executable_path_clamscan]).to eq path
+      end
+    end
+
+    context 'executable_path_clamdscan option' do
+      it 'is clamdscan by default' do
+        expect(Clamby.config[:executable_path_clamdscan]).to eq 'clamdscan'
+      end
+      it 'accepts an executable_path_clamdscan option in the config' do
+        path = '/custom/path/clamdscan'
+        Clamby.configure(executable_path_clamdscan: path)
+        expect(Clamby.config[:executable_path_clamdscan]).to eq path
+      end
+    end
+
+    context 'executable_path_freshclam option' do
+      it 'is freshclam by default' do
+        expect(Clamby.config[:executable_path_freshclam]).to eq 'freshclam'
+      end
+      it 'accepts an executable_path_freshclam option in the config' do
+        path = '/custom/path/freshclam'
+        Clamby.configure(executable_path_freshclam: path)
+        expect(Clamby.config[:executable_path_freshclam]).to eq path
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamby
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.5.1
 platform: ruby
 authors:
 - kobaltz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-11-15 00:00:00.000000000 Z
+date: 2018-12-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler