virustotal_api_compat 0.1.7

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 26974b4f566f04ab3d336ce1259c6f62579ddce0d590371594982fc2b5e1697f
+  data.tar.gz: ec88e2eb3da372f3626d287c3472ed2847ae084548fae814561573b9cbe4d717
+SHA512:
+  metadata.gz: dd66311620efe41b40febf3d41c2efe995844244584801750bd2e2ceccb8e635f9b46b351fbcc588840bed296036ddf3f2caf89ca7d0b6ca516f18764df4df9a
+  data.tar.gz: 452582322d9f5afa696745f02ef588d0bf74eaeaa2db1e8274edd2473c7d521c03bcf1f4337a7c66398770e8822995284bb15715bb387da90518c72f59dea3be

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/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/pull_request_template.md

@@ -0,0 +1,11 @@
+CHANGELOG: no-impact/Added/Changed/Deprecated/Removed/Fixed/Security
+
+## Summary
+
+## Testing
+
+1. _Describe how to test this change_
+
+## Other Information
+
+_Include screenshots, GIFs, and/or API responses as appropriate._

data/.github/workflows/ruby.yml

@@ -0,0 +1,46 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  Test-Ruby-2-7:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1.70.1
+      with:
+        ruby-version: 2.7
+    - name: Show Ruby Version
+      run: ruby --version
+    - name: Install dependencies
+      run: bundle install
+    - name: Lint
+      run: bundle exec rake rubocop
+    - name: Run tests
+      run: bundle exec rake
+      
+  Test-Ruby-3-0:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+      uses: ruby/setup-ruby@v1.70.1
+      with:
+        ruby-version: 3.0
+    - name: Show Ruby Version
+      run: ruby --version
+    - name: Install dependencies
+      run: bundle install
+    - name: Lint
+      run: bundle exec rake rubocop
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,18 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+.rake_tasks~
+.tool-versions
+*.gem
+.idea

data/.rubocop.yml

@@ -0,0 +1,39 @@
+# This is the configuration used to check the rubocop source code.
+
+AllCops:
+  NewCops: enable
+  Exclude:
+    - 'test/fixtures/*'
+
+Style/StringLiterals:
+  Enabled: true
+
+Style/RedundantPercentQ:
+  Enabled: true
+
+# Disabled Checks
+Style/Documentation:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Style/RegexpLiteral:
+  Enabled: false
+
+Lint/MissingCopEnableDirective:
+  Exclude:
+    - 'test/base_test.rb'
+
+Naming/MethodParameterName:
+  Exclude:
+    - 'lib/virustotal_api/ip_report.rb'
+
+Layout/LineLength:
+  Enabled: false
+
+Metrics/MethodLength:
+  Enabled: false
+
+Gemspec/RequiredRubyVersion:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,70 @@
+# VirusTotal API Changelog
+
+## [0.5.7] - 2021-09-20
+
+* Remove EOL Ruby 2.5
+
+## [0.5.6] - 2021-09-20
+
+* Use urlsafe base64 encoding
+* Fix changelog
+  * [@jonnynux](https://github.com/jonnynux)
+
+## [0.5.5] - 2021-05-10
+
+* Add support for larger files
+  * [@Grandman](https://github.com/Grandman)
+
+## [0.5.4] - 2020-12-10
+
+* Manage bad requests like not found
+* Use strict base64 encoding
+  * [@crondaemon](https://github.com/crondaemon)
+
+## [0.5.3] = 2020-10-12
+
+## [0.5.2] - 2020-10-06
+
+* Fix Fix exists? check
+* Fix detected_by for File
+* Fix RateLimitError
+* Added User and Group API
+  * [@jonnynux](https://github.com/jonnynux)
+
+## [0.5.1] - 2020-10-06
+
+* Downgrade ruby requirement to 2.5.
+  * [@crondaemon](https://github.com/crondaemon)
+
+## [0.5.0] - 2020-09-02
+
+* Full rework to support API V3 [#30](https://github.com/pwelch/virustotal_api/pull/30)
+  * [@crondaemon](https://github.com/crondaemon) & [@jonnynux](https://github.com/jonnynux)
+* Move to Ruby 2.6 for minimum Ruby version
+
+## [0.4.1] - 2019-09-04
+
+* Fixed Reponse Parsing
+  * [@jonnynux](https://github.com/jonnynux) 
+
+## [0.4.0] - 2019-07-23
+
+* Added ReScan [#15](https://github.com/pwelch/virustotal_api/pull/15)
+* Added URL Scan [#16](https://github.com/pwelch/virustotal_api/pull/16)
+  * [@jonnynux](https://github.com/jonnynux)
+  
+## [0.3.0] - 2018-03-31
+
+* Added optional scan param for url report API [#5](https://github.com/pwelch/virustotal_api/pull/5)
+  * [@mkunkel ](https://github.com/mkunkel)
+
+## [0.2.0] - 2015-12-19
+
+* Added Check if the respone is 204 [#2](https://github.com/pwelch/virustotal_api/pull/2)
+  * [@postmodern](https://github.com/postmodern)
+
+## [0.1.0] - 2014-12-26
+
+* First Release
+
+https://keepachangelog.com

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 pwelch
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,253 @@
+# VirustotalAPI
+
+This is a copy of virustotal_api to be made compatible with logstash dependencies and gemfile. (old json 1.8.6)
+
+Ruby Gem for [VirusTotal](https://www.virustotal.com) [V3 API](https://developers.virustotal.com/v3.0/reference).
+If you want the version 2, check out the gem versions up to [0.4.0](https://github.com/crondaemon/virustotal_api/tree/v0.4.0).
+
+![Ruby](https://github.com/pwelch/virustotal_api/workflows/Ruby/badge.svg)
+
+[![Gem Version](https://badge.fury.io/rb/virustotal_api.svg)](http://badge.fury.io/rb/virustotal_api)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'virustotal_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install virustotal_api
+
+## 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 Find
+
+```ruby
+require 'virustotal_api'
+
+sha256  = '01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b'
+api_key = 'MY_API_KEY'
+
+vtreport = VirustotalAPI::File.find(sha256, api_key)
+
+# Does the resource have any results?
+vtreport.exists?
+# => true
+
+# URL for File Report (if it exists)
+vtreport.report_url
+# => "https://www.virustotal.com/api/v3/files/01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b"
+
+# Report results (if they exist) are available via #report
+vtreport.report['data']['attributes']['last_analysis_results']['ClamAV']
+# => {"category"=>"undetected", "engine_name"=>"ClamAV", "engine_update"=>"20200826",
+# "engine_version"=>"0.102.4.0", "method"=>"blacklist", "result"=>nil}
+
+# Check whether an Antivirus detected this sample or not
+vtreport.detected_by('ClamAV')
+# => false
+```
+
+### File Upload
+
+```ruby
+require 'virustotal_api'
+
+file    = '/path/to/file'
+api_key = 'MY_API_KEY'
+
+# for upload file
+vtscan = VirustotalAPI::File.upload(file, api_key)
+# or large file (more than 32MB)
+vtscan = VirustotalAPI::File.upload_large(file, api_key)
+
+# Virustotal ID of file
+vtscan.id
+# => "01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b-1419454668"
+
+# Response results are available via #response
+vtscan.report
+# =>
+{"data"=>
+  {"id"=>"MTkxNDBmMjU4ZGY1OGZiYzZjNmU2ODcyMWNhYjhkZTM6MTU5ODUzMTE5OQ==",
+   "type"=>"analysis"}}
+```
+
+### File Analyse
+
+```ruby
+require 'virustotal_api'
+
+sha256  = '01ba4719c80b6fe911b091a7c05124b64eeece964e09c058ef8f9805daca546b'
+api_key = 'MY_API_KEY'
+
+vtrescan = VirustotalAPI::File.analyse(sha256, api_key)
+
+# Virustotal ID of file
+vtrescan.id
+# => "MTkxNDBmMjU4ZGY1OGZiYzZjNmU2ODcyMWNhYjhkZTM6MTU5ODUzMTE5OQ=="
+
+# Response results are available via #response
+vtrescan.report
+# =>
+{"data"=>
+  {"id"=>"MTkxNDBmMjU4ZGY1OGZiYzZjNmU2ODcyMWNhYjhkZTM6MTU5ODUzMTE5OQ==",
+   "type"=>"analysis"}}
+```
+
+### URL find
+
+```ruby
+require 'virustotal_api'
+
+url     = 'http://www.google.com'
+api_key = 'MY_API_KEY'
+
+vturl_report = VirustotalAPI::URL.find(url, api_key)
+
+# Does the resource have any results?
+vturl_report.exists?
+# => true
+
+# URL for Report (if it exists)
+vturl_report.report_url
+# => "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']
+# => {"category"=>"harmless", "engine_name"=>"Avira", "method"=>"blacklist", "result"=>"clean"}
+```
+
+### URL Upload
+
+```ruby
+require 'virustotal_api'
+
+url     = 'http://www.google.com'
+api_key = 'MY_API_KEY'
+
+vturl_scan = VirustotalAPI::URL.upload(url, api_key)
+
+# Virustotal ID of file
+vturl_scan.id
+# => "u-dd014af5ed6b38d9130e3f466f850e46d21b951199d53a18ef29ee9341614eaf-1598531929"
+
+# Response results are available via #response
+vturl_scan.report
+# =>
+{"data"=>
+  {"id"=>
+    "u-dd014af5ed6b38d9130e3f466f850e46d21b951199d53a18ef29ee9341614eaf-1598531929",
+   "type"=>"analysis"}}
+```
+
+### IP Find
+
+```ruby
+require 'virustotal_api'
+
+ip      = '8.8.8.8'
+api_key = 'MY_API_KEY'
+
+vtip_report = VirustotalAPI::IP.find(ip, api_key)
+
+# Does the resource have any results?
+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
+```
+
+### Domain Find
+
+```ruby
+require 'virustotal_api'
+
+domain  = 'virustotal.com'
+api_key = 'MY_API_KEY'
+
+vtdomain_report = VirustotalAPI::Domain.find(domain, api_key)
+
+# Does the resource have any results?
+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
+```
+
+### User Find
+
+```ruby
+require 'virustotal_api'
+
+user_key  = 'user_key' # user_id or api_key
+api_key = 'MY_API_KEY'
+
+vtuser_report = VirustotalAPI::User.find(user_key, api_key)
+
+# Does the resource have any results?
+vtuser_report.exists?
+# => true
+
+# Report results (if they exist) are available via #report
+vtuser_report.report
+# => Hash of report results
+```
+
+### Group Find
+
+```ruby
+require 'virustotal_api'
+
+group_id  = 'GROUP_id'
+api_key = 'MY_API_KEY'
+
+vtgroup_report = VirustotalAPI::Group.find(group_id, api_key)
+
+# Does the resource have any results?
+vtgroup_report.exists?
+# => true
+
+# Report results (if they exist) are available via #report
+vtgroup_report.report
+# => Hash of report results
+```
+
+## Contributors
+
+- [@jonnynux](https://github.com/jonnynux)
+- [@crondaemon](https://github.com/crondaemon/)
+- [@postmodern](https://github.com/postmodern)
+- [@mkunkel](https://github.com/mkunkel)
+- [@Grandman](https://github.com/Grandman)
+
+## 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/Rakefile

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+
+Rake::TestTask.new do |t|
+  t.libs       = ['lib']
+  t.warning    = true
+  t.verbose    = true
+  t.test_files = FileList['test/*_test.rb']
+end
+
+RuboCop::RakeTask.new
+
+require 'yard'
+YARD::Rake::YardocTask.new
+namespace :yard do
+  desc 'Run the YARD server'
+  task :start do
+    sh 'bundle exec yard server --reload'
+  end
+end
+
+task default: :test

data/lib/virustotal_api/analysis.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require_relative 'base'
+
+module VirustotalAPI
+  # A class for '/analyses' API
+  class Analysis < Base
+    # @param [String] id The Virustotal ID to get the report for.
+    # @param [String] api_key The key for virustotal
+    # @return [VirustotalAPI::IP] Report
+    def self.find(id, api_key)
+      report = perform("/analyses/#{id}", api_key)
+      new(report)
+    end
+  end
+end