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,9 +0,0 @@
1
- # CloudmersiveVirusScanApiClient::WebsiteScanResult
2
-
3
- ## Properties
4
- Name | Type | Description | Notes
5
- ------------ | ------------- | ------------- | -------------
6
- **clean_result** | **BOOLEAN** | True if the scan contained no threats, false otherwise | [optional]
7
- **website_threat_type** | **String** | Type of threat returned; can be None, Malware, ForcedDownload or Phishing | [optional]
8
-
9
-
@@ -1,55 +0,0 @@
1
- #!/bin/sh
2
- #
3
- # Generated by: https://github.com/swagger-api/swagger-codegen.git
4
- #
5
- # ref: https://help.github.com/articles/adding-an-existing-project-to-github-using-the-command-line/
6
- #
7
- # Usage example: /bin/sh ./git_push.sh wing328 swagger-petstore-perl "minor update"
8
-
9
- git_user_id=$1
10
- git_repo_id=$2
11
- release_note=$3
12
-
13
- if [ "$git_user_id" = "" ]; then
14
- git_user_id="GIT_USER_ID"
15
- echo "[INFO] No command line input provided. Set \$git_user_id to $git_user_id"
16
- fi
17
-
18
- if [ "$git_repo_id" = "" ]; then
19
- git_repo_id="GIT_REPO_ID"
20
- echo "[INFO] No command line input provided. Set \$git_repo_id to $git_repo_id"
21
- fi
22
-
23
- if [ "$release_note" = "" ]; then
24
- release_note="Minor update"
25
- echo "[INFO] No command line input provided. Set \$release_note to $release_note"
26
- fi
27
-
28
- # Initialize the local directory as a Git repository
29
- git init
30
-
31
- # Adds the files in the local repository and stages them for commit.
32
- git add .
33
-
34
- # Commits the tracked changes and prepares them to be pushed to a remote repository.
35
- git commit -m "$release_note"
36
-
37
- # Sets the new remote
38
- git_remote=`git remote`
39
- if [ "$git_remote" = "" ]; then # git remote not defined
40
-
41
- if [ "$GIT_TOKEN" = "" ]; then
42
- echo "[INFO] \$GIT_TOKEN (environment variable) is not set. Using the git credential in your environment."
43
- git remote add origin https://github.com/${git_user_id}/${git_repo_id}.git
44
- else
45
- git remote add origin https://${git_user_id}:${GIT_TOKEN}@github.com/${git_user_id}/${git_repo_id}.git
46
- fi
47
-
48
- fi
49
-
50
- git pull origin master
51
-
52
- # Pushes (Forces) the changes in the local repository up to the remote repository
53
- echo "Git pushing to https://github.com/${git_user_id}/${git_repo_id}.git"
54
- git push origin master 2>&1 | grep -v 'To https'
55
-
@@ -1,44 +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
- # Common files
14
- require 'cloudmersive-virus-scan-api-client/api_client'
15
- require 'cloudmersive-virus-scan-api-client/api_error'
16
- require 'cloudmersive-virus-scan-api-client/version'
17
- require 'cloudmersive-virus-scan-api-client/configuration'
18
-
19
- # Models
20
- require 'cloudmersive-virus-scan-api-client/models/virus_found'
21
- require 'cloudmersive-virus-scan-api-client/models/virus_scan_result'
22
- require 'cloudmersive-virus-scan-api-client/models/website_scan_request'
23
- require 'cloudmersive-virus-scan-api-client/models/website_scan_result'
24
-
25
- # APIs
26
- require 'cloudmersive-virus-scan-api-client/api/scan_api'
27
-
28
- module CloudmersiveVirusScanApiClient
29
- class << self
30
- # Customize default settings for the SDK using block.
31
- # CloudmersiveVirusScanApiClient.configure do |config|
32
- # config.username = "xxx"
33
- # config.password = "xxx"
34
- # end
35
- # If no block given, return the default Configuration object.
36
- def configure
37
- if block_given?
38
- yield(Configuration.default)
39
- else
40
- Configuration.default
41
- end
42
- end
43
- end
44
- end
@@ -1,134 +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 ScanApi
17
- attr_accessor :api_client
18
-
19
- def initialize(api_client = ApiClient.default)
20
- @api_client = api_client
21
- end
22
-
23
- # Scan a file for viruses
24
- #
25
- # @param input_file Input file to perform the operation on.
26
- # @param [Hash] opts the optional parameters
27
- # @return [VirusScanResult]
28
- def scan_file(input_file, opts = {})
29
- data, _status_code, _headers = scan_file_with_http_info(input_file, opts)
30
- return data
31
- end
32
-
33
- # Scan a file for viruses
34
- #
35
- # @param input_file Input file to perform the operation on.
36
- # @param [Hash] opts the optional parameters
37
- # @return [Array<(VirusScanResult, Fixnum, Hash)>] VirusScanResult data, response status code and response headers
38
- def scan_file_with_http_info(input_file, opts = {})
39
- if @api_client.config.debugging
40
- @api_client.config.logger.debug "Calling API: ScanApi.scan_file ..."
41
- end
42
- # verify the required parameter 'input_file' is set
43
- if @api_client.config.client_side_validation && input_file.nil?
44
- fail ArgumentError, "Missing the required parameter 'input_file' when calling ScanApi.scan_file"
45
- end
46
- # resource path
47
- local_var_path = "/virus/scan/file"
48
-
49
- # query parameters
50
- query_params = {}
51
-
52
- # header parameters
53
- header_params = {}
54
- # HTTP header 'Accept' (if needed)
55
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
56
- # HTTP header 'Content-Type'
57
- header_params['Content-Type'] = @api_client.select_header_content_type(['multipart/form-data'])
58
-
59
- # form parameters
60
- form_params = {}
61
- form_params["inputFile"] = input_file
62
-
63
- # http body (model)
64
- post_body = nil
65
- auth_names = ['Apikey']
66
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
67
- :header_params => header_params,
68
- :query_params => query_params,
69
- :form_params => form_params,
70
- :body => post_body,
71
- :auth_names => auth_names,
72
- :return_type => 'VirusScanResult')
73
- if @api_client.config.debugging
74
- @api_client.config.logger.debug "API called: ScanApi#scan_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
75
- end
76
- return data, status_code, headers
77
- end
78
-
79
- # Scan a website for malicious content including viruses and threats (including Phishing)
80
- #
81
- # @param input
82
- # @param [Hash] opts the optional parameters
83
- # @return [WebsiteScanResult]
84
- def scan_website(input, opts = {})
85
- data, _status_code, _headers = scan_website_with_http_info(input, opts)
86
- return data
87
- end
88
-
89
- # Scan a website for malicious content including viruses and threats (including Phishing)
90
- #
91
- # @param input
92
- # @param [Hash] opts the optional parameters
93
- # @return [Array<(WebsiteScanResult, Fixnum, Hash)>] WebsiteScanResult data, response status code and response headers
94
- def scan_website_with_http_info(input, opts = {})
95
- if @api_client.config.debugging
96
- @api_client.config.logger.debug "Calling API: ScanApi.scan_website ..."
97
- end
98
- # verify the required parameter 'input' is set
99
- if @api_client.config.client_side_validation && input.nil?
100
- fail ArgumentError, "Missing the required parameter 'input' when calling ScanApi.scan_website"
101
- end
102
- # resource path
103
- local_var_path = "/virus/scan/website"
104
-
105
- # query parameters
106
- query_params = {}
107
-
108
- # header parameters
109
- header_params = {}
110
- # HTTP header 'Accept' (if needed)
111
- header_params['Accept'] = @api_client.select_header_accept(['application/json', 'text/json', 'application/xml', 'text/xml'])
112
- # HTTP header 'Content-Type'
113
- header_params['Content-Type'] = @api_client.select_header_content_type(['application/json', 'text/json', 'application/xml', 'text/xml', 'application/x-www-form-urlencoded'])
114
-
115
- # form parameters
116
- form_params = {}
117
-
118
- # http body (model)
119
- post_body = @api_client.object_to_http_body(input)
120
- auth_names = ['Apikey']
121
- data, status_code, headers = @api_client.call_api(:POST, local_var_path,
122
- :header_params => header_params,
123
- :query_params => query_params,
124
- :form_params => form_params,
125
- :body => post_body,
126
- :auth_names => auth_names,
127
- :return_type => 'WebsiteScanResult')
128
- if @api_client.config.debugging
129
- @api_client.config.logger.debug "API called: ScanApi#scan_website\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
130
- end
131
- return data, status_code, headers
132
- end
133
- end
134
- end
@@ -1,389 +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
- require 'json'
15
- require 'logger'
16
- require 'tempfile'
17
- require 'typhoeus'
18
- require 'uri'
19
-
20
- module CloudmersiveVirusScanApiClient
21
- class ApiClient
22
- # The Configuration object holding settings to be used in the API client.
23
- attr_accessor :config
24
-
25
- # Defines the headers to be used in HTTP requests of all API calls by default.
26
- #
27
- # @return [Hash]
28
- attr_accessor :default_headers
29
-
30
- # Initializes the ApiClient
31
- # @option config [Configuration] Configuration for initializing the object, default to Configuration.default
32
- def initialize(config = Configuration.default)
33
- @config = config
34
- @user_agent = "Swagger-Codegen/#{VERSION}/ruby"
35
- @default_headers = {
36
- 'Content-Type' => "application/json",
37
- 'User-Agent' => @user_agent
38
- }
39
- end
40
-
41
- def self.default
42
- @@default ||= ApiClient.new
43
- end
44
-
45
- # Call an API with given options.
46
- #
47
- # @return [Array<(Object, Fixnum, Hash)>] an array of 3 elements:
48
- # the data deserialized from response body (could be nil), response status code and response headers.
49
- def call_api(http_method, path, opts = {})
50
- request = build_request(http_method, path, opts)
51
- response = request.run
52
-
53
- if @config.debugging
54
- @config.logger.debug "HTTP response body ~BEGIN~\n#{response.body}\n~END~\n"
55
- end
56
-
57
- unless response.success?
58
- if response.timed_out?
59
- fail ApiError.new('Connection timed out')
60
- elsif response.code == 0
61
- # Errors from libcurl will be made visible here
62
- fail ApiError.new(:code => 0,
63
- :message => response.return_message)
64
- else
65
- fail ApiError.new(:code => response.code,
66
- :response_headers => response.headers,
67
- :response_body => response.body),
68
- response.status_message
69
- end
70
- end
71
-
72
- if opts[:return_type]
73
- data = deserialize(response, opts[:return_type])
74
- else
75
- data = nil
76
- end
77
- return data, response.code, response.headers
78
- end
79
-
80
- # Builds the HTTP request
81
- #
82
- # @param [String] http_method HTTP method/verb (e.g. POST)
83
- # @param [String] path URL path (e.g. /account/new)
84
- # @option opts [Hash] :header_params Header parameters
85
- # @option opts [Hash] :query_params Query parameters
86
- # @option opts [Hash] :form_params Query parameters
87
- # @option opts [Object] :body HTTP body (JSON/XML)
88
- # @return [Typhoeus::Request] A Typhoeus Request
89
- def build_request(http_method, path, opts = {})
90
- url = build_request_url(path)
91
- http_method = http_method.to_sym.downcase
92
-
93
- header_params = @default_headers.merge(opts[:header_params] || {})
94
- query_params = opts[:query_params] || {}
95
- form_params = opts[:form_params] || {}
96
-
97
- update_params_for_auth! header_params, query_params, opts[:auth_names]
98
-
99
- # set ssl_verifyhosts option based on @config.verify_ssl_host (true/false)
100
- _verify_ssl_host = @config.verify_ssl_host ? 2 : 0
101
-
102
- req_opts = {
103
- :method => http_method,
104
- :headers => header_params,
105
- :params => query_params,
106
- :params_encoding => @config.params_encoding,
107
- :timeout => @config.timeout,
108
- :ssl_verifypeer => @config.verify_ssl,
109
- :ssl_verifyhost => _verify_ssl_host,
110
- :sslcert => @config.cert_file,
111
- :sslkey => @config.key_file,
112
- :verbose => @config.debugging
113
- }
114
-
115
- # set custom cert, if provided
116
- req_opts[:cainfo] = @config.ssl_ca_cert if @config.ssl_ca_cert
117
-
118
- if [:post, :patch, :put, :delete].include?(http_method)
119
- req_body = build_request_body(header_params, form_params, opts[:body])
120
- req_opts.update :body => req_body
121
- if @config.debugging
122
- @config.logger.debug "HTTP request body param ~BEGIN~\n#{req_body}\n~END~\n"
123
- end
124
- end
125
-
126
- request = Typhoeus::Request.new(url, req_opts)
127
- download_file(request) if opts[:return_type] == 'File'
128
- request
129
- end
130
-
131
- # Check if the given MIME is a JSON MIME.
132
- # JSON MIME examples:
133
- # application/json
134
- # application/json; charset=UTF8
135
- # APPLICATION/JSON
136
- # */*
137
- # @param [String] mime MIME
138
- # @return [Boolean] True if the MIME is application/json
139
- def json_mime?(mime)
140
- (mime == "*/*") || !(mime =~ /Application\/.*json(?!p)(;.*)?/i).nil?
141
- end
142
-
143
- # Deserialize the response to the given return type.
144
- #
145
- # @param [Response] response HTTP response
146
- # @param [String] return_type some examples: "User", "Array[User]", "Hash[String,Integer]"
147
- def deserialize(response, return_type)
148
- body = response.body
149
-
150
- # handle file downloading - return the File instance processed in request callbacks
151
- # note that response body is empty when the file is written in chunks in request on_body callback
152
- return @tempfile if return_type == 'File'
153
-
154
- return nil if body.nil? || body.empty?
155
-
156
- # return response body directly for String return type
157
- return body if return_type == 'String'
158
-
159
- # ensuring a default content type
160
- content_type = response.headers['Content-Type'] || 'application/json'
161
-
162
- fail "Content-Type is not supported: #{content_type}" unless json_mime?(content_type)
163
-
164
- begin
165
- data = JSON.parse("[#{body}]", :symbolize_names => true)[0]
166
- rescue JSON::ParserError => e
167
- if %w(String Date DateTime).include?(return_type)
168
- data = body
169
- else
170
- raise e
171
- end
172
- end
173
-
174
- convert_to_type data, return_type
175
- end
176
-
177
- # Convert data to the given return type.
178
- # @param [Object] data Data to be converted
179
- # @param [String] return_type Return type
180
- # @return [Mixed] Data in a particular type
181
- def convert_to_type(data, return_type)
182
- return nil if data.nil?
183
- case return_type
184
- when 'String'
185
- data.to_s
186
- when 'Integer'
187
- data.to_i
188
- when 'Float'
189
- data.to_f
190
- when 'BOOLEAN'
191
- data == true
192
- when 'DateTime'
193
- # parse date time (expecting ISO 8601 format)
194
- DateTime.parse data
195
- when 'Date'
196
- # parse date time (expecting ISO 8601 format)
197
- Date.parse data
198
- when 'Object'
199
- # generic object (usually a Hash), return directly
200
- data
201
- when /\AArray<(.+)>\z/
202
- # e.g. Array<Pet>
203
- sub_type = $1
204
- data.map {|item| convert_to_type(item, sub_type) }
205
- when /\AHash\<String, (.+)\>\z/
206
- # e.g. Hash<String, Integer>
207
- sub_type = $1
208
- {}.tap do |hash|
209
- data.each {|k, v| hash[k] = convert_to_type(v, sub_type) }
210
- end
211
- else
212
- # models, e.g. Pet
213
- CloudmersiveVirusScanApiClient.const_get(return_type).new.tap do |model|
214
- model.build_from_hash data
215
- end
216
- end
217
- end
218
-
219
- # Save response body into a file in (the defined) temporary folder, using the filename
220
- # from the "Content-Disposition" header if provided, otherwise a random filename.
221
- # The response body is written to the file in chunks in order to handle files which
222
- # size is larger than maximum Ruby String or even larger than the maximum memory a Ruby
223
- # process can use.
224
- #
225
- # @see Configuration#temp_folder_path
226
- def download_file(request)
227
- tempfile = nil
228
- encoding = nil
229
- request.on_headers do |response|
230
- content_disposition = response.headers['Content-Disposition']
231
- if content_disposition and content_disposition =~ /filename=/i
232
- filename = content_disposition[/filename=['"]?([^'"\s]+)['"]?/, 1]
233
- prefix = sanitize_filename(filename)
234
- else
235
- prefix = 'download-'
236
- end
237
- prefix = prefix + '-' unless prefix.end_with?('-')
238
- encoding = response.body.encoding
239
- tempfile = Tempfile.open(prefix, @config.temp_folder_path, encoding: encoding)
240
- @tempfile = tempfile
241
- end
242
- request.on_body do |chunk|
243
- chunk.force_encoding(encoding)
244
- tempfile.write(chunk)
245
- end
246
- request.on_complete do |response|
247
- tempfile.close
248
- @config.logger.info "Temp file written to #{tempfile.path}, please copy the file to a proper folder "\
249
- "with e.g. `FileUtils.cp(tempfile.path, '/new/file/path')` otherwise the temp file "\
250
- "will be deleted automatically with GC. It's also recommended to delete the temp file "\
251
- "explicitly with `tempfile.delete`"
252
- end
253
- end
254
-
255
- # Sanitize filename by removing path.
256
- # e.g. ../../sun.gif becomes sun.gif
257
- #
258
- # @param [String] filename the filename to be sanitized
259
- # @return [String] the sanitized filename
260
- def sanitize_filename(filename)
261
- filename.gsub(/.*[\/\\]/, '')
262
- end
263
-
264
- def build_request_url(path)
265
- # Add leading and trailing slashes to path
266
- path = "/#{path}".gsub(/\/+/, '/')
267
- URI.encode(@config.base_url + path)
268
- end
269
-
270
- # Builds the HTTP request body
271
- #
272
- # @param [Hash] header_params Header parameters
273
- # @param [Hash] form_params Query parameters
274
- # @param [Object] body HTTP body (JSON/XML)
275
- # @return [String] HTTP body data in the form of string
276
- def build_request_body(header_params, form_params, body)
277
- # http form
278
- if header_params['Content-Type'] == 'application/x-www-form-urlencoded' ||
279
- header_params['Content-Type'] == 'multipart/form-data'
280
- data = {}
281
- form_params.each do |key, value|
282
- case value
283
- when ::File, ::Array, nil
284
- # let typhoeus handle File, Array and nil parameters
285
- data[key] = value
286
- else
287
- data[key] = value.to_s
288
- end
289
- end
290
- elsif body
291
- data = body.is_a?(String) ? body : body.to_json
292
- else
293
- data = nil
294
- end
295
- data
296
- end
297
-
298
- # Update hearder and query params based on authentication settings.
299
- #
300
- # @param [Hash] header_params Header parameters
301
- # @param [Hash] query_params Query parameters
302
- # @param [String] auth_names Authentication scheme name
303
- def update_params_for_auth!(header_params, query_params, auth_names)
304
- Array(auth_names).each do |auth_name|
305
- auth_setting = @config.auth_settings[auth_name]
306
- next unless auth_setting
307
- case auth_setting[:in]
308
- when 'header' then header_params[auth_setting[:key]] = auth_setting[:value]
309
- when 'query' then query_params[auth_setting[:key]] = auth_setting[:value]
310
- else fail ArgumentError, 'Authentication token must be in `query` of `header`'
311
- end
312
- end
313
- end
314
-
315
- # Sets user agent in HTTP header
316
- #
317
- # @param [String] user_agent User agent (e.g. swagger-codegen/ruby/1.0.0)
318
- def user_agent=(user_agent)
319
- @user_agent = user_agent
320
- @default_headers['User-Agent'] = @user_agent
321
- end
322
-
323
- # Return Accept header based on an array of accepts provided.
324
- # @param [Array] accepts array for Accept
325
- # @return [String] the Accept header (e.g. application/json)
326
- def select_header_accept(accepts)
327
- return nil if accepts.nil? || accepts.empty?
328
- # use JSON when present, otherwise use all of the provided
329
- json_accept = accepts.find { |s| json_mime?(s) }
330
- return json_accept || accepts.join(',')
331
- end
332
-
333
- # Return Content-Type header based on an array of content types provided.
334
- # @param [Array] content_types array for Content-Type
335
- # @return [String] the Content-Type header (e.g. application/json)
336
- def select_header_content_type(content_types)
337
- # use application/json by default
338
- return 'application/json' if content_types.nil? || content_types.empty?
339
- # use JSON when present, otherwise use the first one
340
- json_content_type = content_types.find { |s| json_mime?(s) }
341
- return json_content_type || content_types.first
342
- end
343
-
344
- # Convert object (array, hash, object, etc) to JSON string.
345
- # @param [Object] model object to be converted into JSON string
346
- # @return [String] JSON string representation of the object
347
- def object_to_http_body(model)
348
- return model if model.nil? || model.is_a?(String)
349
- local_body = nil
350
- if model.is_a?(Array)
351
- local_body = model.map{|m| object_to_hash(m) }
352
- else
353
- local_body = object_to_hash(model)
354
- end
355
- local_body.to_json
356
- end
357
-
358
- # Convert object(non-array) to hash.
359
- # @param [Object] obj object to be converted into JSON string
360
- # @return [String] JSON string representation of the object
361
- def object_to_hash(obj)
362
- if obj.respond_to?(:to_hash)
363
- obj.to_hash
364
- else
365
- obj
366
- end
367
- end
368
-
369
- # Build parameter value according to the given collection format.
370
- # @param [String] collection_format one of :csv, :ssv, :tsv, :pipes and :multi
371
- def build_collection_param(param, collection_format)
372
- case collection_format
373
- when :csv
374
- param.join(',')
375
- when :ssv
376
- param.join(' ')
377
- when :tsv
378
- param.join("\t")
379
- when :pipes
380
- param.join('|')
381
- when :multi
382
- # return the array directly as typhoeus will handle it as expected
383
- param
384
- else
385
- fail "unknown collection format: #{collection_format.inspect}"
386
- end
387
- end
388
- end
389
- end