Contents

# frozen_string_literal: true

require "ruby_clamdscan/socket"
require "ruby_clamdscan/commands/scan"
require "ruby_clamdscan/commands/manage"
require "ruby_clamdscan/commands/status"
require "ruby_clamdscan/configuration"
require "ruby_clamdscan/version"

# Utility for interacting with ClamAV
module RubyClamdscan
  class << self
    # Configuration to use interacting with the ClamAV server
    def configuration
      @configuration ||= Configuration.new
      @configuration.use_tcp_socket = true
      @configuration.tcp_host = "localhost"
      @configuration.tcp_port = 3310

      @configuration
    end

    # Configure RubyClamdscan
    def configure
      yield(configuration)
    end

    # Scans a file
    # @param filepath [String] Path to file in local storage
    # @return [RubyClamdscan::Models::ScanResult] Result from the scan attempt
    def scan_file_from_path(filepath)
      RubyClamdscan::Commands::Scan.scan_file(filepath, @configuration)
    end

    # Scans the contents of the stream passed in
    # @param stream [IO] stream of file contents
    # @return [RubyClamdscan::Models::ScanResult] Result from the scan attempt
    def scan_contents(stream)
      RubyClamdscan::Commands::Scan.scan(stream, @configuration)
    end

    def ping_server
      RubyClamdscan::Commands::Status.ping_server(@configuration)
    end

    def server_version
      RubyClamdscan::Commands::Status.server_version(@configuration)
    end

    def server_stats
      RubyClamdscan::Commands::Status.server_stats(@configuration)
    end

    def reload_server_database
      RubyClamdscan::Commands::Manage.reload_server_database(@configuration)
    end

    def shutdown_server
      RubyClamdscan::Commands::Manage.shutdown_server(@configuration)
    end
  end
end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
ruby_clamdscan-0.1.2	lib/ruby_clamdscan.rb
ruby_clamdscan-0.1.1	lib/ruby_clamdscan.rb
ruby_clamdscan-0.1.0	lib/ruby_clamdscan.rb