clamby 1.5.1 → 1.6.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8580f01b4d5f65af4ee327b290e6e17f074fafb351a95a07d079c4eebad54ae1
-  data.tar.gz: 8b0bc003922e5490d24464954cb01a40084aaf3b7344243c9110a3d1811e57db
+  metadata.gz: e9bf0bfa99f769f41a964838dca46fcb5d6b4c2a2e1653ff43c3a40fde25480f
+  data.tar.gz: 95615a8f2c69aa42a593f909a426266253026c7bc3d24a74dfabb13dd931c526
 SHA512:
-  metadata.gz: 6f7b78e3b031158253bd4cc7809d87a0570710ed7239f3fd837bcab4235baf5bcc182a29fa22669523d037658f2387601973eb36bc6981bc760aeeb03fd392d1
-  data.tar.gz: 56c12c45b4ecc6c9c6162243a8483226213f908d5df10655f409cb106b78881c3f0abfd781f7175757dbc2f50c9abb714952c5085ef420d021f77fe285a29ab3
+  metadata.gz: d4af568ba3f78fb465a18625ff9e9fca343de65b95b155b57cd3b7156d19db876457837331896c3c9c6767326a93f6dcf01f73c5518180df9ff95b7af8868b5e
+  data.tar.gz: 3c2b5004c4b5dbb2fc627a2d20a79307361b5385b3b53dc0500fe1683430db9619d90a18e0aa414d28ce103bbbe9265409462c0d3845f0e6667a76ff788743a6

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .DS_Store/
+.byebug_history

data/.travis.yml

@@ -1,13 +1,14 @@
 language: ruby
 before_install:
-  - gem install bundler -v '>= 1.5.3'
+  - gem install bundler -v '1.17.3'
   - gem install rake
   - gem install rspec
 rvm:
-  - 2.0.0
-  - 2.1.1
   - 2.3.4
   - 2.4.1
