virustotalx 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f014d99e8a184fa94a9f2d696209672867c2d437c83bf094b49346078887b077
-  data.tar.gz: 0ff81e8a4a61b7283a8d54fe329127d602b07847f8a62ca70f7aa4112b6a6187
+  metadata.gz: 29c0a2908fdf7c04604adbdf13e22e34883b71ccfa2ccdb803067a835d7feb47
+  data.tar.gz: 2c13fbcdcdc79cb3489825760fb62560693bb715191e75dd165c55d25e96ab89
 SHA512:
-  metadata.gz: c957e719c7a2f9be34493128a95369f5a0bd0f0a534570f9466c70af1cec243daba9198b516cc21af576bd3f5d31b01a65dc017cd6a946663c6d9f3009906d04
-  data.tar.gz: a0497c176fc774a95193452590226f9887792aed9a42a1e144859b0db99684195c75d1e6ca8eb5de833a00a72b506b86f88bf347f621ea3f84b865c4960ef4e5
+  metadata.gz: 22ae1e88179b146f4ae4569899567f01525228f2605143301c89f7d070fd8d2354d5db7c1c763d9a71cc6bafd78c30532851f9c97e718015feec74b8420307a4
+  data.tar.gz: 282f86c261ccfea33d66287d8d5e08c8d2efc2be7d9a1d4c7d91c14986492307ded9d8aa149522f17e328a402e8d08a474edefe5ac18adcd5695d15fe0b65c67

data/.github/workflows/test.yml

@@ -0,0 +1,26 @@
+name: Ruby CI
+
+on: [pull_request]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [2.7, '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - name: Build and test with Rake
+      run: |
+        gem install bundler
+        bundle install
+        bundle exec rake

data/.overcommit.yml

@@ -0,0 +1,9 @@
+PreCommit:
+  BundleCheck:
+    enabled: true
+
+  RuboCop:
+    enabled: true
+    required_executable: bundle
+    command: ["bundle", "exec", "standardrb"]
+    on_warn: fail

data/.standard.yml

@@ -0,0 +1,4 @@
+ignore:
+  - "**/*":
+      - Layout/SpaceInsideHashLiteralBraces
+      - Style/RescueStandardError

data/README.md

@@ -1,7 +1,7 @@
 # virustotalx
 
 [![Gem Version](https://badge.fury.io/rb/virustotalx.svg)](https://badge.fury.io/rb/virustotalx)
-[![Build Status](https://travis-ci.org/ninoseki/virustotalx.svg?branch=master)](https://travis-ci.org/ninoseki/virustotalx)
+[![Ruby CI](https://github.com/ninoseki/virustotalx/actions/workflows/test.yml/badge.svg)](https://github.com/ninoseki/virustotalx/actions/workflows/test.yml)
 [![Coverage Status](https://coveralls.io/repos/github/ninoseki/virustotalx/badge.svg?branch=master)](https://coveralls.io/github/ninoseki/virustotalx?branch=master)
 [![CodeFactor](https://www.codefactor.io/repository/github/ninoseki/virustotalx/badge)](https://www.codefactor.io/repository/github/ninoseki/virustotalx)
 
@@ -44,7 +44,7 @@ api.ip_address.get("1.1.1.1")
 ### Files
 
 | HTTP Method | URL                                | API method                                                 |
-| ----------- | ---------------------------------- | ---------------------------------------------------------- |
+|-------------|------------------------------------|------------------------------------------------------------|
 | POST        | /files                             | api.file.upload(filepath)                                  |
 | GET         | /files/upload_url                  | api.file.upload_url                                        |
 | GET         | /files/{id}                        | api.file.get(id)                                           |
@@ -62,7 +62,7 @@ api.ip_address.get("1.1.1.1")
 ### URLs
 
 | HTTP Method | URL                         | API method                                                     |
-| ----------- | --------------------------- | -------------------------------------------------------------- |
+|-------------|-----------------------------|----------------------------------------------------------------|
 | POST        | /urls                       | N/A                                                            |
 | GET         | /urls/{id}                  | api.url.get(id)                                                |
 | POST        | /urls/{id}/analyse          | api.url.analyse(id)                                            |
@@ -78,7 +78,7 @@ Note: you can use a URL as an id.
 ### Domains
 
 | HTTP Method | URL                              | API method                                                   |
-| ----------- | -------------------------------- | ------------------------------------------------------------ |
+|-------------|----------------------------------|--------------------------------------------------------------|
 | GET         | /domains/{domain}                | api.domain.get(domain)                                       |
 | GET         | /domains/{domain}/comments       | api.domain.comment(domain)                                   |
 | POST        | /domains/{domain}/comments       | api.domain.add_comment(domain, text)                         |
@@ -87,7 +87,7 @@ Note: you can use a URL as an id.
 ### IP addresses
 
 | HTTP Method | URL                               | API method                                                                      |
-| ----------- | --------------------------------- | ------------------------------------------------------------------------------- |
+|-------------|-----------------------------------|---------------------------------------------------------------------------------|
 | GET         | /ip_addresses/{ip}                | api.ip_address.get(ip)                                                          |
 | GET         | /ip_addresses/{ip}/comments       | api.ip_address.comments(id)                                                     |
 | POST        | /ip_addresses/{ip}/comments       | api.ip_address.add_comment(id, text)                                            |
@@ -96,13 +96,13 @@ Note: you can use a URL as an id.
 ### Analyses
 
 | HTTP Method | URL            | API method           |
-| ----------- | -------------- | -------------------- |
+|-------------|----------------|----------------------|
 | GET         | /analyses/{id} | api.analysis.get(ip) |
 
 ## Graphs
 
 | HTTP Method | URL                                                  | API method                                                                          |
-| ----------- | ---------------------------------------------------- | ----------------------------------------------------------------------------------- |
+|-------------|------------------------------------------------------|-------------------------------------------------------------------------------------|
 | GET         | graphs                                               | api.graph.search(filter: nil, limit: nil, cursor: nil, order: nil, attributes: nil) |
 | POST        | graphs                                               | api.graph.create(\*\*params)                                                        |
 | GET         | graphs/{id}                                          | api.graph.get(id)                                                                   |
@@ -117,6 +117,12 @@ Note: you can use a URL as an id.
 | DELETE      | graphs/{id}/relationships/editors/{user_or_group_id} | api.graph.delete_editor(id, user_or_group_id)                                       |
 | GET         | graphs/{id}/relationships/{relationship}             | api.graph.`relationship`(id)                                                        |
 
+## Intelligence
+
+| HTTP Method | URL                 | API method                                                                                 |
+|-------------|---------------------|--------------------------------------------------------------------------------------------|
+| GET         | intelligence/search | api.intelligence.search(query, order: nil, limit: nil, cursor: nil, descriptors_only: nil) |
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -3,4 +3,4 @@ require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/lib/virustotal/api.rb

@@ -69,5 +69,14 @@ module VirusTotal
     def graph
       @graph ||= Client::Graph.new(key: key)
     end
+
+    #
+    # Intelligence API endpoint client
+    #
+    # @return [VirusTotal::Client::Intelligence]
+    #
+    def intelligence
+      @intelligence ||= Client::Intelligence.new(key: key)
+    end
   end
 end

data/lib/virustotal/clients/base.rb

@@ -16,8 +16,9 @@ module VirusTotal
         domain: "domains",
         file: "files",
         graph: "graphs",
+        intelligence: "intelligence",
         ipaddress: "ip_addresses",
-        url: "urls",
+        url: "urls"
       }.freeze
 
       attr_reader :key
@@ -38,7 +39,8 @@ module VirusTotal
       end
 
       def https_options
-        if proxy = ENV["HTTPS_PROXY"] || ENV["https_proxy"]
+        proxy = ENV["HTTPS_PROXY"] || ENV["https_proxy"]
+        if proxy
           uri = URI(proxy)
           {
             proxy_address: uri.hostname,
@@ -55,13 +57,13 @@ module VirusTotal
         code = code.to_s.to_sym
 
         table = {
-          "400": BadRequestError,
-          "401": AuthenticationRequiredError,
-          "403": ForbiddenError,
-          "404": NotFoundError,
-          "409": AlreadyExistsError,
-          "429": QuotaExceededError,
-          "503": TransientError,
+          '400': BadRequestError,
+          '401': AuthenticationRequiredError,
+          '403': ForbiddenError,
+          '404': NotFoundError,
+          '409': AlreadyExistsError,
+          '429': QuotaExceededError,
+          '503': TransientError
         }
         raise Error, "Unsupported response code returned: #{code} - #{message}" unless table.key?(code)
 
@@ -78,7 +80,7 @@ module VirusTotal
           code = response.code.to_i
           body = response.body
           json = JSON.parse(body) if response["Content-Type"].to_s.include?("application/json")
-          message = json ? json.dig("message") : body
+          message = json ? json["message"] : body
 
           case code
           when 200
@@ -114,7 +116,7 @@ module VirusTotal
         post = Net::HTTP::Post.new(url_for(path))
 
         data = [
-          ["file", file, { "filename": filename }],
+          ["file", file, { filename: filename }]
         ]
         post.set_form(data, "multipart/form-data")
 

data/lib/virustotal/clients/domain.rb

@@ -10,7 +10,7 @@ module VirusTotal
       private
 
       def relationships
-        @relationships ||= %w(
+        @relationships ||= %w[
           communicating_files
           downloaded_files
           graphs
@@ -19,7 +19,7 @@ module VirusTotal
           resolutions
           siblings
           urls
-        ).map(&:to_sym)
+        ].map(&:to_sym)
       end
     end
   end

data/lib/virustotal/clients/file.rb

@@ -89,7 +89,7 @@ module VirusTotal
       private
 
       def relationships
-        @relationships ||= %w(
+        @relationships ||= %w[
           analyses
           behaviours
           bundled_files
@@ -112,7 +112,7 @@ module VirusTotal
           submissions
           screenshots
           votes
-        ).map(&:to_sym)
+        ].map(&:to_sym)
       end
     end
   end

data/lib/virustotal/clients/graph.rb

@@ -4,6 +4,7 @@ module VirusTotal
   module Client
     class Graph < Base
       include Action::Get
+      include Action::Relationships
 
       #
       # Return graphs.
@@ -181,14 +182,14 @@ module VirusTotal
       private
 
       def relationships
-        @relationships ||= %w(
+        @relationships ||= %w[
           comments
           items
           viewers
           editors
           owner
           group
-        ).map(&:to_sym)
+        ].map(&:to_sym)
       end
     end
   end

data/lib/virustotal/clients/intelligence.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module VirusTotal
+  module Client
+    class Intelligence < Base
+      #
+      # Intelligense search
+      #
+      # @param [String] query Search query
+      # @param [String, nil] order Sort order
+      # @param [Integer, nil] limit Maximum number of results
+      # @param [String, nil] cursor Continuation cursor
+      # @param [Boolean, nil] descriptors_only Whether to return full object information or just object descriptors
+      #
+      # @return [Hash]
+      #
+      def search(query, order: nil, limit: nil, cursor: nil, descriptors_only: nil)
+        params = {
+          query: query,
+          order: order,
+          limit: limit,
+          cursor: cursor,
+          descriptors_only: descriptors_only
+        }.compact
+
+        _get("/#{name}/search", params) { |json| json }
+      end
+    end
+  end
+end

data/lib/virustotal/clients/ip_address.rb

@@ -10,7 +10,7 @@ module VirusTotal
       private
 
       def relationships
-        @relationships ||= %w(
+        @relationships ||= %w[
           communicating_files
           downloaded_files
           graphs
@@ -18,7 +18,7 @@ module VirusTotal
           referrer_files
           resolutions
           urls
-        ).map(&:to_sym)
+        ].map(&:to_sym)
       end
     end
   end

data/lib/virustotal/clients/url.rb

@@ -45,14 +45,14 @@ module VirusTotal
       end
 
       def relationships
-        @relationships ||= %w(
+        @relationships ||= %w[
           analyses
           downloaded_files
           graphs
           last_serving_ip_address
           redirecting_urls
           submissions
-        ).map(&:to_sym)
+        ].map(&:to_sym)
       end
     end
   end

data/lib/virustotal/errors.rb

@@ -4,15 +4,26 @@ module VirusTotal
   class Error < StandardError; end
 
   class AlreadyExistsError < Error; end
+
   class AuthenticationRequiredError < Error; end
+
   class BadRequestError < Error; end
+
   class ForbiddenError < Error; end
+
   class InvalidArgumentError < Error; end
+
   class NotFoundError < Error; end
+
   class QuotaExceededError < Error; end
+
   class RateLimitError < Error; end
+
   class TooManyRequestsError < Error; end
+
   class TransientError < Error; end
+
   class UserNotActiveError < Error; end
+
   class WrongCredentialsError < Error; end
 end

data/lib/virustotal/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module VirusTotal
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/virustotal.rb

@@ -17,8 +17,8 @@ require "virustotal/clients/analysis"
 require "virustotal/clients/domain"
 require "virustotal/clients/file"
 require "virustotal/clients/graph"
+require "virustotal/clients/intelligence"
 require "virustotal/clients/ip_address"
 require "virustotal/clients/url"
 
-module VirusTotal
-end
+module VirusTotal; end

data/renovate.json

@@ -0,0 +1,5 @@
+{
+  "extends": [
+    "config:base"
+  ]
+}

data/virustotalx.gemspec

@@ -1,33 +1,35 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "virustotal/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "virustotalx"
-  spec.version       = VirusTotal::VERSION
-  spec.authors       = ["Manabu Niseki"]
-  spec.email         = ["manabu.niseki@gmail.com"]
+  spec.name = "virustotalx"
+  spec.version = VirusTotal::VERSION
+  spec.authors = ["Manabu Niseki"]
+  spec.email = ["manabu.niseki@gmail.com"]
 
-  spec.summary       = "Yet another VirusTotal API wrapper for Ruby"
-  spec.description   = "Yet another VirusTotal API wrapper for Ruby"
-  spec.homepage      = "https://github.com/ninoseki/virustotalx"
-  spec.license       = "MIT"
+  spec.summary = "Yet another VirusTotal API wrapper for Ruby"
+  spec.description = "Yet another VirusTotal API wrapper for Ruby"
+  spec.homepage = "https://github.com/ninoseki/virustotalx"
+  spec.license = "MIT"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path(__dir__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "coveralls", "~> 0.8"
+  spec.add_development_dependency "bundler", "~> 2.2"
+  spec.add_development_dependency "coveralls_reborn", "~> 0.23"
+  spec.add_development_dependency "overcommit", "~> 0.58"
   spec.add_development_dependency "rake", "~> 13.0"
-  spec.add_development_dependency "rspec", "~> 3.9"
-  spec.add_development_dependency "vcr", "~> 5.0"
-  spec.add_development_dependency "webmock", "~> 3.7"
+  spec.add_development_dependency "rspec", "~> 3.10"
+  spec.add_development_dependency "standard", "~> 1.3"
+  spec.add_development_dependency "vcr", "~> 6.0"
+  spec.add_development_dependency "webmock", "~> 3.14"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: virustotalx
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Manabu Niseki
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-10-19 00:00:00.000000000 Z
+date: 2021-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.23'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0.23'
+- !ruby/object:Gem::Dependency
+  name: overcommit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.58'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -58,42 +72,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '3.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.10'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.9'
+        version: '1.3'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '6.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '3.14'
 description: Yet another VirusTotal API wrapper for Ruby
 email:
 - manabu.niseki@gmail.com
@@ -101,9 +129,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/test.yml"
 - ".gitignore"
+- ".overcommit.yml"
 - ".rspec"
-- ".travis.yml"
+- ".standard.yml"
 - Gemfile
 - LICENSE
 - README.md
@@ -121,17 +151,19 @@ files:
 - lib/virustotal/clients/domain.rb
 - lib/virustotal/clients/file.rb
 - lib/virustotal/clients/graph.rb
+- lib/virustotal/clients/intelligence.rb
 - lib/virustotal/clients/ip_address.rb
 - lib/virustotal/clients/url.rb
 - lib/virustotal/errors.rb
 - lib/virustotal/version.rb
 - lib/virustotalx.rb
+- renovate.json
 - virustotalx.gemspec
 homepage: https://github.com/ninoseki/virustotalx
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -146,8 +178,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.22
+signing_key:
 specification_version: 4
 summary: Yet another VirusTotal API wrapper for Ruby
 test_files: []

data/.travis.yml

@@ -1,7 +0,0 @@
----
-sudo: false
-language: ruby
-cache: bundler
-rvm:
-  - 2.6.1
-before_install: gem install bundler -v 2.0.1