clamby 0.0.1 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1693cf1781ac3eaead9999bd4aa25a0e0fb64f28
-  data.tar.gz: 9b93c18f81c7d06c1ade22065ba6e12f48eef4a0
+  metadata.gz: 3277f73b27e06cb253308aa6db21d99789346a8f
+  data.tar.gz: 01014888335684717c6ccdbd48e5ba1ea9ffca21
 SHA512:
-  metadata.gz: 4294bb0849e9da0a7db332305a43844018756c4b4e8f7a704e0a6a633f67d9bc66d04137c91ce6ae808108af41f6479774d789e029171810f6c66192c7103f45
-  data.tar.gz: 36c019f99df0504b0a812b1a9f4f48443c514d09c51fee9380041ad57868d78c9e187cb22b4a90b417b561dc49dd972f5893cbfeb6d17c8d926f165b8d3a5682
+  metadata.gz: 42870280a5cb511d2d9b8518601fbdaaee59c233f3fdba23ce06b65465b21c1f7ec9f5529ec0713267475dcd689a96d94e12419f5d102344d2b786a71db06da9
+  data.tar.gz: 5098899d37ea0a8286a7a8f80b51cd6c5c52835ee80db2af15093e60cc26610d23229e97956e0e1ebb1ed8d004138ee859849dc2da519dc0a55ff221a58106c6

data/README.md

@@ -4,14 +4,54 @@ This gem depends on the `clamscan` and `freshclam` daemons to be installed alrea
 
 If you have a file upload on your site and you do not scan the files for viruses then you not only compromise your software, but also the users of the software and their files. This gem's function is to simply scan a given file.
 
+#Usage
+
+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
+  before_create :scan_for_viruses
+
+  private
+
+  def scan_for_viruses
+      path = self.attribute.url
+      Clamby.scan(path)
+  end
+```
+
+***Updating Definitions***
+
+I have done little testing with updating definitions online. However, there is a method that you can call `Clamby.update` which will execute `freshclam`. It is recommended that you follow the instructions below to ensure that this is done automatically on a daily/weekly basis.
+
+***Viruses Detected***
+
+It's good to note that Clamby will not by default delete files which had a virus. Instead, this is left to you to decide what should occur with that file. Below is an example where if a scan came back `false`, the file would be deleted.
+
+```ruby
+  before_create :scan_for_viruses
+
+  private
+
+  def scan_for_viruses
+      path = self.attribute.url
+      scan_result = Clamby.scan(path)
+      if scan_result
+        return true
+      else
+        File.delete(path)
+        return false
+      end
+  end
+```
+
+
 #Configuration
 
 Configuration is rather limited right now. You can exclude the check if `clamscan` exists which will save a bunch of time for scanning your files. However, for development purposes, your machine may not have `clamscan` installed and you may wonder why it's not working properly. This is just to give you a reminder to install `clamscan` on your development machine and production machine. You can add the following to a config file, `clamby_setup.rb` to your initializers directory.
 
-    Clamby.configure do |config|
-		config.check = false
-	end
-
+```ruby
+    Clamby.configure({check: false})
+```
 
 #Dependencies
 
@@ -23,6 +63,22 @@ Configuration is rather limited right now. You can exclude the check if `clamsca
 
 `brew install clamav`
 
+***Auto Update****
+
+To update the virus database, open a terminal and enter the following command:
+
+`sudo freshclam`
+
+To automate this update you can set up a cron job. I'll show how to update the virus database every day at 8:57 PM. 
+
+You need to modify the crontab for the root user.
+
+`sudo crontab -e`
+
+This opens the root crontab file in a text editor. Add the following line
+
+`57 08 * * * sudo freshclam`
+
 #LICENSE
 
 Copyright (c) 2014 kobaltz

data/lib/clamby.rb

@@ -47,6 +47,10 @@ module Clamby
 	end
   end
 
+  def self.update
+  	system("freshclam")
+  end
+
   def self.config
     @config
   end

data/lib/clamby/version.rb

@@ -1,3 +1,3 @@
 module Clamby
-  VERSION = "0.0.1"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clamby
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 1.0.1
 platform: ruby
 authors:
 - kobaltz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-09 00:00:00.000000000 Z
+date: 2014-03-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler