virus-scanner 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 03b4ec9633dbafbb3b4bed8c86b03c488c121555
+  data.tar.gz: d79420981386d30c6263a89634b03663f63d2dc1
+SHA512:
+  metadata.gz: 523e8135e360df0639ea19ef59dca182aa13eba6eb849408dd7eb3c5becafacb95910e3887fbeda05bb1f3f6dd541a962cda261e5fe0b1199702742b09968edd
+  data.tar.gz: b447be15eef98ed818d80c2c055f5f17bbd3acdcef882ac4479840a642c718d7f71b4069f31da2ab27c2479b946bb54381a0ba3b7f300d58089405932dfaf9f7

data/.gitignore

@@ -0,0 +1,7 @@
+.DS_Store
+Gemfile.lock
+.bundle
+/virus-scanner*.gem
+/tmp
+.ruby-gemset
+*.swp

data/.ruby-version

@@ -0,0 +1 @@
+2.2.0

data/Gemfile

@@ -0,0 +1,9 @@
+source "https://rubygems.org"
+
+gemspec
+
+group :test do
+  gem "webmock"
+  gem "mocha"
+  gem "shoulda"
+end

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (c) 2015 BitZesty Ltd.
+
+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 @@
+# vs-ruby
+This is ruby gem for communication with Virus Scanner API.
+
+## Installation
+
+To use it in your project, add following line to your Gemfile
+
+`gem vs-ruby`
+
+and then run
+
+`bundle`
+
+or install it by hand
+
+`gem install vs-ruby`
+
+It uses faraday as HTTP middleware so you may use any HTTP backend you want. Net:HTTP is default one.
+
+(TODO: add configuration option to change HTTP request)
+
+## Usage
+
+`VirusScanner::File` class has two methods:
+
+ * `check_from_url` which accepts URL to remote file as argument and returns scan job status
+ * `check_status` which accepts job UUID as argument and returns information about job status
+
+(c) 2015 BitZesty Ltd.
+

data/Rakefile

@@ -0,0 +1,11 @@
+require "rubygems"
+require "rake"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "lib" << "test"
+  t.pattern = "test/**/*_test.rb"
+  t.verbose = true
+end
+
+task default: :test

data/lib/virus_scanner/errors.rb

@@ -0,0 +1,43 @@
+module VirusScanner
+  class Error < StandardError
+    def initialize(statement)
+      if statement.is_a?(Exception)
+        @error = statement
+      else
+        @message = statement
+      end
+    end
+
+    def message
+      @message || "#{@error.class} (wrapped in #{self.class}) - #{@error.message}"
+    end
+
+    def backtrace
+      if @error
+        error_backtrace = ["--- Backtrace from #{@error.class} ---"] + (@error.backtrace || [])
+        wrapper_backtrace = ["--- Backtrace from #{self.class} ---"] + (super || [])
+        error_backtrace + wrapper_backtrace
+      else
+        super
+      end
+    end
+
+    def inspect
+      if @error
+        "#{error.inspect} (wrapped in a #{self.class})"
+      else
+        super
+      end
+    end
+
+    def to_s
+      if @error
+        "#{@error.class} (wrapped in a #{self.class}) - #{@error}"
+      else
+        super
+      end
+    end
+  end
+
+  class HTTPError < Error; end
+end

data/lib/virus_scanner/file.rb

@@ -0,0 +1,21 @@
+module VirusScanner
+  class File
+    attr_accessor :body
+    def self.scan_url(url)
+      # Pass URL to file to check to the HTTP requests handler
+      body = handler.post(url)
+
+      body
+    end
+
+    def self.check_status(uuid)
+      body = handler.get(uuid)
+
+      body
+    end
+
+    def self.handler
+      VirusScanner::HTTP.new
+    end
+  end
+end

data/lib/virus_scanner/http.rb

@@ -0,0 +1,37 @@
+module VirusScanner
+  class HTTP
+    attr_accessor :url, :options, :method
+
+    def initialize
+      @conn = ::Faraday.new(url: ENV["VIRUS_SCANNER_API_URL"]) do |c|
+        c.request :url_encoded
+        c.response :json, content_type: /\bjson$/
+        c.adapter ::Faraday.default_adapter
+        c.headers = { "X-Auth-Token" => ENV["VIRUS_SCANNER_API_KEY"] }
+      end
+    rescue VirusScanner::HttpError => e
+      handle_exception(e)
+    end
+
+    def post(url)
+      response = @conn.post "/scan", url: url
+      response.body
+    rescue VirusScanner::Error => e
+      handle_exception(e)
+    end
+
+    def get(uuid)
+      response = @conn.get "/status/#{uuid}"
+      response.body
+    rescue VirusScanner::Error => e
+      handle_exception(e)
+    end
+
+    private
+
+    def handle_exception(e)
+      puts e.message
+      puts e.backtrace.inspect
+    end
+  end
+end

data/lib/virus_scanner/version.rb

@@ -0,0 +1,3 @@
+module VirusScanner
+  VERSION = "0.0.3"
+end

data/lib/virus_scanner.rb

@@ -0,0 +1,9 @@
+# faraday for connection handling
+require "faraday"
+require "faraday_middleware"
+
+# VirusScanner
+require "virus_scanner/version"
+require "virus_scanner/file"
+require "virus_scanner/http"
+require "virus_scanner/errors"

data/test/file_test.rb

@@ -0,0 +1,28 @@
+require_relative "./test_helper.rb"
+
+describe VirusScanner::File do
+  describe "#check_from_url" do
+    it "returns info about scan job" do
+      response = { "status" => "scanning", "id" => "de401fdf-08b0-44a8-810b-20794c5c98c7" }
+      VirusScanner::HTTP.any_instance.stubs(:post).returns(response)
+      assert_equal(VirusScanner::File.scan_url("url-to-suspected-file"),
+                   "status" => "scanning",
+                   "id" => "de401fdf-08b0-44a8-810b-20794c5c98c7")
+    end
+  end
+
+  describe "#check_status" do
+    it "returns OK when file is clean" do
+      response = {
+        "status" => "OK",
+        "uuid" => "de401fdf-08b0-44a8-810b-20794c5c98c7",
+        "md5" => "md5 hash" }
+      VirusScanner::HTTP.any_instance.stubs(:get).returns(response)
+
+      assert_equal(VirusScanner::File.check_status("de401fdf-08b0-44a8-810b-20794c5c98c7"),
+                   "status" => "OK",
+                   "uuid" => "de401fdf-08b0-44a8-810b-20794c5c98c7",
+                   "md5" => "md5 hash")
+    end
+  end
+end

data/test/http_test.rb

@@ -0,0 +1,41 @@
+require_relative "./test_helper.rb"
+
+ENV["VIRUS_SCANNER_API_URL"] = "http://localhost:3000"
+
+describe VirusScanner::HTTP do
+  describe "#post" do
+    it "returns id of job if posted with success" do
+      # stub POST request for providing URL to files for scan
+      stub_request(:post, "localhost:3000/scan").to_return(
+        body:
+        { id: "de401fdf-08b0-44a8-810b-20794c5c98c7" }.to_json)
+
+      # check if stubbed URL provides id for scan job
+      assert_includes(VirusScanner::HTTP.new.post("url"), "de401fdf-08b0-44a8-810b-20794c5c98c7")
+    end
+  end
+
+  describe "#get" do
+    it "returns status of a job for provided uuid" do
+      stub_request(:get, "localhost:3000/status/de401fdf-08b0-44a8-810b-20794c5c98c7").to_return(
+        body:
+        { id: "de401fdf-08b0-44a8-810b-20794c5c98c7",
+          result: "------------ SCAN SUMMARY -----------",
+          md5: "69630e4574ec6798239b091cda43dca0",
+          status: "error" }.to_json)
+
+      assert_includes(
+        VirusScanner::HTTP.new.get("de401fdf-08b0-44a8-810b-20794c5c98c7"),
+        "error")
+      assert_includes(
+        VirusScanner::HTTP.new.get("de401fdf-08b0-44a8-810b-20794c5c98c7"),
+        "SCAN SUMMARY")
+      assert_includes(
+        VirusScanner::HTTP.new.get("de401fdf-08b0-44a8-810b-20794c5c98c7"),
+        "69630e4574ec6798239b091cda43dca0")
+      assert_includes(
+        VirusScanner::HTTP.new.get("de401fdf-08b0-44a8-810b-20794c5c98c7"),
+        "de401fdf-08b0-44a8-810b-20794c5c98c7")
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+require_relative "../lib/virus_scanner"
+require "json"
+require "minitest/autorun"
+require "minitest/unit"
+require "mocha/test_unit"
+require "webmock/minitest"

data/vs-ruby.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "virus_scanner/version"
+
+Gem::Specification.new do |s|
+  s.name          = "virus-scanner"
+  s.version       = VirusScanner::VERSION
+  s.authors       = ["BitZesty Ltd"]
+  s.email         = ["info@bitzesty.com"]
+  s.description   = "API client for virus-scanner service"
+  s.summary       = "API client for virus-scanner service"
+  s.homepage      = "https://github.com/bitzesty/vs-ruby"
+  s.license       = "MIT"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%q{^bin/}) { |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_dependency "faraday"
+  s.add_dependency "faraday_middleware"
+
+  s.add_development_dependency "bundler", "~> 1.3"
+  s.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: virus-scanner
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- BitZesty Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: API client for virus-scanner service
+email:
+- info@bitzesty.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/virus_scanner.rb
+- lib/virus_scanner/errors.rb
+- lib/virus_scanner/file.rb
+- lib/virus_scanner/http.rb
+- lib/virus_scanner/version.rb
+- test/file_test.rb
+- test/http_test.rb
+- test/test_helper.rb
+- vs-ruby.gemspec
+homepage: https://github.com/bitzesty/vs-ruby
+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.4.5
+signing_key: 
+specification_version: 4
+summary: API client for virus-scanner service
+test_files: []