vt_api 0.1.2 → 0.1.2.1

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

@@ -1,59 +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
+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

@@ -1,156 +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
+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

@@ -1,78 +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
+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

@@ -1,15 +1,16 @@
-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
+require_relative 'config'
+require_relative 'v2/file'
+require_relative 'v2/url'
+require_relative 'v2/comments'
+
+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

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