vigilion 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 10b4c38751fd1fd34676937ab9a7653bdb003ebf
+  data.tar.gz: 53e88cbd504435d9f552128072a3ebf6fc442ae0
+SHA512:
+  metadata.gz: a2e8b3cd387102ba0a0aeece76a7f5c33b276f41a000182279cdb7d248329d847dd8802c0b4fc7970d154be866eac2d6199a3c0170009133777777ea0f5c7885
+  data.tar.gz: 7122e42286d3cd6b20aa93f118846b6c9f5358a39370eba469218f5059fdffd5410d4eb26c5dbebcdb0eab6be3bb6ec4535566ed621fe4b3c65d639375fa0c13

data/.gitignore

@@ -0,0 +1,6 @@
+.DS_Store
+Gemfile.lock
+.bundle
+/tmp
+.ruby-gemset
+*.swp

data/.ruby-version

@@ -0,0 +1 @@
+2.2.2

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 Bit Zesty 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,35 @@
+# Vigilion
+
+This Ruby gem is for integrating with the [Vigilion Anti-Virus & Malware file scanning service](https://www.vigilion.com/).
+
+If you are using Rails, you should use our [Rails gem](
+https://github.com/vigilion/vigilion-rails), which includes
+integration with Active Record and Action Controller.
+
+## Installation
+
+Add vigilion to your `Gemfile` and then run `bundle install`
+
+`gem 'vigilion'`
+
+or install it by hand
+
+`gem install vigilion`
+
+This gem uses faraday as HTTP middleware, so you may use any HTTP
+backend you want, `Net:HTTP` is the default.
+
+## Configuration
+
+You need to configure the client before making any API requests e.g. in an initializer.
+
+```
+Vigilion.configure do |config|
+  config.access_key_id = ENV['VIGILION_API_KEY']
+  config.secret_access_key = ENV['VIGILION_API_SECRET']
+end
+```
+
+Vigilion documentation [https://vigilion.readme.io/docs/ruby](https://vigilion.readme.io/docs/ruby)
+
+(c) 2015 Bit Zesty 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/vigilion.rb

@@ -0,0 +1,28 @@
+# faraday for connection handling
+require "faraday"
+require "faraday_middleware"
+require "faraday/detailed_logger"
+
+# Vigilion
+require "vigilion/version"
+require "vigilion/configuration"
+require "vigilion/http"
+require "vigilion/errors"
+
+module Vigilion
+  def self.configure(&block)
+    Vigilion::Configuration.configure(&block)
+  end
+
+  def self.scan_url(identifier, url, options = {})
+    Vigilion::HTTP.new.scan_url identifier, url, options
+  end
+
+  def self.scan_path(identifier, path, options = {})
+    Vigilion::HTTP.new.scan_path identifier, path, options
+  end
+
+  def self.check_status(identifier)
+    Vigilion::HTTP.new.get(identifier)
+  end
+end

data/lib/vigilion/configuration.rb

@@ -0,0 +1,18 @@
+require 'singleton'
+require 'ostruct'
+
+module Vigilion
+  class Configuration < OpenStruct
+    include Singleton
+
+    def self.configure
+      yield instance
+    end
+
+    def self.method_missing(m, *args, &block)
+      instance.send(m, *args)
+    end
+  end
+
+  Configuration.server_url = "https://api.vigilion.com"
+end

data/lib/vigilion/errors.rb

@@ -0,0 +1,4 @@
+module Vigilion
+  class Error < StandardError
+  end
+end

data/lib/vigilion/http.rb

@@ -0,0 +1,75 @@
+module Vigilion
+  class HTTP
+    attr_accessor :url, :options, :method
+
+    def initialize
+      validate_access_keys
+      @conn = ::Faraday.new(url: Configuration.server_url) do |c|
+        c.request :multipart
+        c.request :json
+        c.response :json, content_type: /\bjson$/
+        c.response :detailed_logger
+        c.adapter ::Faraday.default_adapter
+        c.headers = {
+          'X-Api-Key' => Configuration.access_key_id,
+          'User-Agent' => "Vigilion #{Vigilion::VERSION} (#{RUBY_PLATFORM}, Ruby #{RUBY_VERSION})"
+        }
+      end
+    end
+
+    def scan_url(key, url, options = {})
+      send scan: options.merge({ key: key, url: url })
+    end
+
+    def scan_path(key, path, options = {})
+      send scan: options.merge({ key: key, file: Faraday::UploadIO.new(path, 'application') })
+    end
+
+    def get(uuid)
+      response = @conn.get "/scans/#{uuid}"
+      response.body
+    end
+
+    def validate
+      response = @conn.get "/projects/validate"
+      process_response("", response)
+    end
+
+    def self.digest(body)
+      Digest::MD5.hexdigest("#{body}#{Vigilion::Configuration.secret_access_key}")
+    end
+
+  private
+
+    HOW_TO_CONFIGURE = <<-MESSAGE
+To configure the access keys add a Vigilion.configure block during the application start up.
+If you are using vigilion-rails, execute `rails g vigilion:install` to create an initializer.
+By default the initializer uses environment variables so make sure they are present.
+If you don't know your access keys, go to https://www.vigilion.com and get them!
+MESSAGE
+
+    INVALID_CREDENTIALS = <<-MESSAGE
+The provided credentials are not valid.
+Visit https://www.vigilion.com to get the access keys of your project.
+MESSAGE
+
+    def send(request)
+      response = @conn.post "/scans", request
+      process_response(request, response)
+    end
+
+    def process_response(request, response)
+      raise Vigilion::Error.new(INVALID_CREDENTIALS) if response.status == 401
+      raise Vigilion::Error.new("Payment required: #{response.body['error']}") if response.status == 402
+      unless response.success?
+        raise Vigilion::Error.new("Invalid scanning request: #{request}. Status: #{response.status}. Response: #{response.body}")
+      end
+      response.body
+    end
+
+    def validate_access_keys
+      raise Vigilion::Error.new("Configuration.access_key_id is not present\n#{HOW_TO_CONFIGURE}") unless Configuration.access_key_id
+      raise Vigilion::Error.new("Configuration.secret_access_key is not present\n#{HOW_TO_CONFIGURE}") unless Configuration.secret_access_key
+    end
+  end
+end

data/lib/vigilion/version.rb

@@ -0,0 +1,3 @@
+module Vigilion
+  VERSION = "1.0.1"
+end

data/test/configuration_test.rb

@@ -0,0 +1,17 @@
+require_relative "./test_helper.rb"
+
+describe Vigilion::Configuration do
+  describe "configure" do
+    it "allows set attributes" do
+      Vigilion.configure do |config|
+        config.attribute = "something"
+      end
+
+      assert_equal Vigilion::Configuration.attribute, "something"
+    end
+
+    it "has default values" do
+      refute_nil Vigilion::Configuration.server_url
+    end
+  end
+end

data/test/http_test.rb

@@ -0,0 +1,88 @@
+require_relative "./test_helper.rb"
+
+describe Vigilion::HTTP do
+
+  describe "constructor" do
+    it "raises error without access_key_id" do
+      Vigilion::Configuration.access_key_id = nil
+      assert_raises Vigilion::Error do
+        Vigilion::HTTP.new
+      end
+    end
+
+    it "raises error without secret_access_key" do
+      Vigilion::Configuration.secret_access_key = nil
+      assert_raises Vigilion::Error do
+        Vigilion::HTTP.new
+      end
+    end
+  end
+
+  describe "with credentials" do
+    before do
+      Vigilion.configure do |config|
+        config.access_key_id = "some-key"
+        config.secret_access_key = "some-secret"
+      end
+    end
+
+    describe "#scan_url" do
+      it "returns status of job if posted with success" do
+        # stub POST request for providing URL to files for scan
+        stub_request(:post, "localhost:5000/scans").to_return(
+          body: { "status" => "scanning" }.to_json)
+
+        # check if stubbed URL provides status for scan job
+        scan_request = Vigilion.scan_url("id", "url")
+        assert_includes(scan_request, "scanning")
+      end
+
+      it "accepts options" do
+        # stub POST request for providing URL to files for scan
+        stub_request(:post, "localhost:5000/scans").to_return(
+          body: { "status" => "scanning" }.to_json)
+
+        # check if stubbed URL provides status for scan job
+        scan_request = Vigilion.scan_url("id", "url", force: true)
+        assert_includes(scan_request, "scanning")
+      end
+    end
+
+    describe "#scan_path" do
+      it "returns status of job if posted with success" do
+        # stub POST request for providing URL to files for scan
+        stub_request(:post, "localhost:5000/scans").to_return(
+          body: { "status" => "scanning" }.to_json)
+
+        # check if stubbed URL provides status for scan job
+        scan_request = Vigilion.scan_path("id", "test/sample_file.txt")
+        assert_includes(scan_request, "scanning")
+      end
+
+      it "accepts options" do
+        # stub POST request for providing URL to files for scan
+        stub_request(:post, "localhost:5000/scans").to_return(
+          body: { "status" => "scanning" }.to_json)
+
+        # check if stubbed URL provides status for scan job
+        scan_request = Vigilion.scan_path("id", "test/sample_file.txt", force: true)
+        assert_includes(scan_request, "scanning")
+      end
+    end
+
+    describe "#get" do
+      it "returns status of a job for provided uuid" do
+        body = { id: "de401fdf-08b0-44a8-810b-20794c5c98c7",
+            result: "Eicar-Test-Signature FOUND",
+            md5: "69630e4574ec6798239b091cda43dca0",
+            status: "error" }.to_json
+
+        stub_request(:get, "localhost:5000/scans/de401fdf-08b0-44a8-810b-20794c5c98c7").to_return(
+          body: body)
+
+        result = Vigilion.check_status("de401fdf-08b0-44a8-810b-20794c5c98c7")
+        assert_equal(result, body)
+      end
+    end
+  end
+end

data/test/sample_file.txt

@@ -0,0 +1 @@
+sample_file

data/test/test_helper.rb

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

data/vigilion.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "vigilion/version"
+
+Gem::Specification.new do |s|
+  s.name          = "vigilion"
+  s.version       = Vigilion::VERSION
+  s.authors       = ["Bit Zesty Ltd"]
+  s.email         = ["help@vigilion.com"]
+  s.description   = "API client for Vigilion Anti-Virus & Malware file scanning service"
+  s.summary       = "API client for Vigilion Anti-Virus & Malware file scanning service"
+  s.homepage      = "https://github.com/vigilion/vigilion-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_dependency "faraday-detailed_logger"
+
+  s.add_development_dependency "rake"
+end

metadata

@@ -0,0 +1,116 @@
+--- !ruby/object:Gem::Specification
+name: vigilion
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Bit Zesty Ltd
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-18 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: faraday-detailed_logger
+  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: 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 Vigilion Anti-Virus & Malware file scanning service
+email:
+- help@vigilion.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/vigilion.rb
+- lib/vigilion/configuration.rb
+- lib/vigilion/errors.rb
+- lib/vigilion/http.rb
+- lib/vigilion/version.rb
+- test/configuration_test.rb
+- test/http_test.rb
+- test/sample_file.txt
+- test/test_helper.rb
+- vigilion.gemspec
+homepage: https://github.com/vigilion/vigilion-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 Vigilion Anti-Virus & Malware file scanning service
+test_files: []