virustotal_api 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ef4844e6f5a7e7be0cf7ed1aa7c7f25027bc5522
-  data.tar.gz: 34c4dcb450256151376eb1486ca2b9fed3a9a3be
+  metadata.gz: 08639ee03219b15575d468fd157eda539bc3897e
+  data.tar.gz: 2c281969e78d7fbcf5d665b392ab16bf11c7abc8
 SHA512:
-  metadata.gz: 2bb1845d91af6c8ed7fef6055ec3514aa86427d6e751877b5c3ac4630430b17beb1dc9138c8a5d3d71c33ef503a0da056f558fbe97605f0fd621cb09d585ab0d
-  data.tar.gz: 2b73096b9aefc1aee739fb1bfb243f508a9e5b79118352dc34800c959ce1bb4ada3db7cfa2a8adccc834f65676c042ea4dfb1e5245adf480016d7212819e935c
+  metadata.gz: 63fb4449337880642ae44ce0c1fa483835fa21c7a8f5a38e456aae569322ab26b1e9f7a22362e9b1bef65503a4f652b5154594e2be01c947003d2dc441eefdfc
+  data.tar.gz: 365ba31b29a47e37f34565c97ce45a08105865ffd531bc5bfabfa305ab89b297b1aa9a465515d79f3fb96a2052e7e69e895d625b4ddadbae53439aa1399ea613

data/.travis.yml

@@ -1,4 +1,8 @@
+---
 sudo: false
+branches:
+  except:
+    - gh-pages
 cache: bundler
 language: ruby
 rvm:

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+# VirusTotal API Changelog
+
+## 0.2.0
+
+* Check if the respone is 204 [#2](https://github.com/pwelch/virustotal_api/pull/2)
+  * Check if the respone is 204 (No Content) and raise an exception. [@postmodern](https://github.com/postmodern)
+
+## 0.1.0
+
+* First Release

data/README.md

@@ -2,6 +2,7 @@
 
 Ruby Gem for [VirusTotal](https://www.virustotal.com) [V2 API](https://www.virustotal.com/en/documentation/public-api/)
 
+[![Gem Version](https://badge.fury.io/rb/virustotal_api.svg)](http://badge.fury.io/rb/virustotal_api)
 [![Build Status](https://secure.travis-ci.org/pwelch/virustotal_api.svg)](http://travis-ci.org/pwelch/virustotal_api)
 
 ## Installation
@@ -22,6 +23,10 @@ Or install it yourself as:
 
 ## Usage
 
+VirusTotal only allows 4 queries per minute for their Public API. https://www.virustotal.com/en/faq/
+
+You will need a Private API Key if you require more queries per minute.
+
 ### File Report
 
 ```ruby

data/lib/virustotal_api/base.rb

@@ -1,3 +1,4 @@
+require 'virustotal_api/exceptions'
 require 'rest-client'
 require 'json'
 
@@ -8,6 +9,16 @@ module VirustotalAPI
       VirustotalAPI::URI
     end
 
+    # @param [RestClient::Response] response
+    # @return [Hash] the parsed JSON.
+    def self.parse(response)
+      if response.code == 204
+        fail(RateLimitError, 'maximum number of 4 requests per minute reached')
+      end
+
+      JSON.parse(response.body)
+    end
+
     # @return [String] string of API URI instance method
     def api_uri
       self.class.api_uri

data/lib/virustotal_api/domain_report.rb

@@ -17,7 +17,7 @@ module VirustotalAPI
         api_uri + '/domain/report',
         { :params => params(domain, api_key) }
       )
-      report = JSON.parse(response.body)
+      report = parse(response)
 
       new(report)
     end

data/lib/virustotal_api/exceptions.rb

@@ -0,0 +1,4 @@
+module VirustotalAPI
+  class RateLimitError < RuntimeError
+  end
+end

data/lib/virustotal_api/file_report.rb

@@ -18,7 +18,7 @@ module VirustotalAPI
         api_uri + '/file/report',
         params(resource, api_key)
       )
-      report = JSON.parse(response.body)
+      report = parse(response)
 
       new(report)
     end

data/lib/virustotal_api/ip_report.rb

@@ -17,7 +17,7 @@ module VirustotalAPI
         api_uri + '/ip-address/report',
         { :params => params(ip, api_key) }
       )
-      report = JSON.parse(response.body)
+      report = parse(response)
 
       new(report)
     end

data/lib/virustotal_api/url_report.rb

@@ -19,7 +19,7 @@ module VirustotalAPI
         api_uri + '/url/report',
         params(resource, api_key)
       )
-      report = JSON.parse(response.body)
+      report = parse(response)
 
       new(report)
     end

data/lib/virustotal_api/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module VirustotalAPI
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/test/base_test.rb

@@ -13,7 +13,7 @@ class VirustotalAPIBaseTest < Minitest::Test
   end
 
   # Instance Method
-  def test_api_uri
+  def test_api_uri_instance_method
     base_uri = 'https://www.virustotal.com/vtapi/v2'
     vt_base = VirustotalAPI::Base.new
 
@@ -22,13 +22,31 @@ class VirustotalAPIBaseTest < Minitest::Test
   end
 
   # Class Method
-  def test_api_uri
+  def test_api_uri_class_method
     base_uri = 'https://www.virustotal.com/vtapi/v2'
 
     assert VirustotalAPI::Base.api_uri.is_a?(String)
     assert VirustotalAPI::Base.api_uri, base_uri
   end
 
+  def test_parse_code_200
+    mock_response_200 = Minitest::Mock.new
+    mock_response_200.expect(:code, 200)
+    mock_response_200.expect(:body, '{}')
+
+    assert VirustotalAPI::Base.parse(mock_response_200), {}
+  end
+
+  def test_parse_code_204
+    mock_response_204 = Minitest::Mock.new
+    mock_response_204.expect(:code, 204)
+    mock_response_204.expect(:body, '{}')
+
+    assert_raises VirustotalAPI::RateLimitError do
+      VirustotalAPI::Base.parse(mock_response_204)
+    end
+  end
+
   # Test using FileReport
   def test_exists?
     VCR.use_cassette('report') do

data/test/exceptions_test.rb

@@ -0,0 +1,8 @@
+# encoding: utf-8
+require './test/test_helper'
+
+class RateLimitErrorTest < Minitest::Test
+  def test_class_exists
+    assert VirustotalAPI::RateLimitError
+  end
+end

data/test/version_test.rb

@@ -4,6 +4,6 @@ require './test/test_helper'
 class VirustotalAPIVTReportTest < Minitest::Test
   def test_version
     assert VirustotalAPI::VERSION.is_a?(String)
-    assert VirustotalAPI::VERSION, '0.1.0'
+    assert VirustotalAPI::VERSION, '0.2.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: virustotal_api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - pwelch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-26 00:00:00.000000000 Z
+date: 2015-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest-client
@@ -160,6 +160,7 @@ files:
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -167,6 +168,7 @@ files:
 - lib/virustotal_api.rb
 - lib/virustotal_api/base.rb
 - lib/virustotal_api/domain_report.rb
+- lib/virustotal_api/exceptions.rb
 - lib/virustotal_api/file_report.rb
 - lib/virustotal_api/file_scan.rb
 - lib/virustotal_api/ip_report.rb
@@ -175,6 +177,7 @@ files:
 - lib/virustotal_api/version.rb
 - test/base_test.rb
 - test/domain_report_test.rb
+- test/exceptions_test.rb
 - test/file_report_test.rb
 - test/file_scan_test.rb
 - test/fixtures/domain_report.yml
@@ -211,13 +214,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.3
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: Gem for VirusTotal.com API
 test_files:
 - test/base_test.rb
 - test/domain_report_test.rb
+- test/exceptions_test.rb
 - test/file_report_test.rb
 - test/file_scan_test.rb
 - test/fixtures/domain_report.yml