+  - 2.5.3
+  - 2.6.3
+  - 2.6.5
 install: 
  - sudo apt-get install clamav
  - sudo freshclam

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v1.6.5
+ - [bennacer860](https://github.com/kobaltz/clamby/commits?author=bennacer860) - Added config data dir option
+
+
+# v1.6.2
+ - [emilong](https://github.com/kobaltz/clamby/commits?author=emilong) - Handle nil exit status of clamav executable.
+
+# v1.6.1
+ - [broder](https://github.com/kobaltz/clamby/commits?author=broder) - Fixed issue with detecting clamdscan version when using custom config file
+
+# v1.6.0
+ - When checking version, use the executable configuration.
+
 # v1.5.1
  - [ahukkanen](https://github.com/kobaltz/clamby/commits?author=ahukkanen) - Configurable execution paths
 

data/README.md

@@ -17,14 +17,14 @@ Just add `gem 'clamby'` to your `Gemfile` and run `bundle install`.
 
 You can use two methods to scan a file for a virus:
 
-If you use `safe?` to scan a file, it will return true if no viruses were found, false if a virus was found, and nil if there was a problem finding the file or if there was a problem using `clamscan`
+If you use `safe?` to scan a file, it will return `true` if no viruses were found, `false` if a virus was found, and `nil` if there was a problem finding the file or if there was a problem using `clamscan`
 
-`safe?(path_to_file)`
+`Clamby.safe?(path_to_file)`
 
-If you use `virus?` to scan a file, it will return true if a virus was found, false if no virus was found, and nil if there was a problem finding the file or if there was a problem using `clamscan`
+If you use `virus?` to scan a file, it will return `true` if a virus was found, `false` if no virus was found, and `nil` if there was a problem finding the file or if there was a problem using `clamscan`
 
 
-`virus?(path_to_file)`
+`Clamby.virus?(path_to_file)`
 
 In your model with the uploader, you can add the scanner to a before method to scan the file. When a file is scanned, a successful scan will return `true`. An unsuccessful scan will return `false`. A scan may be unsuccessful for a number of reasons; `clamscan` could not be found, `clamscan` returned a virus, or the file which you were trying to scan could not be found.
 
@@ -64,6 +64,25 @@ It's good to note that Clamby will not by default delete files which had a virus
   end
 ```
 
+## with ActiveStorage
+
+With ActiveStorage, you don't have access to the file through normal methods, so you'll have to access the file through the `attachment_changes`. 
+
+```ruby
+class User < ApplicationRecord
+  has_one_attached :avatar
+  before_save :scan_for_viruses
+
+  private
+
+  def scan_for_viruses
+    return unless self.attachment_changes['avatar']
+
+    path = self.attachment_changes['avatar'].attachable.tempfile.path
+    Clamby.safe?(path)
+  end
+end
+```
 
 # Configuration
 
@@ -80,7 +99,7 @@ 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_level => 'medium', # one of 'off', 'low', 'medium', 'high'
       :executable_path_clamscan => 'clamscan',
       :executable_path_clamdscan => 'clamdscan',
       :executable_path_freshclam => 'freshclam',
@@ -161,6 +180,11 @@ This opens the root crontab file in a text editor. Add the following line
 
 `57 08 * * * sudo freshclam`
 
+# Contributors
+
+<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
 # LICENSE
 
 Copyright (c) 2016 kobaltz

data/clamby.gemspec

@@ -18,7 +18,8 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "bundler"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
 end

data/lib/clamby.rb

@@ -15,6 +15,7 @@ module Clamby
     :fdpass => false,
     :stream => false,
     :output_level => 'medium',
+    :datadir => nil,
     :executable_path_clamscan => 'clamscan',
     :executable_path_clamdscan => 'clamdscan',
     :executable_path_freshclam => 'freshclam',

data/lib/clamby/command.rb

@@ -21,20 +21,23 @@ 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]
       end
 
+      args << "-d #{Clamby.config[:datadir]}" if Clamby.config[:datadir]
+
       new.run scan_executable, *args
 
-      case $CHILD_STATUS.exitstatus
+      # $CHILD_STATUS maybe nil if the execution itself (not the client process)
+      # fails
+      case $CHILD_STATUS && $CHILD_STATUS.exitstatus
       when 0
         return false
-      when 2
+      when nil, 2
         # clamdscan returns 2 whenever error other than a detection happens
         if Clamby.config[:error_clamscan_client_error] && Clamby.config[:daemonize]
           raise Clamby::ClamscanClientError.new("Clamscan client error")
         end
-
+ 
         # returns true to maintain legacy behavior
         return true
       else
@@ -46,12 +49,14 @@ module Clamby
 
     # Update the virus definitions.
     def self.freshclam
-      new.run 'freshclam'
+      args = []
+      args << "--datadir=#{Clamby.config[:datadir]}" if Clamby.config[:datadir]
+      new.run 'freshclam', *args
     end
 
     # Show the ClamAV version. Also acts as a quick check if ClamAV functions.
     def self.clamscan_version
-      new.run 'clamscan', '--version'
+      new.run scan_executable, '--version'
     end
 
     # Run the given commands via a system call.
@@ -67,13 +72,14 @@ module Clamby
       self.command = args | default_args
       self.command = command.sort.unshift(executable_full)
 
-      system(*self.command, system_options)
+      system(self.command.join(' '), system_options)
     end
 
     private
 
     def default_args
       args = []
+      args << "--config-file=#{Clamby.config[:config_file]}" if Clamby.config[:daemonize] && Clamby.config[:config_file]
       args << '--quiet' if Clamby.config[:output_level] == 'low'
       args << '--verbose' if Clamby.config[:output_level] == 'high'
       args

data/lib/clamby/version.rb

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

data/spec/clamby/command_spec.rb

@@ -34,7 +34,7 @@ describe Clamby::Command do
 
     describe 'passing file descriptor' do
       it 'does not include fdpass in the command by default' do
-        Clamby.configure(fdpass: false)
+        Clamby.configure
         expect(runner).to receive(:run).with('clamscan', good_path, '--no-summary')
         allow(described_class).to receive(:new).and_return(runner)
 
@@ -60,7 +60,7 @@ describe Clamby::Command do
 
     describe 'streaming files to clamd' do
       it 'does not include stream in the command by default' do
-        Clamby.configure(stream: false)
+        Clamby.configure
         expect(runner).to receive(:run).with('clamscan', good_path, '--no-summary')
         allow(described_class).to receive(:new).and_return(runner)
 
@@ -86,32 +86,24 @@ describe Clamby::Command do
 
     describe 'specifying config-file' do
       it 'does not include the parameter in the clamscan command by default' do
-        Clamby.configure(daemonize: false, stream: false, fdpass: false)
-        expect(runner).to receive(:run).with('clamscan', good_path, '--no-summary')
-        allow(described_class).to receive(:new).and_return(runner)
+        Clamby.configure
 
-        described_class.scan(good_path)
+        expect(described_class.new.send(:default_args)).not_to include(a_string_matching(/--config-file/))
       end
       it 'does not include the parameter in the clamdscan command by default' do
-        Clamby.configure(daemonize: true, stream: false, fdpass: false)
-        expect(runner).to receive(:run).with('clamdscan', good_path, '--no-summary')
-        allow(described_class).to receive(:new).and_return(runner)
+        Clamby.configure(daemonize: true)
 
-        described_class.scan(good_path)
+        expect(described_class.new.send(:default_args)).not_to include(a_string_matching(/--config-file/))
       end
       it 'omits the parameter when invoking clamscan if it is set' do
-        Clamby.configure(daemonize: false, stream: false, fdpass: false, config_file: 'clamd.conf')
-        expect(runner).to receive(:run).with('clamscan', good_path, '--no-summary')
-        allow(described_class).to receive(:new).and_return(runner)
+        Clamby.configure(daemonize: false, config_file: 'clamd.conf')
 
-        described_class.scan(good_path)
+        expect(described_class.new.send(:default_args)).not_to include('--config-file=clamd.conf')
       end
       it 'passes the parameter when invoking clamdscan if it is set' do
-        Clamby.configure(daemonize: true, stream: false, fdpass: false, config_file: 'clamd.conf')
-        expect(runner).to receive(:run).with('clamdscan', good_path, '--no-summary', '--config-file=clamd.conf')
-        allow(described_class).to receive(:new).and_return(runner)
+        Clamby.configure(daemonize: true, config_file: 'clamd.conf')
 
-        described_class.scan(good_path)
+        expect(described_class.new.send(:default_args)).to include('--config-file=clamd.conf')
       end
     end
 

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: clamby
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.6
 platform: ruby
 authors:
 - kobaltz
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-12-02 00:00:00.000000000 Z
+date: 2020-07-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +52,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Clamby allows users to scan files uploaded with Paperclip or Carrierwave.
   If a file has a virus, then you can delete this file and discard it without causing
   harm to other users.
@@ -86,7 +100,7 @@ homepage: ''
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -101,9 +115,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
-signing_key: 
+rubygems_version: 3.0.8
+signing_key:
 specification_version: 4
 summary: Scan file uploads with ClamAV
 test_files: