vtapi 0.1.0

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in vtapi.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 masatanish
+
+MIT License
+
+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,75 @@
+# VtAPI
+
+Ruby gem for VirusTotal Public API v2.0
+
+https://www.virustotal.com/en/documentation/public-api/
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vtapi'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vtapi
+
+## Usage
+### Prepare
+```ruby
+# initialize
+api = VtAPI.new('-- Your API KEY--')
+```
+
+### File Report
+```ruby
+# retrieve file report by file hash(SHA256, SHA1, MD5)
+resp = api.file_report('00ce460c8b337110912066f746731a916e85bf1d7f4b44f09ca3cc39f9b52a98')
+
+puts resp.response_code # 1: OK, 0: result doesn't exist, -2: still queued
+
+# resp is a instance of VtAPI::Response class
+puts resp.positives  #  num of positives
+puts resp.scan_results # {"McAfee"=>nil, "Symantec"=>"Android.ZertSecurity", ... }
+```
+
+### File Upload
+```ruby
+# read file
+data = File.open(some_path, 'rb') {|f| f.read }
+
+# upload data
+resp = api.file_scan(data)
+
+# confirm response_code
+puts resp.response_code # 1: OK, 0: result doesn't exist, -2: still queued
+```
+
+## Features
+### Supported API
+* file/scan
+* file/resan
+* file/report
+
+### not implemented yet
+* url/scan
+* url/report
+* ip-address/report
+* domain/report
+
+### unsupported API
+* comments/puts
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+

data/Rakefile

@@ -0,0 +1,5 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/lib/vtapi/api.rb

@@ -0,0 +1,50 @@
+require 'rest-client'
+require 'tempfile'
+require 'json'
+
+class VtAPI
+  # base URL of the VirusTotal Public API v2.0 
+  BASE_URL = 'https://www.virustotal.com/vtapi/v2/'
+
+  attr_reader :apikey
+
+  def initialize(apikey)
+    @apikey = apikey
+  end
+
+  def file_scan(data)
+    # TODO: set filename or file path
+    tmp = Tempfile.open('tmp')
+    tmp.write data
+    def tmp.content_type
+      'application/octet-stream'
+    end
+    tmp.pos=0
+    http_post('file/scan', file: tmp, multipart: true)
+  end
+
+  def file_rescan(resource)
+    http_post('file/rescan', resource: resource)
+  end
+
+  def file_report(resource)
+    http_post('file/report', resource: resource)
+  end
+
+
+  def http_post(path, params = {})
+    uri = BASE_URL + path
+    params['apikey'] = @apikey
+    resp = RestClient.post(uri, params) do |resp, req, result, &block|
+      case resp.code
+      when 204
+        raise ExceedAPILimit, "you exceed the public API request rate limit: key[#{@apikey}]"
+      when 403
+        raise AuthError, "you do not have the required priviledges: key[#{@apikey}]"
+      else
+        resp.return!(req, result, &block)
+      end
+    end
+    Response.new(resp.body)
+  end
+end

data/lib/vtapi/exception.rb

@@ -0,0 +1,6 @@
+class VtAPI
+  # 204 exceed the public API request rate limit
+  class ExceedAPILimit < StandardError; end
+  # 403 Forbidden
+  class AuthError < StandardError; end
+end

data/lib/vtapi/response.rb

@@ -0,0 +1,38 @@
+require 'json'
+require 'time'
+
+class VtAPI
+  class Response
+    def initialize(response_body)
+      @json = JSON.parse(response_body)
+      @json.keys.each do |key|
+        Response.class_eval {
+          define_method key.to_s do |*args|
+            @json[key]
+          end
+        }
+      end
+      @json['scan_date'] = Time.parse(@json['scan_date'] + "UTC") if @json.has_key? 'scan_date'
+    end
+
+    def keys
+      @json.keys
+    end
+
+    def positive_threats
+      Hash[@json.fetch('scans', {}).select{|k,v| v['detected'] }.map{|k,v| [k, v['result']] }]
+    end
+
+    def positive_brands
+      @json.fetch('scans', {}).select{|k,v| v['detected'] }.keys
+    end
+
+    def scan_results
+      Hash[@json.fetch('scans', {}).map{|k,v| [k, v['result']] }]
+    end
+
+    def [](key)
+      @json.fetch(key.to_s) # raise KeyError when key doesn't exist.
+    end
+  end
+end

data/lib/vtapi/version.rb

@@ -0,0 +1,3 @@
+module Vtapi
+  VERSION = "0.1.0"
+end

data/lib/vtapi.rb

