README.md in virus_scan_service-0.0.8 vs README.md in virus_scan_service-0.1.0
- old
+ new
@@ -7,11 +7,15 @@
Service gem that provide virus scan runner that will pull down list of
files to be scanned from your application server, lunch antivirus check (currently only
Kasperky Endponit Security runner Windows or Linux) and send scan result
back to server.
-You don't need to have this script running on the same server
+If you want to use difrent antivirus (like `ClamAV`) that's fine,
+but you will have to implement your own runner `:)`.
+Pull requests are welcome.
+
+You don't need to have script running this service on the same server
as application server VM. (Article comming soon)
Originaly built to work along [witch_doctor engine gem](https://github.com/equivalent/witch_doctor)
however that is not required. All your server has to do
is provide API that this secvice can comunicate with:
@@ -19,11 +23,11 @@
#### GET `/wd/virus_scans` `ContentType: application/json`
response
```json
-[{"id":"123","scan_result":"","file_url":"http://thisis.test/download/file.png"}]
+{"data":[{"id":"123","scan_result":"","file_url":"http://thisis.test/download/file.png"}]}
```
#### PUT `/wd/virus_scans/123` `ContentType: application/json`
request body
@@ -33,14 +37,17 @@
```
response
```json
-{"id":"123","scan_result":"Clean","file_url":"http://thisis.test/download/file.png"}
+{"data":{"id":"123","scan_result":"Clean","file_url":"http://thisis.test/download/file.png"}}
```
For more examples check `spec/courier_spec.rb`, `spec/support/request_response_mocks.rb
+## JSON API
+
+gem is implementing [JSON API standard](http://jsonapi.org/)
## Statuses
* `Clean`
* `VirusInfected`