vt_api 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 054fff89e1df6de6fcc9d8810d34a6ec8f96fb3e
+  data.tar.gz: 07a4e81bad492af92a4186aba30d3083de477f77
+SHA512:
+  metadata.gz: 862429bae5fd52abb14e755c379ed72be1233632d9153bf491f6f71fbf56916ca4d4ab7de8014cfe2ef438f7b710530ba5bda1f18db7871b5e1ca96955fd4921
+  data.tar.gz: 36d82bbb40e0a0403b96427bd103b683f27a503de9485e487d3de5261af87b9c3df6274d357acf0cf3398494d773db2e1909fb3035a85ad60e34d2ea9f3ea6d7

data/.gitignore

@@ -0,0 +1,9 @@
+/.idea/
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

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

data/.yardopts

@@ -0,0 +1 @@
+--verbose --no-private lib/**/*.rb - README.md LICENSE.md

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in vt_api.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,28 @@
+PATH
+  remote: .
+  specs:
+    vt_api (0.1.1)
+      faraday (~> 0.15)
+      mimemagic (~> 0.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    mimemagic (0.3.3)
+    multipart-post (2.0.0)
+    rake (10.5.0)
+    yard (0.9.18)
+
+PLATFORMS
+  x64-mingw32
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  rake (~> 10.0)
+  vt_api!
+  yard (~> 0.9)
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.md

@@ -0,0 +1,170 @@
+Apache License
+==============
+
+_Version 2.0, January 2004_  
+_&lt;<http://www.apache.org/licenses/>&gt;_
+
+### Terms and Conditions for use, reproduction, and distribution
+
+#### 1. Definitions
+
+“License” shall mean the terms and conditions for use, reproduction, and
+distribution as defined by Sections 1 through 9 of this document.
+
+“Licensor” shall mean the copyright owner or entity authorized by the copyright
+owner that is granting the License.
+
+“Legal Entity” shall mean the union of the acting entity and all other entities
+that control, are controlled by, or are under common control with that entity.
+For the purposes of this definition, “control” means **(i)** the power, direct or
+indirect, to cause the direction or management of such entity, whether by
+contract or otherwise, or **(ii)** ownership of fifty percent (50%) or more of the
+outstanding shares, or **(iii)** beneficial ownership of such entity.
+
+“You” (or “Your”) shall mean an individual or Legal Entity exercising
+permissions granted by this License.
+
+“Source” form shall mean the preferred form for making modifications, including
+but not limited to software source code, documentation source, and configuration
+files.
+
+“Object” form shall mean any form resulting from mechanical transformation or
+translation of a Source form, including but not limited to compiled object code,
+generated documentation, and conversions to other media types.
+
+“Work” shall mean the work of authorship, whether in Source or Object form, made
+available under the License, as indicated by a copyright notice that is included
+in or attached to the work (an example is provided in the Appendix below).
+
+“Derivative Works” shall mean any work, whether in Source or Object form, that
+is based on (or derived from) the Work and for which the editorial revisions,
+annotations, elaborations, or other modifications represent, as a whole, an
+original work of authorship. For the purposes of this License, Derivative Works
+shall not include works that remain separable from, or merely link (or bind by
+name) to the interfaces of, the Work and Derivative Works thereof.
+
+“Contribution” shall mean any work of authorship, including the original version
+of the Work and any modifications or additions to that Work or Derivative Works
+thereof, that is intentionally submitted to Licensor for inclusion in the Work
+by the copyright owner or by an individual or Legal Entity authorized to submit
+on behalf of the copyright owner. For the purposes of this definition,
+“submitted” means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems, and
+issue tracking systems that are managed by, or on behalf of, the Licensor for
+the purpose of discussing and improving the Work, but excluding communication
+that is conspicuously marked or otherwise designated in writing by the copyright
+owner as “Not a Contribution.”
+
+“Contributor” shall mean Licensor and any individual or Legal Entity on behalf
+of whom a Contribution has been received by Licensor and subsequently
+incorporated within the Work.
+
+#### 2. Grant of Copyright License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the Work and such
+Derivative Works in Source or Object form.
+
+#### 3. Grant of Patent License
+
+Subject to the terms and conditions of this License, each Contributor hereby
+grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free,
+irrevocable (except as stated in this section) patent license to make, have
+made, use, offer to sell, sell, import, and otherwise transfer the Work, where
+such license applies only to those patent claims licensable by such Contributor
+that are necessarily infringed by their Contribution(s) alone or by combination
+of their Contribution(s) with the Work to which such Contribution(s) was
+submitted. If You institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work or a
+Contribution incorporated within the Work constitutes direct or contributory
+patent infringement, then any patent licenses granted to You under this License
+for that Work shall terminate as of the date such litigation is filed.
+
+#### 4. Redistribution
+
+You may reproduce and distribute copies of the Work or Derivative Works thereof
+in any medium, with or without modifications, and in Source or Object form,
+provided that You meet the following conditions:
+
+* **(a)** You must give any other recipients of the Work or Derivative Works a copy of
+this License; and
+* **(b)** You must cause any modified files to carry prominent notices stating that You
+changed the files; and
+* **(c)** You must retain, in the Source form of any Derivative Works that You distribute,
+all copyright, patent, trademark, and attribution notices from the Source form
+of the Work, excluding those notices that do not pertain to any part of the
+Derivative Works; and
+* **(d)** If the Work includes a “NOTICE” text file as part of its distribution, then any
+Derivative Works that You distribute must include a readable copy of the
+attribution notices contained within such NOTICE file, excluding those notices
+that do not pertain to any part of the Derivative Works, in at least one of the
+following places: within a NOTICE text file distributed as part of the
+Derivative Works; within the Source form or documentation, if provided along
+with the Derivative Works; or, within a display generated by the Derivative
+Works, if and wherever such third-party notices normally appear. The contents of
+the NOTICE file are for informational purposes only and do not modify the
+License. You may add Your own attribution notices within Derivative Works that
+You distribute, alongside or as an addendum to the NOTICE text from the Work,
+provided that such additional attribution notices cannot be construed as
+modifying the License.
+
+You may add Your own copyright statement to Your modifications and may provide
+additional or different license terms and conditions for use, reproduction, or
+distribution of Your modifications, or for any such Derivative Works as a whole,
+provided Your use, reproduction, and distribution of the Work otherwise complies
+with the conditions stated in this License.
+
+#### 5. Submission of Contributions
+
+Unless You explicitly state otherwise, any Contribution intentionally submitted
+for inclusion in the Work by You to the Licensor shall be under the terms and
+conditions of this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify the terms of
+any separate license agreement you may have executed with Licensor regarding
+such Contributions.
+
+#### 6. Trademarks
+
+This License does not grant permission to use the trade names, trademarks,
+service marks, or product names of the Licensor, except as required for
+reasonable and customary use in describing the origin of the Work and
+reproducing the content of the NOTICE file.
+
+#### 7. Disclaimer of Warranty
+
+Unless required by applicable law or agreed to in writing, Licensor provides the
+Work (and each Contributor provides its Contributions) on an “AS IS” BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied,
+including, without limitation, any warranties or conditions of TITLE,
+NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are
+solely responsible for determining the appropriateness of using or
+redistributing the Work and assume any risks associated with Your exercise of
+permissions under this License.
+
+#### 8. Limitation of Liability
+
+In no event and under no legal theory, whether in tort (including negligence),
+contract, or otherwise, unless required by applicable law (such as deliberate
+and grossly negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special, incidental,
+or consequential damages of any character arising as a result of this License or
+out of the use or inability to use the Work (including but not limited to
+damages for loss of goodwill, work stoppage, computer failure or malfunction, or
+any and all other commercial damages or losses), even if such Contributor has
+been advised of the possibility of such damages.
+
+#### 9. Accepting Warranty or Additional Liability
+
+While redistributing the Work or Derivative Works thereof, You may choose to
+offer, and charge a fee for, acceptance of support, warranty, indemnity, or
+other liability obligations and/or rights consistent with this License. However,
+in accepting such obligations, You may act only on Your own behalf and on Your
+sole responsibility, not on behalf of any other Contributor, and only if You
+agree to indemnify, defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason of your
+accepting any such warranty or additional liability.
+
+_END OF TERMS AND CONDITIONS_

data/README.md

@@ -0,0 +1,61 @@
+> __DISCLAIMER__: Tests for this project are not complete yet, coming soon!
+
+# VtApi - VirusTotal API implementation
+
+[![Gem Version](https://badge.fury.io/rb/vt_api.svg)](https://badge.fury.io/rb/vt_api)
+
+VtApi is a Ruby binding to fresh VirusTotal 2.0 API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vt_api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vt_api
+
+## Supported API versions
+
+* [VirusTotal Public API 2.0](https://developers.virustotal.com/v2.0/reference#public-vs-private-api)
+
+More versions (i.e. VT Private API) are on the way.
+
+## Usage
+
+Basic usage:
+
+```ruby
+require 'vt_api'
+
+VtApi.token = 'YOUR_TOKEN'
+
+file = VtApi::ApiV2::File.report resource: 'fca0b14b72c426a67f06a771c9e2d67e6883972e' # => #<VtApi::ApiV2::File ...>
+scans = file.scans # => [#<VtApi::ApiV2::File::AvResult ...>, ...]  
+
+scan_id = VtApi::ApiV2::File.schedule_scan file: 'foobar.txt' # => "92605f5aa57e20475a893cd63d998ffdafca8b1c6142fca225ea5638a2437fe6-2139190"
+
+url = VtApi::ApiV2::URL.report resource: 'https://bitbucket.org/kkremen/vt_api' # => #<VtApi::ApiV2::URL ...>
+
+comments = VtApi::ApiV2::Comments.get resource: 'fca0b14b72c426a67f06a771c9e2d67e6883972e' # => [#<VtApi::ApiV2::Comments::Comment ...>, ...]
+comments = VtApi::ApiV2::Comments.put resource: 'fca0b14b72c426a67f06a771c9e2d67e6883972e', text: 'Lorem ipsum dolor sit amet...' # => true
+```
+You can change HTTP adapter by using ```VtApi.configure```:
+
+```ruby
+VtApi.configure do |opts|
+    opts.token = 'YOUR_TOKEN'
+    opts.adapter = :net_http # see Faraday gem for more adapters.
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [Apache 2.0 Public License](http://www.apache.org/licenses/LICENSE-2.0).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+# require "rake/testtask"
+
+# Rake::TestTask.new(:test) do |t|
+#   t.libs << "test"
+#   t.libs << "lib"
+#   t.test_files = FileList["test/**/*_test.rb"]
+# end
+#
+# task :default => :test

data/lib/vt_api/api/config.rb

@@ -0,0 +1,33 @@
+require 'ostruct'
+
+module VtApi
+	# Default options for VT API, common for all versions
+	DEFAULT_OPTIONS = OpenStruct.new(
+		token:   nil,
+		adapter: :net_http
+	)
+
+	# Get current options
+	#
+	# @return [OpenStruct]
+	def self.options
+		@options ||= DEFAULT_OPTIONS
+	end
+
+	# Configure VtApi.
+	#
+	# @yield [opts] Configuration block.
+	# @yieldparam opts Options object.
+	# @return [Object] Block result.
+	def self.configure
+		yield options
+	end
+
+	# Set VtApi token (apikey).
+	#
+	# @param [String] token
+	# @return [String] Token.
+	def self.token=(token)
+		options[:token] = token
+	end
+end

data/lib/vt_api/api/v2/comments.rb

@@ -0,0 +1,59 @@
+module VtApi
+	module ApiV2
+		# VT API 2.0 for comments
+		module Comments
+			# Representation of a comment
+			class Comment
+				attr_reader :text, :date_token, :date
+
+				# Creates new Comment object from API data.
+				# It is not recommended to use this directly.
+				# Refer to API methods instead.
+				#
+				# @see Comments.get
+				# @see Comments.put
+				#
+				# @param [String] date_token Date token as present in API (can be used in <code>Comments.get</code>).
+				# @param [String] text Comment text
+				def initialize(date_token, text)
+					@date_token = date_token
+					@date       = DateTime.parse date_token
+					@text       = text
+				end
+			end
+
+			# @see https://developers.virustotal.com/v2.0/reference#comments-get
+			# @see Comment#date_token
+			#
+			# @param [String] resource
+			# @param [String] before Must be in format of <code>date_token</code>. Refer to API docs for more info.
+			# @return [Array<Comment>] Array of parsed comments.
+			def self.get(resource:, before:)
+				resp = ApiV2.provider.request 'comments.get', apikey: VtApi.options.token, resource: resource, before: before
+
+				parse_comments resp
+			end
+
+			# @see https://developers.virustotal.com/v2.0/reference#comments-put
+			#
+			# @param [String] resource
+			# @param [String] text Comment text string.
+			# @return [Boolean] True if comment put successfully ('response_code' equals 1), false otherwise.
+			def self.put(resource:, text:)
+				resp = ApiV2.provider.request 'comments.put', apikey: VtApi.options.token, resource: resource, text: text
+
+				resp.response_code == 1
+			end
+
+			private
+
+			def self.parse_comments(api_resp)
+				if api_resp.response_code.nil? or api_resp.response_code != 1
+					[]
+				else
+					api_resp.comments.map {|comment| Comment.new comment.date, comment.text}
+				end
+			end
+		end
+	end
+end

data/lib/vt_api/api/v2/file.rb

@@ -0,0 +1,156 @@
+require 'date'
+require 'pathname'
+
+require 'faraday/upload_io'
+require 'mimemagic'
+
+require_relative '../config'
+require_relative '../../internal/api_provider'
+require_relative '../v2'
+
+module VtApi
+	module ApiV2
+		# Class that represents VT Public API 2.0 for files.
+		class File
+
+			# Representation of particular AV result on file.
+			class AvResult
+				attr_reader :av_name, :triggered, :version, :threat_name, :update
+
+				# noinspection RubyResolve
+				def initialize(av_name, scan_obj)
+					@av_name     = av_name
+					@triggered   = scan_obj.detected
+					@version     = scan_obj.version
+					@threat_name = scan_obj.result
+					@update      = scan_obj.update
+				end
+			end
+
+			# Existing ID types
+			# @see #id
+			ID_TYPES = %w(scan_id resource_id md5 sha1 sha256)
+
+			class << self
+				# @see https://developers.virustotal.com/v2.0/reference#file-report
+				#
+				# @param [String] resource
+				# @return [File] File report if present, <code>nil</code> otherwise.
+				def report(resource:)
+					resp = ApiV2.provider.request 'file.report', apikey: VtApi.options.token, resource: resource
+					from_response resp
+				end
+
+				# @see https://developers.virustotal.com/v2.0/reference#file-rescan
+				#
+				# @param [String] resource
+				# @return [String] Scan ID.
+				def schedule_rescan(resource:)
+					resp = ApiV2.provider.request 'file.rescan', apikey: VtApi.options.token, resource: resource
+					resp.scan_id
+				end
+
+				# @see https://developers.virustotal.com/v2.0/reference#file-scan
+				#
+				# @param [String|Pathname|UploadIO] file
+				# @return [String] Scan ID.
+				def schedule_scan(file:)
+					if file.kind_of? String or file.kind_of? Pathname
+						file = file_to_io file
+					end
+
+					resp = ApiV2.provider.request 'file.scan', apikey: VtApi.options.token, file: file
+					resp.scan_id
+				end
+
+				private
+
+				def file_to_io(file)
+					file = ::File.realpath file
+					file = ::File.absolute_path file
+
+					mime = MimeMagic.by_path file
+
+					UploadIO.new file, mime
+				end
+			end
+
+			# Shorthand for #initialize.
+			#
+			# @see #initialize
+			def self.from_response(api_resp)
+				if api_resp.response_code.nil? or api_resp.response_code < 1
+					nil
+				else
+					report = self.new api_resp
+
+					report
+				end
+			end
+
+			attr_reader :scan_date, :permalink, :scans, :scan_count, :trigger_count
+
+			# Initializes new object from VT API response.
+			# @note Direct creation of object cas cause errors since it doesn't contain any validity checks. Use predefined API method bindings instead.
+			#
+			# @see .report
+			# @see .schedule_scan
+			# @see .schedule_rescan
+			#
+			# @param [OpenStruct] api_resp
+			def initialize(api_resp)
+				load_ids! api_resp
+				load_meta! api_resp
+				load_scans! api_resp
+			end
+
+			# @return [Fixnum]
+			def threat_level
+				@trigger_count.to_f / @scan_count
+			end
+
+			# Get file identifier.
+			# Since VT API offers many ways to identify the file, you can supply ID type to get specific file.
+			#
+			# @see ID_TYPES
+			#
+			# @param [Symbol|String] type
+			# @return [String] ID string of specified type.
+			def id(type = :id)
+				unless ID_TYPES.include? type.to_sym
+					raise ArgumentError, "There is no such id type (#{type}) in VT API 2.0"
+				end
+
+				@ids[type.to_sym]
+			end
+
+			private
+
+			# noinspection RubyResolve
+			def load_ids!(api_resp)
+				@ids = OpenStruct.new ({
+					scan_id:     api_resp.scan_id,
+					md5:         api_resp.md5,
+					sha1:        api_resp.sha1,
+					sha256:      api_resp.sha256,
+					resource_id: api_resp.resource
+				})
+			end
+
+			def load_meta!(api_resp)
+				@scan_date = DateTime.parse(api_resp.scan_date)
+				@permalink = URI(api_resp.permalink)
+			end
+
+			# noinspection RubyResolve
+			def load_scans!(api_resp)
+				@scan_count    = api_resp.total
+				@trigger_count = api_resp.positives
+
+				@scans = api_resp.scans.to_h.to_a.map do |key, value|
+					[key, AvResult.new(key.to_s, value)]
+				end.to_h
+			end
+		end
+	end
+end

data/lib/vt_api/api/v2/url.rb

@@ -0,0 +1,78 @@
+module VtApi
+	module ApiV2
+		# Class that represents URL scan report.
+		class URL
+			class << self
+
+				# @see https://developers.virustotal.com/v2.0/reference#url-report
+				#
+				# @param [String] resource
+				# @param [Boolean] scan Shedule URL scan if it is not present in system.
+				# @return [URL] URL report object is present, <code>nil</code> otherwise.
+				def report(resource:, scan: false)
+					resp = ApiV2.provider.request 'url.report', apikey: VtApi.options.token, resource: resource, schedule_scan: (scan ? 1 : 0)
+					pp resp
+					from_response resp
+				end
+
+				# @see https://developers.virustotal.com/v2.0/reference#url-scan
+				#
+				# @param [String] url
+				# @return [String] Scheduled scan ID.
+				def schedule_scan(url:)
+					resp = ApiV2.provider.request 'url.report', apikey: VtApi.options.token, url: url
+					resp.scan_id
+				end
+
+			end
+
+			# Shorthand for #initialize.
+			#
+			# @see #initialize
+			def self.from_response(api_resp)
+				if api_resp.response_code.nil? or api_resp.response_code < 1
+					nil
+				else
+					report = self.new api_resp
+					report
+				end
+			end
+
+			attr_reader :id, :url, :scan_date, :permalink, :filescan_id
+
+			# Initializes new object from VT API response.
+			# @note Direct creation of object cas cause errors since it doesn't contain any validity checks. Use predefined API method bindings instead.
+			#
+			# @see .report
+			# @see .schedule_scan
+			#
+			# @param [OpenStruct] api_resp
+			def initialize(api_resp)
+				load_id!(api_resp)
+				load_meta!(api_resp)
+				load_scans!(api_resp)
+			end
+
+			private
+
+			# noinspection RubyResolve
+			def load_scans!(api_resp)
+				@scan_count    = api_resp.total
+				@trigger_count = api_resp.positives
+				@scans         = api_resp.scans
+			end
+
+			def load_meta!(api_resp)
+				@scan_date   = api_resp.scan_date
+				@permalink   = api_resp.permalink
+				@filescan_id = api_resp.filescan_id
+			end
+
+			# noinspection RubyResolve
+			def load_id!(api_resp)
+				@id  = api_resp.scan_id
+				@url = api_resp.url
+			end
+		end
+	end
+end

data/lib/vt_api/api/v2.rb

@@ -0,0 +1,15 @@
+require_relative 'config'
+require_relative 'v2/file'
+require_relative 'v2/url'
+
+module VtApi
+	module ApiV2
+
+		# Get ApiProvider singleton configured for VT Public API 2.0.
+		#
+		# @return [ApiProvider]
+		def self.provider
+			@provider ||= ApiProvider.new Versions::API_V2, VtApi.options.adapter
+		end
+	end
+end

data/lib/vt_api/api.rb

@@ -0,0 +1,2 @@
+require_relative 'api/config'
+require_relative 'api/v2'

data/lib/vt_api/internal/api_provider.rb

@@ -0,0 +1,65 @@
+require 'faraday'
+
+require 'json'
+require 'ostruct'
+
+require_relative 'versions/default'
+require_relative '../../vt_api'
+
+module VtApi
+	# API intercation class.
+	#
+	# Uses [Faraday] for HTTP interaction.
+	class ApiProvider
+
+		# Create new ApiProvider.
+		#
+		# @param [ApiVersion] api_version API interface to use.
+		# @param [Object] adapter Faraday HTTP adapter.
+		# @return [Object]
+		def initialize(api_version = Versions::DEFAULT, adapter = :net_http)
+			unless api_version.kind_of? ApiVersion
+				raise ArgumentError, "Invalid API interface supplied! Must be subclass of 'ApiVersion', got #{api_version.class} instead"
+			end
+
+			@api        = api_version
+			@connection = Faraday.new @api.base_url do |conn|
+				conn.request :multipart
+				conn.request :url_encoded
+
+				conn.adapter adapter
+			end
+		end
+
+		# Performs a request to given API method.
+		# Requested method must be described in API interface.
+		#
+		# @raise [UndefinedMethodError]
+		# @raise [MissingParametersError]
+		# @raise [ApiError]
+		#
+		# @param [String] method_name
+		# @param [Hash] params
+		# @return [OpenStruct] Method result object.
+		def request(method_name, params = {})
+			unless @api.endpoint? method_name
+				raise UndefinedMethodError, "Endpoint '#{method_name}' not found in '#{@api.version}' API interface."
+			end
+
+			endpoint = @api.endpoint method_name
+
+			unless endpoint.params_valid? (params)
+				raise MissingParametersError, "Missed parameters #{endpoint.missing_params(params).to_s} required by endpoint '#{method_name}'."
+			end
+
+			result = @connection.public_send(endpoint.method, endpoint.uri, params, {})
+
+			if @api.error? result.status
+				raise ApiError, "#{@api.version} error: #{@api.error(result.status)}"
+			end
+
+			# noinspection RubyResolve
+			JSON.parse result.body, object_class: OpenStruct
+		end
+	end
+end

data/lib/vt_api/internal/api_version.rb

@@ -0,0 +1,51 @@
+module VtApi
+
+	# @abstract Base class for API interfaces.
+	class ApiVersion
+		# Get API base URL.
+		#
+		# @return [String]
+		def base_url
+			''
+		end
+
+		# API interface name/version.
+		# 
+		# @return [String]
+		def version
+			nil
+		end
+
+		# Get API HTTP-code description.
+		# 
+		# @param [Integer] http_code
+		# @return [String] Error description.
+		def error(http_code)
+			nil
+		end
+
+		# Check whether API HTTP-code means error.
+		#
+		# @param [Integer] http_code
+		# @return [Boolean] Error description.
+		def error?(http_code)
+			false
+		end
+
+		# Get API method endpoint interface.
+		#
+		# @param [String] method API method name to be called.
+		# @return [VtApi::Endpoint]
+		def endpoint(method)
+			nil
+		end
+
+		# Check whether given method is defined in interface.
+		#
+		# @param [String] method Method name.
+		# @return [Boolean]
+		def endpoint?(method)
+			false
+		end
+	end
+end

data/lib/vt_api/internal/endpoint.rb

@@ -0,0 +1,69 @@
+require 'faraday/connection'
+
+module VtApi
+	# API endpoint interface class.
+	class Endpoint
+		attr_accessor :uri, :method
+
+		# Initialize new endpoint.
+		#
+		# Interface parameters are described as in example below.
+		# @example
+		#   {
+		#       foo: true, # this describes required parameter
+		#       bar: false # this describes a parameter that can be omitted
+		#   }
+		#
+		# @param [Object] uri Relative URL of the endpoint.
+		# @param [Object] method HTTP method to be used for the endpoint.
+		# @param [Object] params Endpoint parameters interface.
+		def initialize(uri, method, params = {})
+			@uri    = uri
+			@method = method
+			@params = params
+		end
+
+
+		# Check whether given parameters match endpoint interface.
+		#
+		# @param [Hash] passed_params
+		# @return [Boolean]
+		def params_valid?(passed_params)
+			@params.each do |param, required|
+				if required and passed_params[param].nil?
+					return false
+				end
+			end
+
+			true
+		end
+
+		# Get a list of missing parameters.
+		#
+		# @param [Hash] passed_params
+		# @return [Array]
+		def missing_params(passed_params)
+			missing = []
+
+			@params.each do |param, required|
+				if required and passed_params[param].nil?
+					missing << param
+				end
+			end
+
+			missing
+		end
+
+		private
+
+		# Remove redundant slashes from URL.
+		# @example
+		#   clean_url 'http://google.com////search' # => 'http://google.com/search'
+		#
+		# @param [String] uri
+		# @return [String]
+		def clean_uri(uri)
+			uri.gsub %r{([^:])[\/]+}, '\1/'
+		end
+	end
+end

data/lib/vt_api/internal/versions/api_v2.rb

@@ -0,0 +1,130 @@
+require_relative '../api_version'
+require_relative '../endpoint'
+
+module VtApi
+	module Versions
+
+		# VirusTotal Public API 2.0 singleton interface.
+		# Describes all available API methods (endpoints).
+		class ApiV2 < ApiVersion
+
+			# Root URI for all endpoints.
+			BASE_URI = 'https://virustotal.com/vtapi/v2/'
+
+			# VirusTotal Public API v2.0 interface description.
+			ENDPOINTS = {
+				'file.report':       Endpoint.new('file/report', :get, {
+					apikey:   true,
+					resource: true
+				}),
+				'file.scan':         Endpoint.new('file/scan', :post, {
+					apikey: true,
+					file:   true
+				}),
+				'file.rescan':       Endpoint.new('file/rescan', :post, {
+					apikey:   true,
+					resource: true
+				}),
+				'url.report':        Endpoint.new('url/report', :get, {
+					apikey:        true,
+					resource:      true,
+					schedule_scan: false
+				}),
+				'url.scan':          Endpoint.new('url/scan', :post, {
+					apikey: true,
+					url:    true
+				}),
+				'domain.report':     Endpoint.new('domain/report', :get, {
+					apikey: true,
+					domain: true
+				}),
+				'ip-address.report': Endpoint.new('ip-address/report', :get, {
+					apikey: true,
+					domain: true
+				}),
+				'comments.get':      Endpoint.new('comments/get', :get, {
+					apikey:   true,
+					resource: true,
+					before:   false
+				}),
+				'comments.put':      Endpoint.new('comments/put', :post, {
+					apikey:   true,
+					resource: true,
+					comment:  true
+				}),
+			}
+
+			# List of possible HTTP error codes with descriptions
+			ERRORS = {
+				204 => "Request rate limit exceeded.",
+				400 => "Invalid arguments.",
+				403 => "Access denied.",
+				404 => "Endpoint not found."
+			}
+
+			class << self
+				# Get interface instance.
+				#
+				# @return [VtApi::Versions::ApiV2]
+				def instance
+					@instance ||= self.new
+				end
+			end
+
+			# Get API method endpoint interface.
+			#
+			# @param [String] method API method name to be called.
+			# @return [VtApi::Endpoint]
+			def endpoint(method)
+				ENDPOINTS[method.to_sym] unless ENDPOINTS[method.to_sym].nil?
+			end
+
+			# Check whether given method is defined in interface.
+			#
+			# @param [String] method Method name.
+			# @return [Boolean]
+			def endpoint?(method)
+				not endpoint(method).nil?
+			end
+
+			# Get API HTTP-code description.
+			#
+			# @param [Integer] http_code
+			# @return [String] Error description.
+			def error(http_code)
+				ERRORS[http_code] unless ERRORS[http_code].nil?
+			end
+
+			# Check whether API HTTP-code means error.
+			#
+			# @param [Integer] http_code
+			# @return [Boolean] Error description.
+			def error?(http_code)
+				not error(http_code).nil?
+			end
+
+			# Get API base URL.
+			#
+			# @return [String]
+			def base_url
+				BASE_URI
+			end
+
+			# API interface name/version.
+			#
+			# @return [String]
+			def version
+				'VTAPI-2.0'
+			end
+
+			private
+
+			# Locked constructor.
+			def initialize
+			end
+		end
+
+		# Shorthand for <code>ApiV2.instance</code>
+		API_V2 = ApiV2.instance
+	end
+end

data/lib/vt_api/internal/versions/default.rb

@@ -0,0 +1,11 @@
+require_relative 'api_v2'
+
+module VtApi
+	module Versions
+
+		# Default API version used by ApiProvider
+		#
+		# @see VtApi::ApiProvider
+		DEFAULT = API_V2
+	end
+end

data/lib/vt_api/internal/versions.rb

@@ -0,0 +1,2 @@
+require_relative 'versions/api_v2'
+require_relative 'versions/default'

data/lib/vt_api/internal.rb

@@ -0,0 +1,4 @@
+require_relative 'internal/api_provider'
+require_relative 'internal/api_version'
+require_relative 'internal/endpoint'
+require_relative 'internal/versions'

data/lib/vt_api/version.rb

@@ -0,0 +1,3 @@
+module VtApi
+	VERSION = "0.1.2"
+end

data/lib/vt_api.rb

@@ -0,0 +1,28 @@
+require_relative 'vt_api/version'
+require_relative 'vt_api/internal'
+require_relative 'vt_api/api'
+
+module VtApi
+
+	# Error is thrown when some of required request params are missing
+	#
+	# @see Endpoint#params_valid
+	# @see ApiProvider#request
+	class MissingParametersError < ArgumentError
+	end
+
+	# Error is thrown when requested method could not be found in interface.
+	#
+	# @see ApiVersion#endpoint?
+	# @see ApiProvider#request
+	class UndefinedMethodError < NoMethodError
+	end
+
+	# Error is thrown when API returns HTTP code marked by interface as error.
+	#
+	# @see ApiVersion#error?
+	# @see ApiVersion#error
+	# @see ApiProvider#request
+	class ApiError < RuntimeError
+	end
+end

data/vt_api.gemspec

@@ -0,0 +1,45 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'vt_api/version'
+
+Gem::Specification.new do |spec|
+	spec.name    = 'vt_api'
+	spec.version = VtApi::VERSION
+	spec.authors = [%{Karl 'Charon' Meinkopf}]
+	spec.email   = ['kremen.karl@yandex.com']
+
+	spec.summary     = %{VirusTotal API bindings for Ruby}
+	spec.description = %{}
+	spec.homepage    = 'http://example.com/'
+	spec.license     = ''
+
+	if spec.respond_to?(:metadata)
+		spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+
+		spec.metadata['homepage_uri']    = spec.homepage
+		spec.metadata['source_code_uri'] = 'http://example.com/'
+		spec.metadata['changelog_uri']   = 'http://example.com'
+	else
+		raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+	end
+
+	spec.files = []
+
+	Dir.chdir(File.expand_path('..', __FILE__)) do
+		spec.files += `git ls-files -z`.split(0.chr).reject {|f| f.match(%r{^(test|spec|features)/})}
+	end
+
+
+	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 'rake', '~> 10.0'
+	spec.add_development_dependency 'yard', '~> 0.9'
+	# spec.add_development_dependency 'rspec', '~> 3.8'
+	# spec.add_development_dependency 'pry', '~> 0.12'
+	# spec.add_development_dependency 'webmock', '~> 3.5'
+	spec.add_dependency 'faraday', '~> 0.15'
+	spec.add_dependency 'mimemagic', '~> 0.3'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: vt_api
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Karl 'Charon' Meinkopf
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-03-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.15'
+- !ruby/object:Gem::Dependency
+  name: mimemagic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.3'
+description: ''
+email:
+- kremen.karl@yandex.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- ".yardopts"
+- Gemfile
+- Gemfile.lock
+- LICENSE.md
+- README.md
+- Rakefile
+- lib/vt_api.rb
+- lib/vt_api/api.rb
+- lib/vt_api/api/config.rb
+- lib/vt_api/api/v2.rb
+- lib/vt_api/api/v2/comments.rb
+- lib/vt_api/api/v2/file.rb
+- lib/vt_api/api/v2/url.rb
+- lib/vt_api/internal.rb
+- lib/vt_api/internal/api_provider.rb
+- lib/vt_api/internal/api_version.rb
+- lib/vt_api/internal/endpoint.rb
+- lib/vt_api/internal/versions.rb
+- lib/vt_api/internal/versions/api_v2.rb
+- lib/vt_api/internal/versions/default.rb
+- lib/vt_api/version.rb
+- vt_api.gemspec
+homepage: http://example.com/
+licenses:
+- ''
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: http://example.com/
+  source_code_uri: http://example.com/
+  changelog_uri: http://example.com
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14.1
+signing_key: 
+specification_version: 4
+summary: VirusTotal API bindings for Ruby
+test_files: []