cloudmersive-virus-scan-api-client 1.3.0 → 2.0.1

Sign up to get free protection for your applications and to get access to all the features.
@@ -1,38 +0,0 @@
1
- =begin
2
- #virusapi
3
-
4
- #Virus API lets you scan files and content for viruses and identify security issues with content.
5
-
6
- OpenAPI spec version: v1
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: unset
10
-
11
- =end
12
-
13
- module CloudmersiveVirusScanApiClient
14
- class ApiError < StandardError
15
- attr_reader :code, :response_headers, :response_body
16
-
17
- # Usage examples:
18
- # ApiError.new
19
- # ApiError.new("message")
20
- # ApiError.new(:code => 500, :response_headers => {}, :response_body => "")
21
- # ApiError.new(:code => 404, :message => "Not Found")
22
- def initialize(arg = nil)
23
- if arg.is_a? Hash
24
- if arg.key?(:message) || arg.key?('message')
25
- super(arg[:message] || arg['message'])
26
- else
27
- super arg
28
- end
29
-
30
- arg.each do |k, v|
31
- instance_variable_set "@#{k}", v
32
- end
33
- else
34
- super arg
35
- end
36
- end
37
- end
38
- end
@@ -1,209 +0,0 @@
1
- =begin
2
- #virusapi
3
-
4
- #Virus API lets you scan files and content for viruses and identify security issues with content.
5
-
6
- OpenAPI spec version: v1
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: unset
10
-
11
- =end
12
-
13
- require 'uri'
14
-
15
- module CloudmersiveVirusScanApiClient
16
- class Configuration
17
- # Defines url scheme
18
- attr_accessor :scheme
19
-
20
- # Defines url host
21
- attr_accessor :host
22
-
23
- # Defines url base path
24
- attr_accessor :base_path
25
-
26
- # Defines API keys used with API Key authentications.
27
- #
28
- # @return [Hash] key: parameter name, value: parameter value (API key)
29
- #
30
- # @example parameter name is "api_key", API key is "xxx" (e.g. "api_key=xxx" in query string)
31
- # config.api_key['api_key'] = 'xxx'
32
- attr_accessor :api_key
33
-
34
- # Defines API key prefixes used with API Key authentications.
35
- #
36
- # @return [Hash] key: parameter name, value: API key prefix
37
- #
38
- # @example parameter name is "Authorization", API key prefix is "Token" (e.g. "Authorization: Token xxx" in headers)
39
- # config.api_key_prefix['api_key'] = 'Token'
40
- attr_accessor :api_key_prefix
41
-
42
- # Defines the username used with HTTP basic authentication.
43
- #
44
- # @return [String]
45
- attr_accessor :username
46
-
47
- # Defines the password used with HTTP basic authentication.
48
- #
49
- # @return [String]
50
- attr_accessor :password
51
-
52
- # Defines the access token (Bearer) used with OAuth2.
53
- attr_accessor :access_token
54
-
55
- # Set this to enable/disable debugging. When enabled (set to true), HTTP request/response
56
- # details will be logged with `logger.debug` (see the `logger` attribute).
57
- # Default to false.
58
- #
59
- # @return [true, false]
60
- attr_accessor :debugging
61
-
62
- # Defines the logger used for debugging.
63
- # Default to `Rails.logger` (when in Rails) or logging to STDOUT.
64
- #
65
- # @return [#debug]
66
- attr_accessor :logger
67
-
68
- # Defines the temporary folder to store downloaded files
69
- # (for API endpoints that have file response).
70
- # Default to use `Tempfile`.
71
- #
72
- # @return [String]
73
- attr_accessor :temp_folder_path
74
-
75
- # The time limit for HTTP request in seconds.
76
- # Default to 0 (never times out).
77
- attr_accessor :timeout
78
-
79
- # Set this to false to skip client side validation in the operation.
80
- # Default to true.
81
- # @return [true, false]
82
- attr_accessor :client_side_validation
83
-
84
- ### TLS/SSL setting
85
- # Set this to false to skip verifying SSL certificate when calling API from https server.
86
- # Default to true.
87
- #
88
- # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
89
- #
90
- # @return [true, false]
91
- attr_accessor :verify_ssl
92
-
93
- ### TLS/SSL setting
94
- # Set this to false to skip verifying SSL host name
95
- # Default to true.
96
- #
97
- # @note Do NOT set it to false in production code, otherwise you would face multiple types of cryptographic attacks.
98
- #
99
- # @return [true, false]
100
- attr_accessor :verify_ssl_host
101
-
102
- ### TLS/SSL setting
103
- # Set this to customize the certificate file to verify the peer.
104
- #
105
- # @return [String] the path to the certificate file
106
- #
107
- # @see The `cainfo` option of Typhoeus, `--cert` option of libcurl. Related source code:
108
- # https://github.com/typhoeus/typhoeus/blob/master/lib/typhoeus/easy_factory.rb#L145
109
- attr_accessor :ssl_ca_cert
110
-
111
- ### TLS/SSL setting
112
- # Client certificate file (for client certificate)
113
- attr_accessor :cert_file
114
-
115
- ### TLS/SSL setting
116
- # Client private key file (for client certificate)
117
- attr_accessor :key_file
118
-
119
- # Set this to customize parameters encoding of array parameter with multi collectionFormat.
120
- # Default to nil.
121
- #
122
- # @see The params_encoding option of Ethon. Related source code:
123
- # https://github.com/typhoeus/ethon/blob/master/lib/ethon/easy/queryable.rb#L96
124
- attr_accessor :params_encoding
125
-
126
- attr_accessor :inject_format
127
-
128
- attr_accessor :force_ending_format
129
-
130
- def initialize
131
- @scheme = 'https'
132
- @host = 'api.cloudmersive.com'
133
- @base_path = ''
134
- @api_key = {}
135
- @api_key_prefix = {}
136
- @timeout = 0
137
- @client_side_validation = true
138
- @verify_ssl = true
139
- @verify_ssl_host = true
140
- @params_encoding = nil
141
- @cert_file = nil
142
- @key_file = nil
143
- @debugging = false
144
- @inject_format = false
145
- @force_ending_format = false
146
- @logger = defined?(Rails) ? Rails.logger : Logger.new(STDOUT)
147
-
148
- yield(self) if block_given?
149
- end
150
-
151
- # The default Configuration object.
152
- def self.default
153
- @@default ||= Configuration.new
154
- end
155
-
156
- def configure
157
- yield(self) if block_given?
158
- end
159
-
160
- def scheme=(scheme)
161
- # remove :// from scheme
162
- @scheme = scheme.sub(/:\/\//, '')
163
- end
164
-
165
- def host=(host)
166
- # remove http(s):// and anything after a slash
167
- @host = host.sub(/https?:\/\//, '').split('/').first
168
- end
169
-
170
- def base_path=(base_path)
171
- # Add leading and trailing slashes to base_path
172
- @base_path = "/#{base_path}".gsub(/\/+/, '/')
173
- @base_path = "" if @base_path == "/"
174
- end
175
-
176
- def base_url
177
- url = "#{scheme}://#{[host, base_path].join('/').gsub(/\/+/, '/')}".sub(/\/+\z/, '')
178
- URI.encode(url)
179
- end
180
-
181
- # Gets API key (with prefix if set).
182
- # @param [String] param_name the parameter name of API key auth
183
- def api_key_with_prefix(param_name)
184
- if @api_key_prefix[param_name]
185
- "#{@api_key_prefix[param_name]} #{@api_key[param_name]}"
186
- else
187
- @api_key[param_name]
188
- end
189
- end
190
-
191
- # Gets Basic Auth token string
192
- def basic_auth_token
193
- 'Basic ' + ["#{username}:#{password}"].pack('m').delete("\r\n")
194
- end
195
-
196
- # Returns Auth Settings hash for api client.
197
- def auth_settings
198
- {
199
- 'Apikey' =>
200
- {
201
- type: 'api_key',
202
- in: 'header',
203
- key: 'Apikey',
204
- value: api_key_with_prefix('Apikey')
205
- },
206
- }
207
- end
208
- end
209
- end
@@ -1,199 +0,0 @@
1
- =begin
2
- #virusapi
3
-
4
- #Virus API lets you scan files and content for viruses and identify security issues with content.
5
-
6
- OpenAPI spec version: v1
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: unset
10
-
11
- =end
12
-
13
- require 'date'
14
-
15
- module CloudmersiveVirusScanApiClient
16
- # Virus positively identified
17
- class VirusFound
18
- # Name of the file containing the virus
19
- attr_accessor :file_name
20
-
21
- # Name of the virus that was found
22
- attr_accessor :virus_name
23
-
24
-
25
- # Attribute mapping from ruby-style variable name to JSON key.
26
- def self.attribute_map
27
- {
28
- :'file_name' => :'FileName',
29
- :'virus_name' => :'VirusName'
30
- }
31
- end
32
-
33
- # Attribute type mapping.
34
- def self.swagger_types
35
- {
36
- :'file_name' => :'String',
37
- :'virus_name' => :'String'
38
- }
39
- end
40
-
41
- # Initializes the object
42
- # @param [Hash] attributes Model attributes in the form of hash
43
- def initialize(attributes = {})
44
- return unless attributes.is_a?(Hash)
45
-
46
- # convert string to symbol for hash key
47
- attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
48
-
49
- if attributes.has_key?(:'FileName')
50
- self.file_name = attributes[:'FileName']
51
- end
52
-
53
- if attributes.has_key?(:'VirusName')
54
- self.virus_name = attributes[:'VirusName']
55
- end
56
-
57
- end
58
-
59
- # Show invalid properties with the reasons. Usually used together with valid?
60
- # @return Array for valid properties with the reasons
61
- def list_invalid_properties
62
- invalid_properties = Array.new
63
- return invalid_properties
64
- end
65
-
66
- # Check to see if the all the properties in the model are valid
67
- # @return true if the model is valid
68
- def valid?
69
- return true
70
- end
71
-
72
- # Checks equality by comparing each attribute.
73
- # @param [Object] Object to be compared
74
- def ==(o)
75
- return true if self.equal?(o)
76
- self.class == o.class &&
77
- file_name == o.file_name &&
78
- virus_name == o.virus_name
79
- end
80
-
81
- # @see the `==` method
82
- # @param [Object] Object to be compared
83
- def eql?(o)
84
- self == o
85
- end
86
-
87
- # Calculates hash code according to all attributes.
88
- # @return [Fixnum] Hash code
89
- def hash
90
- [file_name, virus_name].hash
91
- end
92
-
93
- # Builds the object from hash
94
- # @param [Hash] attributes Model attributes in the form of hash
95
- # @return [Object] Returns the model itself
96
- def build_from_hash(attributes)
97
- return nil unless attributes.is_a?(Hash)
98
- self.class.swagger_types.each_pair do |key, type|
99
- if type =~ /\AArray<(.*)>/i
100
- # check to ensure the input is an array given that the the attribute
101
- # is documented as an array but the input is not
102
- if attributes[self.class.attribute_map[key]].is_a?(Array)
103
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
104
- end
105
- elsif !attributes[self.class.attribute_map[key]].nil?
106
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
107
- end # or else data not found in attributes(hash), not an issue as the data can be optional
108
- end
109
-
110
- self
111
- end
112
-
113
- # Deserializes the data based on type
114
- # @param string type Data type
115
- # @param string value Value to be deserialized
116
- # @return [Object] Deserialized data
117
- def _deserialize(type, value)
118
- case type.to_sym
119
- when :DateTime
120
- DateTime.parse(value)
121
- when :Date
122
- Date.parse(value)
123
- when :String
124
- value.to_s
125
- when :Integer
126
- value.to_i
127
- when :Float
128
- value.to_f
129
- when :BOOLEAN
130
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
131
- true
132
- else
133
- false
134
- end
135
- when :Object
136
- # generic object (usually a Hash), return directly
137
- value
138
- when /\AArray<(?<inner_type>.+)>\z/
139
- inner_type = Regexp.last_match[:inner_type]
140
- value.map { |v| _deserialize(inner_type, v) }
141
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
142
- k_type = Regexp.last_match[:k_type]
143
- v_type = Regexp.last_match[:v_type]
144
- {}.tap do |hash|
145
- value.each do |k, v|
146
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
147
- end
148
- end
149
- else # model
150
- temp_model = CloudmersiveVirusScanApiClient.const_get(type).new
151
- temp_model.build_from_hash(value)
152
- end
153
- end
154
-
155
- # Returns the string representation of the object
156
- # @return [String] String presentation of the object
157
- def to_s
158
- to_hash.to_s
159
- end
160
-
161
- # to_body is an alias to to_hash (backward compatibility)
162
- # @return [Hash] Returns the object in the form of hash
163
- def to_body
164
- to_hash
165
- end
166
-
167
- # Returns the object in the form of hash
168
- # @return [Hash] Returns the object in the form of hash
169
- def to_hash
170
- hash = {}
171
- self.class.attribute_map.each_pair do |attr, param|
172
- value = self.send(attr)
173
- next if value.nil?
174
- hash[param] = _to_hash(value)
175
- end
176
- hash
177
- end
178
-
179
- # Outputs non-array value in the form of hash
180
- # For object, use to_hash. Otherwise, just return the value
181
- # @param [Object] value Any valid value
182
- # @return [Hash] Returns the value in the form of hash
183
- def _to_hash(value)
184
- if value.is_a?(Array)
185
- value.compact.map{ |v| _to_hash(v) }
186
- elsif value.is_a?(Hash)
187
- {}.tap do |hash|
188
- value.each { |k, v| hash[k] = _to_hash(v) }
189
- end
190
- elsif value.respond_to? :to_hash
191
- value.to_hash
192
- else
193
- value
194
- end
195
- end
196
-
197
- end
198
-
199
- end
@@ -1,201 +0,0 @@
1
- =begin
2
- #virusapi
3
-
4
- #Virus API lets you scan files and content for viruses and identify security issues with content.
5
-
6
- OpenAPI spec version: v1
7
-
8
- Generated by: https://github.com/swagger-api/swagger-codegen.git
9
- Swagger Codegen version: unset
10
-
11
- =end
12
-
13
- require 'date'
14
-
15
- module CloudmersiveVirusScanApiClient
16
- # Result of running a virus scan
17
- class VirusScanResult
18
- # True if the scan contained no viruses, false otherwise
19
- attr_accessor :clean_result
20
-
21
- # Array of viruses found, if any
22
- attr_accessor :found_viruses
23
-
24
-
25
- # Attribute mapping from ruby-style variable name to JSON key.
26
- def self.attribute_map
27
- {
28
- :'clean_result' => :'CleanResult',
29
- :'found_viruses' => :'FoundViruses'
30
- }
31
- end
32
-
33
- # Attribute type mapping.
34
- def self.swagger_types
35
- {
36
- :'clean_result' => :'BOOLEAN',
37
- :'found_viruses' => :'Array<VirusFound>'
38
- }
39
- end
40
-
41
- # Initializes the object
42
- # @param [Hash] attributes Model attributes in the form of hash
43
- def initialize(attributes = {})
44
- return unless attributes.is_a?(Hash)
45
-
46
- # convert string to symbol for hash key
47
- attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
48
-
49
- if attributes.has_key?(:'CleanResult')
50
- self.clean_result = attributes[:'CleanResult']
51
- end
52
-
53
- if attributes.has_key?(:'FoundViruses')
54
- if (value = attributes[:'FoundViruses']).is_a?(Array)
55
- self.found_viruses = value
56
- end
57
- end
58
-
59
- end
60
-
61
- # Show invalid properties with the reasons. Usually used together with valid?
62
- # @return Array for valid properties with the reasons
63
- def list_invalid_properties
64
- invalid_properties = Array.new
65
- return invalid_properties
66
- end
67
-
68
- # Check to see if the all the properties in the model are valid
69
- # @return true if the model is valid
70
- def valid?
71
- return true
72
- end
73
-
74
- # Checks equality by comparing each attribute.
75
- # @param [Object] Object to be compared
76
- def ==(o)
77
- return true if self.equal?(o)
78
- self.class == o.class &&
79
- clean_result == o.clean_result &&
80
- found_viruses == o.found_viruses
81
- end
82
-
83
- # @see the `==` method
84
- # @param [Object] Object to be compared
85
- def eql?(o)
86
- self == o
87
- end
88
-
89
- # Calculates hash code according to all attributes.
90
- # @return [Fixnum] Hash code
91
- def hash
92
- [clean_result, found_viruses].hash
93
- end
94
-
95
- # Builds the object from hash
96
- # @param [Hash] attributes Model attributes in the form of hash
97
- # @return [Object] Returns the model itself
98
- def build_from_hash(attributes)
99
- return nil unless attributes.is_a?(Hash)
100
- self.class.swagger_types.each_pair do |key, type|
101
- if type =~ /\AArray<(.*)>/i
102
- # check to ensure the input is an array given that the the attribute
103
- # is documented as an array but the input is not
104
- if attributes[self.class.attribute_map[key]].is_a?(Array)
105
- self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
106
- end
107
- elsif !attributes[self.class.attribute_map[key]].nil?
108
- self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
109
- end # or else data not found in attributes(hash), not an issue as the data can be optional
110
- end
111
-
112
- self
113
- end
114
-
115
- # Deserializes the data based on type
116
- # @param string type Data type
117
- # @param string value Value to be deserialized
118
- # @return [Object] Deserialized data
119
- def _deserialize(type, value)
120
- case type.to_sym
121
- when :DateTime
122
- DateTime.parse(value)
123
- when :Date
124
- Date.parse(value)
125
- when :String
126
- value.to_s
127
- when :Integer
128
- value.to_i
129
- when :Float
130
- value.to_f
131
- when :BOOLEAN
132
- if value.to_s =~ /\A(true|t|yes|y|1)\z/i
133
- true
134
- else
135
- false
136
- end
137
- when :Object
138
- # generic object (usually a Hash), return directly
139
- value
140
- when /\AArray<(?<inner_type>.+)>\z/
141
- inner_type = Regexp.last_match[:inner_type]
142
- value.map { |v| _deserialize(inner_type, v) }
143
- when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
144
- k_type = Regexp.last_match[:k_type]
145
- v_type = Regexp.last_match[:v_type]
146
- {}.tap do |hash|
147
- value.each do |k, v|
148
- hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
149
- end
150
- end
151
- else # model
152
- temp_model = CloudmersiveVirusScanApiClient.const_get(type).new
153
- temp_model.build_from_hash(value)
154
- end
155
- end
156
-
157
- # Returns the string representation of the object
158
- # @return [String] String presentation of the object
159
- def to_s
160
- to_hash.to_s
161
- end
162
-
163
- # to_body is an alias to to_hash (backward compatibility)
164
- # @return [Hash] Returns the object in the form of hash
165
- def to_body
166
- to_hash
167
- end
168
-
169
- # Returns the object in the form of hash
170
- # @return [Hash] Returns the object in the form of hash
171
- def to_hash
172
- hash = {}
173
- self.class.attribute_map.each_pair do |attr, param|
174
- value = self.send(attr)
175
- next if value.nil?
176
- hash[param] = _to_hash(value)
177
- end
178
- hash
179
- end
180
-
181
- # Outputs non-array value in the form of hash
182
- # For object, use to_hash. Otherwise, just return the value
183
- # @param [Object] value Any valid value
184
- # @return [Hash] Returns the value in the form of hash
185
- def _to_hash(value)
186
- if value.is_a?(Array)
187
- value.compact.map{ |v| _to_hash(v) }
188
- elsif value.is_a?(Hash)
189
- {}.tap do |hash|
190
- value.each { |k, v| hash[k] = _to_hash(v) }
191
- end
192
- elsif value.respond_to? :to_hash
193
- value.to_hash
194
- else
195
- value
196
- end
197
- end
198
-
199
- end
200
-
201
- end