clamby 1.0.5 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9fd8ce4dbb727390a6c41672ce701ef9ede81a4
-  data.tar.gz: 69585a26d1f9f8de1f279b15a0980226c687f0b9
+  metadata.gz: bc2d255f725e2d898512f707dfe9c6c3d064771d
+  data.tar.gz: 7d64e8cbb7ecf414827211f863e07b43eb2a65ac
 SHA512:
-  metadata.gz: 4492b45533ef3e967f818746a43742e9a525d333a91bf88c413c98d88bc6ac1fced3f0d98b89009369f68d1284df90f786ab7fada2f19d414afa5c91c8d9233a
-  data.tar.gz: a5176fddef6a09a0e4c3d801818064984ce368563bf94ccc141b26cdd93e0a69232a6a43a248b49c8858a4fa6def05b0f684b75423279069df9bc27dff744d8c
+  metadata.gz: 83da29cd8e1bf8361ee4e37796dbcd687ab4eaf8cb12cf16eca3c5a77201de41d228ddc0985737e94947e7a02c7e463cae91d307028c99be518690366abae1a0
+  data.tar.gz: 970f9ac1d977842b31a2d819a85e34aef0f7b7942a666694753fc33353e590039ee40abc61a2f834b5d4add02e2fa71f9048e9b4a1a794d32c8f4c577c787daf

data/.gitignore

@@ -15,3 +15,4 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
+.DS_Store/

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+before_install:
+  - gem install bundler -v '>= 1.5.3'
+  - gem install rake
+  - gem install rspec
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1
+install: 
+ - sudo apt-get install clamav
+ - sudo freshclam
+
+gemfile:
+  - Gemfile

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+#v1.10
+ - Changed `scan()` to `safe?()`
+ - Added virus?()
+ - Added/Changed `rspec` to accomodate new/changed functionality
+
 #v1.0.5
  - Made default virus detection not throw a warning
  - If scanning a file that doesn't exist, `scan(path)` will return nil.

data/README.md

@@ -1,6 +1,8 @@
 ![Clamby Logo](https://raw.github.com/kobaltz/clamby/master/clamby_logo.png)
 
 [![GemVersion](https://badge.fury.io/rb/clamby.png)](https://badge.fury.io/rb/clamby.png)
+[![Build Status](https://travis-ci.org/kobaltz/clamby.png?branch=master)](https://travis-ci.org/kobaltz/clamby)
+
 
 This gem depends on the `clamscan` and `freshclam` daemons to be installed already.
 
@@ -10,6 +12,19 @@ If you have a file upload on your site and you do not scan the files for viruses
 
 Be sure to check the CHANGELOG as recent changes may affect functionality.
 
+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`
+
+`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`
+
+
+`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.
 
 ```ruby
@@ -19,7 +34,7 @@ In your model with the uploader, you can add the scanner to a before method to s
 
   def scan_for_viruses
       path = self.attribute.url
-      Clamby.scan(path)
+      Clamby.safe?(path)
   end
 ```
 
@@ -38,7 +53,7 @@ It's good to note that Clamby will not by default delete files which had a virus
 
   def scan_for_viruses
       path = self.attribute.url
-      scan_result = Clamby.scan(path)
+      scan_result = Clamby.safe?(path)
       if scan_result
         return true
       else

data/Rakefile

@@ -1 +1,6 @@
 require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new
+
+task :default => :spec

data/lib/clamby.rb

@@ -15,7 +15,7 @@ module Clamby
     opts.each {|k,v| @config[k.to_sym] = v if @valid_config_keys.include? k.to_sym}
   end
 
-  def self.scan(path)
+  def self.safe?(path)
     if self.scanner_exists?
       if file_exists?(path)
         scanner = system("clamscan #{path} --no-summary")
@@ -37,7 +37,27 @@ module Clamby
     end
   end
 
-
+  def self.virus?(path)
+    if self.scanner_exists?
+      if file_exists?(path)
+        scanner = system("clamscan #{path} --no-summary")
+        if scanner
+          return false
+        elsif not scanner
+          if @config[:error_file_virus]
+            raise Exceptions::VirusDetected.new("VIRUS DETECTED on #{Time.now}: #{path}")
+          else
+            puts "VIRUS DETECTED on #{Time.now}: #{path}"
+            return true
+          end
+        end
+      else
+        return nil
+      end
+    else
+      return nil
+    end
+  end
 
   def self.scanner_exists?
     if @config[:check]

data/lib/clamby/version.rb

@@ -1,3 +1,3 @@
 module Clamby
-  VERSION = "1.0.5"
+  VERSION = "1.1.0"
 end

data/spec/clamby_spec.rb

@@ -20,19 +20,23 @@ describe Clamby do
   end
 
   it "should scan file as safe" do
-    expect(Clamby.scan(good_path)).to be true
+    expect(Clamby.safe?(good_path)).to be true
+    expect(Clamby.virus?(good_path)).to be false
   end
 
   it "should scan file and return nil" do
-    expect(Clamby.scan(bad_path)).to be nil
+    expect(Clamby.safe?(bad_path)).to be nil
+    expect(Clamby.virus?(bad_path)).to be nil
   end
 
   it "should scan file as dangerous" do
     `wget http://www.eicar.org/download/eicar.com`
     Clamby.configure({:error_file_virus => true})
-    expect{Clamby.scan('eicar.com')}.to raise_exception(Exceptions::VirusDetected)
+    expect{Clamby.safe?('eicar.com')}.to raise_exception(Exceptions::VirusDetected)
+    expect{Clamby.virus?('eicar.com')}.to raise_exception(Exceptions::VirusDetected)
     Clamby.configure({:error_file_virus => false})
-    expect(Clamby.scan('eicar.com')).to be false
+    expect(Clamby.safe?('eicar.com')).to be false
+    expect(Clamby.virus?('eicar.com')).to be true
     File.delete('eicar.com')
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clamby
 version: !ruby/object:Gem::Version
-  version: 1.0.5
+  version: 1.1.0
 platform: ruby
 authors:
 - kobaltz
@@ -63,6 +63,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -73,7 +74,7 @@ files:
 - lib/clamby.rb
 - lib/clamby/exception.rb
 - lib/clamby/version.rb
-- spec/.travis.yml
+- spec/.DS_Store
 - spec/clamby_spec.rb
 - spec/spec_helper.rb
 homepage: ''
@@ -101,6 +102,6 @@ signing_key:
 specification_version: 4
 summary: Scan file uploads with ClamAV
 test_files:
-- spec/.travis.yml
+- spec/.DS_Store
 - spec/clamby_spec.rb
 - spec/spec_helper.rb

data/spec/.travis.yml

@@ -1,2 +0,0 @@
-rvm:
-  - 1.9.3