clamav-client 2.0.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0e16bf843318d1ae3aec44e522c278143affc3d2
-  data.tar.gz: 100e606c288e5a6a3a46a0537e4d4f6f0d989b9c
+  metadata.gz: 11dfc16043cb078ca8546e7d1c6a8b3a8566998d
+  data.tar.gz: 36153ccbb6af07644a62fe8bc3bed19a45bb0c65
 SHA512:
-  metadata.gz: 06d3e9d069ff7875b6f499c78adfbdaae9a29a030fd38f68435393e322cfa3c407c0d53a72d4067550cfa0b09c3da73858c4d944b8ce46f31c95ccb4d3484a0e
-  data.tar.gz: 141d5420ccd5fc6a90332b77184b5c1c593d2b27ce297a2b498677cc7b176a87aa3dffdd86f13173492912f47ed2906faba88daa17280407fbffb092d11df4a4
+  metadata.gz: 412d152f55ad56fd5dc93845a2e2706550248324462f752de4e2f0c3c709830d5285dbbb66d6282f9d2d4da37d5c4ee6a1e21481800440891164218da97fbd6c
+  data.tar.gz: c73336041272d4f4608dc649b5d82c1e4ce9f2c06cb582e870754b9b5ad912e0f87447c88a08872d9259b6678497763c172b9a69eca5dcbdf4573684fb7f0023

data/.travis.yml

@@ -8,4 +8,7 @@ rvm:
   - jruby-19mode
   - jruby-head
   - rbx
-script: rake unit_tests
+before_install: "sudo ./test/ci-setup.sh"
+env:
+  - CLAMD_UNIX_SOCKET=/var/run/clamav/clamd.ctl
+script: rake

data/ChangeLog.md

@@ -0,0 +1,34 @@
+# Unreleased (3.0.0)
+
+  * README:       Added instructions to install ClamAV on Ubuntu, RedHat and CentOS
+  * INSTREAM:     fixed a problem parsing the "FOUND" response
+  * VirusReponse: The virus file name is now held by the VirusReponse object
+
+
+# 2.0.1
+
+  * README.md : ClamAV's setup notes
+  * clamav-client.gemspec : Upgrade gem after yanking it on RG
+
+# 2.0.0
+
+  * lib/clamav/commands/instream_command: Support of INSTREAM
+  * lib/clamav/responses.rb : Change insufficient comparison
+  * README.md: Now backward-compatible back to Ruby 1.9.2
+  * lib/clamav/client.rb : Configure with constants
+    * CLAMD_UNIX_SOCKET
+    * CLAMD_TCP_HOST
+    * CLAMD_TCP_PORT
+  * clamav-client.gemspec : Add the minitest gem for older Rubies
+  * .travis.yml : New test script. Add support for more Rubies
+  * lib/clamav/connection : remove keyword arguments
+  * travis.yml : Add basic configuration
+  * lib/clamav/wrapper.rb : Host common code
+  * lib/clamav/commands/command : Remove dead code
+  * Code format consistency.
+  * Explicit #call() to better document usage.
+  * Code typos; Ruby highlighting; wording.
+
+# 1.0.0
+
+  * Initial release

data/README.md

@@ -20,6 +20,29 @@ Alternatively, you can spawn a `pry` console right away by just running:
 
     $ rake console
 
+### Installing ClamAV's daemon
+
+#### On OSX
+
+If you are using brew, just run
+
+```shell
+brew install clamav
+```
+#### On Linux (Ubuntu)
+```shell
+sudo apt-get install clamav-daemon clamav-freshclam clamav-unofficial-sigs
+sudo freshclam
+sudo service clamav-daemon start
+```
+#### On Linux (RedHat, CentOS)
+```shell
+sudo yum install clamd clamav clamav-db
+sudo freshclam
+sudo service clamd start
+```
+Under RedHat/CentOS the UNIX Socket, located at `/var/run/clamav/clamd.sock`
+
 ## Requirements
 
 * Ruby >= 1.9.2
@@ -157,6 +180,12 @@ over the `CLAMD_UNIX_SOCKET`.
 
 Sets the socket path of the ClamAV daemon.
 
+Under RedHat/CentOS this can either be set via an environment variable (above) or in the ClamAV::Connection call
+```
+connection = ClamAV::Connection.new(socket: ::UNIXSocket.new('/var/run/clamav/clamd.sock'), wrapper: ::ClamAV::Wrappers::NewLineWrapper.new)
+client = ClamAV::Client.new(connection)
+```
+
 #### CLAMD_TCP_HOST and CLAMD_TCP_PORT
 
 Sets the host and port of the ClamAV daemon.

data/clamav-client.gemspec

@@ -3,7 +3,7 @@ $:<< 'lib'
 
 Gem::Specification.new do |spec|
   spec.name          = "clamav-client"
-  spec.version       = "2.0.1"
+  spec.version       = "3.0.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.}

data/lib/clamav/commands/command.rb

@@ -21,23 +21,19 @@ require 'clamav/responses/virus_response'
 module ClamAV
   module Commands
     class Command
-      Statuses = {
-        'OK'                          => ClamAV::SuccessResponse,
-        'ERROR'                       => ClamAV::ErrorResponse,
-        'ClamAV-Test-Signature FOUND' => ClamAV::VirusResponse
-      }
 
       def call; raise NotImplementedError.new; end
 
       protected
 
+        # OK response looks like "1: stream: OK" or "1: /tmp/NOT_A_VIRUS.TXT: OK"
+        # FOUND response looks like "1: stream: Eicar-Test-Signature FOUND" or "1: /tmp/EICAR.COM: Eicar-Test-Signature FOUND"
         def get_status_from_response(str)
-          case str
-          when 'Error processing command. ERROR'
-            ErrorResponse.new(str)
-          else
-            /(?<id>\d+): (?<filepath>.*): (?<status>.*)/ =~ str
-            Statuses[status].new(filepath)
+          /^(?<id>\d+): (?<filepath>.*): (?<virus_name>.*)\s?(?<status>(OK|FOUND))$/ =~ str
+          case status
+          when 'OK' then ClamAV::SuccessResponse.new(filepath)
+          when 'FOUND' then ClamAV::VirusResponse.new(filepath, virus_name.strip)
+          else ClamAV::ErrorResponse.new(str)
           end
         end
 

data/lib/clamav/responses.rb

@@ -16,17 +16,13 @@
 
 module ClamAV
   class Response
-    def initialize(file)
-      @file = file
-    end
 
+    attr_reader :file, :virus_name, :error_str
+
+    # Not sure if this is still required?
     def ==(other)
       @file == other.file && self.class == other.class
     end
 
-    protected
-
-      attr_reader :file
-
   end
 end

data/lib/clamav/responses/error_response.rb

@@ -18,5 +18,10 @@ require 'clamav/responses'
 
 module ClamAV
   class ErrorResponse < Response
+
+    def initialize(error_str)
+      @error_str = error_str
+    end
+
   end
 end

data/lib/clamav/responses/success_response.rb

@@ -18,5 +18,10 @@ require 'clamav/responses'
 
 module ClamAV
   class SuccessResponse < Response
+
+    def initialize(file)
+      @file = file
+    end
+
   end
 end

data/lib/clamav/responses/virus_response.rb

@@ -18,5 +18,11 @@ require 'clamav/responses'
 
 module ClamAV
   class VirusResponse < Response
+
+    def initialize(file, virus_name)
+      @file = file
+      @virus_name = virus_name
+    end
+
   end
 end

data/test/ci-setup.sh

@@ -0,0 +1,7 @@
+# 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

data/test/integration/clamav/client_test.rb

@@ -40,32 +40,42 @@ describe "ClamAV::Client Integration Tests" do
     end
 
     describe "scan" do
+      let(:base_path) { File.expand_path('../../../../', __FILE__) }
+
       it "can be started" do
-        dir = File.expand_path('../../../../test/fixtures', __FILE__)
+        dir = File.join(base_path, 'test/fixtures')
         results = client.execute(ClamAV::Commands::ScanCommand.new(dir))
 
-        expected_results = [
-          ClamAV::VirusResponse.new("/Users/cesario/Development/clamav-client/test/fixtures/clamavtest.gz"),
-          ClamAV::VirusResponse.new("/Users/cesario/Development/clamav-client/test/fixtures/clamavtest.txt"),
-          ClamAV::VirusResponse.new("/Users/cesario/Development/clamav-client/test/fixtures/clamavtest.zip"),
-          ClamAV::SuccessResponse.new("/Users/cesario/Development/clamav-client/test/fixtures/innocent.txt")
-        ]
-        assert_equal expected_results, results
+        expected_results = {
+          "#{base_path}/test/fixtures/clamavtest.gz"  => ClamAV::VirusResponse,
+          "#{base_path}/test/fixtures/clamavtest.txt" => ClamAV::VirusResponse,
+          "#{base_path}/test/fixtures/clamavtest.zip" => ClamAV::VirusResponse,
+          "#{base_path}/test/fixtures/innocent.txt"   => ClamAV::SuccessResponse
+        }
+
+        results.each do |result|
+          expected_result = expected_results[result.file]
+          assert_equal expected_result, result.class
+        end
       end
     end
 
     describe "instream" do
-      it "can be started" do
-        dir = File.expand_path('../../../../test/fixtures', __FILE__)
-
-        [
-          ['clamavtest.txt', ClamAV::VirusResponse],
-          ['innocent.txt',   ClamAV::SuccessResponse]
-        ].each do |file, response_class|
-          io      = File.open(File.join(dir, file))
-          command = ClamAV::Commands::InstreamCommand.new(io)
-          client.execute(command).must_equal response_class.new("stream")
-        end
+      let(:dir) { File.expand_path('../../../../test/fixtures', __FILE__) }
+
+      it "can recognize a sane file" do
+        command = build_command_for_file('innocent.txt')
+        client.execute(command).must_equal ClamAV::SuccessResponse.new("stream")
+      end
+
+      it "can recognize an infected file" do
+        command = build_command_for_file('clamavtest.txt')
+        client.execute(command).must_equal ClamAV::VirusResponse.new("stream", "ClamAV-Test-Signature")
+      end
+
+      def build_command_for_file(file)
+        io = File.open(File.join(dir, file))
+        ClamAV::Commands::InstreamCommand.new(io)
       end
     end
   end

data/test/integration/clamav/util_test.rb

@@ -19,15 +19,22 @@ describe "ClamAV::Client Integration Tests" do
   describe "Util" do
     describe "absolute_path" do
       it "transforms a single file to an array of one element" do
-        assert_equal [File.absolute_path(__FILE__)], ClamAV::Util.path_to_files(__FILE__)
+        expected_path = File.absolute_path(__FILE__)
+        actual_path   = ClamAV::Util.path_to_files(__FILE__).first
+        assert_equal expected_path, actual_path
       end
 
       it "transforms a directory to an array of N element" do
         files = %w(
-          /Users/cesario/Development/clamav-client/test/integration/clamav/client_test.rb
-          /Users/cesario/Development/clamav-client/test/integration/clamav/util_test.rb
-        )
-        assert_equal files, ClamAV::Util.path_to_files(File.dirname(__FILE__))
+          clamav-client/test/integration/clamav/client_test.rb
+          clamav-client/test/integration/clamav/util_test.rb
+        ).sort
+        actual_files = ClamAV::Util.path_to_files(File.dirname(__FILE__)).sort
+
+        files.each_with_index do |file, index|
+          path   = Regexp.new(".*/#{file}")
+          assert path.match(actual_files[index])
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamav-client
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Franck Verrot
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-22 00:00:00.000000000 Z
+date: 2014-07-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -75,6 +75,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- ChangeLog.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -95,6 +96,7 @@ files:
 - lib/clamav/wrapper.rb
 - lib/clamav/wrappers/new_line_wrapper.rb
 - lib/clamav/wrappers/null_termination_wrapper.rb
+- test/ci-setup.sh
 - test/fixtures/clamavtest.gz
 - test/fixtures/clamavtest.txt
 - test/fixtures/clamavtest.zip
@@ -134,6 +136,7 @@ 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/fixtures/clamavtest.gz
 - test/fixtures/clamavtest.txt
 - test/fixtures/clamavtest.zip