clamav-client 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: f0765081b986a543225746b34463d67904e78d24
-  data.tar.gz: 02d2787cb4e94a0551a368571429b3ea603b2e73
+SHA256:
+  metadata.gz: 9faaee84d1654a9496db2e440016f43d48ac89bced72a9b52fcce5c31740ce6a
+  data.tar.gz: 3aeda255bb63e3c1472f3f9f40924b6d0ba1fd27aa13b545e7c3ad530af55ade
 SHA512:
-  metadata.gz: 7f0fd0c5d6328d0335990864a2bfa8a7431134b864d6348ccb01d0f7576c0fd64256f0b72e7dd6bbfd766b29cf69a12f948335d1df82f646395a7a20aa879931
-  data.tar.gz: 1898edd1566913d9a2702a5372adbf8c870d5e20be424c81e362a8708de1280a67132272b871fb0315826bd648d9ec1a57865c9443be384fe7707f4f903324ac
+  metadata.gz: 4a75c056a1546df14e3ef2d74f4c7d8ad4f6a31aa573f5da24ff5042bb783cf398ddd8918ab3e946310084eec094dc8bf4aae11b46817f0b1c3780b65875f2a0
+  data.tar.gz: d50abc42b02b48e654ada918bcfba393c5f8d881365a0e2f92b256a3c8b50fea8a20e5c05c081910f41fba83ed4bcc0d05397edde8bff84bcbd03f55a76f20d4

data/.circleci/config.yml

@@ -0,0 +1,44 @@
+version: 2
+
+shared: &shared
+  working_directory: ~/repo
+  docker:
+    - image: docker:18.09.2
+  steps:
+    - checkout
+    - setup_remote_docker
+    - run:
+        name: build image
+        command: |
+          docker build -f test/Dockerfile --build-arg RUBY_VERSION -t franckverrot/clamav-client .
+    - run:
+        name: run tests
+        command: |
+          docker run franckverrot/clamav-client rake
+
+jobs:
+  "2.4":
+    <<: *shared
+    environment:
+      RUBY_VERSION=2.4-stretch
+  "2.5":
+    <<: *shared
+    environment:
+      RUBY_VERSION=2.5-stretch
+  "2.6":
+    <<: *shared
+    environment:
+      RUBY_VERSION=2.6-stretch
+  "2.7":
+    <<: *shared
+    environment:
+      RUBY_VERSION=2.7-slim
+
+workflows:
+  version: 2
+  build:
+    jobs:
+      - "2.4"
+      - "2.5"
+      - "2.6"
+      - "2.7"

data/ChangeLog.md

@@ -1,6 +1,12 @@
-# Unreleased (3.1.0)
+# Unreleased
 
-# 3.0.1
+# 3.2.0
+
+  * Add `ClamAV::Client#ping` as a short-hand for executing a ping
+  * Add `ClamAV::Client#safe?` as a way to check both streams and files
+  * Add support for Ruby 2.7
+
+# 3.1.0
 
   * Drop support for old Rubies (prior to 2.2)
   * Drop fixtures from the gem

data/README.md

@@ -45,7 +45,7 @@ Under RedHat/CentOS the UNIX Socket, located at `/var/run/clamav/clamd.sock`
 
 ## Requirements
 
-* Ruby >= 1.9.2
+* Ruby >= 2.4
 * clamd
 
 ## Usage
@@ -190,6 +190,10 @@ client = ClamAV::Client.new(connection)
 
 Sets the host and port of the ClamAV daemon.
 
+## Licensing
+
+GPLv3. COMMERCIAL license available upon request.
+
 ## Contributing
 
 1. Fork it ( https://github.com/franckverrot/clamav-client/fork )

data/clamav-client.gemspec

@@ -3,7 +3,7 @@ $:<< 'lib'
 
 Gem::Specification.new do |spec|
   spec.name          = "clamav-client"
-  spec.version       = "3.1.0"
+  spec.version       = "3.2.0"
   spec.authors       = ["Franck Verrot"]
   spec.email         = ["franck@verrot.fr"]
   spec.summary       = %q{ClamAV::Client connects to a Clam Anti-Virus clam daemon and send commands.}
@@ -16,7 +16,7 @@ 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 "pry"
   spec.add_development_dependency "minitest"

data/lib/clamav/client.rb

@@ -49,5 +49,24 @@ module ClamAV
         ::UNIXSocket.new(unix_socket || '/var/run/clamav/clamd.ctl')
       end
     end
+
+    def ping
+      execute Commands::PingCommand.new
+    end
+
+    def safe?(target)
+      return instream(target).virus_name.nil? if target.is_a?(StringIO)
+      scan(target).all? { |file| file.virus_name.nil? }
+    end
+
+    private
+
+    def instream(io)
+      execute Commands::InstreamCommand.new(io)
+    end
+
+    def scan(file_path)
+      execute Commands::ScanCommand.new(file_path)
+    end
   end
 end

data/start.sh

@@ -0,0 +1,6 @@
+#!/bin/bash
+set -ex
+
+service clamav-daemon start
+
+exec "$@"

data/test/Dockerfile

@@ -0,0 +1,16 @@
+ARG RUBY_VERSION
+FROM ruby:${RUBY_VERSION}
+LABEL maintainer="franck@verrot.fr"
+
+WORKDIR /clamav-client
+ADD Gemfile /clamav-client
+ADD clamav-client.gemspec /clamav-client
+
+RUN apt-get update -qq && \
+      apt-get install -y clamav-daemon clamav-freshclam clamav-unofficial-sigs && \
+      freshclam && \
+      bundle
+
+ENTRYPOINT ["./start.sh"]
+
+ADD . /clamav-client

data/test/integration/clamav/client_test.rb

@@ -37,13 +37,17 @@ describe "ClamAV::Client Integration Tests" do
         assert client.execute(ping_command)
         assert client.execute(ping_command)
       end
+
+      it "can be used as #ping" do
+        assert_equal client.execute(ping_command), client.ping
+      end
     end
 
     describe "scan" do
       let(:base_path) { File.expand_path('../../../../', __FILE__) }
+      let(:dir) { File.join(base_path, 'test/fixtures') }
 
       it "can be started" do
-        dir = File.join(base_path, 'test/fixtures')
         results = client.execute(ClamAV::Commands::ScanCommand.new(dir))
 
         expected_results = {
@@ -58,6 +62,10 @@ describe "ClamAV::Client Integration Tests" do
           assert_equal expected_result, result.class
         end
       end
+
+      it "can be used as #scan" do
+        assert_equal client.execute(ClamAV::Commands::ScanCommand.new(dir)), client.send(:scan, dir)
+      end
     end
 
     describe "instream" do
@@ -73,10 +81,42 @@ describe "ClamAV::Client Integration Tests" do
         client.execute(command).must_equal ClamAV::VirusResponse.new("stream", "ClamAV-Test-Signature")
       end
 
+      it "can be used as #instream" do
+        io = File.open(File.join(dir, 'innocent.txt'))
+        assert_equal client.execute(ClamAV::Commands::InstreamCommand.new(io)), client.send(:instream, io)
+      end
+
       def build_command_for_file(file)
         io = File.open(File.join(dir, file))
         ClamAV::Commands::InstreamCommand.new(io)
       end
     end
+
+    describe 'safe?' do
+      let(:dir) { File.expand_path('../../../../test/fixtures', __FILE__) }
+
+      it 'returns true if the given io is safe' do
+        io = build_io_obj('innocent.txt')
+        assert client.safe?(io)
+      end
+
+      it 'returns false if the given io is infected' do
+        io = build_io_obj('clamavtest.txt')
+        refute client.safe?(io)
+      end
+
+      it 'returns false if there is any infected file in the given files' do
+        refute client.safe?(dir)
+      end
+
+      it 'returns true if all the give file is safe' do
+        assert client.safe?("#{dir}/innocent.txt")
+      end
+
+      def build_io_obj(file)
+        content = File.read(File.join(dir, file))
+        io = StringIO.new(content)
+      end
+    end
   end
 end

metadata

@@ -1,29 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: clamav-client
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Franck Verrot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2020-02-14 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
@@ -73,8 +73,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".circleci/config.yml"
 - ".gitignore"
-- ".travis.yml"
 - ChangeLog.md
 - Gemfile
 - LICENSE.txt
@@ -96,7 +96,8 @@ files:
 - lib/clamav/wrapper.rb
 - lib/clamav/wrappers/new_line_wrapper.rb
 - lib/clamav/wrappers/null_termination_wrapper.rb
-- test/ci-setup.sh
+- start.sh
+- test/Dockerfile
 - test/integration/clamav/client_test.rb
 - test/integration/clamav/util_test.rb
 - test/test_helper.rb
@@ -126,13 +127,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.4
+rubygems_version: 3.0.2
 signing_key: 
 specification_version: 4
 summary: ClamAV::Client connects to a Clam Anti-Virus clam daemon and send commands.
 test_files:
-- test/ci-setup.sh
+- test/Dockerfile
 - test/integration/clamav/client_test.rb
 - test/integration/clamav/util_test.rb
 - test/test_helper.rb

data/.travis.yml

@@ -1,11 +0,0 @@
-language: ruby
-rvm:
-  - 2.3.1
-  - 2.2.5
-  - ruby-head
-  - jruby-head
-  - rbx
-before_install: "sudo ./test/ci-setup.sh"
-env:
-  - CLAMD_UNIX_SOCKET=/var/run/clamav/clamd.ctl
-script: rake

data/test/ci-setup.sh

@@ -1,7 +0,0 @@
-# Update Ubuntu and install ClamAV
-apt-get update
-apt-get install clamav-daemon clamav-freshclam clamav-unofficial-sigs
-
-# Update the signature database and start the daemon
-freshclam
-service clamav-daemon start