clamav-client 1.0.0

data/lib/clamav/responses.rb

@@ -0,0 +1,30 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module ClamAV
+  class Response
+    def initialize(file)
+      @file = file
+    end
+
+    def ==(other)
+      @file == other.file
+    end
+
+    protected
+      attr_reader :file
+  end
+end

data/lib/clamav/responses/error_response.rb

@@ -0,0 +1,21 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'clamav/responses'
+module ClamAV
+  class ErrorResponse < Response
+  end
+end

data/lib/clamav/responses/success_response.rb

@@ -0,0 +1,21 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'clamav/responses'
+module ClamAV
+  class SuccessResponse < Response
+  end
+end

data/lib/clamav/responses/virus_response.rb

@@ -0,0 +1,21 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'clamav/responses'
+module ClamAV
+  class VirusResponse < Response
+  end
+end

data/lib/clamav/util.rb

@@ -0,0 +1,32 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module ClamAV
+  module Util
+    UnknownPathException = Class.new(RuntimeError)
+
+    def Util.path_to_files(path)
+      if Dir.exist?(path)
+        Dir.glob(path + '/*')
+      elsif File.exist?(path)
+        [path]
+      else
+        message =" (path = #{path})"
+        raise UnknownPathException.new("#{__FILE__}:#{__LINE__} path_to_files : path argument neither a file nor a directory. Aborting. #{message}")
+      end
+    end
+  end
+end

data/lib/clamav/wrapper.rb

@@ -0,0 +1,22 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+module ClamAV
+  class Wrapper
+    def wrap_request(request);     raise NotImplementedError; end
+    def unwrap_response(response); raise NotImplementedError; end
+  end
+end

data/lib/clamav/wrappers/new_line_wrapper.rb

@@ -0,0 +1,35 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'clamav/wrapper'
+
+module ClamAV
+  module Wrappers
+    class NewLineWrapper < ::ClamAV::Wrapper
+      def wrap_request(request)
+        "n#{request}\n"
+      end
+
+      def read_response(socket)
+        buff = ""
+        while (char = socket.getc) != "\n"
+          buff << char
+        end
+        buff
+      end
+    end
+  end
+end

data/lib/clamav/wrappers/null_termination_wrapper.rb

@@ -0,0 +1,35 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'clamav/wrapper'
+
+module ClamAV
+  module Wrappers
+    class NullTerminationWrapper < ::ClamAV::Wrapper
+      def wrap_request(request)
+        "z#{request}\0"
+      end
+
+      def read_response(socket)
+        buff = ""
+        while (char = socket.getc) != "\0"
+          buff << char
+        end
+        buff
+      end
+    end
+  end
+end

data/test/fixtures/clamavtest.txt

@@ -0,0 +1 @@
+$CEliacmaTrESTuScikgsn$FREE-TEST-SIGNATURE$EEEEE$

data/test/fixtures/innocent.txt

@@ -0,0 +1 @@
+Innocent!

data/test/integration/clamav/client_test.rb

@@ -0,0 +1,57 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'test_helper'
+
+describe "ClamAV::Client Integration Tests" do
+  describe "default new line delimiter" do
+    let(:client) { ClamAV::Client.new }
+
+    describe "any callable" do
+      it "can be used" do
+        assert client.execute(lambda { |conn| true })
+      end
+    end
+
+    describe "ping" do
+      let(:ping_command) { ClamAV::Commands::PingCommand.new }
+
+      it "can be sent" do
+        assert client.execute(ping_command)
+      end
+
+      it "can be sent multiple times" do
+        assert client.execute(ping_command)
+        assert client.execute(ping_command)
+      end
+    end
+
+    describe "scan" do
+      it "can be started" do
+        dir = File.expand_path('../../../../test/fixtures', __FILE__)
+        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
+      end
+    end
+  end
+end

data/test/integration/clamav/util_test.rb

@@ -0,0 +1,34 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'test_helper'
+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__)
+      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__))
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,19 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'minitest/autorun'
+
+require 'clamav/client'

data/test/unit/clamav/client_test.rb

@@ -0,0 +1,36 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'test_helper'
+
+describe "ClamAV::Client" do
+  describe "its instantiation" do
+
+    let(:conn) { Minitest::Mock.new }
+
+    it "can have its connection injected" do
+      # Given
+      conn.expect(:establish_connection, nil, [])
+
+      # When
+      ClamAV::Client.new(conn)
+
+      # Then
+      conn.verify
+    end
+
+  end
+end

data/test/unit/clamav/commands/ping_command_test.rb

@@ -0,0 +1,33 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'test_helper'
+
+describe "PingCommand" do
+  before do
+    @conn = Minitest::Mock.new
+  end
+
+  after do
+    @conn.verify
+  end
+
+  it "can be called" do
+    @conn.expect(:send_request, '42: PONG', ["PING"])
+
+    assert ClamAV::Commands::PingCommand.new.call(@conn)
+  end
+end

data/test/unit/clamav/commands/scan_command_test.rb

@@ -0,0 +1,36 @@
+# clamav-client - ClamAV client
+# Copyright (C) 2014 Franck Verrot <franck@verrot.fr>
+
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+require 'test_helper'
+
+describe "ScanCommand" do
+  before do
+    @conn = Minitest::Mock.new
+    @path = 'some path'
+  end
+
+  after do
+    @conn.verify
+  end
+
+  it "can recognize a sane file" do
+    @conn.expect(:send_request, "1: #{@path}: OK", ["SCAN #{@path}"])
+
+    ClamAV::Util.stub :path_to_files, [@path] do
+      assert ClamAV::Commands::ScanCommand.new(@path).call(@conn)
+    end
+  end
+end