EICAR 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MTQ0OTkzNTMyMjRkMGU0YjJkMzdkMGZhZjdiYTFmNGNkNWZlMTNmYQ==
+    Njk4MjNmNDE3MTE5ZWRmMDA1ZjBmZDhlMmVkZDk5N2I2ZDIyNTRkNA==
   data.tar.gz: !binary |-
-    NmE0MzlhYWUyMjI2ZTc0NTgzMDc2ZjY4MTUxYTVhZWU3NzJhN2E5OQ==
+    ZTY0Y2M3YWY3MDExNzU2MjFlMTcxZmFkNzM0NzYzZTZmZjYwYjgwYw==
 SHA512:
   metadata.gz: !binary |-
-    Yzg0YTNjYTNhNzA4MTVlNWIxNTFmMmVmNTUxNzgxZjIwMTNjNzhhOWY0Mzkw
-    YjhhYzQ2NzZhZjVjNGJlN2EwMTgzOWZiYjg2NDVkZWFhYjU2ZTk4NTRkMDAz
-    ZmIwMGRjOWJlYzcwOWViYzBkZGI3ZWJhNDc1MjQ2YTM5YzBmN2I=
+    NmViZmIxNmRjMWY5ZGI0ZTg0MGIzYTVhY2E3YjBkZGRjZDIwNGZkMjE2NDgw
+    NjA1MzFlNWY1Yzk5MzgxOTE1MWNkNGFmZDcxMjFmMDAwNmQ5MzU2NGNkNjcy
+    OTAzNzBjMTJmOWVkNWYxNTViYTljMTVhMTcxYjg3ZjgwODYzNzI=
   data.tar.gz: !binary |-
-    N2MxZDYyMTkxNDlmYzk2OTI0OGJlZjQyYjY5OWU1ZWNhMWVjOTQzZWY2N2Rl
-    ZjMwNmVlZTkwYjRmOTMyOTlkODEzZDk0N2VjMDlhMTM2NTQ3MmUxZjliOTAw
-    ZWUxMGRjNjNkZDQ3OTk2YjI2MWIwMWJhODkxODZiN2RiNzRjN2M=
+    ZmY2ZmM1ZmNlNDBmMzdhMjczYzQ3MTY0OWFiNjQzYmQ2N2QwMDNmMjkyYmYz
+    NmFjZDdkYTY0N2QxMGIzMTBhMDgxMTVjYmNlNjBjNjRiYWRmODY3NzI4ZGM2
+    ZDAzMzY5NzNhNzEzYzRmYWM5MDNmYWMwZjQ3Y2ZiZDlhMTZjODQ=

data/README.md

@@ -43,6 +43,18 @@ end
 puts "A/V is active in #{ENV['GEM_HOME']}."
 ````
 
+You can also write the EICAR test file to any given target directory
+with this gem. For example:
+
+````ruby
+EICAR.create # Creates the EICAR test file in the default GEM_HOME location
+EICAR.create "/tmp/foo.exe" # Writes to an arbitrary path
+````
+
+This can be useful for spot-checking A/V coverage on a per directory or
+per filesystem basis (eg, across SMB shares).
+
+
 Expected Results
 ================
 

data/lib/eicar.rb

@@ -1,29 +1,48 @@
 require 'eicar/version'
 
+# The EICAR mixin. It's quite useful for EICAR things.
 module EICAR
 
-  # Antivirus should /not/ pick this up, ever.
+  # This is the EICAR test string, obfuscated as a downcased, ROT13
+  # string. Antivirus should /not/ pick this up, ever, since it's out of
+  # spec to try to decode it.
+  #
   ROT13_DOWNCASE_EICAR = "k5b!c%@nc[4cmk54(c^)7pp)7}$rvpne-fgnaqneq-nagvivehf-grfg-svyr!$u+u*"
 
+  # @return [String] The library/gem version.
+  #
   def self.version
     EICAR::VERSION
   end
 
+  # A generic Error class.
+  # 
   class Error < StandardError
   end
 
+  # Raised when there's a problem with reading the EICAR file.
+  #
   class EICARReadError < Error
   end
 
+  # Raised when there's a problem with writing the EICAR file.
+  #
   class EICARWriteError < Error
   end
 
+  # The default path for the EICAR test file. Usually, it will be in the
+  # bin path of your GEM_HOME
+  # @return [String] the full path of the EICAR test file
+  #
   def self.test_file_path
     lib_path = File.expand_path(File.dirname(__FILE__))
     bin_path = File.expand_path(File.join(lib_path, "..", "bin"))
     File.join(bin_path, "eicar.com")
   end
 
+  # The EICAR test string, as read from the test file path.
+  # @return [String] the EICAR test string
+  #
   def self.test_string
     begin
     data = File.open(self.test_file_path, "rb") {|f| f.read f.stat.size}
@@ -32,6 +51,10 @@ module EICAR
     end
   end
 
+  # Tests if antivirus is active as far as the EICAR test file is
+  # concerned.
+  # @return [Boolean]
+  #
   def self.antivirus_active?
     begin
       self.test_string
@@ -41,26 +64,45 @@ module EICAR
     return false
   end
 
+  # Creates a ROT13 encoded string.
+  # @param str [String] the string to encode
+  # @return [String] the encoded string
+  #
   def self.rot13(str)
     str.tr "A-Za-z", "N-ZA-Mn-za-m"
   end
 
-  # Returns a TrueClass if the file was created and is readable in the
-  # given path (by default, the expected path for the EICAR test file).
+  # Creates the EICAR test file in a given path. If successful, returns
+  # the path written to. Without an argument, it attempts to write to
+  # the expected EICAR.test_file_path For system-wide gem installs, this
+  # will usually need to be run as root, or else you'll raise.
   #
-  # For system-wide gem installs, this will usually need
-  # to be run as root, or else you'll raise.
+  # @param path [String] the path to write to
+  # @return [String] the full, non-relative path written to
   #
-  # TODO: yardify this
-  def self.create(path=nil)
-    data = self.rot13(ROT13_DOWNCASE_EICAR).upcase
+  def self.create(path=self.test_file_path)
+    write_data = self.rot13(ROT13_DOWNCASE_EICAR).upcase
+    expanded_path = File.expand_path(path)
+
     begin
-      path ||= self.test_file_path
-      File.open(path, "wb") {|f| f.write data}
+      File.open(expanded_path, "wb") {|f| f.write write_data}
     rescue SystemCallError
       raise EICAR::EICARWriteError
     end
-    File.readable? self.test_file_path
+
+    begin
+      if File.readable? expanded_path
+        read_data = File.open(expanded_path, "rb") {|f| f.read f.stat.size}
+      end
+    rescue SystemCallError
+      raise EICAR::EICARReadError
+    end
+
+    if read_data == write_data
+      return File.path(expanded_path)
+    else
+      raise EICAR::Error
+    end
   end
 
 end

data/lib/eicar/version.rb

@@ -1,3 +1,7 @@
 module EICAR
-  VERSION = '0.0.3'
+
+  # The version constant for the EICAR mixin.
+  #
+  VERSION = '0.0.4'
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: EICAR
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Tod Beardsley
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-12-31 00:00:00.000000000 Z
+date: 2014-03-27 00:00:00.000000000 Z
 dependencies: []
 description: ! "\n    This gem is designed to fail in the face of anti-virus coverage\n
   \   of your gem path. If you are running anti-virus systemwide, this\n    gem will
@@ -56,3 +56,4 @@ signing_key:
 specification_version: 4
 summary: A gem to test local anti-virus filesystem coverage
 test_files: []
+has_rdoc: