vt_api 0.1.2.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fac819e622e3c60efbc2cc60426057ace6ca7ff542a68845b820b56f0e2b1f32
-  data.tar.gz: c78d660d99542a49c1a79fd2dbb522c8d71f1129aba89bcdfb053a9567944049
+  metadata.gz: d38c571162ab68a4e9546da48dca0278826a563176aba99a4a6b08bb9fa07f5b
+  data.tar.gz: b96cc897788cbf83b84e37b5ad5822c2ada1dc5d3c6b3e820a4747345822c126
 SHA512:
-  metadata.gz: c17f98ff6d6a3f4a4e9334b3af161fe41b9f6ee730ca0f93b9bc2fff222094c10297aaddccf6bb65e9fbe21e79433f848b62d68205eecf0c52b42c2768a57e1b
-  data.tar.gz: f57d8bb5307fc6e5a6824354553f0961d9406fedd5237f731154c064da63177b2df63d67a33f1f4e2ba2b30ed365eb853ce8dc99dd036f37e2c0f1366f1adede
+  metadata.gz: 43e6919c0215b9d988889365d9812e86964613aacd21b056d89cb2351aa6d10881ec15cdebab89b2ab45a0dd8da861e923f4737418ae6b422f655a1fcda9b19a
+  data.tar.gz: 5ac6d587584b22e2a408986aecf9400950fd44112b7d3162d217718069c216fb5d6b27768c62b3fc4b76f8356e5850255b02ae628398978ece63f046d4591553

data/.rubocop.yml

@@ -0,0 +1,13 @@
+---
+
+Layout/Tab:
+  Enabled: false
+
+Layout/IndentationWidth:
+  Width: 1
+
+Metrics/LineLength:
+  Max: 120
+
+Layout/AlignHash:
+  EnforcedColonStyle: table

data/.scrutinizer.yml

@@ -0,0 +1,16 @@
+checks:
+  ruby: true
+build:
+  nodes:
+    analysis:
+      tests:
+        override:
+          - ruby-scrutinizer-run
+          - command: rubocop-run
+            use_website_config: true
+      environment:
+        ruby:
+          version: 2.5.1
+filter:
+  excluded_paths:
+    - 'spec/*'

data/Gemfile

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

data/Gemfile.lock

@@ -1,28 +1,71 @@
 PATH
   remote: .
   specs:
-    vt_api (0.1.1)
+    vt_api (0.1.3)
       faraday (~> 0.15)
       mimemagic (~> 0.3)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.3)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
+    hashdiff (0.3.8)
     mimemagic (0.3.3)
     multipart-post (2.0.0)
+    mustermann (1.0.3)
+    public_suffix (3.0.3)
+    rack (2.0.6)
+    rack-protection (2.0.5)
+      rack
     rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    safe_yaml (1.0.5)
+    sinatra (2.0.5)
+      mustermann (~> 1.0)
+      rack (~> 2.0)
+      rack-protection (= 2.0.5)
+      tilt (~> 2.0)
+    tilt (2.0.9)
+    webmock (3.5.1)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+      hashdiff
     yard (0.9.18)
 
 PLATFORMS
+  ruby
+  unknown
   x64-mingw32
 
 DEPENDENCIES
   bundler (~> 2.0)
   rake (~> 10.0)
+  rspec (~> 3.8)
+  sinatra (~> 2.0)
   vt_api!
+  webmock (~> 3.5)
   yard (~> 0.9)
 
+RUBY VERSION
+   ruby 2.5.1p57
+
 BUNDLED WITH
    2.0.1

data/README.md

@@ -42,7 +42,7 @@ 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 ...>
+url = VtApi::ApiV2::URL.report resource: 'https://bitbucket.org/thedeadferryman/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

data/Rakefile

@@ -1,10 +1,25 @@
-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
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+YARD_SOURCES = Dir['lib/**/*.rb']
+YARD_EXTRAS  = Dir['*.md']
+
+begin
+	require 'rspec/core/rake_task'
+	RSpec::Core::RakeTask.new
+rescue LoadError
+	STDERR.puts 'RSpec not found, skipping testing tasks'
+end
+
+begin
+	require 'yard'
+	YARD::Rake::YardocTask.new do |opts|
+		opts.files   = YARD_SOURCES + %w[-] + YARD_EXTRAS
+		opts.options = %w[--verbose --no-private]
+	end
+rescue LoadError
+	STDERR.puts 'YARDoc not found, skipping doc tasks'
+end
+
+task default: %i[spec build]

data/lib/vt_api.rb

@@ -1,28 +1,10 @@
+# frozen_string_literal: true
+
 require_relative 'vt_api/version'
+require_relative 'vt_api/errors'
 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/lib/vt_api/api.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require_relative 'api/config'
 require_relative 'api/v2'

data/lib/vt_api/api/config.rb

@@ -1,5 +1,8 @@
+# frozen_string_literal: true
+
 require 'ostruct'
 
