virustotal_api 0.4.1 → 0.5.4

data/.circleci/config.yml

@@ -1,23 +0,0 @@
-version: 2
-jobs:
-  test:
-    docker:
-      - image: circleci/ruby:2.5.3-stretch
-    steps:
-      - checkout
-      - run: 
-          name: Setup
-          command: |
-            gem update bundler
-            bundle install
-      - run: 
-          name: Rubocop
-          command: bundle exec rake rubocop
-      - run:
-          name: Run Tests
-          command: bundle exec rake test
-workflows:
-  version: 2
-  test:
-    jobs:
-      - test

data/.github/workflows/gem_publish.yml

@@ -1,38 +0,0 @@
-name: Ruby Gem
-
-on: release
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-
-    steps:
-    - uses: actions/checkout@master
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        version: 2.6.x
-
-    - name: Publish to GPR
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:github: Bearer ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push --KEY github --host https://rubygems.pkg.github.com/${OWNER} *.gem
-      env:
-        GEM_HOST_API_KEY: ${{secrets.GITHUB_TOKEN}}
-        OWNER: username
-
-    - name: Publish to RubyGems
-      run: |
-        mkdir -p $HOME/.gem
-        touch $HOME/.gem/credentials
-        chmod 0600 $HOME/.gem/credentials
-        printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-        gem build *.gemspec
-        gem push *.gem
-      env:
-        GEM_HOST_API_KEY: ${{secrets.RUBYGEMS_AUTH_TOKEN}}

data/lib/virustotal_api/domain_report.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module VirustotalAPI
-  class DomainReport < Base
-    attr_reader :report
-
-    def initialize(report)
-      @report = report
-    end
-
-    # @param [String] domain
-    # @param [String] api_key for virustotal
-    # @return [VirustotalAPI::IPReport] Report Search Result
-    def self.find(domain, api_key)
-      response = RestClient.get(
-        api_uri + '/domain/report',
-        { params: params(domain, api_key) }
-      )
-      report = parse(response)
-
-      new(report)
-    end
-
-    # @param [String] domain
-    # @param [String] api_key virustotal
-    # @return [Hash] params for GET Request
-    def self.params(domain, api_key)
-      {
-        domain: domain,
-        apikey: api_key
-      }
-    end
-  end
-end

data/lib/virustotal_api/file_report.rb

@@ -1,37 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module VirustotalAPI
-  class FileReport < Base
-    attr_reader :report, :report_url
-
-    def initialize(report)
-      @report     = report
-      @report_url = report.fetch('permalink') { nil }
-    end
-
-    # @param [String] resource file as a md5/sha1/sha256 hash
-    # @param [String] api_key for virustotal
-    # @return [VirustotalAPI::FileReport] Report Search Result
-    def self.find(resource, api_key)
-      response = RestClient.post(
-        api_uri + '/file/report',
-        params(resource, api_key)
-      )
-      report = parse(response)
-
-      new(report)
-    end
-
-    # @param [String] resource file as a md5/sha1/sha256 hash
-    # @param [String] api_key for virustotal
-    # @return [Hash] params for POST Request
-    def self.params(resource, api_key)
-      {
-        resource: resource,
-        apikey: api_key
-      }
-    end
-  end
-end

data/lib/virustotal_api/file_rescan.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module VirustotalAPI
-  class FileRescan < Base
-    attr_reader :report, :rescan_id
-
-    def initialize(report)
-      @report    = report
-      @rescan_id = @report.fetch('scan_id') { nil }
-    end
-
-    # @param [String] resource file as a md5/sha1/sha256 hash
-    # @param [String] api_key for virustotal
-    # @return [VirustotalAPI::FileRescan] Report
-    def self.rescan(resource, api_key)
-      response = RestClient.post(
-        api_uri + '/file/rescan',
-        apikey: api_key,
-        resource: resource
-      )
-      report = parse(response)
-
-      new(report)
-    end
-
-    # @return [Boolean] if file was queued
-    # 0 => not_present, 1 => exists, -2 => queued_for_analysis
-    def queued_for_analysis?
-      response_code = @report.fetch('response_code') { nil }
-
-      response_code == -2
-    end
-  end
-end

data/lib/virustotal_api/file_scan.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module VirustotalAPI
-  class FileScan < Base
-    attr_reader :report, :scan_id
-
-    def initialize(report)
-      @report  = report
-      @scan_id = @report.fetch('scan_id') { nil }
-    end
-
-    # @param [String] file_path for file to be sent for scan
-    # @param [String] api_key for virustotal
-    # @param [Hash] opts hash for additional options
-    # @return [VirusotalAPI::FileScan] Report
-    def self.scan(file_path, api_key, opts = {})
-      response = RestClient.post(
-        api_uri + '/file/scan',
-        apikey: api_key,
-        filename: opts.fetch('filename') { File.basename(file_path) },
-        file: File.open(file_path, 'r')
-      )
-      report = parse(response)
-
-      new(report)
-    end
-
-    # @return [Boolean] if file was queued
-    # 0 => not_present, 1 => exists, -2 => queued_for_analysis
-    def queued_for_analysis?
-      response_code = @report.fetch('response_code') { nil }
-
-      response_code == -2
-    end
-  end
-end

data/lib/virustotal_api/ip_report.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module VirustotalAPI
-  class IPReport < Base
-    attr_reader :report
-
-    def initialize(report)
-      @report = report
-    end
-
-    # @param [String] ip address IPv4 format
-    # @param [String] api_key for virustotal
-    # @return [VirustotalAPI::IPReport] Report Search Result
-    def self.find(ip, api_key)
-      response = RestClient.get(
-        api_uri + '/ip-address/report',
-        { params: params(ip, api_key) }
-      )
-      report = parse(response)
-
-      new(report)
-    end
-
-    # @param [String] ip address IPv4 format
-    # @param [String] api_key for virustotal
-    # @return [Hash] params for GET Request
-    def self.params(ip, api_key)
-      {
-        ip: ip,
-        apikey: api_key
-      }
-    end
-  end
-end

data/lib/virustotal_api/url_report.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module VirustotalAPI
-  class URLReport < Base
-    attr_reader :report, :report_url, :scan_id
-
-    def initialize(report)
-      @report     = report
-      @report_url = report.fetch('permalink') { nil }
-      @scan_id    = report.fetch('scan_id') { nil }
-    end
-
-    # @param [String] resource as an ip/domain/url
-    # @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, scan = 0)
-      response = RestClient.post(
-        api_uri + '/url/report',
-        params(resource, api_key, scan)
-      )
-      report = parse(response)
-
-      new(report)
-    end
-
-    # @param [String] resource as an ip/domain/url
-    # @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, scan = 0)
-      {
-        resource: resource,
-        apikey: api_key,
-        scan: scan.to_s
-      }
-    end
-  end
-end

data/lib/virustotal_api/url_scan.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base'
-
-module VirustotalAPI
-  class URLScan < Base
-    attr_reader :report, :scan_id
-
-    def initialize(report)
-      @report  = report
-      @scan_id = @report.fetch('scan_id') { nil }
-    end
-
-    # @param [String] url
-    # @param [String] api_key for virustotal
-    # @return [VirustotalAPI::URLScan] Report
-    def self.scan(url, api_key)
-      response = RestClient.post(
-        api_uri + '/url/scan',
-        apikey: api_key,
-        url: url
-      )
-      report = parse(response)
-
-      new(report)
-    end
-
-    # @return [Boolean] if file was queued
-    # 0 => not_present, 1 => exists, -2 => queued_for_analysis
-    def queued_for_analysis?
-      response_code = @report.fetch('response_code') { nil }
-
-      response_code == -2
-    end
-  end
-end

data/test/domain_report_test.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require './test/test_helper'
-
-class VirustotalAPIDomainReportTest < Minitest::Test
-  def setup
-    @domain  = 'virustotal.com'
-    @api_key = 'testapikey'
-  end
-
-  def test_class_exists
-    assert VirustotalAPI::DomainReport
-  end
-
-  def test_report_response
-    VCR.use_cassette('domain_report') do
-      vtdomain_report = VirustotalAPI::DomainReport.find(@domain, @api_key)
-
-      # Make sure that the JSON was parsed
-      assert vtdomain_report.is_a?(VirustotalAPI::DomainReport)
-      assert vtdomain_report.report.is_a?(Hash)
-    end
-  end
-
-  def test_exists?
-    VCR.use_cassette('domain_report') do
-      vtdomain_report = VirustotalAPI::DomainReport.find(@domain, @api_key)
-
-      assert vtdomain_report.exists?, true
-    end
-  end
-end

data/test/file_report_test.rb

@@ -1,36 +0,0 @@
-# frozen_string_literal: true
-
-require './test/test_helper'
-
-class VirustotalAPIFileReportTest < Minitest::Test
-  # rubocop:disable LineLength
-  def setup
-    @sha256  = '01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b'
-    @api_key = 'testapikey'
-  end
-
-  def test_class_exists
-    assert VirustotalAPI::FileReport
-  end
-
-  def test_report_response
-    VCR.use_cassette('report') do
-      virustotal_report = VirustotalAPI::FileReport.find(@sha256, @api_key)
-
-      # Make sure that the JSON was parsed
-      assert virustotal_report.is_a?(VirustotalAPI::FileReport)
-      assert virustotal_report.report.is_a?(Hash)
-    end
-  end
-
-  def test_report_url
-    permalink = 'https://www.virustotal.com/file/01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b/analysis/1418032127/'
-    VCR.use_cassette('report') do
-      virustotal_report = VirustotalAPI::FileReport.find(@sha256, @api_key)
-
-      assert virustotal_report.report_url.is_a?(String)
-      assert virustotal_report.report_url, permalink
-    end
-  end
-  # rubocop:enable LineLength
-end

data/test/file_rescan_test.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-require './test/test_helper'
-
-class VirustotalAPIFileRescanTest < Minitest::Test
-  # rubocop:disable LineLength
-  def setup
-    @sha256  = '01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b'
-    @api_key = 'testapikey'
-  end
-
-  def test_class_exists
-    assert VirustotalAPI::FileRescan
-  end
-
-  def test_rescan_response
-    VCR.use_cassette('rescan') do
-      virustotal_rescan = VirustotalAPI::FileRescan.rescan(@sha256, @api_key)
-
-      assert virustotal_rescan.report.is_a?(Hash)
-    end
-  end
-
-  def test_rescan_id
-    VCR.use_cassette('rescan') do
-      virustotal_rescan = VirustotalAPI::FileRescan.rescan(@sha256, @api_key)
-
-      assert virustotal_rescan.rescan_id.is_a?(String)
-    end
-  end
-  # rubocop:enable LineLength
-end

data/test/file_scan_test.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require './test/test_helper'
-
-class VirustotalAPIFileScanTest < Minitest::Test
-  def setup
-    @file_path = File.expand_path('test/fixtures/null_file')
-    @api_key   = 'testapikey'
-  end
-
-  def test_class_exists
-    assert VirustotalAPI::FileScan
-  end
-
-  def test_response
-    VCR.use_cassette('scan') do
-      virustotal_scan = VirustotalAPI::FileScan.scan(@file_path, @api_key)
-
-      assert virustotal_scan.report.is_a?(Hash)
-    end
-  end
-
-  def test_scan_id
-    VCR.use_cassette('scan') do
-      virustotal_scan = VirustotalAPI::FileScan.scan(@file_path, @api_key)
-
-      assert virustotal_scan.scan_id.is_a?(String)
-    end
-  end
-end