virustotal_api 0.5.2 → 0.5.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bed8beb641ac85649be4628d37065079d3f2c881499a67065200eeba57f2176
-  data.tar.gz: a55ce4ed4bdc573607389e20578efd53f10d7ab1597b3deb05644571dac752c6
+  metadata.gz: 549e10acf953216ded9295c21129e76fc737bd63f29703af799499c6feed2c6e
+  data.tar.gz: d20c12d67d748d329e3b0e340a4857115d516d942af5e3a282bb72e80a90e373
 SHA512:
-  metadata.gz: 13c8674a48591fd1c063a4d76040555aeace01a19981feb558241ff1843984f2e8052c6169bec8a1ec4f63519e14bf9b3a109fcf7f8fc667d8a1e0cbfe7f99aa
-  data.tar.gz: b64cfe0bfa5fa79927d22d591534f2b7db2b3ca7f572e8360b0423c3de5def7948f3264381e001596c095c66ec04187fe5fddf1d4148ad21bcf66a08eaf981ac
+  metadata.gz: 394ad7a9dbf0f4c59d7e286acd57974e042427f0f4c82d1c652195b0dca4d17a0eeed28cd82946da2a072679a824060bacf184c741ecd0578e383386295c328d
+  data.tar.gz: 0f9b0e2bc76a11d1b496ac1b0fb266875ed36cbfb51b27396396b555c3e47d5e411073e8bef956e1e44d08ec395e1165a45df8e525b24af6a0ae915d2c9c1b79

data/README.md

@@ -117,7 +117,7 @@ vturl_report.exists?
 
 # URL for Report (if it exists)
 vturl_report.report_url
-# => "https://www.virustotal.com/api/v3/urls/dd014af5ed6b38d9130e3f466f850e46d21b951199d53a18ef29ee9341614eaf/"
+# => "https://www.virustotal.com/api/v3/urls/dd014af5ed6b38d9130e3f466f850e46d21b951199d53a18ef29ee9341614eaf"
 
 # Report results (if they exist) are available via #report
 vturl_report.report['data']['attributes']['last_analysis_results']['Avira']
@@ -161,6 +161,10 @@ vtip_report = VirustotalAPI::IP.find(ip, api_key)
 vtip_report.exists?
 # => true
 
+# URL for Report (if it exists)
+vtip_report.report_url
+# => "https://www.virustotal.com/api/v3/ip_addresses/8.8.8.8"
+
 # Report results (if they exist) are available via #report
 vtip_report.report
 # => Hash of report results
@@ -180,6 +184,10 @@ vtdomain_report = VirustotalAPI::Domain.find(domain, api_key)
 vtdomain_report.exists?
 # => true
 
+# URL for Report (if it exists)
+vtdomain_report.report_url
+# => "https://www.virustotal.com/api/v3/domains/virustotal.com"
+
 # Report results (if they exist) are available via #report
 vtdomain_report.report
 # => Hash of report results

data/lib/virustotal_api/analysis.rb

@@ -5,13 +5,6 @@ require_relative 'base'
 module VirustotalAPI
   # A class for '/analyses' API
   class Analysis < Base
-    attr_reader :report
-
-    # rubocop:disable Lint/MissingSuper
-    def initialize(report)
-      @report = report
-    end
-
     # @param [String] id The Virustotal ID to get the report for.
     # @param [String] api_key The key for virustotal
     # @return [VirustotalAPI::IP] Report
@@ -21,4 +14,3 @@ module VirustotalAPI
     end
   end
 end
-# rubocop:enable Lint/MissingSuper

data/lib/virustotal_api/base.rb

@@ -9,10 +9,12 @@ require 'base64'
 module VirustotalAPI
   # The base class implementing the raw calls to Virustotal API V3.
   class Base
-    attr_reader :report
+    attr_reader :report, :report_url, :id
 
     def initialize(report)
       @report = report
+      @report_url = report&.dig('data', 'links', 'self')
+      @id = report&.dig('data', 'id')
     end
 
     # @return [String] string of API URI class method

data/lib/virustotal_api/domain.rb

@@ -5,11 +5,6 @@ require_relative 'base'
 module VirustotalAPI
   # A class for '/domains' API
   class Domain < Base
-    # rubocop:disable Lint/UselessMethodDefinition
-    def initialize(report)
-      super(report)
-    end
-
     # Find a domain.
     #
     # @param [String] domain The domain to search
@@ -21,4 +16,3 @@ module VirustotalAPI
     end
   end
 end
-# rubocop:enable Lint/UselessMethodDefinition

data/lib/virustotal_api/file.rb

@@ -5,14 +5,6 @@ require_relative 'base'
 module VirustotalAPI
   # A class for '/files' API
   class File < Base
-    attr_reader :id, :report_url
-
-    def initialize(report)
-      super(report)
-      @id = report&.dig('data', 'id')
-      @report_url = report&.dig('data', 'links', 'self')
-    end
-
     # Find a hash.
     #
     # @param [String] resource file as a md5/sha1/sha256 hash

data/lib/virustotal_api/group.rb

@@ -5,14 +5,6 @@ require_relative 'base'
 module VirustotalAPI
   # A class for '/groups' API
   class Group < Base
-    attr_reader :report_url, :id
-
-    def initialize(report)
-      super(report)
-      @report_url = report&.dig('data', 'links', 'self')
-      @id = report&.dig('data', 'id')
-    end
-
     # Find a Group.
     #
     # @param [String] group_id to find

data/lib/virustotal_api/ip.rb

@@ -5,11 +5,6 @@ require_relative 'base'
 module VirustotalAPI
   # A class for '/ip_addresses' API
   class IP < Base
-    # rubocop:disable Lint/UselessMethodDefinition
-    def initialize(report)
-      super(report)
-    end
-
     # Find an IP.
     #
     # @param [String] ip address The IP to find.
@@ -21,4 +16,3 @@ module VirustotalAPI
     end
   end
 end
-# rubocop:enable Lint/UselessMethodDefinition

data/lib/virustotal_api/url.rb

@@ -5,14 +5,6 @@ require_relative 'base'
 module VirustotalAPI
   # A class for '/urls' API
   class URL < Base
-    attr_reader :report_url, :id
-
-    def initialize(report)
-      super(report)
-      @report_url = report&.dig('data', 'links', 'self')
-      @id = report&.dig('data', 'id')
-    end
-
     # Find a URL.
     #
     # @param [String] resource as an ip/domain/url

data/lib/virustotal_api/user.rb

@@ -5,14 +5,6 @@ require_relative 'base'
 module VirustotalAPI
   # A class for '/users' API
   class User < Base
-    attr_reader :report_url, :id
-
-    def initialize(report)
-      super(report)
-      @report_url = report&.dig('data', 'links', 'self')
-      @id = report&.dig('data', 'id')
-    end
-
     # Find a User.
     #
     # @param [String] user_key with id or api_key

data/lib/virustotal_api/version.rb

@@ -2,5 +2,5 @@
 
 module VirustotalAPI
   # The GEM version
-  VERSION = '0.5.2'
+  VERSION = '0.5.3'
 end

data/test/analysis_test.rb

@@ -11,13 +11,16 @@ class VirustotalAPIAnalysisTest < Minitest::Test
   def test_todo
     VCR.use_cassette('url_find') do
       vtreport = VirustotalAPI::URL.find(@url, @api_key)
+
       @id = vtreport.id
-      assert @id
+      assert @id.is_a?(String)
     end
 
     VCR.use_cassette('analysis') do
       analysis = VirustotalAPI::Analysis.find(@id, @api_key)
+
       assert analysis.exists?
+      assert analysis.id.is_a?(String)
     end
   end
 end

data/test/domain_test.rb

@@ -17,16 +17,11 @@ class VirustotalAPIDomainTest < Minitest::Test
       vtdomain_report = VirustotalAPI::Domain.find(@domain, @api_key)
 
       # Make sure that the JSON was parsed
+      assert vtdomain_report.exists?
       assert vtdomain_report.is_a?(VirustotalAPI::Domain)
       assert vtdomain_report.report.is_a?(Hash)
-    end
-  end
-
-  def test_exists?
-    VCR.use_cassette('domain') do
-      vtdomain_report = VirustotalAPI::Domain.find(@domain, @api_key)
-
-      assert vtdomain_report.exists?
+      assert vtdomain_report.id.is_a?(String)
+      assert vtdomain_report.report_url.is_a?(String)
     end
   end
 end

data/test/file_test.rb

@@ -4,9 +4,9 @@ require './test/test_helper'
 
 class VirustotalAPIFileTest < Minitest::Test
   def setup
-    @sha256 = '01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b'
+    @sha256    = '01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b'
     @file_path = File.expand_path('test/fixtures/null_file')
-    @api_key = 'testapikey'
+    @api_key   = 'testapikey'
   end
 
   def test_class_exists
@@ -15,57 +15,49 @@ class VirustotalAPIFileTest < Minitest::Test
 
   def test_report_response
     VCR.use_cassette('file_find') do
-      virustotal_report = VirustotalAPI::File.find(@sha256, @api_key)
+      vt_file_report = VirustotalAPI::File.find(@sha256, @api_key)
 
       # Make sure that the JSON was parsed
-      assert virustotal_report.is_a?(VirustotalAPI::File)
-      assert virustotal_report.report.is_a?(Hash)
+      assert vt_file_report.exists?
+      assert vt_file_report.is_a?(VirustotalAPI::File)
+      assert vt_file_report.report.is_a?(Hash)
+      assert vt_file_report.id.is_a?(String)
+      assert vt_file_report.report_url.is_a?(String)
     end
   end
 
   def test_find
-    permalink = 'https://www.virustotal.com/api/v3/files/' \
-                '01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b'
+    id        = '01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b'
+    permalink = "https://www.virustotal.com/api/v3/files/#{id}"
+
     VCR.use_cassette('file_find') do
-      virustotal_report = VirustotalAPI::File.find(@sha256, @api_key)
+      vt_file_report = VirustotalAPI::File.find(@sha256, @api_key)
 
-      assert virustotal_report.report_url.is_a?(String)
-      assert_equal permalink, virustotal_report.report_url
-      assert virustotal_report.detected_by('Avira')
-      assert !virustotal_report.detected_by('Acronis')
-      assert !virustotal_report.detected_by('Yeyeyeye') # not present in file
+      assert_equal permalink, vt_file_report.report_url
+      assert_equal id, vt_file_report.id
+      assert vt_file_report.detected_by('Avira')
+      assert !vt_file_report.detected_by('Acronis')
+      assert !vt_file_report.detected_by('Yeyeyeye') # not present in file
     end
   end
 
   def test_upload
     VCR.use_cassette('file_upload') do
-      virustotal_upload = VirustotalAPI::File.upload(@file_path, @api_key)
-
-      assert virustotal_upload.report.is_a?(Hash)
-    end
-  end
-
-  def test_upload_id
-    VCR.use_cassette('file_upload') do
-      virustotal_upload = VirustotalAPI::File.upload(@file_path, @api_key)
+      vt_file_upload = VirustotalAPI::File.upload(@file_path, @api_key)
 
-      assert virustotal_upload.id.is_a?(String)
+      assert vt_file_upload.exists?
+      assert vt_file_upload.report.is_a?(Hash)
+      assert vt_file_upload.id.is_a?(String)
     end
   end
 
   def test_analyse
     VCR.use_cassette('file_analyse') do
-      virustotal_analyse = VirustotalAPI::File.analyse(@sha256, @api_key)
-
-      assert virustotal_analyse.report.is_a?(Hash)
-    end
-  end
-
-  def test_analyse_id
-    VCR.use_cassette('file_analyse') do
-      virustotal_analyse = VirustotalAPI::File.analyse(@sha256, @api_key)
+      vt_file_analyse = VirustotalAPI::File.analyse(@sha256, @api_key)
 
-      assert virustotal_analyse.id.is_a?(String)
+      assert vt_file_analyse.exists?
+      assert vt_file_analyse.report.is_a?(Hash)
+      assert vt_file_analyse.id.is_a?(String)
     end
   end
 end