@@ -0,0 +1,5 @@
+require 'vtapi/version'
+require 'vtapi/exception'
+require 'vtapi/response'
+require 'vtapi/api'
+

data/spec/response_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe VtAPI::Response do
+  context 'with sample file_report response' do
+    let(:sample_response) {
+      "{\"scans\":{\"McAfee\":{\"detected\":false,\"version\":\"5.400.0.1158\",\"result\":null,\"update\":\"20130512\"},\"Symantec\":{\"detected\":true,\"version\":\"20121.3.0.76\",\"result\":\"Android.ZertSecurity\",\"update\":\"20130512\"},\"Kaspersky\":{\"detected\":true,\"version\":\"9.0.0.837\",\"result\":\"HEUR:Trojan-Banker.AndroidOS.Zitmo.a\",\"update\":\"20130512\"},\"TrendMicro\":{\"detected\":false,\"version\":\"9.740.0.1012\",\"result\":null,\"update\":\"20130512\"},\"Microsoft\":{\"detected\":false,\"version\":\"1.9402\",\"result\":null,\"update\":\"20130512\"}},\"scan_id\":\"00ce460c8b337110912066f746731a916e85bf1d7f4b44f09ca3cc39f9b52a98-1368320515\",\"sha1\":\"e1b727b3e9336033606df79eeba03dd218b56c20\",\"resource\":\"00ce460c8b337110912066f746731a916e85bf1d7f4b44f09ca3cc39f9b52a98\",\"response_code\":1,\"scan_date\":\"2013-05-12 01:01:55\",\"permalink\":\"https://www.virustotal.com/file/00ce460c8b337110912066f746731a916e85bf1d7f4b44f09ca3cc39f9b52a98/analysis/1368320515/\",\"verbose_msg\":\"Scan finished, scan information embedded in this object\",\"total\":46,\"positives\":22,\"sha256\":\"00ce460c8b337110912066f746731a916e85bf1d7f4b44f09ca3cc39f9b52a98\",\"md5\":\"1cf41bdc0fdd409774eb755031a6f49d\"}"
+    }
+    let(:response) { VtAPI::Response.new(sample_response) }
+
+    describe '#md5' do
+      it { expect(response.md5).to eq '1cf41bdc0fdd409774eb755031a6f49d' }
+    end
+
+    describe '#sha1' do
+      it { expect(response.sha1).to eq 'e1b727b3e9336033606df79eeba03dd218b56c20' }
+    end
+
+    describe '#sha256' do
+      it { expect(response.sha256).to eq '00ce460c8b337110912066f746731a916e85bf1d7f4b44f09ca3cc39f9b52a98' }
+    end
+
+    describe '#scan_date' do
+      it { expect(response.scan_date).to be_a Time }
+    end
+
+    describe '#total' do
+      it { expect(response.total).to eq 46 }
+    end
+
+    describe '#positives' do
+      it { expect(response.positives).to eq 22 }
+    end
+
+    describe '#scan_id' do
+      it { expect(response.scan_id).to eq '00ce460c8b337110912066f746731a916e85bf1d7f4b44f09ca3cc39f9b52a98-1368320515' }
+    end
+
+    describe '#resource' do
+      it { expect(response.resource).to eq '00ce460c8b337110912066f746731a916e85bf1d7f4b44f09ca3cc39f9b52a98' }
+    end
+
+    describe '#keys' do
+      it { expect(response.keys).to match_array ['scans', 'scan_id', 'sha1', 'resource', 'response_code', 'scan_date', 'permalink', 'verbose_msg', 'total', 'positives', 'sha256', 'md5'] }
+    end
+
+    describe '#positive_brands' do
+      subject { response.positive_brands }
+      it { expect(subject).to match_array ["Kaspersky", "Symantec"] }
+    end
+
+    describe '#positive_threats' do
+      subject { response.positive_threats }
+      it { expect(subject).to eq({"Symantec"=>"Android.ZertSecurity", "Kaspersky"=>"HEUR:Trojan-Banker.AndroidOS.Zitmo.a"}) }
+    end
+
+    describe '#scan_results' do
+      subject { response.scan_results }
+      it { expect(subject).to eq({"McAfee"=>nil, "Symantec"=>"Android.ZertSecurity", "Kaspersky"=>"HEUR:Trojan-Banker.AndroidOS.Zitmo.a", "TrendMicro"=>nil, "Microsoft"=>nil}) }
+    end
+  end
+
+  context 'with no scan result' do
+    describe '#positive_brands' do
+      pending 'not implemented yet'
+    end
+
+    describe '#positive_threats' do
+      pending 'not implemented yet'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'rspec'
+require 'webmock/rspec'
+
+require 'vtapi'
+
+RSpec.configure do |config|
+
+end

