virustotal_api 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 08639ee03219b15575d468fd157eda539bc3897e
-  data.tar.gz: 2c281969e78d7fbcf5d665b392ab16bf11c7abc8
+SHA256:
+  metadata.gz: 8bed66a7fba9485458455710be627e1f833347bceb426162e95580a0523f709e
+  data.tar.gz: 958f96c673f266360f5da1f5c28e9c948407956176be6af1196ad53aee7ab551
 SHA512:
-  metadata.gz: 63fb4449337880642ae44ce0c1fa483835fa21c7a8f5a38e456aae569322ab26b1e9f7a22362e9b1bef65503a4f652b5154594e2be01c947003d2dc441eefdfc
-  data.tar.gz: 365ba31b29a47e37f34565c97ce45a08105865ffd531bc5bfabfa305ab89b297b1aa9a465515d79f3fb96a2052e7e69e895d625b4ddadbae53439aa1399ea613
+  metadata.gz: b633ba4b732ea5cc41470928879ef92c75000a66df300d7640a4e28d210a85192cd69fb5a4c96e4fd37f1434eda2c0678a3ac359c235fb46a588f67cebe20d51
+  data.tar.gz: 25bf3927a97a5fdc9435caa0073223b46fb4af8badc0f18edb735c5ce34174b585a98db7b04a05b9aea35213a2f0d1e9f6c47be1c9132c78668c04334776dac6

data/.github/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at git@pwelch.net. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/.github/CONTRIBUTING.md

@@ -0,0 +1,7 @@
+# Contributing
+
+1. Fork it ( https://github.com/pwelch/virustotal_api/fork )
+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 a new Pull Request

data/.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,15 @@
+## Expected Behavior
+
+
+## Actual Behavior
+
+
+## Steps to Reproduce the Problem
+
+  1.
+
+## Specifications
+
+  - Version:
+  - Platform:
+  - Subsystem:

data/.rubocop.yml

@@ -25,3 +25,11 @@ Style/RegexpLiteral:
 
 Style/BracesAroundHashParameters:
   Enabled: false
+
+Lint/MissingCopEnableDirective:
+  Exclude:
+    - 'test/base_test.rb'
+
+Naming/UncommunicativeMethodParamName:
+  Exclude:
+    - 'lib/virustotal_api/ip_report.rb'

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # VirusTotal API Changelog
 
+## 0.3.0
+
+* Add optional scan param for url report API [#5](https://github.com/pwelch/virustotal_api/pull/5)
+  * [@mkunkel ](https://github.com/mkunkel)
+
 ## 0.2.0
 
 * Check if the respone is 204 [#2](https://github.com/pwelch/virustotal_api/pull/2)

data/Gemfile

@@ -1,5 +1,3 @@
-# encoding: utf-8
-
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require 'bundler/gem_tasks'
 require 'rake/testtask'
 require 'rubocop/rake_task'

data/lib/virustotal_api/base.rb

@@ -13,7 +13,7 @@ module VirustotalAPI
     # @return [Hash] the parsed JSON.
     def self.parse(response)
       if response.code == 204
-        fail(RateLimitError, 'maximum number of 4 requests per minute reached')
+        raise(RateLimitError, 'maximum number of 4 requests per minute reached')
       end
 
       JSON.parse(response.body)
@@ -29,7 +29,7 @@ module VirustotalAPI
     def exists?
       response_code = report.fetch('response_code') { nil }
 
-      response_code == 1 ? true : false
+      response_code == 1
     end
   end
 end

data/lib/virustotal_api/domain_report.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require_relative 'base'
 
 module VirustotalAPI

data/lib/virustotal_api/file_report.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require_relative 'base'
 
 module VirustotalAPI

data/lib/virustotal_api/file_scan.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require_relative 'base'
 
 module VirustotalAPI
@@ -30,7 +30,7 @@ module VirustotalAPI
     def queued_for_analysis?
       response_code = report.fetch('response_code') { nil }
 
-      response_code == -2 ? true : false
+      response_code == -2
     end
   end
 end

data/lib/virustotal_api/ip_report.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require_relative 'base'
 
 module VirustotalAPI

data/lib/virustotal_api/uri.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 module VirustotalAPI
-  URI = 'https://www.virustotal.com/vtapi/v2'
+  URI = 'https://www.virustotal.com/vtapi/v2'.freeze
 end

data/lib/virustotal_api/url_report.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require_relative 'base'
 
 module VirustotalAPI
@@ -13,11 +13,12 @@ module VirustotalAPI
 
     # @param [String] resource file as a md5/sha1/sha256 hash
     # @param [String] api_key for virustotal
+    # @param [Integer] optional param to start scan if not found. 1 for true
     # @return [VirustotalAPI::URLReport] Report Search Result
-    def self.find(resource, api_key)
+    def self.find(resource, api_key, scan = 0)
       response = RestClient.post(
         api_uri + '/url/report',
-        params(resource, api_key)
+        params(resource, api_key, scan)
       )
       report = parse(response)
 
@@ -26,11 +27,13 @@ module VirustotalAPI
 
     # @param [String] resource file as a md5/sha1/sha256 hash
     # @param [String] api_key for virustotal
+    # @param [Integer] optional param to start scan if not found. 1 for true
     # @return [Hash] params for POST Request
-    def self.params(resource, api_key)
+    def self.params(resource, api_key, scan = 0)
       {
         :resource => resource,
-        :apikey   => api_key
+        :apikey   => api_key,
+        :scan     => scan.to_s
       }
     end
   end

data/lib/virustotal_api/version.rb

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

data/lib/virustotal_api.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require 'virustotal_api/domain_report'
 require 'virustotal_api/file_report'
 require 'virustotal_api/file_scan'

data/test/base_test.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 # rubocop:disable LineLength
 require './test/test_helper'
 
@@ -30,20 +30,20 @@ class VirustotalAPIBaseTest < Minitest::Test
   end
 
   def test_parse_code_200
-    mock_response_200 = Minitest::Mock.new
-    mock_response_200.expect(:code, 200)
-    mock_response_200.expect(:body, '{}')
+    mock_response200 = Minitest::Mock.new
+    mock_response200.expect(:code, 200)
+    mock_response200.expect(:body, '{}')
 
-    assert VirustotalAPI::Base.parse(mock_response_200), {}
+    assert VirustotalAPI::Base.parse(mock_response200), {}
   end
 
   def test_parse_code_204
-    mock_response_204 = Minitest::Mock.new
-    mock_response_204.expect(:code, 204)
-    mock_response_204.expect(:body, '{}')
+    mock_response204 = Minitest::Mock.new
+    mock_response204.expect(:code, 204)
+    mock_response204.expect(:body, '{}')
 
     assert_raises VirustotalAPI::RateLimitError do
-      VirustotalAPI::Base.parse(mock_response_204)
+      VirustotalAPI::Base.parse(mock_response204)
     end
   end
 

data/test/domain_report_test.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require './test/test_helper'
 
 class VirustotalAPIDomainReportTest < Minitest::Test

data/test/exceptions_test.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require './test/test_helper'
 
 class RateLimitErrorTest < Minitest::Test

data/test/file_report_test.rb

@@ -1,8 +1,7 @@
-# encoding: utf-8
-# rubocop:disable LineLength
 require './test/test_helper'
 
 class VirustotalAPIFileReportTest < Minitest::Test
+  # rubocop:disable LineLength
   def setup
     @sha256  = '01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b'
     @api_key = 'testapikey'
@@ -31,4 +30,5 @@ class VirustotalAPIFileReportTest < Minitest::Test
       assert virustotal_report.report_url, permalink
     end
   end
+  # rubocop:enable LineLength
 end

data/test/file_scan_test.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require './test/test_helper'
 
 class VirustotalAPIFileScanTest < Minitest::Test

data/test/fixtures/queue_unscanned_url_report.yml

@@ -0,0 +1,46 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.virustotal.com/vtapi/v2/url/report
+    body:
+      encoding: UTF-8
+      string: resource=http%3A%2F%2Fwww.unscanned.com&apikey=testapikey&scan=1
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (linux-gnu x86_64) ruby/2.4.1p111
+      Content-Length:
+      - '118'
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json
+      X-Cloud-Trace-Context:
+      - 82dde70aa4bad5b45d047d625ec37c2a
+      Date:
+      - Thu, 15 Mar 2018 14:46:41 GMT
+      Server:
+      - Google Frontend
+      Content-Length:
+      - '441'
+    body:
+      encoding: UTF-8
+      string: '{"permalink": "https://www.virustotal.com/url/c1f6493ad83d51c833a875bb10cca5bde7e2c35456168173a0bf25005c43ecaf/analysis/1521125201/",
+        "resource": "http://www.unscanned.com/", "url": "http://www.unscanned.com/",
+        "response_code": 1, "scan_date": "2018-03-15 14:46:41", "scan_id": "c1f6493ad83d51c833a875bb10cca5bde7e2c35456168173a0bf25005c43ecaf-1521125201",
+        "verbose_msg": "Scan request successfully queued, come back later for the
+        report"}'
+    http_version:
+  recorded_at: Thu, 15 Mar 2018 14:46:41 GMT
+recorded_with: VCR 4.0.0

data/test/fixtures/unscanned_url_report.yml

@@ -0,0 +1,43 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://www.virustotal.com/vtapi/v2/url/report
+    body:
+      encoding: UTF-8
+      string: resource=http%3A%2F%2Fwww.unscanned.com&apikey=testapikey&scan=0
+    headers:
+      Accept:
+      - "*/*"
+      Accept-Encoding:
+      - gzip, deflate
+      User-Agent:
+      - rest-client/2.0.2 (linux-gnu x86_64) ruby/2.4.1p111
+      Content-Length:
+      - '121'
+      Content-Type:
+      - application/x-www-form-urlencoded
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Cache-Control:
+      - no-cache
+      Content-Type:
+      - application/json
+      X-Cloud-Trace-Context:
+      - 66a8de76e13e5d05605518bdbfdf4628
+      Date:
+      - Mon, 26 Mar 2018 21:44:17 GMT
+      Server:
+      - Google Frontend
+      Content-Length:
+      - '120'
+    body:
+      encoding: UTF-8
+      string: '{"response_code": 0, "resource": "http://www.unscanned.com", "verbose_msg":
+        "Resource does not exist in the dataset"}'
+    http_version:
+  recorded_at: Mon, 26 Mar 2018 21:44:17 GMT
+recorded_with: VCR 4.0.0

data/test/ip_report_test.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require './test/test_helper'
 
 class VirustotalAPIIPReportTest < Minitest::Test

data/test/test_helper.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require './lib/virustotal_api'
 require 'minitest/autorun'
 require 'webmock/minitest'

data/test/uri_test.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require './test/test_helper'
 
 class VirustotalAPIVTReportTest < Minitest::Test

data/test/url_report_test.rb

@@ -1,8 +1,9 @@
-# encoding: utf-8
+
 require './test/test_helper'
 
 class VirustotalAPIURLReportTest < Minitest::Test
   def setup
+    @unscanned_url = 'http://www.unscanned.com'
     @url     = 'http://www.google.com'
     @api_key = 'testapikey'
   end
@@ -36,4 +37,20 @@ class VirustotalAPIURLReportTest < Minitest::Test
       assert vturl_report.scan_id.is_a?(String)
     end
   end
+
+  def test_scan_unscanned_url
+    VCR.use_cassette('unscanned_url_report') do
+      vturl_report = VirustotalAPI::URLReport.find(@unscanned_url, @api_key)
+
+      assert vturl_report.report['response_code'].zero?
+    end
+  end
+
+  def test_queue_unscanned_url
+    VCR.use_cassette('queue_unscanned_url_report') do
+      vturl_report = VirustotalAPI::URLReport.find(@unscanned_url, @api_key, 1)
+
+      assert vturl_report.report['response_code'] == 1
+    end
+  end
 end

data/test/version_test.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+
 require './test/test_helper'
 
 class VirustotalAPIVTReportTest < Minitest::Test

data/virustotal_api.gemspec

@@ -1,5 +1,5 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'virustotal_api/version'
 
@@ -18,15 +18,15 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'rest-client'
   spec.add_dependency 'json'
+  spec.add_dependency 'rest-client'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '~> 1.16'
   spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'vcr'
-  spec.add_development_dependency 'webmock'
   spec.add_development_dependency 'pry'
-  spec.add_development_dependency 'yard', '~> 0.8'
+  spec.add_development_dependency 'rake', '~> 12.3'
   spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'vcr'
+  spec.add_development_dependency 'webmock'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

metadata

@@ -1,17 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: virustotal_api
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - pwelch
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-19 00:00:00.000000000 Z
+date: 2018-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rest-client
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -25,7 +25,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -44,30 +44,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,21 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: vcr
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '12.3'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,33 +123,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: yard
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.9'
 description: Gem for VirusTotal.com API
 email:
 - paul@pwelch.net
@@ -157,6 +157,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/CODE_OF_CONDUCT.md"
+- ".github/CONTRIBUTING.md"
+- ".github/ISSUE_TEMPLATE.md"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"
@@ -183,10 +186,12 @@ files:
 - test/fixtures/domain_report.yml
 - test/fixtures/ip_report.yml
 - test/fixtures/null_file
+- test/fixtures/queue_unscanned_url_report.yml
 - test/fixtures/report.yml
 - test/fixtures/report_not_found.yml
 - test/fixtures/request_forbidden.yml
 - test/fixtures/scan.yml
+- test/fixtures/unscanned_url_report.yml
 - test/fixtures/url_report.yml
 - test/ip_report_test.rb
 - test/test_helper.rb
@@ -214,7 +219,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Gem for VirusTotal.com API
@@ -227,14 +232,15 @@ test_files:
 - test/fixtures/domain_report.yml
 - test/fixtures/ip_report.yml
 - test/fixtures/null_file
+- test/fixtures/queue_unscanned_url_report.yml
 - test/fixtures/report.yml
 - test/fixtures/report_not_found.yml
 - test/fixtures/request_forbidden.yml
 - test/fixtures/scan.yml
+- test/fixtures/unscanned_url_report.yml
 - test/fixtures/url_report.yml
 - test/ip_report_test.rb
 - test/test_helper.rb
 - test/uri_test.rb
 - test/url_report_test.rb
 - test/version_test.rb
-has_rdoc: