vtapi 0.1.0 → 0.2.0

data/README.md

@@ -1,4 +1,4 @@
-# VtAPI
+# VtAPI [![Gem Version](https://badge.fury.io/rb/vtapi.png)](http://badge.fury.io/rb/vtapi)
 
 Ruby gem for VirusTotal Public API v2.0
 
@@ -37,7 +37,24 @@ puts resp.positives  #  num of positives
 puts resp.scan_results # {"McAfee"=>nil, "Symantec"=>"Android.ZertSecurity", ... }
 ```
 
-### File Upload
+### File Report (multiple resources)
+```ruby
+# retrieve file report by file hash(SHA256, SHA1, MD5)
+# up to 4 resources can assign 
+resources = ['00ce460c8b33711091206..', ..]
+resps = api.file_report(resources)
+resps.each do |r|
+  puts "#{r.sha256}: #{r.positives} / #{r.total}" if r.response_code == 1
+end
+```
+The following APIs are supported Posting multi resources(URLs).
+* VtAPI#file_report
+* VtAPI#file_rescan
+* VtAPI#url_scan
+* VtAPI#url_report
+
+
+### File Scan (File Upload)
 ```ruby
 # read file
 data = File.open(some_path, 'rb') {|f| f.read }
@@ -49,21 +66,43 @@ resp = api.file_scan(data)
 puts resp.response_code # 1: OK, 0: result doesn't exist, -2: still queued
 ```
 
+
+### URL Scan
+```ruby
+# upload url
+resp = api.url_scan(url)
+
+# confirm response_code
+puts resp.response_code # 1: OK, 0: result doesn't exist, -2: still queued
+```
+
+
+### URL Report
+```ruby
+# upload url
+resp = api.url_scan(url)
+
+# confirm result
+puts resp.scans
+```
+
+
 ## Features
-### Supported API
+### Support API
 * file/scan
 * file/resan
 * file/report
-
-### not implemented yet
 * url/scan
 * url/report
+
+### Not implemented yet
 * ip-address/report
 * domain/report
 
-### unsupported API
+### Unsupported
 * comments/puts
 
+
 ## Contributing
 
 1. Fork it

data/lib/vtapi/api.rb

@@ -24,13 +24,36 @@ class VtAPI
   end
 
   def file_rescan(resource)
+    if resource.is_a? Array
+      raise 'limit is up to 25 items' if resource.size > 25
+      resource = resource.join(', ')
+    end
     http_post('file/rescan', resource: resource)
   end
 
   def file_report(resource)
+    if resource.is_a? Array
+      raise 'limit is up to 4 items' if resource.size > 4
+      resource = resource.join(', ')
+    end
     http_post('file/report', resource: resource)
   end
 
+  def url_scan(url)
+    if url.is_a? Array
+      raise 'limit is up to 4 items' if url.size > 4
+      url = url.join("\n")
+    end
+    http_post('url/scan', url: url)
+  end
+
+  def url_report(url)
+    if url.is_a? Array
+      raise 'limit is up to 4 items' if url.size > 4
+      url = url.join(", ")
+    end
+    http_post('url/report', resource: url)
+  end
 
   def http_post(path, params = {})
     uri = BASE_URL + path
@@ -45,6 +68,6 @@ class VtAPI
         resp.return!(req, result, &block)
       end
     end
-    Response.new(resp.body)
+    Response.parse(resp.body)
   end
 end

data/lib/vtapi/response.rb

@@ -3,8 +3,17 @@ require 'time'
 
 class VtAPI
   class Response
-    def initialize(response_body)
-      @json = JSON.parse(response_body)
+    def self.parse(response_body)
+      json = JSON.parse(response_body)
+      if json.is_a? Array
+        return json.map{|e| Response.new(e) }
+      else
+        return Response.new(json)
+      end
+    end
+
+    def initialize(json)
+      @json = json
       @json.keys.each do |key|
         Response.class_eval {
           define_method key.to_s do |*args|
@@ -34,5 +43,9 @@ class VtAPI
     def [](key)
       @json.fetch(key.to_s) # raise KeyError when key doesn't exist.
     end
+
+    def to_s
+      @json.to_json
+    end
   end
 end

data/lib/vtapi/version.rb

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

data/spec/response_spec.rb

@@ -5,7 +5,9 @@ describe VtAPI::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) }
+    let(:sample_json) { JSON.parse(sample_response) }
+    let(:response) { VtAPI::Response.new(sample_json) }
+    
 
     describe '#md5' do
       it { expect(response.md5).to eq '1cf41bdc0fdd409774eb755031a6f49d' }
@@ -57,6 +59,14 @@ describe VtAPI::Response 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
+
+    describe '#to_s' do
+      subject { response.to_s }
+      it 'should be able to parse as json' do
+         expect{ JSON.parse(subject) }.to_not raise_error
+      end
+      it { expect(JSON.parse(subject).keys).to match_array ['scans', 'scan_id', 'sha1', 'resource', 'response_code', 'scan_date', 'permalink', 'verbose_msg', 'total', 'positives', 'sha256', 'md5'] }
+    end
   end
 
   context 'with no scan result' do
@@ -67,5 +77,28 @@ describe VtAPI::Response do
     describe '#positive_threats' do
       pending 'not implemented yet'
     end
+
+  end
+
+  describe '.parse' do
+    subject { VtAPI::Response.parse(response) }
+    context 'assigns single response' do
+      let(:response) { '{"md5":"1cf41bdc0fdd409774eb755031a6f49d"}' }
+      it { expect(subject).to be_a VtAPI::Response }
+      it { expect(subject.md5).to eq "1cf41bdc0fdd409774eb755031a6f49d" }
+    end
+
+    context 'assigns array response' do
+      subject {VtAPI::Response.parse(response) }
+      let(:response) { '[{"md5":"1cf41bdc0fdd409774eb755031a6f49d"}, {"md5":"1eef5bdc64241652f8a0df0c2dc92df6"}]' }
+      it { expect(subject).to be_a Array }
+      it { expect(subject).to have(2).items }
+
+      context 'about first object' do
+        subject {VtAPI::Response.parse(response).first }
+        it { expect(subject).to be_a VtAPI::Response }
+      end
+    end
   end
+
 end

data/spec/vtapi_spec.rb

@@ -48,6 +48,22 @@ describe VtAPI do
       .to_return(:body => sample_response, :status => 200)
       subject
     end
+
+    context 'assigns 2 resources' do
+      let(:resource) { ['ff' * 32, '00' * 32] }
+      let(:sample_response) { '[{}]' }
+      it "should post resource parameter as comma separete value" do
+        stub_request(:post, api_url)
+        .with(:body => {'resource' => resource.join(', '), 'apikey' => apikey} )
+        .to_return(:body => sample_response, :status => 200)
+        subject
+      end
+    end
+
+    context 'when assign 25 resources(over the limitation)' do
+      let(:resource) { ['ff' * 32] * 25 }
+      it { expect{ subject }.to raise_error }
+    end
   end
 
   describe '#file_report' do
@@ -74,5 +90,85 @@ describe VtAPI do
         expect{ subject }.to raise_error(VtAPI::AuthError)
       end
     end
+
+    context 'when assign 2 resources' do
+      let(:resource) { ['ff' * 32, '00' * 32] }
+      it "should post resource parameter as comma separete value" do
+        stub_request(:post, api_url)
+        .with(:body => {'resource' => resource.join(', '), 'apikey' => apikey} )
+        .to_return(:body => sample_response, :status => 200)
+        subject
+      end
+    end
+
+    context 'when assign 5 resources(over the limitation)' do
+      let(:resource) { ['ff' * 32] * 5 }
+      it { expect{ subject }.to raise_error }
+    end
   end
+
+  describe '#url_scan' do
+    let(:sample_response) { '{}' }
+    let(:api_url) { 'https://www.virustotal.com/vtapi/v2/url/scan' }
+    let(:target_url) { 'http://www.foobar.com/' }
+    subject { api.url_scan(target_url) }
+
+    it "should connect to 'https://www.virustotal.com/vtapi/v2/url/scan'" do
+      stub_request(:post, api_url)
+      .with(:body => {'url' => target_url, 'apikey' => apikey} )
+      .to_return(:body => sample_response, :status => 200)
+      subject
+    end
+
+    context 'when assign 2 urls' do
+      let(:target_url) { ['http://foobar.com/', 'http://abc.com'] }
+
+      it "should post url parameter which is joined by '\\n'" do
+        stub_request(:post, api_url)
+        .with(:body => {'url' => target_url.join("\n"), 'apikey' => apikey} )
+        .to_return(:body => sample_response, :status => 200)
+        subject
+      end
+    end
+
+    context 'when assign 5 urls (over the limitation)' do
+      let(:target_url) { ['http://www.foobar.com/'] * 5 }
+
+      it { expect{ subject }.to raise_error }
+    end
+  end
+
+  describe '#url_report' do
+    let(:sample_response) { '{}' }
+    let(:api_url) { 'https://www.virustotal.com/vtapi/v2/url/report' }
+    let(:target_url) { 'http://www.foobar.com/' }
+    subject { api.url_report(target_url) }
+
+    it "should connect to 'https://www.virustotal.com/vtapi/v2/url/report'" do
+      stub_request(:post, api_url)
+      .with(:body => {'resource' => target_url, 'apikey' => apikey} )
+      .to_return(:body => sample_response, :status => 200)
+      subject
+    end
+
+    context 'when assign 2 urls' do
+      let(:target_url) { ['http://foobar.com/', 'http://abc.com'] }
+
+      it "should post url parameter which is joined by ', '" do
+        stub_request(:post, api_url)
+        .with(:body => {'resource' => target_url.join(", "), 'apikey' => apikey} )
+        .to_return(:body => sample_response, :status => 200)
+        subject
+      end
+    end
+
+    context 'when assign 5 urls (over the limitation)' do
+      let(:target_url) { ['http://www.foobar.com/'] * 5 }
+
+      it { expect{ subject }.to raise_error }
+    end
+  end
+
+
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vtapi
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-20 00:00:00.000000000 Z
+date: 2013-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70305944392860 !ruby/object:Gem::Requirement
+  requirement: &70343748341080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '1.3'
   type: :development
   prerelease: false
-  version_requirements: *70305944392860
+  version_requirements: *70343748341080
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70305944392140 !ruby/object:Gem::Requirement
+  requirement: &70343748340660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70305944392140
+  version_requirements: *70343748340660
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70305944391080 !ruby/object:Gem::Requirement
+  requirement: &70343748340120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 2.13.0
   type: :development
   prerelease: false
-  version_requirements: *70305944391080
+  version_requirements: *70343748340120
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70305944390140 !ruby/object:Gem::Requirement
+  requirement: &70343748339620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.11.0
   type: :development
   prerelease: false
-  version_requirements: *70305944390140
+  version_requirements: *70343748339620
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70305944388880 !ruby/object:Gem::Requirement
+  requirement: &70343748339160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,7 +65,7 @@ dependencies:
         version: 1.6.7
   type: :runtime
   prerelease: false
-  version_requirements: *70305944388880
+  version_requirements: *70343748339160
 description: gem for VirusTotal Public API version2.0.
 email:
 - masatanish@gmail.com
@@ -102,7 +102,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -530785710278489622
+      hash: -803017513526154134
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -111,7 +111,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -530785710278489622
+      hash: -803017513526154134
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.16