data/test/group_test.rb

@@ -17,15 +17,10 @@ class VirustotalAPIGroupReportTest < Minitest::Test
       vtgroup_report = VirustotalAPI::Group.find(@group_id, @api_key)
 
       # Make sure that the JSON was parsed
+      assert vtgroup_report.exists?
       assert vtgroup_report.is_a?(VirustotalAPI::Group)
       assert vtgroup_report.report.is_a?(Hash)
-    end
-  end
-
-  def test_find
-    VCR.use_cassette('group_find') do
-      vtgroup_report = VirustotalAPI::Group.find(@group_id, @api_key)
-
+      assert vtgroup_report.id.is_a?(String)
       assert vtgroup_report.report_url.is_a?(String)
     end
   end

data/test/ip_test.rb

@@ -19,6 +19,8 @@ class VirustotalAPIIPReportTest < Minitest::Test
       # Make sure that the JSON was parsed
       assert vtip_report.is_a?(VirustotalAPI::IP)
       assert vtip_report.report.is_a?(Hash)
+      assert vtip_report.id.is_a?(String)
+      assert vtip_report.report_url.is_a?(String)
     end
   end
 end

data/test/url_test.rb

@@ -18,24 +18,11 @@ class VirustotalAPIURLReportTest < Minitest::Test
       vturl_report = VirustotalAPI::URL.find(@url, @api_key)
 
       # Make sure that the JSON was parsed
+      assert vturl_report.exists?
       assert vturl_report.is_a?(VirustotalAPI::URL)
       assert vturl_report.report.is_a?(Hash)
-    end
-  end
-
-  def test_find
-    VCR.use_cassette('url_find') do
-      vturl_report = VirustotalAPI::URL.find(@url, @api_key)
-
-      assert vturl_report.report_url.is_a?(String)
-    end
-  end
-
-  def test_scan_url
-    VCR.use_cassette('url_find') do
-      vturl_report = VirustotalAPI::URL.find(@url, @api_key)
-
       assert vturl_report.id.is_a?(String)
+      assert vturl_report.report_url.is_a?(String)
     end
   end
 
@@ -43,23 +30,18 @@ class VirustotalAPIURLReportTest < Minitest::Test
     VCR.use_cassette('unscanned_url_find') do
       vturl_report = VirustotalAPI::URL.find(@unscanned_url, @api_key)
 
+      assert !vturl_report.exists?
       assert_empty vturl_report.report
     end
   end
 
   def test_analyse
     VCR.use_cassette('url_analyse') do
-      vturl_scan = VirustotalAPI::URL.analyse(@url, @api_key)
-
-      assert vturl_scan.report.is_a?(Hash)
-    end
-  end
-
-  def test_analyse_id
-    VCR.use_cassette('url_analyse') do
-      vturl_scan = VirustotalAPI::URL.analyse(@url, @api_key)
+      vturl_analyse = VirustotalAPI::URL.analyse(@url, @api_key)
 
-      assert vturl_scan.id.is_a?(String)
+      assert vturl_analyse.exists?
+      assert vturl_analyse.report.is_a?(Hash)
+      assert vturl_analyse.id.is_a?(String)
     end
   end
 end

data/test/user_test.rb

@@ -16,15 +16,10 @@ class VirustotalAPIUserReportTest < Minitest::Test
       vtuser_report = VirustotalAPI::User.find(@api_key, @api_key)
 
       # Make sure that the JSON was parsed
+      assert vtuser_report.exists?
       assert vtuser_report.is_a?(VirustotalAPI::User)
       assert vtuser_report.report.is_a?(Hash)
-    end
-  end
-
-  def test_find
-    VCR.use_cassette('user_find') do
-      vtuser_report = VirustotalAPI::User.find(@api_key, @api_key)
-
+      assert vtuser_report.id.is_a?(String)
       assert vtuser_report.report_url.is_a?(String)
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: virustotal_api
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 0.5.3
 platform: ruby
 authors:
 - pwelch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-08 00:00:00.000000000 Z
+date: 2020-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json