ok_computer-clamav 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cba4b6796c3b0cde03e5aac46f7f757abf4987be91b459e8f47ed217b22698b7
+  data.tar.gz: 7d001359aa532a4f6b6f3096d4831a7ec6822d33042d3912b6b46d0728876eaf
+SHA512:
+  metadata.gz: 7fd45eafaacd5e7423f8018d5e2d67c59593711ac559f17b2eda6d1f034512d866ccbcee3af5b0d8b905441b53da80d2c1d92131ca751070768df41dfe0b83b6
+  data.tar.gz: 40abf4e0a663318785bef47895e54ceb41d370c533d89019bacff941e83e7ca13ad7ea7acc084856221d3513edeb92a667df015ac7e563a64b9dd8056bff5c19

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 ok_computer-clamav.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,37 @@
+PATH
+  remote: .
+  specs:
+    ok_computer-clamav (0.1.0)
+      okcomputer (>= 1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    okcomputer (1.17.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  ok_computer-clamav!
+  rake (~> 10.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   1.16.2

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 Joost Baaij
+
+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,37 @@
+# OkComputer::Clamav
+
+Monitor `clamd` from the luxury of your existing [OkComputer](https://github.com/sportngin/okcomputer/) setup!
+
+This check will make noise when the daemon does not respond to messages. It
+makes a socket connection, sends a PING and waits for a PONG. If any of that
+does not occur, you'll know it.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ok_computer-clamav'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In `config/initializers/ok_computer.rb`:
+
+``` ruby
+OkComputer::Registry.register "clamd", OkComputer::Clamav::ClamdCheck.new
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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/spacebabies/ok_computer-clamav.

data/Rakefile

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

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "ok_computer/clamav"
+
+# 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/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/lib/ok_computer/clamav.rb

@@ -0,0 +1,7 @@
+require "ok_computer/clamav/version"
+
+module OkComputer
+  module Clamav
+    # Your code goes here...
+  end
+end

data/lib/ok_computer/clamav/clamd_check.rb

@@ -0,0 +1,32 @@
+module OkComputer
+  module Clamav
+    # This class performs a health check on a clamd instance using the
+    # {PING command}[https://linux.die.net/man/8/clamd].
+    #
+    class ClamdCheck < OkComputer::Check
+      attr_reader :socket_path
+
+      # `socket_path`: the Unix socket path clamd is using.
+      #
+      # default: /var/run/clamav/clamd.ctl (Debian/Ubuntu)
+      # homebrew on macOS uses /tmp/clamd.socket
+      def initialize(socket_path:'/var/run/clamav/clamd.ctl')
+        @socket_path = socket_path
+      end
+
+      def check
+        socket = UNIXSocket.new(socket_path)
+        socket.write "nPING\n"
+        clamd_status = socket.readline
+        socket.close
+
+        if clamd_status != "PONG\n"
+          mark_failure
+          mark_message "clamd responded to PING with #{clamd_status}"
+        else
+          mark_message 'clamd is running and responds to PING'
+        end
+      end
+    end
+  end
+end

data/lib/ok_computer/clamav/version.rb

@@ -0,0 +1,5 @@
+module OkComputer
+  module Clamav
+    VERSION = "0.1.0"
+  end
+end

data/ok_computer-clamav.gemspec

@@ -0,0 +1,36 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ok_computer/clamav/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ok_computer-clamav"
+  spec.version       = OkComputer::Clamav::VERSION
+  spec.license       = 'MIT'
+  spec.authors       = ["Joost Baaij"]
+  spec.email         = ["joost@spacebabies.nl"]
+
+  spec.summary       = 'Monitor ClamAV using OK Computer'
+  spec.description   = <<-EOF
+    Monitor `clamd` from the luxury of your existing OkComputer setup!
+    This check will make noise when the daemon does not respond to messages. It
+    makes a socket connection, sends a PING and waits for a PONG. If any of that
+    does not occur, you'll know it.
+  EOF
+  spec.homepage      = 'https://github.com/spacebabies/ok_computer-clamav'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'okcomputer', '>= 1.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: ok_computer-clamav
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joost Baaij
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: okcomputer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: |2
+      Monitor `clamd` from the luxury of your existing OkComputer setup!
+      This check will make noise when the daemon does not respond to messages. It
+      makes a socket connection, sends a PING and waits for a PONG. If any of that
+      does not occur, you'll know it.
+email:
+- joost@spacebabies.nl
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/ok_computer/clamav.rb
+- lib/ok_computer/clamav/clamd_check.rb
+- lib/ok_computer/clamav/version.rb
+- ok_computer-clamav.gemspec
+homepage: https://github.com/spacebabies/ok_computer-clamav
+licenses:
+- MIT
+metadata: {}
+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.7.7
+signing_key: 
+specification_version: 4
+summary: Monitor ClamAV using OK Computer
+test_files: []