data/spec/vtapi_spec.rb

@@ -0,0 +1,78 @@
+require 'spec_helper'
+
+describe VtAPI do
+  before do
+    #RestClient.log = STDERR
+  end
+
+  let(:apikey) { 'test apikey' }
+  let(:api) { VtAPI.new(apikey) }
+  subject { api }
+
+  describe '#apikey' do
+    it { expect(subject.apikey).to eq apikey }
+  end
+
+  describe '#file_scan' do
+    let(:sample_response) { '{}' }
+    let(:api_url) { 'https://www.virustotal.com/vtapi/v2/file/scan' }
+    subject { api.file_scan('binary data') }
+    it "should connect to virustotal.com with 'multipart/form-data' Content-Type" do
+      stub_request(:post, api_url)
+      .with(:headers => { "Content-Type" => /^multipart\/form-data;.*/ })
+      .to_return(:body => sample_response)
+      subject
+    end
+    it 'should include data part in body' do
+      stub_request(:post, api_url)
+      .with(:body => /name="file"; filename="tmp.*\r\n/ )
+      .to_return(:body => sample_response)
+      subject
+    end
+    it 'should include posted binary data in body' do
+      stub_request(:post, api_url)
+      .with(:body => /binary data/ )
+      .to_return(:body => sample_response)
+      subject
+    end
+  end
+
+  describe '#file_rescan' do
+    let(:sample_response) { '{}' }
+    let(:api_url) { 'https://www.virustotal.com/vtapi/v2/file/rescan' }
+    let(:resource) { 'ff' * 32 }
+    subject { api.file_rescan(resource) }
+    it "should connect to 'https://www.virustotal.com/vtapi/v2/file/rescan'" do
+      stub_request(:post, api_url)
+      .with(:body => {'resource' => resource, 'apikey' => apikey} )
+      .to_return(:body => sample_response, :status => 200)
+      subject
+    end
+  end
+
+  describe '#file_report' do
+    let(:sample_response) { '{}' }
+    let(:api_url) { 'https://www.virustotal.com/vtapi/v2/file/report' }
+    let(:resource) { 'ff' * 32 }
+    subject { api.file_report(resource) }
+    it "should connect to 'https://www.virustotal.com/vtapi/v2/file/report'" do
+      stub_request(:post, api_url)
+      .with(:body => {'resource' => resource, 'apikey' => apikey} )
+      .to_return(:body => sample_response, :status => 200)
+      subject
+    end
+
+    context 'when server returns 204' do
+      it do
+        stub_request(:post, api_url).to_return(:status => 204)
+        expect{ subject }.to raise_error(VtAPI::ExceedAPILimit)
+      end
+    end
+    context 'when server returns 403' do
+      it do
+        stub_request(:post, api_url).to_return(:status => 403)
+        expect{ subject }.to raise_error(VtAPI::AuthError)
+      end
+    end
+  end
+end

data/vtapi.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vtapi/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "vtapi"
+  spec.version       = Vtapi::VERSION
+  spec.authors       = ["masatanish"]
+  spec.email         = ["masatanish@gmail.com"]
+  spec.description   = %q{gem for VirusTotal Public API version2.0.}
+  spec.summary       = %q{gem for VirusTotal Public API version2.0.}
+  spec.homepage      = "https://github.com/masatanish/vtapi"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~>2.13.0"
+  spec.add_development_dependency "webmock", "~>1.11.0"
+
+  spec.add_dependency "rest-client", "~>1.6.7"
+end

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification
+name: vtapi
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- masatanish
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70305944392860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: *70305944392860
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70305944392140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70305944392140
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70305944391080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: *70305944391080
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70305944390140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.11.0
+  type: :development
+  prerelease: false
+  version_requirements: *70305944390140
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70305944388880 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *70305944388880
+description: gem for VirusTotal Public API version2.0.
+email:
+- masatanish@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/vtapi.rb
+- lib/vtapi/api.rb
+- lib/vtapi/exception.rb
+- lib/vtapi/response.rb
+- lib/vtapi/version.rb
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/vtapi_spec.rb
+- vtapi.gemspec
+homepage: https://github.com/masatanish/vtapi
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -530785710278489622
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -530785710278489622
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.16
+signing_key: 
+specification_version: 3
+summary: gem for VirusTotal Public API version2.0.
+test_files:
+- spec/response_spec.rb
+- spec/spec_helper.rb
+- spec/vtapi_spec.rb