vt_api 0.1.2 → 0.1.2.1

data/lib/vt_api/internal/api_provider.rb

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

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

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

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

@@ -1,11 +1,11 @@
-require_relative 'api_v2'
-
-module VtApi
-	module Versions
-
-		# Default API version used by ApiProvider
-		#
-		# @see VtApi::ApiProvider
-		DEFAULT = API_V2
-	end
+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

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

data/lib/vt_api/internal.rb

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

data/lib/vt_api/version.rb

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