(check BADGES.md for build status & test coverage)

# Witch Doctor

Rails engine that provides simple API so that external antivirus
script can pull down files that need to be scanned and update their
results.


Engine was designed to work alongside [virus_scan_service gem](https://github.com/equivalent/virus_scan_service),
to which it provides a list of VirusScans. These are created upon file resource
create / update events.


## CarrierWave

gem is by default assuming you use [Carriewave
gem](https://github.com/carrierwaveuploader/carrierwave)
however it's not a dependancy as long as `:mount_point` responds to
`url` call (look at `spec/dummy/app/models/document.rb`) for more
details


# Setup

In your application:

```ruby
# Gemfile

# ...
gem 'witch_doctor', github: 'equivalent/witch_doctor'

```

```ruby
# config/routes.rb
MyCoolApplication::Application.routes.draw do
  mount WitchDoctor::Engine => "/wd", :as => "witch_doctor"
  # ...
end
```

```ruby
# /config/initializers/witch_doctor.rb

VirusScan.token = Rails
  .application
  .secrets
  .fetch('antivirus_scan')
  .fetch('token')
```


```sh
bundle install
rake db:migrate
```

## Optional

**Add helper**

```ruby
# app/helpers/application_helper.rb
include WitchDoctor::ApplicationHelper
```

after this you can use the `antivirus` helper

```haml
= antivirus(@document, :attachment) do
  - link_to @document.attachment_name, @document.attachment.url
```

This will show the link when `VirusScan` for `@document` is `Clean`


# Overiding WitchDoctor Examples

## extending controller

```ruby
module WitchDoctor
  module MyAppControllerExtension
    def self.included(base)
      base.force_ssl unless: :development?
      base.skip_before_filter :do_stuff
    end

    def development?
      Rails.env.in? ['test', 'development']
    end
  end
end
WitchDoctor::VirusScansController.send(:include,WitchDoctor::MyAppControllerExtension)
```

## extending Antivirus helper

```ruby
include WitchDoctor::ApplicationHelper
module ApplicationHelper
  alias_method :antivirus_without_view_requirement_respect, :antivirus
  alias_method :antivirus, :antivirus_with_view_requirement_respect

  def antivirus_with_view_requirement_respect(decorated_resource, mount_point)
    if decorated_resource.send("view_requires_#{mount_point}_virus_check?")
      antivirus_without_view_requirement_respect(decorated_resource, mount_point)
    else
      yield
    end
  end
end
```