littleneck_clamav 0.0.1

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--tty

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (C) 2012 Theo Cushion
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,50 @@
+Littleneck ClamAV [![Build status](https://secure.travis-ci.org/theozaurus/littleneck_clamav.png)](http://travis-ci.org/theozaurus/littleneck_clamav)
+=================
+
+[Littleneck ClamAV](http://github.com/theozaurus/littleneck_clamav) is a thin
+wrapper to make it quick and easy to use [ClamAV](http://www.clamav.net) within
+Ruby.
+
+It will use `clamdscan` if available to save load time, or fallback to
+`clamscan` if it is not. Compilation is avoided by using the command line
+interface of ClamAV, and as such Littleneck expects a working and up to date
+ClamAV installation.
+
+Requirements
+============
+
+It is currently fully tested against:
+
+ - Ruby 1.9.3
+
+Usage
+=====
+
+To scan a file:
+
+    scanner = LittleneckClamAV.new
+    result = scanner.scan "jeepers.txt"
+    result.clean?
+    => false
+    result.infected?
+    => true
+    result.description
+    => "HLLP.Creeper.5127"
+    result.path
+    => "jeepers.txt"
+
+To find out about the scanners database
+
+    scanner.database_version
+    => 15306
+    scanner.database_date
+    => 2012-08-28 20:18:12 +00:00
+    scanner.engine
+    => "0.97.5"
+
+You can specify a specific scanner to use as well
+
+    scanner = LittleneckClamAV::Clam.new
+    # or
+    scanner = LittleneckClamAV::Clamd.new
+

data/lib/littleneck_clamav/clam.rb

@@ -0,0 +1,81 @@
+require "cocaine"
+require "time"
+
+require_relative "result"
+require_relative "error"
+
+class LittleneckClamAV
+
+  class Clam
+
+    def engine
+      version[:engine] if available?
+    end
+
+    def database_version
+      version[:database_version].to_i if available?
+    end
+
+    def database_date
+      Time.parse(version[:database_date]) if available?
+    end
+
+    def available?
+      version[:success]
+    end
+
+    def scan(path)
+      check_scan! path
+      opts = { :swallow_stderr => true, :expected_outcodes => [0, 1] }
+      params = ["--no-summary", path].join(" ")
+      output = Cocaine::CommandLine.new( command, params, opts ).run
+      parse_result path, output, $?.exitstatus
+    end
+
+    def command
+      "clamscan"
+    end
+
+  private
+
+    def version
+      @version ||= begin
+        opts = { :swallow_stderr => true }
+        params = "--version"
+        output = Cocaine::CommandLine.new( command, params, opts ).run
+        output.strip!
+        engine, db_version, db_date = output.sub(/^ClamAV /,'').split("/",3)
+        success = !!(db_version && db_date)
+        {
+          :output           => output,
+          :engine           => engine,
+          :database_version => db_version,
+          :database_date    => db_date,
+          :success          => success
+        }
+      rescue Cocaine::ExitStatusError, Cocaine::CommandNotFoundError => e
+        {:error => e.message, :success => false }
+      end
+    end
+
+    def parse_result(path, output, code)
+      clean = $?.exitstatus == 0
+      description = output.split(":").last.strip
+      description.sub! " FOUND", ""
+      Result.new :path => path, :clean => clean, :description => description
+    end
+
+    def check_scan!(path)
+      exists = File.exists? path
+      if !exists
+        raise Error, "the path #{path} does not exist"
+      elsif !available?
+        message = "#{self.class} is not available"
+        message << "because #{version[:message]}" if version[:message]
+        raise Error, message
+      end
+    end
+
+  end
+
+end

data/lib/littleneck_clamav/clamd.rb

@@ -0,0 +1,13 @@
+require_relative "clam"
+
+class LittleneckClamAV
+
+  class Clamd < Clam
+
+    def command
+      "clamdscan"
+    end
+
+  end
+
+end

data/lib/littleneck_clamav/error.rb

@@ -0,0 +1,5 @@
+class LittleneckClamAV
+
+  class Error < StandardError; end
+
+end

data/lib/littleneck_clamav/result.rb

@@ -0,0 +1,29 @@
+class LittleneckClamAV
+
+  class Result
+
+    def initialize(opts)
+      @path        = opts[:path]
+      @clean       = opts[:clean]
+      @description = opts[:description]
+    end
+
+    def path
+      @path
+    end
+
+    def clean?
+      @clean
+    end
+
+    def infected?
+      !@clean
+    end
+
+    def description
+      @description
+    end
+
+  end
+
+end

data/lib/littleneck_clamav.rb

@@ -0,0 +1,45 @@
+require_relative "littleneck_clamav/clam"
+require_relative "littleneck_clamav/clamd"
+require_relative "littleneck_clamav/error"
+
+class LittleneckClamAV
+
+  def engine
+    scanner.engine
+  end
+
+  def database_version
+    scanner.database_version
+  end
+
+  def database_date
+    scanner.database_date
+  end
+
+  def available?
+    !!scanner
+  end
+
+  def scan(*args)
+    scanner.scan(*args)
+  end
+
+  def scanner
+    @scanner ||= begin
+      scanner = scanners.find{|s| s.available? }
+      raise Error, "no scanner available, is ClamAV installed?" unless scanner
+      scanner
+    end
+  end
+
+private
+
+  def preference
+    [Clamd, Clam]
+  end
+
+  def scanners
+    @scanners ||= preference.map(&:new)
+  end
+
+end

data/spec/clam_spec.rb

@@ -0,0 +1,19 @@
+require "spec_helper"
+
+describe LittleneckClamAV::Clam do
+
+  it_behaves_like "a scanner"
+
+  describe "instance method" do
+
+    describe "command" do
+
+      it "should return clamdscan" do
+        subject.command.should == "clamscan"
+      end
+
+    end
+
+  end
+
+end

data/spec/clamd_spec.rb

@@ -0,0 +1,17 @@
+describe LittleneckClamAV::Clamd do
+
+  it_behaves_like "a scanner"
+
+  describe "instance method" do
+
+    describe "command" do
+
+      it "should return clamdscan" do
+        subject.command.should == "clamdscan"
+      end
+
+    end
+
+  end
+
+end

data/spec/littleneck_clamav_spec.rb

@@ -0,0 +1,97 @@
+require "spec_helper"
+
+describe LittleneckClamAV do
+
+  describe "instance method" do
+
+    describe "engine" do
+
+      it "should call `engine` on the scanner" do
+        scanner = mock("scanner")
+        scanner.should_receive :engine
+        subject.stub( :scanner => scanner )
+
+        subject.engine
+      end
+
+    end
+
+    describe "database_version" do
+
+      it "should call `database_version` on the scanner" do
+        scanner = mock("scanner")
+        scanner.should_receive :database_version
+        subject.stub( :scanner => scanner )
+
+        subject.database_version
+      end
+
+    end
+
+    describe "database_date" do
+
+      it "should call `database_date` on the scanner" do
+        scanner = mock("scanner")
+        scanner.should_receive :database_date
+        subject.stub( :scanner => scanner )
+
+        subject.database_date
+      end
+
+    end
+
+    describe "available?" do
+
+      it "should return true if a scanner is available" do
+        subject.stub( :scanner => Object.new )
+
+        subject.available?.should == true
+      end
+
+      it "should return false if a scanner is not available" do
+        subject.stub( :scanner => nil )
+
+        subject.available?.should == false
+      end
+
+    end
+
+    describe "scan" do
+
+      it "should call `scan` on the scanner" do
+        scanner = mock("scanner")
+        scanner.should_receive :scan
+        subject.stub( :scanner => scanner )
+
+        subject.scan
+      end
+
+    end
+
+    describe "scanner" do
+
+      it "should return Clamd if available" do
+        LittleneckClamAV::Clamd.any_instance.stub(:available? => true)
+
+        subject.scanner.should be_a LittleneckClamAV::Clamd
+      end
+
+      it "should return Clam if Clamd is not available" do
+        LittleneckClamAV::Clamd.any_instance.stub(:available? => false)
+        LittleneckClamAV::Clam.any_instance.stub(:available? => true)
+
+        subject.scanner.should be_a LittleneckClamAV::Clam
+      end
+
+      it "should raise an error if neither are available" do
+        LittleneckClamAV::Clamd.any_instance.stub(:available? => false)
+        LittleneckClamAV::Clam.any_instance.stub(:available? => false)
+
+        lambda { subject.scanner }.should raise_error( LittleneckClamAV::Error )
+      end
+
+    end
+
+  end
+
+end

data/spec/result_spec.rb

@@ -0,0 +1,55 @@
+require "spec_helper"
+
+describe LittleneckClamAV::Result do
+
+  describe "instance method" do
+
+    describe "infected?" do
+
+      it "should return true when infected" do
+        result = result_factory :clean => false
+        result.infected?.should be_true
+      end
+
+      it "should return false when clean" do
+        result = result_factory :clean => true
+        result.infected?.should be_false
+      end
+
+    end
+
+    describe "clean?" do
+
+      it "should return true when clean" do
+        result = result_factory :clean => true
+        result.clean?.should be_true
+      end
+
+      it "should return false when infected" do
+        result = result_factory :clean => false
+        result.clean?.should be_false
+      end
+
+    end
+
+    describe "description" do
+
+      it "should return the description passed in" do
+        result = result_factory :description => "Hello"
+        result.description.should == "Hello"
+      end
+
+    end
+
+    describe "path" do
+
+      it "should return the path passed in" do
+        result = result_factory :path => "foo/bar"
+        result.path.should == "foo/bar"
+      end
+
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$:.unshift File.join(File.dirname(File.dirname(__FILE__)),'lib')
+
+require "littleneck_clamav"
+require "rspec/mocks/any_instance"
+
+Dir[File.join(File.dirname(__FILE__),'support','*.rb')].each{|f| require f }
+
+RSpec.configure do |config|
+  config.expect_with :rspec
+  config.mock_with   :rspec
+end

data/spec/support/factories.rb

@@ -0,0 +1,9 @@
+def result_factory(override = {})
+  options = {
+    :success     => true,
+    :path        => "foo.txt",
+    :description => "OK"
+  }.merge( override )
+
+  LittleneckClamAV::Result.new options
+end

data/spec/support/shared_examples.rb

@@ -0,0 +1,131 @@
+shared_examples_for "a scanner" do
+
+  def mock_cocaine(cocaine_options={})
+    options = { :output => "", :exitvalue => 0 }.merge( cocaine_options )
+    mock = Cocaine::CommandLine.should_receive( :new )
+    mock = mock.with(
+      options[:cmd], options[:opts], options[:params]
+    ) if options[:cmd] || options[:opts] || options[:params]
+
+    if cocaine_options[:raise]
+      mock.and_raise cocaine_options[:raise]
+    else
+      mock.and_return(
+        double "cocaine command", :run => options[:output]
+      )
+    end
+
+    `true`  if options[:exitvalue] == 0
+    `false` if options[:exitvalue] == 1
+  end
+
+ describe "instance method" do
+
+    describe "engine" do
+
+      it "should call Cocaine with correct parameters" do
+        mock_cocaine :cmd => subject.command, :opts => "--version", :params => { :swallow_stderr => true }
+        subject.engine
+      end
+
+      it "should interpret the return value correctly" do
+        mock_cocaine :output => "ClamAV 0.97.5/15306/Tue Aug 28 20:18:12 2012\n"
+        subject.engine.should == "0.97.5"
+      end
+
+    end
+
+    describe "database_version" do
+
+      it "should call Cocaine with correct parameters" do
+        mock_cocaine :cmd => subject.command, :opts => "--version", :params => { :swallow_stderr => true }
+        subject.database_version
+      end
+
+      it "should interpret the return value correctly" do
+        mock_cocaine :output => "ClamAV 0.97.5/15306/Tue Aug 28 20:18:12 2012\n"
+        subject.database_version.should == 15306
+      end
+
+    end
+
+    describe "database_version" do
+
+      it "should call Cocaine with correct parameters" do
+        mock_cocaine :cmd => subject.command, :opts => "--version", :params => { :swallow_stderr => true }
+        subject.database_date
+      end
+
+      it "should interpret the return value correctly" do
+        mock_cocaine :output => "ClamAV 0.97.5/15306/Tue Aug 28 20:18:12 2012\n"
+        subject.database_date.should == Time.parse("Tue Aug 28 20:18:12 2012")
+      end
+
+    end
+
+    describe "available?" do
+
+      it "should return true when Cocaine returns okay" do
+        mock_cocaine :output => "ClamAV 0.97.5/15306/Tue Aug 28 20:18:12 2012\n"
+
+        subject.available?.should == true
+      end
+
+      it "should return false when command errors" do
+        mock_cocaine :raise => Cocaine::ExitStatusError.new( "oh noes" )
+
+        subject.available?.should == false
+      end
+
+      it "should return false when command is not found" do
+        mock_cocaine :raise => Cocaine::CommandNotFoundError
+
+        subject.available?.should == false
+      end
+
+    end
+
+    describe "scan" do
+
+      it "should call Cocaine" do
+        file = __FILE__
+
+        subject.stub(:available?).and_return(true)
+
+        mock_cocaine :cmd => subject.command,
+                     :opts => "--no-summary #{file}",
+                     :params => { :swallow_stderr => true, :expected_outcodes => [0, 1] },
+                     :output => "#{file}: OK"
+
+        subject.scan file
+      end
+
+      it "should create a Result" do
+        file = __FILE__
+
+        subject.stub(:available?).and_return(true)
+
+        mock_cocaine :output => "#{file}: OK\n"
+
+        LittleneckClamAV::Result.should_receive(:new).with(:path => file, :clean => true, :description => "OK")
+
+        subject.scan file
+      end
+
+      it "should raise an error if the path does not exist" do
+        lambda { subject.scan "foo" }.should raise_error( LittleneckClamAV::Error )
+      end
+
+      it "should raise an error if it is not available" do
+        file = __FILE__
+
+        subject.stub(:available?).and_return(false)
+
+        lambda { subject.scan "foo" }.should raise_error( LittleneckClamAV::Error )
+      end
+
+    end
+
+  end
+
+end

metadata

@@ -0,0 +1,120 @@
+--- !ruby/object:Gem::Specification
+name: littleneck_clamav
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Theo Cushion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cocaine
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.11'
+description: 
+email: theo.c@zepler.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/littleneck_clamav/clam.rb
+- lib/littleneck_clamav/clamd.rb
+- lib/littleneck_clamav/error.rb
+- lib/littleneck_clamav/result.rb
+- lib/littleneck_clamav.rb
+- LICENSE
+- README.md
+- spec/clam_spec.rb
+- spec/clamd_spec.rb
+- spec/littleneck_clamav_spec.rb
+- spec/result_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/shared_examples.rb
+- .rspec
+homepage: http://github.com/theozaurus/littleneck_clamav
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -4199699967230361114
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A thin wrapper to make it quick and easy to use ClamAV (daemonised or not)
+  within Ruby
+test_files:
+- spec/clam_spec.rb
+- spec/clamd_spec.rb
+- spec/littleneck_clamav_spec.rb
+- spec/result_spec.rb
+- spec/spec_helper.rb
+- spec/support/factories.rb
+- spec/support/shared_examples.rb
+- .rspec