rclam 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 59b97381697ed5e1005e15cd0b8e2a63c718368f
+  data.tar.gz: c3c1a43620cb8653fa67edf3e308b8272f50be65
+SHA512:
+  metadata.gz: cad232e9ac09a60f12df014390166edb7c2fc999c0aa74187acc1a7baf6684b637843a7b4103081172a05236cbf4ee440d8b2218d825cbe216431e1daddad5a1
+  data.tar.gz: d2ae8a33a8e5bc49570160b5dc75be19538cf89543814dd4741d2dc667c6453310de376ab56304db46ed55a631140323f13f463634d7e45c3e40703360d54b9e

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.gem

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.3

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in rclam.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Roby Parr
+
+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,30 @@
+# Rclam
+
+This is a small command-line utility that wraps around clamscan that 
+makes it easier to use for systems maintenance.
+
+## Installation
+
+`$ gem install rclam`
+
+*Note that this is not meant to be used as a library, but a command-line utility.*
+
+## Usage
+
+To run a scan of your entire computer:
+
+`rclam scan /`
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/robyparr/rclam.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rclam"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/rclam

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require "bundler/setup"
+require "rclam"
+Rclam::CLI.start(ARGV)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rclam

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require "rclam"
+Rclam::CLI.start(ARGV)

data/lib/rclam.rb

@@ -0,0 +1,28 @@
+require "thor"
+require "date"
+require "open3"
+
+require "rclam/version"
+require "rclam/clamav"
+require "rclam/helpers"
+
+module Rclam
+  class CLI < Thor
+    desc "scan [location]", "Runs clamscan against the specified location."
+    def scan(location = '/')
+      not_installed         unless Rclam::ClamAV.installed?
+      Rclam::ClamAV.update  unless Rclam::ClamAV.up_to_date?
+
+      puts "Scanning #{File.expand_path(location)}..."
+      result = Rclam::ClamAV.scan location
+      puts Rclam::Helpers.clamscan_report(result)
+    end
+
+    private
+
+      def not_installed
+        puts "ClamAV is not installed. Please install before running."
+        exit 1
+      end
+  end
+end

data/lib/rclam/clamav.rb

@@ -0,0 +1,23 @@
+module Rclam
+  module ClamAV
+
+    def self.installed?
+      executable_location = %x{which clamscan}
+      !executable_location.empty?
+    end
+
+    def self.up_to_date?
+      last_update = Rclam::Helpers.last_signatures_update
+      Rclam::Helpers.date_within_a_day?(last_update)
+    end
+
+    def self.update
+      %x{freshclam}
+    end
+
+    def self.scan(location)
+      output, err, status = Open3.capture3("clamscan -ri #{location}")
+      output
+    end
+  end
+end

data/lib/rclam/helpers.rb

@@ -0,0 +1,43 @@
+module Rclam
+  module Helpers
+    FRESHCLAM_REGEX = /^.+\/(\D{3} \D{3} \d{2} \d{2}:\d{2}:\d{2} \d{4})$/
+    INFECTED_FILES_REGEX = /^Infected files: (\d+)$/
+    SCANNED_FILES_REGEX = /^Scanned files: (\d+)$/
+    TIME_REGEX = /^Time: .+\((\d \w{1} \d \w{1})\)$/
+    SIGNATURES_REGEX = /^Known viruses: (\d+)$/
+
+    def self.first_regex_capture(regex, value)
+      match = regex.match(value)
+      return nil if match.nil?
+      match.captures.first
+    end
+
+    def self.last_signatures_update
+      version_header = %x{freshclam --version}
+      DateTime.parse self.first_regex_capture(FRESHCLAM_REGEX, version_header)
+    end
+
+    def self.date_within_a_day?(date)
+      hours_difference = ((DateTime.now.to_time - date.to_time) / 3600).to_i
+      hours_difference <= 24
+    end
+
+    def self.clamscan_report(results)
+      infected_files = first_regex_capture(INFECTED_FILES_REGEX, results).to_i
+      scanned_files = first_regex_capture(SCANNED_FILES_REGEX, results)
+      signatures = first_regex_capture(SIGNATURES_REGEX, results)
+      result = infected_files > 0 ? "!!INFECTED!!" : "CLEAN"
+
+      result = %Q{
+        Result:         #{result}
+        Infections:     #{infected_files}
+        Scanned Files:  #{scanned_files}
+        Signatures:     #{signatures}
+      }
+      
+      # Remove tabs from each line
+      # https://stackoverflow.com/a/31345870
+      result.each_line.map(&:strip).join("\n")
+    end
+  end
+end

data/lib/rclam/version.rb

@@ -0,0 +1,3 @@
+module Rclam
+  VERSION = "0.2.0"
+end

data/rclam.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rclam/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rclam"
+  spec.version       = Rclam::VERSION
+  spec.authors       = ["Roby Parr"]
+  spec.email         = ["roby.parr@gmail.com"]
+
+  spec.summary       = "A small command-line wrapper around clamscan."
+  spec.description   = %q{
+    This is a small command-line utility that wraps around clamscan to
+    make it easier to use for systems maintenance.
+  }
+  spec.homepage      = "https://github.com/robyparr/rclam"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = ["rclam"]
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_runtime_dependency "thor", "~> 0.20.0"
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification
+name: rclam
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Roby Parr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.20.0
+description: "\n    This is a small command-line utility that wraps around clamscan
+  to\n    make it easier to use for systems maintenance.\n  "
+email:
+- roby.parr@gmail.com
+executables:
+- rclam
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/rclam
+- bin/setup
+- exe/rclam
+- lib/rclam.rb
+- lib/rclam/clamav.rb
+- lib/rclam/helpers.rb
+- lib/rclam/version.rb
+- rclam.gemspec
+homepage: https://github.com/robyparr/rclam
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: A small command-line wrapper around clamscan.
+test_files: []