+# @author Karl F. Meinkopf
 module VtApi
 	# Default options for VT API, common for all versions
 	DEFAULT_OPTIONS = OpenStruct.new(
@@ -30,4 +33,4 @@ module VtApi
 	def self.token=(token)
 		options[:token] = token
 	end
-end
+end

data/lib/vt_api/api/v2.rb

@@ -1,16 +1,14 @@
+# frozen_string_literal: true
+
 require_relative 'config'
+
+require_relative 'v2/essentials'
 require_relative 'v2/file'
 require_relative 'v2/url'
 require_relative 'v2/comments'
 
 module VtApi
+	# VT Public 2.0 API bindings
 	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
+end

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

@@ -1,3 +1,8 @@
+# frozen_string_literal: true
+
+
+require_relative 'essentials'
+
 module VtApi
 	module ApiV2
 		# VT API 2.0 for comments
@@ -45,15 +50,14 @@ module VtApi
 				resp.response_code == 1
 			end
 
-			private
-
 			def self.parse_comments(api_resp)
-				if api_resp.response_code.nil? or api_resp.response_code != 1
+				# noinspection RubyResolve
+				if api_resp.response_code.nil? || (api_resp.response_code != 1)
 					[]
 				else
-					api_resp.comments.map {|comment| Comment.new comment.date, comment.text}
+					api_resp.comments.map { |comment| Comment.new comment.date, comment.text }
 				end
 			end
 		end
 	end
-end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module VtApi
+	# VT Public 2.0 API bindings
+	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/v2/file.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'date'
 require 'pathname'
 
@@ -5,14 +7,12 @@ require 'faraday/upload_io'
 require 'mimemagic'
 
 require_relative '../config'
-require_relative '../../internal/api_provider'
-require_relative '../v2'
+require_relative 'essentials'
 
 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
@@ -29,7 +29,7 @@ module VtApi
 
 			# Existing ID types
 			# @see #id
-			ID_TYPES = %w(scan_id resource_id md5 sha1 sha256)
+			ID_TYPES = %w[scan_id resource_id md5 sha1 sha256].freeze
 
 			class << self
 				# @see https://developers.virustotal.com/v2.0/reference#file-report
@@ -55,9 +55,7 @@ module VtApi
 				# @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
+					file = file_to_io file if file.is_a?(String) || file.is_a?(Pathname)
 
 					resp = ApiV2.provider.request 'file.scan', apikey: VtApi.options.token, file: file
 					resp.scan_id
@@ -79,10 +77,11 @@ module VtApi
 			#
 			# @see #initialize
 			def self.from_response(api_resp)
-				if api_resp.response_code.nil? or api_resp.response_code < 1
+				# noinspection RubyResolve
+				if api_resp.response_code.nil? || (api_resp.response_code < 1)
 					nil
 				else
-					report = self.new api_resp
+					report = new api_resp
 
 					report
 				end
@@ -91,7 +90,8 @@ module VtApi
 			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.
+			# @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
@@ -117,9 +117,7 @@ module VtApi
 			# @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
+				raise ArgumentError, "There is no such id type (#{type}) in VT API 2.0" unless ID_TYPES.include? type.to_sym
 
 				@ids[type.to_sym]
 			end
@@ -128,13 +126,13 @@ module VtApi
 
 			# noinspection RubyResolve
 			def load_ids!(api_resp)
-				@ids = OpenStruct.new ({
+				@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)
@@ -153,4 +151,4 @@ module VtApi
 			end
 		end
 	end
-end
+end

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

@@ -1,16 +1,23 @@
+# frozen_string_literal: true
+
+require_relative '../config'
+require_relative 'essentials'
+
 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.
+				# @param [Boolean] scan Schedule 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)
+					resp = ApiV2.provider.request 'url.report',
+					                              apikey:        VtApi.options.token,
+					                              resource:      resource,
+					                              schedule_scan: (scan ? 1 : 0)
 					pp resp
 					from_response resp
 				end
@@ -23,17 +30,17 @@ module VtApi
 					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
+				# noinspection RubyResolve
+				if api_resp.response_code.nil? || (api_resp.response_code < 1)
 					nil
 				else
-					report = self.new api_resp
+					report = new api_resp
 					report
 				end
 			end
@@ -41,7 +48,8 @@ module VtApi
 			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.
+			# @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
@@ -75,4 +83,4 @@ module VtApi
 			end
 		end
 	end
-end
+end

data/lib/vt_api/errors.rb

@@ -0,0 +1,23 @@
+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/lib/vt_api/internal.rb

@@ -1,4 +1,6 @@
+# frozen_string_literal: true
+
 require_relative 'internal/api_provider'
 require_relative 'internal/api_version'
 require_relative 'internal/endpoint'
-require_relative 'internal/versions'
+require_relative 'internal/versions'

data/lib/vt_api/internal/api_provider.rb

@@ -1,25 +1,27 @@
+# frozen_string_literal: true
+
 require 'faraday'
 
 require 'json'
 require 'ostruct'
 
 require_relative 'versions/default'
-require_relative '../../vt_api'
+require_relative '../errors'
 
 module VtApi
-	# API intercation class.
+	# API interaction 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"
+			unless api_version.is_a? ApiVersion
+				raise ArgumentError,
+				      "Invalid API interface supplied! Must be subclass of 'ApiVersion', got #{api_version.class} instead"
 			end
 
 			@api        = api_version
@@ -42,24 +44,31 @@ module VtApi
 		# @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
+			endpoint = endpoint(method_name, params)
 
 			result = @connection.public_send(endpoint.method, endpoint.uri, params, {})
 
-			if @api.error? result.status
-				raise ApiError, "#{@api.version} error: #{@api.error(result.status)}"
-			end
+			raise ApiError, "#{@api.version} error: #{@api.error(result.status)}" if @api.error? result.status
 
 			# noinspection RubyResolve
 			JSON.parse result.body, object_class: OpenStruct
 		end
+
+		private
+
+		def endpoint(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)} required by endpoint '#{method_name}'."
+			end
+			endpoint
+		end
 	end
-end
+end

data/lib/vt_api/internal/api_version.rb

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

data/lib/vt_api/internal/endpoint.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday/connection'
 
 module VtApi
@@ -23,16 +25,13 @@ module VtApi
 			@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
+				return false if required && passed_params[param].nil?
 			end
 
 			true
@@ -46,9 +45,7 @@ module VtApi
 			missing = []
 
 			@params.each do |param, required|
-				if required and passed_params[param].nil?
-					missing << param
-				end
+				missing << param if required && passed_params[param].nil?
 			end
 
 			missing
@@ -66,4 +63,4 @@ module VtApi
 			uri.gsub %r{([^:])[\/]+}, '\1/'
 		end
 	end
-end
+end

data/lib/vt_api/internal/versions.rb

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require_relative 'versions/api_v2'
-require_relative 'versions/default'
+require_relative 'versions/default'

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

@@ -1,73 +1,64 @@
+# frozen_string_literal: true
+
 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
-				}),
-			}
+				'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)
+			}.freeze
 
 			# List of possible HTTP error codes with descriptions
 			ERRORS = {
-				204 => "Request rate limit exceeded.",
-				400 => "Invalid arguments.",
-				403 => "Access denied.",
-				404 => "Endpoint not found."
-			}
+				204 => 'Request rate limit exceeded.',
+				400 => 'Invalid arguments.',
+				403 => 'Access denied.',
+				404 => 'Endpoint not found.'
+			}.freeze
 
 			class << self
 				# Get interface instance.
 				#
 				# @return [VtApi::Versions::ApiV2]
 				def instance
-					@instance ||= self.new
+					@instance ||= new
 				end
 			end
 
@@ -84,7 +75,7 @@ module VtApi
 			# @param [String] method Method name.
 			# @return [Boolean]
 			def endpoint?(method)
-				not endpoint(method).nil?
+				!endpoint(method).nil?
 			end
 
 			# Get API HTTP-code description.
@@ -100,10 +91,10 @@ module VtApi
 			# @param [Integer] http_code
 			# @return [Boolean] Error description.
 			def error?(http_code)
-				not error(http_code).nil?
+				!error(http_code).nil?
 			end
 
-			# Get API base URL.
+			# API base URL.
 			#
 			# @return [String]
 			def base_url
@@ -116,15 +107,9 @@ module VtApi
 			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
+end

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

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

data/lib/vt_api/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module VtApi
-	VERSION = "0.1.2.1"
+	VERSION = '0.1.3'
 end

data/vt_api.gemspec

@@ -26,20 +26,22 @@ Gem::Specification.new do |spec|
 	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)/})}
+		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.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 'rspec', '~> 3.8'
+	spec.add_development_dependency 'sinatra', '~> 2.0'
+	spec.add_development_dependency 'webmock', '~> 3.5'
 	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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: vt_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Karl 'Charon' Meinkopf
@@ -38,6 +38,48 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  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: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -88,22 +130,23 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".scrutinizer.yml"
 - ".travis.yml"
-- ".yardopts"
 - Gemfile
 - Gemfile.lock
 - LICENSE.md
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - 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/essentials.rb
 - lib/vt_api/api/v2/file.rb
 - lib/vt_api/api/v2/url.rb
+- lib/vt_api/errors.rb
 - lib/vt_api/internal.rb
 - lib/vt_api/internal/api_provider.rb
 - lib/vt_api/internal/api_version.rb

data/.yardopts

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

data/bin/console

@@ -1,13 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "vt_api"
-
-VtApi.token = 'fe2b8030e62c7d2e3a2ce7450159612fd3bf0419e0ffbdeea3e06e80d51a01af'
-
-include VtApi
-
-ApiV2::File.report resource: '13166fc9de263ee2c676430ae88e65040e10761c90e79347a2684476bc60e622'
-
-# require "pry"
-# Pry.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here